f2d332b1a308ff74a8df20725efce60110aaf45e
[ffmpeg.git] / libavcodec / bethsoftvideo.c
1 /*
2  * Bethesda VID video decoder
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 bethsoftvideo.c
24  * @brief Bethesda Softworks VID Video Decoder
25  * @author Nicholas Tung [ntung (at. ntung com] (2007-03)
26  * @sa http://wiki.multimedia.cx/index.php?title=Bethsoft_VID
27  * @sa http://www.svatopluk.com/andux/docs/dfvid.html
28  */
29
30 #include "common.h"
31 #include "dsputil.h"
32 #include "bethsoftvideo.h"
33 #include "bytestream.h"
34
35 typedef struct BethsoftvidContext {
36     AVFrame frame;
37 } BethsoftvidContext;
38
39 static int bethsoftvid_decode_init(AVCodecContext *avctx)
40 {
41     BethsoftvidContext *vid = avctx->priv_data;
42     vid->frame.reference = 1;
43     vid->frame.buffer_hints = FF_BUFFER_HINTS_VALID |
44         FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
45     avctx->pix_fmt = PIX_FMT_PAL8;    // palette in vid->frame.data[1]
46     av_log(avctx, AV_LOG_DEBUG, "[bethsoftvid video decoder] init\n");
47     return 0;
48 }
49
50 static void set_palette(AVFrame * frame, uint8_t * palette_buffer)
51 {
52     uint32_t * palette = (uint32_t *)frame->data[1];
53     int a;
54     for(a = 0; a < 256; a++)
55     {
56         palette[a] = AV_RB24(&palette_buffer[a * 3]) * 4;    // multiply all colors by 4
57     }
58     frame->palette_has_changed = 1;
59 }
60
61 static int bethsoftvid_decode_frame(AVCodecContext *avctx,
62                               void *data, int *data_size,
63                               uint8_t *buf, int buf_size)
64 {
65     BethsoftvidContext * vid = avctx->priv_data;
66     char block_type;
67     uint8_t * destination;
68     uint8_t * frame_end;
69     int line_remaining = avctx->width;          // number of bytes remaining on a line
70     const int wrap_to_next_line = vid->frame.linesize[0] - avctx->width;
71     uint8_t rle_num_bytes;
72     int yoffset;
73
74     av_log(avctx, AV_LOG_DEBUG, "[bethsoftvid video decoder] decoding frame\n");
75
76     // reget buffer will copy old data, good for simple difference frames
77     if (avctx->reget_buffer(avctx, &vid->frame)) {
78         av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
79         return -1;
80     }
81     destination = vid->frame.data[0];
82     frame_end = vid->frame.data[0] + vid->frame.linesize[0] * avctx->height;
83
84     switch(block_type = *buf++)
85     {
86         case PALETTE_BLOCK: set_palette(&vid->frame, buf); return 0;
87         case VIDEO_YOFF_P_FRAME:
88             yoffset = bytestream_get_le16(&buf);
89             if(yoffset >= avctx->height) { return -1; }
90             destination += vid->frame.linesize[0] * yoffset;
91     }
92
93     // main code
94     while((rle_num_bytes = *buf++))
95     {
96         int length = rle_num_bytes & 0x7f;
97
98         // copy any bytes starting at the current position, and ending at the frame width
99         while(length > line_remaining)
100         {
101             if(rle_num_bytes < 0x80) { bytestream_get_buffer(&buf, destination, line_remaining); }
102             else if(block_type == VIDEO_I_FRAME) { memset(destination, buf[0], line_remaining); }
103             length -= line_remaining;      // decrement the number of bytes to be copied
104             destination += line_remaining + wrap_to_next_line;    // skip over extra bytes at end of frame
105             line_remaining = avctx->width;
106             if(destination == frame_end) { goto end; }
107         }
108
109         // copy any remaining bytes after / if line overflows
110         if(rle_num_bytes < 0x80) { bytestream_get_buffer(&buf, destination, length); }
111         else if(block_type == VIDEO_I_FRAME) { memset(destination, *buf++, length); }
112         line_remaining -= length;
113         destination += length;
114     }
115     end:
116
117     *data_size = sizeof(AVFrame);
118     *(AVFrame*)data = vid->frame;
119
120     return buf_size;
121 }
122
123 static int bethsoftvid_decode_end(AVCodecContext *avctx)
124 {
125     BethsoftvidContext * vid = avctx->priv_data;
126     av_log(avctx, AV_LOG_DEBUG, "[bethsoftvid video decoder] closing\n");
127     if(vid->frame.data[0]) { avctx->release_buffer(avctx, &vid->frame); }
128     return 0;
129 }
130
131 AVCodec bethsoftvid_decoder = {
132     .name = "bethsoftvid",
133     .type = CODEC_TYPE_VIDEO,
134     .id = CODEC_ID_BETHSOFTVID,
135     .priv_data_size = sizeof(BethsoftvidContext),
136     .init = bethsoftvid_decode_init,
137     .close = bethsoftvid_decode_end,
138     .decode = bethsoftvid_decode_frame,
139 };