FFmpeg
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 
30 #include "libavutil/attributes.h"
31 #include "libavutil/channel_layout.h"
32 #include "libavutil/intreadwrite.h"
33 #include "avformat.h"
34 #include "demux.h"
35 #include "internal.h"
36 #include "avio_internal.h"
37 
38 #define RoQ_MAGIC_NUMBER 0x1084
39 #define RoQ_CHUNK_PREAMBLE_SIZE 8
40 #define RoQ_AUDIO_SAMPLE_RATE 22050
41 #define RoQ_CHUNKS_TO_SCAN 30
42 
43 #define RoQ_INFO 0x1001
44 #define RoQ_QUAD_CODEBOOK 0x1002
45 #define RoQ_QUAD_VQ 0x1011
46 #define RoQ_SOUND_MONO 0x1020
47 #define RoQ_SOUND_STEREO 0x1021
48 
49 typedef struct RoqDemuxContext {
50 
51  int frame_rate;
52  int width;
53  int height;
54  int audio_channels;
55 
56  int video_stream_index;
57  int audio_stream_index;
58 
59  int64_t video_pts;
60  unsigned int audio_frame_count;
61 
62 } RoqDemuxContext;
63 
64 static int roq_probe(const AVProbeData *p)
65 {
66  if ((AV_RL16(&p->buf[0]) != RoQ_MAGIC_NUMBER) ||
67  (AV_RL32(&p->buf[2]) != 0xFFFFFFFF))
68  return 0;
69 
70  return AVPROBE_SCORE_MAX;
71 }
72 
73 static int roq_read_header(AVFormatContext *s)
74 {
75  RoqDemuxContext *roq = s->priv_data;
76  AVIOContext *pb = s->pb;
77  unsigned char preamble[RoQ_CHUNK_PREAMBLE_SIZE];
78  int ret;
79 
80  /* get the main header */
81  if ((ret = ffio_read_size(pb, preamble, RoQ_CHUNK_PREAMBLE_SIZE)) < 0)
82  return ret;
83  roq->frame_rate = AV_RL16(&preamble[6]);
84 
85  /* init private context parameters */
86  roq->width = roq->height = roq->audio_channels = roq->video_pts =
87  roq->audio_frame_count = 0;
88  roq->audio_stream_index = -1;
89  roq->video_stream_index = -1;
90 
91  s->ctx_flags |= AVFMTCTX_NOHEADER;
92 
93  return 0;
94 }
95 
96 static int roq_read_packet(AVFormatContext *s,
97  AVPacket *pkt)
98 {
99  RoqDemuxContext *roq = s->priv_data;
100  AVIOContext *pb = s->pb;
101  int ret = 0;
102  unsigned int chunk_size;
103  unsigned int chunk_type;
104  unsigned int codebook_size;
105  unsigned char preamble[RoQ_CHUNK_PREAMBLE_SIZE];
106  int packet_read = 0;
107  int64_t codebook_offset;
108 
109  while (!packet_read) {
110 
111  if (avio_feof(s->pb))
112  return AVERROR_EOF;
113 
114  /* get the next chunk preamble */
115  if ((ret = ffio_read_size(pb, preamble, RoQ_CHUNK_PREAMBLE_SIZE)) < 0)
116  return ret;
117 
118  chunk_type = AV_RL16(&preamble[0]);
119  chunk_size = AV_RL32(&preamble[2]);
120  if(chunk_size > INT_MAX)
121  return AVERROR_INVALIDDATA;
122 
123  chunk_size = ffio_limit(pb, chunk_size);
124 
125  switch (chunk_type) {
126 
127  case RoQ_INFO:
128  if (roq->video_stream_index == -1) {
129  AVStream *st = avformat_new_stream(s, NULL);
130  if (!st)
131  return AVERROR(ENOMEM);
132  avpriv_set_pts_info(st, 63, 1, roq->frame_rate);
133  roq->video_stream_index = st->index;
134  st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
135  st->codecpar->codec_id = AV_CODEC_ID_ROQ;
136  st->codecpar->codec_tag = 0; /* no fourcc */
137 
138  if ((ret = ffio_read_size(pb, preamble, RoQ_CHUNK_PREAMBLE_SIZE)) < 0)
139  return ret;
140  st->codecpar->width = roq->width = AV_RL16(preamble);
141  st->codecpar->height = roq->height = AV_RL16(preamble + 2);
142  break;
143  }
144  /* don't care about this chunk anymore */
145  avio_skip(pb, RoQ_CHUNK_PREAMBLE_SIZE);
146  break;
147 
148  case RoQ_QUAD_CODEBOOK:
149  if (roq->video_stream_index < 0)
150  return AVERROR_INVALIDDATA;
151  /* packet needs to contain both this codebook and next VQ chunk */
152  codebook_offset = avio_tell(pb) - RoQ_CHUNK_PREAMBLE_SIZE;
153  codebook_size = chunk_size;
154  avio_skip(pb, codebook_size);
155  if ((ret = ffio_read_size(pb, preamble, RoQ_CHUNK_PREAMBLE_SIZE)) < 0)
156  return ret;
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_INVALIDDATA;
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) {
179  AVStream *st = avformat_new_stream(s, NULL);
180  if (!st)
181  return AVERROR(ENOMEM);
182  avpriv_set_pts_info(st, 32, 1, RoQ_AUDIO_SAMPLE_RATE);
183  roq->audio_stream_index = st->index;
184  st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
185  st->codecpar->codec_id = AV_CODEC_ID_ROQ_DPCM;
186  st->codecpar->codec_tag = 0; /* no tag */
187  if (chunk_type == RoQ_SOUND_STEREO) {
188  st->codecpar->ch_layout = (AVChannelLayout)AV_CHANNEL_LAYOUT_STEREO;
189  } else {
190  st->codecpar->ch_layout = (AVChannelLayout)AV_CHANNEL_LAYOUT_MONO;
191  }
192  roq->audio_channels = st->codecpar->ch_layout.nb_channels;
193  st->codecpar->sample_rate = RoQ_AUDIO_SAMPLE_RATE;
194  st->codecpar->bits_per_coded_sample = 16;
195  st->codecpar->bit_rate = roq->audio_channels * st->codecpar->sample_rate *
196  st->codecpar->bits_per_coded_sample;
197  st->codecpar->block_align = roq->audio_channels * st->codecpar->bits_per_coded_sample;
198  }
199  av_fallthrough;
200  case RoQ_QUAD_VQ:
201  if (chunk_type == RoQ_QUAD_VQ) {
202  if (roq->video_stream_index < 0)
203  return AVERROR_INVALIDDATA;
204  }
205 
206  /* load up the packet */
207  ret = av_new_packet(pkt, chunk_size + RoQ_CHUNK_PREAMBLE_SIZE);
208  if (ret < 0)
209  return ret;
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 = ffio_read_size(pb, pkt->data + RoQ_CHUNK_PREAMBLE_SIZE,
224  chunk_size);
225  if (ret < 0)
226  return ret;
227 
228  packet_read = 1;
229  break;
230 
231  default:
232  av_log(s, AV_LOG_ERROR, " unknown RoQ chunk (%04X)\n", chunk_type);
233  return AVERROR_INVALIDDATA;
234  }
235  }
236 
237  return ret;
238 }
239 
240 const FFInputFormat ff_roq_demuxer = {
241  .p.name = "roq",
242  .p.long_name = NULL_IF_CONFIG_SMALL("id RoQ"),
243  .priv_data_size = sizeof(RoqDemuxContext),
244  .read_probe = roq_probe,
245  .read_header = roq_read_header,
246  .read_packet = roq_read_packet,
247 };
RoqDemuxContext::audio_channels
int audio_channels
Definition: idroqdec.c:54
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:53
AV_CHANNEL_LAYOUT_STEREO
#define AV_CHANNEL_LAYOUT_STEREO
Definition: channel_layout.h:395
RoqDemuxContext::width
int width
Definition: idroqdec.c:52
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const struct AVCodec *c)
Add a new stream to a media file.
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
int64_t
long long int64_t
Definition: coverity.c:34
AVPacket::data
uint8_t * data
Definition: packet.h:595
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:61
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:329
RoqDemuxContext
Definition: idroqdec.c:49
ff_roq_demuxer
const FFInputFormat ff_roq_demuxer
Definition: idroqdec.c:240
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:463
avpriv_set_pts_info
void avpriv_set_pts_info(AVStream *st, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: avformat.c:895
RoQ_MAGIC_NUMBER
#define RoQ_MAGIC_NUMBER
Definition: idroqdec.c:38
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:494
RoqDemuxContext::audio_stream_index
int audio_stream_index
Definition: idroqdec.c:57
RoQ_INFO
#define RoQ_INFO
Definition: idroqdec.c:43
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:210
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_read_callback.c:42
roq_read_packet
static int roq_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: idroqdec.c:96
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
av_new_packet
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: packet.c:98
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:549
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:201
AVCodecParameters::width
int width
The width of the video frame in pixels.
Definition: codec_par.h:143
RoqDemuxContext::height
int height
Definition: idroqdec.c:53
AV_RL16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:94
av_fallthrough
#define av_fallthrough
Definition: attributes.h:67
AVFormatContext
Format I/O context.
Definition: avformat.h:1263
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:767
NULL
#define NULL
Definition: coverity.c:32
AVFMTCTX_NOHEADER
#define AVFMTCTX_NOHEADER
signal that no header is present (streams are added dynamically)
Definition: avformat.h:1214
RoqDemuxContext::video_pts
int64_t video_pts
Definition: idroqdec.c:59
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:451
AV_CODEC_ID_ROQ_DPCM
@ AV_CODEC_ID_ROQ_DPCM
Definition: codec_id.h:449
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
The channel layout and number of channels.
Definition: codec_par.h:207
AVCodecParameters::sample_rate
int sample_rate
The number of audio samples per second.
Definition: codec_par.h:213
RoQ_QUAD_CODEBOOK
#define RoQ_QUAD_CODEBOOK
Definition: idroqdec.c:44
AVIOContext
Bytestream IO Context.
Definition: avio.h:160
AV_CODEC_ID_ROQ
@ AV_CODEC_ID_ROQ
Definition: codec_id.h:90
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:319
FFInputFormat::p
AVInputFormat p
The public AVInputFormat.
Definition: demux.h:70
attributes.h
read_header
static int read_header(FFV1Context *f, RangeCoder *c)
Definition: ffv1dec.c:501
ffio_limit
int ffio_limit(AVIOContext *s, int size)
Definition: aviobuf.c:1064
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:588
avio_internal.h
AVCodecParameters::height
int height
The height of the video frame in pixels.
Definition: codec_par.h:150
AVCodecParameters::block_align
int block_align
The number of bytes per coded audio frame, required by some formats.
Definition: codec_par.h:221
demux.h
roq_read_header
static int roq_read_header(AVFormatContext *s)
Definition: idroqdec.c:73
av_get_packet
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:98
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:744
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:236
avformat.h
roq_probe
static int roq_probe(const AVProbeData *p)
Definition: idroqdec.c:64
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
AVStream::index
int index
stream index in AVFormatContext
Definition: avformat.h:750
channel_layout.h
RoqDemuxContext::frame_rate
int frame_rate
Definition: idroqdec.c:51
RoQ_CHUNK_PREAMBLE_SIZE
#define RoQ_CHUNK_PREAMBLE_SIZE
Definition: idroqdec.c:39
Windows::Graphics::DirectX::Direct3D11::p
IDirect3DDxgiInterfaceAccess _COM_Outptr_ void ** p
Definition: vsrc_gfxcapture_winrt.hpp:53
AVPacket::stream_index
int stream_index
Definition: packet.h:597
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:321
RoQ_QUAD_VQ
#define RoQ_QUAD_VQ
Definition: idroqdec.c:45
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:200
read_probe
static int read_probe(const AVProbeData *p)
Definition: cdg.c:30
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:113
AV_CHANNEL_LAYOUT_MONO
#define AV_CHANNEL_LAYOUT_MONO
Definition: channel_layout.h:394
RoQ_SOUND_STEREO
#define RoQ_SOUND_STEREO
Definition: idroqdec.c:47
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:57
AVPacket
This structure stores compressed data.
Definition: packet.h:572
RoqDemuxContext::video_stream_index
int video_stream_index
Definition: idroqdec.c:56
AVPacket::pos
int64_t pos
byte position in stream, -1 if unknown
Definition: packet.h:615
FFInputFormat
Definition: demux.h:66
RoQ_SOUND_MONO
#define RoQ_SOUND_MONO
Definition: idroqdec.c:46
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:99
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
ffio_read_size
int ffio_read_size(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:665
pkt
static AVPacket * pkt
Definition: demux_decode.c:55
RoQ_AUDIO_SAMPLE_RATE
#define RoQ_AUDIO_SAMPLE_RATE
Definition: idroqdec.c:40
RoqDemuxContext::audio_frame_count
unsigned int audio_frame_count
Definition: idroqdec.c:60
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:349
Generated on Tue May 5 2026 19:23:29 for FFmpeg by   doxygen 1.8.17