mmvideo: remove unused variable
[ffmpeg.git] / libavcodec / mmvideo.c
1 /*
2  * American Laser Games MM Video Decoder
3  * Copyright (c) 2006,2008 Peter Ross
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  * American Laser Games MM Video Decoder
25  * by Peter Ross (pross@xvid.org)
26  *
27  * The MM format was used by IBM-PC ports of ALG's "arcade shooter" games,
28  * including Mad Dog McCree and Crime Patrol.
29  *
30  * Technical details here:
31  *  http://wiki.multimedia.cx/index.php?title=American_Laser_Games_MM
32  */
33
34 #include "libavutil/intreadwrite.h"
35 #include "avcodec.h"
36 #include "bytestream.h"
37
38 #define MM_PREAMBLE_SIZE    6
39
40 #define MM_TYPE_INTER       0x5
41 #define MM_TYPE_INTRA       0x8
42 #define MM_TYPE_INTRA_HH    0xc
43 #define MM_TYPE_INTER_HH    0xd
44 #define MM_TYPE_INTRA_HHV   0xe
45 #define MM_TYPE_INTER_HHV   0xf
46 #define MM_TYPE_PALETTE     0x31
47
48 typedef struct MmContext {
49     AVCodecContext *avctx;
50     AVFrame frame;
51     int palette[AVPALETTE_COUNT];
52     GetByteContext gb;
53 } MmContext;
54
55 static av_cold int mm_decode_init(AVCodecContext *avctx)
56 {
57     MmContext *s = avctx->priv_data;
58
59     s->avctx = avctx;
60
61     avctx->pix_fmt = PIX_FMT_PAL8;
62
63     avcodec_get_frame_defaults(&s->frame);
64     s->frame.reference = 3;
65
66     return 0;
67 }
68
69 static int mm_decode_pal(MmContext *s)
70 {
71     int i;
72
73     bytestream2_skip(&s->gb, 4);
74     for (i = 0; i < 128; i++) {
75         s->palette[i] = 0xFF << 24 | bytestream2_get_be24(&s->gb);
76         s->palette[i+128] = s->palette[i]<<2;
77     }
78
79     return 0;
80 }
81
82 /**
83  * @param half_horiz Half horizontal resolution (0 or 1)
84  * @param half_vert Half vertical resolution (0 or 1)
85  */
86 static int mm_decode_intra(MmContext * s, int half_horiz, int half_vert)
87 {
88     int x, y;
89     x=0; y=0;
90
91     while (bytestream2_get_bytes_left(&s->gb) > 0) {
92         int run_length, color;
93
94         if (y >= s->avctx->height)
95             return 0;
96
97         color = bytestream2_get_byte(&s->gb);
98         if (color & 0x80) {
99             run_length = 1;
100         }else{
101             run_length = (color & 0x7f) + 2;
102             color = bytestream2_get_byte(&s->gb);
103         }
104
105         if (half_horiz)
106             run_length *=2;
107
108         if (color) {
109             memset(s->frame.data[0] + y*s->frame.linesize[0] + x, color, run_length);
110             if (half_vert)
111                 memset(s->frame.data[0] + (y+1)*s->frame.linesize[0] + x, color, run_length);
112         }
113         x+= run_length;
114
115         if (x >= s->avctx->width) {
116             x=0;
117             y += 1 + half_vert;
118         }
119     }
120
121     return 0;
122 }
123
124 /*
125  * @param half_horiz Half horizontal resolution (0 or 1)
126  * @param half_vert Half vertical resolution (0 or 1)
127  */
128 static int mm_decode_inter(MmContext * s, int half_horiz, int half_vert)
129 {
130     int data_off = bytestream2_get_le16(&s->gb), y;
131     GetByteContext data_ptr;
132
133     if (bytestream2_get_bytes_left(&s->gb) < data_off)
134         return AVERROR_INVALIDDATA;
135
136     bytestream2_init(&data_ptr, s->gb.buffer + data_off, bytestream2_get_bytes_left(&s->gb) - data_off);
137     while (s->gb.buffer < data_ptr.buffer_start) {
138         int i, j;
139         int length = bytestream2_get_byte(&s->gb);
140         int x = bytestream2_get_byte(&s->gb) + ((length & 0x80) << 1);
141         length &= 0x7F;
142
143         if (length==0) {
144             y += x;
145             continue;
146         }
147
148         if (y + half_vert >= s->avctx->height)
149             return 0;
150
151         for(i=0; i<length; i++) {
152             int replace_array = bytestream2_get_byte(&s->gb);
153             for(j=0; j<8; j++) {
154                 int replace = (replace_array >> (7-j)) & 1;
155                 if (replace) {
156                     int color = bytestream2_get_byte(&data_ptr);
157                     s->frame.data[0][y*s->frame.linesize[0] + x] = color;
158                     if (half_horiz)
159                         s->frame.data[0][y*s->frame.linesize[0] + x + 1] = color;
160                     if (half_vert) {
161                         s->frame.data[0][(y+1)*s->frame.linesize[0] + x] = color;
162                         if (half_horiz)
163                             s->frame.data[0][(y+1)*s->frame.linesize[0] + x + 1] = color;
164                     }
165                 }
166                 x += 1 + half_horiz;
167             }
168         }
169
170         y += 1 + half_vert;
171     }
172
173     return 0;
174 }
175
176 static int mm_decode_frame(AVCodecContext *avctx,
177                             void *data, int *data_size,
178                             AVPacket *avpkt)
179 {
180     const uint8_t *buf = avpkt->data;
181     int buf_size = avpkt->size;
182     MmContext *s = avctx->priv_data;
183     int type, res;
184
185     if (buf_size < MM_PREAMBLE_SIZE)
186         return AVERROR_INVALIDDATA;
187     type = AV_RL16(&buf[0]);
188     buf += MM_PREAMBLE_SIZE;
189     buf_size -= MM_PREAMBLE_SIZE;
190     bytestream2_init(&s->gb, buf, buf_size);
191
192     if (avctx->reget_buffer(avctx, &s->frame) < 0) {
193         av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
194         return -1;
195     }
196
197     switch(type) {
198     case MM_TYPE_PALETTE   : res = mm_decode_pal(s); return buf_size;
199     case MM_TYPE_INTRA     : res = mm_decode_intra(s, 0, 0); break;
200     case MM_TYPE_INTRA_HH  : res = mm_decode_intra(s, 1, 0); break;
201     case MM_TYPE_INTRA_HHV : res = mm_decode_intra(s, 1, 1); break;
202     case MM_TYPE_INTER     : res = mm_decode_inter(s, 0, 0); break;
203     case MM_TYPE_INTER_HH  : res = mm_decode_inter(s, 1, 0); break;
204     case MM_TYPE_INTER_HHV : res = mm_decode_inter(s, 1, 1); break;
205     default:
206         res = AVERROR_INVALIDDATA;
207         break;
208     }
209     if (res < 0)
210         return res;
211
212     memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
213
214     *data_size = sizeof(AVFrame);
215     *(AVFrame*)data = s->frame;
216
217     return buf_size;
218 }
219
220 static av_cold int mm_decode_end(AVCodecContext *avctx)
221 {
222     MmContext *s = avctx->priv_data;
223
224     if(s->frame.data[0])
225         avctx->release_buffer(avctx, &s->frame);
226
227     return 0;
228 }
229
230 AVCodec ff_mmvideo_decoder = {
231     .name           = "mmvideo",
232     .type           = AVMEDIA_TYPE_VIDEO,
233     .id             = CODEC_ID_MMVIDEO,
234     .priv_data_size = sizeof(MmContext),
235     .init           = mm_decode_init,
236     .close          = mm_decode_end,
237     .decode         = mm_decode_frame,
238     .capabilities   = CODEC_CAP_DR1,
239     .long_name = NULL_IF_CONFIG_SMALL("American Laser Games MM Video"),
240 };