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>
6 * This file is part of FFmpeg.
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.
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.
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
26 * by Jaikrishnan Menon
27 * for more information on the .iff file format, visit:
28 * http://wiki.multimedia.cx/index.php?title=IFF
31 #include "libavutil/avassert.h"
32 #include "libavutil/channel_layout.h"
33 #include "libavutil/intreadwrite.h"
34 #include "libavutil/dict.h"
35 #include "libavcodec/bytestream.h"
39 #define ID_8SVX MKTAG('8','S','V','X')
40 #define ID_16SV MKTAG('1','6','S','V')
41 #define ID_MAUD MKTAG('M','A','U','D')
42 #define ID_MHDR MKTAG('M','H','D','R')
43 #define ID_MDAT MKTAG('M','D','A','T')
44 #define ID_VHDR MKTAG('V','H','D','R')
45 #define ID_ATAK MKTAG('A','T','A','K')
46 #define ID_RLSE MKTAG('R','L','S','E')
47 #define ID_CHAN MKTAG('C','H','A','N')
48 #define ID_PBM MKTAG('P','B','M',' ')
49 #define ID_ILBM MKTAG('I','L','B','M')
50 #define ID_BMHD MKTAG('B','M','H','D')
51 #define ID_DGBL MKTAG('D','G','B','L')
52 #define ID_CAMG MKTAG('C','A','M','G')
53 #define ID_CMAP MKTAG('C','M','A','P')
54 #define ID_ACBM MKTAG('A','C','B','M')
55 #define ID_DEEP MKTAG('D','E','E','P')
56 #define ID_RGB8 MKTAG('R','G','B','8')
57 #define ID_RGBN MKTAG('R','G','B','N')
59 #define ID_FORM MKTAG('F','O','R','M')
60 #define ID_ANNO MKTAG('A','N','N','O')
61 #define ID_AUTH MKTAG('A','U','T','H')
62 #define ID_CHRS MKTAG('C','H','R','S')
63 #define ID_COPYRIGHT MKTAG('(','c',')',' ')
64 #define ID_CSET MKTAG('C','S','E','T')
65 #define ID_FVER MKTAG('F','V','E','R')
66 #define ID_NAME MKTAG('N','A','M','E')
67 #define ID_TEXT MKTAG('T','E','X','T')
68 #define ID_ABIT MKTAG('A','B','I','T')
69 #define ID_BODY MKTAG('B','O','D','Y')
70 #define ID_DBOD MKTAG('D','B','O','D')
71 #define ID_DPEL MKTAG('D','P','E','L')
72 #define ID_DLOC MKTAG('D','L','O','C')
73 #define ID_TVDC MKTAG('T','V','D','C')
80 * This number of bytes if added at the beginning of each AVPacket
81 * which contain additional information about video properties
82 * which has to be shared between demuxer and decoder.
83 * This number may change between frames, e.g. the demuxer might
84 * set it to smallest possible size of 2 to indicate that there's
85 * no extradata changing in this frame.
87 #define IFF_EXTRA_VIDEO_SIZE 41
93 } svx8_compression_type;
99 svx8_compression_type svx8_compression;
101 unsigned maud_compression;
102 unsigned bitmap_compression; ///< delta compression method used
103 unsigned bpp; ///< bits per plane to decode (differs from bits_per_coded_sample if HAM)
104 unsigned ham; ///< 0 if non-HAM or number of hold bits (6 for bpp > 6, 4 otherwise)
105 unsigned flags; ///< 1 for EHB, 0 is no extra half darkening
106 unsigned transparency; ///< transparency color index in palette
107 unsigned masking; ///< masking method used
108 uint8_t tvdc[32]; ///< TVDC lookup table
111 /* Metadata string read */
112 static int get_metadata(AVFormatContext *s,
113 const char *const tag,
114 const unsigned data_size)
116 uint8_t *buf = ((data_size + 1) == 0) ? NULL : av_malloc(data_size + 1);
119 return AVERROR(ENOMEM);
121 if (avio_read(s->pb, buf, data_size) < 0) {
126 av_dict_set(&s->metadata, tag, buf, AV_DICT_DONT_STRDUP_VAL);
130 static int iff_probe(AVProbeData *p)
132 const uint8_t *d = p->buf;
134 if ( AV_RL32(d) == ID_FORM &&
135 (AV_RL32(d+8) == ID_8SVX ||
136 AV_RL32(d+8) == ID_16SV ||
137 AV_RL32(d+8) == ID_MAUD ||
138 AV_RL32(d+8) == ID_PBM ||
139 AV_RL32(d+8) == ID_ACBM ||
140 AV_RL32(d+8) == ID_DEEP ||
141 AV_RL32(d+8) == ID_ILBM ||
142 AV_RL32(d+8) == ID_RGB8 ||
143 AV_RL32(d+8) == ID_RGBN) )
144 return AVPROBE_SCORE_MAX;
148 static const uint8_t deep_rgb24[] = {0, 0, 0, 3, 0, 1, 0, 8, 0, 2, 0, 8, 0, 3, 0, 8};
149 static const uint8_t deep_rgba[] = {0, 0, 0, 4, 0, 1, 0, 8, 0, 2, 0, 8, 0, 3, 0, 8};
150 static const uint8_t deep_bgra[] = {0, 0, 0, 4, 0, 3, 0, 8, 0, 2, 0, 8, 0, 1, 0, 8};
151 static const uint8_t deep_argb[] = {0, 0, 0, 4, 0,17, 0, 8, 0, 1, 0, 8, 0, 2, 0, 8};
152 static const uint8_t deep_abgr[] = {0, 0, 0, 4, 0,17, 0, 8, 0, 3, 0, 8, 0, 2, 0, 8};
154 static int iff_read_header(AVFormatContext *s)
156 IffDemuxContext *iff = s->priv_data;
157 AVIOContext *pb = s->pb;
160 uint32_t chunk_id, data_size;
161 uint32_t screenmode = 0, num, den;
162 unsigned transparency = 0;
163 unsigned masking = 0; // no mask
167 st = avformat_new_stream(s, NULL);
169 return AVERROR(ENOMEM);
171 st->codec->channels = 1;
172 st->codec->channel_layout = AV_CH_LAYOUT_MONO;
174 // codec_tag used by ByteRun1 decoder to distinguish progressive (PBM) and interlaced (ILBM) content
175 st->codec->codec_tag = avio_rl32(pb);
176 iff->bitmap_compression = -1;
177 iff->svx8_compression = -1;
179 iff->maud_compression = -1;
181 while(!url_feof(pb)) {
184 const char *metadata_tag = NULL;
185 chunk_id = avio_rl32(pb);
186 data_size = avio_rb32(pb);
187 orig_pos = avio_tell(pb);
191 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
194 return AVERROR_INVALIDDATA;
196 st->codec->sample_rate = avio_rb16(pb);
197 if (data_size >= 16) {
199 iff->svx8_compression = avio_r8(pb);
204 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
207 return AVERROR_INVALIDDATA;
209 iff->maud_bits = avio_rb16(pb);
214 return AVERROR_INVALIDDATA;
216 st->codec->sample_rate = num / den;
217 st->codec->channels = avio_rb16(pb);
218 iff->maud_compression = avio_rb16(pb);
219 if (st->codec->channels == 1)
220 st->codec->channel_layout = AV_CH_LAYOUT_MONO;
221 else if (st->codec->channels == 2)
222 st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
229 iff->body_pos = avio_tell(pb);
230 iff->body_end = iff->body_pos + data_size;
231 iff->body_size = data_size;
236 return AVERROR_INVALIDDATA;
237 if (avio_rb32(pb) < 6) {
238 st->codec->channels = 1;
239 st->codec->channel_layout = AV_CH_LAYOUT_MONO;
241 st->codec->channels = 2;
242 st->codec->channel_layout = AV_CH_LAYOUT_STEREO;
248 return AVERROR_INVALIDDATA;
249 screenmode = avio_rb32(pb);
253 st->codec->extradata_size = data_size + IFF_EXTRA_VIDEO_SIZE;
254 st->codec->extradata = av_malloc(data_size + IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
255 if (!st->codec->extradata)
256 return AVERROR(ENOMEM);
257 if (avio_read(pb, st->codec->extradata + IFF_EXTRA_VIDEO_SIZE, data_size) < 0)
262 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
264 return AVERROR_INVALIDDATA;
265 st->codec->width = avio_rb16(pb);
266 st->codec->height = avio_rb16(pb);
267 avio_skip(pb, 4); // x, y offset
268 st->codec->bits_per_coded_sample = avio_r8(pb);
270 masking = avio_r8(pb);
272 iff->bitmap_compression = avio_r8(pb);
273 if (data_size >= 14) {
274 avio_skip(pb, 1); // padding
275 transparency = avio_rb16(pb);
277 if (data_size >= 16) {
278 st->sample_aspect_ratio.num = avio_r8(pb);
279 st->sample_aspect_ratio.den = avio_r8(pb);
284 if (data_size < 4 || (data_size & 3))
285 return AVERROR_INVALIDDATA;
286 if ((fmt_size = avio_read(pb, fmt, sizeof(fmt))) < 0)
288 if (fmt_size == sizeof(deep_rgb24) && !memcmp(fmt, deep_rgb24, sizeof(deep_rgb24)))
289 st->codec->pix_fmt = AV_PIX_FMT_RGB24;
290 else if (fmt_size == sizeof(deep_rgba) && !memcmp(fmt, deep_rgba, sizeof(deep_rgba)))
291 st->codec->pix_fmt = AV_PIX_FMT_RGBA;
292 else if (fmt_size == sizeof(deep_bgra) && !memcmp(fmt, deep_bgra, sizeof(deep_bgra)))
293 st->codec->pix_fmt = AV_PIX_FMT_BGRA;
294 else if (fmt_size == sizeof(deep_argb) && !memcmp(fmt, deep_argb, sizeof(deep_argb)))
295 st->codec->pix_fmt = AV_PIX_FMT_ARGB;
296 else if (fmt_size == sizeof(deep_abgr) && !memcmp(fmt, deep_abgr, sizeof(deep_abgr)))
297 st->codec->pix_fmt = AV_PIX_FMT_ABGR;
299 av_log_ask_for_sample(s, "unsupported color format\n");
300 return AVERROR_PATCHWELCOME;
305 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
307 return AVERROR_INVALIDDATA;
308 st->codec->width = avio_rb16(pb);
309 st->codec->height = avio_rb16(pb);
310 iff->bitmap_compression = avio_rb16(pb);
311 st->sample_aspect_ratio.num = avio_r8(pb);
312 st->sample_aspect_ratio.den = avio_r8(pb);
313 st->codec->bits_per_coded_sample = 24;
318 return AVERROR_INVALIDDATA;
319 st->codec->width = avio_rb16(pb);
320 st->codec->height = avio_rb16(pb);
324 if (data_size < sizeof(iff->tvdc))
325 return AVERROR_INVALIDDATA;
326 res = avio_read(pb, iff->tvdc, sizeof(iff->tvdc));
332 case ID_TEXT: metadata_tag = "comment"; break;
333 case ID_AUTH: metadata_tag = "artist"; break;
334 case ID_COPYRIGHT: metadata_tag = "copyright"; break;
335 case ID_NAME: metadata_tag = "title"; break;
339 if ((res = get_metadata(s, metadata_tag, data_size)) < 0) {
340 av_log(s, AV_LOG_ERROR, "cannot allocate metadata tag %s!\n", metadata_tag);
344 avio_skip(pb, data_size - (avio_tell(pb) - orig_pos) + (data_size & 1));
347 avio_seek(pb, iff->body_pos, SEEK_SET);
349 switch(st->codec->codec_type) {
350 case AVMEDIA_TYPE_AUDIO:
351 avpriv_set_pts_info(st, 32, 1, st->codec->sample_rate);
353 if (st->codec->codec_tag == ID_16SV)
354 st->codec->codec_id = AV_CODEC_ID_PCM_S16BE_PLANAR;
355 else if (st->codec->codec_tag == ID_MAUD) {
356 if (iff->maud_bits == 8 && !iff->maud_compression) {
357 st->codec->codec_id = AV_CODEC_ID_PCM_U8;
358 } else if (iff->maud_bits == 16 && !iff->maud_compression) {
359 st->codec->codec_id = AV_CODEC_ID_PCM_S16BE;
360 } else if (iff->maud_bits == 8 && iff->maud_compression == 2) {
361 st->codec->codec_id = AV_CODEC_ID_PCM_ALAW;
362 } else if (iff->maud_bits == 8 && iff->maud_compression == 3) {
363 st->codec->codec_id = AV_CODEC_ID_PCM_MULAW;
365 av_log_ask_for_sample(s, "unsupported compression %d and bit depth %d\n", iff->maud_compression, iff->maud_bits);
366 return AVERROR_PATCHWELCOME;
369 st->codec->bits_per_coded_sample =
370 av_get_bits_per_sample(st->codec->codec_id);
372 st->codec->block_align =
373 st->codec->bits_per_coded_sample * st->codec->channels / 8;
375 switch (iff->svx8_compression) {
377 st->codec->codec_id = AV_CODEC_ID_PCM_S8_PLANAR;
380 st->codec->codec_id = AV_CODEC_ID_8SVX_FIB;
383 st->codec->codec_id = AV_CODEC_ID_8SVX_EXP;
386 av_log(s, AV_LOG_ERROR,
387 "Unknown SVX8 compression method '%d'\n", iff->svx8_compression);
392 st->codec->bits_per_coded_sample = av_get_bits_per_sample(st->codec->codec_id);
393 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate * st->codec->bits_per_coded_sample;
394 st->codec->block_align = st->codec->channels * st->codec->bits_per_coded_sample;
397 case AVMEDIA_TYPE_VIDEO:
398 iff->bpp = st->codec->bits_per_coded_sample;
399 if ((screenmode & 0x800 /* Hold And Modify */) && iff->bpp <= 8) {
400 iff->ham = iff->bpp > 6 ? 6 : 4;
401 st->codec->bits_per_coded_sample = 24;
403 iff->flags = (screenmode & 0x80 /* Extra HalfBrite */) && iff->bpp <= 8;
404 iff->masking = masking;
405 iff->transparency = transparency;
407 if (!st->codec->extradata) {
408 st->codec->extradata_size = IFF_EXTRA_VIDEO_SIZE;
409 st->codec->extradata = av_malloc(IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
410 if (!st->codec->extradata)
411 return AVERROR(ENOMEM);
413 buf = st->codec->extradata;
414 bytestream_put_be16(&buf, IFF_EXTRA_VIDEO_SIZE);
415 bytestream_put_byte(&buf, iff->bitmap_compression);
416 bytestream_put_byte(&buf, iff->bpp);
417 bytestream_put_byte(&buf, iff->ham);
418 bytestream_put_byte(&buf, iff->flags);
419 bytestream_put_be16(&buf, iff->transparency);
420 bytestream_put_byte(&buf, iff->masking);
421 bytestream_put_buffer(&buf, iff->tvdc, sizeof(iff->tvdc));
422 st->codec->codec_id = AV_CODEC_ID_IFF_ILBM;
431 static int iff_read_packet(AVFormatContext *s,
434 IffDemuxContext *iff = s->priv_data;
435 AVIOContext *pb = s->pb;
436 AVStream *st = s->streams[0];
438 int64_t pos = avio_tell(pb);
440 if (pos >= iff->body_end)
443 if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
444 if (st->codec->codec_tag == ID_MAUD) {
445 ret = av_get_packet(pb, pkt, FFMIN(iff->body_end - pos, 1024 * st->codec->block_align));
447 ret = av_get_packet(pb, pkt, iff->body_size);
449 } else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
452 if (av_new_packet(pkt, iff->body_size + 2) < 0) {
453 return AVERROR(ENOMEM);
457 bytestream_put_be16(&buf, 2);
458 ret = avio_read(pb, buf, iff->body_size);
463 if (pos == iff->body_pos)
464 pkt->flags |= AV_PKT_FLAG_KEY;
467 pkt->stream_index = 0;
471 AVInputFormat ff_iff_demuxer = {
473 .long_name = NULL_IF_CONFIG_SMALL("IFF (Interchange File Format)"),
474 .priv_data_size = sizeof(IffDemuxContext),
475 .read_probe = iff_probe,
476 .read_header = iff_read_header,
477 .read_packet = iff_read_packet,
478 .flags = AVFMT_GENERIC_INDEX,