Merge commit 'df9b9567518f2840d79a4a96b447ebe1aa326408'
[ffmpeg.git] / libavcodec / yop.c
1 /*
2  * Psygnosis YOP decoder
3  *
4  * Copyright (C) 2010 Mohamed Naufal Basheer <naufal11@gmail.com>
5  * derived from the code by
6  * Copyright (C) 2009 Thomas P. Higdon <thomas.p.higdon@gmail.com>
7  *
8  * This file is part of FFmpeg.
9  *
10  * FFmpeg is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * FFmpeg is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with FFmpeg; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24
25 #include "libavutil/intreadwrite.h"
26 #include "libavutil/imgutils.h"
27
28 #include "avcodec.h"
29 #include "get_bits.h"
30 #include "internal.h"
31
32 typedef struct YopDecContext {
33     AVFrame frame;
34     AVCodecContext *avctx;
35
36     int num_pal_colors;
37     int first_color[2];
38     int frame_data_length;
39     int row_pos;
40
41     uint8_t *low_nibble;
42     uint8_t *srcptr;
43     uint8_t *dstptr;
44     uint8_t *dstbuf;
45 } YopDecContext;
46
47 // These tables are taken directly from:
48 // http://wiki.multimedia.cx/index.php?title=Psygnosis_YOP
49
50 /**
51  * Lookup table for painting macroblocks. Bytes 0-2 of each entry contain
52  * the macroblock positions to be painted (taken as (0, B0, B1, B2)).
53  * Byte 3 contains the number of bytes consumed on the input,
54  * equal to max(bytes 0-2) + 1.
55  */
56 static const uint8_t paint_lut[15][4] =
57     {{1, 2, 3, 4}, {1, 2, 0, 3},
58      {1, 2, 1, 3}, {1, 2, 2, 3},
59      {1, 0, 2, 3}, {1, 0, 0, 2},
60      {1, 0, 1, 2}, {1, 1, 2, 3},
61      {0, 1, 2, 3}, {0, 1, 0, 2},
62      {1, 1, 0, 2}, {0, 1, 1, 2},
63      {0, 0, 1, 2}, {0, 0, 0, 1},
64      {1, 1, 1, 2},
65     };
66
67 /**
68  * Lookup table for copying macroblocks. Each entry contains the respective
69  * x and y pixel offset for the copy source.
70  */
71 static const int8_t motion_vector[16][2] =
72     {{-4, -4}, {-2, -4},
73      { 0, -4}, { 2, -4},
74      {-4, -2}, {-4,  0},
75      {-3, -3}, {-1, -3},
76      { 1, -3}, { 3, -3},
77      {-3, -1}, {-2, -2},
78      { 0, -2}, { 2, -2},
79      { 4, -2}, {-2,  0},
80     };
81
82 static av_cold int yop_decode_init(AVCodecContext *avctx)
83 {
84     YopDecContext *s = avctx->priv_data;
85     s->avctx = avctx;
86
87     if (avctx->width & 1 || avctx->height & 1 ||
88         av_image_check_size(avctx->width, avctx->height, 0, avctx) < 0) {
89         return -1;
90     }
91
92     if (!avctx->extradata) {
93         av_log(avctx, AV_LOG_ERROR, "extradata missing\n");
94         return AVERROR_INVALIDDATA;
95     }
96
97     avctx->pix_fmt = AV_PIX_FMT_PAL8;
98
99     avcodec_get_frame_defaults(&s->frame);
100     s->num_pal_colors = avctx->extradata[0];
101     s->first_color[0] = avctx->extradata[1];
102     s->first_color[1] = avctx->extradata[2];
103
104     if (s->num_pal_colors + s->first_color[0] > 256 ||
105         s->num_pal_colors + s->first_color[1] > 256) {
106         av_log(avctx, AV_LOG_ERROR,
107                "Palette parameters invalid, header probably corrupt\n");
108         return AVERROR_INVALIDDATA;
109     }
110
111     return 0;
112 }
113
114 static av_cold int yop_decode_close(AVCodecContext *avctx)
115 {
116     YopDecContext *s = avctx->priv_data;
117     if (s->frame.data[0])
118         avctx->release_buffer(avctx, &s->frame);
119     return 0;
120 }
121
122 /**
123  * Paint a macroblock using the pattern in paint_lut.
124  * @param s codec context
125  * @param tag the tag that was in the nibble
126  */
127 static void yop_paint_block(YopDecContext *s, int tag)
128 {
129     s->dstptr[0]                        = s->srcptr[0];
130     s->dstptr[1]                        = s->srcptr[paint_lut[tag][0]];
131     s->dstptr[s->frame.linesize[0]]     = s->srcptr[paint_lut[tag][1]];
132     s->dstptr[s->frame.linesize[0] + 1] = s->srcptr[paint_lut[tag][2]];
133
134     // The number of src bytes consumed is in the last part of the lut entry.
135     s->srcptr += paint_lut[tag][3];
136 }
137
138 /**
139  * Copy a previously painted macroblock to the current_block.
140  * @param copy_tag the tag that was in the nibble
141  */
142 static int yop_copy_previous_block(YopDecContext *s, int copy_tag)
143 {
144     uint8_t *bufptr;
145
146     // Calculate position for the copy source
147     bufptr = s->dstptr + motion_vector[copy_tag][0] +
148              s->frame.linesize[0] * motion_vector[copy_tag][1];
149     if (bufptr < s->dstbuf) {
150         av_log(s->avctx, AV_LOG_ERROR, "File probably corrupt\n");
151         return AVERROR_INVALIDDATA;
152     }
153
154     s->dstptr[0]                        = bufptr[0];
155     s->dstptr[1]                        = bufptr[1];
156     s->dstptr[s->frame.linesize[0]]     = bufptr[s->frame.linesize[0]];
157     s->dstptr[s->frame.linesize[0] + 1] = bufptr[s->frame.linesize[0] + 1];
158
159     return 0;
160 }
161
162 /**
163  * Return the next nibble in sequence, consuming a new byte on the input
164  * only if necessary.
165  */
166 static uint8_t yop_get_next_nibble(YopDecContext *s)
167 {
168     int ret;
169
170     if (s->low_nibble) {
171         ret           = *s->low_nibble & 0xf;
172         s->low_nibble = NULL;
173     }else {
174         s->low_nibble = s->srcptr++;
175         ret           = *s->low_nibble >> 4;
176     }
177     return ret;
178 }
179
180 /**
181  * Take s->dstptr to the next macroblock in sequence.
182  */
183 static void yop_next_macroblock(YopDecContext *s)
184 {
185     // If we are advancing to the next row of macroblocks
186     if (s->row_pos == s->frame.linesize[0] - 2) {
187         s->dstptr  += s->frame.linesize[0];
188         s->row_pos =  0;
189     }else {
190         s->row_pos += 2;
191     }
192     s->dstptr += 2;
193 }
194
195 static int yop_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
196                             AVPacket *avpkt)
197 {
198     YopDecContext *s = avctx->priv_data;
199     int tag, firstcolor, is_odd_frame;
200     int ret, i;
201     uint32_t *palette;
202
203     if (s->frame.data[0])
204         avctx->release_buffer(avctx, &s->frame);
205
206     if (avpkt->size < 4 + 3*s->num_pal_colors) {
207         av_log(avctx, AV_LOG_ERROR, "packet of size %d too small\n", avpkt->size);
208         return AVERROR_INVALIDDATA;
209     }
210
211     ret = ff_get_buffer(avctx, &s->frame);
212     if (ret < 0) {
213         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
214         return ret;
215     }
216
217     s->frame.linesize[0] = avctx->width;
218
219     s->dstbuf     = s->frame.data[0];
220     s->dstptr     = s->frame.data[0];
221     s->srcptr     = avpkt->data + 4;
222     s->row_pos    = 0;
223     s->low_nibble = NULL;
224
225     is_odd_frame = avpkt->data[0];
226     if(is_odd_frame>1){
227         av_log(avctx, AV_LOG_ERROR, "frame is too odd %d\n", is_odd_frame);
228         return AVERROR_INVALIDDATA;
229     }
230     firstcolor   = s->first_color[is_odd_frame];
231     palette      = (uint32_t *)s->frame.data[1];
232
233     for (i = 0; i < s->num_pal_colors; i++, s->srcptr += 3) {
234         palette[i + firstcolor] = (s->srcptr[0] << 18) |
235                                   (s->srcptr[1] << 10) |
236                                   (s->srcptr[2] << 2);
237         palette[i + firstcolor] |= 0xFFU << 24 |
238                                    (palette[i + firstcolor] >> 6) & 0x30303;
239     }
240
241     s->frame.palette_has_changed = 1;
242
243     while (s->dstptr - s->dstbuf <
244            avctx->width * avctx->height &&
245            s->srcptr - avpkt->data < avpkt->size) {
246
247         tag = yop_get_next_nibble(s);
248
249         if (tag != 0xf) {
250             yop_paint_block(s, tag);
251         }else {
252             tag = yop_get_next_nibble(s);
253             ret = yop_copy_previous_block(s, tag);
254             if (ret < 0) {
255                 avctx->release_buffer(avctx, &s->frame);
256                 return ret;
257             }
258         }
259         yop_next_macroblock(s);
260     }
261
262     *got_frame = 1;
263     *(AVFrame *) data = s->frame;
264     return avpkt->size;
265 }
266
267 AVCodec ff_yop_decoder = {
268     .name           = "yop",
269     .type           = AVMEDIA_TYPE_VIDEO,
270     .id             = AV_CODEC_ID_YOP,
271     .priv_data_size = sizeof(YopDecContext),
272     .init           = yop_decode_init,
273     .close          = yop_decode_close,
274     .decode         = yop_decode_frame,
275     .long_name      = NULL_IF_CONFIG_SMALL("Psygnosis YOP Video"),
276 };