Merge remote branch 'qatar/master'
[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
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 "libavutil/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 av_cold int bethsoftvid_decode_init(AVCodecContext *avctx)
40 {
41     BethsoftvidContext *vid = avctx->priv_data;
42     avcodec_get_frame_defaults(&vid->frame);
43     vid->frame.reference = 1;
44     vid->frame.buffer_hints = FF_BUFFER_HINTS_VALID |
45         FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
46     avctx->pix_fmt = PIX_FMT_PAL8;
47     return 0;
48 }
49
50 static void set_palette(AVFrame * frame, const 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         palette[a] = AV_RB24(&palette_buffer[a * 3]) * 4;
56     }
57     frame->palette_has_changed = 1;
58 }
59
60 static int bethsoftvid_decode_frame(AVCodecContext *avctx,
61                               void *data, int *data_size,
62                               AVPacket *avpkt)
63 {
64     const uint8_t *buf = avpkt->data;
65     int buf_size = avpkt->size;
66     BethsoftvidContext * vid = avctx->priv_data;
67     char block_type;
68     uint8_t * dst;
69     uint8_t * frame_end;
70     int remaining = avctx->width;          // number of bytes remaining on a line
71     const int wrap_to_next_line = vid->frame.linesize[0] - avctx->width;
72     int code;
73     int yoffset;
74
75     if (avctx->reget_buffer(avctx, &vid->frame)) {
76         av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
77         return -1;
78     }
79     dst = vid->frame.data[0];
80     frame_end = vid->frame.data[0] + vid->frame.linesize[0] * avctx->height;
81
82     switch(block_type = *buf++){
83         case PALETTE_BLOCK:
84             set_palette(&vid->frame, buf);
85             return 0;
86         case VIDEO_YOFF_P_FRAME:
87             yoffset = bytestream_get_le16(&buf);
88             if(yoffset >= avctx->height)
89                 return -1;
90             dst += vid->frame.linesize[0] * yoffset;
91     }
92
93     // main code
94     while((code = *buf++)){
95         int length = code & 0x7f;
96
97         // copy any bytes starting at the current position, and ending at the frame width
98         while(length > remaining){
99             if(code < 0x80)
100                 bytestream_get_buffer(&buf, dst, remaining);
101             else if(block_type == VIDEO_I_FRAME)
102                 memset(dst, buf[0], remaining);
103             length -= remaining;      // decrement the number of bytes to be copied
104             dst += remaining + wrap_to_next_line;    // skip over extra bytes at end of frame
105             remaining = avctx->width;
106             if(dst == frame_end)
107                 goto end;
108         }
109
110         // copy any remaining bytes after / if line overflows
111         if(code < 0x80)
112             bytestream_get_buffer(&buf, dst, length);
113         else if(block_type == VIDEO_I_FRAME)
114             memset(dst, *buf++, length);
115         remaining -= length;
116         dst += length;
117     }
118     end:
119
120     *data_size = sizeof(AVFrame);
121     *(AVFrame*)data = vid->frame;
122
123     return buf_size;
124 }
125
126 static av_cold int bethsoftvid_decode_end(AVCodecContext *avctx)
127 {
128     BethsoftvidContext * vid = avctx->priv_data;
129     if(vid->frame.data[0])
130         avctx->release_buffer(avctx, &vid->frame);
131     return 0;
132 }
133
134 AVCodec ff_bethsoftvid_decoder = {
135     .name = "bethsoftvid",
136     .type = AVMEDIA_TYPE_VIDEO,
137     .id = CODEC_ID_BETHSOFTVID,
138     .priv_data_size = sizeof(BethsoftvidContext),
139     .init = bethsoftvid_decode_init,
140     .close = bethsoftvid_decode_end,
141     .decode = bethsoftvid_decode_frame,
142     .capabilities = CODEC_CAP_DR1,
143     .long_name = NULL_IF_CONFIG_SMALL("Bethesda VID video"),
144 };