Libav
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 
72 #include "libavutil/imgutils.h"
73 #include "libavutil/intreadwrite.h"
74 #include "avformat.h"
75 #include "internal.h"
76 
77 #define HUFFMAN_TABLE_SIZE (64 * 1024)
78 #define IDCIN_FPS 14
79 
80 typedef struct IdcinDemuxContext {
86 
87  /* demux state variables */
91  int64_t first_pkt_pos;
93 
94 static int idcin_probe(AVProbeData *p)
95 {
96  unsigned int number;
97 
98  /*
99  * This is what you could call a "probabilistic" file check: id CIN
100  * files don't have a definite file signature. In lieu of such a marker,
101  * perform sanity checks on the 5 32-bit header fields:
102  * width, height: greater than 0, less than or equal to 1024
103  * audio sample rate: greater than or equal to 8000, less than or
104  * equal to 48000, or 0 for no audio
105  * audio sample width (bytes/sample): 0 for no audio, or 1 or 2
106  * audio channels: 0 for no audio, or 1 or 2
107  */
108 
109  /* check we have enough data to do all checks, otherwise the
110  0-padding may cause a wrong recognition */
111  if (p->buf_size < 20)
112  return 0;
113 
114  /* check the video width */
115  number = AV_RL32(&p->buf[0]);
116  if ((number == 0) || (number > 1024))
117  return 0;
118 
119  /* check the video height */
120  number = AV_RL32(&p->buf[4]);
121  if ((number == 0) || (number > 1024))
122  return 0;
123 
124  /* check the audio sample rate */
125  number = AV_RL32(&p->buf[8]);
126  if ((number != 0) && ((number < 8000) | (number > 48000)))
127  return 0;
128 
129  /* check the audio bytes/sample */
130  number = AV_RL32(&p->buf[12]);
131  if (number > 2)
132  return 0;
133 
134  /* check the audio channels */
135  number = AV_RL32(&p->buf[16]);
136  if (number > 2)
137  return 0;
138 
139  /* return half certainty since this check is a bit sketchy */
141 }
142 
144 {
145  AVIOContext *pb = s->pb;
146  IdcinDemuxContext *idcin = s->priv_data;
147  AVStream *st;
148  unsigned int width, height;
149  unsigned int sample_rate, bytes_per_sample, channels;
150  int ret;
151 
152  /* get the 5 header parameters */
153  width = avio_rl32(pb);
154  height = avio_rl32(pb);
155  sample_rate = avio_rl32(pb);
156  bytes_per_sample = avio_rl32(pb);
157  channels = avio_rl32(pb);
158 
159  if (s->pb->eof_reached) {
160  av_log(s, AV_LOG_ERROR, "incomplete header\n");
161  return s->pb->error ? s->pb->error : AVERROR_EOF;
162  }
163 
164  if (av_image_check_size(width, height, 0, s) < 0)
165  return AVERROR_INVALIDDATA;
166  if (sample_rate > 0) {
167  if (sample_rate < 14 || sample_rate > INT_MAX) {
168  av_log(s, AV_LOG_ERROR, "invalid sample rate: %u\n", sample_rate);
169  return AVERROR_INVALIDDATA;
170  }
171  if (bytes_per_sample < 1 || bytes_per_sample > 2) {
172  av_log(s, AV_LOG_ERROR, "invalid bytes per sample: %u\n",
173  bytes_per_sample);
174  return AVERROR_INVALIDDATA;
175  }
176  if (channels < 1 || channels > 2) {
177  av_log(s, AV_LOG_ERROR, "invalid channels: %u\n", channels);
178  return AVERROR_INVALIDDATA;
179  }
180  idcin->audio_present = 1;
181  } else {
182  /* if sample rate is 0, assume no audio */
183  idcin->audio_present = 0;
184  }
185 
186  st = avformat_new_stream(s, NULL);
187  if (!st)
188  return AVERROR(ENOMEM);
189  avpriv_set_pts_info(st, 33, 1, IDCIN_FPS);
190  st->start_time = 0;
191  idcin->video_stream_index = st->index;
194  st->codec->codec_tag = 0; /* no fourcc */
195  st->codec->width = width;
196  st->codec->height = height;
197 
198  /* load up the Huffman tables into extradata */
201  ret = avio_read(pb, st->codec->extradata, HUFFMAN_TABLE_SIZE);
202  if (ret < 0) {
203  return ret;
204  } else if (ret != HUFFMAN_TABLE_SIZE) {
205  av_log(s, AV_LOG_ERROR, "incomplete header\n");
206  return AVERROR(EIO);
207  }
208 
209  if (idcin->audio_present) {
210  idcin->audio_present = 1;
211  st = avformat_new_stream(s, NULL);
212  if (!st)
213  return AVERROR(ENOMEM);
214  avpriv_set_pts_info(st, 63, 1, sample_rate);
215  st->start_time = 0;
216  idcin->audio_stream_index = st->index;
218  st->codec->codec_tag = 1;
219  st->codec->channels = channels;
220  st->codec->channel_layout = channels > 1 ? AV_CH_LAYOUT_STEREO :
222  st->codec->sample_rate = sample_rate;
223  st->codec->bits_per_coded_sample = bytes_per_sample * 8;
224  st->codec->bit_rate = sample_rate * bytes_per_sample * 8 * channels;
225  st->codec->block_align = idcin->block_align = bytes_per_sample * channels;
226  if (bytes_per_sample == 1)
228  else
230 
231  if (sample_rate % 14 != 0) {
232  idcin->audio_chunk_size1 = (sample_rate / 14) *
233  bytes_per_sample * channels;
234  idcin->audio_chunk_size2 = (sample_rate / 14 + 1) *
235  bytes_per_sample * channels;
236  } else {
237  idcin->audio_chunk_size1 = idcin->audio_chunk_size2 =
238  (sample_rate / 14) * bytes_per_sample * channels;
239  }
240  idcin->current_audio_chunk = 0;
241  }
242 
243  idcin->next_chunk_is_video = 1;
244  idcin->first_pkt_pos = avio_tell(s->pb);
245 
246  return 0;
247 }
248 
250  AVPacket *pkt)
251 {
252  int ret;
253  unsigned int command;
254  unsigned int chunk_size;
255  IdcinDemuxContext *idcin = s->priv_data;
256  AVIOContext *pb = s->pb;
257  int i;
258  int palette_scale;
259  unsigned char r, g, b;
260  unsigned char palette_buffer[768];
261  uint32_t palette[256];
262 
263  if (s->pb->eof_reached)
264  return s->pb->error ? s->pb->error : AVERROR_EOF;
265 
266  if (idcin->next_chunk_is_video) {
267  command = avio_rl32(pb);
268  if (command == 2) {
269  return AVERROR(EIO);
270  } else if (command == 1) {
271  /* trigger a palette change */
272  ret = avio_read(pb, palette_buffer, 768);
273  if (ret < 0) {
274  return ret;
275  } else if (ret != 768) {
276  av_log(s, AV_LOG_ERROR, "incomplete packet\n");
277  return AVERROR(EIO);
278  }
279  /* scale the palette as necessary */
280  palette_scale = 2;
281  for (i = 0; i < 768; i++)
282  if (palette_buffer[i] > 63) {
283  palette_scale = 0;
284  break;
285  }
286 
287  for (i = 0; i < 256; i++) {
288  r = palette_buffer[i * 3 ] << palette_scale;
289  g = palette_buffer[i * 3 + 1] << palette_scale;
290  b = palette_buffer[i * 3 + 2] << palette_scale;
291  palette[i] = (r << 16) | (g << 8) | (b);
292  }
293  }
294 
295  if (s->pb->eof_reached) {
296  av_log(s, AV_LOG_ERROR, "incomplete packet\n");
297  return s->pb->error ? s->pb->error : AVERROR_EOF;
298  }
299  chunk_size = avio_rl32(pb);
300  if (chunk_size < 4 || chunk_size > INT_MAX - 4) {
301  av_log(s, AV_LOG_ERROR, "invalid chunk size: %u\n", chunk_size);
302  return AVERROR_INVALIDDATA;
303  }
304  /* skip the number of decoded bytes (always equal to width * height) */
305  avio_skip(pb, 4);
306  chunk_size -= 4;
307  ret= av_get_packet(pb, pkt, chunk_size);
308  if (ret < 0)
309  return ret;
310  else if (ret != chunk_size) {
311  av_log(s, AV_LOG_ERROR, "incomplete packet\n");
312  av_free_packet(pkt);
313  return AVERROR(EIO);
314  }
315  if (command == 1) {
316  uint8_t *pal;
317 
320  if (ret < 0) {
321  av_free_packet(pkt);
322  return ret;
323  }
324  memcpy(pal, palette, AVPALETTE_SIZE);
325  pkt->flags |= AV_PKT_FLAG_KEY;
326  }
327  pkt->stream_index = idcin->video_stream_index;
328  pkt->duration = 1;
329  } else {
330  /* send out the audio chunk */
331  if (idcin->current_audio_chunk)
332  chunk_size = idcin->audio_chunk_size2;
333  else
334  chunk_size = idcin->audio_chunk_size1;
335  ret= av_get_packet(pb, pkt, chunk_size);
336  if (ret < 0)
337  return ret;
338  pkt->stream_index = idcin->audio_stream_index;
339  pkt->duration = chunk_size / idcin->block_align;
340 
341  idcin->current_audio_chunk ^= 1;
342  }
343 
344  if (idcin->audio_present)
345  idcin->next_chunk_is_video ^= 1;
346 
347  return 0;
348 }
349 
350 static int idcin_read_seek(AVFormatContext *s, int stream_index,
351  int64_t timestamp, int flags)
352 {
353  IdcinDemuxContext *idcin = s->priv_data;
354 
355  if (idcin->first_pkt_pos > 0) {
356  int ret = avio_seek(s->pb, idcin->first_pkt_pos, SEEK_SET);
357  if (ret < 0)
358  return ret;
359  ff_update_cur_dts(s, s->streams[idcin->video_stream_index], 0);
360  idcin->next_chunk_is_video = 1;
361  idcin->current_audio_chunk = 0;
362  return 0;
363  }
364  return -1;
365 }
366 
368  .name = "idcin",
369  .long_name = NULL_IF_CONFIG_SMALL("id Cinematic"),
370  .priv_data_size = sizeof(IdcinDemuxContext),
376 };
#define AVPALETTE_SIZE
Definition: avcodec.h:2959
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:62
Bytestream IO Context.
Definition: avio.h:68
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:54
void av_free_packet(AVPacket *pkt)
Free a packet.
Definition: avpacket.c:242
static int idcin_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: idcin.c:350
misc image utilities
#define HUFFMAN_TABLE_SIZE
Definition: idcin.c:77
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:3208
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:153
int index
stream index in AVFormatContext
Definition: avformat.h:684
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:186
int audio_present
Definition: idcin.c:90
#define AV_CH_LAYOUT_STEREO
int block_align
number of bytes per packet if constant and known or 0 Used by some WAV based audio codecs...
Definition: avcodec.h:1816
Format I/O context.
Definition: avformat.h:871
void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp)
Update cur_dts of all streams based on the given timestamp and AVStream.
Definition: utils.c:1235
uint8_t
#define b
Definition: input.c:52
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1162
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:935
static int flags
Definition: log.c:44
#define AVERROR_EOF
End of file.
Definition: error.h:51
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:118
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:219
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:2481
int duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: avcodec.h:995
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
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1023
int current_audio_chunk
Definition: idcin.c:88
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:123
unsigned int avio_rl32(AVIOContext *s)
Definition: aviobuf.c:558
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:142
g
Definition: yuv2rgb.c:535
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:148
AVStream * avformat_new_stream(AVFormatContext *s, AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:2662
int audio_chunk_size2
Definition: idcin.c:84
static int idcin_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: idcin.c:249
int64_t first_pkt_pos
Definition: idcin.c:91
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:979
uint64_t channel_layout
Audio channel layout.
Definition: avcodec.h:1840
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:702
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:391
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:390
static int idcin_probe(AVProbeData *p)
Definition: idcin.c:94
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
Check if the given dimension of an image is valid, meaning that all bytes of the image can be address...
Definition: imgutils.c:220
int bit_rate
the average bitrate
Definition: avcodec.h:1112
audio channel layout utility functions
int video_stream_index
Definition: idcin.c:81
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
int width
picture width / height.
Definition: avcodec.h:1217
int block_align
Definition: idcin.c:85
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:82
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:536
Stream structure.
Definition: avformat.h:683
NULL
Definition: eval.c:55
static int width
Definition: utils.c:156
enum AVMediaType codec_type
Definition: avcodec.h:1062
#define IDCIN_FPS
Definition: idcin.c:78
enum AVCodecID codec_id
Definition: avcodec.h:1065
int sample_rate
samples per second
Definition: avcodec.h:1779
AVIOContext * pb
I/O context.
Definition: avformat.h:913
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
Definition: avcodec.h:1080
int extradata_size
Definition: avcodec.h:1163
static int read_packet(AVFormatContext *ctx, AVPacket *pkt)
Definition: libcdio.c:114
int audio_chunk_size1
Definition: idcin.c:83
#define AVPROBE_SCORE_EXTENSION
score for file extension
Definition: avformat.h:394
int error
contains the error code or 0 if no error happened
Definition: avio.h:102
This structure contains the data a format has to probe a file.
Definition: avformat.h:388
int height
Definition: gxfenc.c:72
Main libavformat public API header.
int64_t start_time
Decoding: pts of the first frame of the stream, in stream time base.
Definition: avformat.h:727
#define AVFMT_NO_BYTE_SEEK
Format does not allow seeking by bytes.
Definition: avformat.h:415
int eof_reached
true if eof reached
Definition: avio.h:96
int channels
number of audio channels
Definition: avcodec.h:1780
void * priv_data
Format private data.
Definition: avformat.h:899
static int idcin_read_header(AVFormatContext *s)
Definition: idcin.c:143
int next_chunk_is_video
Definition: idcin.c:89
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:516
AVInputFormat ff_idcin_demuxer
Definition: idcin.c:367
uint8_t * av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int size)
Allocate new information of a packet.
Definition: avpacket.c:261
int stream_index
Definition: avcodec.h:975
#define AV_CH_LAYOUT_MONO
This structure stores compressed data.
Definition: avcodec.h:950