1 /*****************************************************************************
2 * cinepak.c: cinepak video decoder
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
5 * $Id: cinepak.c,v 1.6 2003/11/23 13:25:32 gbazin Exp $
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
29 #include <vlc/decoder.h>
31 /*****************************************************************************
33 *****************************************************************************/
34 static int OpenDecoder ( vlc_object_t * );
35 static void CloseDecoder( vlc_object_t * );
38 set_description( _("Cinepak video decoder") );
39 set_capability( "decoder", 100 );
40 set_callbacks( OpenDecoder, CloseDecoder );
44 /*****************************************************************************
46 *****************************************************************************/
47 #define CINEPAK_MAXSTRIP 32
58 int b_grayscale; /* force to grayscale */
66 uint8_t *p_y, *p_u, *p_v;
68 int i_stride[3]; /* our 3 planes */
72 cinepak_codebook_t codebook_v1[CINEPAK_MAXSTRIP][256];
73 cinepak_codebook_t codebook_v4[CINEPAK_MAXSTRIP][256];
77 /*****************************************************************************
78 * decoder_sys_t : decoder descriptor
79 *****************************************************************************/
85 cinepak_context_t context;
88 static picture_t *DecodeBlock ( decoder_t *, block_t ** );
90 static int cinepak_decode_frame( cinepak_context_t *, int, uint8_t * );
92 /*****************************************************************************
93 * OpenDecoder: probe the decoder and return score
94 *****************************************************************************
95 * Tries to launch a decoder and return score so that the interface is able
97 *****************************************************************************/
98 static int OpenDecoder( vlc_object_t *p_this )
100 decoder_t *p_dec = (decoder_t*)p_this;
101 decoder_sys_t *p_sys;
104 if( p_dec->fmt_in.i_codec != VLC_FOURCC('c','v','i','d') &&
105 p_dec->fmt_in.i_codec != VLC_FOURCC('C','V','I','D') )
110 /* Allocate the memory needed to store the decoder's structure */
111 if( ( p_dec->p_sys = p_sys = malloc(sizeof(decoder_sys_t)) ) == NULL )
113 msg_Err( p_dec, "out of memory" );
116 memset( &p_sys->context, 0, sizeof( cinepak_context_t ) );
118 var_Create( p_dec, "grayscale", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
119 var_Get( p_dec, "grayscale", &val );
120 p_sys->context.b_grayscale = val.b_bool;
122 p_dec->pf_decode_video = DecodeBlock;
124 msg_Dbg( p_dec, "cinepak decoder started" );
129 /****************************************************************************
130 * DecodeBlock: the whole thing
131 ****************************************************************************
132 * This function must be fed with whole frames.
133 ****************************************************************************/
134 static picture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
136 decoder_sys_t *p_sys = p_dec->p_sys;
137 int i_status, i_plane;
138 uint8_t *p_dst, *p_src;
142 if( !pp_block || !*pp_block )
149 i_status = cinepak_decode_frame( &p_sys->context, p_block->i_buffer,
153 msg_Warn( p_dec, "cannot decode one frame (%d bytes)",
155 block_Release( p_block );
159 p_dec->fmt_out.video.i_width = p_sys->context.i_width;
160 p_dec->fmt_out.video.i_height = p_sys->context.i_height;
161 p_dec->fmt_out.video.i_aspect = p_sys->context.i_width
162 * VOUT_ASPECT_FACTOR / p_sys->context.i_height;
163 p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0');
165 /* Get a new picture */
166 if( ( p_pic = p_dec->pf_vout_buffer_new( p_dec ) ) )
168 for( i_plane = 0; i_plane < 3; i_plane++ )
172 p_dst = p_pic->p[i_plane].p_pixels;
173 p_src = p_sys->context.p_pix[i_plane];
175 i_lines = __MIN( p_sys->context.i_lines[i_plane],
176 p_pic->p[i_plane].i_lines );
177 for( i_line = 0; i_line < i_lines; i_line++ )
179 memcpy( p_dst, p_src,
180 __MIN( p_pic->p[i_plane].i_pitch,
181 p_sys->context.i_stride[i_plane] ) );
182 p_dst += p_pic->p[i_plane].i_pitch;
183 p_src += p_sys->context.i_stride[i_plane];
187 p_pic->date = p_block->i_pts ? p_block->i_pts : p_block->i_dts;
190 block_Release( p_block );
194 /*****************************************************************************
195 * CloseDecoder: decoder destruction
196 *****************************************************************************/
197 static void CloseDecoder( vlc_object_t *p_this )
199 decoder_t *p_dec = (decoder_t *)p_this;
200 decoder_sys_t *p_sys = p_dec->p_sys;
203 msg_Dbg( p_dec, "cinepak decoder stopped" );
205 for( i = 0; i < 3; i++ )
207 if( p_sys->context.p_pix[i] ) free( p_sys->context.p_pix[i] );
213 /*****************************************************************************
215 *****************************************************************************/
217 #define GET2BYTES( p ) \
220 #define GET3BYTES( p ) \
221 (GetDWBE( p ) >> 8); p+= 3;
223 #define GET4BYTES( p ) \
229 static void cinepak_LoadCodebook( cinepak_codebook_t *p_codebook,
230 uint8_t *p_data, int b_grayscale )
232 int i, i_y[4], i_u, i_v, i_Cb, i_Cr;
235 #define FIX( x ) ( (int)( (x) * ( 1L << SCALEBITS ) + 0.5 ) )
237 for( i = 0; i < 4; i++ )
239 i_y[i] = (uint8_t)( *(p_data++) );
243 i_u = (int8_t)( *(p_data++) );
244 i_v = (int8_t)( *(p_data++) );
253 | Y | | 1 -0.0655 0.0110 | | CY |
254 | Cb | = | 0 1.1656 -0.0062 | | CU |
255 | Cr | | 0 0.0467 1.4187 | | CV |
257 i_uv = ( FIX( -0.0655 ) * i_u + FIX( 0.0110 ) * i_v ) >> SCALEBITS;
258 for( i = 0; i < 4; i++ )
262 i_Cb = ( FIX( 1.1656 ) * i_u + FIX( -0.0062 ) * i_v ) >> SCALEBITS;
263 i_Cr = ( FIX( 0.0467 ) * i_u + FIX( 1.4187 ) * i_v ) >> SCALEBITS;
265 for( i = 0; i < 4; i++ )
267 p_codebook->i_y[i] = __MIN( __MAX( 0, i_y[i] ), 255 );
269 p_codebook->i_u = __MIN( __MAX( 0, i_Cb + 128 ), 255 );
270 p_codebook->i_v = __MIN( __MAX( 0, i_Cr + 128 ), 255 );
276 static void cinepak_Getv4( cinepak_context_t *p_context,
277 int i_strip, int i_x, int i_y,
278 int i_x2, int i_y2, uint8_t *p_data )
283 uint8_t *p_dst_y, *p_dst_u, *p_dst_v;
284 #define PIX_SET_Y( x, y, v ) \
285 p_dst_y[(x) + (y)* p_context->i_stride[0]] = (v);
287 #define PIX_SET_UV( i, p, x, y, v ) \
288 p[(x) + (y)* (p_context->i_stride[i])] = (v);
290 for( i = 0; i < 4; i++ )
292 i_index[i] = *(p_data++);
296 p_dst_y = p_context->p_pix[0] + p_context->i_stride[0] * i_y + i_x;
297 p_dst_u = p_context->p_pix[1] + p_context->i_stride[1] * (i_y/2) + (i_x/2);
298 p_dst_v = p_context->p_pix[2] + p_context->i_stride[2] * (i_y/2) + (i_x/2);
300 for( i = 0; i < 2; i++ )
302 for( j = 0; j < 2; j ++ )
304 PIX_SET_Y( 2*j + 0, 2*i + 0,
305 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[0]);
306 PIX_SET_Y( 2*j + 1, 2*i + 0,
307 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[1]);
308 PIX_SET_Y( 2*j + 0, 2*i + 1,
309 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[2]);
310 PIX_SET_Y( 2*j + 1, 2*i + 1,
311 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[3]);
313 PIX_SET_UV( 1, p_dst_u, j, i,
314 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_u );
315 PIX_SET_UV( 2, p_dst_v, j, i,
316 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_v );
323 static void cinepak_Getv1( cinepak_context_t *p_context,
324 int i_strip, int i_x, int i_y,
325 int i_x2, int i_y2, uint8_t *p_data )
330 uint8_t *p_dst_y, *p_dst_u, *p_dst_v;
331 #define PIX_SET_Y( x, y, v ) \
332 p_dst_y[(x) + (y)* p_context->i_stride[0]] = (v);
334 #define PIX_SET_UV( i,p, x, y, v ) \
335 p[(x) + (y)* (p_context->i_stride[i])] = (v);
337 i_index = *(p_data++);
340 p_dst_y = p_context->p_pix[0] + p_context->i_stride[0] * i_y + i_x;
341 p_dst_u = p_context->p_pix[1] + p_context->i_stride[1] * (i_y/2) + (i_x/2);
342 p_dst_v = p_context->p_pix[2] + p_context->i_stride[2] * (i_y/2) + (i_x/2);
344 for( i = 0; i < 2; i++ )
346 for( j = 0; j < 2; j ++ )
348 PIX_SET_Y( 2*j + 0, 2*i + 0,
349 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
350 PIX_SET_Y( 2*j + 1, 2*i + 0,
351 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
352 PIX_SET_Y( 2*j + 0, 2*i + 1,
353 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
354 PIX_SET_Y( 2*j + 1, 2*i + 1,
355 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
357 PIX_SET_UV( 1,p_dst_u, j, i,
358 p_context->codebook_v1[i_strip][i_index].i_u );
359 PIX_SET_UV( 2,p_dst_v, j, i,
360 p_context->codebook_v1[i_strip][i_index].i_v );
368 /*****************************************************************************
369 * The function that decode one frame
370 *****************************************************************************/
371 static int cinepak_decode_frame( cinepak_context_t *p_context,
372 int i_length, uint8_t *p_data )
378 int i_width, i_height;
381 int i_strip_x1 =0, i_strip_y1=0;
382 int i_strip_x2 =0, i_strip_y2=0;
386 /* Broken header or no data */
391 i_frame_flags = *(p_data++);
392 i_frame_size = GET3BYTES( p_data );
393 i_width = GET2BYTES( p_data );
394 i_height = GET2BYTES( p_data );
395 i_frame_strips = GET2BYTES( p_data );
397 if( !i_frame_size || !i_width || !i_height )
403 /* Check if we have a picture buffer with good size */
404 if( ( p_context->i_width != i_width ) ||
405 ( p_context->i_height != i_height ) )
408 for( i = 0; i < 3; i++ )
410 FREE( p_context->p_pix[i] );
413 p_context->i_width = i_width;
414 p_context->i_height = i_height;
416 p_context->i_stride[0] = ( i_width + 3 ) & 0xfffc;
417 p_context->i_stride[1] = p_context->i_stride[2] =
418 p_context->i_stride[0] / 2;
420 p_context->i_lines[0] = ( i_height + 3 ) & 0xfffc;
421 p_context->i_lines[1] = p_context->i_lines[2] =
422 p_context->i_lines[0] /2;
424 for( i = 0; i < 3; i++ )
426 p_context->p_pix[i] = malloc( p_context->i_stride[i] *
427 p_context->i_lines[i] );
428 /* Set it to all black */
429 memset( p_context->p_pix[i], ( i == 0 ) ? 0 : 128 ,
430 p_context->i_stride[i] * p_context->i_lines[i] );
434 if( i_frame_size != i_length )
436 i_length = __MIN( i_length, i_frame_size );
440 if( i_frame_strips >= CINEPAK_MAXSTRIP )
442 i_frame_strips = CINEPAK_MAXSTRIP;
445 /* Now decode each strip */
446 for( i_strip = 0; i_strip < i_frame_strips; i_strip++ )
456 i_strip_id = GET2BYTES( p_data );
457 i_strip_size = GET2BYTES( p_data );
458 i_strip_size = __MIN( i_strip_size, i_length );
459 /* FIXME I don't really understand how it's work; */
460 i_strip_y1 = i_strip_y2 + GET2BYTES( p_data );
461 i_strip_x1 = GET2BYTES( p_data );
462 i_strip_y2 = i_strip_y2 + GET2BYTES( p_data );
463 i_strip_x2 = GET2BYTES( p_data );
465 i_length -= i_strip_size;
468 /* init codebook , if needed */
469 if( ( i_strip > 0 )&&( !(i_frame_flags&0x01) ) )
471 memcpy( &p_context->codebook_v1[i_strip],
472 &p_context->codebook_v1[i_strip-1],
473 sizeof(cinepak_codebook_t[256] ) );
475 memcpy( &p_context->codebook_v4[i_strip],
476 &p_context->codebook_v4[i_strip-1],
477 sizeof(cinepak_codebook_t[256] ) );
480 /* Now parse all chunk in this strip */
481 while( i_strip_size > 0 )
483 cinepak_codebook_t (*p_codebook)[CINEPAK_MAXSTRIP][256];
488 uint32_t i_vector_flags;
491 int i_x, i_y; /* (0,0) begin in fact at (x1,y1) ... */
493 i_chunk_id = GET2BYTES( p_data );
494 i_chunk_size = GET2BYTES( p_data );
495 i_chunk_size = __MIN( i_chunk_size, i_strip_size );
496 i_strip_size -= i_chunk_size;
502 if( i_chunk_size < 0 )
509 case( 0x2000 ): /* 12bits v4 Intra*/
510 case( 0x2200 ): /* 12bits v1 Intra*/
511 case( 0x2400 ): /* 8bits v4 Intra*/
512 case( 0x2600 ): /* 8bits v1 Intra */
513 i_mode = ( ( i_chunk_id&0x0400 ) == 0 );
514 p_codebook = ( i_chunk_id&0x0200 ) ?
515 &p_context->codebook_v1 :
516 &p_context->codebook_v4;
518 i_count = __MIN( i_chunk_size / ( i_mode ? 6 : 4 ), 256 );
520 for( i = 0; i < i_count; i++ )
522 cinepak_LoadCodebook( &((*p_codebook)[i_strip][i]),
524 i_mode&~p_context->b_grayscale );
525 p_data += i_mode ? 6 : 4;
526 i_chunk_size -= i_mode ? 6 : 4;
530 case( 0x2100 ): /* selective 12bits v4 Inter*/
531 case( 0x2300 ): /* selective 12bits v1 Inter*/
532 case( 0x2500 ): /* selective 8bits v4 Inter*/
533 case( 0x2700 ): /* selective 8bits v1 Inter*/
534 i_mode = ( ( i_chunk_id&0x0400 ) == 0 );
535 p_codebook = ( i_chunk_id&0x0200 ) ?
536 &p_context->codebook_v1 :
537 &p_context->codebook_v4;
540 while( (i_chunk_size > 4)&&(i_index<256))
542 i_vector_flags = GET4BYTES( p_data );
544 for( i = 0; i < 32; i++ )
546 if( ( i_chunk_size < ( i_mode ? 6 : 4 ) )
547 || (i_index >= 256 ) )
551 if( i_vector_flags&0x80000000UL )
553 cinepak_LoadCodebook(
554 &((*p_codebook)[i_strip][i_index]),
555 p_data, i_mode&~p_context->b_grayscale );
557 p_data += i_mode ? 6 : 4;
558 i_chunk_size -= i_mode ? 6 : 4;
561 i_vector_flags <<= 1;
566 case( 0x3000 ): /* load image Intra */
567 while( (i_chunk_size >= 4 )&&(i_y<i_strip_y2-i_strip_y1) )
569 i_vector_flags = GET4BYTES( p_data );
574 for( i = 0; i < 32; i++ )
576 if( ( i_y >= i_strip_y2 - i_strip_y1) ||
577 ( i_chunk_size<=0 ) )
581 if( i_vector_flags&0x80000000UL )
583 cinepak_Getv4( p_context,
587 i_strip_x2, i_strip_y2,
594 cinepak_Getv1( p_context,
598 i_strip_x2, i_strip_y2,
605 if( i_x >= i_strip_x2 - i_strip_x1 )
610 i_vector_flags <<= 1;
615 case( 0x3100 ): /* load image Inter */
616 while( ( i_chunk_size > 4 )&&( i_y < i_strip_y2 - i_strip_y1) )
619 i_vector_flags = GET4BYTES( p_data );
621 i_mask = 0x80000000UL;
623 while( (i_chunk_size > 0 ) && ( i_mask )
624 && ( i_y < i_strip_y2 - i_strip_y1 ) )
626 if( i_vector_flags&i_mask )
631 if( i_chunk_size < 4 )
635 i_vector_flags = GET4BYTES( p_data );
637 i_mask = 0x80000000UL;
639 if( i_vector_flags&i_mask )
641 if( i_chunk_size < 4 ) break;
642 cinepak_Getv4( p_context,
646 i_strip_x2, i_strip_y2,
653 if( i_chunk_size < 1 ) break;
654 cinepak_Getv1( p_context,
658 i_strip_x2, i_strip_y2,
667 if( i_x >= i_strip_x2 - i_strip_x1 )
676 case( 0x3200 ): /* load intra picture but all v1*/
677 while( ( i_chunk_size > 0 ) &&
678 ( i_y < i_strip_y2 - i_strip_y1 ) )
680 cinepak_Getv1( p_context,
684 i_strip_x2, i_strip_y2,
690 if( i_x >= i_strip_x2 - i_strip_x1 )
702 p_data += i_chunk_size ; /* skip remains bytes */