From e4e400fd17e7f248a61ef74681f55eed8b18be7e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tomas=20H=C3=A4rdin?= <tjoppen@acc.umu.se>
Date: Tue, 8 Aug 2017 15:28:06 +0200
Subject: [PATCH 2/3] Add muxer/demuxer for raw codec2 and .c2 files
---
Changelog | 1 +
doc/general.texi | 4 +
libavformat/Makefile | 4 +
libavformat/allformats.c | 2 +
libavformat/codec2.c | 314 +++++++++++++++++++++++++++++++++++++++++++++++
libavformat/rawenc.c | 13 ++
libavformat/utils.c | 1 +
libavformat/version.h | 2 +-
8 files changed, 340 insertions(+), 1 deletion(-)
create mode 100644 libavformat/codec2.c
@@ -28,6 +28,7 @@ version <next>:
- nsp demuxer
- support LibreSSL (via libtls)
- codec2 en/decoding via libcodec2
+- muxer/demuxer for raw codec2 files and .c2 files
version 3.4:
@@ -308,6 +308,10 @@ library:
@item BRSTM @tab @tab X
@tab Audio format used on the Nintendo Wii.
@item BWF @tab X @tab X
+@item codec2 (raw) @tab X @tab X
+ @tab Must be given -mode format option to decode correctly.
+@item codec2 (.c2 files) @tab X @tab X
+ @tab Contains header with version and mode info, simplifying playback.
@item CRI ADX @tab X @tab X
@tab Audio-only format used in console video games.
@item Discworld II BMV @tab @tab X
@@ -131,6 +131,10 @@ OBJS-$(CONFIG_CAVSVIDEO_MUXER) += rawenc.o
OBJS-$(CONFIG_CDG_DEMUXER) += cdg.o
OBJS-$(CONFIG_CDXL_DEMUXER) += cdxl.o
OBJS-$(CONFIG_CINE_DEMUXER) += cinedec.o
+OBJS-$(CONFIG_CODEC2_DEMUXER) += ../libavcodec/codec2utils.o codec2.o rawdec.o pcm.o
+OBJS-$(CONFIG_CODEC2_MUXER) += ../libavcodec/codec2utils.o codec2.o rawenc.o
+OBJS-$(CONFIG_CODEC2RAW_DEMUXER) += ../libavcodec/codec2utils.o codec2.o rawdec.o pcm.o
+OBJS-$(CONFIG_CODEC2RAW_MUXER) += rawenc.o
OBJS-$(CONFIG_CONCAT_DEMUXER) += concatdec.o
OBJS-$(CONFIG_CRC_MUXER) += crcenc.o
OBJS-$(CONFIG_DATA_DEMUXER) += rawdec.o
@@ -97,6 +97,8 @@ static void register_all(void)
REGISTER_DEMUXER (CDG, cdg);
REGISTER_DEMUXER (CDXL, cdxl);
REGISTER_DEMUXER (CINE, cine);
+ REGISTER_MUXDEMUX(CODEC2, codec2);
+ REGISTER_MUXDEMUX(CODEC2RAW, codec2raw);
REGISTER_DEMUXER (CONCAT, concat);
REGISTER_MUXER (CRC, crc);
REGISTER_MUXDEMUX(DASH, dash);
new file mode 100644
@@ -0,0 +1,314 @@
+/*
+ * codec2 muxer and demuxers
+ * Copyright (c) 2017 Tomas Härdin
+ *
+ * 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 <memory.h>
+#include "libavcodec/codec2utils.h"
+#include "avio_internal.h"
+#include "avformat.h"
+#include "internal.h"
+#include "rawdec.h"
+#include "rawenc.h"
+#include "pcm.h"
+
+#define AVPRIV_CODEC2_HEADER_SIZE 7
+
+//the lowest version we should ever run across is 0.8
+//we may run across later versions as the format evolves
+#define EXPECTED_CODEC2_MAJOR_VERSION 0
+#define EXPECTED_CODEC2_MINOR_VERSION 8
+
+typedef struct {
+ const AVClass *class;
+ int mode;
+ int frames_per_packet;
+} Codec2Context;
+
+static const uint8_t avpriv_codec2_magic[3] = {0xC0, 0xDE, 0xC2};
+
+//check for 0xC0DEC2, return non-zero if it doesn't match
+static int check_magic(uint8_t *ptr) {
+ return memcmp(ptr, avpriv_codec2_magic, 3);
+}
+
+static int codec2_probe(AVProbeData *p)
+{
+ int score;
+
+ //must be at least 7 bytes and start wih 0xC0DEC2
+ if (p->buf_size < AVPRIV_CODEC2_HEADER_SIZE || check_magic(p->buf)) {
+ return 0;
+ }
+
+ //no .c2 files prior to 0.8
+ if (p->buf[3] == 0 && p->buf[4] < 8) {
+ return 0;
+ }
+
+ //give a poor score if major version doesn't match
+ //this allows such files to be detected at least, even if we can't do much with them
+ if (p->buf[3] != EXPECTED_CODEC2_MAJOR_VERSION) {
+ return AVPROBE_SCORE_MAX/10;
+ }
+
+ //if the minor version is known, no unknown mode is used and no flags are set then -> max score,
+ //else penalize 20% for each byte outside of expectations
+ //this way if only the first four bytes are OK then we're slightly less than AVPROBE_SCORE_MAX/2
+ //cap score at max-1 unless file extension is .c2
+ score = AVPROBE_SCORE_MAX;
+ if (!av_match_ext(p->filename, "c2")) score -= 1;
+ if (p->buf[4] > EXPECTED_CODEC2_MINOR_VERSION) score -= AVPROBE_SCORE_MAX/5;
+ if (p->buf[5] > AVPRIV_CODEC2_MODE_MAX) score -= AVPROBE_SCORE_MAX/5;
+ if (p->buf[6] != 0) score -= AVPROBE_SCORE_MAX/5;
+ return score;
+}
+
+static int codec2_read_header_common(AVFormatContext *s, AVStream *st)
+{
+ int mode = avpriv_codec2_mode_from_extradata(st->codecpar->extradata);
+
+ st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
+ st->codecpar->codec_id = AV_CODEC_ID_CODEC2;
+ st->codecpar->sample_rate = 8000;
+ st->codecpar->channels = 1;
+ st->codecpar->format = AV_SAMPLE_FMT_S16;
+ st->codecpar->channel_layout = AV_CH_LAYOUT_MONO;
+ st->codecpar->bit_rate = avpriv_codec2_mode_bit_rate(s, mode);
+ st->codecpar->frame_size = avpriv_codec2_mode_frame_size(s, mode);
+ st->codecpar->block_align = avpriv_codec2_mode_block_align(s, mode);
+
+ if (st->codecpar->bit_rate <= 0 ||
+ st->codecpar->frame_size <= 0 ||
+ st->codecpar->block_align <= 0) {
+ return AVERROR(EINVAL);
+ }
+
+ avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
+
+ //replicating estimate_timings_from_bit_rate() in utils.c to avoid warnings
+ if (s->pb && st->codecpar->bit_rate > 0) {
+ int64_t filesize = avio_size(s->pb);
+ if (filesize > s->internal->data_offset) {
+ filesize -= s->internal->data_offset;
+ st->duration = av_rescale(8 * filesize,
+ st->time_base.den,
+ st->codecpar->bit_rate * (int64_t) st->time_base.num);
+ }
+ }
+
+ return 0;
+}
+
+static int codec2_read_header(AVFormatContext *s)
+{
+ AVStream *st = avformat_new_stream(s, NULL);
+ int ret, version;
+ uint8_t magic[3];
+
+ if (!st) {
+ return AVERROR(ENOMEM);
+ }
+
+ avio_read(s->pb, magic, 3);
+ if (check_magic(magic)) {
+ av_log(s, AV_LOG_ERROR, "not a .c2 file\n");
+ return AVERROR_INVALIDDATA;
+ }
+
+ ret = ff_alloc_extradata(st->codecpar, AVPRIV_CODEC2_EXTRADATA_SIZE);
+ if (ret) {
+ return ret;
+ }
+
+ avio_read(s->pb, st->codecpar->extradata, AVPRIV_CODEC2_EXTRADATA_SIZE);
+
+ version = avpriv_codec2_version_from_extradata(st->codecpar->extradata);
+ if ((version >> 8) != EXPECTED_CODEC2_MAJOR_VERSION) {
+ avpriv_report_missing_feature(s, "Major version %i", version >> 8);
+ return AVERROR_PATCHWELCOME;
+ }
+
+ s->internal->data_offset = AVPRIV_CODEC2_HEADER_SIZE;
+
+ return codec2_read_header_common(s, st);
+}
+
+static int codec2_read_packet(AVFormatContext *s, AVPacket *pkt)
+{
+ Codec2Context *c2 = s->priv_data;
+ AVStream *st = s->streams[0];
+ int ret, size, n, block_align, frame_size;
+
+ block_align = st->codecpar->block_align;
+ frame_size = st->codecpar->frame_size;
+
+ if (block_align <= 0 || frame_size <= 0 || c2->frames_per_packet <= 0) {
+ return AVERROR(EINVAL);
+ }
+
+ //try to read desired number of frames, compute n from to actual number of bytes read
+ size = c2->frames_per_packet * block_align;
+ ret = av_get_packet(s->pb, pkt, size);
+ if (ret < 0) {
+ return ret;
+ }
+
+ //only set duration - compute_pkt_fields() and ff_pcm_read_seek() takes care of everything else
+ //tested by spamming the seek functionality in ffplay
+ n = ret / block_align;
+ pkt->duration = n * frame_size;
+
+ return ret;
+}
+
+static int codec2_write_header(AVFormatContext *s)
+{
+ AVStream *st;
+
+ if (s->nb_streams != 1 || s->streams[0]->codecpar->codec_id != AV_CODEC_ID_CODEC2) {
+ av_log(s, AV_LOG_ERROR, ".c2 files must have exactly one codec2 stream\n");
+ return AVERROR(EINVAL);
+ }
+
+ st = s->streams[0];
+
+ if (st->codecpar->extradata_size != AVPRIV_CODEC2_EXTRADATA_SIZE) {
+ av_log(s, AV_LOG_ERROR, ".c2 files require exactly %i bytes of extradata (got %i)\n",
+ AVPRIV_CODEC2_EXTRADATA_SIZE, st->codecpar->extradata_size);
+ return AVERROR(EINVAL);
+ }
+
+ avio_write(s->pb, avpriv_codec2_magic, 3);
+ avio_write(s->pb, st->codecpar->extradata, AVPRIV_CODEC2_EXTRADATA_SIZE);
+
+ return 0;
+}
+
+static int codec2raw_read_header(AVFormatContext *s)
+{
+ Codec2Context *c2 = s->priv_data;
+ AVStream *st;
+ int ret;
+
+ if (c2->mode < 0) {
+ //FIXME: using a default value of -1 for mandatory options is an incredibly ugly hack
+ av_log(s, AV_LOG_ERROR, "-mode must be set in order to make sense of raw codec2 files\n");
+ return AVERROR(EINVAL);
+ }
+
+ st = avformat_new_stream(s, NULL);
+ if (!st) {
+ return AVERROR(ENOMEM);
+ }
+
+ ret = ff_alloc_extradata(st->codecpar, AVPRIV_CODEC2_EXTRADATA_SIZE);
+ if (ret) {
+ return ret;
+ }
+
+ s->internal->data_offset = 0;
+ avpriv_codec2_make_extradata(st->codecpar->extradata, c2->mode);
+
+ return codec2_read_header_common(s, st);
+}
+
+//transcoding report2074.c2 to wav went from 7.391s to 5.322s with -frames_per_packet 1000 compared to default, same sha1sum
+#define FRAMES_PER_PACKET \
+ { "frames_per_packet", "Number of frames to read at a time. Higher = faster decoding, lower granularity", \
+ offsetof(Codec2Context, frames_per_packet), AV_OPT_TYPE_INT, {.i64 = 1}, 1, INT_MAX, AV_OPT_FLAG_DECODING_PARAM}
+
+static const AVOption codec2_options[] = {
+ FRAMES_PER_PACKET,
+ { NULL },
+};
+
+static const AVOption codec2raw_options[] = {
+ AVPRIV_CODEC2_AVOPTIONS("codec2 mode [mandatory]", Codec2Context, -1, -1, AV_OPT_FLAG_DECODING_PARAM),
+ FRAMES_PER_PACKET,
+ { NULL },
+};
+
+static const AVClass codec2_mux_class = {
+ .class_name = "codec2 muxer",
+ .item_name = av_default_item_name,
+ .version = LIBAVUTIL_VERSION_INT,
+ .category = AV_CLASS_CATEGORY_DEMUXER,
+};
+
+static const AVClass codec2_demux_class = {
+ .class_name = "codec2 demuxer",
+ .item_name = av_default_item_name,
+ .option = codec2_options,
+ .version = LIBAVUTIL_VERSION_INT,
+ .category = AV_CLASS_CATEGORY_DEMUXER,
+};
+
+static const AVClass codec2raw_demux_class = {
+ .class_name = "codec2raw demuxer",
+ .item_name = av_default_item_name,
+ .option = codec2raw_options,
+ .version = LIBAVUTIL_VERSION_INT,
+ .category = AV_CLASS_CATEGORY_DEMUXER,
+};
+
+#if CONFIG_CODEC2_DEMUXER
+AVInputFormat ff_codec2_demuxer = {
+ .name = "codec2",
+ .long_name = NULL_IF_CONFIG_SMALL("codec2 .c2 demuxer"),
+ .priv_data_size = sizeof(Codec2Context),
+ .extensions = "c2",
+ .read_probe = codec2_probe,
+ .read_header = codec2_read_header,
+ .read_packet = codec2_read_packet,
+ .read_seek = ff_pcm_read_seek,
+ .flags = AVFMT_GENERIC_INDEX,
+ .raw_codec_id = AV_CODEC_ID_CODEC2,
+ .priv_class = &codec2_demux_class,
+};
+#endif
+
+#if CONFIG_CODEC2_MUXER
+AVOutputFormat ff_codec2_muxer = {
+ .name = "codec2",
+ .long_name = NULL_IF_CONFIG_SMALL("codec2 .c2 muxer"),
+ .priv_data_size = sizeof(Codec2Context),
+ .extensions = "c2",
+ .audio_codec = AV_CODEC_ID_CODEC2,
+ .video_codec = AV_CODEC_ID_NONE,
+ .write_header = codec2_write_header,
+ .write_packet = ff_raw_write_packet,
+ .flags = AVFMT_NOTIMESTAMPS,
+ .priv_class = &codec2_mux_class,
+};
+#endif
+
+#if CONFIG_CODEC2RAW_DEMUXER
+AVInputFormat ff_codec2raw_demuxer = {
+ .name = "codec2raw",
+ .long_name = NULL_IF_CONFIG_SMALL("raw codec2 demuxer"),
+ .priv_data_size = sizeof(Codec2Context),
+ .read_header = codec2raw_read_header,
+ .read_packet = codec2_read_packet,
+ .read_seek = ff_pcm_read_seek,
+ .flags = AVFMT_GENERIC_INDEX,
+ .raw_codec_id = AV_CODEC_ID_CODEC2,
+ .priv_class = &codec2raw_demux_class,
+};
+#endif
@@ -117,6 +117,19 @@ AVOutputFormat ff_cavsvideo_muxer = {
};
#endif
+#if CONFIG_CODEC2RAW_MUXER
+AVOutputFormat ff_codec2raw_muxer = {
+ .name = "codec2raw",
+ .long_name = NULL_IF_CONFIG_SMALL("raw codec2 muxer"),
+ .audio_codec = AV_CODEC_ID_CODEC2,
+ .video_codec = AV_CODEC_ID_NONE,
+ .write_header = force_one_stream,
+ .write_packet = ff_raw_write_packet,
+ .flags = AVFMT_NOTIMESTAMPS,
+};
+#endif
+
+
#if CONFIG_DATA_MUXER
AVOutputFormat ff_data_muxer = {
.name = "data",
@@ -905,6 +905,7 @@ static int determinable_frame_size(AVCodecContext *avctx)
case AV_CODEC_ID_MP1:
case AV_CODEC_ID_MP2:
case AV_CODEC_ID_MP3:
+ case AV_CODEC_ID_CODEC2:
return 1;
}
@@ -32,7 +32,7 @@
// Major bumping may affect Ticket5467, 5421, 5451(compatibility with Chromium)
// Also please add any ticket numbers that you believe might be affected here
#define LIBAVFORMAT_VERSION_MAJOR 58
-#define LIBAVFORMAT_VERSION_MINOR 3
+#define LIBAVFORMAT_VERSION_MINOR 4
#define LIBAVFORMAT_VERSION_MICRO 100
#define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \
--
2.11.0