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