2 * Psygnosis YOP decoder
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>
8 * This file is part of FFmpeg.
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.
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.
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
25 #include "libavutil/intreadwrite.h"
26 #include "libavutil/imgutils.h"
32 typedef struct YopDecContext {
34 AVCodecContext *avctx;
38 int frame_data_length;
47 // These tables are taken directly from:
48 // http://wiki.multimedia.cx/index.php?title=Psygnosis_YOP
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.
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},
68 * Lookup table for copying macroblocks. Each entry contains the respective
69 * x and y pixel offset for the copy source.
71 static const int8_t motion_vector[16][2] =
82 static av_cold int yop_decode_init(AVCodecContext *avctx)
84 YopDecContext *s = avctx->priv_data;
87 if (avctx->width & 1 || avctx->height & 1 ||
88 av_image_check_size(avctx->width, avctx->height, 0, avctx) < 0) {
89 av_log(avctx, AV_LOG_ERROR, "YOP has invalid dimensions\n");
90 return AVERROR_INVALIDDATA;
93 if (avctx->extradata_size < 3) {
94 av_log(avctx, AV_LOG_ERROR, "Missing or incomplete extradata.\n");
95 return AVERROR_INVALIDDATA;
98 avctx->pix_fmt = AV_PIX_FMT_PAL8;
100 avcodec_get_frame_defaults(&s->frame);
101 s->num_pal_colors = avctx->extradata[0];
102 s->first_color[0] = avctx->extradata[1];
103 s->first_color[1] = avctx->extradata[2];
105 if (s->num_pal_colors + s->first_color[0] > 256 ||
106 s->num_pal_colors + s->first_color[1] > 256) {
107 av_log(avctx, AV_LOG_ERROR,
108 "Palette parameters invalid, header probably corrupt\n");
109 return AVERROR_INVALIDDATA;
115 static av_cold int yop_decode_close(AVCodecContext *avctx)
117 YopDecContext *s = avctx->priv_data;
118 if (s->frame.data[0])
119 avctx->release_buffer(avctx, &s->frame);
124 * Paint a macroblock using the pattern in paint_lut.
125 * @param s codec context
126 * @param tag the tag that was in the nibble
128 static int yop_paint_block(YopDecContext *s, int tag)
130 if (s->src_end - s->srcptr < paint_lut[tag][3]) {
131 av_log(s->avctx, AV_LOG_ERROR, "Packet too small.\n");
132 return AVERROR_INVALIDDATA;
135 s->dstptr[0] = s->srcptr[0];
136 s->dstptr[1] = s->srcptr[paint_lut[tag][0]];
137 s->dstptr[s->frame.linesize[0]] = s->srcptr[paint_lut[tag][1]];
138 s->dstptr[s->frame.linesize[0] + 1] = s->srcptr[paint_lut[tag][2]];
140 // The number of src bytes consumed is in the last part of the lut entry.
141 s->srcptr += paint_lut[tag][3];
146 * Copy a previously painted macroblock to the current_block.
147 * @param copy_tag the tag that was in the nibble
149 static int yop_copy_previous_block(YopDecContext *s, int copy_tag)
153 // Calculate position for the copy source
154 bufptr = s->dstptr + motion_vector[copy_tag][0] +
155 s->frame.linesize[0] * motion_vector[copy_tag][1];
156 if (bufptr < s->dstbuf) {
157 av_log(s->avctx, AV_LOG_ERROR, "File probably corrupt\n");
158 return AVERROR_INVALIDDATA;
161 s->dstptr[0] = bufptr[0];
162 s->dstptr[1] = bufptr[1];
163 s->dstptr[s->frame.linesize[0]] = bufptr[s->frame.linesize[0]];
164 s->dstptr[s->frame.linesize[0] + 1] = bufptr[s->frame.linesize[0] + 1];
170 * Return the next nibble in sequence, consuming a new byte on the input
173 static uint8_t yop_get_next_nibble(YopDecContext *s)
178 ret = *s->low_nibble & 0xf;
179 s->low_nibble = NULL;
181 s->low_nibble = s->srcptr++;
182 ret = *s->low_nibble >> 4;
187 static int yop_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
190 YopDecContext *s = avctx->priv_data;
191 int tag, firstcolor, is_odd_frame;
195 if (avpkt->size < 4 + 3 * s->num_pal_colors) {
196 av_log(avctx, AV_LOG_ERROR, "Packet too small.\n");
197 return AVERROR_INVALIDDATA;
200 if (s->frame.data[0])
201 avctx->release_buffer(avctx, &s->frame);
203 ret = ff_get_buffer(avctx, &s->frame);
205 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
209 if (!avctx->frame_number)
210 memset(s->frame.data[1], 0, AVPALETTE_SIZE);
212 s->dstbuf = s->frame.data[0];
213 s->dstptr = s->frame.data[0];
214 s->srcptr = avpkt->data + 4;
215 s->src_end = avpkt->data + avpkt->size;
216 s->low_nibble = NULL;
218 is_odd_frame = avpkt->data[0];
220 av_log(avctx, AV_LOG_ERROR, "frame is too odd %d\n", is_odd_frame);
221 return AVERROR_INVALIDDATA;
223 firstcolor = s->first_color[is_odd_frame];
224 palette = (uint32_t *)s->frame.data[1];
226 for (i = 0; i < s->num_pal_colors; i++, s->srcptr += 3) {
227 palette[i + firstcolor] = (s->srcptr[0] << 18) |
228 (s->srcptr[1] << 10) |
230 palette[i + firstcolor] |= 0xFFU << 24 |
231 (palette[i + firstcolor] >> 6) & 0x30303;
234 s->frame.palette_has_changed = 1;
236 for (y = 0; y < avctx->height; y += 2) {
237 for (x = 0; x < avctx->width; x += 2) {
238 if (s->srcptr - avpkt->data >= avpkt->size) {
239 av_log(avctx, AV_LOG_ERROR, "Packet too small.\n");
240 return AVERROR_INVALIDDATA;
243 tag = yop_get_next_nibble(s);
246 ret = yop_paint_block(s, tag);
250 tag = yop_get_next_nibble(s);
251 ret = yop_copy_previous_block(s, tag);
253 avctx->release_buffer(avctx, &s->frame);
259 s->dstptr += 2*s->frame.linesize[0] - x;
263 *(AVFrame *) data = s->frame;
267 AVCodec ff_yop_decoder = {
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"),