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