6b107b9904e2bf1644b4192b90c741a9cf335d7e
[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 Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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
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/imgutils.h"
72 #include "libavutil/intreadwrite.h"
73 #include "avformat.h"
74 #include "internal.h"
75
76 #define HUFFMAN_TABLE_SIZE (64 * 1024)
77 #define IDCIN_FPS 14
78
79 typedef struct IdcinDemuxContext {
80     int video_stream_index;
81     int audio_stream_index;
82     int audio_chunk_size1;
83     int audio_chunk_size2;
84
85     /* demux state variables */
86     int current_audio_chunk;
87     int next_chunk_is_video;
88     int audio_present;
89
90     int64_t pts;
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 we have enough data to do all checks, otherwise the
109        0-padding may cause a wrong recognition */
110     if (p->buf_size < 20)
111         return 0;
112
113     /* check the video width */
114     number = AV_RL32(&p->buf[0]);
115     if ((number == 0) || (number > 1024))
116        return 0;
117
118     /* check the video height */
119     number = AV_RL32(&p->buf[4]);
120     if ((number == 0) || (number > 1024))
121        return 0;
122
123     /* check the audio sample rate */
124     number = AV_RL32(&p->buf[8]);
125     if ((number != 0) && ((number < 8000) | (number > 48000)))
126         return 0;
127
128     /* check the audio bytes/sample */
129     number = AV_RL32(&p->buf[12]);
130     if (number > 2)
131         return 0;
132
133     /* check the audio channels */
134     number = AV_RL32(&p->buf[16]);
135     if (number > 2)
136         return 0;
137
138     /* return half certainly since this check is a bit sketchy */
139     return AVPROBE_SCORE_MAX / 2;
140 }
141
142 static int idcin_read_header(AVFormatContext *s)
143 {
144     AVIOContext *pb = s->pb;
145     IdcinDemuxContext *idcin = s->priv_data;
146     AVStream *st;
147     unsigned int width, height;
148     unsigned int sample_rate, bytes_per_sample, channels;
149
150     /* get the 5 header parameters */
151     width = avio_rl32(pb);
152     height = avio_rl32(pb);
153     sample_rate = avio_rl32(pb);
154     bytes_per_sample = avio_rl32(pb);
155     channels = avio_rl32(pb);
156
157     if (av_image_check_size(width, height, 0, s) < 0)
158         return AVERROR_INVALIDDATA;
159     if (sample_rate > 0) {
160         if (sample_rate < 14 || sample_rate > INT_MAX) {
161             av_log(s, AV_LOG_ERROR, "invalid sample rate: %u\n", sample_rate);
162             return AVERROR_INVALIDDATA;
163         }
164         if (bytes_per_sample < 1 || bytes_per_sample > 2) {
165             av_log(s, AV_LOG_ERROR, "invalid bytes per sample: %u\n",
166                    bytes_per_sample);
167             return AVERROR_INVALIDDATA;
168         }
169         if (channels < 1 || channels > 2) {
170             av_log(s, AV_LOG_ERROR, "invalid channels: %u\n", channels);
171             return AVERROR_INVALIDDATA;
172         }
173     }
174
175     st = avformat_new_stream(s, NULL);
176     if (!st)
177         return AVERROR(ENOMEM);
178     avpriv_set_pts_info(st, 33, 1, IDCIN_FPS);
179     idcin->video_stream_index = st->index;
180     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
181     st->codec->codec_id = AV_CODEC_ID_IDCIN;
182     st->codec->codec_tag = 0;  /* no fourcc */
183     st->codec->width = width;
184     st->codec->height = height;
185
186     /* load up the Huffman tables into extradata */
187     st->codec->extradata_size = HUFFMAN_TABLE_SIZE;
188     st->codec->extradata = av_malloc(HUFFMAN_TABLE_SIZE);
189     if (avio_read(pb, st->codec->extradata, HUFFMAN_TABLE_SIZE) !=
190         HUFFMAN_TABLE_SIZE)
191         return AVERROR(EIO);
192
193     /* if sample rate is 0, assume no audio */
194     if (sample_rate) {
195         idcin->audio_present = 1;
196         st = avformat_new_stream(s, NULL);
197         if (!st)
198             return AVERROR(ENOMEM);
199         avpriv_set_pts_info(st, 33, 1, IDCIN_FPS);
200         idcin->audio_stream_index = st->index;
201         st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
202         st->codec->codec_tag = 1;
203         st->codec->channels = channels;
204         st->codec->sample_rate = sample_rate;
205         st->codec->bits_per_coded_sample = bytes_per_sample * 8;
206         st->codec->bit_rate = sample_rate * bytes_per_sample * 8 * channels;
207         st->codec->block_align = bytes_per_sample * channels;
208         if (bytes_per_sample == 1)
209             st->codec->codec_id = AV_CODEC_ID_PCM_U8;
210         else
211             st->codec->codec_id = AV_CODEC_ID_PCM_S16LE;
212
213         if (sample_rate % 14 != 0) {
214             idcin->audio_chunk_size1 = (sample_rate / 14) *
215             bytes_per_sample * channels;
216             idcin->audio_chunk_size2 = (sample_rate / 14 + 1) *
217                 bytes_per_sample * channels;
218         } else {
219             idcin->audio_chunk_size1 = idcin->audio_chunk_size2 =
220                 (sample_rate / 14) * bytes_per_sample * channels;
221         }
222         idcin->current_audio_chunk = 0;
223     } else
224         idcin->audio_present = 1;
225
226     idcin->next_chunk_is_video = 1;
227     idcin->pts = 0;
228
229     return 0;
230 }
231
232 static int idcin_read_packet(AVFormatContext *s,
233                              AVPacket *pkt)
234 {
235     int ret;
236     unsigned int command;
237     unsigned int chunk_size;
238     IdcinDemuxContext *idcin = s->priv_data;
239     AVIOContext *pb = s->pb;
240     int i;
241     int palette_scale;
242     unsigned char r, g, b;
243     unsigned char palette_buffer[768];
244     uint32_t palette[256];
245
246     if (s->pb->eof_reached)
247         return AVERROR(EIO);
248
249     if (idcin->next_chunk_is_video) {
250         command = avio_rl32(pb);
251         if (command == 2) {
252             return AVERROR(EIO);
253         } else if (command == 1) {
254             /* trigger a palette change */
255             if (avio_read(pb, palette_buffer, 768) != 768)
256                 return AVERROR(EIO);
257             /* scale the palette as necessary */
258             palette_scale = 2;
259             for (i = 0; i < 768; i++)
260                 if (palette_buffer[i] > 63) {
261                     palette_scale = 0;
262                     break;
263                 }
264
265             for (i = 0; i < 256; i++) {
266                 r = palette_buffer[i * 3    ] << palette_scale;
267                 g = palette_buffer[i * 3 + 1] << palette_scale;
268                 b = palette_buffer[i * 3 + 2] << palette_scale;
269                 palette[i] = (r << 16) | (g << 8) | (b);
270             }
271         }
272
273         chunk_size = avio_rl32(pb);
274         /* skip the number of decoded bytes (always equal to width * height) */
275         avio_skip(pb, 4);
276         chunk_size -= 4;
277         ret= av_get_packet(pb, pkt, chunk_size);
278         if (ret < 0)
279             return ret;
280         if (command == 1) {
281             uint8_t *pal;
282
283             pal = av_packet_new_side_data(pkt, AV_PKT_DATA_PALETTE,
284                                           AVPALETTE_SIZE);
285             if (ret < 0)
286                 return ret;
287             memcpy(pal, palette, AVPALETTE_SIZE);
288         }
289         pkt->stream_index = idcin->video_stream_index;
290         pkt->pts = idcin->pts;
291     } else {
292         /* send out the audio chunk */
293         if (idcin->current_audio_chunk)
294             chunk_size = idcin->audio_chunk_size2;
295         else
296             chunk_size = idcin->audio_chunk_size1;
297         ret= av_get_packet(pb, pkt, chunk_size);
298         if (ret < 0)
299             return ret;
300         pkt->stream_index = idcin->audio_stream_index;
301         pkt->pts = idcin->pts;
302
303         idcin->current_audio_chunk ^= 1;
304         idcin->pts++;
305     }
306
307     if (idcin->audio_present)
308         idcin->next_chunk_is_video ^= 1;
309
310     return ret;
311 }
312
313 AVInputFormat ff_idcin_demuxer = {
314     .name           = "idcin",
315     .long_name      = NULL_IF_CONFIG_SMALL("id Cinematic"),
316     .priv_data_size = sizeof(IdcinDemuxContext),
317     .read_probe     = idcin_probe,
318     .read_header    = idcin_read_header,
319     .read_packet    = idcin_read_packet,
320 };