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 "libavcodec/bytestream.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/dict.h"
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_CAMG MKTAG('C','A','M','G')
46 #define ID_CMAP MKTAG('C','M','A','P')
47 #define ID_ACBM MKTAG('A','C','B','M')
49 #define ID_FORM MKTAG('F','O','R','M')
50 #define ID_ANNO MKTAG('A','N','N','O')
51 #define ID_AUTH MKTAG('A','U','T','H')
52 #define ID_CHRS MKTAG('C','H','R','S')
53 #define ID_COPYRIGHT MKTAG('(','c',')',' ')
54 #define ID_CSET MKTAG('C','S','E','T')
55 #define ID_FVER MKTAG('F','V','E','R')
56 #define ID_NAME MKTAG('N','A','M','E')
57 #define ID_TEXT MKTAG('T','E','X','T')
58 #define ID_ABIT MKTAG('A','B','I','T')
59 #define ID_BODY MKTAG('B','O','D','Y')
60 #define ID_ANNO MKTAG('A','N','N','O')
67 * This number of bytes if added at the beginning of each AVPacket
68 * which contain additional information about video properties
69 * which has to be shared between demuxer and decoder.
70 * This number may change between frames, e.g. the demuxer might
71 * set it to smallest possible size of 2 to indicate that there's
72 * no extradata changing in this frame.
74 #define IFF_EXTRA_VIDEO_SIZE 9
80 } svx8_compression_type;
85 } bitmap_compression_type;
91 svx8_compression_type svx8_compression;
92 bitmap_compression_type bitmap_compression; ///< delta compression method used
93 unsigned bpp; ///< bits per plane to decode (differs from bits_per_coded_sample if HAM)
94 unsigned ham; ///< 0 if non-HAM or number of hold bits (6 for bpp > 6, 4 otherwise)
95 unsigned flags; ///< 1 for EHB, 0 is no extra half darkening
96 unsigned transparency; ///< transparency color index in palette
97 unsigned masking; ///< masking method used
100 /* Metadata string read */
101 static int get_metadata(AVFormatContext *s,
102 const char *const tag,
103 const unsigned data_size)
105 uint8_t *buf = ((data_size + 1) == 0) ? NULL : av_malloc(data_size + 1);
108 return AVERROR(ENOMEM);
110 if (avio_read(s->pb, buf, data_size) < 0) {
115 av_dict_set(&s->metadata, tag, buf, AV_DICT_DONT_STRDUP_VAL);
119 static int iff_probe(AVProbeData *p)
121 const uint8_t *d = p->buf;
123 if ( AV_RL32(d) == ID_FORM &&
124 (AV_RL32(d+8) == ID_8SVX || AV_RL32(d+8) == ID_PBM || AV_RL32(d+8) == ID_ILBM || AV_RL32(d+8) == ID_ACBM) )
125 return AVPROBE_SCORE_MAX;
129 static int iff_read_header(AVFormatContext *s,
130 AVFormatParameters *ap)
132 IffDemuxContext *iff = s->priv_data;
133 AVIOContext *pb = s->pb;
136 uint32_t chunk_id, data_size;
137 uint32_t screenmode = 0;
138 unsigned transparency = 0;
139 unsigned masking = 0; // no mask
141 st = avformat_new_stream(s, NULL);
143 return AVERROR(ENOMEM);
145 st->codec->channels = 1;
147 // codec_tag used by ByteRun1 decoder to distinguish progressive (PBM) and interlaced (ILBM) content
148 st->codec->codec_tag = avio_rl32(pb);
150 while(!url_feof(pb)) {
153 const char *metadata_tag = NULL;
154 chunk_id = avio_rl32(pb);
155 data_size = avio_rb32(pb);
156 orig_pos = avio_tell(pb);
160 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
163 return AVERROR_INVALIDDATA;
165 st->codec->sample_rate = avio_rb16(pb);
166 if (data_size >= 16) {
168 iff->svx8_compression = avio_r8(pb);
174 iff->body_pos = avio_tell(pb);
175 iff->body_size = data_size;
180 return AVERROR_INVALIDDATA;
181 st->codec->channels = (avio_rb32(pb) < 6) ? 1 : 2;
186 return AVERROR_INVALIDDATA;
187 screenmode = avio_rb32(pb);
191 st->codec->extradata_size = data_size + IFF_EXTRA_VIDEO_SIZE;
192 st->codec->extradata = av_malloc(data_size + IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
193 if (!st->codec->extradata)
194 return AVERROR(ENOMEM);
195 if (avio_read(pb, st->codec->extradata + IFF_EXTRA_VIDEO_SIZE, data_size) < 0)
200 iff->bitmap_compression = -1;
201 st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
203 return AVERROR_INVALIDDATA;
204 st->codec->width = avio_rb16(pb);
205 st->codec->height = avio_rb16(pb);
206 avio_skip(pb, 4); // x, y offset
207 st->codec->bits_per_coded_sample = avio_r8(pb);
209 masking = avio_r8(pb);
211 iff->bitmap_compression = avio_r8(pb);
212 if (data_size >= 14) {
213 avio_skip(pb, 1); // padding
214 transparency = avio_rb16(pb);
216 if (data_size >= 16) {
217 st->sample_aspect_ratio.num = avio_r8(pb);
218 st->sample_aspect_ratio.den = avio_r8(pb);
223 case ID_TEXT: metadata_tag = "comment"; break;
224 case ID_AUTH: metadata_tag = "artist"; break;
225 case ID_COPYRIGHT: metadata_tag = "copyright"; break;
226 case ID_NAME: metadata_tag = "title"; break;
230 if ((res = get_metadata(s, metadata_tag, data_size)) < 0) {
231 av_log(s, AV_LOG_ERROR, "cannot allocate metadata tag %s!", metadata_tag);
235 avio_skip(pb, data_size - (avio_tell(pb) - orig_pos) + (data_size & 1));
238 avio_seek(pb, iff->body_pos, SEEK_SET);
240 switch(st->codec->codec_type) {
241 case AVMEDIA_TYPE_AUDIO:
242 avpriv_set_pts_info(st, 32, 1, st->codec->sample_rate);
244 switch (iff->svx8_compression) {
246 st->codec->codec_id = CODEC_ID_PCM_S8_PLANAR;
249 st->codec->codec_id = CODEC_ID_8SVX_FIB;
252 st->codec->codec_id = CODEC_ID_8SVX_EXP;
255 av_log(s, AV_LOG_ERROR,
256 "Unknown SVX8 compression method '%d'\n", iff->svx8_compression);
260 st->codec->bits_per_coded_sample = iff->svx8_compression == COMP_NONE ? 8 : 4;
261 st->codec->bit_rate = st->codec->channels * st->codec->sample_rate * st->codec->bits_per_coded_sample;
262 st->codec->block_align = st->codec->channels * st->codec->bits_per_coded_sample;
265 case AVMEDIA_TYPE_VIDEO:
266 iff->bpp = st->codec->bits_per_coded_sample;
267 if ((screenmode & 0x800 /* Hold And Modify */) && iff->bpp <= 8) {
268 iff->ham = iff->bpp > 6 ? 6 : 4;
269 st->codec->bits_per_coded_sample = 24;
271 iff->flags = (screenmode & 0x80 /* Extra HalfBrite */) && iff->bpp <= 8;
272 iff->masking = masking;
273 iff->transparency = transparency;
275 if (!st->codec->extradata) {
276 st->codec->extradata_size = IFF_EXTRA_VIDEO_SIZE;
277 st->codec->extradata = av_malloc(IFF_EXTRA_VIDEO_SIZE + FF_INPUT_BUFFER_PADDING_SIZE);
278 if (!st->codec->extradata)
279 return AVERROR(ENOMEM);
281 buf = st->codec->extradata;
282 bytestream_put_be16(&buf, IFF_EXTRA_VIDEO_SIZE);
283 bytestream_put_byte(&buf, iff->bitmap_compression);
284 bytestream_put_byte(&buf, iff->bpp);
285 bytestream_put_byte(&buf, iff->ham);
286 bytestream_put_byte(&buf, iff->flags);
287 bytestream_put_be16(&buf, iff->transparency);
288 bytestream_put_byte(&buf, iff->masking);
290 switch (iff->bitmap_compression) {
292 st->codec->codec_id = CODEC_ID_IFF_ILBM;
294 case BITMAP_BYTERUN1:
295 st->codec->codec_id = CODEC_ID_IFF_BYTERUN1;
298 av_log(s, AV_LOG_ERROR,
299 "Unknown bitmap compression method '%d'\n", iff->bitmap_compression);
300 return AVERROR_INVALIDDATA;
310 static int iff_read_packet(AVFormatContext *s,
313 IffDemuxContext *iff = s->priv_data;
314 AVIOContext *pb = s->pb;
315 AVStream *st = s->streams[0];
318 if(iff->sent_bytes >= iff->body_size)
321 if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
322 ret = av_get_packet(pb, pkt, iff->body_size);
323 } else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
326 if (av_new_packet(pkt, iff->body_size + 2) < 0) {
327 return AVERROR(ENOMEM);
331 bytestream_put_be16(&buf, 2);
332 ret = avio_read(pb, buf, iff->body_size);
337 if(iff->sent_bytes == 0)
338 pkt->flags |= AV_PKT_FLAG_KEY;
339 iff->sent_bytes = iff->body_size;
341 pkt->stream_index = 0;
345 AVInputFormat ff_iff_demuxer = {
347 .long_name = NULL_IF_CONFIG_SMALL("IFF format"),
348 .priv_data_size = sizeof(IffDemuxContext),
349 .read_probe = iff_probe,
350 .read_header = iff_read_header,
351 .read_packet = iff_read_packet,