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 typedef struct {
30  int64_t data;
31  uint8_t *pkt_sizes;
34  int packets;
35 } CAFContext;
36 
37 static uint32_t codec_flags(enum AVCodecID codec_id) {
38  switch (codec_id) {
41  return 1; //< kCAFLinearPCMFormatFlagIsFloat
45  return 2; //< kCAFLinearPCMFormatFlagIsLittleEndian
48  return 3; //< kCAFLinearPCMFormatFlagIsFloat | kCAFLinearPCMFormatFlagIsLittleEndian
49  default:
50  return 0;
51  }
52 }
53 
54 static uint32_t samples_per_packet(enum AVCodecID codec_id, int channels, int block_align) {
55  switch (codec_id) {
56  case AV_CODEC_ID_PCM_S8:
69  return 1;
70  case AV_CODEC_ID_MACE3:
71  case AV_CODEC_ID_MACE6:
72  return 6;
74  return 64;
75  case AV_CODEC_ID_AMR_NB:
76  case AV_CODEC_ID_GSM:
77  case AV_CODEC_ID_ILBC:
78  case AV_CODEC_ID_QCELP:
79  return 160;
80  case AV_CODEC_ID_GSM_MS:
81  return 320;
82  case AV_CODEC_ID_MP1:
83  return 384;
84  case AV_CODEC_ID_OPUS:
85  return 960;
86  case AV_CODEC_ID_MP2:
87  case AV_CODEC_ID_MP3:
88  return 1152;
89  case AV_CODEC_ID_AC3:
90  return 1536;
91  case AV_CODEC_ID_QDM2:
92  case AV_CODEC_ID_QDMC:
93  return 2048 * channels;
94  case AV_CODEC_ID_ALAC:
95  return 4096;
97  return (block_align - 4 * channels) * 8 / (4 * channels) + 1;
99  return (block_align - 7 * channels) * 2 / channels + 2;
100  default:
101  return 0;
102  }
103 }
104 
106 {
107  AVIOContext *pb = s->pb;
108  AVCodecParameters *par = s->streams[0]->codecpar;
109  CAFContext *caf = s->priv_data;
110  AVDictionaryEntry *t = NULL;
111  unsigned int codec_tag = ff_codec_get_tag(ff_codec_caf_tags, par->codec_id);
112  int64_t chunk_size = 0;
113  int frame_size = par->frame_size;
114 
115  if (s->nb_streams != 1) {
116  av_log(s, AV_LOG_ERROR, "CAF files have exactly one stream\n");
117  return AVERROR(EINVAL);
118  }
119 
120  switch (par->codec_id) {
121  case AV_CODEC_ID_AAC:
122  av_log(s, AV_LOG_ERROR, "muxing codec currently unsupported\n");
123  return AVERROR_PATCHWELCOME;
124  }
125 
126  if (par->codec_id == AV_CODEC_ID_OPUS && par->channels > 2) {
127  av_log(s, AV_LOG_ERROR, "Only mono and stereo are supported for Opus\n");
128  return AVERROR_INVALIDDATA;
129  }
130 
131  if (!codec_tag) {
132  av_log(s, AV_LOG_ERROR, "unsupported codec\n");
133  return AVERROR_INVALIDDATA;
134  }
135 
136  if (!par->block_align && !(pb->seekable & AVIO_SEEKABLE_NORMAL)) {
137  av_log(s, AV_LOG_ERROR, "Muxing variable packet size not supported on non seekable output\n");
138  return AVERROR_INVALIDDATA;
139  }
140 
141  if (par->codec_id != AV_CODEC_ID_MP3 || frame_size != 576)
143 
144  ffio_wfourcc(pb, "caff"); //< mFileType
145  avio_wb16(pb, 1); //< mFileVersion
146  avio_wb16(pb, 0); //< mFileFlags
147 
148  ffio_wfourcc(pb, "desc"); //< Audio Description chunk
149  avio_wb64(pb, 32); //< mChunkSize
150  avio_wb64(pb, av_double2int(par->sample_rate)); //< mSampleRate
151  avio_wl32(pb, codec_tag); //< mFormatID
152  avio_wb32(pb, codec_flags(par->codec_id)); //< mFormatFlags
153  avio_wb32(pb, par->block_align); //< mBytesPerPacket
154  avio_wb32(pb, frame_size); //< mFramesPerPacket
155  avio_wb32(pb, par->channels); //< mChannelsPerFrame
156  avio_wb32(pb, av_get_bits_per_sample(par->codec_id)); //< mBitsPerChannel
157 
158  if (par->channel_layout) {
159  ffio_wfourcc(pb, "chan");
160  avio_wb64(pb, 12);
162  }
163 
164  if (par->codec_id == AV_CODEC_ID_ALAC) {
165  ffio_wfourcc(pb, "kuki");
166  avio_wb64(pb, 12 + par->extradata_size);
167  avio_write(pb, "\0\0\0\14frmaalac", 12);
168  avio_write(pb, par->extradata, par->extradata_size);
169  } else if (par->codec_id == AV_CODEC_ID_AMR_NB) {
170  ffio_wfourcc(pb, "kuki");
171  avio_wb64(pb, 29);
172  avio_write(pb, "\0\0\0\14frmasamr", 12);
173  avio_wb32(pb, 0x11); /* size */
174  avio_write(pb, "samrFFMP", 8);
175  avio_w8(pb, 0); /* decoder version */
176 
177  avio_wb16(pb, 0x81FF); /* Mode set (all modes for AMR_NB) */
178  avio_w8(pb, 0x00); /* Mode change period (no restriction) */
179  avio_w8(pb, 0x01); /* Frames per sample */
180  } else if (par->codec_id == AV_CODEC_ID_QDM2 || par->codec_id == AV_CODEC_ID_QDMC) {
181  ffio_wfourcc(pb, "kuki");
182  avio_wb64(pb, par->extradata_size);
183  avio_write(pb, par->extradata, par->extradata_size);
184  }
185 
187  if (av_dict_count(s->metadata)) {
188  ffio_wfourcc(pb, "info"); //< Information chunk
189  while ((t = av_dict_get(s->metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
190  chunk_size += strlen(t->key) + strlen(t->value) + 2;
191  }
192  avio_wb64(pb, chunk_size + 4);
193  avio_wb32(pb, av_dict_count(s->metadata));
194  t = NULL;
195  while ((t = av_dict_get(s->metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
196  avio_put_str(pb, t->key);
197  avio_put_str(pb, t->value);
198  }
199  }
200 
201  ffio_wfourcc(pb, "data"); //< Audio Data chunk
202  caf->data = avio_tell(pb);
203  avio_wb64(pb, -1); //< mChunkSize
204  avio_wb32(pb, 0); //< mEditCount
205 
206  return 0;
207 }
208 
210 {
211  CAFContext *caf = s->priv_data;
212 
213  avio_write(s->pb, pkt->data, pkt->size);
214  if (!s->streams[0]->codecpar->block_align) {
215  void *pkt_sizes = caf->pkt_sizes;
216  int i, alloc_size = caf->size_entries_used + 5;
217  if (alloc_size < 0) {
218  caf->pkt_sizes = NULL;
219  } else {
220  caf->pkt_sizes = av_fast_realloc(caf->pkt_sizes,
221  &caf->size_buffer_size,
222  alloc_size);
223  }
224  if (!caf->pkt_sizes) {
225  av_free(pkt_sizes);
226  return AVERROR(ENOMEM);
227  }
228  for (i = 4; i > 0; i--) {
229  unsigned top = pkt->size >> i * 7;
230  if (top)
231  caf->pkt_sizes[caf->size_entries_used++] = 128 | top;
232  }
233  caf->pkt_sizes[caf->size_entries_used++] = pkt->size & 127;
234  caf->packets++;
235  }
236  return 0;
237 }
238 
240 {
241  CAFContext *caf = s->priv_data;
242  AVIOContext *pb = s->pb;
243  AVCodecParameters *par = s->streams[0]->codecpar;
244 
245  if (pb->seekable & AVIO_SEEKABLE_NORMAL) {
246  int64_t file_size = avio_tell(pb);
247 
248  avio_seek(pb, caf->data, SEEK_SET);
249  avio_wb64(pb, file_size - caf->data - 8);
250  avio_seek(pb, file_size, SEEK_SET);
251  if (!par->block_align) {
252  ffio_wfourcc(pb, "pakt");
253  avio_wb64(pb, caf->size_entries_used + 24);
254  avio_wb64(pb, caf->packets); ///< mNumberPackets
255  avio_wb64(pb, caf->packets * samples_per_packet(par->codec_id, par->channels, par->block_align)); ///< mNumberValidFrames
256  avio_wb32(pb, 0); ///< mPrimingFrames
257  avio_wb32(pb, 0); ///< mRemainderFrames
258  avio_write(pb, caf->pkt_sizes, caf->size_entries_used);
259  caf->size_buffer_size = 0;
260  }
261  }
262  av_freep(&caf->pkt_sizes);
263  return 0;
264 }
265 
267  .name = "caf",
268  .long_name = NULL_IF_CONFIG_SMALL("Apple CAF (Core Audio Format)"),
269  .mime_type = "audio/x-caf",
270  .extensions = "caf",
271  .priv_data_size = sizeof(CAFContext),
272  .audio_codec = AV_CODEC_ID_PCM_S16BE,
273  .video_codec = AV_CODEC_ID_NONE,
277  .codec_tag = ff_caf_codec_tags_list,
278 };
CAFContext::data
int64_t data
Definition: cafenc.c:30
AV_CODEC_ID_PCM_S16LE
@ AV_CODEC_ID_PCM_S16LE
Definition: codec_id.h:312
AV_CODEC_ID_MACE6
@ AV_CODEC_ID_MACE6
Definition: codec_id.h:431
AV_CODEC_ID_PCM_F32BE
@ AV_CODEC_ID_PCM_F32BE
Definition: codec_id.h:332
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:357
AV_CODEC_ID_ADPCM_IMA_QT
@ AV_CODEC_ID_ADPCM_IMA_QT
Definition: codec_id.h:351
AV_CODEC_ID_AC3
@ AV_CODEC_ID_AC3
Definition: codec_id.h:424
AVOutputFormat::name
const char * name
Definition: avformat.h:491
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:58
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:209
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:365
AV_CODEC_ID_ALAC
@ AV_CODEC_ID_ALAC
Definition: codec_id.h:437
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:70
AV_CODEC_ID_AMR_NB
@ AV_CODEC_ID_AMR_NB
Definition: codec_id.h:404
CAFContext::size_entries_used
int size_entries_used
Definition: cafenc.c:33
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:313
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
AV_CODEC_ID_MP3
@ AV_CODEC_ID_MP3
preferred ID for decoding MPEG audio layer 1, 2 or 3
Definition: codec_id.h:422
AV_CODEC_ID_PCM_S8
@ AV_CODEC_ID_PCM_S8
Definition: codec_id.h:316
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:181
AV_CODEC_ID_MACE3
@ AV_CODEC_ID_MACE3
Definition: codec_id.h:430
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:484
s
#define s(width, name)
Definition: cbs_vp9.c:257
AVDictionaryEntry::key
char * key
Definition: dict.h:82
frame_size
int frame_size
Definition: mxfenc.c:2206
AV_CODEC_ID_MP2
@ AV_CODEC_ID_MP2
Definition: codec_id.h:421
channels
channels
Definition: aptx.h:33
AV_CODEC_ID_PCM_MULAW
@ AV_CODEC_ID_PCM_MULAW
Definition: codec_id.h:318
CAFContext::pkt_sizes
uint8_t * pkt_sizes
Definition: cafenc.c:31
codec_id
enum AVCodecID codec_id
Definition: vaapi_decode.c:369
caf_write_header
static int caf_write_header(AVFormatContext *s)
Definition: cafenc.c:105
AVFormatContext
Format I/O context.
Definition: avformat.h:1106
AV_CODEC_ID_PCM_ALAW
@ AV_CODEC_ID_PCM_ALAW
Definition: codec_id.h:319
samples_per_packet
static uint32_t samples_per_packet(enum AVCodecID codec_id, int channels, int block_align)
Definition: cafenc.c:54
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
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:193
AV_CODEC_ID_QDM2
@ AV_CODEC_ID_QDM2
Definition: codec_id.h:440
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:439
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:46
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:423
AV_CODEC_ID_QCELP
@ AV_CODEC_ID_QCELP
Definition: codec_id.h:445
av_get_bits_per_sample
int av_get_bits_per_sample(enum AVCodecID codec_id)
Return codec bits per sample.
Definition: utils.c:583
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AV_CODEC_ID_PCM_S24LE
@ AV_CODEC_ID_PCM_S24LE
Definition: codec_id.h:324
AVPacket::size
int size
Definition: packet.h:366
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:266
AVIOContext::seekable
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:260
AV_CODEC_ID_QDMC
@ AV_CODEC_ID_QDMC
Definition: codec_id.h:471
AV_CODEC_ID_OPUS
@ AV_CODEC_ID_OPUS
Definition: codec_id.h:481
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:215
avio_wb32
void avio_wb32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:373
avio_wl32
void avio_wl32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:365
write_packet
static void write_packet(OutputFile *of, AVPacket *pkt, OutputStream *ost, int unqueue)
Definition: ffmpeg.c:729
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:5481
av_double2int
static av_always_inline uint64_t av_double2int(double f)
Reinterpret a double as a 64-bit integer.
Definition: intfloat.h:70
i
int i
Definition: input.c:407
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:47
AVOutputFormat
Definition: avformat.h:490
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:334
AV_CODEC_ID_PCM_S32BE
@ AV_CODEC_ID_PCM_S32BE
Definition: codec_id.h:321
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:239
AV_CODEC_ID_GSM_MS
@ AV_CODEC_ID_GSM_MS
Definition: codec_id.h:451
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:243
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:3068
CAFContext::packets
int packets
Definition: cafenc.c:34
avio_wb64
void avio_wb64(AVIOContext *s, uint64_t val)
Definition: aviobuf.c:439
AV_CODEC_ID_PCM_S32LE
@ AV_CODEC_ID_PCM_S32LE
Definition: codec_id.h:320
AV_CODEC_ID_PCM_F64LE
@ AV_CODEC_ID_PCM_F64LE
Definition: codec_id.h:335
av_free
#define av_free(p)
Definition: tableprint_vlc.h:34
AVDictionaryEntry
Definition: dict.h:81
CAFContext
Definition: cafenc.c:29
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:342
AV_CODEC_ID_ADPCM_IMA_WAV
@ AV_CODEC_ID_ADPCM_IMA_WAV
Definition: codec_id.h:352
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
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:480
CAFContext::size_buffer_size
int size_buffer_size
Definition: cafenc.c:32
avio_wb16
void avio_wb16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:451
AV_CODEC_ID_PCM_F32LE
@ AV_CODEC_ID_PCM_F32LE
Definition: codec_id.h:333
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:37
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
AVDictionaryEntry::value
char * value
Definition: dict.h:83
write_header
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:346
ff_mov_write_chan
void ff_mov_write_chan(AVIOContext *pb, int64_t channel_layout)
Definition: isom.c:412
avio_put_str
int avio_put_str(AVIOContext *s, const char *str)
Write a NULL-terminated string.
Definition: aviobuf.c:381
AV_CODEC_ID_MP1
@ AV_CODEC_ID_MP1
Definition: codec_id.h:463
AV_CODEC_ID_PCM_S24BE
@ AV_CODEC_ID_PCM_S24BE
Definition: codec_id.h:325