Implement SoX native format muxer and demuxer.

Patch by Daniel Verkamp $firstname@drv DOT nu.

Originally committed as revision 18998 to svn://svn.ffmpeg.org/ffmpeg/trunk

Changelog

@@ -21,6 +21,7 @@ version <next>:
 - V210 decoder and encoder
 - remaining GPL parts in AC-3 decoder converted to LGPL
 - QCP demuxer
+- SoX native format muxer and demuxer
 
 
 

doc/general.texi

@@ -209,6 +209,7 @@ library:
 @item Sony OpenMG (OMA)         @tab   @tab X
     @tab Audio format used in Sony Sonic Stage and Sony Vegas.
 @item Sony PlayStation STR      @tab   @tab X
+@item SoX native format         @tab X @tab X
 @item SUN AU format             @tab X @tab X
 @item THP                       @tab   @tab X
     @tab Used on the Nintendo GameCube.

libavformat/Makefile

@@ -204,6 +204,8 @@ OBJS-$(CONFIG_SHORTEN_DEMUXER)           += raw.o id3v2.o
 OBJS-$(CONFIG_SIFF_DEMUXER)              += siff.o
 OBJS-$(CONFIG_SMACKER_DEMUXER)           += smacker.o
 OBJS-$(CONFIG_SOL_DEMUXER)               += sol.o raw.o
+OBJS-$(CONFIG_SOX_DEMUXER)               += soxdec.o
+OBJS-$(CONFIG_SOX_MUXER)                 += soxenc.o
 OBJS-$(CONFIG_STR_DEMUXER)               += psxstr.o
 OBJS-$(CONFIG_SWF_DEMUXER)               += swfdec.o
 OBJS-$(CONFIG_SWF_MUXER)                 += swfenc.o

libavformat/allformats.c

@@ -177,6 +177,7 @@ void av_register_all(void)
     REGISTER_DEMUXER  (SIFF, siff);
     REGISTER_DEMUXER  (SMACKER, smacker);
     REGISTER_DEMUXER  (SOL, sol);
+    REGISTER_MUXDEMUX (SOX, sox);
     REGISTER_DEMUXER  (STR, str);
     REGISTER_MUXDEMUX (SWF, swf);
     REGISTER_MUXER    (TG2, tg2);

libavformat/sox.h

+/*
+ * SoX native format common data
+ * Copyright (c) 2009 Daniel Verkamp <daniel@drv.nu>
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef AVFORMAT_SOX_H
+#define AVFORMAT_SOX_H
+
+#define SOX_FIXED_HDR (4 + 8 + 8 + 4 + 4) /**< Size of fixed header without magic */
+
+#define SOX_TAG MKTAG('.', 'S', 'o', 'X')
+
+#endif /* AVFORMAT_SOX_H */

libavformat/soxdec.c

+/*
+ * SoX native format demuxer
+ * Copyright (c) 2009 Daniel Verkamp <daniel@drv.nu>
+ *
+ * Based on libSoX sox-fmt.c
+ * Copyright (c) 2008 robs@users.sourceforge.net
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+/**
+ * SoX native format demuxer
+ * @file libavformat/soxdec.c
+ * @author Daniel Verkamp
+ * @sa http://wiki.multimedia.cx/index.php?title=SoX_native_intermediate_format
+ */
+
+#include "libavutil/intreadwrite.h"
+#include "avformat.h"
+#include "raw.h"
+#include "sox.h"
+
+static int sox_probe(AVProbeData *p)
+{
+    if (AV_RL32(p->buf) == SOX_TAG || AV_RB32(p->buf) == SOX_TAG)
+        return AVPROBE_SCORE_MAX;
+    return 0;
+}
+
+static int sox_read_header(AVFormatContext *s,
+                           AVFormatParameters *ap)
+{
+    ByteIOContext *pb = s->pb;
+    unsigned header_size, comment_size;
+    double sample_rate, sample_rate_frac;
+    AVStream *st;
+
+    st = av_new_stream(s, 0);
+    if (!st)
+        return AVERROR(ENOMEM);
+
+    st->codec->codec_type = CODEC_TYPE_AUDIO;
+
+    if (get_le32(pb) == SOX_TAG) {
+        st->codec->codec_id = CODEC_ID_PCM_S32LE;
+        header_size         = get_le32(pb);
+        url_fskip(pb, 8); /* sample count */
+        sample_rate         = av_int2dbl(get_le64(pb));
+        st->codec->channels = get_le32(pb);
+        comment_size        = get_le32(pb);
+    } else {
+        st->codec->codec_id = CODEC_ID_PCM_S32BE;
+        header_size         = get_be32(pb);
+        url_fskip(pb, 8); /* sample count */
+        sample_rate         = av_int2dbl(get_be64(pb));
+        st->codec->channels = get_be32(pb);
+        comment_size        = get_be32(pb);
+    }
+
+    if (comment_size > 0xFFFFFFFFU - SOX_FIXED_HDR - 4U) {
+        av_log(s, AV_LOG_ERROR, "invalid comment size (%u)\n", comment_size);
+        return -1;
+    }
+
+    if (sample_rate <= 0 || sample_rate > INT_MAX) {
+        av_log(s, AV_LOG_ERROR, "invalid sample rate (%f)\n", sample_rate);
+        return -1;
+    }
+
+    sample_rate_frac = sample_rate - floor(sample_rate);
+    if (sample_rate_frac)
+        av_log(s, AV_LOG_WARNING,
+               "truncating fractional part of sample rate (%f)\n",
+               sample_rate_frac);
+
+    if ((header_size + 4) & 7 || header_size < SOX_FIXED_HDR + comment_size
+        || st->codec->channels > 65535) /* Reserve top 16 bits */ {
+        av_log(s, AV_LOG_ERROR, "invalid header\n");
+        return -1;
+    }
+
+    if (comment_size &&
+        comment_size + FF_INPUT_BUFFER_PADDING_SIZE >= comment_size) {
+        char *comment = av_mallocz(comment_size + FF_INPUT_BUFFER_PADDING_SIZE);
+        if (get_buffer(pb, comment, comment_size) != comment_size) {
+            av_freep(&comment);
+            return AVERROR_IO;
+        }
+        av_metadata_set(&s->metadata, "comment", comment);
+        av_freep(&comment);
+    }
+
+    url_fskip(pb, header_size - SOX_FIXED_HDR - comment_size);
+
+    st->codec->sample_rate           = sample_rate;
+    st->codec->sample_fmt            = SAMPLE_FMT_S32;
+    st->codec->bits_per_coded_sample = 32;
+    st->codec->bit_rate              = st->codec->sample_rate *
+                                       st->codec->bits_per_coded_sample *
+                                       st->codec->channels;
+
+    av_set_pts_info(st, 64, 1, st->codec->sample_rate);
+
+    return 0;
+}
+
+#define MAX_SIZE 4096
+
+static int sox_read_packet(AVFormatContext *s,
+                           AVPacket *pkt)
+{
+    int ret;
+
+    if (url_feof(s->pb))
+        return AVERROR_EOF;
+
+    ret = av_get_packet(s->pb, pkt, MAX_SIZE);
+    if (ret < 0)
+        return AVERROR(EIO);
+    pkt->stream_index = 0;
+    pkt->size = ret;
+
+    return 0;
+}
+
+AVInputFormat sox_demuxer = {
+    "sox",
+    NULL_IF_CONFIG_SMALL("SoX native format"),
+    0,
+    sox_probe,
+    sox_read_header,
+    sox_read_packet,
+    NULL,
+    pcm_read_seek,
+};

libavformat/soxenc.c

+/*
+ * SoX native format muxer
+ * Copyright (c) 2009 Daniel Verkamp <daniel@drv.nu>
+ *
+ * Based on libSoX sox-fmt.c
+ * Copyright (c) 2008 robs@users.sourceforge.net
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+/**
+ * SoX native format muxer
+ * @file libavformat/soxenc.c
+ * @author Daniel Verkamp
+ * @sa http://wiki.multimedia.cx/index.php?title=SoX_native_intermediate_format
+ */
+
+#include "libavutil/intreadwrite.h"
+#include "avformat.h"
+#include "sox.h"
+
+typedef struct {
+    int64_t header_size;
+} SoXContext;
+
+static int sox_write_header(AVFormatContext *s)
+{
+    SoXContext *sox = s->priv_data;
+    ByteIOContext *pb = s->pb;
+    AVCodecContext *enc = s->streams[0]->codec;
+    AVMetadataTag *comment;
+    size_t comment_len = 0, comment_size;
+
+    comment = av_metadata_get(s->metadata, "comment", NULL, 0);
+    if (comment)
+        comment_len = strlen(comment->value);
+    comment_size = (comment_len + 7) & ~7;
+
+    sox->header_size = SOX_FIXED_HDR + comment_size;
+
+    if (enc->codec_id == CODEC_ID_PCM_S32LE) {
+        put_tag(pb, ".SoX");
+        put_le32(pb, sox->header_size);
+        put_le64(pb, 0); /* number of samples */
+        put_le64(pb, av_dbl2int(enc->sample_rate));
+        put_le32(pb, enc->channels);
+        put_le32(pb, comment_size);
+    } else if (enc->codec_id == CODEC_ID_PCM_S32BE) {
+        put_tag(pb, "XoS.");
+        put_be32(pb, sox->header_size);
+        put_be64(pb, 0); /* number of samples */
+        put_be64(pb, av_dbl2int(enc->sample_rate));
+        put_be32(pb, enc->channels);
+        put_be32(pb, comment_size);
+    } else {
+        av_log(s, AV_LOG_ERROR, "invalid codec; use pcm_s32le or pcm_s32be\n");
+        return -1;
+    }
+
+    if (comment_len)
+        put_buffer(pb, comment->value, comment_len);
+
+    for ( ; comment_size > comment_len; comment_len++)
+        put_byte(pb, 0);
+
+    put_flush_packet(pb);
+
+    return 0;
+}
+
+static int sox_write_packet(AVFormatContext *s, AVPacket *pkt)
+{
+    ByteIOContext *pb = s->pb;
+    put_buffer(pb, pkt->data, pkt->size);
+    return 0;
+}
+
+static int sox_write_trailer(AVFormatContext *s)
+{
+    SoXContext *sox = s->priv_data;
+    ByteIOContext *pb = s->pb;
+    AVCodecContext *enc = s->streams[0]->codec;
+
+    if (!url_is_streamed(s->pb)) {
+        /* update number of samples */
+        int64_t file_size = url_ftell(pb);
+        int64_t num_samples = (file_size - sox->header_size - 4LL) >> 2LL;
+        url_fseek(pb, 8, SEEK_SET);
+        if (enc->codec_id == CODEC_ID_PCM_S32LE) {
+            put_le64(pb, num_samples);
+        } else
+            put_be64(pb, num_samples);
+        url_fseek(pb, file_size, SEEK_SET);
+
+        put_flush_packet(pb);
+    }
+
+    return 0;
+}
+
+AVOutputFormat sox_muxer = {
+    "sox",
+    NULL_IF_CONFIG_SMALL("SoX native format"),
+    NULL,
+    "sox",
+    sizeof(SoXContext),
+    CODEC_ID_PCM_S32LE,
+    CODEC_ID_NONE,
+    sox_write_header,
+    sox_write_packet,
+    sox_write_trailer,
+};