FFmpeg
codec2.c
Go to the documentation of this file.
1 /*
2  * codec2 muxer and demuxers
3  * Copyright (c) 2017 Tomas Härdin
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #include "config_components.h"
23 
24 #include "libavcodec/codec2utils.h"
26 #include "libavutil/intreadwrite.h"
27 #include "libavutil/opt.h"
28 #include "avio_internal.h"
29 #include "avformat.h"
30 #include "demux.h"
31 #include "internal.h"
32 #include "mux.h"
33 #include "rawenc.h"
34 #include "pcm.h"
35 
36 #define CODEC2_HEADER_SIZE 7
37 #define CODEC2_MAGIC 0xC0DEC2
38 
39 //the lowest version we should ever run across is 0.8
40 //we may run across later versions as the format evolves
41 #define EXPECTED_CODEC2_MAJOR_VERSION 0
42 #define EXPECTED_CODEC2_MINOR_VERSION 8
43 
44 typedef struct {
45  const AVClass *class;
46  int mode;
49 
50 static int codec2_probe(const AVProbeData *p)
51 {
52  //must start wih C0 DE C2
53  if (AV_RB24(p->buf) != CODEC2_MAGIC) {
54  return 0;
55  }
56 
57  //no .c2 files prior to 0.8
58  //be strict about major version while we're at it
59  if (p->buf[3] != EXPECTED_CODEC2_MAJOR_VERSION ||
61  return 0;
62  }
63 
64  //32 bits of identification -> low score
65  return AVPROBE_SCORE_EXTENSION + 1;
66 }
67 
68 //Mimics codec2_samples_per_frame()
70 {
71  int frame_size_table[CODEC2_MODE_MAX+1] = {
72  160, // 3200
73  160, // 2400
74  320, // 1600
75  320, // 1400
76  320, // 1300
77  320, // 1200
78  320, // 700
79  320, // 700B
80  320, // 700C
81  };
82 
84  av_log(s, AV_LOG_ERROR, "unknown codec2 mode %i, can't find frame_size\n", mode);
85  return 0;
86  } else {
87  return frame_size_table[mode];
88  }
89 }
90 
91 //Mimics (codec2_bits_per_frame()+7)/8
93 {
94  int block_align_table[CODEC2_MODE_MAX+1] = {
95  8, // 3200
96  6, // 2400
97  8, // 1600
98  7, // 1400
99  7, // 1300
100  6, // 1200
101  4, // 700
102  4, // 700B
103  4, // 700C
104  };
105 
107  av_log(s, AV_LOG_ERROR, "unknown codec2 mode %i, can't find block_align\n", mode);
108  return 0;
109  } else {
110  return block_align_table[mode];
111  }
112 }
113 
114 //Computes bitrate from mode, with frames rounded up to the nearest octet.
115 //So 700 bit/s (28 bits/frame) becomes 800 bits/s (32 bits/frame).
117 {
119  int block_align = codec2_mode_block_align(s, mode);
120 
121  if (frame_size <= 0 || block_align <= 0) {
122  return 0;
123  }
124 
125  return 8 * 8000 * block_align / frame_size;
126 }
127 
129 {
131 
134  st->codecpar->sample_rate = 8000;
140 
141  if (st->codecpar->bit_rate <= 0 ||
142  st->codecpar->frame_size <= 0 ||
143  st->codecpar->block_align <= 0) {
144  return AVERROR_INVALIDDATA;
145  }
146 
147  avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
148 
149  return 0;
150 }
151 
153 {
155  int ret, version;
156 
157  if (!st) {
158  return AVERROR(ENOMEM);
159  }
160 
161  if (avio_rb24(s->pb) != CODEC2_MAGIC) {
162  av_log(s, AV_LOG_ERROR, "not a .c2 file\n");
163  return AVERROR_INVALIDDATA;
164  }
165 
167  if (ret) {
168  return ret;
169  }
170 
172  if (ret < 0) {
173  return ret;
174  }
175 
177  if ((version >> 8) != EXPECTED_CODEC2_MAJOR_VERSION) {
178  avpriv_report_missing_feature(s, "Major version %i", version >> 8);
179  return AVERROR_PATCHWELCOME;
180  }
181 
183 
184  return codec2_read_header_common(s, st);
185 }
186 
188 {
189  Codec2Context *c2 = s->priv_data;
190  AVStream *st = s->streams[0];
191  int ret, size, n, block_align, frame_size;
192 
193  block_align = st->codecpar->block_align;
195 
196  if (block_align <= 0 || frame_size <= 0 || c2->frames_per_packet <= 0) {
197  return AVERROR(EINVAL);
198  }
199 
200  //try to read desired number of frames, compute n from to actual number of bytes read
201  size = c2->frames_per_packet * block_align;
202  ret = av_get_packet(s->pb, pkt, size);
203  if (ret < 0) {
204  return ret;
205  }
206 
207  //only set duration - compute_pkt_fields() and ff_pcm_read_seek() takes care of everything else
208  //tested by spamming the seek functionality in ffplay
209  n = ret / block_align;
210  pkt->duration = n * frame_size;
211 
212  return ret;
213 }
214 
216 {
217  AVStream *st = s->streams[0];
218 
220  av_log(s, AV_LOG_ERROR, ".c2 files require exactly %i bytes of extradata (got %i)\n",
222  return AVERROR(EINVAL);
223  }
224 
225  avio_wb24(s->pb, CODEC2_MAGIC);
227 
228  return 0;
229 }
230 
232 {
233  Codec2Context *c2 = s->priv_data;
234  AVStream *st;
235  int ret;
236 
237  if (c2->mode < 0) {
238  //FIXME: using a default value of -1 for mandatory options is an incredibly ugly hack
239  av_log(s, AV_LOG_ERROR, "-mode must be set in order to make sense of raw codec2 files\n");
240  return AVERROR(EINVAL);
241  }
242 
243  st = avformat_new_stream(s, NULL);
244  if (!st) {
245  return AVERROR(ENOMEM);
246  }
247 
249  if (ret) {
250  return ret;
251  }
252 
254 
255  return codec2_read_header_common(s, st);
256 }
257 
258 //transcoding report2074.c2 to wav went from 7.391s to 5.322s with -frames_per_packet 1000 compared to default, same sha1sum
259 #define FRAMES_PER_PACKET \
260  { "frames_per_packet", "Number of frames to read at a time. Higher = faster decoding, lower granularity", \
261  offsetof(Codec2Context, frames_per_packet), AV_OPT_TYPE_INT, {.i64 = 1}, 1, INT_MAX, AV_OPT_FLAG_DECODING_PARAM}
262 
263 static const AVOption codec2_options[] = {
265  { NULL },
266 };
267 
268 static const AVOption codec2raw_options[] = {
269  CODEC2_AVOPTIONS("codec2 mode [mandatory]", Codec2Context, -1, -1, AV_OPT_FLAG_DECODING_PARAM),
271  { NULL },
272 };
273 
274 static const AVClass codec2_demux_class = {
275  .class_name = "codec2 demuxer",
276  .item_name = av_default_item_name,
277  .option = codec2_options,
278  .version = LIBAVUTIL_VERSION_INT,
279  .category = AV_CLASS_CATEGORY_DEMUXER,
280 };
281 
283  .class_name = "codec2raw demuxer",
284  .item_name = av_default_item_name,
285  .option = codec2raw_options,
286  .version = LIBAVUTIL_VERSION_INT,
287  .category = AV_CLASS_CATEGORY_DEMUXER,
288 };
289 
290 #if CONFIG_CODEC2_DEMUXER
292  .p.name = "codec2",
293  .p.long_name = NULL_IF_CONFIG_SMALL("codec2 .c2 demuxer"),
294  .p.extensions = "c2",
295  .p.flags = AVFMT_GENERIC_INDEX,
296  .p.priv_class = &codec2_demux_class,
297  .priv_data_size = sizeof(Codec2Context),
302  .raw_codec_id = AV_CODEC_ID_CODEC2,
303 };
304 #endif
305 
306 #if CONFIG_CODEC2_MUXER
308  .p.name = "codec2",
309  .p.long_name = NULL_IF_CONFIG_SMALL("codec2 .c2 muxer"),
310  .p.extensions = "c2",
311  .p.audio_codec = AV_CODEC_ID_CODEC2,
312  .p.video_codec = AV_CODEC_ID_NONE,
313  .p.subtitle_codec = AV_CODEC_ID_NONE,
314  .p.flags = AVFMT_NOTIMESTAMPS,
315  .flags_internal = FF_OFMT_FLAG_MAX_ONE_OF_EACH |
317  .write_header = codec2_write_header,
318  .write_packet = ff_raw_write_packet,
319 };
320 #endif
321 
322 #if CONFIG_CODEC2RAW_DEMUXER
324  .p.name = "codec2raw",
325  .p.long_name = NULL_IF_CONFIG_SMALL("raw codec2 demuxer"),
326  .p.flags = AVFMT_GENERIC_INDEX,
327  .p.priv_class = &codec2raw_demux_class,
328  .priv_data_size = sizeof(Codec2Context),
332  .raw_codec_id = AV_CODEC_ID_CODEC2,
333 };
334 #endif
CODEC2_EXTRADATA_SIZE
#define CODEC2_EXTRADATA_SIZE
Definition: codec2utils.h:48
codec2_options
static const AVOption codec2_options[]
Definition: codec2.c:263
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:69
AVOutputFormat::name
const char * name
Definition: avformat.h:510
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
pcm.h
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:51
ffformatcontext
static av_always_inline FFFormatContext * ffformatcontext(AVFormatContext *s)
Definition: internal.h:188
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const struct AVCodec *c)
Add a new stream to a media file.
AVFMT_NOTIMESTAMPS
#define AVFMT_NOTIMESTAMPS
Format does not need / have any timestamps.
Definition: avformat.h:479
EXPECTED_CODEC2_MINOR_VERSION
#define EXPECTED_CODEC2_MINOR_VERSION
Definition: codec2.c:42
codec2_read_packet
static int codec2_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: codec2.c:187
AVOption
AVOption.
Definition: opt.h:357
codec2_write_header
static int codec2_write_header(AVFormatContext *s)
Definition: codec2.c:215
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:542
FF_OFMT_FLAG_ONLY_DEFAULT_CODECS
#define FF_OFMT_FLAG_ONLY_DEFAULT_CODECS
If this flag is set, then the only permitted audio/video/subtitle codec ids are AVOutputFormat....
Definition: mux.h:59
FFOutputFormat::p
AVOutputFormat p
The public AVOutputFormat.
Definition: mux.h:65
codec2_read_header_common
static int codec2_read_header_common(AVFormatContext *s, AVStream *st)
Definition: codec2.c:128
avpriv_set_pts_info
void avpriv_set_pts_info(AVStream *st, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: avformat.c:853
codec2_mode_bit_rate
static int codec2_mode_bit_rate(AVFormatContext *s, int mode)
Definition: codec2.c:116
ff_codec2raw_demuxer
const FFInputFormat ff_codec2raw_demuxer
read_seek
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:151
AVFMT_GENERIC_INDEX
#define AVFMT_GENERIC_INDEX
Use generic index building code.
Definition: avformat.h:480
pkt
AVPacket * pkt
Definition: movenc.c:60
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_read_callback.c:42
AVCodecParameters::frame_size
int frame_size
Audio only.
Definition: codec_par.h:195
codec2_make_extradata
static void codec2_make_extradata(uint8_t *ptr, int mode)
Definition: codec2utils.h:51
ff_codec2_demuxer
const FFInputFormat ff_codec2_demuxer
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
EXPECTED_CODEC2_MAJOR_VERSION
#define EXPECTED_CODEC2_MAJOR_VERSION
Definition: codec2.c:41
CODEC2_MODE_MAX
#define CODEC2_MODE_MAX
Definition: codec2utils.h:30
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:553
codec2_read_header
static int codec2_read_header(AVFormatContext *s)
Definition: codec2.c:152
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:453
frame_size
int frame_size
Definition: mxfenc.c:2423
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
codec2utils.h
FFFormatContext::data_offset
int64_t data_offset
offset of the first packet
Definition: internal.h:101
ff_raw_write_packet
int ff_raw_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: rawenc.c:31
AV_CODEC_ID_CODEC2
@ AV_CODEC_ID_CODEC2
Definition: codec_id.h:507
AV_CLASS_CATEGORY_DEMUXER
@ AV_CLASS_CATEGORY_DEMUXER
Definition: log.h:33
AVFormatContext
Format I/O context.
Definition: avformat.h:1255
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:766
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:550
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
codec2raw_read_header
static int codec2raw_read_header(AVFormatContext *s)
Definition: codec2.c:231
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:451
FFOutputFormat
Definition: mux.h:61
Codec2Context::frames_per_packet
int frames_per_packet
Definition: codec2.c:47
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
Audio only.
Definition: codec_par.h:180
AVPROBE_SCORE_EXTENSION
#define AVPROBE_SCORE_EXTENSION
score for file extension
Definition: avformat.h:461
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:184
AVCodecParameters::extradata_size
int extradata_size
Size of the extradata content in bytes.
Definition: codec_par.h:73
avio_rb24
unsigned int avio_rb24(AVIOContext *s)
Definition: aviobuf.c:754
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:303
size
int size
Definition: twinvq_data.h:10344
avpriv_report_missing_feature
void avpriv_report_missing_feature(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message about a missing feature.
FFInputFormat::p
AVInputFormat p
The public AVInputFormat.
Definition: demux.h:41
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:201
codec2_mode_from_extradata
static uint8_t codec2_mode_from_extradata(uint8_t *ptr)
Definition: codec2utils.h:59
version
version
Definition: libkvazaar.c:321
rawenc.h
codec2raw_demux_class
static const AVClass codec2raw_demux_class
Definition: codec2.c:282
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:50
avio_internal.h
Codec2Context::mode
int mode
Definition: codec2.c:46
CODEC2_AVOPTIONS
#define CODEC2_AVOPTIONS(desc, classname, min_val, default_val, option_flags)
Definition: codec2utils.h:36
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:191
codec2_mode_block_align
static int codec2_mode_block_align(AVFormatContext *s, int mode)
Definition: codec2.c:92
FF_OFMT_FLAG_MAX_ONE_OF_EACH
#define FF_OFMT_FLAG_MAX_ONE_OF_EACH
If this flag is set, it indicates that for each codec type whose corresponding default codec (i....
Definition: mux.h:50
AV_SAMPLE_FMT_S16
@ AV_SAMPLE_FMT_S16
signed 16 bits
Definition: samplefmt.h:58
FRAMES_PER_PACKET
#define FRAMES_PER_PACKET
Definition: codec2.c:259
demux.h
codec2raw_options
static const AVOption codec2raw_options[]
Definition: codec2.c:268
av_get_packet
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:91
codec2_mode_frame_size
static int codec2_mode_frame_size(AVFormatContext *s, int mode)
Definition: codec2.c:69
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:743
AVClass::class_name
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:71
ff_pcm_read_seek
int ff_pcm_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: pcm.c:73
avformat.h
codec2_demux_class
static const AVClass codec2_demux_class
Definition: codec2.c:274
c2
static const uint64_t c2
Definition: murmur3.c:53
channel_layout.h
mode
mode
Definition: ebur128.h:83
AV_OPT_FLAG_DECODING_PARAM
#define AV_OPT_FLAG_DECODING_PARAM
A generic parameter which can be set by the user for demuxing or decoding.
Definition: opt.h:284
Codec2Context
Definition: codec2.c:44
CODEC2_MAGIC
#define CODEC2_MAGIC
Definition: codec2.c:37
read_probe
static int read_probe(const AVProbeData *p)
Definition: cdg.c:30
AVCodecParameters::format
int format
Definition: codec_par.h:92
avio_wb24
void avio_wb24(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:455
AV_CHANNEL_LAYOUT_MONO
#define AV_CHANNEL_LAYOUT_MONO
Definition: channel_layout.h:378
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:55
codec2_probe
static int codec2_probe(const AVProbeData *p)
Definition: codec2.c:50
AVPacket
This structure stores compressed data.
Definition: packet.h:501
FFInputFormat
Definition: demux.h:37
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:97
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
ffio_read_size
int ffio_read_size(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:662
CODEC2_HEADER_SIZE
#define CODEC2_HEADER_SIZE
Definition: codec2.c:36
AV_RB24
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_RB24
Definition: bytestream.h:97
ff_codec2_muxer
const FFOutputFormat ff_codec2_muxer
AV_RB16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_WB24 unsigned int_TMPL AV_RB16
Definition: bytestream.h:98
ff_alloc_extradata
int ff_alloc_extradata(AVCodecParameters *par, int size)
Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end which is always set to 0.
Definition: utils.c:227
mux.h