libavformat/iff.c

   1 /*
   2  * IFF (.iff) file demuxer
   3  * Copyright (c) 2008 Jaikrishnan Menon <realityman@gmx.net>
   4  * Copyright (c) 2010 Peter Ross <pross@xvid.org>
   5  * Copyright (c) 2010 Sebastian Vater <cdgs.basty@googlemail.com>
   6  *
   7  * This file is part of Libav.
   8  *
   9  * Libav is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * Libav is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with Libav; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22  */
  23
  24 /**
  25  * @file
  26  * IFF file demuxer
  27  * by Jaikrishnan Menon
  28  * for more information on the .iff file format, visit:
  29  * http://wiki.multimedia.cx/index.php?title=IFF
  30  */
  31
  32 #include "libavutil/intreadwrite.h"
  33 #include "libavutil/dict.h"
  34 #include "avformat.h"
  35
  36 #define ID_8SVX       MKTAG('8','S','V','X')
  37 #define ID_VHDR       MKTAG('V','H','D','R')
  38 #define ID_ATAK       MKTAG('A','T','A','K')
  39 #define ID_RLSE       MKTAG('R','L','S','E')
  40 #define ID_CHAN       MKTAG('C','H','A','N')
  41 #define ID_PBM        MKTAG('P','B','M',' ')
  42 #define ID_ILBM       MKTAG('I','L','B','M')
  43 #define ID_BMHD       MKTAG('B','M','H','D')
  44 #define ID_CMAP       MKTAG('C','M','A','P')
  45
  46 #define ID_FORM       MKTAG('F','O','R','M')
  47 #define ID_ANNO       MKTAG('A','N','N','O')
  48 #define ID_AUTH       MKTAG('A','U','T','H')
  49 #define ID_CHRS       MKTAG('C','H','R','S')
  50 #define ID_COPYRIGHT  MKTAG('(','c',')',' ')
  51 #define ID_CSET       MKTAG('C','S','E','T')
  52 #define ID_FVER       MKTAG('F','V','E','R')
  53 #define ID_NAME       MKTAG('N','A','M','E')
  54 #define ID_TEXT       MKTAG('T','E','X','T')
  55 #define ID_BODY       MKTAG('B','O','D','Y')
  56 #define ID_ANNO       MKTAG('A','N','N','O')
  57
  58 #define LEFT    2
  59 #define RIGHT   4
  60 #define STEREO  6
  61
  62 #define PACKET_SIZE 1024
  63
  64 typedef enum {
  65     COMP_NONE,
  66     COMP_FIB,
  67     COMP_EXP
  68 } svx8_compression_type;
  69
  70 typedef enum {
  71     BITMAP_RAW,
  72     BITMAP_BYTERUN1
  73 } bitmap_compression_type;
  74
  75 typedef struct {
  76     uint64_t  body_pos;
  77     uint32_t  body_size;
  78     uint32_t  sent_bytes;
  79     uint32_t  audio_frame_count;
  80 } IffDemuxContext;
  81
  82
  83 static void interleave_stereo(const uint8_t *src, uint8_t *dest, int size)
  84 {
  85     uint8_t *end = dest + size;
  86     size = size>>1;
  87
  88     while(dest < end) {
  89         *dest++ = *src;
  90         *dest++ = *(src+size);
  91         src++;
  92     }
  93 }
  94
  95 /* Metadata string read */
  96 static int get_metadata(AVFormatContext *s,
  97                         const char *const tag,
  98                         const unsigned data_size)
  99 {
 100     uint8_t *buf = ((data_size + 1) == 0) ? NULL : av_malloc(data_size + 1);
 101
 102     if (!buf)
 103         return AVERROR(ENOMEM);
 104
 105     if (avio_read(s->pb, buf, data_size) < 0) {
 106         av_free(buf);
 107         return AVERROR(EIO);
 108     }
 109     buf[data_size] = 0;
 110     av_dict_set(&s->metadata, tag, buf, AV_DICT_DONT_STRDUP_VAL);
 111     return 0;
 112 }
 113
 114 static int iff_probe(AVProbeData *p)
 115 {
 116     const uint8_t *d = p->buf;
 117
 118     if ( AV_RL32(d)   == ID_FORM &&
 119          (AV_RL32(d+8) == ID_8SVX || AV_RL32(d+8) == ID_PBM || AV_RL32(d+8) == ID_ILBM) )
 120         return AVPROBE_SCORE_MAX;
 121     return 0;
 122 }
 123
 124 static int iff_read_header(AVFormatContext *s,
 125                            AVFormatParameters *ap)
 126 {
 127     IffDemuxContext *iff = s->priv_data;
 128     AVIOContext *pb = s->pb;
 129     AVStream *st;
 130     uint32_t chunk_id, data_size;
 131     int compression = -1;
 132
 133     st = av_new_stream(s, 0);
 134     if (!st)
 135         return AVERROR(ENOMEM);
 136
 137     st->codec->channels = 1;
 138     avio_skip(pb, 8);
 139     // codec_tag used by ByteRun1 decoder to distinguish progressive (PBM) and interlaced (ILBM) content
 140     st->codec->codec_tag = avio_rl32(pb);
 141
 142     while(!pb->eof_reached) {
 143         uint64_t orig_pos;
 144         int res;
 145         const char *metadata_tag = NULL;
 146         chunk_id = avio_rl32(pb);
 147         data_size = avio_rb32(pb);
 148         orig_pos = avio_tell(pb);
 149
 150         switch(chunk_id) {
 151         case ID_VHDR:
 152             st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
 153
 154             if (data_size < 14)
 155                 return AVERROR_INVALIDDATA;
 156             avio_skip(pb, 12);
 157             st->codec->sample_rate = avio_rb16(pb);
 158             if (data_size >= 16) {
 159                 avio_skip(pb, 1);
 160                 compression        = avio_r8(pb);
 161             }
 162             break;
 163
 164         case ID_BODY:
 165             iff->body_pos = avio_tell(pb);
 166             iff->body_size = data_size;
 167             break;
 168
 169         case ID_CHAN:
 170             if (data_size < 4)
 171                 return AVERROR_INVALIDDATA;
 172             st->codec->channels = (avio_rb32(pb) < 6) ? 1 : 2;
 173             break;
 174
 175         case ID_CMAP:
 176             st->codec->extradata_size = data_size;
 177             st->codec->extradata      = av_malloc(data_size);
 178             if (!st->codec->extradata)
 179                 return AVERROR(ENOMEM);
 180             if (avio_read(pb, st->codec->extradata, data_size) < 0)
 181                 return AVERROR(EIO);
 182             break;
 183
 184         case ID_BMHD:
 185             st->codec->codec_type            = AVMEDIA_TYPE_VIDEO;
 186             if (data_size <= 8)
 187                 return AVERROR_INVALIDDATA;
 188             st->codec->width                 = avio_rb16(pb);
 189             st->codec->height                = avio_rb16(pb);
 190             avio_skip(pb, 4); // x, y offset
 191             st->codec->bits_per_coded_sample = avio_r8(pb);
 192             if (data_size >= 11) {
 193                 avio_skip(pb, 1); // masking
 194                 compression                  = avio_r8(pb);
 195             }
 196             if (data_size >= 16) {
 197                 avio_skip(pb, 3); // paddding, transparent
 198                 st->sample_aspect_ratio.num  = avio_r8(pb);
 199                 st->sample_aspect_ratio.den  = avio_r8(pb);
 200             }
 201             break;
 202
 203         case ID_ANNO:
 204         case ID_TEXT:
 205             metadata_tag = "comment";
 206             break;
 207
 208         case ID_AUTH:
 209             metadata_tag = "artist";
 210             break;
 211
 212         case ID_COPYRIGHT:
 213             metadata_tag = "copyright";
 214             break;
 215
 216         case ID_NAME:
 217             metadata_tag = "title";
 218             break;
 219         }
 220
 221         if (metadata_tag) {
 222             if ((res = get_metadata(s, metadata_tag, data_size)) < 0) {
 223                 av_log(s, AV_LOG_ERROR, "cannot allocate metadata tag %s!", metadata_tag);
 224                 return res;
 225             }
 226         }
 227         avio_skip(pb, data_size - (avio_tell(pb) - orig_pos) + (data_size & 1));
 228     }
 229
 230     avio_seek(pb, iff->body_pos, SEEK_SET);
 231
 232     switch(st->codec->codec_type) {
 233     case AVMEDIA_TYPE_AUDIO:
 234         av_set_pts_info(st, 32, 1, st->codec->sample_rate);
 235
 236         switch(compression) {
 237         case COMP_NONE:
 238             st->codec->codec_id = CODEC_ID_PCM_S8;
 239             break;
 240         case COMP_FIB:
 241             st->codec->codec_id = CODEC_ID_8SVX_FIB;
 242             break;
 243         case COMP_EXP:
 244             st->codec->codec_id = CODEC_ID_8SVX_EXP;
 245             break;
 246         default:
 247             av_log(s, AV_LOG_ERROR, "unknown compression method\n");
 248             return -1;
 249         }
 250
 251         st->codec->bits_per_coded_sample = 8;
 252         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate * st->codec->bits_per_coded_sample;
 253         st->codec->block_align = st->codec->channels * st->codec->bits_per_coded_sample;
 254         break;
 255
 256     case AVMEDIA_TYPE_VIDEO:
 257         switch (compression) {
 258         case BITMAP_RAW:
 259             st->codec->codec_id = CODEC_ID_IFF_ILBM;
 260             break;
 261         case BITMAP_BYTERUN1:
 262             st->codec->codec_id = CODEC_ID_IFF_BYTERUN1;
 263             break;
 264         default:
 265             av_log(s, AV_LOG_ERROR, "unknown compression method\n");
 266             return AVERROR_INVALIDDATA;
 267         }
 268         break;
 269     default:
 270         return -1;
 271     }
 272
 273     return 0;
 274 }
 275
 276 static int iff_read_packet(AVFormatContext *s,
 277                            AVPacket *pkt)
 278 {
 279     IffDemuxContext *iff = s->priv_data;
 280     AVIOContext *pb = s->pb;
 281     AVStream *st = s->streams[0];
 282     int ret;
 283
 284     if(iff->sent_bytes >= iff->body_size)
 285         return AVERROR(EIO);
 286
 287     if(st->codec->channels == 2) {
 288         uint8_t sample_buffer[PACKET_SIZE];
 289
 290         ret = avio_read(pb, sample_buffer, PACKET_SIZE);
 291         if(av_new_packet(pkt, PACKET_SIZE) < 0) {
 292             av_log(s, AV_LOG_ERROR, "cannot allocate packet\n");
 293             return AVERROR(ENOMEM);
 294         }
 295         interleave_stereo(sample_buffer, pkt->data, PACKET_SIZE);
 296     } else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
 297         ret = av_get_packet(pb, pkt, iff->body_size);
 298     } else {
 299         ret = av_get_packet(pb, pkt, PACKET_SIZE);
 300     }
 301
 302     if(iff->sent_bytes == 0)
 303         pkt->flags |= AV_PKT_FLAG_KEY;
 304
 305     if(st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
 306         iff->sent_bytes += PACKET_SIZE;
 307     } else {
 308         iff->sent_bytes = iff->body_size;
 309     }
 310     pkt->stream_index = 0;
 311     if(st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
 312         pkt->pts = iff->audio_frame_count;
 313         iff->audio_frame_count += ret / st->codec->channels;
 314     }
 315     return ret;
 316 }
 317
 318 AVInputFormat ff_iff_demuxer = {
 319     .name           = "IFF",
 320     .long_name      = NULL_IF_CONFIG_SMALL("IFF format"),
 321     .priv_data_size = sizeof(IffDemuxContext),
 322     .read_probe     = iff_probe,
 323     .read_header    = iff_read_header,
 324     .read_packet    = iff_read_packet,
 325 };