remove numerous definitions of BE_*/LE_* macros; convert FOURCC_TAG ->
[ffmpeg.git] / libavformat / idcin.c
1 /*
2  * Id Quake II CIN File Demuxer
3  * Copyright (c) 2003 The ffmpeg Project
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19
20 /**
21  * @file idcin.c
22  * Id Quake II CIN file demuxer by Mike Melanson (melanson@pcisys.net)
23  * For more information about the Id CIN format, visit:
24  *   http://www.csse.monash.edu.au/~timf/
25  *
26  * CIN is a somewhat quirky and ill-defined format. Here are some notes
27  * for anyone trying to understand the technical details of this format:
28  *
29  * The format has no definite file signature. This is problematic for a
30  * general-purpose media player that wants to automatically detect file
31  * types. However, a CIN file does start with 5 32-bit numbers that
32  * specify audio and video parameters. This demuxer gets around the lack
33  * of file signature by performing sanity checks on those parameters.
34  * Probabalistically, this is a reasonable solution since the number of
35  * valid combinations of the 5 parameters is a very small subset of the
36  * total 160-bit number space.
37  *
38  * Refer to the function idcin_probe() for the precise A/V parameters
39  * that this demuxer allows.
40  *
41  * Next, each audio and video frame has a duration of 1/14 sec. If the
42  * audio sample rate is a multiple of the common frequency 22050 Hz it will
43  * divide evenly by 14. However, if the sample rate is 11025 Hz:
44  *   11025 (samples/sec) / 14 (frames/sec) = 787.5 (samples/frame)
45  * The way the CIN stores audio in this case is by storing 787 sample
46  * frames in the first audio frame and 788 sample frames in the second
47  * audio frame. Therefore, the total number of bytes in an audio frame
48  * is given as:
49  *   audio frame #0: 787 * (bytes/sample) * (# channels) bytes in frame
50  *   audio frame #1: 788 * (bytes/sample) * (# channels) bytes in frame
51  *   audio frame #2: 787 * (bytes/sample) * (# channels) bytes in frame
52  *   audio frame #3: 788 * (bytes/sample) * (# channels) bytes in frame
53  *
54  * Finally, not all Id CIN creation tools agree on the resolution of the
55  * color palette, apparently. Some creation tools specify red, green, and
56  * blue palette components in terms of 6-bit VGA color DAC values which
57  * range from 0..63. Other tools specify the RGB components as full 8-bit
58  * values that range from 0..255. Since there are no markers in the file to
59  * differentiate between the two variants, this demuxer uses the following
60  * heuristic:
61  *   - load the 768 palette bytes from disk
62  *   - assume that they will need to be shifted left by 2 bits to
63  *     transform them from 6-bit values to 8-bit values
64  *   - scan through all 768 palette bytes
65  *     - if any bytes exceed 63, do not shift the bytes at all before
66  *       transmitting them to the video decoder
67  */
68
69 #include "avformat.h"
70
71 #define HUFFMAN_TABLE_SIZE (64 * 1024)
72 #define FRAME_PTS_INC (90000 / 14)
73
74 typedef struct IdcinDemuxContext {
75     int video_stream_index;
76     int audio_stream_index;
77     int audio_chunk_size1;
78     int audio_chunk_size2;
79
80     /* demux state variables */
81     int current_audio_chunk;
82     int next_chunk_is_video;
83     int audio_present;
84
85     int64_t pts;
86
87     AVPaletteControl palctrl;
88 } IdcinDemuxContext;
89
90 static int idcin_probe(AVProbeData *p)
91 {
92     unsigned int number;
93
94     /*
95      * This is what you could call a "probabilistic" file check: Id CIN
96      * files don't have a definite file signature. In lieu of such a marker,
97      * perform sanity checks on the 5 32-bit header fields:
98      *  width, height: greater than 0, less than or equal to 1024
99      * audio sample rate: greater than or equal to 8000, less than or
100      *  equal to 48000, or 0 for no audio
101      * audio sample width (bytes/sample): 0 for no audio, or 1 or 2
102      * audio channels: 0 for no audio, or 1 or 2
103      */
104
105     /* cannot proceed without 20 bytes */
106     if (p->buf_size < 20)
107         return 0;
108
109     /* check the video width */
110     number = LE_32(&p->buf[0]);
111     if ((number == 0) || (number > 1024))
112        return 0;
113
114     /* check the video height */
115     number = LE_32(&p->buf[4]);
116     if ((number == 0) || (number > 1024))
117        return 0;
118
119     /* check the audio sample rate */
120     number = LE_32(&p->buf[8]);
121     if ((number != 0) && ((number < 8000) | (number > 48000)))
122         return 0;
123
124     /* check the audio bytes/sample */
125     number = LE_32(&p->buf[12]);
126     if (number > 2)
127         return 0;
128
129     /* check the audio channels */
130     number = LE_32(&p->buf[16]);
131     if (number > 2)
132         return 0;
133
134     /* return half certainly since this check is a bit sketchy */
135     return AVPROBE_SCORE_MAX / 2;
136 }
137
138 static int idcin_read_header(AVFormatContext *s,
139                              AVFormatParameters *ap)
140 {
141     ByteIOContext *pb = &s->pb;
142     IdcinDemuxContext *idcin = (IdcinDemuxContext *)s->priv_data;
143     AVStream *st;
144     unsigned int width, height;
145     unsigned int sample_rate, bytes_per_sample, channels;
146
147     /* get the 5 header parameters */
148     width = get_le32(pb);
149     height = get_le32(pb);
150     sample_rate = get_le32(pb);
151     bytes_per_sample = get_le32(pb);
152     channels = get_le32(pb);
153
154     st = av_new_stream(s, 0);
155     if (!st)
156         return AVERROR_NOMEM;
157     idcin->video_stream_index = st->index;
158     st->codec.codec_type = CODEC_TYPE_VIDEO;
159     st->codec.codec_id = CODEC_ID_IDCIN;
160     st->codec.codec_tag = 0;  /* no fourcc */
161     st->codec.width = width;
162     st->codec.height = height;
163
164     /* load up the Huffman tables into extradata */
165     st->codec.extradata_size = HUFFMAN_TABLE_SIZE;
166     st->codec.extradata = av_malloc(HUFFMAN_TABLE_SIZE);
167     if (get_buffer(pb, st->codec.extradata, HUFFMAN_TABLE_SIZE) !=
168         HUFFMAN_TABLE_SIZE)
169         return -EIO;
170     /* save a reference in order to transport the palette */
171     st->codec.palctrl = &idcin->palctrl;
172
173     /* if sample rate is 0, assume no audio */
174     if (sample_rate) {
175         idcin->audio_present = 1;
176         st = av_new_stream(s, 0);
177         if (!st)
178             return AVERROR_NOMEM;
179         idcin->audio_stream_index = st->index;
180         st->codec.codec_type = CODEC_TYPE_AUDIO;
181         st->codec.codec_tag = 1;
182         st->codec.channels = channels;
183         st->codec.sample_rate = sample_rate;
184         st->codec.bits_per_sample = bytes_per_sample * 8;
185         st->codec.bit_rate = sample_rate * bytes_per_sample * 8 * channels;
186         st->codec.block_align = bytes_per_sample * channels;
187         if (bytes_per_sample == 1)
188             st->codec.codec_id = CODEC_ID_PCM_U8;
189         else
190             st->codec.codec_id = CODEC_ID_PCM_S16LE;
191
192         if (sample_rate % 14 != 0) {
193             idcin->audio_chunk_size1 = (sample_rate / 14) *
194             bytes_per_sample * channels;
195             idcin->audio_chunk_size2 = (sample_rate / 14 + 1) *
196                 bytes_per_sample * channels;
197         } else {
198             idcin->audio_chunk_size1 = idcin->audio_chunk_size2 =
199                 (sample_rate / 14) * bytes_per_sample * channels;
200         }
201         idcin->current_audio_chunk = 0;
202     } else
203         idcin->audio_present = 1;
204
205     idcin->next_chunk_is_video = 1;
206     idcin->pts = 0;
207
208     /* set the pts reference (1 pts = 1/90000) */
209     s->pts_num = 1;
210     s->pts_den = 90000;
211
212     return 0;
213 }
214
215 static int idcin_read_packet(AVFormatContext *s,
216                              AVPacket *pkt)
217 {
218     int ret;
219     unsigned int command;
220     unsigned int chunk_size;
221     IdcinDemuxContext *idcin = (IdcinDemuxContext *)s->priv_data;
222     ByteIOContext *pb = &s->pb;
223     int i;
224     int palette_scale;
225     unsigned char r, g, b;
226     unsigned char palette_buffer[768];
227
228     if (url_feof(&s->pb))
229         return -EIO;
230
231     if (idcin->next_chunk_is_video) {
232         command = get_le32(pb);
233         if (command == 2) {
234             return -EIO;
235         } else if (command == 1) {
236             /* trigger a palette change */
237             idcin->palctrl.palette_changed = 1;
238             if (get_buffer(pb, palette_buffer, 768) != 768)
239                 return -EIO;
240             /* scale the palette as necessary */
241             palette_scale = 2;
242             for (i = 0; i < 768; i++)
243                 if (palette_buffer[i] > 63) {
244                     palette_scale = 0;
245                     break;
246                 }
247
248             for (i = 0; i < 256; i++) {
249                 r = palette_buffer[i * 3    ] << palette_scale;
250                 g = palette_buffer[i * 3 + 1] << palette_scale;
251                 b = palette_buffer[i * 3 + 2] << palette_scale;
252                 idcin->palctrl.palette[i] = (r << 16) | (g << 8) | (b);
253             }
254         }
255
256         chunk_size = get_le32(pb);
257         /* skip the number of decoded bytes (always equal to width * height) */
258         url_fseek(pb, 4, SEEK_CUR);
259         chunk_size -= 4;
260         if (av_new_packet(pkt, chunk_size))
261             ret = -EIO;
262         pkt->stream_index = idcin->video_stream_index;
263         pkt->pts = idcin->pts;
264         ret = get_buffer(pb, pkt->data, chunk_size);
265         if (ret != chunk_size)
266             ret = -EIO;
267     } else {
268         /* send out the audio chunk */
269         if (idcin->current_audio_chunk)
270             chunk_size = idcin->audio_chunk_size2;
271         else
272             chunk_size = idcin->audio_chunk_size1;
273         if (av_new_packet(pkt, chunk_size))
274             return -EIO;
275         pkt->stream_index = idcin->audio_stream_index;
276         pkt->pts = idcin->pts;
277         ret = get_buffer(&s->pb, pkt->data, chunk_size);
278         if (ret != chunk_size)
279             ret = -EIO;
280
281         idcin->current_audio_chunk ^= 1;
282         idcin->pts += FRAME_PTS_INC;
283     }
284
285     if (idcin->audio_present)
286         idcin->next_chunk_is_video ^= 1;
287
288     return ret;
289 }
290
291 static int idcin_read_close(AVFormatContext *s)
292 {
293
294     return 0;
295 }
296
297 static AVInputFormat idcin_iformat = {
298     "idcin",
299     "Id CIN format",
300     sizeof(IdcinDemuxContext),
301     idcin_probe,
302     idcin_read_header,
303     idcin_read_packet,
304     idcin_read_close,
305 };
306
307 int idcin_init(void)
308 {
309     av_register_input_format(&idcin_iformat);
310     return 0;
311 }