2 * Cinepak Video Decoder
3 * Copyright (C) 2003 the ffmpeg project
5 * This file is part of FFmpeg.
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.
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.
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
24 * Cinepak video decoder
25 * @author Ewald Snel <ewald@rambo.its.tudelft.nl>
27 * @see For more information on the Cinepak algorithm, visit:
28 * http://www.csse.monash.edu.au/~timf/
29 * @see For more information on the quirky data inside Sega FILM/CPK files, visit:
30 * http://wiki.multimedia.cx/index.php?title=Sega_FILM
32 * Cinepak colorspace support (c) 2013 Rl, Aetey Global Technologies AB
33 * @author Cinepak colorspace, Rl, Aetey Global Technologies AB
40 #include "libavutil/common.h"
41 #include "libavutil/intreadwrite.h"
45 typedef uint8_t cvid_codebook[12];
53 cvid_codebook v4_codebook[256];
54 cvid_codebook v1_codebook[256];
57 typedef struct CinepakContext {
59 AVCodecContext *avctx;
62 const unsigned char *data;
68 cvid_strip strips[MAX_STRIPS];
70 int sega_film_skip_bytes;
75 static void cinepak_decode_codebook (cvid_codebook *codebook,
76 int chunk_id, int size, const uint8_t *data)
78 const uint8_t *eod = (data + size);
83 /* check if this chunk contains 4- or 6-element vectors */
84 n = (chunk_id & 0x04) ? 4 : 6;
89 for (i=0; i < 256; i++) {
90 if ((chunk_id & 0x01) && !(mask >>= 1)) {
94 flag = AV_RB32 (data);
99 if (!(chunk_id & 0x01) || (flag & mask)) {
102 if ((data + n) > eod)
105 for (k = 0; k < 4; ++k) {
107 for (kk = 0; kk < 3; ++kk)
112 u = *(int8_t *)data++;
113 v = *(int8_t *)data++;
117 g = *p++ - (u/2) - v;
120 *p++ = av_clip_uint8(r);
121 *p++ = av_clip_uint8(g);
122 *p++ = av_clip_uint8(b);
125 /* this codebook type indicates either greyscale or
126 * palettized video, it is already stored as grey rgb24
127 * which makes it robust even when the frame is considered
136 static int cinepak_decode_vectors (CinepakContext *s, cvid_strip *strip,
137 int chunk_id, int size, const uint8_t *data)
139 const uint8_t *eod = (data + size);
141 uint8_t *cb0, *cb1, *cb2, *cb3;
143 char *ip0, *ip1, *ip2, *ip3;
148 for (y=strip->y1; y < strip->y2; y+=4) {
150 /* take care of y dimension not being multiple of 4, such streams exist */
151 ip0 = ip1 = ip2 = ip3 = s->frame.data[0] +
152 (s->palette_video?strip->x1:strip->x1*3) + (y * s->frame.linesize[0]);
153 if(s->avctx->height - y > 1) {
154 ip1 = ip0 + s->frame.linesize[0];
155 if(s->avctx->height - y > 2) {
156 ip2 = ip1 + s->frame.linesize[0];
157 if(s->avctx->height - y > 3) {
158 ip3 = ip2 + s->frame.linesize[0];
162 /* to get the correct picture for not-multiple-of-4 cases let us fill
163 * each block from the bottom up, thus possibly overwriting the top line
164 * more than once but ending with the correct data in place
165 * (instead of in-loop checking) */
167 for (x=strip->x1; x < strip->x2; x+=4) {
168 if ((chunk_id & 0x01) && !(mask >>= 1)) {
169 if ((data + 4) > eod)
170 return AVERROR_INVALIDDATA;
172 flag = AV_RB32 (data);
177 if (!(chunk_id & 0x01) || (flag & mask)) {
178 if (!(chunk_id & 0x02) && !(mask >>= 1)) {
179 if ((data + 4) > eod)
180 return AVERROR_INVALIDDATA;
182 flag = AV_RB32 (data);
187 if ((chunk_id & 0x02) || (~flag & mask)) {
190 return AVERROR_INVALIDDATA;
192 p = strip->v1_codebook[*data++] + 6;
193 if (s->palette_video) {
194 *(ip3+0) = *(ip3+1) = *(ip2+0) = *(ip2+1) = *p;
195 p += 3; /* ... + 9 */
196 *(ip3+2) = *(ip3+3) = *(ip2+2) = *(ip2+3) = *p;
197 p -= 9; /* ... + 0 */
198 *(ip1+0) = *(ip1+1) = *(ip0+0) = *(ip0+1) = *p;
199 p += 3; /* ... + 3 */
200 *(ip1+2) = *(ip1+3) = *(ip0+2) = *(ip0+3) = *p;
202 memcpy(ip3 + 0, p, 3); memcpy(ip3 + 3, p, 3);
203 memcpy(ip2 + 0, p, 3); memcpy(ip2 + 3, p, 3);
204 p += 3; /* ... + 9 */
205 memcpy(ip3 + 6, p, 3); memcpy(ip3 + 9, p, 3);
206 memcpy(ip2 + 6, p, 3); memcpy(ip2 + 9, p, 3);
207 p -= 9; /* ... + 0 */
208 memcpy(ip1 + 0, p, 3); memcpy(ip1 + 3, p, 3);
209 memcpy(ip0 + 0, p, 3); memcpy(ip0 + 3, p, 3);
210 p += 3; /* ... + 3 */
211 memcpy(ip1 + 6, p, 3); memcpy(ip1 + 9, p, 3);
212 memcpy(ip0 + 6, p, 3); memcpy(ip0 + 9, p, 3);
215 } else if (flag & mask) {
216 if ((data + 4) > eod)
217 return AVERROR_INVALIDDATA;
219 cb0 = strip->v4_codebook[*data++];
220 cb1 = strip->v4_codebook[*data++];
221 cb2 = strip->v4_codebook[*data++];
222 cb3 = strip->v4_codebook[*data++];
223 if (s->palette_video) {
246 memcpy(ip3 + 0, cb2 + 6, 6);
247 memcpy(ip3 + 6, cb3 + 6, 6);
248 memcpy(ip2 + 0, cb2 + 0, 6);
249 memcpy(ip2 + 6, cb3 + 0, 6);
250 memcpy(ip1 + 0, cb0 + 6, 6);
251 memcpy(ip1 + 6, cb1 + 6, 6);
252 memcpy(ip0 + 0, cb0 + 0, 6);
253 memcpy(ip0 + 6, cb1 + 0, 6);
259 if (s->palette_video) {
263 ip0 += 12; ip1 += 12;
264 ip2 += 12; ip3 += 12;
272 static int cinepak_decode_strip (CinepakContext *s,
273 cvid_strip *strip, const uint8_t *data, int size)
275 const uint8_t *eod = (data + size);
276 int chunk_id, chunk_size;
278 /* coordinate sanity checks */
279 if (strip->x2 > s->width ||
280 strip->y2 > s->height ||
281 strip->x1 >= strip->x2 || strip->y1 >= strip->y2)
282 return AVERROR_INVALIDDATA;
284 while ((data + 4) <= eod) {
286 chunk_size = AV_RB24 (&data[1]) - 4;
288 return AVERROR_INVALIDDATA;
291 chunk_size = ((data + chunk_size) > eod) ? (eod - data) : chunk_size;
299 cinepak_decode_codebook (strip->v4_codebook, chunk_id,
307 cinepak_decode_codebook (strip->v1_codebook, chunk_id,
314 return cinepak_decode_vectors (s, strip, chunk_id,
321 return AVERROR_INVALIDDATA;
324 static int cinepak_decode (CinepakContext *s)
326 const uint8_t *eod = (s->data + s->size);
327 int i, result, strip_size, frame_flags, num_strips;
329 int encoded_buf_size;
332 return AVERROR_INVALIDDATA;
334 frame_flags = s->data[0];
335 num_strips = AV_RB16 (&s->data[8]);
336 encoded_buf_size = AV_RB24(&s->data[1]);
338 /* if this is the first frame, check for deviant Sega FILM data */
339 if (s->sega_film_skip_bytes == -1) {
340 if (!encoded_buf_size) {
341 av_log_ask_for_sample(s->avctx, "encoded_buf_size is 0");
342 return AVERROR_PATCHWELCOME;
344 if (encoded_buf_size != s->size && (s->size % encoded_buf_size) != 0) {
345 /* If the encoded frame size differs from the frame size as indicated
346 * by the container file, this data likely comes from a Sega FILM/CPK file.
347 * If the frame header is followed by the bytes FE 00 00 06 00 00 then
348 * this is probably one of the two known files that have 6 extra bytes
349 * after the frame header. Else, assume 2 extra bytes. The container
350 * size also cannot be a multiple of the encoded size. */
352 (s->data[10] == 0xFE) &&
353 (s->data[11] == 0x00) &&
354 (s->data[12] == 0x00) &&
355 (s->data[13] == 0x06) &&
356 (s->data[14] == 0x00) &&
357 (s->data[15] == 0x00))
358 s->sega_film_skip_bytes = 6;
360 s->sega_film_skip_bytes = 2;
362 s->sega_film_skip_bytes = 0;
365 s->data += 10 + s->sega_film_skip_bytes;
367 num_strips = FFMIN(num_strips, MAX_STRIPS);
369 s->frame.key_frame = 0;
371 for (i=0; i < num_strips; i++) {
372 if ((s->data + 12) > eod)
373 return AVERROR_INVALIDDATA;
375 s->strips[i].id = s->data[0];
376 s->strips[i].y1 = y0;
378 s->strips[i].y2 = y0 + AV_RB16 (&s->data[8]);
379 s->strips[i].x2 = s->avctx->width;
381 if (s->strips[i].id == 0x10)
382 s->frame.key_frame = 1;
384 strip_size = AV_RB24 (&s->data[1]) - 12;
386 return AVERROR_INVALIDDATA;
388 strip_size = ((s->data + strip_size) > eod) ? (eod - s->data) : strip_size;
390 if ((i > 0) && !(frame_flags & 0x01)) {
391 memcpy (s->strips[i].v4_codebook, s->strips[i-1].v4_codebook,
392 sizeof(s->strips[i].v4_codebook));
393 memcpy (s->strips[i].v1_codebook, s->strips[i-1].v1_codebook,
394 sizeof(s->strips[i].v1_codebook));
397 result = cinepak_decode_strip (s, &s->strips[i], s->data, strip_size);
402 s->data += strip_size;
403 y0 = s->strips[i].y2;
408 static av_cold int cinepak_decode_init(AVCodecContext *avctx)
410 CinepakContext *s = avctx->priv_data;
413 s->width = (avctx->width + 3) & ~3;
414 s->height = (avctx->height + 3) & ~3;
415 s->sega_film_skip_bytes = -1; /* uninitialized state */
417 // check for paletted data
418 if (avctx->bits_per_coded_sample != 8) {
419 s->palette_video = 0;
420 avctx->pix_fmt = AV_PIX_FMT_RGB24;
422 s->palette_video = 1;
423 avctx->pix_fmt = AV_PIX_FMT_PAL8;
426 avcodec_get_frame_defaults(&s->frame);
427 s->frame.data[0] = NULL;
432 static int cinepak_decode_frame(AVCodecContext *avctx,
433 void *data, int *got_frame,
436 const uint8_t *buf = avpkt->data;
437 int ret = 0, buf_size = avpkt->size;
438 CinepakContext *s = avctx->priv_data;
443 s->frame.reference = 3;
444 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE |
445 FF_BUFFER_HINTS_REUSABLE;
446 if ((ret = avctx->reget_buffer(avctx, &s->frame))) {
447 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
451 if (s->palette_video) {
452 const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
454 s->frame.palette_has_changed = 1;
455 memcpy(s->pal, pal, AVPALETTE_SIZE);
459 if ((ret = cinepak_decode(s)) < 0) {
460 av_log(avctx, AV_LOG_ERROR, "cinepak_decode failed\n");
463 if (s->palette_video)
464 memcpy (s->frame.data[1], s->pal, AVPALETTE_SIZE);
467 *(AVFrame*)data = s->frame;
469 /* report that the buffer was completely consumed */
473 static av_cold int cinepak_decode_end(AVCodecContext *avctx)
475 CinepakContext *s = avctx->priv_data;
477 if (s->frame.data[0])
478 avctx->release_buffer(avctx, &s->frame);
483 AVCodec ff_cinepak_decoder = {
485 .type = AVMEDIA_TYPE_VIDEO,
486 .id = AV_CODEC_ID_CINEPAK,
487 .priv_data_size = sizeof(CinepakContext),
488 .init = cinepak_decode_init,
489 .close = cinepak_decode_end,
490 .decode = cinepak_decode_frame,
491 .capabilities = CODEC_CAP_DR1,
492 .long_name = NULL_IF_CONFIG_SMALL("Cinepak"),