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"
46 typedef uint8_t cvid_codebook
[12];
54 cvid_codebook v4_codebook
[256];
55 cvid_codebook v1_codebook
[256];
58 typedef struct CinepakContext
{
60 AVCodecContext
*avctx
;
63 const unsigned char *data
;
69 cvid_strip strips
[MAX_STRIPS
];
71 int sega_film_skip_bytes
;
76 static void cinepak_decode_codebook (cvid_codebook
*codebook
,
77 int chunk_id
, int size
, const uint8_t *data
)
79 const uint8_t *eod
= (data
+ size
);
84 /* check if this chunk contains 4- or 6-element vectors */
85 n
= (chunk_id
& 0x04) ? 4 : 6;
90 for (i
=0; i
< 256; i
++) {
91 if ((chunk_id
& 0x01) && !(mask
>>= 1)) {
95 flag
= AV_RB32 (data
);
100 if (!(chunk_id
& 0x01) || (flag
& mask
)) {
103 if ((data
+ n
) > eod
)
106 for (k
= 0; k
< 4; ++k
) {
108 for (kk
= 0; kk
< 3; ++kk
)
113 u
= *(int8_t *)data
++;
114 v
= *(int8_t *)data
++;
118 g
= *p
++ - (u
/2) - v
;
121 *p
++ = av_clip_uint8(r
);
122 *p
++ = av_clip_uint8(g
);
123 *p
++ = av_clip_uint8(b
);
132 static int cinepak_decode_vectors (CinepakContext
*s
, cvid_strip
*strip
,
133 int chunk_id
, int size
, const uint8_t *data
)
135 const uint8_t *eod
= (data
+ size
);
137 uint8_t *cb0
, *cb1
, *cb2
, *cb3
;
139 char *ip0
, *ip1
, *ip2
, *ip3
;
144 for (y
=strip
->y1
; y
< strip
->y2
; y
+=4) {
146 /* take care of y dimension not being multiple of 4, such streams exist */
147 ip0
= ip1
= ip2
= ip3
= s
->frame
->data
[0] +
148 (s
->palette_video
?strip
->x1
:strip
->x1
*3) + (y
* s
->frame
->linesize
[0]);
149 if(s
->avctx
->height
- y
> 1) {
150 ip1
= ip0
+ s
->frame
->linesize
[0];
151 if(s
->avctx
->height
- y
> 2) {
152 ip2
= ip1
+ s
->frame
->linesize
[0];
153 if(s
->avctx
->height
- y
> 3) {
154 ip3
= ip2
+ s
->frame
->linesize
[0];
158 /* to get the correct picture for not-multiple-of-4 cases let us fill
159 * each block from the bottom up, thus possibly overwriting the top line
160 * more than once but ending with the correct data in place
161 * (instead of in-loop checking) */
163 for (x
=strip
->x1
; x
< strip
->x2
; x
+=4) {
164 if ((chunk_id
& 0x01) && !(mask
>>= 1)) {
165 if ((data
+ 4) > eod
)
166 return AVERROR_INVALIDDATA
;
168 flag
= AV_RB32 (data
);
173 if (!(chunk_id
& 0x01) || (flag
& mask
)) {
174 if (!(chunk_id
& 0x02) && !(mask
>>= 1)) {
175 if ((data
+ 4) > eod
)
176 return AVERROR_INVALIDDATA
;
178 flag
= AV_RB32 (data
);
183 if ((chunk_id
& 0x02) || (~flag
& mask
)) {
186 return AVERROR_INVALIDDATA
;
188 p
= strip
->v1_codebook
[*data
++];
189 if (s
->palette_video
) {
190 ip3
[0] = ip3
[1] = ip2
[0] = ip2
[1] = p
[6];
191 ip3
[2] = ip3
[3] = ip2
[2] = ip2
[3] = p
[9];
192 ip1
[0] = ip1
[1] = ip0
[0] = ip0
[1] = p
[0];
193 ip1
[2] = ip1
[3] = ip0
[2] = ip0
[3] = p
[3];
196 memcpy(ip3
+ 0, p
, 3); memcpy(ip3
+ 3, p
, 3);
197 memcpy(ip2
+ 0, p
, 3); memcpy(ip2
+ 3, p
, 3);
198 p
+= 3; /* ... + 9 */
199 memcpy(ip3
+ 6, p
, 3); memcpy(ip3
+ 9, p
, 3);
200 memcpy(ip2
+ 6, p
, 3); memcpy(ip2
+ 9, p
, 3);
201 p
-= 9; /* ... + 0 */
202 memcpy(ip1
+ 0, p
, 3); memcpy(ip1
+ 3, p
, 3);
203 memcpy(ip0
+ 0, p
, 3); memcpy(ip0
+ 3, p
, 3);
204 p
+= 3; /* ... + 3 */
205 memcpy(ip1
+ 6, p
, 3); memcpy(ip1
+ 9, p
, 3);
206 memcpy(ip0
+ 6, p
, 3); memcpy(ip0
+ 9, p
, 3);
209 } else if (flag
& mask
) {
210 if ((data
+ 4) > eod
)
211 return AVERROR_INVALIDDATA
;
213 cb0
= strip
->v4_codebook
[*data
++];
214 cb1
= strip
->v4_codebook
[*data
++];
215 cb2
= strip
->v4_codebook
[*data
++];
216 cb3
= strip
->v4_codebook
[*data
++];
217 if (s
->palette_video
) {
240 memcpy(ip3
+ 0, cb2
+ 6, 6);
241 memcpy(ip3
+ 6, cb3
+ 6, 6);
242 memcpy(ip2
+ 0, cb2
+ 0, 6);
243 memcpy(ip2
+ 6, cb3
+ 0, 6);
244 memcpy(ip1
+ 0, cb0
+ 6, 6);
245 memcpy(ip1
+ 6, cb1
+ 6, 6);
246 memcpy(ip0
+ 0, cb0
+ 0, 6);
247 memcpy(ip0
+ 6, cb1
+ 0, 6);
253 if (s
->palette_video
) {
257 ip0
+= 12; ip1
+= 12;
258 ip2
+= 12; ip3
+= 12;
266 static int cinepak_decode_strip (CinepakContext
*s
,
267 cvid_strip
*strip
, const uint8_t *data
, int size
)
269 const uint8_t *eod
= (data
+ size
);
270 int chunk_id
, chunk_size
;
272 /* coordinate sanity checks */
273 if (strip
->x2
> s
->width
||
274 strip
->y2
> s
->height
||
275 strip
->x1
>= strip
->x2
|| strip
->y1
>= strip
->y2
)
276 return AVERROR_INVALIDDATA
;
278 while ((data
+ 4) <= eod
) {
280 chunk_size
= AV_RB24 (&data
[1]) - 4;
282 return AVERROR_INVALIDDATA
;
285 chunk_size
= ((data
+ chunk_size
) > eod
) ? (eod
- data
) : chunk_size
;
293 cinepak_decode_codebook (strip
->v4_codebook
, chunk_id
,
301 cinepak_decode_codebook (strip
->v1_codebook
, chunk_id
,
308 return cinepak_decode_vectors (s
, strip
, chunk_id
,
315 return AVERROR_INVALIDDATA
;
318 static int cinepak_decode (CinepakContext
*s
)
320 const uint8_t *eod
= (s
->data
+ s
->size
);
321 int i
, result
, strip_size
, frame_flags
, num_strips
;
323 int encoded_buf_size
;
326 return AVERROR_INVALIDDATA
;
328 frame_flags
= s
->data
[0];
329 num_strips
= AV_RB16 (&s
->data
[8]);
330 encoded_buf_size
= AV_RB24(&s
->data
[1]);
332 /* if this is the first frame, check for deviant Sega FILM data */
333 if (s
->sega_film_skip_bytes
== -1) {
334 if (!encoded_buf_size
) {
335 avpriv_request_sample(s
->avctx
, "encoded_buf_size 0");
336 return AVERROR_PATCHWELCOME
;
338 if (encoded_buf_size
!= s
->size
&& (s
->size
% encoded_buf_size
) != 0) {
339 /* If the encoded frame size differs from the frame size as indicated
340 * by the container file, this data likely comes from a Sega FILM/CPK file.
341 * If the frame header is followed by the bytes FE 00 00 06 00 00 then
342 * this is probably one of the two known files that have 6 extra bytes
343 * after the frame header. Else, assume 2 extra bytes. The container
344 * size also cannot be a multiple of the encoded size. */
346 (s
->data
[10] == 0xFE) &&
347 (s
->data
[11] == 0x00) &&
348 (s
->data
[12] == 0x00) &&
349 (s
->data
[13] == 0x06) &&
350 (s
->data
[14] == 0x00) &&
351 (s
->data
[15] == 0x00))
352 s
->sega_film_skip_bytes
= 6;
354 s
->sega_film_skip_bytes
= 2;
356 s
->sega_film_skip_bytes
= 0;
359 s
->data
+= 10 + s
->sega_film_skip_bytes
;
361 num_strips
= FFMIN(num_strips
, MAX_STRIPS
);
363 s
->frame
->key_frame
= 0;
365 for (i
=0; i
< num_strips
; i
++) {
366 if ((s
->data
+ 12) > eod
)
367 return AVERROR_INVALIDDATA
;
369 s
->strips
[i
].id
= s
->data
[0];
370 /* zero y1 means "relative to the previous stripe" */
371 if (!(s
->strips
[i
].y1
= AV_RB16 (&s
->data
[4])))
372 s
->strips
[i
].y2
= (s
->strips
[i
].y1
= y0
) + AV_RB16 (&s
->data
[8]);
374 s
->strips
[i
].y2
= AV_RB16 (&s
->data
[8]);
375 s
->strips
[i
].x1
= AV_RB16 (&s
->data
[6]);
376 s
->strips
[i
].x2
= AV_RB16 (&s
->data
[10]);
378 if (s
->strips
[i
].id
== 0x10)
379 s
->frame
->key_frame
= 1;
381 strip_size
= AV_RB24 (&s
->data
[1]) - 12;
383 return AVERROR_INVALIDDATA
;
385 strip_size
= ((s
->data
+ strip_size
) > eod
) ? (eod
- s
->data
) : strip_size
;
387 if ((i
> 0) && !(frame_flags
& 0x01)) {
388 memcpy (s
->strips
[i
].v4_codebook
, s
->strips
[i
-1].v4_codebook
,
389 sizeof(s
->strips
[i
].v4_codebook
));
390 memcpy (s
->strips
[i
].v1_codebook
, s
->strips
[i
-1].v1_codebook
,
391 sizeof(s
->strips
[i
].v1_codebook
));
394 result
= cinepak_decode_strip (s
, &s
->strips
[i
], s
->data
, strip_size
);
399 s
->data
+= strip_size
;
400 y0
= s
->strips
[i
].y2
;
405 static av_cold
int cinepak_decode_init(AVCodecContext
*avctx
)
407 CinepakContext
*s
= avctx
->priv_data
;
410 s
->width
= (avctx
->width
+ 3) & ~3;
411 s
->height
= (avctx
->height
+ 3) & ~3;
413 s
->sega_film_skip_bytes
= -1; /* uninitialized state */
415 // check for paletted data
416 if (avctx
->bits_per_coded_sample
!= 8) {
417 s
->palette_video
= 0;
418 avctx
->pix_fmt
= AV_PIX_FMT_RGB24
;
420 s
->palette_video
= 1;
421 avctx
->pix_fmt
= AV_PIX_FMT_PAL8
;
424 s
->frame
= av_frame_alloc();
426 return AVERROR(ENOMEM
);
431 static int cinepak_decode_frame(AVCodecContext
*avctx
,
432 void *data
, int *got_frame
,
435 const uint8_t *buf
= avpkt
->data
;
436 int ret
= 0, buf_size
= avpkt
->size
;
437 CinepakContext
*s
= avctx
->priv_data
;
442 if ((ret
= ff_reget_buffer(avctx
, s
->frame
)) < 0)
445 if (s
->palette_video
) {
446 const uint8_t *pal
= av_packet_get_side_data(avpkt
, AV_PKT_DATA_PALETTE
, NULL
);
448 s
->frame
->palette_has_changed
= 1;
449 memcpy(s
->pal
, pal
, AVPALETTE_SIZE
);
453 if ((ret
= cinepak_decode(s
)) < 0) {
454 av_log(avctx
, AV_LOG_ERROR
, "cinepak_decode failed\n");
457 if (s
->palette_video
)
458 memcpy (s
->frame
->data
[1], s
->pal
, AVPALETTE_SIZE
);
460 if ((ret
= av_frame_ref(data
, s
->frame
)) < 0)
465 /* report that the buffer was completely consumed */
469 static av_cold
int cinepak_decode_end(AVCodecContext
*avctx
)
471 CinepakContext
*s
= avctx
->priv_data
;
473 av_frame_free(&s
->frame
);
478 AVCodec ff_cinepak_decoder
= {
480 .long_name
= NULL_IF_CONFIG_SMALL("Cinepak"),
481 .type
= AVMEDIA_TYPE_VIDEO
,
482 .id
= AV_CODEC_ID_CINEPAK
,
483 .priv_data_size
= sizeof(CinepakContext
),
484 .init
= cinepak_decode_init
,
485 .close
= cinepak_decode_end
,
486 .decode
= cinepak_decode_frame
,
487 .capabilities
= CODEC_CAP_DR1
,