FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavformat/bethsoftvid.c
Date: 2024-04-26 14:42:52
Exec Total Coverage
Lines: 116 150 77.3%
Functions: 4 4 100.0%
Branches: 44 68 64.7%
Line Branch Exec Source
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/channel_layout.h"
31 #include "libavutil/imgutils.h"
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/mem.h"
34 #include "avformat.h"
35 #include "demux.h"
36 #include "internal.h"
37 #include "libavcodec/bethsoftvideo.h"
38
39 #define BVID_PALETTE_SIZE 3 * 256
40
41 #define DEFAULT_SAMPLE_RATE 11111
42
43 typedef struct BVID_DemuxContext
44 {
45 int nframes;
46 int sample_rate; /**< audio sample rate */
47 int width; /**< video width */
48 int height; /**< video height */
49 /** delay value between frames, added to individual frame delay.
50 * custom units, which will be added to other custom units (~=16ms according
51 * to free, unofficial documentation) */
52 int bethsoft_global_delay;
53 int video_index; /**< video stream index */
54 int audio_index; /**< audio stream index */
55 int has_palette;
56 uint8_t palette[BVID_PALETTE_SIZE];
57
58 int is_finished;
59
60 } BVID_DemuxContext;
61
62 7128 static int vid_probe(const AVProbeData *p)
63 {
64 // little-endian VID tag, file starts with "VID\0"
65
2/2
✓ Branch 0 taken 7127 times.
✓ Branch 1 taken 1 times.
 7128 if (AV_RL32(p->buf) != MKTAG('V', 'I', 'D', 0))
66 7127 return 0;
67
68
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 if (p->buf[4] != 2)
69 ✗ return AVPROBE_SCORE_MAX / 4;
70
71 1 return AVPROBE_SCORE_MAX;
72 }
73
74 1 static int vid_read_header(AVFormatContext *s)
75 {
76 1 BVID_DemuxContext *vid = s->priv_data;
77 1 AVIOContext *pb = s->pb;
78 int ret;
79
80 /* load main header. Contents:
81 * bytes: 'V' 'I' 'D'
82 * int16s: always_512, nframes, width, height, delay, always_14
83 */
84 1 avio_skip(pb, 5);
85 1 vid->nframes = avio_rl16(pb);
86 1 vid->width = avio_rl16(pb);
87 1 vid->height = avio_rl16(pb);
88 1 vid->bethsoft_global_delay = avio_rl16(pb);
89 1 avio_rl16(pb);
90
91 1 ret = av_image_check_size(vid->width, vid->height, 0, s);
92
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 if (ret < 0)
93 ✗ return ret;
94
95 // wait until the first packet to create each stream
96 1 vid->video_index = -1;
97 1 vid->audio_index = -1;
98 1 vid->sample_rate = DEFAULT_SAMPLE_RATE;
99 1 s->ctx_flags |= AVFMTCTX_NOHEADER;
100
101 1 return 0;
102 }
103
104 #define BUFFER_PADDING_SIZE 1000
105 81 static int read_frame(BVID_DemuxContext *vid, AVIOContext *pb, AVPacket *pkt,
106 uint8_t block_type, AVFormatContext *s)
107 {
108 81 uint8_t * vidbuf_start = NULL;
109 81 int vidbuf_nbytes = 0;
110 int code;
111 81 int bytes_copied = 0;
112 int position, duration, npixels;
113 unsigned int vidbuf_capacity;
114 81 int ret = 0;
115 AVStream *st;
116
117
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 80 times.
 81 if (vid->video_index < 0) {
118 1 st = avformat_new_stream(s, NULL);
119
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 if (!st)
120 ✗ return AVERROR(ENOMEM);
121 1 vid->video_index = st->index;
122
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 if (vid->audio_index < 0) {
123 ✗ avpriv_request_sample(s, "Using default video time base since "
124 "having no audio packet before the first "
125 "video packet");
126 }
127 1 avpriv_set_pts_info(st, 64, 185, vid->sample_rate);
128 1 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
129 1 st->codecpar->codec_id = AV_CODEC_ID_BETHSOFTVID;
130 1 st->codecpar->width = vid->width;
131 1 st->codecpar->height = vid->height;
132 }
133 81 st = s->streams[vid->video_index];
134 81 npixels = st->codecpar->width * st->codecpar->height;
135
136 81 vidbuf_start = av_malloc(vidbuf_capacity = BUFFER_PADDING_SIZE);
137
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 81 times.
 81 if(!vidbuf_start)
138 ✗ return AVERROR(ENOMEM);
139
140 // save the file position for the packet, include block type
141 81 position = avio_tell(pb) - 1;
142
143 81 vidbuf_start[vidbuf_nbytes++] = block_type;
144
145 // get the current packet duration
146 81 duration = vid->bethsoft_global_delay + avio_rl16(pb);
147
148 // set the y offset if it exists (decoder header data should be in data section)
149
2/2
✓ Branch 0 taken 80 times.
✓ Branch 1 taken 1 times.
 81 if(block_type == VIDEO_YOFF_P_FRAME){
150
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 80 times.
 80 if (avio_read(pb, &vidbuf_start[vidbuf_nbytes], 2) != 2) {
151 ✗ ret = AVERROR(EIO);
152 ✗ goto fail;
153 }
154 80 vidbuf_nbytes += 2;
155 }
156
157 do{
158 247012 uint8_t *tmp = av_fast_realloc(vidbuf_start, &vidbuf_capacity,
159 247012 vidbuf_nbytes + BUFFER_PADDING_SIZE);
160
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 247012 times.
 247012 if (!tmp) {
161 ✗ ret = AVERROR(ENOMEM);
162 ✗ goto fail;
163 }
164 247012 vidbuf_start = tmp;
165
166 247012 code = avio_r8(pb);
167 247012 vidbuf_start[vidbuf_nbytes++] = code;
168
169
2/2
✓ Branch 0 taken 127080 times.
✓ Branch 1 taken 119932 times.
 247012 if(code >= 0x80){ // rle sequence
170
2/2
✓ Branch 0 taken 504 times.
✓ Branch 1 taken 126576 times.
 127080 if(block_type == VIDEO_I_FRAME)
171 504 vidbuf_start[vidbuf_nbytes++] = avio_r8(pb);
172
2/2
✓ Branch 0 taken 119852 times.
✓ Branch 1 taken 80 times.
 119932 } else if(code){ // plain sequence
173
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 119852 times.
 119852 if (avio_read(pb, &vidbuf_start[vidbuf_nbytes], code) != code) {
174 ✗ ret = AVERROR(EIO);
175 ✗ goto fail;
176 }
177 119852 vidbuf_nbytes += code;
178 }
179 247012 bytes_copied += code & 0x7F;
180
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 247011 times.
 247012 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
1/2
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
 1 if(avio_r8(pb))
183 1 avio_seek(pb, -1, SEEK_CUR);
184 1 break;
185 }
186
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 247011 times.
 247011 if (bytes_copied > npixels) {
187 ✗ ret = AVERROR_INVALIDDATA;
188 ✗ goto fail;
189 }
190
2/2
✓ Branch 0 taken 246931 times.
✓ Branch 1 taken 80 times.
 247011 } while(code);
191
192 // copy data into packet
193
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 81 times.
 81 if ((ret = av_new_packet(pkt, vidbuf_nbytes)) < 0)
194 ✗ goto fail;
195 81 memcpy(pkt->data, vidbuf_start, vidbuf_nbytes);
196
197 81 pkt->pos = position;
198 81 pkt->stream_index = vid->video_index;
199 81 pkt->duration = duration;
200
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 80 times.
 81 if (block_type == VIDEO_I_FRAME)
201 1 pkt->flags |= AV_PKT_FLAG_KEY;
202
203 /* if there is a new palette available, add it to packet side data */
204
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 80 times.
 81 if (vid->has_palette) {
205 1 uint8_t *pdata = av_packet_new_side_data(pkt, AV_PKT_DATA_PALETTE,
206 BVID_PALETTE_SIZE);
207
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 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 1 memcpy(pdata, vid->palette, BVID_PALETTE_SIZE);
213 1 vid->has_palette = 0;
214 }
215
216 81 vid->nframes--; // used to check if all the frames were read
217 81 fail:
218 81 av_free(vidbuf_start);
219 81 return ret;
220 }
221
222 158 static int vid_read_packet(AVFormatContext *s,
223 AVPacket *pkt)
224 {
225 158 BVID_DemuxContext *vid = s->priv_data;
226 158 AVIOContext *pb = s->pb;
227 unsigned char block_type;
228 int audio_length;
229 int ret_value;
230
231
2/4
✓ Branch 0 taken 158 times.
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 158 times.
 158 if(vid->is_finished || avio_feof(pb))
232 ✗ return AVERROR_EOF;
233
234 158 block_type = avio_r8(pb);
235
4/6
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 74 times.
✓ Branch 3 taken 81 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
 158 switch(block_type){
236 1 case PALETTE_BLOCK:
237
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 if (vid->has_palette) {
238 ✗ av_log(s, AV_LOG_WARNING, "discarding unused palette\n");
239 ✗ vid->has_palette = 0;
240 }
241
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1 times.
 1 if (avio_read(pb, vid->palette, BVID_PALETTE_SIZE) != BVID_PALETTE_SIZE) {
242 ✗ return AVERROR(EIO);
243 }
244 1 vid->has_palette = 1;
245 1 return vid_read_packet(s, pkt);
246
247 2 case FIRST_AUDIO_BLOCK:
248 2 avio_rl16(pb);
249 // soundblaster DAC used for sample rate, as on specification page (link above)
250 2 vid->sample_rate = 1000000 / (256 - avio_r8(pb));
251 76 case AUDIO_BLOCK:
252
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 75 times.
 76 if (vid->audio_index < 0) {
253 1 AVStream *st = avformat_new_stream(s, NULL);
254
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 if (!st)
255 ✗ return AVERROR(ENOMEM);
256 1 vid->audio_index = st->index;
257 1 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
258 1 st->codecpar->codec_id = AV_CODEC_ID_PCM_U8;
259 1 st->codecpar->ch_layout = (AVChannelLayout)AV_CHANNEL_LAYOUT_MONO;
260 1 st->codecpar->bits_per_coded_sample = 8;
261 1 st->codecpar->sample_rate = vid->sample_rate;
262 1 st->codecpar->bit_rate = 8 * st->codecpar->sample_rate;
263 1 st->start_time = 0;
264 1 avpriv_set_pts_info(st, 64, 1, vid->sample_rate);
265 }
266 76 audio_length = avio_rl16(pb);
267
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 76 times.
 76 if ((ret_value = av_get_packet(pb, pkt, audio_length)) != audio_length) {
268 ✗ if (ret_value < 0)
269 ✗ return ret_value;
270 ✗ av_log(s, AV_LOG_ERROR, "incomplete audio block\n");
271 ✗ return AVERROR(EIO);
272 }
273 76 pkt->stream_index = vid->audio_index;
274 76 pkt->duration = audio_length;
275 76 pkt->flags |= AV_PKT_FLAG_KEY;
276 76 return 0;
277
278 81 case VIDEO_P_FRAME:
279 case VIDEO_YOFF_P_FRAME:
280 case VIDEO_I_FRAME:
281 81 return read_frame(vid, pb, pkt, block_type, s);
282
283 ✗ case EOF_BLOCK:
284 ✗ if(vid->nframes != 0)
285 ✗ av_log(s, AV_LOG_VERBOSE, "reached terminating character but not all frames read.\n");
286 ✗ vid->is_finished = 1;
287 ✗ return AVERROR(EIO);
288 ✗ default:
289 ✗ av_log(s, AV_LOG_ERROR, "unknown block (character = %c, decimal = %d, hex = %x)!!!\n",
290 block_type, block_type, block_type);
291 ✗ return AVERROR_INVALIDDATA;
292 }
293 }
294
295 const FFInputFormat ff_bethsoftvid_demuxer = {
296 .p.name = "bethsoftvid",
297 .p.long_name = NULL_IF_CONFIG_SMALL("Bethesda Softworks VID"),
298 .priv_data_size = sizeof(BVID_DemuxContext),
299 .read_probe = vid_probe,
300 .read_header = vid_read_header,
301 .read_packet = vid_read_packet,
302 };
303