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(const 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_clipd(av_int2double(avio_rb64(pb)), 0, INT_MAX);
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 if (caf->bytes_per_packet < 0 || caf->frames_per_packet < 0)
83 return AVERROR_INVALIDDATA;
85 /* calculate bit rate for constant size packets */
86 if (caf->frames_per_packet > 0 && caf->bytes_per_packet > 0) {
87 st->codecpar->bit_rate = (uint64_t)st->codecpar->sample_rate * (uint64_t)caf->bytes_per_packet * 8
88 / (uint64_t)caf->frames_per_packet;
90 st->codecpar->bit_rate = 0;
94 if (st->codecpar->codec_tag == MKTAG('l','p','c','m'))
95 st->codecpar->codec_id = ff_mov_get_lpcm_codec_id(st->codecpar->bits_per_coded_sample, (flags ^ 0x2) | 0x4);
97 st->codecpar->codec_id = ff_codec_get_id(ff_codec_caf_tags, st->codecpar->codec_tag);
101 /** Read magic cookie chunk */
102 static int read_kuki_chunk(AVFormatContext *s, int64_t size)
104 AVIOContext *pb = s->pb;
105 AVStream *st = s->streams[0];
108 if (size < 0 || size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
111 if (st->codecpar->codec_id == AV_CODEC_ID_AAC) {
112 /* The magic cookie format for AAC is an mp4 esds atom.
113 The lavc AAC decoder requires the data from the codec specific
114 description as extradata input. */
117 strt = avio_tell(pb);
118 ff_mov_read_esds(s, pb);
119 skip = size - (avio_tell(pb) - strt);
120 if (skip < 0 || !st->codecpar->extradata ||
121 st->codecpar->codec_id != AV_CODEC_ID_AAC) {
122 av_log(s, AV_LOG_ERROR, "invalid AAC magic cookie\n");
123 return AVERROR_INVALIDDATA;
126 } else if (st->codecpar->codec_id == AV_CODEC_ID_ALAC) {
127 #define ALAC_PREAMBLE 12
128 #define ALAC_HEADER 36
129 #define ALAC_NEW_KUKI 24
130 uint8_t preamble[12];
131 if (size < ALAC_NEW_KUKI) {
132 av_log(s, AV_LOG_ERROR, "invalid ALAC magic cookie\n");
134 return AVERROR_INVALIDDATA;
136 if (avio_read(pb, preamble, ALAC_PREAMBLE) != ALAC_PREAMBLE) {
137 av_log(s, AV_LOG_ERROR, "failed to read preamble\n");
138 return AVERROR_INVALIDDATA;
141 if ((ret = ff_alloc_extradata(st->codecpar, ALAC_HEADER)) < 0)
144 /* For the old style cookie, we skip 12 bytes, then read 36 bytes.
145 * The new style cookie only contains the last 24 bytes of what was
146 * 36 bytes in the old style cookie, so we fabricate the first 12 bytes
147 * in that case to maintain compatibility. */
148 if (!memcmp(&preamble[4], "frmaalac", 8)) {
149 if (size < ALAC_PREAMBLE + ALAC_HEADER) {
150 av_log(s, AV_LOG_ERROR, "invalid ALAC magic cookie\n");
151 av_freep(&st->codecpar->extradata);
152 return AVERROR_INVALIDDATA;
154 if (avio_read(pb, st->codecpar->extradata, ALAC_HEADER) != ALAC_HEADER) {
155 av_log(s, AV_LOG_ERROR, "failed to read kuki header\n");
156 av_freep(&st->codecpar->extradata);
157 return AVERROR_INVALIDDATA;
159 avio_skip(pb, size - ALAC_PREAMBLE - ALAC_HEADER);
161 AV_WB32(st->codecpar->extradata, 36);
162 memcpy(&st->codecpar->extradata[4], "alac", 4);
163 AV_WB32(&st->codecpar->extradata[8], 0);
164 memcpy(&st->codecpar->extradata[12], preamble, 12);
165 if (avio_read(pb, &st->codecpar->extradata[24], ALAC_NEW_KUKI - 12) != ALAC_NEW_KUKI - 12) {
166 av_log(s, AV_LOG_ERROR, "failed to read new kuki header\n");
167 av_freep(&st->codecpar->extradata);
168 return AVERROR_INVALIDDATA;
170 avio_skip(pb, size - ALAC_NEW_KUKI);
172 } else if (st->codecpar->codec_id == AV_CODEC_ID_OPUS) {
173 // The data layout for Opus is currently unknown, so we do not export
174 // extradata at all. Multichannel streams are not supported.
175 if (st->codecpar->channels > 2) {
176 avpriv_request_sample(s, "multichannel Opus in CAF");
177 return AVERROR_PATCHWELCOME;
180 } else if ((ret = ff_get_extradata(s, st->codecpar, pb, size)) < 0) {
187 /** Read packet table chunk */
188 static int read_pakt_chunk(AVFormatContext *s, int64_t size)
190 AVIOContext *pb = s->pb;
191 AVStream *st = s->streams[0];
192 CafContext *caf = s->priv_data;
193 int64_t pos = 0, ccount, num_packets;
197 ccount = avio_tell(pb);
199 num_packets = avio_rb64(pb);
200 if (num_packets < 0 || INT32_MAX / sizeof(AVIndexEntry) < num_packets)
201 return AVERROR_INVALIDDATA;
203 st->nb_frames = avio_rb64(pb); /* valid frames */
204 st->nb_frames += avio_rb32(pb); /* priming frames */
205 st->nb_frames += avio_rb32(pb); /* remainder frames */
208 for (i = 0; i < num_packets; i++) {
210 return AVERROR_INVALIDDATA;
211 ret = av_add_index_entry(s->streams[0], pos, st->duration, 0, 0, AVINDEX_KEYFRAME);
214 pos += caf->bytes_per_packet ? caf->bytes_per_packet : ff_mp4_read_descr_len(pb);
215 st->duration += caf->frames_per_packet ? caf->frames_per_packet : ff_mp4_read_descr_len(pb);
218 if (avio_tell(pb) - ccount > size) {
219 av_log(s, AV_LOG_ERROR, "error reading packet table\n");
220 return AVERROR_INVALIDDATA;
222 avio_skip(pb, ccount + size - avio_tell(pb));
224 caf->num_bytes = pos;
228 /** Read information chunk */
229 static void read_info_chunk(AVFormatContext *s, int64_t size)
231 AVIOContext *pb = s->pb;
233 unsigned int nb_entries = avio_rb32(pb);
234 for (i = 0; i < nb_entries && !avio_feof(pb); i++) {
237 avio_get_str(pb, INT_MAX, key, sizeof(key));
238 avio_get_str(pb, INT_MAX, value, sizeof(value));
239 av_dict_set(&s->metadata, key, value, 0);
243 static int read_header(AVFormatContext *s)
245 AVIOContext *pb = s->pb;
246 CafContext *caf = s->priv_data;
252 avio_skip(pb, 8); /* magic, version, file flags */
254 /* audio description chunk */
255 if (avio_rb32(pb) != MKBETAG('d','e','s','c')) {
256 av_log(s, AV_LOG_ERROR, "desc chunk not present\n");
257 return AVERROR_INVALIDDATA;
259 size = avio_rb64(pb);
261 return AVERROR_INVALIDDATA;
263 ret = read_desc_chunk(s);
268 /* parse each chunk */
270 while (!avio_feof(pb)) {
272 /* stop at data chunk if seeking is not supported or
273 data chunk size is unknown */
274 if (found_data && (caf->data_size < 0 || !(pb->seekable & AVIO_SEEKABLE_NORMAL)))
278 size = avio_rb64(pb);
284 case MKBETAG('d','a','t','a'):
285 avio_skip(pb, 4); /* edit count */
286 caf->data_start = avio_tell(pb);
287 caf->data_size = size < 0 ? -1 : size - 4;
288 if (caf->data_size > 0 && (pb->seekable & AVIO_SEEKABLE_NORMAL))
289 avio_skip(pb, caf->data_size);
293 case MKBETAG('c','h','a','n'):
294 if ((ret = ff_mov_read_chan(s, s->pb, st, size)) < 0)
298 /* magic cookie chunk */
299 case MKBETAG('k','u','k','i'):
300 if (read_kuki_chunk(s, size))
301 return AVERROR_INVALIDDATA;
304 /* packet table chunk */
305 case MKBETAG('p','a','k','t'):
306 if (read_pakt_chunk(s, size))
307 return AVERROR_INVALIDDATA;
310 case MKBETAG('i','n','f','o'):
311 read_info_chunk(s, size);
315 av_log(s, AV_LOG_WARNING,
316 "skipping CAF chunk: %08"PRIX32" (%s), size %"PRId64"\n",
317 tag, av_fourcc2str(av_bswap32(tag)), size);
318 case MKBETAG('f','r','e','e'):
319 if (size < 0 && found_data)
322 return AVERROR_INVALIDDATA;
327 if (pos > INT64_MAX - size)
328 return AVERROR_INVALIDDATA;
329 avio_skip(pb, FFMAX(0, pos + size - avio_tell(pb)));
334 return AVERROR_INVALIDDATA;
337 if (caf->bytes_per_packet > 0 && caf->frames_per_packet > 0) {
338 if (caf->data_size > 0)
339 st->nb_frames = (caf->data_size / caf->bytes_per_packet) * caf->frames_per_packet;
340 } else if (st->internal->nb_index_entries && st->duration > 0) {
341 if (st->codecpar->sample_rate && caf->data_size / st->duration > INT64_MAX / st->codecpar->sample_rate / 8) {
342 av_log(s, AV_LOG_ERROR, "Overflow during bit rate calculation %d * 8 * %"PRId64"\n",
343 st->codecpar->sample_rate, caf->data_size / st->duration);
344 return AVERROR_INVALIDDATA;
346 st->codecpar->bit_rate = st->codecpar->sample_rate * 8LL *
347 (caf->data_size / st->duration);
349 av_log(s, AV_LOG_ERROR, "Missing packet table. It is required when "
350 "block size or frame size are variable.\n");
351 return AVERROR_INVALIDDATA;
354 avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
357 /* position the stream at the start of data */
358 if (caf->data_size >= 0)
359 avio_seek(pb, caf->data_start, SEEK_SET);
364 #define CAF_MAX_PKT_SIZE 4096
366 static int read_packet(AVFormatContext *s, AVPacket *pkt)
368 AVIOContext *pb = s->pb;
369 AVStream *st = s->streams[0];
370 CafContext *caf = s->priv_data;
371 int res, pkt_size = 0, pkt_frames = 0;
372 int64_t left = CAF_MAX_PKT_SIZE;
377 /* don't read past end of data chunk */
378 if (caf->data_size > 0) {
379 left = (caf->data_start + caf->data_size) - avio_tell(pb);
386 pkt_frames = caf->frames_per_packet;
387 pkt_size = caf->bytes_per_packet;
389 if (pkt_size > 0 && pkt_frames == 1) {
390 pkt_size = (CAF_MAX_PKT_SIZE / pkt_size) * pkt_size;
391 pkt_size = FFMIN(pkt_size, left);
392 pkt_frames = pkt_size / caf->bytes_per_packet;
393 } else if (st->internal->nb_index_entries) {
394 if (caf->packet_cnt < st->internal->nb_index_entries - 1) {
395 pkt_size = st->internal->index_entries[caf->packet_cnt + 1].pos - st->internal->index_entries[caf->packet_cnt].pos;
396 pkt_frames = st->internal->index_entries[caf->packet_cnt + 1].timestamp - st->internal->index_entries[caf->packet_cnt].timestamp;
397 } else if (caf->packet_cnt == st->internal->nb_index_entries - 1) {
398 pkt_size = caf->num_bytes - st->internal->index_entries[caf->packet_cnt].pos;
399 pkt_frames = st->duration - st->internal->index_entries[caf->packet_cnt].timestamp;
405 if (pkt_size == 0 || pkt_frames == 0 || pkt_size > left)
408 res = av_get_packet(pb, pkt, pkt_size);
413 pkt->stream_index = 0;
414 pkt->dts = pkt->pts = caf->frame_cnt;
417 caf->frame_cnt += pkt_frames;
422 static int read_seek(AVFormatContext *s, int stream_index,
423 int64_t timestamp, int flags)
425 AVStream *st = s->streams[0];
426 CafContext *caf = s->priv_data;
427 int64_t pos, packet_cnt, frame_cnt;
429 timestamp = FFMAX(timestamp, 0);
431 if (caf->frames_per_packet > 0 && caf->bytes_per_packet > 0) {
432 /* calculate new byte position based on target frame position */
433 pos = caf->bytes_per_packet * (timestamp / caf->frames_per_packet);
434 if (caf->data_size > 0)
435 pos = FFMIN(pos, caf->data_size);
436 packet_cnt = pos / caf->bytes_per_packet;
437 frame_cnt = caf->frames_per_packet * packet_cnt;
438 } else if (st->internal->nb_index_entries) {
439 packet_cnt = av_index_search_timestamp(st, timestamp, flags);
440 frame_cnt = st->internal->index_entries[packet_cnt].timestamp;
441 pos = st->internal->index_entries[packet_cnt].pos;
446 if (avio_seek(s->pb, pos + caf->data_start, SEEK_SET) < 0)
449 caf->packet_cnt = packet_cnt;
450 caf->frame_cnt = frame_cnt;
455 AVInputFormat ff_caf_demuxer = {
457 .long_name = NULL_IF_CONFIG_SMALL("Apple CAF (Core Audio Format)"),
458 .priv_data_size = sizeof(CafContext),
460 .read_header = read_header,
461 .read_packet = read_packet,
462 .read_seek = read_seek,
463 .codec_tag = ff_caf_codec_tags_list,