Statistics
| Branch: | Revision:

ffmpeg / libavformat / idcin.c @ da9e6c42

History | View | Annotate | Download (10.1 KB)

1 4120a53a Mike Melanson
/*
2 ffa5ed24 Stefano Sabatini
 * id Quake II CIN File Demuxer
3 4120a53a Mike Melanson
 * Copyright (c) 2003 The ffmpeg Project
4
 *
5 b78e7197 Diego Biurrun
 * This file is part of FFmpeg.
6
 *
7
 * FFmpeg is free software; you can redistribute it and/or
8 4120a53a Mike Melanson
 * modify it under the terms of the GNU Lesser General Public
9
 * License as published by the Free Software Foundation; either
10 b78e7197 Diego Biurrun
 * version 2.1 of the License, or (at your option) any later version.
11 4120a53a Mike Melanson
 *
12 b78e7197 Diego Biurrun
 * FFmpeg is distributed in the hope that it will be useful,
13 4120a53a Mike Melanson
 * 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 b78e7197 Diego Biurrun
 * License along with FFmpeg; if not, write to the Free Software
19 5509bffa Diego Biurrun
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 4120a53a Mike Melanson
 */
21
22
/**
23 ba87f080 Diego Biurrun
 * @file
24 ffa5ed24 Stefano Sabatini
 * id Quake II CIN file demuxer by Mike Melanson (melanson@pcisys.net)
25
 * For more information about the id CIN format, visit:
26 4120a53a Mike Melanson
 *   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 ffa5ed24 Stefano Sabatini
 * Finally, not all id CIN creation tools agree on the resolution of the
57 4120a53a Mike Melanson
 * 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 6a5d31ac Diego Biurrun
#include "libavutil/intreadwrite.h"
72 4120a53a Mike Melanson
#include "avformat.h"
73
74
#define HUFFMAN_TABLE_SIZE (64 * 1024)
75 40e8e497 Mike Melanson
#define IDCIN_FPS 14
76 4120a53a Mike Melanson
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 2a2bbcb0 Mike Melanson
    AVPaletteControl palctrl;
91 4120a53a Mike Melanson
} IdcinDemuxContext;
92
93
static int idcin_probe(AVProbeData *p)
94
{
95
    unsigned int number;
96
97
    /*
98 ffa5ed24 Stefano Sabatini
     * This is what you could call a "probabilistic" file check: id CIN
99 4120a53a Mike Melanson
     * 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 8466ab59 Reimar Döffinger
    /* 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 4120a53a Mike Melanson
    /* check the video width */
114 fead30d4 Alex Beregszaszi
    number = AV_RL32(&p->buf[0]);
115 4120a53a Mike Melanson
    if ((number == 0) || (number > 1024))
116
       return 0;
117
118
    /* check the video height */
119 fead30d4 Alex Beregszaszi
    number = AV_RL32(&p->buf[4]);
120 4120a53a Mike Melanson
    if ((number == 0) || (number > 1024))
121
       return 0;
122
123
    /* check the audio sample rate */
124 fead30d4 Alex Beregszaszi
    number = AV_RL32(&p->buf[8]);
125 4120a53a Mike Melanson
    if ((number != 0) && ((number < 8000) | (number > 48000)))
126
        return 0;
127
128
    /* check the audio bytes/sample */
129 fead30d4 Alex Beregszaszi
    number = AV_RL32(&p->buf[12]);
130 4120a53a Mike Melanson
    if (number > 2)
131
        return 0;
132
133
    /* check the audio channels */
134 fead30d4 Alex Beregszaszi
    number = AV_RL32(&p->buf[16]);
135 4120a53a Mike Melanson
    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
                             AVFormatParameters *ap)
144
{
145 899681cd Björn Axelsson
    ByteIOContext *pb = s->pb;
146 e4141433 Nicholas Tung
    IdcinDemuxContext *idcin = s->priv_data;
147 4120a53a Mike Melanson
    AVStream *st;
148
    unsigned int width, height;
149
    unsigned int sample_rate, bytes_per_sample, channels;
150
151
    /* get the 5 header parameters */
152
    width = get_le32(pb);
153
    height = get_le32(pb);
154
    sample_rate = get_le32(pb);
155
    bytes_per_sample = get_le32(pb);
156
    channels = get_le32(pb);
157
158
    st = av_new_stream(s, 0);
159
    if (!st)
160 769e10f0 Panagiotis Issaris
        return AVERROR(ENOMEM);
161 40e8e497 Mike Melanson
    av_set_pts_info(st, 33, 1, IDCIN_FPS);
162 4120a53a Mike Melanson
    idcin->video_stream_index = st->index;
163 72415b2a Stefano Sabatini
    st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
164 01f4895c Michael Niedermayer
    st->codec->codec_id = CODEC_ID_IDCIN;
165
    st->codec->codec_tag = 0;  /* no fourcc */
166
    st->codec->width = width;
167
    st->codec->height = height;
168 4120a53a Mike Melanson
169
    /* load up the Huffman tables into extradata */
170 01f4895c Michael Niedermayer
    st->codec->extradata_size = HUFFMAN_TABLE_SIZE;
171
    st->codec->extradata = av_malloc(HUFFMAN_TABLE_SIZE);
172
    if (get_buffer(pb, st->codec->extradata, HUFFMAN_TABLE_SIZE) !=
173 4120a53a Mike Melanson
        HUFFMAN_TABLE_SIZE)
174 6f3e0b21 Panagiotis Issaris
        return AVERROR(EIO);
175 4120a53a Mike Melanson
    /* save a reference in order to transport the palette */
176 01f4895c Michael Niedermayer
    st->codec->palctrl = &idcin->palctrl;
177 4120a53a Mike Melanson
178
    /* if sample rate is 0, assume no audio */
179
    if (sample_rate) {
180
        idcin->audio_present = 1;
181
        st = av_new_stream(s, 0);
182
        if (!st)
183 769e10f0 Panagiotis Issaris
            return AVERROR(ENOMEM);
184 40e8e497 Mike Melanson
        av_set_pts_info(st, 33, 1, IDCIN_FPS);
185 4120a53a Mike Melanson
        idcin->audio_stream_index = st->index;
186 72415b2a Stefano Sabatini
        st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
187 01f4895c Michael Niedermayer
        st->codec->codec_tag = 1;
188
        st->codec->channels = channels;
189
        st->codec->sample_rate = sample_rate;
190 dd1c8f3e Luca Abeni
        st->codec->bits_per_coded_sample = bytes_per_sample * 8;
191 01f4895c Michael Niedermayer
        st->codec->bit_rate = sample_rate * bytes_per_sample * 8 * channels;
192
        st->codec->block_align = bytes_per_sample * channels;
193 4120a53a Mike Melanson
        if (bytes_per_sample == 1)
194 01f4895c Michael Niedermayer
            st->codec->codec_id = CODEC_ID_PCM_U8;
195 4120a53a Mike Melanson
        else
196 01f4895c Michael Niedermayer
            st->codec->codec_id = CODEC_ID_PCM_S16LE;
197 4120a53a Mike Melanson
198
        if (sample_rate % 14 != 0) {
199
            idcin->audio_chunk_size1 = (sample_rate / 14) *
200
            bytes_per_sample * channels;
201
            idcin->audio_chunk_size2 = (sample_rate / 14 + 1) *
202
                bytes_per_sample * channels;
203
        } else {
204
            idcin->audio_chunk_size1 = idcin->audio_chunk_size2 =
205
                (sample_rate / 14) * bytes_per_sample * channels;
206
        }
207
        idcin->current_audio_chunk = 0;
208
    } else
209
        idcin->audio_present = 1;
210
211
    idcin->next_chunk_is_video = 1;
212
    idcin->pts = 0;
213
214
    return 0;
215
}
216
217
static int idcin_read_packet(AVFormatContext *s,
218
                             AVPacket *pkt)
219
{
220
    int ret;
221
    unsigned int command;
222
    unsigned int chunk_size;
223 e4141433 Nicholas Tung
    IdcinDemuxContext *idcin = s->priv_data;
224 899681cd Björn Axelsson
    ByteIOContext *pb = s->pb;
225 4120a53a Mike Melanson
    int i;
226
    int palette_scale;
227 2a2bbcb0 Mike Melanson
    unsigned char r, g, b;
228
    unsigned char palette_buffer[768];
229 4120a53a Mike Melanson
230 899681cd Björn Axelsson
    if (url_feof(s->pb))
231 6f3e0b21 Panagiotis Issaris
        return AVERROR(EIO);
232 4120a53a Mike Melanson
233
    if (idcin->next_chunk_is_video) {
234
        command = get_le32(pb);
235
        if (command == 2) {
236 6f3e0b21 Panagiotis Issaris
            return AVERROR(EIO);
237 4120a53a Mike Melanson
        } else if (command == 1) {
238
            /* trigger a palette change */
239 2a2bbcb0 Mike Melanson
            idcin->palctrl.palette_changed = 1;
240
            if (get_buffer(pb, palette_buffer, 768) != 768)
241 6f3e0b21 Panagiotis Issaris
                return AVERROR(EIO);
242 4120a53a Mike Melanson
            /* scale the palette as necessary */
243
            palette_scale = 2;
244
            for (i = 0; i < 768; i++)
245 2a2bbcb0 Mike Melanson
                if (palette_buffer[i] > 63) {
246 4120a53a Mike Melanson
                    palette_scale = 0;
247
                    break;
248
                }
249
250 2a2bbcb0 Mike Melanson
            for (i = 0; i < 256; i++) {
251
                r = palette_buffer[i * 3    ] << palette_scale;
252
                g = palette_buffer[i * 3 + 1] << palette_scale;
253
                b = palette_buffer[i * 3 + 2] << palette_scale;
254
                idcin->palctrl.palette[i] = (r << 16) | (g << 8) | (b);
255
            }
256 4120a53a Mike Melanson
        }
257
258
        chunk_size = get_le32(pb);
259
        /* skip the number of decoded bytes (always equal to width * height) */
260
        url_fseek(pb, 4, SEEK_CUR);
261
        chunk_size -= 4;
262 115329f1 Diego Biurrun
        ret= av_get_packet(pb, pkt, chunk_size);
263 044a950d Vitor Sessak
        if (ret < 0)
264
            return ret;
265 4120a53a Mike Melanson
        pkt->stream_index = idcin->video_stream_index;
266
        pkt->pts = idcin->pts;
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 2692067a Michael Niedermayer
        ret= av_get_packet(pb, pkt, chunk_size);
274 044a950d Vitor Sessak
        if (ret < 0)
275
            return ret;
276 4120a53a Mike Melanson
        pkt->stream_index = idcin->audio_stream_index;
277
        pkt->pts = idcin->pts;
278
279
        idcin->current_audio_chunk ^= 1;
280 40e8e497 Mike Melanson
        idcin->pts++;
281 4120a53a Mike Melanson
    }
282
283
    if (idcin->audio_present)
284
        idcin->next_chunk_is_video ^= 1;
285
286
    return ret;
287
}
288
289 ff70e601 Måns Rullgård
AVInputFormat idcin_demuxer = {
290 4120a53a Mike Melanson
    "idcin",
291 517ac243 Diego Biurrun
    NULL_IF_CONFIG_SMALL("id Cinematic format"),
292 4120a53a Mike Melanson
    sizeof(IdcinDemuxContext),
293
    idcin_probe,
294
    idcin_read_header,
295
    idcin_read_packet,
296
};