Remove explicit filename from Doxygen @file commands.
[ffmpeg.git] / libavformat / iff.c
1 /*
2  * IFF (.iff) file demuxer
3  * Copyright (c) 2008 Jaikrishnan Menon <realityman@gmx.net>
4  * Copyright (c) 2010 Peter Ross <pross@xvid.org>
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/intreadwrite.h"
32 #include "libavcodec/iff.h"
33 #include "avformat.h"
34
35 #define ID_8SVX       MKTAG('8','S','V','X')
36 #define ID_VHDR       MKTAG('V','H','D','R')
37 #define ID_ATAK       MKTAG('A','T','A','K')
38 #define ID_RLSE       MKTAG('R','L','S','E')
39 #define ID_CHAN       MKTAG('C','H','A','N')
40 #define ID_PBM        MKTAG('P','B','M',' ')
41 #define ID_ILBM       MKTAG('I','L','B','M')
42 #define ID_BMHD       MKTAG('B','M','H','D')
43 #define ID_CMAP       MKTAG('C','M','A','P')
44
45 #define ID_FORM       MKTAG('F','O','R','M')
46 #define ID_ANNO       MKTAG('A','N','N','O')
47 #define ID_AUTH       MKTAG('A','U','T','H')
48 #define ID_CHRS       MKTAG('C','H','R','S')
49 #define ID_COPYRIGHT  MKTAG('(','c',')',' ')
50 #define ID_CSET       MKTAG('C','S','E','T')
51 #define ID_FVER       MKTAG('F','V','E','R')
52 #define ID_NAME       MKTAG('N','A','M','E')
53 #define ID_TEXT       MKTAG('T','E','X','T')
54 #define ID_BODY       MKTAG('B','O','D','Y')
55 #define ID_ANNO       MKTAG('A','N','N','O')
56
57 #define LEFT    2
58 #define RIGHT   4
59 #define STEREO  6
60
61 #define PACKET_SIZE 1024
62
63 typedef enum {COMP_NONE, COMP_FIB, COMP_EXP} svx8_compression_type;
64 typedef enum {BITMAP_RAW, BITMAP_BYTERUN1} bitmap_compression_type;
65
66 typedef struct {
67     uint32_t  body_size;
68     uint32_t  sent_bytes;
69     uint32_t  audio_frame_count;
70 } IffDemuxContext;
71
72
73 static void interleave_stereo(const uint8_t *src, uint8_t *dest, int size)
74 {
75     uint8_t *end = dest + size;
76     size = size>>1;
77
78     while(dest < end) {
79         *dest++ = *src;
80         *dest++ = *(src+size);
81         src++;
82     }
83 }
84
85 static int iff_probe(AVProbeData *p)
86 {
87     const uint8_t *d = p->buf;
88
89     if ( AV_RL32(d)   == ID_FORM &&
90          (AV_RL32(d+8) == ID_8SVX || AV_RL32(d+8) == ID_PBM || AV_RL32(d+8) == ID_ILBM) )
91         return AVPROBE_SCORE_MAX;
92     return 0;
93 }
94
95 static int iff_read_header(AVFormatContext *s,
96                            AVFormatParameters *ap)
97 {
98     IffDemuxContext *iff = s->priv_data;
99     ByteIOContext *pb = s->pb;
100     AVStream *st;
101     uint32_t chunk_id, data_size;
102     int padding, done = 0;
103     int compression = -1;
104     char *buf;
105
106     st = av_new_stream(s, 0);
107     if (!st)
108       return AVERROR(ENOMEM);
109
110     st->codec->channels = 1;
111     url_fskip(pb, 8);
112     // codec_tag used by ByteRun1 decoder to distinguish progressive (PBM) and interlaced (ILBM) content
113     st->codec->codec_tag = get_le32(pb);
114
115     while(!done && !url_feof(pb)) {
116         chunk_id = get_le32(pb);
117         data_size = get_be32(pb);
118         padding = data_size & 1;
119
120         switch(chunk_id) {
121         case ID_VHDR:
122             st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
123             url_fskip(pb, 12);
124             st->codec->sample_rate = get_be16(pb);
125             url_fskip(pb, 1);
126             compression            = get_byte(pb);
127             url_fskip(pb, 4);
128             break;
129
130         case ID_BODY:
131             iff->body_size = data_size;
132             done = 1;
133             break;
134
135         case ID_CHAN:
136             st->codec->channels = (get_be32(pb) < 6) ? 1 : 2;
137             break;
138
139         case ID_CMAP:
140             st->codec->extradata_size = data_size;
141             st->codec->extradata      = av_malloc(data_size);
142             if (!st->codec->extradata)
143                 return AVERROR(ENOMEM);
144             if (get_buffer(pb, st->codec->extradata, data_size) < 0)
145                 return AVERROR(EIO);
146             break;
147
148         case ID_BMHD:
149             st->codec->codec_type            = AVMEDIA_TYPE_VIDEO;
150             st->codec->width                 = get_be16(pb);
151             st->codec->height                = get_be16(pb);
152             url_fskip(pb, 4); // x, y offset
153             st->codec->bits_per_coded_sample = get_byte(pb);
154             url_fskip(pb, 1); // masking
155             compression                      = get_byte(pb);
156             url_fskip(pb, 3); // paddding, transparent
157             st->sample_aspect_ratio.num      = get_byte(pb);
158             st->sample_aspect_ratio.den      = get_byte(pb);
159             url_fskip(pb, 4); // source page width, height
160             break;
161
162         case ID_ANNO:
163             buf = av_malloc(data_size + 1);
164             if (!buf)
165                 break;
166             get_buffer(pb, buf, data_size);
167             buf[data_size] = 0;
168             av_metadata_set2(&s->metadata, "comment", buf, AV_METADATA_DONT_STRDUP_VAL);
169             break;
170
171         default:
172             url_fseek(pb, data_size + padding, SEEK_CUR);
173             break;
174         }
175     }
176
177     switch(st->codec->codec_type) {
178     case AVMEDIA_TYPE_AUDIO:
179     av_set_pts_info(st, 32, 1, st->codec->sample_rate);
180
181     switch(compression) {
182     case COMP_NONE:
183         st->codec->codec_id = CODEC_ID_PCM_S8;
184         break;
185     case COMP_FIB:
186         st->codec->codec_id = CODEC_ID_8SVX_FIB;
187         break;
188     case COMP_EXP:
189         st->codec->codec_id = CODEC_ID_8SVX_EXP;
190         break;
191     default:
192         av_log(s, AV_LOG_ERROR, "iff: unknown compression method\n");
193         return -1;
194     }
195
196     st->codec->bits_per_coded_sample = 8;
197     st->codec->bit_rate = st->codec->channels * st->codec->sample_rate * st->codec->bits_per_coded_sample;
198     st->codec->block_align = st->codec->channels * st->codec->bits_per_coded_sample;
199     break;
200
201     case AVMEDIA_TYPE_VIDEO:
202         switch (compression) {
203         case BITMAP_RAW:
204             if (st->codec->codec_tag == ID_ILBM) {
205                 st->codec->codec_id = CODEC_ID_IFF_ILBM;
206             } else {
207                 st->codec->codec_id = CODEC_ID_RAWVIDEO;
208                 st->codec->pix_fmt  = PIX_FMT_PAL8;
209                 st->codec->codec_tag = 0;
210             }
211             break;
212         case BITMAP_BYTERUN1:
213             st->codec->codec_id = CODEC_ID_IFF_BYTERUN1;
214             break;
215         default:
216             av_log(s, AV_LOG_ERROR, "unknown compression method\n");
217             return AVERROR_INVALIDDATA;
218         }
219         break;
220     default:
221         return -1;
222     }
223
224     return 0;
225 }
226
227 static int iff_read_packet(AVFormatContext *s,
228                            AVPacket *pkt)
229 {
230     IffDemuxContext *iff = s->priv_data;
231     ByteIOContext *pb = s->pb;
232     AVStream *st = s->streams[0];
233     int ret;
234
235     if(iff->sent_bytes >= iff->body_size)
236         return AVERROR(EIO);
237
238     if(s->streams[0]->codec->channels == 2) {
239         uint8_t sample_buffer[PACKET_SIZE];
240
241         ret = get_buffer(pb, sample_buffer, PACKET_SIZE);
242         if(av_new_packet(pkt, PACKET_SIZE) < 0) {
243             av_log(s, AV_LOG_ERROR, "iff: cannot allocate packet \n");
244             return AVERROR(ENOMEM);
245         }
246         interleave_stereo(sample_buffer, pkt->data, PACKET_SIZE);
247     } else if (s->streams[0]->codec->codec_id == CODEC_ID_RAWVIDEO) {
248         if(av_new_packet(pkt, iff->body_size + AVPALETTE_SIZE) < 0) {
249             return AVERROR(ENOMEM);
250         }
251
252         ret = ff_cmap_read_palette(st->codec, (uint32_t*)(pkt->data + iff->body_size));
253         if (ret < 0)
254             return ret;
255         av_freep(&st->codec->extradata);
256         st->codec->extradata_size = 0;
257
258         ret = get_buffer(pb, pkt->data, iff->body_size);
259     } else if (s->streams[0]->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
260         ret = av_get_packet(pb, pkt, iff->body_size);
261     } else {
262         ret = av_get_packet(pb, pkt, PACKET_SIZE);
263     }
264
265     if(iff->sent_bytes == 0)
266         pkt->flags |= AV_PKT_FLAG_KEY;
267
268     if(s->streams[0]->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
269         iff->sent_bytes += PACKET_SIZE;
270     } else {
271         iff->sent_bytes = iff->body_size;
272     }
273     pkt->stream_index = 0;
274     if(s->streams[0]->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
275         pkt->pts = iff->audio_frame_count;
276         iff->audio_frame_count += ret / s->streams[0]->codec->channels;
277     }
278     return ret;
279 }
280
281 AVInputFormat iff_demuxer = {
282     "IFF",
283     NULL_IF_CONFIG_SMALL("IFF format"),
284     sizeof(IffDemuxContext),
285     iff_probe,
286     iff_read_header,
287     iff_read_packet,
288 };