libavformat/cafdec.c
5f14b565
 /*
  * Core Audio Format demuxer
  * Copyright (c) 2007 Justin Ruggles
  * Copyright (c) 2009 Peter Ross
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
ba87f080
  * @file
5f14b565
  * Core Audio Format demuxer
  */
 
 #include "avformat.h"
c3f9ebf7
 #include "internal.h"
5f14b565
 #include "isom.h"
3bab7cd1
 #include "mov_chan.h"
5f14b565
 #include "libavutil/intreadwrite.h"
3383a53e
 #include "libavutil/intfloat.h"
d2d67e42
 #include "libavutil/dict.h"
5f14b565
 #include "caf.h"
 
 typedef struct {
     int bytes_per_packet;           ///< bytes in a packet, or 0 if variable
     int frames_per_packet;          ///< frames in a packet, or 0 if variable
     int64_t num_bytes;              ///< total number of bytes in stream
 
     int64_t packet_cnt;             ///< packet counter
     int64_t frame_cnt;              ///< frame counter
 
     int64_t data_start;             ///< data start position, in bytes
     int64_t data_size;              ///< raw data size, in bytes
 } CaffContext;
 
 static int probe(AVProbeData *p)
 {
     if (AV_RB32(p->buf) == MKBETAG('c','a','f','f') && AV_RB16(&p->buf[4]) == 1)
         return AVPROBE_SCORE_MAX;
     return 0;
 }
 
 /** Read audio description chunk */
 static int read_desc_chunk(AVFormatContext *s)
 {
471fe57e
     AVIOContext *pb = s->pb;
5f14b565
     CaffContext *caf  = s->priv_data;
     AVStream *st;
     int flags;
 
     /* new audio stream */
3b3bbdd3
     st = avformat_new_stream(s, NULL);
5f14b565
     if (!st)
2874c81c
         return AVERROR(ENOMEM);
5f14b565
 
     /* parse format description */
72415b2a
     st->codec->codec_type  = AVMEDIA_TYPE_AUDIO;
3383a53e
     st->codec->sample_rate = av_int2double(avio_rb64(pb));
88084eec
     st->codec->codec_tag   = avio_rl32(pb);
e63a3628
     flags = avio_rb32(pb);
     caf->bytes_per_packet  = avio_rb32(pb);
5f14b565
     st->codec->block_align = caf->bytes_per_packet;
e63a3628
     caf->frames_per_packet = avio_rb32(pb);
     st->codec->channels    = avio_rb32(pb);
     st->codec->bits_per_coded_sample = avio_rb32(pb);
5f14b565
 
     /* calculate bit rate for constant size packets */
     if (caf->frames_per_packet > 0 && caf->bytes_per_packet > 0) {
         st->codec->bit_rate = (uint64_t)st->codec->sample_rate * (uint64_t)caf->bytes_per_packet * 8
                               / (uint64_t)caf->frames_per_packet;
     } else {
         st->codec->bit_rate = 0;
     }
 
     /* determine codec */
88084eec
     if (st->codec->codec_tag == MKTAG('l','p','c','m'))
5f14b565
         st->codec->codec_id = ff_mov_get_lpcm_codec_id(st->codec->bits_per_coded_sample, (flags ^ 0x2) | 0x4);
     else
         st->codec->codec_id = ff_codec_get_id(ff_codec_caf_tags, st->codec->codec_tag);
     return 0;
 }
 
 /** Read magic cookie chunk */
 static int read_kuki_chunk(AVFormatContext *s, int64_t size)
 {
471fe57e
     AVIOContext *pb = s->pb;
5f14b565
     AVStream *st      = s->streams[0];
 
     if (size < 0 || size > INT_MAX - FF_INPUT_BUFFER_PADDING_SIZE)
         return -1;
 
36ef5369
     if (st->codec->codec_id == AV_CODEC_ID_AAC) {
5f14b565
         /* The magic cookie format for AAC is an mp4 esds atom.
            The lavc AAC decoder requires the data from the codec specific
            description as extradata input. */
         int strt, skip;
         MOVAtom atom;
 
384c9c2f
         strt = avio_tell(pb);
5f14b565
         ff_mov_read_esds(s, pb, atom);
384c9c2f
         skip = size - (avio_tell(pb) - strt);
5f14b565
         if (skip < 0 || !st->codec->extradata ||
36ef5369
             st->codec->codec_id != AV_CODEC_ID_AAC) {
5f14b565
             av_log(s, AV_LOG_ERROR, "invalid AAC magic cookie\n");
             return AVERROR_INVALIDDATA;
         }
45a8a02a
         avio_skip(pb, skip);
36ef5369
     } else if (st->codec->codec_id == AV_CODEC_ID_ALAC) {
1e6f8d53
 #define ALAC_PREAMBLE 12
 #define ALAC_HEADER   36
80af00b4
 #define ALAC_NEW_KUKI 24
b0b77b9c
         uint8_t preamble[12];
1749e12f
         if (size < ALAC_NEW_KUKI) {
1e6f8d53
             av_log(s, AV_LOG_ERROR, "invalid ALAC magic cookie\n");
45a8a02a
             avio_skip(pb, size);
1e6f8d53
             return AVERROR_INVALIDDATA;
         }
b0b77b9c
         avio_read(pb, preamble, ALAC_PREAMBLE);
 
a807c682
         if (ff_alloc_extradata(st->codec, ALAC_HEADER))
1e6f8d53
             return AVERROR(ENOMEM);
b0b77b9c
 
         /* For the old style cookie, we skip 12 bytes, then read 36 bytes.
          * The new style cookie only contains the last 24 bytes of what was
          * 36 bytes in the old style cookie, so we fabricate the first 12 bytes
          * in that case to maintain compatibility. */
         if (!memcmp(&preamble[4], "frmaalac", 8)) {
d6af8e68
             if (size < ALAC_PREAMBLE + ALAC_HEADER) {
                 av_log(s, AV_LOG_ERROR, "invalid ALAC magic cookie\n");
b0b77b9c
                 av_freep(&st->codec->extradata);
d6af8e68
                 return AVERROR_INVALIDDATA;
             }
             avio_read(pb, st->codec->extradata, ALAC_HEADER);
             avio_skip(pb, size - ALAC_PREAMBLE - ALAC_HEADER);
b0b77b9c
         } else {
             AV_WB32(st->codec->extradata, 36);
             memcpy(&st->codec->extradata[4], "alac", 4);
             AV_WB32(&st->codec->extradata[8], 0);
             memcpy(&st->codec->extradata[12], preamble, 12);
             avio_read(pb, &st->codec->extradata[24], ALAC_NEW_KUKI - 12);
             avio_skip(pb, size - ALAC_NEW_KUKI);
80af00b4
         }
5f14b565
     } else {
a807c682
         if (ff_alloc_extradata(st->codec, size))
5f14b565
             return AVERROR(ENOMEM);
e63a3628
         avio_read(pb, st->codec->extradata, size);
5f14b565
     }
 
     return 0;
 }
 
 /** Read packet table chunk */
 static int read_pakt_chunk(AVFormatContext *s, int64_t size)
 {
471fe57e
     AVIOContext *pb = s->pb;
5f14b565
     AVStream *st      = s->streams[0];
     CaffContext *caf  = s->priv_data;
c0196a14
     int64_t pos = 0, ccount, num_packets;
     int i;
5f14b565
 
384c9c2f
     ccount = avio_tell(pb);
5f14b565
 
e63a3628
     num_packets = avio_rb64(pb);
5f14b565
     if (num_packets < 0 || INT32_MAX / sizeof(AVIndexEntry) < num_packets)
         return AVERROR_INVALIDDATA;
 
e63a3628
     st->nb_frames  = avio_rb64(pb); /* valid frames */
     st->nb_frames += avio_rb32(pb); /* priming frames */
     st->nb_frames += avio_rb32(pb); /* remainder frames */
5f14b565
 
     st->duration = 0;
     for (i = 0; i < num_packets; i++) {
         av_add_index_entry(s->streams[0], pos, st->duration, 0, 0, AVINDEX_KEYFRAME);
         pos += caf->bytes_per_packet ? caf->bytes_per_packet : ff_mp4_read_descr_len(pb);
         st->duration += caf->frames_per_packet ? caf->frames_per_packet : ff_mp4_read_descr_len(pb);
     }
 
f5a9c35f
     if (avio_tell(pb) - ccount > size) {
5f14b565
         av_log(s, AV_LOG_ERROR, "error reading packet table\n");
f5a9c35f
         return AVERROR_INVALIDDATA;
5f14b565
     }
f5a9c35f
     avio_skip(pb, ccount + size - avio_tell(pb));
5f14b565
 
     caf->num_bytes = pos;
     return 0;
 }
 
 /** Read information chunk */
 static void read_info_chunk(AVFormatContext *s, int64_t size)
 {
471fe57e
     AVIOContext *pb = s->pb;
5f14b565
     unsigned int i;
e63a3628
     unsigned int nb_entries = avio_rb32(pb);
5f14b565
     for (i = 0; i < nb_entries; i++) {
         char key[32];
         char value[1024];
f7a9b1de
         avio_get_str(pb, INT_MAX, key, sizeof(key));
         avio_get_str(pb, INT_MAX, value, sizeof(value));
d2d67e42
         av_dict_set(&s->metadata, key, value, 0);
5f14b565
     }
 }
 
6e9651d1
 static int read_header(AVFormatContext *s)
5f14b565
 {
471fe57e
     AVIOContext *pb = s->pb;
5f14b565
     CaffContext *caf  = s->priv_data;
     AVStream *st;
     uint32_t tag = 0;
     int found_data, ret;
c2e2b302
     int64_t size, pos;
5f14b565
 
45a8a02a
     avio_skip(pb, 8); /* magic, version, file flags */
5f14b565
 
     /* audio description chunk */
e63a3628
     if (avio_rb32(pb) != MKBETAG('d','e','s','c')) {
5f14b565
         av_log(s, AV_LOG_ERROR, "desc chunk not present\n");
         return AVERROR_INVALIDDATA;
     }
e63a3628
     size = avio_rb64(pb);
5f14b565
     if (size != 32)
         return AVERROR_INVALIDDATA;
 
     ret = read_desc_chunk(s);
     if (ret)
         return ret;
     st = s->streams[0];
 
     /* parse each chunk */
     found_data = 0;
     while (!url_feof(pb)) {
 
         /* stop at data chunk if seeking is not supported or
            data chunk size is unknown */
8978feda
         if (found_data && (caf->data_size < 0 || !pb->seekable))
5f14b565
             break;
 
e63a3628
         tag  = avio_rb32(pb);
         size = avio_rb64(pb);
c2e2b302
         pos  = avio_tell(pb);
5f14b565
         if (url_feof(pb))
             break;
 
         switch (tag) {
         case MKBETAG('d','a','t','a'):
45a8a02a
             avio_skip(pb, 4); /* edit count */
384c9c2f
             caf->data_start = avio_tell(pb);
5f14b565
             caf->data_size  = size < 0 ? -1 : size - 4;
8978feda
             if (caf->data_size > 0 && pb->seekable)
45a8a02a
                 avio_skip(pb, caf->data_size);
5f14b565
             found_data = 1;
             break;
 
3bab7cd1
         case MKBETAG('c','h','a','n'):
9afb7061
             if ((ret = ff_mov_read_chan(s, s->pb, st, size)) < 0)
3bab7cd1
                 return ret;
             break;
 
5f14b565
         /* magic cookie chunk */
         case MKBETAG('k','u','k','i'):
             if (read_kuki_chunk(s, size))
                 return AVERROR_INVALIDDATA;
             break;
 
         /* packet table chunk */
         case MKBETAG('p','a','k','t'):
             if (read_pakt_chunk(s, size))
                 return AVERROR_INVALIDDATA;
             break;
 
         case MKBETAG('i','n','f','o'):
             read_info_chunk(s, size);
             break;
 
         default:
 #define _(x) ((x) >= ' ' ? (x) : ' ')
2a2146aa
             av_log(s, AV_LOG_WARNING, "skipping CAF chunk: %08X (%c%c%c%c), size %"PRId64"\n",
                 tag, _(tag>>24), _((tag>>16)&0xFF), _((tag>>8)&0xFF), _(tag&0xFF), size);
5f14b565
 #undef _
         case MKBETAG('f','r','e','e'):
             if (size < 0)
                 return AVERROR_INVALIDDATA;
             break;
         }
c2e2b302
 
         if (size > 0) {
64b7e7dc
             if (pos > INT64_MAX - size)
c2e2b302
                 return AVERROR_INVALIDDATA;
             avio_skip(pb, FFMAX(0, pos + size - avio_tell(pb)));
         }
5f14b565
     }
 
     if (!found_data)
         return AVERROR_INVALIDDATA;
 
     if (caf->bytes_per_packet > 0 && caf->frames_per_packet > 0) {
         if (caf->data_size > 0)
             st->nb_frames = (caf->data_size / caf->bytes_per_packet) * caf->frames_per_packet;
a202541f
     } else if (st->nb_index_entries && st->duration > 0) {
5f14b565
         st->codec->bit_rate = st->codec->sample_rate * caf->data_size * 8 /
                               st->duration;
     } else {
         av_log(s, AV_LOG_ERROR, "Missing packet table. It is required when "
                                 "block size or frame size are variable.\n");
         return AVERROR_INVALIDDATA;
     }
 
c3f9ebf7
     avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
5f14b565
     st->start_time = 0;
 
     /* position the stream at the start of data */
     if (caf->data_size >= 0)
f59d8ff8
         avio_seek(pb, caf->data_start, SEEK_SET);
5f14b565
 
     return 0;
 }
 
 #define CAF_MAX_PKT_SIZE 4096
 
 static int read_packet(AVFormatContext *s, AVPacket *pkt)
 {
471fe57e
     AVIOContext *pb = s->pb;
5f14b565
     AVStream *st      = s->streams[0];
     CaffContext *caf  = s->priv_data;
     int res, pkt_size = 0, pkt_frames = 0;
     int64_t left      = CAF_MAX_PKT_SIZE;
 
     if (url_feof(pb))
e94f4294
         return AVERROR_EOF;
5f14b565
 
     /* don't read past end of data chunk */
     if (caf->data_size > 0) {
384c9c2f
         left = (caf->data_start + caf->data_size) - avio_tell(pb);
b1e190d0
         if (!left)
             return AVERROR_EOF;
         if (left < 0)
5ae092ee
             return AVERROR(EIO);
5f14b565
     }
 
     pkt_frames = caf->frames_per_packet;
     pkt_size   = caf->bytes_per_packet;
 
     if (pkt_size > 0 && pkt_frames == 1) {
         pkt_size   = (CAF_MAX_PKT_SIZE / pkt_size) * pkt_size;
         pkt_size   = FFMIN(pkt_size, left);
         pkt_frames = pkt_size / caf->bytes_per_packet;
     } else if (st->nb_index_entries) {
         if (caf->packet_cnt < st->nb_index_entries - 1) {
             pkt_size   = st->index_entries[caf->packet_cnt + 1].pos       - st->index_entries[caf->packet_cnt].pos;
             pkt_frames = st->index_entries[caf->packet_cnt + 1].timestamp - st->index_entries[caf->packet_cnt].timestamp;
         } else if (caf->packet_cnt == st->nb_index_entries - 1) {
             pkt_size   = caf->num_bytes - st->index_entries[caf->packet_cnt].pos;
             pkt_frames = st->duration   - st->index_entries[caf->packet_cnt].timestamp;
         } else {
5ae092ee
             return AVERROR(EIO);
5f14b565
         }
     }
 
     if (pkt_size == 0 || pkt_frames == 0 || pkt_size > left)
5ae092ee
         return AVERROR(EIO);
5f14b565
 
     res = av_get_packet(pb, pkt, pkt_size);
     if (res < 0)
         return res;
 
     pkt->size           = res;
     pkt->stream_index   = 0;
     pkt->dts = pkt->pts = caf->frame_cnt;
 
     caf->packet_cnt++;
     caf->frame_cnt += pkt_frames;
 
     return 0;
 }
 
 static int read_seek(AVFormatContext *s, int stream_index,
                      int64_t timestamp, int flags)
 {
     AVStream *st = s->streams[0];
     CaffContext *caf = s->priv_data;
af701d42
     int64_t pos, packet_cnt, frame_cnt;
5f14b565
 
     timestamp = FFMAX(timestamp, 0);
 
     if (caf->frames_per_packet > 0 && caf->bytes_per_packet > 0) {
         /* calculate new byte position based on target frame position */
8aa6d899
         pos = caf->bytes_per_packet * (timestamp / caf->frames_per_packet);
5f14b565
         if (caf->data_size > 0)
             pos = FFMIN(pos, caf->data_size);
af701d42
         packet_cnt = pos / caf->bytes_per_packet;
         frame_cnt  = caf->frames_per_packet * packet_cnt;
5f14b565
     } else if (st->nb_index_entries) {
af701d42
         packet_cnt = av_index_search_timestamp(st, timestamp, flags);
         frame_cnt  = st->index_entries[packet_cnt].timestamp;
         pos        = st->index_entries[packet_cnt].pos;
5f14b565
     } else {
         return -1;
     }
 
af701d42
     if (avio_seek(s->pb, pos + caf->data_start, SEEK_SET) < 0)
75f41806
         return -1;
af701d42
 
     caf->packet_cnt = packet_cnt;
     caf->frame_cnt  = frame_cnt;
 
5f14b565
     return 0;
 }
 
66355be3
 AVInputFormat ff_caf_demuxer = {
dfc2c4d9
     .name           = "caf",
0177b7d2
     .long_name      = NULL_IF_CONFIG_SMALL("Apple CAF (Core Audio Format)"),
dfc2c4d9
     .priv_data_size = sizeof(CaffContext),
     .read_probe     = probe,
     .read_header    = read_header,
     .read_packet    = read_packet,
     .read_seek      = read_seek,
67ffcb96
     .codec_tag      = (const AVCodecTag* const []){ ff_codec_caf_tags, 0 },
5f14b565
 };