iff.c 13.5 KB
Newer Older
Jai Menon's avatar
Jai Menon committed
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>
Jai Menon's avatar
Jai Menon committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * 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
 */

/**
24
 * @file
Diego Biurrun's avatar
Diego Biurrun committed
25
 * IFF file demuxer
Jai Menon's avatar
Jai Menon committed
26 27 28 29 30
 * by Jaikrishnan Menon
 * for more information on the .iff file format, visit:
 * http://wiki.multimedia.cx/index.php?title=IFF
 */

31
#include "libavcodec/bytestream.h"
32
#include "libavutil/avassert.h"
33
#include "libavutil/intreadwrite.h"
34
#include "libavutil/dict.h"
Jai Menon's avatar
Jai Menon committed
35
#include "avformat.h"
36
#include "internal.h"
Jai Menon's avatar
Jai Menon committed
37 38 39 40 41 42

#define ID_8SVX       MKTAG('8','S','V','X')
#define ID_VHDR       MKTAG('V','H','D','R')
#define ID_ATAK       MKTAG('A','T','A','K')
#define ID_RLSE       MKTAG('R','L','S','E')
#define ID_CHAN       MKTAG('C','H','A','N')
43 44 45
#define ID_PBM        MKTAG('P','B','M',' ')
#define ID_ILBM       MKTAG('I','L','B','M')
#define ID_BMHD       MKTAG('B','M','H','D')
46
#define ID_DGBL       MKTAG('D','G','B','L')
47
#define ID_CAMG       MKTAG('C','A','M','G')
48
#define ID_CMAP       MKTAG('C','M','A','P')
49
#define ID_ACBM       MKTAG('A','C','B','M')
50
#define ID_DEEP       MKTAG('D','E','E','P')
Jai Menon's avatar
Jai Menon committed
51 52 53 54 55 56 57 58 59 60

#define ID_FORM       MKTAG('F','O','R','M')
#define ID_ANNO       MKTAG('A','N','N','O')
#define ID_AUTH       MKTAG('A','U','T','H')
#define ID_CHRS       MKTAG('C','H','R','S')
#define ID_COPYRIGHT  MKTAG('(','c',')',' ')
#define ID_CSET       MKTAG('C','S','E','T')
#define ID_FVER       MKTAG('F','V','E','R')
#define ID_NAME       MKTAG('N','A','M','E')
#define ID_TEXT       MKTAG('T','E','X','T')
61
#define ID_ABIT       MKTAG('A','B','I','T')
Jai Menon's avatar
Jai Menon committed
62
#define ID_BODY       MKTAG('B','O','D','Y')
63 64
#define ID_DBOD       MKTAG('D','B','O','D')
#define ID_DPEL       MKTAG('D','P','E','L')
Jai Menon's avatar
Jai Menon committed
65 66 67 68 69

#define LEFT    2
#define RIGHT   4
#define STEREO  6

70 71 72 73 74 75 76 77 78 79
/**
 * This number of bytes if added at the beginning of each AVPacket
 * which contain additional information about video properties
 * which has to be shared between demuxer and decoder.
 * This number may change between frames, e.g. the demuxer might
 * set it to smallest possible size of 2 to indicate that there's
 * no extradata changing in this frame.
 */
#define IFF_EXTRA_VIDEO_SIZE 9

80 81 82 83 84 85 86 87 88 89
typedef enum {
    COMP_NONE,
    COMP_FIB,
    COMP_EXP
} svx8_compression_type;

typedef enum {
    BITMAP_RAW,
    BITMAP_BYTERUN1
} bitmap_compression_type;
Jai Menon's avatar
Jai Menon committed
90 91

typedef struct {
92
    uint64_t  body_pos;
Jai Menon's avatar
Jai Menon committed
93 94
    uint32_t  body_size;
    uint32_t  sent_bytes;
95 96
    svx8_compression_type   svx8_compression;
    bitmap_compression_type bitmap_compression;  ///< delta compression method used
97 98 99 100 101
    unsigned  bpp;          ///< bits per plane to decode (differs from bits_per_coded_sample if HAM)
    unsigned  ham;          ///< 0 if non-HAM or number of hold bits (6 for bpp > 6, 4 otherwise)
    unsigned  flags;        ///< 1 for EHB, 0 is no extra half darkening
    unsigned  transparency; ///< transparency color index in palette
    unsigned  masking;      ///< masking method used
Jai Menon's avatar
Jai Menon committed
102 103
} IffDemuxContext;

Sebastian Vater's avatar
Sebastian Vater committed
104 105 106 107 108 109 110 111 112 113
/* Metadata string read */
static int get_metadata(AVFormatContext *s,
                        const char *const tag,
                        const unsigned data_size)
{
    uint8_t *buf = ((data_size + 1) == 0) ? NULL : av_malloc(data_size + 1);

    if (!buf)
        return AVERROR(ENOMEM);

114
    if (avio_read(s->pb, buf, data_size) < 0) {
Sebastian Vater's avatar
Sebastian Vater committed
115 116 117 118
        av_free(buf);
        return AVERROR(EIO);
    }
    buf[data_size] = 0;
119
    av_dict_set(&s->metadata, tag, buf, AV_DICT_DONT_STRDUP_VAL);
Sebastian Vater's avatar
Sebastian Vater committed
120 121 122
    return 0;
}

Jai Menon's avatar
Jai Menon committed
123 124 125 126
static int iff_probe(AVProbeData *p)
{
    const uint8_t *d = p->buf;

127 128 129 130 131 132
    if (  AV_RL32(d)   == ID_FORM &&
         (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) )
Jai Menon's avatar
Jai Menon committed
133 134 135 136
        return AVPROBE_SCORE_MAX;
    return 0;
}

137 138 139
static const uint8_t deep_rgb24[] = {0, 0, 0, 3, 0, 1, 0, 8, 0, 2, 0, 8, 0, 3, 0, 8};
static const uint8_t deep_rgba[]  = {0, 0, 0, 4, 0, 1, 0, 8, 0, 2, 0, 8, 0, 3, 0, 8};

140
static int iff_read_header(AVFormatContext *s)
Jai Menon's avatar
Jai Menon committed
141 142
{
    IffDemuxContext *iff = s->priv_data;
143
    AVIOContext *pb = s->pb;
Jai Menon's avatar
Jai Menon committed
144
    AVStream *st;
145
    uint8_t *buf;
Jai Menon's avatar
Jai Menon committed
146
    uint32_t chunk_id, data_size;
147 148 149
    uint32_t screenmode = 0;
    unsigned transparency = 0;
    unsigned masking = 0; // no mask
150 151
    uint8_t fmt[16];
    int fmt_size;
Jai Menon's avatar
Jai Menon committed
152

153
    st = avformat_new_stream(s, NULL);
Jai Menon's avatar
Jai Menon committed
154
    if (!st)
155
        return AVERROR(ENOMEM);
Jai Menon's avatar
Jai Menon committed
156 157

    st->codec->channels = 1;
158
    avio_skip(pb, 8);
159
    // codec_tag used by ByteRun1 decoder to distinguish progressive (PBM) and interlaced (ILBM) content
160
    st->codec->codec_tag = avio_rl32(pb);
Jai Menon's avatar
Jai Menon committed
161

162 163
    while(!url_feof(pb)) {
        uint64_t orig_pos;
Sebastian Vater's avatar
Sebastian Vater committed
164 165
        int res;
        const char *metadata_tag = NULL;
166 167
        chunk_id = avio_rl32(pb);
        data_size = avio_rb32(pb);
168
        orig_pos = avio_tell(pb);
Jai Menon's avatar
Jai Menon committed
169 170 171

        switch(chunk_id) {
        case ID_VHDR:
172
            st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
173 174 175

            if (data_size < 14)
                return AVERROR_INVALIDDATA;
176
            avio_skip(pb, 12);
177
            st->codec->sample_rate = avio_rb16(pb);
178
            if (data_size >= 16) {
179
                avio_skip(pb, 1);
180
                iff->svx8_compression = avio_r8(pb);
181
            }
Jai Menon's avatar
Jai Menon committed
182 183
            break;

184
        case ID_ABIT:
Jai Menon's avatar
Jai Menon committed
185
        case ID_BODY:
186
        case ID_DBOD:
187
            iff->body_pos = avio_tell(pb);
Jai Menon's avatar
Jai Menon committed
188 189 190 191
            iff->body_size = data_size;
            break;

        case ID_CHAN:
192 193
            if (data_size < 4)
                return AVERROR_INVALIDDATA;
194
            st->codec->channels = (avio_rb32(pb) < 6) ? 1 : 2;
Jai Menon's avatar
Jai Menon committed
195 196
            break;

197 198 199 200 201 202
        case ID_CAMG:
            if (data_size < 4)
                return AVERROR_INVALIDDATA;
            screenmode                = avio_rb32(pb);
            break;

203
        case ID_CMAP:
204 205
            st->codec->extradata_size = data_size + IFF_EXTRA_VIDEO_SIZE;
            st->codec->extradata      = av_malloc(data_size + IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
206 207
            if (!st->codec->extradata)
                return AVERROR(ENOMEM);
208
            if (avio_read(pb, st->codec->extradata + IFF_EXTRA_VIDEO_SIZE, data_size) < 0)
209 210 211 212
                return AVERROR(EIO);
            break;

        case ID_BMHD:
213
            iff->bitmap_compression = -1;
214
            st->codec->codec_type            = AVMEDIA_TYPE_VIDEO;
215 216
            if (data_size <= 8)
                return AVERROR_INVALIDDATA;
217 218
            st->codec->width                 = avio_rb16(pb);
            st->codec->height                = avio_rb16(pb);
219
            avio_skip(pb, 4); // x, y offset
220
            st->codec->bits_per_coded_sample = avio_r8(pb);
221 222 223
            if (data_size >= 10)
                masking                      = avio_r8(pb);
            if (data_size >= 11)
224
                iff->bitmap_compression      = avio_r8(pb);
225 226 227
            if (data_size >= 14) {
                avio_skip(pb, 1); // padding
                transparency                 = avio_rb16(pb);
228 229
            }
            if (data_size >= 16) {
230 231
                st->sample_aspect_ratio.num  = avio_r8(pb);
                st->sample_aspect_ratio.den  = avio_r8(pb);
232
            }
233 234
            break;

235 236 237 238 239 240 241 242 243 244
        case ID_DPEL:
            if (data_size < 4 || (data_size & 3))
                return AVERROR_INVALIDDATA;
            if ((fmt_size = avio_read(pb, fmt, sizeof(fmt))) < 0)
                return fmt_size;
            if (fmt_size == sizeof(deep_rgb24) && !memcmp(fmt, deep_rgb24, sizeof(deep_rgb24)))
                st->codec->pix_fmt = PIX_FMT_RGB24;
            else if (fmt_size == sizeof(deep_rgba) && !memcmp(fmt, deep_rgba, sizeof(deep_rgba)))
                st->codec->pix_fmt = PIX_FMT_RGBA;
            else {
245
                av_log_ask_for_sample(s, "unsupported color format\n");
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
                return AVERROR_PATCHWELCOME;
            }
            break;

        case ID_DGBL:
            st->codec->codec_type            = AVMEDIA_TYPE_VIDEO;
            if (data_size < 8)
                return AVERROR_INVALIDDATA;
            st->codec->width                 = avio_rb16(pb);
            st->codec->height                = avio_rb16(pb);
            iff->bitmap_compression          = avio_rb16(pb);
            if (iff->bitmap_compression != 0) {
                av_log(s, AV_LOG_ERROR,
                       "compression %i not supported\n", iff->bitmap_compression);
                return AVERROR_PATCHWELCOME;
            }
            st->sample_aspect_ratio.num      = avio_r8(pb);
            st->sample_aspect_ratio.den      = avio_r8(pb);
            st->codec->bits_per_coded_sample = 24;
            break;

267
        case ID_ANNO:
268 269 270 271
        case ID_TEXT:      metadata_tag = "comment";   break;
        case ID_AUTH:      metadata_tag = "artist";    break;
        case ID_COPYRIGHT: metadata_tag = "copyright"; break;
        case ID_NAME:      metadata_tag = "title";     break;
Jai Menon's avatar
Jai Menon committed
272
        }
273

Sebastian Vater's avatar
Sebastian Vater committed
274 275
        if (metadata_tag) {
            if ((res = get_metadata(s, metadata_tag, data_size)) < 0) {
276
                av_log(s, AV_LOG_ERROR, "cannot allocate metadata tag %s!\n", metadata_tag);
Sebastian Vater's avatar
Sebastian Vater committed
277 278 279
                return res;
            }
        }
280
        avio_skip(pb, data_size - (avio_tell(pb) - orig_pos) + (data_size & 1));
Jai Menon's avatar
Jai Menon committed
281 282
    }

283
    avio_seek(pb, iff->body_pos, SEEK_SET);
284

285
    switch(st->codec->codec_type) {
286
    case AVMEDIA_TYPE_AUDIO:
287
        avpriv_set_pts_info(st, 32, 1, st->codec->sample_rate);
Jai Menon's avatar
Jai Menon committed
288

289
        switch (iff->svx8_compression) {
290
        case COMP_NONE:
291
            st->codec->codec_id = AV_CODEC_ID_PCM_S8_PLANAR;
292 293
            break;
        case COMP_FIB:
294
            st->codec->codec_id = AV_CODEC_ID_8SVX_FIB;
295 296
            break;
        case COMP_EXP:
297
            st->codec->codec_id = AV_CODEC_ID_8SVX_EXP;
298 299
            break;
        default:
300 301
            av_log(s, AV_LOG_ERROR,
                   "Unknown SVX8 compression method '%d'\n", iff->svx8_compression);
302 303
            return -1;
        }
Jai Menon's avatar
Jai Menon committed
304

305
        st->codec->bits_per_coded_sample = iff->svx8_compression == COMP_NONE ? 8 : 4;
306 307 308
        st->codec->bit_rate = st->codec->channels * st->codec->sample_rate * st->codec->bits_per_coded_sample;
        st->codec->block_align = st->codec->channels * st->codec->bits_per_coded_sample;
        break;
309

310
    case AVMEDIA_TYPE_VIDEO:
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
        iff->bpp          = st->codec->bits_per_coded_sample;
        if ((screenmode & 0x800 /* Hold And Modify */) && iff->bpp <= 8) {
            iff->ham      = iff->bpp > 6 ? 6 : 4;
            st->codec->bits_per_coded_sample = 24;
        }
        iff->flags        = (screenmode & 0x80 /* Extra HalfBrite */) && iff->bpp <= 8;
        iff->masking      = masking;
        iff->transparency = transparency;

        if (!st->codec->extradata) {
            st->codec->extradata_size = IFF_EXTRA_VIDEO_SIZE;
            st->codec->extradata      = av_malloc(IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
            if (!st->codec->extradata)
                return AVERROR(ENOMEM);
        }
        buf = st->codec->extradata;
        bytestream_put_be16(&buf, IFF_EXTRA_VIDEO_SIZE);
328
        bytestream_put_byte(&buf, iff->bitmap_compression);
329 330 331 332 333 334
        bytestream_put_byte(&buf, iff->bpp);
        bytestream_put_byte(&buf, iff->ham);
        bytestream_put_byte(&buf, iff->flags);
        bytestream_put_be16(&buf, iff->transparency);
        bytestream_put_byte(&buf, iff->masking);

335
        switch (iff->bitmap_compression) {
336
        case BITMAP_RAW:
337
            st->codec->codec_id = AV_CODEC_ID_IFF_ILBM;
338 339
            break;
        case BITMAP_BYTERUN1:
340
            st->codec->codec_id = AV_CODEC_ID_IFF_BYTERUN1;
341 342
            break;
        default:
343 344
            av_log(s, AV_LOG_ERROR,
                   "Unknown bitmap compression method '%d'\n", iff->bitmap_compression);
345 346 347 348 349 350
            return AVERROR_INVALIDDATA;
        }
        break;
    default:
        return -1;
    }
Jai Menon's avatar
Jai Menon committed
351 352 353 354 355 356 357 358

    return 0;
}

static int iff_read_packet(AVFormatContext *s,
                           AVPacket *pkt)
{
    IffDemuxContext *iff = s->priv_data;
359
    AVIOContext *pb = s->pb;
360
    AVStream *st = s->streams[0];
Jai Menon's avatar
Jai Menon committed
361 362
    int ret;

363
    if(iff->sent_bytes >= iff->body_size)
364
        return AVERROR_EOF;
Jai Menon's avatar
Jai Menon committed
365

366 367
    if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
        ret = av_get_packet(pb, pkt, iff->body_size);
368
    } else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
369 370 371 372 373 374 375 376 377
        uint8_t *buf;

        if (av_new_packet(pkt, iff->body_size + 2) < 0) {
            return AVERROR(ENOMEM);
        }

        buf = pkt->data;
        bytestream_put_be16(&buf, 2);
        ret = avio_read(pb, buf, iff->body_size);
378
    } else {
379
        av_assert0(0);
Jai Menon's avatar
Jai Menon committed
380
    }
Jai Menon's avatar
Jai Menon committed
381 382

    if(iff->sent_bytes == 0)
383
        pkt->flags |= AV_PKT_FLAG_KEY;
384
    iff->sent_bytes = iff->body_size;
Jai Menon's avatar
Jai Menon committed
385 386 387 388 389

    pkt->stream_index = 0;
    return ret;
}

390
AVInputFormat ff_iff_demuxer = {
391
    .name           = "iff",
392
    .long_name      = NULL_IF_CONFIG_SMALL("IFF (Interchange File Format)"),
393 394 395 396
    .priv_data_size = sizeof(IffDemuxContext),
    .read_probe     = iff_probe,
    .read_header    = iff_read_header,
    .read_packet    = iff_read_packet,
Jai Menon's avatar
Jai Menon committed
397
};