git.sesse.net Git - ffmpeg/blob - libavformat/iff.c

   1 /*
   2  * Copyright (c) 2008 Jaikrishnan Menon <realityman@gmx.net>
   3  * Copyright (c) 2010 Peter Ross <pross@xvid.org>
   4  * Copyright (c) 2010 Sebastian Vater <cdgs.basty@googlemail.com>
   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  * IFF file demuxer
  26  * by Jaikrishnan Menon
  27  * for more information on the .iff file format, visit:
  28  * http://wiki.multimedia.cx/index.php?title=IFF
  29  */
  30
  31 #include "libavcodec/bytestream.h"
  32 #include "libavutil/intreadwrite.h"
  33 #include "libavutil/dict.h"
  34 #include "avformat.h"
  35 #include "internal.h"
  36
  37 #define ID_8SVX       MKTAG('8','S','V','X')
  38 #define ID_VHDR       MKTAG('V','H','D','R')
  39 #define ID_ATAK       MKTAG('A','T','A','K')
  40 #define ID_RLSE       MKTAG('R','L','S','E')
  41 #define ID_CHAN       MKTAG('C','H','A','N')
  42 #define ID_PBM        MKTAG('P','B','M',' ')
  43 #define ID_ILBM       MKTAG('I','L','B','M')
  44 #define ID_BMHD       MKTAG('B','M','H','D')
  45 #define ID_DGBL       MKTAG('D','G','B','L')
  46 #define ID_CAMG       MKTAG('C','A','M','G')
  47 #define ID_CMAP       MKTAG('C','M','A','P')
  48 #define ID_ACBM       MKTAG('A','C','B','M')
  49 #define ID_DEEP       MKTAG('D','E','E','P')
  50
  51 #define ID_FORM       MKTAG('F','O','R','M')
  52 #define ID_ANNO       MKTAG('A','N','N','O')
  53 #define ID_AUTH       MKTAG('A','U','T','H')
  54 #define ID_CHRS       MKTAG('C','H','R','S')
  55 #define ID_COPYRIGHT  MKTAG('(','c',')',' ')
  56 #define ID_CSET       MKTAG('C','S','E','T')
  57 #define ID_FVER       MKTAG('F','V','E','R')
  58 #define ID_NAME       MKTAG('N','A','M','E')
  59 #define ID_TEXT       MKTAG('T','E','X','T')
  60 #define ID_ABIT       MKTAG('A','B','I','T')
  61 #define ID_BODY       MKTAG('B','O','D','Y')
  62 #define ID_DBOD       MKTAG('D','B','O','D')
  63 #define ID_ANNO       MKTAG('A','N','N','O')
  64 #define ID_DPEL       MKTAG('D','P','E','L')
  65
  66 #define LEFT    2
  67 #define RIGHT   4
  68 #define STEREO  6
  69
  70 /**
  71  * This number of bytes if added at the beginning of each AVPacket
  72  * which contain additional information about video properties
  73  * which has to be shared between demuxer and decoder.
  74  * This number may change between frames, e.g. the demuxer might
  75  * set it to smallest possible size of 2 to indicate that there's
  76  * no extradata changing in this frame.
  77  */
  78 #define IFF_EXTRA_VIDEO_SIZE 9
  79
  80 typedef enum {
  81     COMP_NONE,
  82     COMP_FIB,
  83     COMP_EXP
  84 } svx8_compression_type;
  85
  86 typedef enum {
  87     BITMAP_RAW,
  88     BITMAP_BYTERUN1
  89 } bitmap_compression_type;
  90
  91 typedef struct {
  92     uint64_t  body_pos;
  93     uint32_t  body_size;
  94     uint32_t  sent_bytes;
  95     svx8_compression_type   svx8_compression;
  96     bitmap_compression_type bitmap_compression;  ///< delta compression method used
  97     unsigned  bpp;          ///< bits per plane to decode (differs from bits_per_coded_sample if HAM)
  98     unsigned  ham;          ///< 0 if non-HAM or number of hold bits (6 for bpp > 6, 4 otherwise)
  99     unsigned  flags;        ///< 1 for EHB, 0 is no extra half darkening
 100     unsigned  transparency; ///< transparency color index in palette
 101     unsigned  masking;      ///< masking method used
 102 } IffDemuxContext;
 103
 104 /* Metadata string read */
 105 static int get_metadata(AVFormatContext *s,
 106                         const char *const tag,
 107                         const unsigned data_size)
 108 {
 109     uint8_t *buf = ((data_size + 1) == 0) ? NULL : av_malloc(data_size + 1);
 110
 111     if (!buf)
 112         return AVERROR(ENOMEM);
 113
 114     if (avio_read(s->pb, buf, data_size) < 0) {
 115         av_free(buf);
 116         return AVERROR(EIO);
 117     }
 118     buf[data_size] = 0;
 119     av_dict_set(&s->metadata, tag, buf, AV_DICT_DONT_STRDUP_VAL);
 120     return 0;
 121 }
 122
 123 static int iff_probe(AVProbeData *p)
 124 {
 125     const uint8_t *d = p->buf;
 126
 127     if ( AV_RL32(d)   == ID_FORM &&
 128          (AV_RL32(d+8) == ID_8SVX || AV_RL32(d+8) == ID_PBM || AV_RL32(d+8) == ID_ACBM || AV_RL32(d+8) == ID_DEEP || AV_RL32(d+8) == ID_ILBM) )
 129         return AVPROBE_SCORE_MAX;
 130     return 0;
 131 }
 132
 133 static const uint8_t deep_rgb24[] = {0, 0, 0, 3, 0, 1, 0, 8, 0, 2, 0, 8, 0, 3, 0, 8};
 134 static const uint8_t deep_rgba[]  = {0, 0, 0, 4, 0, 1, 0, 8, 0, 2, 0, 8, 0, 3, 0, 8};
 135
 136 static int iff_read_header(AVFormatContext *s)
 137 {
 138     IffDemuxContext *iff = s->priv_data;
 139     AVIOContext *pb = s->pb;
 140     AVStream *st;
 141     uint8_t *buf;
 142     uint32_t chunk_id, data_size;
 143     uint32_t screenmode = 0;
 144     unsigned transparency = 0;
 145     unsigned masking = 0; // no mask
 146     uint8_t fmt[16];
 147     int fmt_size;
 148
 149     st = avformat_new_stream(s, NULL);
 150     if (!st)
 151         return AVERROR(ENOMEM);
 152
 153     st->codec->channels = 1;
 154     avio_skip(pb, 8);
 155     // codec_tag used by ByteRun1 decoder to distinguish progressive (PBM) and interlaced (ILBM) content
 156     st->codec->codec_tag = avio_rl32(pb);
 157
 158     while(!url_feof(pb)) {
 159         uint64_t orig_pos;
 160         int res;
 161         const char *metadata_tag = NULL;
 162         chunk_id = avio_rl32(pb);
 163         data_size = avio_rb32(pb);
 164         orig_pos = avio_tell(pb);
 165
 166         switch(chunk_id) {
 167         case ID_VHDR:
 168             st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
 169
 170             if (data_size < 14)
 171                 return AVERROR_INVALIDDATA;
 172             avio_skip(pb, 12);
 173             st->codec->sample_rate = avio_rb16(pb);
 174             if (data_size >= 16) {
 175                 avio_skip(pb, 1);
 176                 iff->svx8_compression = avio_r8(pb);
 177             }
 178             break;
 179
 180         case ID_ABIT:
 181         case ID_BODY:
 182         case ID_DBOD:
 183             iff->body_pos = avio_tell(pb);
 184             iff->body_size = data_size;
 185             break;
 186
 187         case ID_CHAN:
 188             if (data_size < 4)
 189                 return AVERROR_INVALIDDATA;
 190             st->codec->channels = (avio_rb32(pb) < 6) ? 1 : 2;
 191             break;
 192
 193         case ID_CAMG:
 194             if (data_size < 4)
 195                 return AVERROR_INVALIDDATA;
 196             screenmode                = avio_rb32(pb);
 197             break;
 198
 199         case ID_CMAP:
 200             st->codec->extradata_size = data_size + IFF_EXTRA_VIDEO_SIZE;
 201             st->codec->extradata      = av_malloc(data_size + IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
 202             if (!st->codec->extradata)
 203                 return AVERROR(ENOMEM);
 204             if (avio_read(pb, st->codec->extradata + IFF_EXTRA_VIDEO_SIZE, data_size) < 0)
 205                 return AVERROR(EIO);
 206             break;
 207
 208         case ID_BMHD:
 209             iff->bitmap_compression = -1;
 210             st->codec->codec_type            = AVMEDIA_TYPE_VIDEO;
 211             if (data_size <= 8)
 212                 return AVERROR_INVALIDDATA;
 213             st->codec->width                 = avio_rb16(pb);
 214             st->codec->height                = avio_rb16(pb);
 215             avio_skip(pb, 4); // x, y offset
 216             st->codec->bits_per_coded_sample = avio_r8(pb);
 217             if (data_size >= 10)
 218                 masking                      = avio_r8(pb);
 219             if (data_size >= 11)
 220                 iff->bitmap_compression      = avio_r8(pb);
 221             if (data_size >= 14) {
 222                 avio_skip(pb, 1); // padding
 223                 transparency                 = avio_rb16(pb);
 224             }
 225             if (data_size >= 16) {
 226                 st->sample_aspect_ratio.num  = avio_r8(pb);
 227                 st->sample_aspect_ratio.den  = avio_r8(pb);
 228             }
 229             break;
 230
 231         case ID_DPEL:
 232             if (data_size < 4 || (data_size & 3))
 233                 return AVERROR_INVALIDDATA;
 234             if ((fmt_size = avio_read(pb, fmt, sizeof(fmt))) < 0)
 235                 return fmt_size;
 236             if (fmt_size == sizeof(deep_rgb24) && !memcmp(fmt, deep_rgb24, sizeof(deep_rgb24)))
 237                 st->codec->pix_fmt = PIX_FMT_RGB24;
 238             else if (fmt_size == sizeof(deep_rgba) && !memcmp(fmt, deep_rgba, sizeof(deep_rgba)))
 239                 st->codec->pix_fmt = PIX_FMT_RGBA;
 240             else {
 241                 av_log_ask_for_sample(NULL, "unsupported color format\n");
 242                 return AVERROR_PATCHWELCOME;
 243             }
 244             break;
 245
 246         case ID_DGBL:
 247             st->codec->codec_type            = AVMEDIA_TYPE_VIDEO;
 248             if (data_size < 8)
 249                 return AVERROR_INVALIDDATA;
 250             st->codec->width                 = avio_rb16(pb);
 251             st->codec->height                = avio_rb16(pb);
 252             iff->bitmap_compression          = avio_rb16(pb);
 253             if (iff->bitmap_compression != 0) {
 254                 av_log(s, AV_LOG_ERROR,
 255                        "compression %i not supported\n", iff->bitmap_compression);
 256                 return AVERROR_PATCHWELCOME;
 257             }
 258             st->sample_aspect_ratio.num      = avio_r8(pb);
 259             st->sample_aspect_ratio.den      = avio_r8(pb);
 260             st->codec->bits_per_coded_sample = 24;
 261             break;
 262
 263         case ID_ANNO:
 264         case ID_TEXT:      metadata_tag = "comment";   break;
 265         case ID_AUTH:      metadata_tag = "artist";    break;
 266         case ID_COPYRIGHT: metadata_tag = "copyright"; break;
 267         case ID_NAME:      metadata_tag = "title";     break;
 268         }
 269
 270         if (metadata_tag) {
 271             if ((res = get_metadata(s, metadata_tag, data_size)) < 0) {
 272                 av_log(s, AV_LOG_ERROR, "cannot allocate metadata tag %s!", metadata_tag);
 273                 return res;
 274             }
 275         }
 276         avio_skip(pb, data_size - (avio_tell(pb) - orig_pos) + (data_size & 1));
 277     }
 278
 279     avio_seek(pb, iff->body_pos, SEEK_SET);
 280
 281     switch(st->codec->codec_type) {
 282     case AVMEDIA_TYPE_AUDIO:
 283         avpriv_set_pts_info(st, 32, 1, st->codec->sample_rate);
 284
 285         switch (iff->svx8_compression) {
 286         case COMP_NONE:
 287             st->codec->codec_id = CODEC_ID_PCM_S8_PLANAR;
 288             break;
 289         case COMP_FIB:
 290             st->codec->codec_id = CODEC_ID_8SVX_FIB;
 291             break;
 292         case COMP_EXP:
 293             st->codec->codec_id = CODEC_ID_8SVX_EXP;
 294             break;
 295         default:
 296             av_log(s, AV_LOG_ERROR,
 297                    "Unknown SVX8 compression method '%d'\n", iff->svx8_compression);
 298             return -1;
 299         }
 300
 301         st->codec->bits_per_coded_sample = iff->svx8_compression == COMP_NONE ? 8 : 4;
 302         st->codec->bit_rate = st->codec->channels * st->codec->sample_rate * st->codec->bits_per_coded_sample;
 303         st->codec->block_align = st->codec->channels * st->codec->bits_per_coded_sample;
 304         break;
 305
 306     case AVMEDIA_TYPE_VIDEO:
 307         iff->bpp          = st->codec->bits_per_coded_sample;
 308         if ((screenmode & 0x800 /* Hold And Modify */) && iff->bpp <= 8) {
 309             iff->ham      = iff->bpp > 6 ? 6 : 4;
 310             st->codec->bits_per_coded_sample = 24;
 311         }
 312         iff->flags        = (screenmode & 0x80 /* Extra HalfBrite */) && iff->bpp <= 8;
 313         iff->masking      = masking;
 314         iff->transparency = transparency;
 315
 316         if (!st->codec->extradata) {
 317             st->codec->extradata_size = IFF_EXTRA_VIDEO_SIZE;
 318             st->codec->extradata      = av_malloc(IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
 319             if (!st->codec->extradata)
 320                 return AVERROR(ENOMEM);
 321         }
 322         buf = st->codec->extradata;
 323         bytestream_put_be16(&buf, IFF_EXTRA_VIDEO_SIZE);
 324         bytestream_put_byte(&buf, iff->bitmap_compression);
 325         bytestream_put_byte(&buf, iff->bpp);
 326         bytestream_put_byte(&buf, iff->ham);
 327         bytestream_put_byte(&buf, iff->flags);
 328         bytestream_put_be16(&buf, iff->transparency);
 329         bytestream_put_byte(&buf, iff->masking);
 330
 331         switch (iff->bitmap_compression) {
 332         case BITMAP_RAW:
 333             st->codec->codec_id = CODEC_ID_IFF_ILBM;
 334             break;
 335         case BITMAP_BYTERUN1:
 336             st->codec->codec_id = CODEC_ID_IFF_BYTERUN1;
 337             break;
 338         default:
 339             av_log(s, AV_LOG_ERROR,
 340                    "Unknown bitmap compression method '%d'\n", iff->bitmap_compression);
 341             return AVERROR_INVALIDDATA;
 342         }
 343         break;
 344     default:
 345         return -1;
 346     }
 347
 348     return 0;
 349 }
 350
 351 static int iff_read_packet(AVFormatContext *s,
 352                            AVPacket *pkt)
 353 {
 354     IffDemuxContext *iff = s->priv_data;
 355     AVIOContext *pb = s->pb;
 356     AVStream *st = s->streams[0];
 357     int ret;
 358
 359     if(iff->sent_bytes >= iff->body_size)
 360         return AVERROR_EOF;
 361
 362     if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
 363         ret = av_get_packet(pb, pkt, iff->body_size);
 364     } else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
 365         uint8_t *buf;
 366
 367         if (av_new_packet(pkt, iff->body_size + 2) < 0) {
 368             return AVERROR(ENOMEM);
 369         }
 370
 371         buf = pkt->data;
 372         bytestream_put_be16(&buf, 2);
 373         ret = avio_read(pb, buf, iff->body_size);
 374     } else {
 375         av_abort();
 376     }
 377
 378     if(iff->sent_bytes == 0)
 379         pkt->flags |= AV_PKT_FLAG_KEY;
 380     iff->sent_bytes = iff->body_size;
 381
 382     pkt->stream_index = 0;
 383     return ret;
 384 }
 385
 386 AVInputFormat ff_iff_demuxer = {
 387     .name           = "iff",
 388     .long_name      = NULL_IF_CONFIG_SMALL("Interchange File Format"),
 389     .priv_data_size = sizeof(IffDemuxContext),
 390     .read_probe     = iff_probe,
 391     .read_header    = iff_read_header,
 392     .read_packet    = iff_read_packet,
 393 };