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