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