2 * Core Audio Format demuxer
3 * Copyright (c) 2007 Justin Ruggles
4 * Copyright (c) 2009 Peter Ross
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * Core Audio Format demuxer
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/intfloat.h"
36 #include "libavutil/dict.h"
39 typedef struct CafContext {
40 int bytes_per_packet; ///< bytes in a packet, or 0 if variable
41 int frames_per_packet; ///< frames in a packet, or 0 if variable
42 int64_t num_bytes; ///< total number of bytes in stream
44 int64_t packet_cnt; ///< packet counter
45 int64_t frame_cnt; ///< frame counter
47 int64_t data_start; ///< data start position, in bytes
48 int64_t data_size; ///< raw data size, in bytes
51 static int probe(AVProbeData *p)
53 if (AV_RB32(p->buf) == MKBETAG('c','a','f','f') && AV_RB16(&p->buf[4]) == 1)
54 return AVPROBE_SCORE_MAX;
58 /** Read audio description chunk */
59 static int read_desc_chunk(AVFormatContext *s)
61 AVIOContext *pb = s->pb;
62 CafContext *caf = s->priv_data;
66 /* new audio stream */
67 st = avformat_new_stream(s, NULL);
69 return AVERROR(ENOMEM);
71 /* parse format description */
72 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
73 st->codecpar->sample_rate = av_int2double(avio_rb64(pb));
74 st->codecpar->codec_tag = avio_rl32(pb);
75 flags = avio_rb32(pb);
76 caf->bytes_per_packet = avio_rb32(pb);
77 st->codecpar->block_align = caf->bytes_per_packet;
78 caf->frames_per_packet = avio_rb32(pb);
79 st->codecpar->channels = avio_rb32(pb);
80 st->codecpar->bits_per_coded_sample = avio_rb32(pb);
82 /* calculate bit rate for constant size packets */
83 if (caf->frames_per_packet > 0 && caf->bytes_per_packet > 0) {
84 st->codecpar->bit_rate = (uint64_t)st->codecpar->sample_rate * (uint64_t)caf->bytes_per_packet * 8
85 / (uint64_t)caf->frames_per_packet;
87 st->codecpar->bit_rate = 0;
91 if (st->codecpar->codec_tag == MKTAG('l','p','c','m'))
92 st->codecpar->codec_id = ff_mov_get_lpcm_codec_id(st->codecpar->bits_per_coded_sample, (flags ^ 0x2) | 0x4);
94 st->codecpar->codec_id = ff_codec_get_id(ff_codec_caf_tags, st->codecpar->codec_tag);
98 /** Read magic cookie chunk */
99 static int read_kuki_chunk(AVFormatContext *s, int64_t size)
101 AVIOContext *pb = s->pb;
102 AVStream *st = s->streams[0];
104 if (size < 0 || size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
107 if (st->codecpar->codec_id == AV_CODEC_ID_AAC) {
108 /* The magic cookie format for AAC is an mp4 esds atom.
109 The lavc AAC decoder requires the data from the codec specific
110 description as extradata input. */
113 strt = avio_tell(pb);
114 ff_mov_read_esds(s, pb);
115 skip = size - (avio_tell(pb) - strt);
116 if (skip < 0 || !st->codecpar->extradata ||
117 st->codecpar->codec_id != AV_CODEC_ID_AAC) {
118 av_log(s, AV_LOG_ERROR, "invalid AAC magic cookie\n");
119 return AVERROR_INVALIDDATA;
122 } else if (st->codecpar->codec_id == AV_CODEC_ID_ALAC) {
123 #define ALAC_PREAMBLE 12
124 #define ALAC_HEADER 36
125 #define ALAC_NEW_KUKI 24
126 uint8_t preamble[12];
127 if (size < ALAC_NEW_KUKI) {
128 av_log(s, AV_LOG_ERROR, "invalid ALAC magic cookie\n");
130 return AVERROR_INVALIDDATA;
132 if (avio_read(pb, preamble, ALAC_PREAMBLE) != ALAC_PREAMBLE) {
133 av_log(s, AV_LOG_ERROR, "failed to read preamble\n");
134 return AVERROR_INVALIDDATA;
137 av_freep(&st->codecpar->extradata);
138 if (ff_alloc_extradata(st->codecpar, ALAC_HEADER))
139 return AVERROR(ENOMEM);
141 /* For the old style cookie, we skip 12 bytes, then read 36 bytes.
142 * The new style cookie only contains the last 24 bytes of what was
143 * 36 bytes in the old style cookie, so we fabricate the first 12 bytes
144 * in that case to maintain compatibility. */
145 if (!memcmp(&preamble[4], "frmaalac", 8)) {
146 if (size < ALAC_PREAMBLE + ALAC_HEADER) {
147 av_log(s, AV_LOG_ERROR, "invalid ALAC magic cookie\n");
148 av_freep(&st->codecpar->extradata);
149 return AVERROR_INVALIDDATA;
151 if (avio_read(pb, st->codecpar->extradata, ALAC_HEADER) != ALAC_HEADER) {
152 av_log(s, AV_LOG_ERROR, "failed to read kuki header\n");
153 av_freep(&st->codecpar->extradata);
154 return AVERROR_INVALIDDATA;
156 avio_skip(pb, size - ALAC_PREAMBLE - ALAC_HEADER);
158 AV_WB32(st->codecpar->extradata, 36);
159 memcpy(&st->codecpar->extradata[4], "alac", 4);
160 AV_WB32(&st->codecpar->extradata[8], 0);
161 memcpy(&st->codecpar->extradata[12], preamble, 12);
162 if (avio_read(pb, &st->codecpar->extradata[24], ALAC_NEW_KUKI - 12) != ALAC_NEW_KUKI - 12) {
163 av_log(s, AV_LOG_ERROR, "failed to read new kuki header\n");
164 av_freep(&st->codecpar->extradata);
165 return AVERROR_INVALIDDATA;
167 avio_skip(pb, size - ALAC_NEW_KUKI);
169 } else if (st->codecpar->codec_id == AV_CODEC_ID_OPUS) {
170 // The data layout for Opus is currently unknown, so we do not export
171 // extradata at all. Multichannel streams are not supported.
172 if (st->codecpar->channels > 2) {
173 avpriv_request_sample(s, "multichannel Opus in CAF");
174 return AVERROR_PATCHWELCOME;
178 av_freep(&st->codecpar->extradata);
179 if (ff_get_extradata(s, st->codecpar, pb, size) < 0)
180 return AVERROR(ENOMEM);
186 /** Read packet table chunk */
187 static int read_pakt_chunk(AVFormatContext *s, int64_t size)
189 AVIOContext *pb = s->pb;
190 AVStream *st = s->streams[0];
191 CafContext *caf = s->priv_data;
192 int64_t pos = 0, ccount, num_packets;
195 ccount = avio_tell(pb);
197 num_packets = avio_rb64(pb);
198 if (num_packets < 0 || INT32_MAX / sizeof(AVIndexEntry) < num_packets)
199 return AVERROR_INVALIDDATA;
201 st->nb_frames = avio_rb64(pb); /* valid frames */
202 st->nb_frames += avio_rb32(pb); /* priming frames */
203 st->nb_frames += avio_rb32(pb); /* remainder frames */
206 for (i = 0; i < num_packets; i++) {
207 av_add_index_entry(s->streams[0], pos, st->duration, 0, 0, AVINDEX_KEYFRAME);
208 pos += caf->bytes_per_packet ? caf->bytes_per_packet : ff_mp4_read_descr_len(pb);
209 st->duration += caf->frames_per_packet ? caf->frames_per_packet : ff_mp4_read_descr_len(pb);
212 if (avio_tell(pb) - ccount > size) {
213 av_log(s, AV_LOG_ERROR, "error reading packet table\n");
214 return AVERROR_INVALIDDATA;
216 avio_skip(pb, ccount + size - avio_tell(pb));
218 caf->num_bytes = pos;
222 /** Read information chunk */
223 static void read_info_chunk(AVFormatContext *s, int64_t size)
225 AVIOContext *pb = s->pb;
227 unsigned int nb_entries = avio_rb32(pb);
228 for (i = 0; i < nb_entries && !avio_feof(pb); i++) {
231 avio_get_str(pb, INT_MAX, key, sizeof(key));
232 avio_get_str(pb, INT_MAX, value, sizeof(value));
233 av_dict_set(&s->metadata, key, value, 0);
237 static int read_header(AVFormatContext *s)
239 AVIOContext *pb = s->pb;
240 CafContext *caf = s->priv_data;
246 avio_skip(pb, 8); /* magic, version, file flags */
248 /* audio description chunk */
249 if (avio_rb32(pb) != MKBETAG('d','e','s','c')) {
250 av_log(s, AV_LOG_ERROR, "desc chunk not present\n");
251 return AVERROR_INVALIDDATA;
253 size = avio_rb64(pb);
255 return AVERROR_INVALIDDATA;
257 ret = read_desc_chunk(s);
262 /* parse each chunk */
264 while (!avio_feof(pb)) {
266 /* stop at data chunk if seeking is not supported or
267 data chunk size is unknown */
268 if (found_data && (caf->data_size < 0 || !(pb->seekable & AVIO_SEEKABLE_NORMAL)))
272 size = avio_rb64(pb);
278 case MKBETAG('d','a','t','a'):
279 avio_skip(pb, 4); /* edit count */
280 caf->data_start = avio_tell(pb);
281 caf->data_size = size < 0 ? -1 : size - 4;
282 if (caf->data_size > 0 && (pb->seekable & AVIO_SEEKABLE_NORMAL))
283 avio_skip(pb, caf->data_size);
287 case MKBETAG('c','h','a','n'):
288 if ((ret = ff_mov_read_chan(s, s->pb, st, size)) < 0)
292 /* magic cookie chunk */
293 case MKBETAG('k','u','k','i'):
294 if (read_kuki_chunk(s, size))
295 return AVERROR_INVALIDDATA;
298 /* packet table chunk */
299 case MKBETAG('p','a','k','t'):
300 if (read_pakt_chunk(s, size))
301 return AVERROR_INVALIDDATA;
304 case MKBETAG('i','n','f','o'):
305 read_info_chunk(s, size);
309 av_log(s, AV_LOG_WARNING,
310 "skipping CAF chunk: %08"PRIX32" (%s), size %"PRId64"\n",
311 tag, av_fourcc2str(av_bswap32(tag)), size);
312 case MKBETAG('f','r','e','e'):
314 return AVERROR_INVALIDDATA;
319 if (pos > INT64_MAX - size)
320 return AVERROR_INVALIDDATA;
321 avio_skip(pb, FFMAX(0, pos + size - avio_tell(pb)));
326 return AVERROR_INVALIDDATA;
328 if (caf->bytes_per_packet > 0 && caf->frames_per_packet > 0) {
329 if (caf->data_size > 0)
330 st->nb_frames = (caf->data_size / caf->bytes_per_packet) * caf->frames_per_packet;
331 } else if (st->nb_index_entries && st->duration > 0) {
332 if (st->codecpar->sample_rate && caf->data_size / st->duration > INT64_MAX / st->codecpar->sample_rate / 8) {
333 av_log(s, AV_LOG_ERROR, "Overflow during bit rate calculation %d * 8 * %"PRId64"\n",
334 st->codecpar->sample_rate, caf->data_size / st->duration);
335 return AVERROR_INVALIDDATA;
337 st->codecpar->bit_rate = st->codecpar->sample_rate * 8LL *
338 (caf->data_size / st->duration);
340 av_log(s, AV_LOG_ERROR, "Missing packet table. It is required when "
341 "block size or frame size are variable.\n");
342 return AVERROR_INVALIDDATA;
345 avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
348 /* position the stream at the start of data */
349 if (caf->data_size >= 0)
350 avio_seek(pb, caf->data_start, SEEK_SET);
355 #define CAF_MAX_PKT_SIZE 4096
357 static int read_packet(AVFormatContext *s, AVPacket *pkt)
359 AVIOContext *pb = s->pb;
360 AVStream *st = s->streams[0];
361 CafContext *caf = s->priv_data;
362 int res, pkt_size = 0, pkt_frames = 0;
363 int64_t left = CAF_MAX_PKT_SIZE;
368 /* don't read past end of data chunk */
369 if (caf->data_size > 0) {
370 left = (caf->data_start + caf->data_size) - avio_tell(pb);
377 pkt_frames = caf->frames_per_packet;
378 pkt_size = caf->bytes_per_packet;
380 if (pkt_size > 0 && pkt_frames == 1) {
381 pkt_size = (CAF_MAX_PKT_SIZE / pkt_size) * pkt_size;
382 pkt_size = FFMIN(pkt_size, left);
383 pkt_frames = pkt_size / caf->bytes_per_packet;
384 } else if (st->nb_index_entries) {
385 if (caf->packet_cnt < st->nb_index_entries - 1) {
386 pkt_size = st->index_entries[caf->packet_cnt + 1].pos - st->index_entries[caf->packet_cnt].pos;
387 pkt_frames = st->index_entries[caf->packet_cnt + 1].timestamp - st->index_entries[caf->packet_cnt].timestamp;
388 } else if (caf->packet_cnt == st->nb_index_entries - 1) {
389 pkt_size = caf->num_bytes - st->index_entries[caf->packet_cnt].pos;
390 pkt_frames = st->duration - st->index_entries[caf->packet_cnt].timestamp;
396 if (pkt_size == 0 || pkt_frames == 0 || pkt_size > left)
399 res = av_get_packet(pb, pkt, pkt_size);
404 pkt->stream_index = 0;
405 pkt->dts = pkt->pts = caf->frame_cnt;
408 caf->frame_cnt += pkt_frames;
413 static int read_seek(AVFormatContext *s, int stream_index,
414 int64_t timestamp, int flags)
416 AVStream *st = s->streams[0];
417 CafContext *caf = s->priv_data;
418 int64_t pos, packet_cnt, frame_cnt;
420 timestamp = FFMAX(timestamp, 0);
422 if (caf->frames_per_packet > 0 && caf->bytes_per_packet > 0) {
423 /* calculate new byte position based on target frame position */
424 pos = caf->bytes_per_packet * (timestamp / caf->frames_per_packet);
425 if (caf->data_size > 0)
426 pos = FFMIN(pos, caf->data_size);
427 packet_cnt = pos / caf->bytes_per_packet;
428 frame_cnt = caf->frames_per_packet * packet_cnt;
429 } else if (st->nb_index_entries) {
430 packet_cnt = av_index_search_timestamp(st, timestamp, flags);
431 frame_cnt = st->index_entries[packet_cnt].timestamp;
432 pos = st->index_entries[packet_cnt].pos;
437 if (avio_seek(s->pb, pos + caf->data_start, SEEK_SET) < 0)
440 caf->packet_cnt = packet_cnt;
441 caf->frame_cnt = frame_cnt;
446 AVInputFormat ff_caf_demuxer = {
448 .long_name = NULL_IF_CONFIG_SMALL("Apple CAF (Core Audio Format)"),
449 .priv_data_size = sizeof(CafContext),
451 .read_header = read_header,
452 .read_packet = read_packet,
453 .read_seek = read_seek,
454 .codec_tag = (const AVCodecTag* const []){ ff_codec_caf_tags, 0 },