FFmpeg
bethsoftvid.c
Go to the documentation of this file.
1 /*
2  * Bethsoft VID format Demuxer
3  * Copyright (c) 2007 Nicholas Tung
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  * @brief Bethesda Softworks VID (.vid) file demuxer
25  * @author Nicholas Tung [ntung (at. ntung com] (2007-03)
26  * @see http://wiki.multimedia.cx/index.php?title=Bethsoft_VID
27  * @see http://www.svatopluk.com/andux/docs/dfvid.html
28  */
29 
30 #include "libavutil/attributes.h"
31 #include "libavutil/channel_layout.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/intreadwrite.h"
34 #include "libavutil/mem.h"
35 #include "avformat.h"
36 #include "avio_internal.h"
37 #include "demux.h"
38 #include "internal.h"
39 #include "libavcodec/bethsoftvideo.h"
40 
41 #define BVID_PALETTE_SIZE 3 * 256
42 
43 #define DEFAULT_SAMPLE_RATE 11111
44 
45 typedef struct BVID_DemuxContext
46 {
47  int nframes;
48  int sample_rate; /**< audio sample rate */
49  int width; /**< video width */
50  int height; /**< video height */
51  /** delay value between frames, added to individual frame delay.
52  * custom units, which will be added to other custom units (~=16ms according
53  * to free, unofficial documentation) */
54  int bethsoft_global_delay;
55  int video_index; /**< video stream index */
56  int audio_index; /**< audio stream index */
57  int has_palette;
58  uint8_t palette[BVID_PALETTE_SIZE];
59 
60  int is_finished;
61 
62 } BVID_DemuxContext;
63 
64 static int vid_probe(const AVProbeData *p)
65 {
66  // little-endian VID tag, file starts with "VID\0"
67  if (AV_RL32(p->buf) != MKTAG('V', 'I', 'D', 0))
68  return 0;
69 
70  if (p->buf[4] != 2)
71  return AVPROBE_SCORE_MAX / 4;
72 
73  return AVPROBE_SCORE_MAX;
74 }
75 
76 static int vid_read_header(AVFormatContext *s)
77 {
78  BVID_DemuxContext *vid = s->priv_data;
79  AVIOContext *pb = s->pb;
80  int ret;
81 
82  /* load main header. Contents:
83  * bytes: 'V' 'I' 'D'
84  * int16s: always_512, nframes, width, height, delay, always_14
85  */
86  avio_skip(pb, 5);
87  vid->nframes = avio_rl16(pb);
88  vid->width = avio_rl16(pb);
89  vid->height = avio_rl16(pb);
90  vid->bethsoft_global_delay = avio_rl16(pb);
91  avio_rl16(pb);
92 
93  ret = av_image_check_size(vid->width, vid->height, 0, s);
94  if (ret < 0)
95  return ret;
96 
97  // wait until the first packet to create each stream
98  vid->video_index = -1;
99  vid->audio_index = -1;
100  vid->sample_rate = DEFAULT_SAMPLE_RATE;
101  s->ctx_flags |= AVFMTCTX_NOHEADER;
102 
103  return 0;
104 }
105 
106 #define BUFFER_PADDING_SIZE 1000
107 static int read_frame(BVID_DemuxContext *vid, AVIOContext *pb, AVPacket *pkt,
108  uint8_t block_type, AVFormatContext *s)
109 {
110  uint8_t * vidbuf_start = NULL;
111  int vidbuf_nbytes = 0;
112  int code;
113  int bytes_copied = 0;
114  int position, duration, npixels;
115  unsigned int vidbuf_capacity;
116  int ret = 0;
117  AVStream *st;
118 
119  if (vid->video_index < 0) {
120  st = avformat_new_stream(s, NULL);
121  if (!st)
122  return AVERROR(ENOMEM);
123  vid->video_index = st->index;
124  if (vid->audio_index < 0) {
125  avpriv_request_sample(s, "Using default video time base since "
126  "having no audio packet before the first "
127  "video packet");
128  }
129  avpriv_set_pts_info(st, 64, 185, vid->sample_rate);
130  st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
131  st->codecpar->codec_id = AV_CODEC_ID_BETHSOFTVID;
132  st->codecpar->width = vid->width;
133  st->codecpar->height = vid->height;
134  }
135  st = s->streams[vid->video_index];
136  npixels = st->codecpar->width * st->codecpar->height;
137 
138  vidbuf_start = av_malloc(vidbuf_capacity = BUFFER_PADDING_SIZE);
139  if(!vidbuf_start)
140  return AVERROR(ENOMEM);
141 
142  // save the file position for the packet, include block type
143  position = avio_tell(pb) - 1;
144 
145  vidbuf_start[vidbuf_nbytes++] = block_type;
146 
147  // get the current packet duration
148  duration = vid->bethsoft_global_delay + avio_rl16(pb);
149 
150  // set the y offset if it exists (decoder header data should be in data section)
151  if(block_type == VIDEO_YOFF_P_FRAME){
152  ret = ffio_read_size(pb, &vidbuf_start[vidbuf_nbytes], 2);
153  if (ret < 0)
154  goto fail;
155  vidbuf_nbytes += 2;
156  }
157 
158  do{
159  uint8_t *tmp = av_fast_realloc(vidbuf_start, &vidbuf_capacity,
160  vidbuf_nbytes + BUFFER_PADDING_SIZE);
161  if (!tmp) {
162  ret = AVERROR(ENOMEM);
163  goto fail;
164  }
165  vidbuf_start = tmp;
166 
167  code = avio_r8(pb);
168  vidbuf_start[vidbuf_nbytes++] = code;
169 
170  if(code >= 0x80){ // rle sequence
171  if(block_type == VIDEO_I_FRAME)
172  vidbuf_start[vidbuf_nbytes++] = avio_r8(pb);
173  } else if(code){ // plain sequence
174  ret = ffio_read_size(pb, &vidbuf_start[vidbuf_nbytes], code);
175  if (ret < 0)
176  goto fail;
177  vidbuf_nbytes += code;
178  }
179  bytes_copied += code & 0x7F;
180  if(bytes_copied == npixels){ // sometimes no stop character is given, need to keep track of bytes copied
181  // may contain a 0 byte even if read all pixels
182  if(avio_r8(pb))
183  avio_seek(pb, -1, SEEK_CUR);
184  break;
185  }
186  if (bytes_copied > npixels) {
187  ret = AVERROR_INVALIDDATA;
188  goto fail;
189  }
190  } while(code);
191 
192  // copy data into packet
193  if ((ret = av_new_packet(pkt, vidbuf_nbytes)) < 0)
194  goto fail;
195  memcpy(pkt->data, vidbuf_start, vidbuf_nbytes);
196 
197  pkt->pos = position;
198  pkt->stream_index = vid->video_index;
199  pkt->duration = duration;
200  if (block_type == VIDEO_I_FRAME)
201  pkt->flags |= AV_PKT_FLAG_KEY;
202 
203  /* if there is a new palette available, add it to packet side data */
204  if (vid->has_palette) {
205  uint8_t *pdata = av_packet_new_side_data(pkt, AV_PKT_DATA_PALETTE,
206  BVID_PALETTE_SIZE);
207  if (!pdata) {
208  ret = AVERROR(ENOMEM);
209  av_log(s, AV_LOG_ERROR, "Failed to allocate palette side data\n");
210  goto fail;
211  }
212  memcpy(pdata, vid->palette, BVID_PALETTE_SIZE);
213  vid->has_palette = 0;
214  }
215 
216  vid->nframes--; // used to check if all the frames were read
217 fail:
218  av_free(vidbuf_start);
219  return ret;
220 }
221 
222 static int vid_read_packet(AVFormatContext *s,
223  AVPacket *pkt)
224 {
225  BVID_DemuxContext *vid = s->priv_data;
226  AVIOContext *pb = s->pb;
227  unsigned char block_type;
228  int audio_length;
229  int ret_value;
230 
231  if(vid->is_finished || avio_feof(pb))
232  return AVERROR_EOF;
233 
234  block_type = avio_r8(pb);
235  switch(block_type){
236  case PALETTE_BLOCK:
237  if (vid->has_palette) {
238  av_log(s, AV_LOG_WARNING, "discarding unused palette\n");
239  vid->has_palette = 0;
240  }
241  ret_value = ffio_read_size(pb, vid->palette, BVID_PALETTE_SIZE);
242  if (ret_value < 0)
243  return ret_value;
244  vid->has_palette = 1;
245  return vid_read_packet(s, pkt);
246 
247  case FIRST_AUDIO_BLOCK:
248  avio_rl16(pb);
249  // soundblaster DAC used for sample rate, as on specification page (link above)
250  vid->sample_rate = 1000000 / (256 - avio_r8(pb));
251  av_fallthrough;
252  case AUDIO_BLOCK:
253  if (vid->audio_index < 0) {
254  AVStream *st = avformat_new_stream(s, NULL);
255  if (!st)
256  return AVERROR(ENOMEM);
257  vid->audio_index = st->index;
258  st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
259  st->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
260  st->codecpar->ch_layout = (AVChannelLayout)AV_CHANNEL_LAYOUT_MONO;
261  st->codecpar->bits_per_coded_sample = 8;
262  st->codecpar->sample_rate = vid->sample_rate;
263  st->codecpar->bit_rate = 8 * st->codecpar->sample_rate;
264  st->start_time = 0;
265  avpriv_set_pts_info(st, 64, 1, vid->sample_rate);
266  }
267  audio_length = avio_rl16(pb);
268  if ((ret_value = av_get_packet(pb, pkt, audio_length)) != audio_length) {
269  if (ret_value < 0)
270  return ret_value;
271  av_log(s, AV_LOG_ERROR, "incomplete audio block\n");
272  return AVERROR_INVALIDDATA;
273  }
274  pkt->stream_index = vid->audio_index;
275  pkt->duration = audio_length;
276  pkt->flags |= AV_PKT_FLAG_KEY;
277  return 0;
278 
279  case VIDEO_P_FRAME:
280  case VIDEO_YOFF_P_FRAME:
281  case VIDEO_I_FRAME:
282  return read_frame(vid, pb, pkt, block_type, s);
283 
284  case EOF_BLOCK:
285  if(vid->nframes != 0)
286  av_log(s, AV_LOG_VERBOSE, "reached terminating character but not all frames read.\n");
287  vid->is_finished = 1;
288  return AVERROR_INVALIDDATA;
289  default:
290  av_log(s, AV_LOG_ERROR, "unknown block (character = %c, decimal = %d, hex = %x)!!!\n",
291  block_type, block_type, block_type);
292  return AVERROR_INVALIDDATA;
293  }
294 }
295 
296 const FFInputFormat ff_bethsoftvid_demuxer = {
297  .p.name = "bethsoftvid",
298  .p.long_name = NULL_IF_CONFIG_SMALL("Bethesda Softworks VID"),
299  .priv_data_size = sizeof(BVID_DemuxContext),
300  .read_probe = vid_probe,
301  .read_header = vid_read_header,
302  .read_packet = vid_read_packet,
303 };
VIDEO_I_FRAME
@ VIDEO_I_FRAME
Definition: bethsoftvideo.h:30
BVID_DemuxContext::has_palette
int has_palette
Definition: bethsoftvid.c:57
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:216
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
FIRST_AUDIO_BLOCK
@ FIRST_AUDIO_BLOCK
Definition: bethsoftvideo.h:28
vid_read_header
static int vid_read_header(AVFormatContext *s)
Definition: bethsoftvid.c:76
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
AVPacket::data
uint8_t * data
Definition: packet.h:595
ff_bethsoftvid_demuxer
const FFInputFormat ff_bethsoftvid_demuxer
Definition: bethsoftvid.c:296
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:226
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:613
BUFFER_PADDING_SIZE
#define BUFFER_PADDING_SIZE
Definition: bethsoftvid.c:106
AV_PKT_FLAG_KEY
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:650
BVID_DemuxContext::width
int width
video width
Definition: bethsoftvid.c:49
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
DEFAULT_SAMPLE_RATE
#define DEFAULT_SAMPLE_RATE
Definition: bethsoftvid.c:43
AV_PKT_DATA_PALETTE
@ AV_PKT_DATA_PALETTE
An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE bytes worth of palette.
Definition: packet.h:47
BVID_DemuxContext::is_finished
int is_finished
Definition: bethsoftvid.c:60
fail
#define fail()
Definition: checkasm.h:224
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:494
avio_rl16
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:717
PALETTE_BLOCK
@ PALETTE_BLOCK
Definition: bethsoftvideo.h:27
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
av_fast_realloc
void * av_fast_realloc(void *ptr, unsigned int *size, size_t min_size)
Reallocate the given buffer if it is not large enough, otherwise do nothing.
Definition: mem.c:497
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
BVID_DemuxContext::bethsoft_global_delay
int bethsoft_global_delay
delay value between frames, added to individual frame delay.
Definition: bethsoftvid.c:54
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
BVID_DemuxContext::nframes
int nframes
Definition: bethsoftvid.c:47
av_fallthrough
#define av_fallthrough
Definition: attributes.h:67
tmp
static uint8_t tmp[40]
Definition: aes_ctr.c:52
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
VIDEO_YOFF_P_FRAME
@ VIDEO_YOFF_P_FRAME
Definition: bethsoftvideo.h:32
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
BVID_DemuxContext::audio_index
int audio_index
audio stream index
Definition: bethsoftvid.c:56
AUDIO_BLOCK
@ AUDIO_BLOCK
Definition: bethsoftvideo.h:29
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:451
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
The channel layout and number of channels.
Definition: codec_par.h:207
vid_probe
static int vid_probe(const AVProbeData *p)
Definition: bethsoftvid.c:64
AVCodecParameters::sample_rate
int sample_rate
The number of audio samples per second.
Definition: codec_par.h:213
AVIOContext
Bytestream IO Context.
Definition: avio.h:160
BVID_DemuxContext
Definition: bethsoftvid.c:45
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
vid_read_packet
static int vid_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: bethsoftvid.c:222
FFInputFormat::p
AVInputFormat p
The public AVInputFormat.
Definition: demux.h:70
avio_r8
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:606
attributes.h
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:601
read_header
static int read_header(FFV1Context *f, RangeCoder *c)
Definition: ffv1dec.c:501
BVID_DemuxContext::height
int height
video height
Definition: bethsoftvid.c:50
BVID_DemuxContext::video_index
int video_index
video stream index
Definition: bethsoftvid.c:55
av_malloc
#define av_malloc(s)
Definition: ops_asmgen.c:44
code
and forward the test the status of outputs and forward it to the corresponding return FFERROR_NOT_READY If the filters stores internally one or a few frame for some it can consider them to be part of the FIFO and delay acknowledging a status change accordingly Example code
Definition: filter_design.txt:178
avio_internal.h
AVCodecParameters::height
int height
The height of the video frame in pixels.
Definition: codec_par.h:150
BVID_DemuxContext::palette
uint8_t palette[BVID_PALETTE_SIZE]
Definition: bethsoftvid.c:58
demux.h
AV_CODEC_ID_BETHSOFTVID
@ AV_CODEC_ID_BETHSOFTVID
Definition: codec_id.h:155
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
EOF_BLOCK
@ EOF_BLOCK
Definition: bethsoftvideo.h:33
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
BVID_PALETTE_SIZE
#define BVID_PALETTE_SIZE
Definition: bethsoftvid.c:41
bethsoftvideo.h
channel_layout.h
av_packet_new_side_data
uint8_t * av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, size_t size)
Allocate new information of a packet.
Definition: packet.c:231
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
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
mem.h
AV_CODEC_ID_PCM_U8
@ AV_CODEC_ID_PCM_U8
Definition: codec_id.h:343
avpriv_request_sample
#define avpriv_request_sample(...)
Definition: tableprint_vlc.h:37
AV_CHANNEL_LAYOUT_MONO
#define AV_CHANNEL_LAYOUT_MONO
Definition: channel_layout.h:394
av_free
#define av_free(p)
Definition: tableprint_vlc.h:34
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
AVPacket::pos
int64_t pos
byte position in stream, -1 if unknown
Definition: packet.h:615
BVID_DemuxContext::sample_rate
int sample_rate
audio sample rate
Definition: bethsoftvid.c:48
FFInputFormat
Definition: demux.h:66
imgutils.h
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
MKTAG
#define MKTAG(a, b, c, d)
Definition: macros.h:55
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
AVStream::start_time
int64_t start_time
Decoding: pts of the first frame of the stream in presentation order, in stream time base.
Definition: avformat.h:793
pkt
static AVPacket * pkt
Definition: demux_decode.c:55
av_image_check_size
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:318
VIDEO_P_FRAME
@ VIDEO_P_FRAME
Definition: bethsoftvideo.h:31
read_frame
static int read_frame(BVID_DemuxContext *vid, AVIOContext *pb, AVPacket *pkt, uint8_t block_type, AVFormatContext *s)
Definition: bethsoftvid.c:107
duration
static int64_t duration
Definition: ffplay.c:329
avio_feof
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:349
Generated on Sun May 10 2026 19:23:24 for FFmpeg by   doxygen 1.8.17