FFmpeg  4.0
idroqdec.c
Go to the documentation of this file.
1 /*
2  * id RoQ (.roq) 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
24  * id RoQ format file demuxer
25  * by Mike Melanson (melanson@pcisys.net)
26  * for more information on the .roq file format, visit:
27  * http://www.csse.monash.edu.au/~timf/
28  */
29 
31 #include "libavutil/intreadwrite.h"
32 #include "avformat.h"
33 #include "internal.h"
34 #include "avio_internal.h"
35 
36 #define RoQ_MAGIC_NUMBER 0x1084
37 #define RoQ_CHUNK_PREAMBLE_SIZE 8
38 #define RoQ_AUDIO_SAMPLE_RATE 22050
39 #define RoQ_CHUNKS_TO_SCAN 30
40 
41 #define RoQ_INFO 0x1001
42 #define RoQ_QUAD_CODEBOOK 0x1002
43 #define RoQ_QUAD_VQ 0x1011
44 #define RoQ_SOUND_MONO 0x1020
45 #define RoQ_SOUND_STEREO 0x1021
46 
47 typedef struct RoqDemuxContext {
48 
50  int width;
51  int height;
53 
56 
57  int64_t video_pts;
58  unsigned int audio_frame_count;
59 
61 
62 static int roq_probe(AVProbeData *p)
63 {
64  if ((AV_RL16(&p->buf[0]) != RoQ_MAGIC_NUMBER) ||
65  (AV_RL32(&p->buf[2]) != 0xFFFFFFFF))
66  return 0;
67 
68  return AVPROBE_SCORE_MAX;
69 }
70 
72 {
73  RoqDemuxContext *roq = s->priv_data;
74  AVIOContext *pb = s->pb;
75  unsigned char preamble[RoQ_CHUNK_PREAMBLE_SIZE];
76 
77  /* get the main header */
78  if (avio_read(pb, preamble, RoQ_CHUNK_PREAMBLE_SIZE) !=
80  return AVERROR(EIO);
81  roq->frame_rate = AV_RL16(&preamble[6]);
82 
83  /* init private context parameters */
84  roq->width = roq->height = roq->audio_channels = roq->video_pts =
85  roq->audio_frame_count = 0;
86  roq->audio_stream_index = -1;
87  roq->video_stream_index = -1;
88 
90 
91  return 0;
92 }
93 
95  AVPacket *pkt)
96 {
97  RoqDemuxContext *roq = s->priv_data;
98  AVIOContext *pb = s->pb;
99  int ret = 0;
100  unsigned int chunk_size;
101  unsigned int chunk_type;
102  unsigned int codebook_size;
103  unsigned char preamble[RoQ_CHUNK_PREAMBLE_SIZE];
104  int packet_read = 0;
105  int64_t codebook_offset;
106 
107  while (!packet_read) {
108 
109  if (avio_feof(s->pb))
110  return AVERROR(EIO);
111 
112  /* get the next chunk preamble */
113  if ((ret = avio_read(pb, preamble, RoQ_CHUNK_PREAMBLE_SIZE)) !=
115  return AVERROR(EIO);
116 
117  chunk_type = AV_RL16(&preamble[0]);
118  chunk_size = AV_RL32(&preamble[2]);
119  if(chunk_size > INT_MAX)
120  return AVERROR_INVALIDDATA;
121 
122  chunk_size = ffio_limit(pb, chunk_size);
123 
124  switch (chunk_type) {
125 
126  case RoQ_INFO:
127  if (roq->video_stream_index == -1) {
129  if (!st)
130  return AVERROR(ENOMEM);
131  avpriv_set_pts_info(st, 63, 1, roq->frame_rate);
132  roq->video_stream_index = st->index;
135  st->codecpar->codec_tag = 0; /* no fourcc */
136 
138  return AVERROR(EIO);
139  st->codecpar->width = roq->width = AV_RL16(preamble);
140  st->codecpar->height = roq->height = AV_RL16(preamble + 2);
141  break;
142  }
143  /* don't care about this chunk anymore */
145  break;
146 
147  case RoQ_QUAD_CODEBOOK:
148  if (roq->video_stream_index < 0)
149  return AVERROR_INVALIDDATA;
150  /* packet needs to contain both this codebook and next VQ chunk */
151  codebook_offset = avio_tell(pb) - RoQ_CHUNK_PREAMBLE_SIZE;
152  codebook_size = chunk_size;
153  avio_skip(pb, codebook_size);
154  if (avio_read(pb, preamble, RoQ_CHUNK_PREAMBLE_SIZE) !=
156  return AVERROR(EIO);
157  chunk_size = AV_RL32(&preamble[2]) + RoQ_CHUNK_PREAMBLE_SIZE * 2 +
158  codebook_size;
159 
160  if (chunk_size > INT_MAX)
161  return AVERROR_INVALIDDATA;
162 
163  /* rewind */
164  avio_seek(pb, codebook_offset, SEEK_SET);
165 
166  /* load up the packet */
167  ret= av_get_packet(pb, pkt, chunk_size);
168  if (ret != chunk_size)
169  return AVERROR(EIO);
170  pkt->stream_index = roq->video_stream_index;
171  pkt->pts = roq->video_pts++;
172 
173  packet_read = 1;
174  break;
175 
176  case RoQ_SOUND_MONO:
177  case RoQ_SOUND_STEREO:
178  if (roq->audio_stream_index == -1) {
180  if (!st)
181  return AVERROR(ENOMEM);
183  roq->audio_stream_index = st->index;
186  st->codecpar->codec_tag = 0; /* no tag */
187  if (chunk_type == RoQ_SOUND_STEREO) {
188  st->codecpar->channels = 2;
190  } else {
191  st->codecpar->channels = 1;
193  }
194  roq->audio_channels = st->codecpar->channels;
200  }
201  case RoQ_QUAD_VQ:
202  if (chunk_type == RoQ_QUAD_VQ) {
203  if (roq->video_stream_index < 0)
204  return AVERROR_INVALIDDATA;
205  }
206 
207  /* load up the packet */
208  if (av_new_packet(pkt, chunk_size + RoQ_CHUNK_PREAMBLE_SIZE))
209  return AVERROR(EIO);
210  /* copy over preamble */
211  memcpy(pkt->data, preamble, RoQ_CHUNK_PREAMBLE_SIZE);
212 
213  if (chunk_type == RoQ_QUAD_VQ) {
214  pkt->stream_index = roq->video_stream_index;
215  pkt->pts = roq->video_pts++;
216  } else {
217  pkt->stream_index = roq->audio_stream_index;
218  pkt->pts = roq->audio_frame_count;
219  roq->audio_frame_count += (chunk_size / roq->audio_channels);
220  }
221 
222  pkt->pos= avio_tell(pb);
223  ret = avio_read(pb, pkt->data + RoQ_CHUNK_PREAMBLE_SIZE,
224  chunk_size);
225  if (ret != chunk_size) {
226  av_packet_unref(pkt);
227  ret = AVERROR(EIO);
228  }
229 
230  packet_read = 1;
231  break;
232 
233  default:
234  av_log(s, AV_LOG_ERROR, " unknown RoQ chunk (%04X)\n", chunk_type);
235  return AVERROR_INVALIDDATA;
236  }
237  }
238 
239  return ret;
240 }
241 
243  .name = "roq",
244  .long_name = NULL_IF_CONFIG_SMALL("id RoQ"),
245  .priv_data_size = sizeof(RoqDemuxContext),
249 };
#define NULL
Definition: coverity.c:32
int audio_channels
Definition: idroqdec.c:52
const char * s
Definition: avisynth_c.h:768
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
unsigned int audio_frame_count
Definition: idroqdec.c:58
int64_t pos
byte position in stream, -1 if unknown
Definition: avcodec.h:1450
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:4811
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3884
int index
stream index in AVFormatContext
Definition: avformat.h:874
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
static int roq_probe(AVProbeData *p)
Definition: idroqdec.c:62
int64_t video_pts
Definition: idroqdec.c:57
#define AV_RL16
Definition: intreadwrite.h:42
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:331
static AVPacket pkt
#define AV_CH_LAYOUT_STEREO
int ctx_flags
Flags signalling stream properties.
Definition: avformat.h:1391
#define RoQ_SOUND_STEREO
Definition: idroqdec.c:45
#define RoQ_MAGIC_NUMBER
Definition: idroqdec.c:36
Format I/O context.
Definition: avformat.h:1342
int ffio_limit(AVIOContext *s, int size)
Definition: utils.c:247
int width
Video only.
Definition: avcodec.h:3950
#define AVFMTCTX_NOHEADER
signal that no header is present (streams are added dynamically)
Definition: avformat.h:1286
static int roq_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: idroqdec.c:94
#define RoQ_INFO
Definition: idroqdec.c:41
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4441
uint8_t * data
Definition: avcodec.h:1430
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:310
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:557
uint64_t channel_layout
Audio only.
Definition: avcodec.h:3986
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:648
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: avcodec.h:3913
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:86
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define AVERROR(e)
Definition: error.h:43
int audio_stream_index
Definition: idroqdec.c:55
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3880
#define RoQ_SOUND_MONO
Definition: idroqdec.c:44
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:450
int block_align
Audio only.
Definition: avcodec.h:4001
audio channel layout utility functions
static int read_probe(AVProbeData *pd)
Definition: jvdec.c:55
#define AV_RL32
Definition: intreadwrite.h:146
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:530
Stream structure.
Definition: avformat.h:873
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVIOContext * pb
I/O context.
Definition: avformat.h:1384
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:592
#define RoQ_CHUNK_PREAMBLE_SIZE
Definition: idroqdec.c:37
#define RoQ_AUDIO_SAMPLE_RATE
Definition: idroqdec.c:38
This structure contains the data a format has to probe a file.
Definition: avformat.h:448
int sample_rate
Audio only.
Definition: avcodec.h:3994
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:460
Main libavformat public API header.
int video_stream_index
Definition: idroqdec.c:54
void * priv_data
Format private data.
Definition: avformat.h:1370
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: avcodec.h:3926
int channels
Audio only.
Definition: avcodec.h:3990
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:647
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1020
int avio_feof(AVIOContext *s)
feof() equivalent for AVIOContext.
Definition: aviobuf.c:358
#define RoQ_QUAD_CODEBOOK
Definition: idroqdec.c:42
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3888
int stream_index
Definition: avcodec.h:1432
#define AV_CH_LAYOUT_MONO
AVInputFormat ff_roq_demuxer
Definition: idroqdec.c:242
This structure stores compressed data.
Definition: avcodec.h:1407
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1423
static int roq_read_header(AVFormatContext *s)
Definition: idroqdec.c:71
#define RoQ_QUAD_VQ
Definition: idroqdec.c:43