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;
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)
142  frame_size = samples_per_packet(par->codec_id, par->channels, par->block_align);
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);
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  avio_flush(pb);
207  return 0;
208 }
209 
211 {
212  CAFContext *caf = s->priv_data;
213 
214  avio_write(s->pb, pkt->data, pkt->size);
215  if (!s->streams[0]->codecpar->block_align) {
216  void *pkt_sizes = caf->pkt_sizes;
217  int i, alloc_size = caf->size_entries_used + 5;
218  if (alloc_size < 0) {
219  caf->pkt_sizes = NULL;
220  } else {
221  caf->pkt_sizes = av_fast_realloc(caf->pkt_sizes,
222  &caf->size_buffer_size,
223  alloc_size);
224  }
225  if (!caf->pkt_sizes) {
226  av_free(pkt_sizes);
227  return AVERROR(ENOMEM);
228  }
229  for (i = 4; i > 0; i--) {
230  unsigned top = pkt->size >> i * 7;
231  if (top)
232  caf->pkt_sizes[caf->size_entries_used++] = 128 | top;
233  }
234  caf->pkt_sizes[caf->size_entries_used++] = pkt->size & 127;
235  caf->packets++;
236  }
237  return 0;
238 }
239 
241 {
242  CAFContext *caf = s->priv_data;
243  AVIOContext *pb = s->pb;
244  AVCodecParameters *par = s->streams[0]->codecpar;
245 
246  if (pb->seekable & AVIO_SEEKABLE_NORMAL) {
247  int64_t file_size = avio_tell(pb);
248 
249  avio_seek(pb, caf->data, SEEK_SET);
250  avio_wb64(pb, file_size - caf->data - 8);
251  avio_seek(pb, file_size, SEEK_SET);
252  if (!par->block_align) {
253  ffio_wfourcc(pb, "pakt");
254  avio_wb64(pb, caf->size_entries_used + 24);
255  avio_wb64(pb, caf->packets); ///< mNumberPackets
256  avio_wb64(pb, caf->packets * samples_per_packet(par->codec_id, par->channels, par->block_align)); ///< mNumberValidFrames
257  avio_wb32(pb, 0); ///< mPrimingFrames
258  avio_wb32(pb, 0); ///< mRemainderFrames
259  avio_write(pb, caf->pkt_sizes, caf->size_entries_used);
260  caf->size_buffer_size = 0;
261  }
262  avio_flush(pb);
263  }
264  av_freep(&caf->pkt_sizes);
265  return 0;
266 }
267 
269  .name = "caf",
270  .long_name = NULL_IF_CONFIG_SMALL("Apple CAF (Core Audio Format)"),
271  .mime_type = "audio/x-caf",
272  .extensions = "caf",
273  .priv_data_size = sizeof(CAFContext),
274  .audio_codec = AV_CODEC_ID_PCM_S16BE,
275  .video_codec = AV_CODEC_ID_NONE,
279  .codec_tag = (const AVCodecTag* const []){ff_codec_caf_tags, 0},
280 };
static void write_packet(OutputFile *of, AVPacket *pkt, OutputStream *ost, int unqueue)
Definition: ffmpeg.c:689
void avio_wb64(AVIOContext *s, uint64_t val)
Definition: aviobuf.c:466
#define NULL
Definition: coverity.c:32
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
int packets
Definition: cafenc.c:34
channels
Definition: aptx.c:30
enum AVCodecID codec_id
Definition: qsv.c:77
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3968
int size
Definition: avcodec.h:1481
int av_dict_count(const AVDictionary *m)
Get number of entries in dictionary.
Definition: dict.c:35
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
CAF common code.
static av_always_inline uint64_t av_double2int(double f)
Reinterpret a double as a 64-bit integer.
Definition: intfloat.h:70
unsigned int ff_codec_get_tag(const AVCodecTag *tags, enum AVCodecID id)
Definition: utils.c:3148
static AVPacket pkt
This struct describes the properties of an encoded stream.
Definition: avcodec.h:3960
int frame_size
Audio only.
Definition: avcodec.h:4089
Format I/O context.
Definition: avformat.h:1358
Public dictionary API.
void avio_wl32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:372
uint8_t
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1426
uint8_t * pkt_sizes
Definition: cafenc.c:31
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
uint8_t * data
Definition: avcodec.h:1480
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:218
static av_always_inline void ffio_wfourcc(AVIOContext *pb, const uint8_t *s)
Definition: avio_internal.h:58
uint64_t channel_layout
Audio only.
Definition: avcodec.h:4070
#define av_log(a,...)
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:215
int size_entries_used
Definition: cafenc.c:33
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
AVDictionary * metadata
Metadata that applies to the whole file.
Definition: avformat.h:1598
int av_get_bits_per_sample(enum AVCodecID codec_id)
Return codec bits per sample.
Definition: utils.c:1528
static int caf_write_header(AVFormatContext *s)
Definition: cafenc.c:105
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
preferred ID for decoding MPEG audio layer 1, 2 or 3
Definition: avcodec.h:566
int ff_standardize_creation_time(AVFormatContext *s)
Standardize creation_time metadata in AVFormatContext to an ISO-8601 timestamp string.
Definition: utils.c:5710
int extradata_size
Size of the extradata content in bytes.
Definition: avcodec.h:3986
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1414
int block_align
Audio only.
Definition: avcodec.h:4085
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:260
AVOutputFormat ff_caf_muxer
Definition: cafenc.c:268
static int write_trailer(AVFormatContext *s1)
Definition: v4l2enc.c:94
const char * name
Definition: avformat.h:505
#define s(width, name)
Definition: cbs_vp9.c:257
static uint32_t samples_per_packet(enum AVCodecID codec_id, int channels, int block_align)
Definition: cafenc.c:54
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:476
static uint32_t codec_flags(enum AVCodecID codec_id)
Definition: cafenc.c:37
int avio_put_str(AVIOContext *s, const char *str)
Write a NULL-terminated string.
Definition: aviobuf.c:388
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
int frame_size
Definition: mxfenc.c:2214
AVIOContext * pb
I/O context.
Definition: avformat.h:1400
void avio_w8(AVIOContext *s, int b)
Definition: aviobuf.c:196
static int caf_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: cafenc.c:210
void avio_flush(AVIOContext *s)
Force flushing of buffered data.
Definition: aviobuf.c:238
void avio_wb16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:478
static int caf_write_trailer(AVFormatContext *s)
Definition: cafenc.c:240
int sample_rate
Audio only.
Definition: avcodec.h:4078
void ff_mov_write_chan(AVIOContext *pb, int64_t channel_layout)
Definition: isom.c:643
Main libavformat public API header.
int64_t data
Definition: cafenc.c:30
int size_buffer_size
Definition: cafenc.c:32
char * key
Definition: dict.h:86
#define av_free(p)
char * value
Definition: dict.h:87
as in Berlin toast format
Definition: avcodec.h:583
void * priv_data
Format private data.
Definition: avformat.h:1386
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:349
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:3982
int channels
Audio only.
Definition: avcodec.h:4074
void avio_wb32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:380
#define av_freep(p)
#define AV_DICT_IGNORE_SUFFIX
Return first entry in a dictionary whose first part corresponds to the search key, ignoring the suffix of the found key string.
Definition: dict.h:70
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1028
const AVCodecTag ff_codec_caf_tags[]
Known codec tags for CAF.
Definition: caf.c:34
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
This structure stores compressed data.
Definition: avcodec.h:1457