FFmpeg
yop.c
Go to the documentation of this file.
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 <string.h>
26 
27 #include "libavutil/imgutils.h"
28 #include "libavutil/internal.h"
29 
30 #include "avcodec.h"
31 #include "codec_internal.h"
32 #include "decode.h"
33 
34 typedef struct YopDecContext {
37 
39  int first_color[2];
41 
42  const uint8_t *low_nibble;
43  const uint8_t *srcptr;
44  const uint8_t *src_end;
45  uint8_t *dstptr;
46  uint8_t *dstbuf;
48 
49 // These tables are taken directly from:
50 // http://wiki.multimedia.cx/index.php?title=Psygnosis_YOP
51 
52 /**
53  * Lookup table for painting macroblocks. Bytes 0-2 of each entry contain
54  * the macroblock positions to be painted (taken as (0, B0, B1, B2)).
55  * Byte 3 contains the number of bytes consumed on the input,
56  * equal to max(bytes 0-2) + 1.
57  */
58 static const uint8_t paint_lut[15][4] =
59  {{1, 2, 3, 4}, {1, 2, 0, 3},
60  {1, 2, 1, 3}, {1, 2, 2, 3},
61  {1, 0, 2, 3}, {1, 0, 0, 2},
62  {1, 0, 1, 2}, {1, 1, 2, 3},
63  {0, 1, 2, 3}, {0, 1, 0, 2},
64  {1, 1, 0, 2}, {0, 1, 1, 2},
65  {0, 0, 1, 2}, {0, 0, 0, 1},
66  {1, 1, 1, 2},
67  };
68 
69 /**
70  * Lookup table for copying macroblocks. Each entry contains the respective
71  * x and y pixel offset for the copy source.
72  */
73 static const int8_t motion_vector[16][2] =
74  {{-4, -4}, {-2, -4},
75  { 0, -4}, { 2, -4},
76  {-4, -2}, {-4, 0},
77  {-3, -3}, {-1, -3},
78  { 1, -3}, { 3, -3},
79  {-3, -1}, {-2, -2},
80  { 0, -2}, { 2, -2},
81  { 4, -2}, {-2, 0},
82  };
83 
85 {
86  YopDecContext *s = avctx->priv_data;
87 
88  av_frame_free(&s->frame);
89 
90  return 0;
91 }
92 
94 {
95  YopDecContext *s = avctx->priv_data;
96  s->avctx = avctx;
97 
98  if (avctx->width & 1 || avctx->height & 1 ||
99  av_image_check_size(avctx->width, avctx->height, 0, avctx) < 0) {
100  av_log(avctx, AV_LOG_ERROR, "YOP has invalid dimensions\n");
101  return AVERROR_INVALIDDATA;
102  }
103 
104  if (avctx->extradata_size < 3) {
105  av_log(avctx, AV_LOG_ERROR, "Missing or incomplete extradata.\n");
106  return AVERROR_INVALIDDATA;
107  }
108 
109  avctx->pix_fmt = AV_PIX_FMT_PAL8;
110 
111  s->num_pal_colors = avctx->extradata[0];
112  s->first_color[0] = avctx->extradata[1];
113  s->first_color[1] = avctx->extradata[2];
114 
115  if (s->num_pal_colors + s->first_color[0] > 256 ||
116  s->num_pal_colors + s->first_color[1] > 256) {
117  av_log(avctx, AV_LOG_ERROR,
118  "Palette parameters invalid, header probably corrupt\n");
119  return AVERROR_INVALIDDATA;
120  }
121 
122  s->frame = av_frame_alloc();
123  if (!s->frame)
124  return AVERROR(ENOMEM);
125 
126  return 0;
127 }
128 
129 /**
130  * Paint a macroblock using the pattern in paint_lut.
131  * @param s codec context
132  * @param tag the tag that was in the nibble
133  */
134 static int yop_paint_block(YopDecContext *s, int linesize, int tag)
135 {
136  if (s->src_end - s->srcptr < paint_lut[tag][3]) {
137  av_log(s->avctx, AV_LOG_ERROR, "Packet too small.\n");
138  return AVERROR_INVALIDDATA;
139  }
140 
141  s->dstptr[0] = s->srcptr[0];
142  s->dstptr[1] = s->srcptr[paint_lut[tag][0]];
143  s->dstptr[linesize] = s->srcptr[paint_lut[tag][1]];
144  s->dstptr[linesize + 1] = s->srcptr[paint_lut[tag][2]];
145 
146  // The number of src bytes consumed is in the last part of the lut entry.
147  s->srcptr += paint_lut[tag][3];
148  return 0;
149 }
150 
151 /**
152  * Copy a previously painted macroblock to the current_block.
153  * @param copy_tag the tag that was in the nibble
154  */
155 static int yop_copy_previous_block(YopDecContext *s, int linesize, int copy_tag)
156 {
157  uint8_t *bufptr;
158 
159  // Calculate position for the copy source
160  bufptr = s->dstptr + motion_vector[copy_tag][0] +
161  linesize * motion_vector[copy_tag][1];
162  if (bufptr < s->dstbuf) {
163  av_log(s->avctx, AV_LOG_ERROR, "File probably corrupt\n");
164  return AVERROR_INVALIDDATA;
165  }
166 
167  s->dstptr[0] = bufptr[0];
168  s->dstptr[1] = bufptr[1];
169  s->dstptr[linesize] = bufptr[linesize];
170  s->dstptr[linesize + 1] = bufptr[linesize + 1];
171 
172  return 0;
173 }
174 
175 /**
176  * Return the next nibble in sequence, consuming a new byte on the input
177  * only if necessary.
178  */
180 {
181  int ret;
182 
183  if (s->low_nibble) {
184  ret = *s->low_nibble & 0xf;
185  s->low_nibble = NULL;
186  }else {
187  s->low_nibble = s->srcptr++;
188  ret = *s->low_nibble >> 4;
189  }
190  return ret;
191 }
192 
193 static int yop_decode_frame(AVCodecContext *avctx, AVFrame *rframe,
194  int *got_frame, AVPacket *avpkt)
195 {
196  YopDecContext *s = avctx->priv_data;
197  AVFrame *frame = s->frame;
198  int tag, firstcolor, is_odd_frame;
199  int ret, i, x, y;
200  uint32_t *palette;
201 
202  if (avpkt->size < 4 + 3 * s->num_pal_colors) {
203  av_log(avctx, AV_LOG_ERROR, "Packet too small.\n");
204  return AVERROR_INVALIDDATA;
205  }
206 
207  if ((ret = ff_reget_buffer(avctx, frame, 0)) < 0)
208  return ret;
209 
210  if (!avctx->frame_num)
211  memset(frame->data[1], 0, AVPALETTE_SIZE);
212 
213  s->dstbuf = frame->data[0];
214  s->dstptr = frame->data[0];
215  s->srcptr = avpkt->data + 4;
216  s->src_end = avpkt->data + avpkt->size;
217  s->low_nibble = NULL;
218 
219  is_odd_frame = avpkt->data[0];
220  if(is_odd_frame>1){
221  av_log(avctx, AV_LOG_ERROR, "frame is too odd %d\n", is_odd_frame);
222  return AVERROR_INVALIDDATA;
223  }
224  firstcolor = s->first_color[is_odd_frame];
225  palette = (uint32_t *)frame->data[1];
226 
227  for (i = 0; i < s->num_pal_colors; i++, s->srcptr += 3) {
228  palette[i + firstcolor] = (s->srcptr[0] << 18) |
229  (s->srcptr[1] << 10) |
230  (s->srcptr[2] << 2);
231  palette[i + firstcolor] |= 0xFFU << 24 |
232  (palette[i + firstcolor] >> 6) & 0x30303;
233  }
234 
235 #if FF_API_PALETTE_HAS_CHANGED
239 #endif
240 
241  for (y = 0; y < avctx->height; y += 2) {
242  for (x = 0; x < avctx->width; x += 2) {
243  if (s->srcptr - avpkt->data >= avpkt->size) {
244  av_log(avctx, AV_LOG_ERROR, "Packet too small.\n");
245  return AVERROR_INVALIDDATA;
246  }
247 
249 
250  if (tag != 0xf) {
252  if (ret < 0)
253  return ret;
254  } else {
257  if (ret < 0)
258  return ret;
259  }
260  s->dstptr += 2;
261  }
262  s->dstptr += 2*frame->linesize[0] - x;
263  }
264 
265  if ((ret = av_frame_ref(rframe, s->frame)) < 0)
266  return ret;
267 
268  *got_frame = 1;
269  return avpkt->size;
270 }
271 
273  .p.name = "yop",
274  CODEC_LONG_NAME("Psygnosis YOP Video"),
275  .p.type = AVMEDIA_TYPE_VIDEO,
276  .p.id = AV_CODEC_ID_YOP,
277  .priv_data_size = sizeof(YopDecContext),
279  .close = yop_decode_close,
281 };
FF_ENABLE_DEPRECATION_WARNINGS
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:73
YopDecContext::num_pal_colors
int num_pal_colors
Definition: yop.c:38
AVFrame::palette_has_changed
attribute_deprecated int palette_has_changed
Tell user application that palette has changed from previous frame.
Definition: frame.h:533
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
ff_yop_decoder
const FFCodec ff_yop_decoder
Definition: yop.c:272
YopDecContext::src_end
const uint8_t * src_end
Definition: yop.c:44
yop_get_next_nibble
static uint8_t yop_get_next_nibble(YopDecContext *s)
Return the next nibble in sequence, consuming a new byte on the input only if necessary.
Definition: yop.c:179
YopDecContext::dstbuf
uint8_t * dstbuf
Definition: yop.c:46
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:88
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:340
AVPacket::data
uint8_t * data
Definition: packet.h:522
YopDecContext::first_color
int first_color[2]
Definition: yop.c:39
FFCodec
Definition: codec_internal.h:127
AV_CODEC_ID_YOP
@ AV_CODEC_ID_YOP
Definition: codec_id.h:191
paint_lut
static const uint8_t paint_lut[15][4]
Lookup table for painting macroblocks.
Definition: yop.c:58
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:361
YopDecContext::avctx
AVCodecContext * avctx
Definition: yop.c:35
YopDecContext::low_nibble
const uint8_t * low_nibble
Definition: yop.c:42
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:131
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:76
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
AVCodecContext::extradata_size
int extradata_size
Definition: avcodec.h:524
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:287
s
#define s(width, name)
Definition: cbs_vp9.c:198
YopDecContext::dstptr
uint8_t * dstptr
Definition: yop.c:45
decode.h
motion_vector
static const int8_t motion_vector[16][2]
Lookup table for copying macroblocks.
Definition: yop.c:73
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:272
frame
static AVFrame * frame
Definition: demux_decode.c:54
NULL
#define NULL
Definition: coverity.c:32
AVPALETTE_SIZE
#define AVPALETTE_SIZE
Definition: pixfmt.h:32
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:365
AVPacket::size
int size
Definition: packet.h:523
av_frame_ref
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
Definition: frame.c:312
codec_internal.h
for
for(k=2;k<=8;++k)
Definition: h264pred_template.c:425
YopDecContext::srcptr
const uint8_t * srcptr
Definition: yop.c:43
yop_decode_close
static av_cold int yop_decode_close(AVCodecContext *avctx)
Definition: yop.c:84
yop_decode_init
static av_cold int yop_decode_init(AVCodecContext *avctx)
Definition: yop.c:93
YopDecContext::frame
AVFrame * frame
Definition: yop.c:36
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:255
AVCodecContext::extradata
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:523
internal.h
xf
#define xf(width, name, var, range_min, range_max, subs,...)
Definition: cbs_av1.c:590
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:194
AVCodecContext::height
int height
Definition: avcodec.h:618
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:657
YopDecContext
Definition: yop.c:34
avcodec.h
AV_PIX_FMT_PAL8
@ AV_PIX_FMT_PAL8
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:84
AVCodecContext::frame_num
int64_t frame_num
Frame counter, set by libavcodec.
Definition: avcodec.h:2030
YopDecContext::frame_data_length
int frame_data_length
Definition: yop.c:40
tag
uint32_t tag
Definition: movenc.c:1786
ff_reget_buffer
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Identical in function to ff_get_buffer(), except it reuses the existing buffer if available.
Definition: decode.c:1677
ret
ret
Definition: filter_design.txt:187
U
#define U(x)
Definition: vpx_arith.h:37
yop_copy_previous_block
static int yop_copy_previous_block(YopDecContext *s, int linesize, int copy_tag)
Copy a previously painted macroblock to the current_block.
Definition: yop.c:155
AVCodecContext
main external API structure.
Definition: avcodec.h:445
FF_DISABLE_DEPRECATION_WARNINGS
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:72
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVPacket
This structure stores compressed data.
Definition: packet.h:499
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:472
yop_paint_block
static int yop_paint_block(YopDecContext *s, int linesize, int tag)
Paint a macroblock using the pattern in paint_lut.
Definition: yop.c:134
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:618
imgutils.h
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:385
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
av_image_check_size
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
Check if the given dimension of an image is valid, meaning that all bytes of the image can be address...
Definition: imgutils.c:318
yop_decode_frame
static int yop_decode_frame(AVCodecContext *avctx, AVFrame *rframe, int *got_frame, AVPacket *avpkt)
Definition: yop.c:193
copy_tag
static int copy_tag(AVIOContext *in, AVIOContext *out, int32_t tag_name)
Definition: ismindex.c:107