Lego Mindstorms RSO muxer and demuxer.

Patch by Rafaël Carré, rafael d carre a gmail

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

Changelog

@@ -22,6 +22,7 @@ version <next>:
 - native GSM / GSM MS decoder
 - RTP depacketization of QDM2
 - ANSI/ASCII art playback system
+- Lego Mindstorms RSO de/muxer
 
 
 

doc/general.texi

@@ -209,6 +209,7 @@ library:
 @item RL2                       @tab   @tab X
     @tab Audio and video format used in some games by Entertainment Software Partners.
 @item RPL/ARMovie               @tab   @tab X
+@item Lego Mindstorms RSO       @tab X @tab X
 @item RTMP                      @tab X @tab X
     @tab Output is performed by publishing stream to RTMP server
 @item RTP                       @tab   @tab X

libavformat/Makefile

@@ -209,6 +209,8 @@ OBJS-$(CONFIG_RM_DEMUXER)                += rmdec.o rm.o
 OBJS-$(CONFIG_RM_MUXER)                  += rmenc.o rm.o
 OBJS-$(CONFIG_ROQ_DEMUXER)               += idroq.o
 OBJS-$(CONFIG_ROQ_MUXER)                 += raw.o
+OBJS-$(CONFIG_RSO_DEMUXER)               += rsodec.o rso.o raw.o
+OBJS-$(CONFIG_RSO_MUXER)                 += rsoenc.o rso.o
 OBJS-$(CONFIG_RPL_DEMUXER)               += rpl.o
 OBJS-$(CONFIG_RTP_MUXER)                 += rtp.o         \
                                             rtpenc_aac.o     \

libavformat/allformats.c

@@ -174,6 +174,7 @@ void av_register_all(void)
     REGISTER_MUXDEMUX (RM, rm);
     REGISTER_MUXDEMUX (ROQ, roq);
     REGISTER_DEMUXER  (RPL, rpl);
+    REGISTER_MUXDEMUX (RSO, rso);
     REGISTER_MUXER    (RTP, rtp);
     REGISTER_MUXDEMUX (RTSP, rtsp);
     REGISTER_DEMUXER  (SDP, sdp);

libavformat/avformat.h

@@ -22,7 +22,7 @@
 #define AVFORMAT_AVFORMAT_H
 
 #define LIBAVFORMAT_VERSION_MAJOR 52
-#define LIBAVFORMAT_VERSION_MINOR 75
+#define LIBAVFORMAT_VERSION_MINOR 76
 #define LIBAVFORMAT_VERSION_MICRO  0
 
 #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \

libavformat/rso.c

+/*
+ * RSO format common data
+ * Copyright (c) 2010 Rafael Carre
+ *
+ * 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
+ */
+
+#include "avformat.h"
+#include "internal.h"
+#include "rso.h"
+
+const AVCodecTag ff_codec_rso_tags[] = {
+    { CODEC_ID_PCM_U8,          0x0100 },
+    { CODEC_ID_ADPCM_IMA_WAV,   0x0101 },
+    { CODEC_ID_NONE, 0 },
+};

libavformat/rso.h

+/*
+ * RSO format common data
+ * Copyright (c) 2010 Rafael Carre
+ *
+ * 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_RSO_H
+#define AVFORMAT_RSO_H
+
+#include "internal.h"
+
+#define RSO_HEADER_SIZE 8
+
+/* The ffmpeg codecs we support, and the IDs they have in the file */
+extern const AVCodecTag ff_codec_rso_tags[];
+
+#endif /* AVFORMAT_RSO_H */

libavformat/rsodec.c

+/*
+ * RSO demuxer
+ * Copyright (c) 2001 Fabrice Bellard (original AU code)
+ * Copyright (c) 2010 Rafael Carre
+ *
+ * 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
+ */
+
+#include "libavutil/intreadwrite.h"
+#include "avformat.h"
+#include "internal.h"
+#include "raw.h"
+#include "riff.h"
+#include "rso.h"
+
+static int rso_read_header(AVFormatContext *s, AVFormatParameters *ap)
+{
+    ByteIOContext *pb = s->pb;
+    int id, rate, bps;
+    unsigned int size;
+    enum CodecID codec;
+    AVStream *st;
+
+    id   = get_be16(pb);
+    size = get_be16(pb);
+    rate = get_be16(pb);
+    get_be16(pb);   /* play mode ? (0x0000 = don't loop) */
+
+    codec = ff_codec_get_id(ff_codec_rso_tags, id);
+
+    if (codec == CODEC_ID_ADPCM_IMA_WAV) {
+        av_log(s, AV_LOG_ERROR, "ADPCM in RSO not implemented\n");
+        return AVERROR_PATCHWELCOME;
+    }
+
+    bps = av_get_bits_per_sample(codec);
+    if (!bps) {
+        av_log_ask_for_sample(s, "could not determine bits per sample\n");
+        return AVERROR_INVALIDDATA;
+    }
+
+    /* now we are ready: build format streams */
+    st = av_new_stream(s, 0);
+    if (!st)
+        return AVERROR(ENOMEM);
+
+    st->duration            = (size * 8) / bps;
+    st->codec->codec_type   = AVMEDIA_TYPE_AUDIO;
+    st->codec->codec_tag    = id;
+    st->codec->codec_id     = codec;
+    st->codec->channels     = 1;
+    st->codec->sample_rate  = rate;
+
+    av_set_pts_info(st, 64, 1, rate);
+
+    return 0;
+}
+
+#define BLOCK_SIZE 1024 /* in samples */
+
+static int rso_read_packet(AVFormatContext *s, AVPacket *pkt)
+{
+    int bps = av_get_bits_per_sample(s->streams[0]->codec->codec_id);
+    int ret = av_get_packet(s->pb, pkt, BLOCK_SIZE * bps >> 3);
+
+    if (ret < 0)
+        return ret;
+
+    pkt->stream_index = 0;
+
+    /* note: we need to modify the packet size here to handle the last packet */
+    pkt->size = ret;
+
+    return 0;
+}
+
+AVInputFormat rso_demuxer = {
+    .name           =   "rso",
+    .long_name      =   NULL_IF_CONFIG_SMALL("Lego Mindstorms RSO format"),
+    .extensions     =   "rso",
+    .priv_data_size =   0,
+    .read_probe     =   NULL, /* no magic value in this format */
+    .read_header    =   rso_read_header,
+    .read_packet    =   rso_read_packet,
+    .read_close     =   NULL,
+    .read_seek      =   pcm_read_seek,
+    .codec_tag      =   (const AVCodecTag* const []){ff_codec_rso_tags, 0},
+};

libavformat/rsoenc.c

+/*
+ * RSO muxer
+ * Copyright (c) 2001 Fabrice Bellard (original AU code)
+ * Copyright (c) 2010 Rafael Carre
+ *
+ * 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
+ */
+
+#include "avformat.h"
+#include "internal.h"
+#include "riff.h"
+#include "rso.h"
+
+static int rso_write_header(AVFormatContext *s)
+{
+    ByteIOContext  *pb  = s->pb;
+    AVCodecContext *enc = s->streams[0]->codec;
+
+    if (!enc->codec_tag)
+        return AVERROR_INVALIDDATA;
+
+    if (enc->channels != 1) {
+        av_log(s, AV_LOG_ERROR, "RSO only supports mono\n");
+        return AVERROR_INVALIDDATA;
+    }
+
+    if (url_is_streamed(s->pb)) {
+        av_log(s, AV_LOG_ERROR, "muxer does not support non seekable output\n");
+        return AVERROR_INVALIDDATA;
+    }
+
+    /* XXX: find legal sample rates (if any) */
+    if (enc->sample_rate >= 1u<<16) {
+        av_log(s, AV_LOG_ERROR, "Sample rate must be < 65536\n");
+        return AVERROR_INVALIDDATA;
+    }
+
+    if (enc->codec_id == CODEC_ID_ADPCM_IMA_WAV) {
+        av_log(s, AV_LOG_ERROR, "ADPCM in RSO not implemented\n");
+        return AVERROR_PATCHWELCOME;
+    }
+
+    /* format header */
+    put_be16(pb, enc->codec_tag);   /* codec ID */
+    put_be16(pb, 0);                /* data size, will be written at EOF */
+    put_be16(pb, enc->sample_rate);
+    put_be16(pb, 0x0000);           /* play mode ? (0x0000 = don't loop) */
+
+    put_flush_packet(pb);
+
+    return 0;
+}
+
+static int rso_write_packet(AVFormatContext *s, AVPacket *pkt)
+{
+    put_buffer(s->pb, pkt->data, pkt->size);
+    return 0;
+}
+
+static int rso_write_trailer(AVFormatContext *s)
+{
+    ByteIOContext *pb = s->pb;
+    int64_t file_size;
+    uint16_t coded_file_size;
+
+    file_size = url_ftell(pb);
+
+    if (file_size < 0)
+        return file_size;
+
+    if (file_size > 0xffff + RSO_HEADER_SIZE) {
+        av_log(s, AV_LOG_WARNING,
+               "Output file is too big (%"PRId64" bytes >= 64kB)\n", file_size);
+        coded_file_size = 0xffff;
+    } else {
+        coded_file_size = file_size - RSO_HEADER_SIZE;
+    }
+
+    /* update file size */
+    url_fseek(pb, 2, SEEK_SET);
+    put_be16(pb, coded_file_size);
+    url_fseek(pb, file_size, SEEK_SET);
+
+    put_flush_packet(pb);
+
+    return 0;
+}
+
+AVOutputFormat rso_muxer = {
+    .name           =   "rso",
+    .long_name      =   NULL_IF_CONFIG_SMALL("Lego Mindstorms RSO format"),
+    .extensions     =   "rso",
+    .priv_data_size =   0,
+    .audio_codec    =   CODEC_ID_PCM_U8,
+    .video_codec    =   CODEC_ID_NONE,
+    .write_header   =   rso_write_header,
+    .write_packet   =   rso_write_packet,
+    .write_trailer  =   rso_write_trailer,
+    .codec_tag      =   (const AVCodecTag* const []){ff_codec_rso_tags, 0},
+};

tests/lavf-regression.sh

@@ -206,6 +206,10 @@ if [ -n "$do_ogg" ] ; then
 do_audio_only ogg
 fi
 
+if [ -n "$do_rso" ] ; then
+do_audio_only rso
+fi
+
 # pix_fmt conversions
 
 if [ -n "$do_pixfmt" ] ; then