FFmpeg
cafenc.c
Go to the documentation of this file.
1 /*
2  * Core Audio Format muxer
3  * Copyright (c) 2011 Carl Eugen Hoyos
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 "avformat.h"
23 #include "caf.h"
24 #include "isom.h"
25 #include "avio_internal.h"
26 #include "libavutil/intfloat.h"
27 #include "libavutil/dict.h"
28 
29 #define FRAME_SIZE_OFFSET 40
30 
31 typedef struct {
32  int64_t data;
35  int packets;
36 } CAFContext;
37 
38 static uint32_t codec_flags(enum AVCodecID codec_id) {
39  switch (codec_id) {
42  return 1; //< kCAFLinearPCMFormatFlagIsFloat
46  return 2; //< kCAFLinearPCMFormatFlagIsLittleEndian
49  return 3; //< kCAFLinearPCMFormatFlagIsFloat | kCAFLinearPCMFormatFlagIsLittleEndian
50  default:
51  return 0;
52  }
53 }
54 
55 static uint32_t samples_per_packet(enum AVCodecID codec_id, int channels, int block_align) {
56  switch (codec_id) {
57  case AV_CODEC_ID_PCM_S8:
70  return 1;
71  case AV_CODEC_ID_MACE3:
72  case AV_CODEC_ID_MACE6:
73  return 6;
75  return 64;
76  case AV_CODEC_ID_AMR_NB:
77  case AV_CODEC_ID_GSM:
78  case AV_CODEC_ID_ILBC:
79  case AV_CODEC_ID_QCELP:
80  return 160;
81  case AV_CODEC_ID_GSM_MS:
82  return 320;
83  case AV_CODEC_ID_MP1:
84  return 384;
85  case AV_CODEC_ID_MP2:
86  case AV_CODEC_ID_MP3:
87  return 1152;
88  case AV_CODEC_ID_AC3:
89  return 1536;
90  case AV_CODEC_ID_QDM2:
91  case AV_CODEC_ID_QDMC:
92  return 2048 * channels;
93  case AV_CODEC_ID_ALAC:
94  return 4096;
96  return (block_align - 4 * channels) * 8 / (4 * channels) + 1;
98  return (block_align - 7 * channels) * 2 / channels + 2;
99  default:
100  return 0;
101  }
102 }
103 
105 {
106  AVIOContext *pb = s->pb;
107  AVCodecParameters *par = s->streams[0]->codecpar;
108  CAFContext *caf = s->priv_data;
109  AVDictionaryEntry *t = NULL;
110  unsigned int codec_tag = ff_codec_get_tag(ff_codec_caf_tags, par->codec_id);
111  int64_t chunk_size = 0;
112  int frame_size = par->frame_size;
113 
114  if (s->nb_streams != 1) {
115  av_log(s, AV_LOG_ERROR, "CAF files have exactly one stream\n");
116  return AVERROR(EINVAL);
117  }
118 
119  switch (par->codec_id) {
120  case AV_CODEC_ID_AAC:
121  av_log(s, AV_LOG_ERROR, "muxing codec currently unsupported\n");
122  return AVERROR_PATCHWELCOME;
123  }
124 
125  if (par->codec_id == AV_CODEC_ID_OPUS && par->channels > 2) {
126  av_log(s, AV_LOG_ERROR, "Only mono and stereo are supported for Opus\n");
127  return AVERROR_INVALIDDATA;
128  }
129 
130  if (!codec_tag) {
131  av_log(s, AV_LOG_ERROR, "unsupported codec\n");
132  return AVERROR_INVALIDDATA;
133  }
134 
135  if (!par->block_align && !(pb->seekable & AVIO_SEEKABLE_NORMAL)) {
136  av_log(s, AV_LOG_ERROR, "Muxing variable packet size not supported on non seekable output\n");
137  return AVERROR_INVALIDDATA;
138  }
139 
140  if (par->codec_id != AV_CODEC_ID_MP3 || frame_size != 576)
142 
143  ffio_wfourcc(pb, "caff"); //< mFileType
144  avio_wb16(pb, 1); //< mFileVersion
145  avio_wb16(pb, 0); //< mFileFlags
146 
147  ffio_wfourcc(pb, "desc"); //< Audio Description chunk
148  avio_wb64(pb, 32); //< mChunkSize
149  avio_wb64(pb, av_double2int(par->sample_rate)); //< mSampleRate
150  avio_wl32(pb, codec_tag); //< mFormatID
151  avio_wb32(pb, codec_flags(par->codec_id)); //< mFormatFlags
152  avio_wb32(pb, par->block_align); //< mBytesPerPacket
153  avio_wb32(pb, frame_size); //< mFramesPerPacket
154  avio_wb32(pb, par->channels); //< mChannelsPerFrame
155  avio_wb32(pb, av_get_bits_per_sample(par->codec_id)); //< mBitsPerChannel
156 
157  if (par->channel_layout) {
158  ffio_wfourcc(pb, "chan");
159  avio_wb64(pb, 12);
161  }
162 
163  if (par->codec_id == AV_CODEC_ID_ALAC) {
164  ffio_wfourcc(pb, "kuki");
165  avio_wb64(pb, 12 + par->extradata_size);
166  avio_write(pb, "\0\0\0\14frmaalac", 12);
167  avio_write(pb, par->extradata, par->extradata_size);
168  } else if (par->codec_id == AV_CODEC_ID_AMR_NB) {
169  ffio_wfourcc(pb, "kuki");
170  avio_wb64(pb, 29);
171  avio_write(pb, "\0\0\0\14frmasamr", 12);
172  avio_wb32(pb, 0x11); /* size */
173  avio_write(pb, "samrFFMP", 8);
174  avio_w8(pb, 0); /* decoder version */
175 
176  avio_wb16(pb, 0x81FF); /* Mode set (all modes for AMR_NB) */
177  avio_w8(pb, 0x00); /* Mode change period (no restriction) */
178  avio_w8(pb, 0x01); /* Frames per sample */
179  } else if (par->codec_id == AV_CODEC_ID_QDM2 || par->codec_id == AV_CODEC_ID_QDMC) {
180  ffio_wfourcc(pb, "kuki");
181  avio_wb64(pb, par->extradata_size);
182  avio_write(pb, par->extradata, par->extradata_size);
183  }
184 
186  if (av_dict_count(s->metadata)) {
187  ffio_wfourcc(pb, "info"); //< Information chunk
188  while ((t = av_dict_get(s->metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
189  chunk_size += strlen(t->key) + strlen(t->value) + 2;
190  }
191  avio_wb64(pb, chunk_size + 4);
192  avio_wb32(pb, av_dict_count(s->metadata));
193  t = NULL;
194  while ((t = av_dict_get(s->metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
195  avio_put_str(pb, t->key);
196  avio_put_str(pb, t->value);
197  }
198  }
199 
200  ffio_wfourcc(pb, "data"); //< Audio Data chunk
201  caf->data = avio_tell(pb);
202  avio_wb64(pb, -1); //< mChunkSize
203  avio_wb32(pb, 0); //< mEditCount
204 
205  return 0;
206 }
207 
209 {
210  CAFContext *caf = s->priv_data;
211  AVStream *const st = s->streams[0];
212 
213  if (!st->codecpar->block_align) {
214  uint8_t *pkt_sizes;
215  int i, alloc_size = caf->size_entries_used + 5U;
216  if (alloc_size < 0)
217  return AVERROR(ERANGE);
218 
219  pkt_sizes = av_fast_realloc(st->priv_data,
220  &caf->size_buffer_size,
221  alloc_size);
222  if (!pkt_sizes)
223  return AVERROR(ENOMEM);
224  st->priv_data = pkt_sizes;
225  for (i = 4; i > 0; i--) {
226  unsigned top = pkt->size >> i * 7;
227  if (top)
228  pkt_sizes[caf->size_entries_used++] = 128 | top;
229  }
230  pkt_sizes[caf->size_entries_used++] = pkt->size & 127;
231  caf->packets++;
232  }
233  avio_write(s->pb, pkt->data, pkt->size);
234  return 0;
235 }
236 
238 {
239  CAFContext *caf = s->priv_data;
240  AVIOContext *pb = s->pb;
241  AVStream *st = s->streams[0];
242  AVCodecParameters *par = st->codecpar;
243 
244  if (pb->seekable & AVIO_SEEKABLE_NORMAL) {
245  int64_t file_size = avio_tell(pb);
246 
247  avio_seek(pb, caf->data, SEEK_SET);
248  avio_wb64(pb, file_size - caf->data - 8);
249  if (!par->block_align) {
250  int packet_size = samples_per_packet(par->codec_id, par->channels, par->block_align);
251  if (!packet_size) {
252  packet_size = st->duration / (caf->packets - 1);
253  avio_seek(pb, FRAME_SIZE_OFFSET, SEEK_SET);
254  avio_wb32(pb, packet_size);
255  }
256  avio_seek(pb, file_size, SEEK_SET);
257  ffio_wfourcc(pb, "pakt");
258  avio_wb64(pb, caf->size_entries_used + 24U);
259  avio_wb64(pb, caf->packets); ///< mNumberPackets
260  avio_wb64(pb, caf->packets * packet_size); ///< mNumberValidFrames
261  avio_wb32(pb, 0); ///< mPrimingFrames
262  avio_wb32(pb, 0); ///< mRemainderFrames
263  avio_write(pb, st->priv_data, caf->size_entries_used);
264  }
265  }
266  return 0;
267 }
268 
270  .name = "caf",
271  .long_name = NULL_IF_CONFIG_SMALL("Apple CAF (Core Audio Format)"),
272  .mime_type = "audio/x-caf",
273  .extensions = "caf",
274  .priv_data_size = sizeof(CAFContext),
275  .audio_codec = AV_CODEC_ID_PCM_S16BE,
276  .video_codec = AV_CODEC_ID_NONE,
280  .codec_tag = ff_caf_codec_tags_list,
281 };
CAFContext::data
int64_t data
Definition: cafenc.c:32
AV_CODEC_ID_PCM_S16LE
@ AV_CODEC_ID_PCM_S16LE
Definition: codec_id.h:314
AV_CODEC_ID_MACE6
@ AV_CODEC_ID_MACE6
Definition: codec_id.h:433
AV_CODEC_ID_PCM_F32BE
@ AV_CODEC_ID_PCM_F32BE
Definition: codec_id.h:334
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:74
AV_CODEC_ID_ADPCM_MS
@ AV_CODEC_ID_ADPCM_MS
Definition: codec_id.h:359
AV_CODEC_ID_ADPCM_IMA_QT
@ AV_CODEC_ID_ADPCM_IMA_QT
Definition: codec_id.h:353
AV_CODEC_ID_AC3
@ AV_CODEC_ID_AC3
Definition: codec_id.h:426
AVOutputFormat::name
const char * name
Definition: avformat.h:496
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
ffio_wfourcc
static av_always_inline void ffio_wfourcc(AVIOContext *pb, const uint8_t *s)
Definition: avio_internal.h:105
caf.h
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:52
caf_write_packet
static int caf_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: cafenc.c:208
AVStream::priv_data
void * priv_data
Definition: avformat.h:866
av_dict_count
int av_dict_count(const AVDictionary *m)
Get number of entries in dictionary.
Definition: dict.c:35
AVPacket::data
uint8_t * data
Definition: packet.h:373
AV_CODEC_ID_ALAC
@ AV_CODEC_ID_ALAC
Definition: codec_id.h:439
AV_DICT_IGNORE_SUFFIX
#define AV_DICT_IGNORE_SUFFIX
Return first entry in a dictionary whose first part corresponds to the search key,...
Definition: dict.h:68
AV_CODEC_ID_AMR_NB
@ AV_CODEC_ID_AMR_NB
Definition: codec_id.h:406
CAFContext::size_entries_used
int size_entries_used
Definition: cafenc.c:34
intfloat.h
AVCodecParameters::channels
int channels
Audio only.
Definition: codec_par.h:166
AV_CODEC_ID_PCM_S16BE
@ AV_CODEC_ID_PCM_S16BE
Definition: codec_id.h:315
U
#define U(x)
Definition: vp56_arith.h:37
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:486
AV_CODEC_ID_MP3
@ AV_CODEC_ID_MP3
preferred ID for decoding MPEG audio layer 1, 2 or 3
Definition: codec_id.h:424
AVStream::duration
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:900
av_get_bits_per_sample
int av_get_bits_per_sample(enum AVCodecID codec_id)
Return codec bits per sample.
Definition: utils.c:591
AV_CODEC_ID_PCM_S8
@ AV_CODEC_ID_PCM_S8
Definition: codec_id.h:318
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
AV_CODEC_ID_MACE3
@ AV_CODEC_ID_MACE3
Definition: codec_id.h:432
AVCodecParameters::frame_size
int frame_size
Audio only.
Definition: codec_par.h:181
av_dict_get
AVDictionaryEntry * av_dict_get(const AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
Get a dictionary entry with matching key.
Definition: dict.c:40
av_fast_realloc
void * av_fast_realloc(void *ptr, unsigned int *size, size_t min_size)
Reallocate the given buffer if it is not large enough, otherwise do nothing.
Definition: mem.c:504
s
#define s(width, name)
Definition: cbs_vp9.c:257
AVDictionaryEntry::key
char * key
Definition: dict.h:80
frame_size
int frame_size
Definition: mxfenc.c:2205
AV_CODEC_ID_MP2
@ AV_CODEC_ID_MP2
Definition: codec_id.h:423
channels
channels
Definition: aptx.h:33
AV_CODEC_ID_PCM_MULAW
@ AV_CODEC_ID_PCM_MULAW
Definition: codec_id.h:320
codec_id
enum AVCodecID codec_id
Definition: vaapi_decode.c:369
caf_write_header
static int caf_write_header(AVFormatContext *s)
Definition: cafenc.c:104
AVFormatContext
Format I/O context.
Definition: avformat.h:1109
AV_CODEC_ID_PCM_ALAW
@ AV_CODEC_ID_PCM_ALAW
Definition: codec_id.h:321
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1004
samples_per_packet
static uint32_t samples_per_packet(enum AVCodecID codec_id, int channels, int block_align)
Definition: cafenc.c:55
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
isom.h
write_trailer
static int write_trailer(AVFormatContext *s1)
Definition: v4l2enc.c:98
avio_w8
void avio_w8(AVIOContext *s, int b)
Definition: aviobuf.c:196
AV_CODEC_ID_QDM2
@ AV_CODEC_ID_QDM2
Definition: codec_id.h:442
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:170
AV_CODEC_ID_GSM
@ AV_CODEC_ID_GSM
as in Berlin toast format
Definition: codec_id.h:441
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:47
AVCodecParameters::extradata_size
int extradata_size
Size of the extradata content in bytes.
Definition: codec_par.h:78
AV_CODEC_ID_AAC
@ AV_CODEC_ID_AAC
Definition: codec_id.h:425
AV_CODEC_ID_QCELP
@ AV_CODEC_ID_QCELP
Definition: codec_id.h:447
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AV_CODEC_ID_PCM_S24LE
@ AV_CODEC_ID_PCM_S24LE
Definition: codec_id.h:326
AVPacket::size
int size
Definition: packet.h:374
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:117
ff_caf_muxer
const AVOutputFormat ff_caf_muxer
Definition: cafenc.c:269
AVIOContext::seekable
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:262
FRAME_SIZE_OFFSET
#define FRAME_SIZE_OFFSET
Definition: cafenc.c:29
AV_CODEC_ID_QDMC
@ AV_CODEC_ID_QDMC
Definition: codec_id.h:473
AV_CODEC_ID_OPUS
@ AV_CODEC_ID_OPUS
Definition: codec_id.h:483
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:218
avio_wb32
void avio_wb32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:379
avio_wl32
void avio_wl32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:371
write_packet
static void write_packet(OutputFile *of, AVPacket *pkt, OutputStream *ost, int unqueue)
Definition: ffmpeg.c:731
ff_standardize_creation_time
int ff_standardize_creation_time(AVFormatContext *s)
Standardize creation_time metadata in AVFormatContext to an ISO-8601 timestamp string.
Definition: utils.c:1827
av_double2int
static av_always_inline uint64_t av_double2int(double f)
Reinterpret a double as a 64-bit integer.
Definition: intfloat.h:70
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:48
AVOutputFormat
Definition: avformat.h:495
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
avio_internal.h
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:177
AV_CODEC_ID_PCM_F64BE
@ AV_CODEC_ID_PCM_F64BE
Definition: codec_id.h:336
AV_CODEC_ID_PCM_S32BE
@ AV_CODEC_ID_PCM_S32BE
Definition: codec_id.h:323
ff_codec_caf_tags
const AVCodecTag ff_codec_caf_tags[]
Known codec tags for CAF.
Definition: caf.c:34
caf_write_trailer
static int caf_write_trailer(AVFormatContext *s)
Definition: cafenc.c:237
AV_CODEC_ID_GSM_MS
@ AV_CODEC_ID_GSM_MS
Definition: codec_id.h:453
AVStream
Stream structure.
Definition: avformat.h:857
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
avformat.h
dict.h
ff_caf_codec_tags_list
const AVCodecTag *const ff_caf_codec_tags_list[]
Definition: caf.c:81
AVIO_SEEKABLE_NORMAL
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
ff_codec_get_tag
unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id)
Definition: utils.c:347
CAFContext::packets
int packets
Definition: cafenc.c:35
avio_wb64
void avio_wb64(AVIOContext *s, uint64_t val)
Definition: aviobuf.c:445
AV_CODEC_ID_PCM_S32LE
@ AV_CODEC_ID_PCM_S32LE
Definition: codec_id.h:322
AV_CODEC_ID_PCM_F64LE
@ AV_CODEC_ID_PCM_F64LE
Definition: codec_id.h:337
AVDictionaryEntry
Definition: dict.h:79
CAFContext
Definition: cafenc.c:31
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
AVPacket
This structure stores compressed data.
Definition: packet.h:350
AV_CODEC_ID_ADPCM_IMA_WAV
@ AV_CODEC_ID_ADPCM_IMA_WAV
Definition: codec_id.h:354
AVCodecParameters::channel_layout
uint64_t channel_layout
Audio only.
Definition: codec_par.h:162
AV_CODEC_ID_ILBC
@ AV_CODEC_ID_ILBC
Definition: codec_id.h:482
CAFContext::size_buffer_size
int size_buffer_size
Definition: cafenc.c:33
avio_wb16
void avio_wb16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:457
AV_CODEC_ID_PCM_F32LE
@ AV_CODEC_ID_PCM_F32LE
Definition: codec_id.h:335
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
codec_flags
static uint32_t codec_flags(enum AVCodecID codec_id)
Definition: cafenc.c:38
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
AVDictionaryEntry::value
char * value
Definition: dict.h:81
write_header
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:347
ff_mov_write_chan
void ff_mov_write_chan(AVIOContext *pb, int64_t channel_layout)
Definition: isom.c:413
avio_put_str
int avio_put_str(AVIOContext *s, const char *str)
Write a NULL-terminated string.
Definition: aviobuf.c:387
AV_CODEC_ID_MP1
@ AV_CODEC_ID_MP1
Definition: codec_id.h:465
AV_CODEC_ID_PCM_S24BE
@ AV_CODEC_ID_PCM_S24BE
Definition: codec_id.h:327