idcin.c
Go to the documentation of this file.
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 
71 #include "libavutil/intreadwrite.h"
72 #include "avformat.h"
73 #include "internal.h"
74 
75 #define HUFFMAN_TABLE_SIZE (64 * 1024)
76 #define IDCIN_FPS 14
77 
78 typedef struct IdcinDemuxContext {
83 
84  /* demux state variables */
88 
89  int64_t pts;
91 
92 static int idcin_probe(AVProbeData *p)
93 {
94  unsigned int number;
95 
96  /*
97  * This is what you could call a "probabilistic" file check: id CIN
98  * files don't have a definite file signature. In lieu of such a marker,
99  * perform sanity checks on the 5 32-bit header fields:
100  * width, height: greater than 0, less than or equal to 1024
101  * audio sample rate: greater than or equal to 8000, less than or
102  * equal to 48000, or 0 for no audio
103  * audio sample width (bytes/sample): 0 for no audio, or 1 or 2
104  * audio channels: 0 for no audio, or 1 or 2
105  */
106 
107  /* check we have enough data to do all checks, otherwise the
108  0-padding may cause a wrong recognition */
109  if (p->buf_size < 20)
110  return 0;
111 
112  /* check the video width */
113  number = AV_RL32(&p->buf[0]);
114  if ((number == 0) || (number > 1024))
115  return 0;
116 
117  /* check the video height */
118  number = AV_RL32(&p->buf[4]);
119  if ((number == 0) || (number > 1024))
120  return 0;
121 
122  /* check the audio sample rate */
123  number = AV_RL32(&p->buf[8]);
124  if ((number != 0) && ((number < 8000) | (number > 48000)))
125  return 0;
126 
127  /* check the audio bytes/sample */
128  number = AV_RL32(&p->buf[12]);
129  if (number > 2)
130  return 0;
131 
132  /* check the audio channels */
133  number = AV_RL32(&p->buf[16]);
134  if (number > 2)
135  return 0;
136 
137  /* return half certainly since this check is a bit sketchy */
138  return AVPROBE_SCORE_MAX / 2;
139 }
140 
142 {
143  AVIOContext *pb = s->pb;
144  IdcinDemuxContext *idcin = s->priv_data;
145  AVStream *st;
146  unsigned int width, height;
147  unsigned int sample_rate, bytes_per_sample, channels;
148 
149  /* get the 5 header parameters */
150  width = avio_rl32(pb);
151  height = avio_rl32(pb);
152  sample_rate = avio_rl32(pb);
153  bytes_per_sample = avio_rl32(pb);
154  channels = avio_rl32(pb);
155 
156  st = avformat_new_stream(s, NULL);
157  if (!st)
158  return AVERROR(ENOMEM);
159  avpriv_set_pts_info(st, 33, 1, IDCIN_FPS);
160  idcin->video_stream_index = st->index;
163  st->codec->codec_tag = 0; /* no fourcc */
164  st->codec->width = width;
165  st->codec->height = height;
166 
167  /* load up the Huffman tables into extradata */
170  if (avio_read(pb, st->codec->extradata, HUFFMAN_TABLE_SIZE) !=
172  return AVERROR(EIO);
173 
174  /* if sample rate is 0, assume no audio */
175  if (sample_rate) {
176  idcin->audio_present = 1;
177  st = avformat_new_stream(s, NULL);
178  if (!st)
179  return AVERROR(ENOMEM);
180  avpriv_set_pts_info(st, 33, 1, IDCIN_FPS);
181  idcin->audio_stream_index = st->index;
183  st->codec->codec_tag = 1;
184  st->codec->channels = channels;
185  st->codec->sample_rate = sample_rate;
186  st->codec->bits_per_coded_sample = bytes_per_sample * 8;
187  st->codec->bit_rate = sample_rate * bytes_per_sample * 8 * channels;
188  st->codec->block_align = bytes_per_sample * channels;
189  if (bytes_per_sample == 1)
191  else
193 
194  if (sample_rate % 14 != 0) {
195  idcin->audio_chunk_size1 = (sample_rate / 14) *
196  bytes_per_sample * channels;
197  idcin->audio_chunk_size2 = (sample_rate / 14 + 1) *
198  bytes_per_sample * channels;
199  } else {
200  idcin->audio_chunk_size1 = idcin->audio_chunk_size2 =
201  (sample_rate / 14) * bytes_per_sample * channels;
202  }
203  idcin->current_audio_chunk = 0;
204  } else
205  idcin->audio_present = 1;
206 
207  idcin->next_chunk_is_video = 1;
208  idcin->pts = 0;
209 
210  return 0;
211 }
212 
214  AVPacket *pkt)
215 {
216  int ret;
217  unsigned int command;
218  unsigned int chunk_size;
219  IdcinDemuxContext *idcin = s->priv_data;
220  AVIOContext *pb = s->pb;
221  int i;
222  int palette_scale;
223  unsigned char r, g, b;
224  unsigned char palette_buffer[768];
225  uint32_t palette[256];
226 
227  if (s->pb->eof_reached)
228  return AVERROR(EIO);
229 
230  if (idcin->next_chunk_is_video) {
231  command = avio_rl32(pb);
232  if (command == 2) {
233  return AVERROR(EIO);
234  } else if (command == 1) {
235  /* trigger a palette change */
236  if (avio_read(pb, palette_buffer, 768) != 768)
237  return AVERROR(EIO);
238  /* scale the palette as necessary */
239  palette_scale = 2;
240  for (i = 0; i < 768; i++)
241  if (palette_buffer[i] > 63) {
242  palette_scale = 0;
243  break;
244  }
245 
246  for (i = 0; i < 256; i++) {
247  r = palette_buffer[i * 3 ] << palette_scale;
248  g = palette_buffer[i * 3 + 1] << palette_scale;
249  b = palette_buffer[i * 3 + 2] << palette_scale;
250  palette[i] = (r << 16) | (g << 8) | (b);
251  }
252  }
253 
254  chunk_size = avio_rl32(pb);
255  /* skip the number of decoded bytes (always equal to width * height) */
256  avio_skip(pb, 4);
257  chunk_size -= 4;
258  ret= av_get_packet(pb, pkt, chunk_size);
259  if (ret < 0)
260  return ret;
261  if (command == 1) {
262  uint8_t *pal;
263 
266  if (ret < 0)
267  return ret;
268  memcpy(pal, palette, AVPALETTE_SIZE);
269  }
270  pkt->stream_index = idcin->video_stream_index;
271  pkt->pts = idcin->pts;
272  } else {
273  /* send out the audio chunk */
274  if (idcin->current_audio_chunk)
275  chunk_size = idcin->audio_chunk_size2;
276  else
277  chunk_size = idcin->audio_chunk_size1;
278  ret= av_get_packet(pb, pkt, chunk_size);
279  if (ret < 0)
280  return ret;
281  pkt->stream_index = idcin->audio_stream_index;
282  pkt->pts = idcin->pts;
283 
284  idcin->current_audio_chunk ^= 1;
285  idcin->pts++;
286  }
287 
288  if (idcin->audio_present)
289  idcin->next_chunk_is_video ^= 1;
290 
291  return ret;
292 }
293 
295  .name = "idcin",
296  .long_name = NULL_IF_CONFIG_SMALL("id Cinematic"),
297  .priv_data_size = sizeof(IdcinDemuxContext),
301 };
void * av_malloc(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:61
Bytestream IO Context.
Definition: avio.h:68
#define HUFFMAN_TABLE_SIZE
Definition: idcin.c:75
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:3283
int index
stream index in AVFormatContext
Definition: avformat.h:623
int audio_present
Definition: idcin.c:87
int block_align
number of bytes per packet if constant and known or 0 Used by some WAV based audio codecs...
Definition: avcodec.h:2141
Format I/O context.
Definition: avformat.h:828
uint8_t
#define b
Definition: input.c:52
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1454
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:218
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:2704
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:446
#define r
Definition: input.c:51
int current_audio_chunk
Definition: idcin.c:85
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:546
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:88
g
Definition: yuv2rgb.c:540
AVStream * avformat_new_stream(AVFormatContext *s, AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:2736
int audio_chunk_size2
Definition: idcin.c:82
static int idcin_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: idcin.c:213
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:641
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:341
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:340
static int idcin_probe(AVProbeData *p)
Definition: idcin.c:92
int bit_rate
the average bitrate
Definition: avcodec.h:1404
int video_stream_index
Definition: idcin.c:79
int64_t pts
Definition: idcin.c:89
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:54
int width
picture width / height.
Definition: avcodec.h:1508
static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: avio.h:210
#define AV_RL32
Definition: intreadwrite.h:146
int audio_stream_index
Definition: idcin.c:80
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:536
struct IdcinDemuxContext IdcinDemuxContext
Stream structure.
Definition: avformat.h:622
NULL
Definition: eval.c:52
static int width
Definition: utils.c:156
enum AVMediaType codec_type
Definition: avcodec.h:1347
#define IDCIN_FPS
Definition: idcin.c:76
enum AVCodecID codec_id
Definition: avcodec.h:1350
int sample_rate
samples per second
Definition: avcodec.h:2104
AVIOContext * pb
I/O context.
Definition: avformat.h:861
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
Definition: avcodec.h:1365
int extradata_size
Definition: avcodec.h:1455
static int read_packet(AVFormatContext *ctx, AVPacket *pkt)
Definition: libcdio.c:114
int audio_chunk_size1
Definition: idcin.c:81
This structure contains the data a format has to probe a file.
Definition: avformat.h:338
int height
Definition: gxfenc.c:72
Main libavformat public API header.
int eof_reached
true if eof reached
Definition: avio.h:96
int channels
number of audio channels
Definition: avcodec.h:2105
void * priv_data
Format private data.
Definition: avformat.h:848
static int idcin_read_header(AVFormatContext *s)
Definition: idcin.c:141
int next_chunk_is_video
Definition: idcin.c:86
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:455
AVInputFormat ff_idcin_demuxer
Definition: idcin.c:294
uint8_t * av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int size)
Allocate new information of a packet.
Definition: avpacket.c:165
int stream_index
Definition: avcodec.h:917
This structure stores compressed data.
Definition: avcodec.h:898
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:908