Merge remote branch 'qatar/master'
[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
37 #define MM_PREAMBLE_SIZE    6
38
39 #define MM_TYPE_INTER       0x5
40 #define MM_TYPE_INTRA       0x8
41 #define MM_TYPE_INTRA_HH    0xc
42 #define MM_TYPE_INTER_HH    0xd
43 #define MM_TYPE_INTRA_HHV   0xe
44 #define MM_TYPE_INTER_HHV   0xf
45 #define MM_TYPE_PALETTE     0x31
46
47 typedef struct MmContext {
48     AVCodecContext *avctx;
49     AVFrame frame;
50     int palette[AVPALETTE_COUNT];
51 } MmContext;
52
53 static av_cold int mm_decode_init(AVCodecContext *avctx)
54 {
55     MmContext *s = avctx->priv_data;
56
57     s->avctx = avctx;
58
59     avctx->pix_fmt = PIX_FMT_PAL8;
60
61     avcodec_get_frame_defaults(&s->frame);
62     s->frame.reference = 1;
63
64     return 0;
65 }
66
67 static void mm_decode_pal(MmContext *s, const uint8_t *buf, const uint8_t *buf_end)
68 {
69     int i;
70     buf += 4;
71     for (i=0; i<128 && buf+2<buf_end; i++) {
72         s->palette[i] = AV_RB24(buf);
73         s->palette[i+128] = s->palette[i]<<2;
74         buf += 3;
75     }
76 }
77
78 /**
79  * @param half_horiz Half horizontal resolution (0 or 1)
80  * @param half_vert Half vertical resolution (0 or 1)
81  */
82 static void mm_decode_intra(MmContext * s, int half_horiz, int half_vert, const uint8_t *buf, int buf_size)
83 {
84     int i, x, y;
85     i=0; x=0; y=0;
86
87     while(i<buf_size) {
88         int run_length, color;
89
90         if (y >= s->avctx->height)
91             return;
92
93         if (buf[i] & 0x80) {
94             run_length = 1;
95             color = buf[i];
96             i++;
97         }else{
98             run_length = (buf[i] & 0x7f) + 2;
99             color = buf[i+1];
100             i+=2;
101         }
102
103         if (half_horiz)
104             run_length *=2;
105
106         if (color) {
107             memset(s->frame.data[0] + y*s->frame.linesize[0] + x, color, run_length);
108             if (half_vert)
109                 memset(s->frame.data[0] + (y+1)*s->frame.linesize[0] + x, color, run_length);
110         }
111         x+= run_length;
112
113         if (x >= s->avctx->width) {
114             x=0;
115             y += 1 + half_vert;
116         }
117     }
118 }
119
120 /*
121  * @param half_horiz Half horizontal resolution (0 or 1)
122  * @param half_vert Half vertical resolution (0 or 1)
123  */
124 static void mm_decode_inter(MmContext * s, int half_horiz, int half_vert, const uint8_t *buf, int buf_size)
125 {
126     const int data_ptr = 2 + AV_RL16(&buf[0]);
127     int d, r, y;
128     d = data_ptr; r = 2; y = 0;
129
130     while(r < data_ptr) {
131         int i, j;
132         int length = buf[r] & 0x7f;
133         int x = buf[r+1] + ((buf[r] & 0x80) << 1);
134         r += 2;
135
136         if (length==0) {
137             y += x;
138             continue;
139         }
140
141         if (y + half_vert >= s->avctx->height)
142             return;
143
144         for(i=0; i<length; i++) {
145             for(j=0; j<8; j++) {
146                 int replace = (buf[r+i] >> (7-j)) & 1;
147                 if (replace) {
148                     int color = buf[d];
149                     s->frame.data[0][y*s->frame.linesize[0] + x] = color;
150                     if (half_horiz)
151                         s->frame.data[0][y*s->frame.linesize[0] + x + 1] = color;
152                     if (half_vert) {
153                         s->frame.data[0][(y+1)*s->frame.linesize[0] + x] = color;
154                         if (half_horiz)
155                             s->frame.data[0][(y+1)*s->frame.linesize[0] + x + 1] = color;
156                     }
157                     d++;
158                 }
159                 x += 1 + half_horiz;
160             }
161         }
162
163         r += length;
164         y += 1 + half_vert;
165     }
166 }
167
168 static int mm_decode_frame(AVCodecContext *avctx,
169                             void *data, int *data_size,
170                             AVPacket *avpkt)
171 {
172     const uint8_t *buf = avpkt->data;
173     int buf_size = avpkt->size;
174     MmContext *s = avctx->priv_data;
175     const uint8_t *buf_end = buf+buf_size;
176     int type;
177
178     type = AV_RL16(&buf[0]);
179     buf += MM_PREAMBLE_SIZE;
180     buf_size -= MM_PREAMBLE_SIZE;
181
182     if (avctx->reget_buffer(avctx, &s->frame) < 0) {
183         av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
184         return -1;
185     }
186
187     switch(type) {
188     case MM_TYPE_PALETTE   : mm_decode_pal(s, buf, buf_end); return buf_size;
189     case MM_TYPE_INTRA     : mm_decode_intra(s, 0, 0, buf, buf_size); break;
190     case MM_TYPE_INTRA_HH  : mm_decode_intra(s, 1, 0, buf, buf_size); break;
191     case MM_TYPE_INTRA_HHV : mm_decode_intra(s, 1, 1, buf, buf_size); break;
192     case MM_TYPE_INTER     : mm_decode_inter(s, 0, 0, buf, buf_size); break;
193     case MM_TYPE_INTER_HH  : mm_decode_inter(s, 1, 0, buf, buf_size); break;
194     case MM_TYPE_INTER_HHV : mm_decode_inter(s, 1, 1, buf, buf_size); break;
195     default :
196         return -1;
197     }
198
199     memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
200
201     *data_size = sizeof(AVFrame);
202     *(AVFrame*)data = s->frame;
203
204     return buf_size;
205 }
206
207 static av_cold int mm_decode_end(AVCodecContext *avctx)
208 {
209     MmContext *s = avctx->priv_data;
210
211     if(s->frame.data[0])
212         avctx->release_buffer(avctx, &s->frame);
213
214     return 0;
215 }
216
217 AVCodec ff_mmvideo_decoder = {
218     "mmvideo",
219     AVMEDIA_TYPE_VIDEO,
220     CODEC_ID_MMVIDEO,
221     sizeof(MmContext),
222     mm_decode_init,
223     NULL,
224     mm_decode_end,
225     mm_decode_frame,
226     CODEC_CAP_DR1,
227     .long_name = NULL_IF_CONFIG_SMALL("American Laser Games MM Video"),
228 };