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