FFmpeg  4.3
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 
31 #include "libavutil/intreadwrite.h"
32 #include "avformat.h"
33 #include "internal.h"
35 
36 #define BVID_PALETTE_SIZE 3 * 256
37 
38 #define DEFAULT_SAMPLE_RATE 11111
39 
40 typedef struct BVID_DemuxContext
41 {
42  int nframes;
43  int sample_rate; /**< audio sample rate */
44  int width; /**< video width */
45  int height; /**< video height */
46  /** delay value between frames, added to individual frame delay.
47  * custom units, which will be added to other custom units (~=16ms according
48  * to free, unofficial documentation) */
50  int video_index; /**< video stream index */
51  int audio_index; /**< audio stream index */
54 
56 
58 
59 static int vid_probe(const AVProbeData *p)
60 {
61  // little-endian VID tag, file starts with "VID\0"
62  if (AV_RL32(p->buf) != MKTAG('V', 'I', 'D', 0))
63  return 0;
64 
65  if (p->buf[4] != 2)
66  return AVPROBE_SCORE_MAX / 4;
67 
68  return AVPROBE_SCORE_MAX;
69 }
70 
72 {
73  BVID_DemuxContext *vid = s->priv_data;
74  AVIOContext *pb = s->pb;
75 
76  /* load main header. Contents:
77  * bytes: 'V' 'I' 'D'
78  * int16s: always_512, nframes, width, height, delay, always_14
79  */
80  avio_skip(pb, 5);
81  vid->nframes = avio_rl16(pb);
82  vid->width = avio_rl16(pb);
83  vid->height = avio_rl16(pb);
85  avio_rl16(pb);
86 
87  // wait until the first packet to create each stream
88  vid->video_index = -1;
89  vid->audio_index = -1;
92 
93  return 0;
94 }
95 
96 #define BUFFER_PADDING_SIZE 1000
98  uint8_t block_type, AVFormatContext *s)
99 {
100  uint8_t * vidbuf_start = NULL;
101  int vidbuf_nbytes = 0;
102  int code;
103  int bytes_copied = 0;
104  int position, duration, npixels;
105  unsigned int vidbuf_capacity;
106  int ret = 0;
107  AVStream *st;
108 
109  if (vid->video_index < 0) {
110  st = avformat_new_stream(s, NULL);
111  if (!st)
112  return AVERROR(ENOMEM);
113  vid->video_index = st->index;
114  if (vid->audio_index < 0) {
115  avpriv_request_sample(s, "Using default video time base since "
116  "having no audio packet before the first "
117  "video packet");
118  }
119  avpriv_set_pts_info(st, 64, 185, vid->sample_rate);
122  st->codecpar->width = vid->width;
123  st->codecpar->height = vid->height;
124  }
125  st = s->streams[vid->video_index];
126  npixels = st->codecpar->width * st->codecpar->height;
127 
128  vidbuf_start = av_malloc(vidbuf_capacity = BUFFER_PADDING_SIZE);
129  if(!vidbuf_start)
130  return AVERROR(ENOMEM);
131 
132  // save the file position for the packet, include block type
133  position = avio_tell(pb) - 1;
134 
135  vidbuf_start[vidbuf_nbytes++] = block_type;
136 
137  // get the current packet duration
138  duration = vid->bethsoft_global_delay + avio_rl16(pb);
139 
140  // set the y offset if it exists (decoder header data should be in data section)
141  if(block_type == VIDEO_YOFF_P_FRAME){
142  if (avio_read(pb, &vidbuf_start[vidbuf_nbytes], 2) != 2) {
143  ret = AVERROR(EIO);
144  goto fail;
145  }
146  vidbuf_nbytes += 2;
147  }
148 
149  do{
150  uint8_t *tmp = av_fast_realloc(vidbuf_start, &vidbuf_capacity,
151  vidbuf_nbytes + BUFFER_PADDING_SIZE);
152  if (!tmp) {
153  ret = AVERROR(ENOMEM);
154  goto fail;
155  }
156  vidbuf_start = tmp;
157 
158  code = avio_r8(pb);
159  vidbuf_start[vidbuf_nbytes++] = code;
160 
161  if(code >= 0x80){ // rle sequence
162  if(block_type == VIDEO_I_FRAME)
163  vidbuf_start[vidbuf_nbytes++] = avio_r8(pb);
164  } else if(code){ // plain sequence
165  if (avio_read(pb, &vidbuf_start[vidbuf_nbytes], code) != code) {
166  ret = AVERROR(EIO);
167  goto fail;
168  }
169  vidbuf_nbytes += code;
170  }
171  bytes_copied += code & 0x7F;
172  if(bytes_copied == npixels){ // sometimes no stop character is given, need to keep track of bytes copied
173  // may contain a 0 byte even if read all pixels
174  if(avio_r8(pb))
175  avio_seek(pb, -1, SEEK_CUR);
176  break;
177  }
178  if (bytes_copied > npixels) {
179  ret = AVERROR_INVALIDDATA;
180  goto fail;
181  }
182  } while(code);
183 
184  // copy data into packet
185  if ((ret = av_new_packet(pkt, vidbuf_nbytes)) < 0)
186  goto fail;
187  memcpy(pkt->data, vidbuf_start, vidbuf_nbytes);
188 
189  pkt->pos = position;
190  pkt->stream_index = vid->video_index;
191  pkt->duration = duration;
192  if (block_type == VIDEO_I_FRAME)
193  pkt->flags |= AV_PKT_FLAG_KEY;
194 
195  /* if there is a new palette available, add it to packet side data */
196  if (vid->has_palette) {
199  if (!pdata) {
200  ret = AVERROR(ENOMEM);
201  av_log(s, AV_LOG_ERROR, "Failed to allocate palette side data\n");
202  goto fail;
203  }
204  memcpy(pdata, vid->palette, BVID_PALETTE_SIZE);
205  vid->has_palette = 0;
206  }
207 
208  vid->nframes--; // used to check if all the frames were read
209 fail:
210  av_free(vidbuf_start);
211  return ret;
212 }
213 
215  AVPacket *pkt)
216 {
217  BVID_DemuxContext *vid = s->priv_data;
218  AVIOContext *pb = s->pb;
219  unsigned char block_type;
220  int audio_length;
221  int ret_value;
222 
223  if(vid->is_finished || avio_feof(pb))
224  return AVERROR_EOF;
225 
226  block_type = avio_r8(pb);
227  switch(block_type){
228  case PALETTE_BLOCK:
229  if (vid->has_palette) {
230  av_log(s, AV_LOG_WARNING, "discarding unused palette\n");
231  vid->has_palette = 0;
232  }
234  return AVERROR(EIO);
235  }
236  vid->has_palette = 1;
237  return vid_read_packet(s, pkt);
238 
239  case FIRST_AUDIO_BLOCK:
240  avio_rl16(pb);
241  // soundblaster DAC used for sample rate, as on specification page (link above)
242  vid->sample_rate = 1000000 / (256 - avio_r8(pb));
243  case AUDIO_BLOCK:
244  if (vid->audio_index < 0) {
246  if (!st)
247  return AVERROR(ENOMEM);
248  vid->audio_index = st->index;
251  st->codecpar->channels = 1;
254  st->codecpar->sample_rate = vid->sample_rate;
255  st->codecpar->bit_rate = 8 * st->codecpar->sample_rate;
256  st->start_time = 0;
257  avpriv_set_pts_info(st, 64, 1, vid->sample_rate);
258  }
259  audio_length = avio_rl16(pb);
260  if ((ret_value = av_get_packet(pb, pkt, audio_length)) != audio_length) {
261  if (ret_value < 0)
262  return ret_value;
263  av_log(s, AV_LOG_ERROR, "incomplete audio block\n");
264  return AVERROR(EIO);
265  }
266  pkt->stream_index = vid->audio_index;
267  pkt->duration = audio_length;
268  pkt->flags |= AV_PKT_FLAG_KEY;
269  return 0;
270 
271  case VIDEO_P_FRAME:
272  case VIDEO_YOFF_P_FRAME:
273  case VIDEO_I_FRAME:
274  return read_frame(vid, pb, pkt, block_type, s);
275 
276  case EOF_BLOCK:
277  if(vid->nframes != 0)
278  av_log(s, AV_LOG_VERBOSE, "reached terminating character but not all frames read.\n");
279  vid->is_finished = 1;
280  return AVERROR(EIO);
281  default:
282  av_log(s, AV_LOG_ERROR, "unknown block (character = %c, decimal = %d, hex = %x)!!!\n",
283  block_type, block_type, block_type);
284  return AVERROR_INVALIDDATA;
285  }
286 }
287 
289  .name = "bethsoftvid",
290  .long_name = NULL_IF_CONFIG_SMALL("Bethesda Softworks VID"),
291  .priv_data_size = sizeof(BVID_DemuxContext),
295 };
#define NULL
Definition: coverity.c:32
Bytestream IO Context.
Definition: avio.h:161
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
int bethsoft_global_delay
delay value between frames, added to individual frame delay.
Definition: bethsoftvid.c:49
static int vid_read_header(AVFormatContext *s)
Definition: bethsoftvid.c:71
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int64_t pos
byte position in stream, -1 if unknown
Definition: packet.h:375
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:4938
#define avpriv_request_sample(...)
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
int index
stream index in AVFormatContext
Definition: avformat.h:877
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:241
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:329
static AVPacket pkt
int ctx_flags
Flags signalling stream properties.
Definition: avformat.h:1400
Format I/O context.
Definition: avformat.h:1351
int sample_rate
audio sample rate
Definition: bethsoftvid.c:43
uint8_t
#define av_malloc(s)
int width
Video only.
Definition: codec_par.h:126
#define AVFMTCTX_NOHEADER
signal that no header is present (streams are added dynamically)
Definition: avformat.h:1295
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:373
#define BVID_PALETTE_SIZE
Definition: bethsoftvid.c:36
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4519
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1419
int64_t duration
Definition: movenc.c:63
uint8_t * data
Definition: packet.h:355
#define AVERROR_EOF
End of file.
Definition: error.h:55
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
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:304
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: codec_par.h:162
#define av_log(a,...)
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:625
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:89
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:388
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:88
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE bytes worth of palette...
Definition: packet.h:46
#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:186
const uint8_t * code
Definition: spdifenc.c:411
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:56
int height
video height
Definition: bethsoftvid.c:45
#define DEFAULT_SAMPLE_RATE
Definition: bethsoftvid.c:38
int video_index
video stream index
Definition: bethsoftvid.c:50
#define fail()
Definition: checkasm.h:123
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:361
#define BUFFER_PADDING_SIZE
Definition: bethsoftvid.c:96
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:616
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:443
AVInputFormat ff_bethsoftvid_demuxer
Definition: bethsoftvid.c:288
audio channel layout utility functions
#define s(width, name)
Definition: cbs_vp9.c:257
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:480
#define AV_RL32
Definition: intreadwrite.h:146
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:527
Stream structure.
Definition: avformat.h:876
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:1393
static int vid_probe(const AVProbeData *p)
Definition: bethsoftvid.c:59
int audio_index
audio stream index
Definition: bethsoftvid.c:51
This structure contains the data a format has to probe a file.
Definition: avformat.h:441
static int read_frame(BVID_DemuxContext *vid, AVIOContext *pb, AVPacket *pkt, uint8_t block_type, AVFormatContext *s)
Definition: bethsoftvid.c:97
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
int sample_rate
Audio only.
Definition: codec_par.h:170
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:453
unsigned int avio_rl16(AVIOContext *s)
Definition: aviobuf.c:731
Main libavformat public API header.
int64_t start_time
Decoding: pts of the first frame of the stream in presentation order, in stream time base...
Definition: avformat.h:915
uint8_t palette[BVID_PALETTE_SIZE]
Definition: bethsoftvid.c:53
#define av_free(p)
void * priv_data
Format private data.
Definition: avformat.h:1379
static int vid_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: bethsoftvid.c:214
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
int channels
Audio only.
Definition: codec_par.h:166
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:650
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1023
int avio_feof(AVIOContext *s)
Similar to feof() but also returns nonzero on read errors.
Definition: aviobuf.c:356
uint8_t * av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int size)
Allocate new information of a packet.
Definition: avpacket.c:332
int stream_index
Definition: packet.h:357
#define AV_CH_LAYOUT_MONO
#define MKTAG(a, b, c, d)
Definition: common.h:406
This structure stores compressed data.
Definition: packet.h:332
int width
video width
Definition: bethsoftvid.c:44
static uint8_t tmp[11]
Definition: aes_ctr.c:26