Revert "lavd: add new API for iterating input and output devices"
[ffmpeg.git] / libavformat / cafdec.c
1 /*
2  * Core Audio Format demuxer
3  * Copyright (c) 2007 Justin Ruggles
4  * Copyright (c) 2009 Peter Ross
5  *
6  * This file is part of FFmpeg.
7  *
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.
12  *
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.
17  *
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
21  */
22
23 /**
24  * @file
25  * Core Audio Format demuxer
26  */
27
28 #include <inttypes.h>
29
30 #include "avformat.h"
31 #include "internal.h"
32 #include "isom.h"
33 #include "mov_chan.h"
34 #include "libavutil/intreadwrite.h"
35 #include "libavutil/intfloat.h"
36 #include "libavutil/dict.h"
37 #include "caf.h"
38
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
43
44     int64_t packet_cnt;             ///< packet counter
45     int64_t frame_cnt;              ///< frame counter
46
47     int64_t data_start;             ///< data start position, in bytes
48     int64_t data_size;              ///< raw data size, in bytes
49 } CafContext;
50
51 static int probe(AVProbeData *p)
52 {
53     if (AV_RB32(p->buf) == MKBETAG('c','a','f','f') && AV_RB16(&p->buf[4]) == 1)
54         return AVPROBE_SCORE_MAX;
55     return 0;
56 }
57
58 /** Read audio description chunk */
59 static int read_desc_chunk(AVFormatContext *s)
60 {
61     AVIOContext *pb = s->pb;
62     CafContext *caf = s->priv_data;
63     AVStream *st;
64     int flags;
65
66     /* new audio stream */
67     st = avformat_new_stream(s, NULL);
68     if (!st)
69         return AVERROR(ENOMEM);
70
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);
81
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;
86     } else {
87         st->codecpar->bit_rate = 0;
88     }
89
90     /* determine codec */
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);
93     else
94         st->codecpar->codec_id = ff_codec_get_id(ff_codec_caf_tags, st->codecpar->codec_tag);
95     return 0;
96 }
97
98 /** Read magic cookie chunk */
99 static int read_kuki_chunk(AVFormatContext *s, int64_t size)
100 {
101     AVIOContext *pb = s->pb;
102     AVStream *st      = s->streams[0];
103
104     if (size < 0 || size > INT_MAX - AV_INPUT_BUFFER_PADDING_SIZE)
105         return -1;
106
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. */
111         int strt, skip;
112
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;
120         }
121         avio_skip(pb, skip);
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");
129             avio_skip(pb, size);
130             return AVERROR_INVALIDDATA;
131         }
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;
135         }
136
137         av_freep(&st->codecpar->extradata);
138         if (ff_alloc_extradata(st->codecpar, ALAC_HEADER))
139             return AVERROR(ENOMEM);
140
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;
150             }
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;
155             }
156             avio_skip(pb, size - ALAC_PREAMBLE - ALAC_HEADER);
157         } else {
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;
166             }
167             avio_skip(pb, size - ALAC_NEW_KUKI);
168         }
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;
175         }
176         avio_skip(pb, size);
177     } else {
178         av_freep(&st->codecpar->extradata);
179         if (ff_get_extradata(s, st->codecpar, pb, size) < 0)
180             return AVERROR(ENOMEM);
181     }
182
183     return 0;
184 }
185
186 /** Read packet table chunk */
187 static int read_pakt_chunk(AVFormatContext *s, int64_t size)
188 {
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;
193     int i;
194
195     ccount = avio_tell(pb);
196
197     num_packets = avio_rb64(pb);
198     if (num_packets < 0 || INT32_MAX / sizeof(AVIndexEntry) < num_packets)
199         return AVERROR_INVALIDDATA;
200
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 */
204
205     st->duration = 0;
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);
210     }
211
212     if (avio_tell(pb) - ccount > size) {
213         av_log(s, AV_LOG_ERROR, "error reading packet table\n");
214         return AVERROR_INVALIDDATA;
215     }
216     avio_skip(pb, ccount + size - avio_tell(pb));
217
218     caf->num_bytes = pos;
219     return 0;
220 }
221
222 /** Read information chunk */
223 static void read_info_chunk(AVFormatContext *s, int64_t size)
224 {
225     AVIOContext *pb = s->pb;
226     unsigned int i;
227     unsigned int nb_entries = avio_rb32(pb);
228     for (i = 0; i < nb_entries && !avio_feof(pb); i++) {
229         char key[32];
230         char value[1024];
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);
234     }
235 }
236
237 static int read_header(AVFormatContext *s)
238 {
239     AVIOContext *pb = s->pb;
240     CafContext *caf = s->priv_data;
241     AVStream *st;
242     uint32_t tag = 0;
243     int found_data, ret;
244     int64_t size, pos;
245
246     avio_skip(pb, 8); /* magic, version, file flags */
247
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;
252     }
253     size = avio_rb64(pb);
254     if (size != 32)
255         return AVERROR_INVALIDDATA;
256
257     ret = read_desc_chunk(s);
258     if (ret)
259         return ret;
260     st = s->streams[0];
261
262     /* parse each chunk */
263     found_data = 0;
264     while (!avio_feof(pb)) {
265
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)))
269             break;
270
271         tag  = avio_rb32(pb);
272         size = avio_rb64(pb);
273         pos  = avio_tell(pb);
274         if (avio_feof(pb))
275             break;
276
277         switch (tag) {
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);
284             found_data = 1;
285             break;
286
287         case MKBETAG('c','h','a','n'):
288             if ((ret = ff_mov_read_chan(s, s->pb, st, size)) < 0)
289                 return ret;
290             break;
291
292         /* magic cookie chunk */
293         case MKBETAG('k','u','k','i'):
294             if (read_kuki_chunk(s, size))
295                 return AVERROR_INVALIDDATA;
296             break;
297
298         /* packet table chunk */
299         case MKBETAG('p','a','k','t'):
300             if (read_pakt_chunk(s, size))
301                 return AVERROR_INVALIDDATA;
302             break;
303
304         case MKBETAG('i','n','f','o'):
305             read_info_chunk(s, size);
306             break;
307
308         default:
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'):
313             if (size < 0)
314                 return AVERROR_INVALIDDATA;
315             break;
316         }
317
318         if (size > 0) {
319             if (pos > INT64_MAX - size)
320                 return AVERROR_INVALIDDATA;
321             avio_skip(pb, FFMAX(0, pos + size - avio_tell(pb)));
322         }
323     }
324
325     if (!found_data)
326         return AVERROR_INVALIDDATA;
327
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;
336         }
337         st->codecpar->bit_rate = st->codecpar->sample_rate * 8LL *
338                                  (caf->data_size / st->duration);
339     } else {
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;
343     }
344
345     avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
346     st->start_time = 0;
347
348     /* position the stream at the start of data */
349     if (caf->data_size >= 0)
350         avio_seek(pb, caf->data_start, SEEK_SET);
351
352     return 0;
353 }
354
355 #define CAF_MAX_PKT_SIZE 4096
356
357 static int read_packet(AVFormatContext *s, AVPacket *pkt)
358 {
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;
364
365     if (avio_feof(pb))
366         return AVERROR_EOF;
367
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);
371         if (!left)
372             return AVERROR_EOF;
373         if (left < 0)
374             return AVERROR(EIO);
375     }
376
377     pkt_frames = caf->frames_per_packet;
378     pkt_size   = caf->bytes_per_packet;
379
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;
391         } else {
392             return AVERROR(EIO);
393         }
394     }
395
396     if (pkt_size == 0 || pkt_frames == 0 || pkt_size > left)
397         return AVERROR(EIO);
398
399     res = av_get_packet(pb, pkt, pkt_size);
400     if (res < 0)
401         return res;
402
403     pkt->size           = res;
404     pkt->stream_index   = 0;
405     pkt->dts = pkt->pts = caf->frame_cnt;
406
407     caf->packet_cnt++;
408     caf->frame_cnt += pkt_frames;
409
410     return 0;
411 }
412
413 static int read_seek(AVFormatContext *s, int stream_index,
414                      int64_t timestamp, int flags)
415 {
416     AVStream *st = s->streams[0];
417     CafContext *caf = s->priv_data;
418     int64_t pos, packet_cnt, frame_cnt;
419
420     timestamp = FFMAX(timestamp, 0);
421
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;
433     } else {
434         return -1;
435     }
436
437     if (avio_seek(s->pb, pos + caf->data_start, SEEK_SET) < 0)
438         return -1;
439
440     caf->packet_cnt = packet_cnt;
441     caf->frame_cnt  = frame_cnt;
442
443     return 0;
444 }
445
446 AVInputFormat ff_caf_demuxer = {
447     .name           = "caf",
448     .long_name      = NULL_IF_CONFIG_SMALL("Apple CAF (Core Audio Format)"),
449     .priv_data_size = sizeof(CafContext),
450     .read_probe     = probe,
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 },
455 };