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"
31 typedef struct YopDecContext {
33 AVCodecContext *avctx;
37 int frame_data_length;
46 // These tables are taken directly from:
47 // http://wiki.multimedia.cx/index.php?title=Psygnosis_YOP
50 * Lookup table for painting macroblocks. Bytes 0-2 of each entry contain
51 * the macroblock positions to be painted (taken as (0, B0, B1, B2)).
52 * Byte 3 contains the number of bytes consumed on the input,
53 * equal to max(bytes 0-2) + 1.
55 static const uint8_t paint_lut[15][4] =
56 {{1, 2, 3, 4}, {1, 2, 0, 3},
57 {1, 2, 1, 3}, {1, 2, 2, 3},
58 {1, 0, 2, 3}, {1, 0, 0, 2},
59 {1, 0, 1, 2}, {1, 1, 2, 3},
60 {0, 1, 2, 3}, {0, 1, 0, 2},
61 {1, 1, 0, 2}, {0, 1, 1, 2},
62 {0, 0, 1, 2}, {0, 0, 0, 1},
67 * Lookup table for copying macroblocks. Each entry contains the respective
68 * x and y pixel offset for the copy source.
70 static const int8_t motion_vector[16][2] =
81 static av_cold int yop_decode_init(AVCodecContext *avctx)
83 YopDecContext *s = avctx->priv_data;
86 if (avctx->width & 1 || avctx->height & 1 ||
87 av_image_check_size(avctx->width, avctx->height, 0, avctx) < 0) {
91 if (!avctx->extradata) {
92 av_log(avctx, AV_LOG_ERROR, "extradata missing\n");
93 return AVERROR_INVALIDDATA;
96 avctx->pix_fmt = AV_PIX_FMT_PAL8;
98 avcodec_get_frame_defaults(&s->frame);
99 s->num_pal_colors = avctx->extradata[0];
100 s->first_color[0] = avctx->extradata[1];
101 s->first_color[1] = avctx->extradata[2];
103 if (s->num_pal_colors + s->first_color[0] > 256 ||
104 s->num_pal_colors + s->first_color[1] > 256) {
105 av_log(avctx, AV_LOG_ERROR,
106 "Palette parameters invalid, header probably corrupt\n");
107 return AVERROR_INVALIDDATA;
113 static av_cold int yop_decode_close(AVCodecContext *avctx)
115 YopDecContext *s = avctx->priv_data;
116 if (s->frame.data[0])
117 avctx->release_buffer(avctx, &s->frame);
122 * Paint a macroblock using the pattern in paint_lut.
123 * @param s codec context
124 * @param tag the tag that was in the nibble
126 static void yop_paint_block(YopDecContext *s, int tag)
128 s->dstptr[0] = s->srcptr[0];
129 s->dstptr[1] = s->srcptr[paint_lut[tag][0]];
130 s->dstptr[s->frame.linesize[0]] = s->srcptr[paint_lut[tag][1]];
131 s->dstptr[s->frame.linesize[0] + 1] = s->srcptr[paint_lut[tag][2]];
133 // The number of src bytes consumed is in the last part of the lut entry.
134 s->srcptr += paint_lut[tag][3];
138 * Copy a previously painted macroblock to the current_block.
139 * @param copy_tag the tag that was in the nibble
141 static int yop_copy_previous_block(YopDecContext *s, int copy_tag)
145 // Calculate position for the copy source
146 bufptr = s->dstptr + motion_vector[copy_tag][0] +
147 s->frame.linesize[0] * motion_vector[copy_tag][1];
148 if (bufptr < s->dstbuf) {
149 av_log(s->avctx, AV_LOG_ERROR, "File probably corrupt\n");
150 return AVERROR_INVALIDDATA;
153 s->dstptr[0] = bufptr[0];
154 s->dstptr[1] = bufptr[1];
155 s->dstptr[s->frame.linesize[0]] = bufptr[s->frame.linesize[0]];
156 s->dstptr[s->frame.linesize[0] + 1] = bufptr[s->frame.linesize[0] + 1];
162 * Return the next nibble in sequence, consuming a new byte on the input
165 static uint8_t yop_get_next_nibble(YopDecContext *s)
170 ret = *s->low_nibble & 0xf;
171 s->low_nibble = NULL;
173 s->low_nibble = s->srcptr++;
174 ret = *s->low_nibble >> 4;
180 * Take s->dstptr to the next macroblock in sequence.
182 static void yop_next_macroblock(YopDecContext *s)
184 // If we are advancing to the next row of macroblocks
185 if (s->row_pos == s->frame.linesize[0] - 2) {
186 s->dstptr += s->frame.linesize[0];
194 static int yop_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
197 YopDecContext *s = avctx->priv_data;
198 int tag, firstcolor, is_odd_frame;
202 if (s->frame.data[0])
203 avctx->release_buffer(avctx, &s->frame);
205 if (avpkt->size < 4 + 3*s->num_pal_colors) {
206 av_log(avctx, AV_LOG_ERROR, "packet of size %d too small\n", avpkt->size);
207 return AVERROR_INVALIDDATA;
210 ret = avctx->get_buffer(avctx, &s->frame);
212 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
216 s->frame.linesize[0] = avctx->width;
218 s->dstbuf = s->frame.data[0];
219 s->dstptr = s->frame.data[0];
220 s->srcptr = avpkt->data + 4;
222 s->low_nibble = NULL;
224 is_odd_frame = avpkt->data[0];
226 av_log(avctx, AV_LOG_ERROR, "frame is too odd %d\n", is_odd_frame);
227 return AVERROR_INVALIDDATA;
229 firstcolor = s->first_color[is_odd_frame];
230 palette = (uint32_t *)s->frame.data[1];
232 for (i = 0; i < s->num_pal_colors; i++, s->srcptr += 3) {
233 palette[i + firstcolor] = (s->srcptr[0] << 18) |
234 (s->srcptr[1] << 10) |
236 palette[i + firstcolor] |= 0xFFU << 24 |
237 (palette[i + firstcolor] >> 6) & 0x30303;
240 s->frame.palette_has_changed = 1;
242 while (s->dstptr - s->dstbuf <
243 avctx->width * avctx->height &&
244 s->srcptr - avpkt->data < avpkt->size) {
246 tag = yop_get_next_nibble(s);
249 yop_paint_block(s, tag);
251 tag = yop_get_next_nibble(s);
252 ret = yop_copy_previous_block(s, tag);
254 avctx->release_buffer(avctx, &s->frame);
258 yop_next_macroblock(s);
261 *data_size = sizeof(AVFrame);
262 *(AVFrame *) data = s->frame;
266 AVCodec ff_yop_decoder = {
268 .type = AVMEDIA_TYPE_VIDEO,
269 .id = AV_CODEC_ID_YOP,
270 .priv_data_size = sizeof(YopDecContext),
271 .init = yop_decode_init,
272 .close = yop_decode_close,
273 .decode = yop_decode_frame,
274 .long_name = NULL_IF_CONFIG_SMALL("Psygnosis YOP Video"),