2 * Bethesda VID video decoder
3 * Copyright (C) 2007 Nicholas Tung
5 * This file is part of FFmpeg.
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.
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.
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
24 * @brief Bethesda Softworks VID Video Decoder
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
30 #include "libavutil/common.h"
32 #include "bethsoftvideo.h"
33 #include "bytestream.h"
35 typedef struct BethsoftvidContext {
40 static av_cold int bethsoftvid_decode_init(AVCodecContext *avctx)
42 BethsoftvidContext *vid = avctx->priv_data;
43 avcodec_get_frame_defaults(&vid->frame);
44 vid->frame.reference = 3;
45 vid->frame.buffer_hints = FF_BUFFER_HINTS_VALID |
46 FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
47 avctx->pix_fmt = AV_PIX_FMT_PAL8;
51 static int set_palette(BethsoftvidContext *ctx)
53 uint32_t *palette = (uint32_t *)ctx->frame.data[1];
56 if (bytestream2_get_bytes_left(&ctx->g) < 256*3)
57 return AVERROR_INVALIDDATA;
59 for(a = 0; a < 256; a++){
60 palette[a] = 0xFFU << 24 | bytestream2_get_be24u(&ctx->g) * 4;
61 palette[a] |= palette[a] >> 6 & 0x30303;
63 ctx->frame.palette_has_changed = 1;
67 static int bethsoftvid_decode_frame(AVCodecContext *avctx,
68 void *data, int *data_size,
71 BethsoftvidContext * vid = avctx->priv_data;
75 int remaining = avctx->width; // number of bytes remaining on a line
76 int wrap_to_next_line;
80 if ((ret = avctx->reget_buffer(avctx, &vid->frame)) < 0) {
81 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
84 wrap_to_next_line = vid->frame.linesize[0] - avctx->width;
86 if (avpkt->side_data_elems > 0 &&
87 avpkt->side_data[0].type == AV_PKT_DATA_PALETTE) {
88 bytestream2_init(&vid->g, avpkt->side_data[0].data,
89 avpkt->side_data[0].size);
90 if ((ret = set_palette(vid)) < 0)
94 bytestream2_init(&vid->g, avpkt->data, avpkt->size);
95 dst = vid->frame.data[0];
96 frame_end = vid->frame.data[0] + vid->frame.linesize[0] * avctx->height;
98 switch(block_type = bytestream2_get_byte(&vid->g)){
101 if ((ret = set_palette(vid)) < 0) {
102 av_log(avctx, AV_LOG_ERROR, "error reading palette\n");
105 return bytestream2_tell(&vid->g);
107 case VIDEO_YOFF_P_FRAME:
108 yoffset = bytestream2_get_le16(&vid->g);
109 if(yoffset >= avctx->height)
110 return AVERROR_INVALIDDATA;
111 dst += vid->frame.linesize[0] * yoffset;
115 while((code = bytestream2_get_byte(&vid->g))){
116 int length = code & 0x7f;
118 // copy any bytes starting at the current position, and ending at the frame width
119 while(length > remaining){
121 bytestream2_get_buffer(&vid->g, dst, remaining);
122 else if(block_type == VIDEO_I_FRAME)
123 memset(dst, bytestream2_peek_byte(&vid->g), remaining);
124 length -= remaining; // decrement the number of bytes to be copied
125 dst += remaining + wrap_to_next_line; // skip over extra bytes at end of frame
126 remaining = avctx->width;
131 // copy any remaining bytes after / if line overflows
133 bytestream2_get_buffer(&vid->g, dst, length);
134 else if(block_type == VIDEO_I_FRAME)
135 memset(dst, bytestream2_get_byte(&vid->g), length);
141 *data_size = sizeof(AVFrame);
142 *(AVFrame*)data = vid->frame;
147 static av_cold int bethsoftvid_decode_end(AVCodecContext *avctx)
149 BethsoftvidContext * vid = avctx->priv_data;
150 if(vid->frame.data[0])
151 avctx->release_buffer(avctx, &vid->frame);
155 AVCodec ff_bethsoftvid_decoder = {
156 .name = "bethsoftvid",
157 .type = AVMEDIA_TYPE_VIDEO,
158 .id = AV_CODEC_ID_BETHSOFTVID,
159 .priv_data_size = sizeof(BethsoftvidContext),
160 .init = bethsoftvid_decode_init,
161 .close = bethsoftvid_decode_end,
162 .decode = bethsoftvid_decode_frame,
163 .capabilities = CODEC_CAP_DR1,
164 .long_name = NULL_IF_CONFIG_SMALL("Bethesda VID video"),