1 /*****************************************************************************
2 * cinepak.c: cinepak video decoder
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
5 * $Id: cinepak.c,v 1.4 2003/11/22 23:39:14 fenrir 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 #define CINEPAK_MAXSTRIP 32
33 typedef struct cinepak_codebook_s
40 typedef struct cinepak_context_s
42 int b_grayscale; /* force to grayscale */
50 uint8_t *p_y, *p_u, *p_v;
52 int i_stride[3]; /* our 3 planes */
56 cinepak_codebook_t codebook_v1[CINEPAK_MAXSTRIP][256];
57 cinepak_codebook_t codebook_v4[CINEPAK_MAXSTRIP][256];
61 /*****************************************************************************
62 * decoder_sys_t : decoder descriptor
63 *****************************************************************************/
69 cinepak_context_t *p_context;
72 /*****************************************************************************
74 *****************************************************************************/
75 static int OpenDecoder( vlc_object_t * );
76 static void CloseDecoder( vlc_object_t * );
77 static picture_t *DecodeBlock ( decoder_t *, block_t ** );
79 static int cinepak_decode_frame( cinepak_context_t *, int, uint8_t * );
81 /*****************************************************************************
83 *****************************************************************************/
85 set_description( _("Cinepak video decoder") );
86 set_capability( "decoder", 70 );
87 set_callbacks( OpenDecoder, CloseDecoder );
90 /*****************************************************************************
91 * OpenDecoder: probe the decoder and return score
92 *****************************************************************************
93 * Tries to launch a decoder and return score so that the interface is able
95 *****************************************************************************/
96 static int OpenDecoder( vlc_object_t *p_this )
98 decoder_t *p_dec = (decoder_t*)p_this;
102 switch( p_dec->fmt_in.i_codec )
104 case VLC_FOURCC('c','v','i','d'):
105 case VLC_FOURCC('C','V','I','D'):
112 /* Allocate the memory needed to store the decoder's structure */
113 if( ( p_dec->p_sys = p_sys =
114 (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
116 msg_Err( p_dec, "out of memory" );
120 if( !(p_sys->p_context = malloc( sizeof( cinepak_context_t ) ) ) )
122 msg_Err( p_dec, "out of memory" );
124 memset( p_sys->p_context, 0, sizeof( cinepak_context_t ) );
126 var_Create( p_dec, "grayscale", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
127 var_Get( p_dec, "grayscale", &val );
128 p_sys->p_context->b_grayscale = val.b_bool;
130 p_dec->pf_decode_video = DecodeBlock;
132 msg_Dbg( p_dec, "cinepak decoder started" );
137 /****************************************************************************
138 * DecodeBlock: the whole thing
139 ****************************************************************************
140 * This function must be fed with whole frames.
141 ****************************************************************************/
142 static picture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
144 decoder_sys_t *p_sys = p_dec->p_sys;
145 int i_status, i_plane;
146 uint8_t *p_dst, *p_src;
150 if( !pp_block || !*pp_block ) return NULL;
154 i_status = cinepak_decode_frame( p_sys->p_context, p_block->i_buffer,
158 msg_Warn( p_dec, "cannot decode one frame (%d bytes)",
160 block_Release( p_block );
164 p_dec->fmt_out.video.i_width = p_sys->p_context->i_width;
165 p_dec->fmt_out.video.i_height = p_sys->p_context->i_height;
166 p_dec->fmt_out.video.i_aspect = p_sys->p_context->i_width
167 * VOUT_ASPECT_FACTOR / p_sys->p_context->i_height;
168 p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0');
170 /* Get a new picture */
171 p_pic = p_dec->pf_vout_buffer_new( p_dec );
175 block_Release( p_block );
179 for( i_plane = 0; i_plane < 3; i_plane++ )
183 p_dst = p_pic->p[i_plane].p_pixels;
184 p_src = p_sys->p_context->p_pix[i_plane];
186 i_lines = __MIN( p_sys->p_context->i_lines[i_plane],
187 p_pic->p[i_plane].i_lines );
188 for( i_line = 0; i_line < i_lines; i_line++ )
190 memcpy( p_dst, p_src,
191 __MIN( p_pic->p[i_plane].i_pitch,
192 p_sys->p_context->i_stride[i_plane] ) );
193 p_dst += p_pic->p[i_plane].i_pitch;
194 p_src += p_sys->p_context->i_stride[i_plane];
198 p_pic->date = p_block->i_pts;
199 block_Release( p_block );
204 /*****************************************************************************
205 * CloseDecoder: decoder destruction
206 *****************************************************************************/
207 static void CloseDecoder( vlc_object_t *p_this )
209 decoder_t *p_dec = (decoder_t *)p_this;
210 decoder_sys_t *p_sys = p_dec->p_sys;
213 msg_Dbg( p_dec, "cinepak decoder stopped" );
215 for( i = 0; i < 3; i++ )
217 if( p_sys->p_context->p_pix[i] ) free( p_sys->p_context->p_pix[i] );
220 free( p_sys->p_context );
225 /*****************************************************************************
227 *****************************************************************************/
229 #define GET2BYTES( p ) \
232 #define GET3BYTES( p ) \
233 (GetDWBE( p ) >> 8); p+= 3;
235 #define GET4BYTES( p ) \
241 static void cinepak_LoadCodebook( cinepak_codebook_t *p_codebook,
242 uint8_t *p_data, int b_grayscale )
244 int i, i_y[4], i_u, i_v, i_Cb, i_Cr;
247 #define FIX( x ) ( (int)( (x) * ( 1L << SCALEBITS ) + 0.5 ) )
249 for( i = 0; i < 4; i++ )
251 i_y[i] = (uint8_t)( *(p_data++) );
255 i_u = (int8_t)( *(p_data++) );
256 i_v = (int8_t)( *(p_data++) );
265 | Y | | 1 -0.0655 0.0110 | | CY |
266 | Cb | = | 0 1.1656 -0.0062 | | CU |
267 | Cr | | 0 0.0467 1.4187 | | CV |
269 i_uv = ( FIX( -0.0655 ) * i_u + FIX( 0.0110 ) * i_v ) >> SCALEBITS;
270 for( i = 0; i < 4; i++ )
274 i_Cb = ( FIX( 1.1656 ) * i_u + FIX( -0.0062 ) * i_v ) >> SCALEBITS;
275 i_Cr = ( FIX( 0.0467 ) * i_u + FIX( 1.4187 ) * i_v ) >> SCALEBITS;
277 for( i = 0; i < 4; i++ )
279 p_codebook->i_y[i] = __MIN( __MAX( 0, i_y[i] ), 255 );
281 p_codebook->i_u = __MIN( __MAX( 0, i_Cb + 128 ), 255 );
282 p_codebook->i_v = __MIN( __MAX( 0, i_Cr + 128 ), 255 );
288 static void cinepak_Getv4( cinepak_context_t *p_context,
289 int i_strip, int i_x, int i_y,
290 int i_x2, int i_y2, uint8_t *p_data )
295 uint8_t *p_dst_y, *p_dst_u, *p_dst_v;
296 #define PIX_SET_Y( x, y, v ) \
297 p_dst_y[(x) + (y)* p_context->i_stride[0]] = (v);
299 #define PIX_SET_UV( i, p, x, y, v ) \
300 p[(x) + (y)* (p_context->i_stride[i])] = (v);
302 for( i = 0; i < 4; i++ )
304 i_index[i] = *(p_data++);
308 p_dst_y = p_context->p_pix[0] + p_context->i_stride[0] * i_y + i_x;
309 p_dst_u = p_context->p_pix[1] + p_context->i_stride[1] * (i_y/2) + (i_x/2);
310 p_dst_v = p_context->p_pix[2] + p_context->i_stride[2] * (i_y/2) + (i_x/2);
312 for( i = 0; i < 2; i++ )
314 for( j = 0; j < 2; j ++ )
316 PIX_SET_Y( 2*j + 0, 2*i + 0,
317 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[0]);
318 PIX_SET_Y( 2*j + 1, 2*i + 0,
319 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[1]);
320 PIX_SET_Y( 2*j + 0, 2*i + 1,
321 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[2]);
322 PIX_SET_Y( 2*j + 1, 2*i + 1,
323 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[3]);
325 PIX_SET_UV( 1, p_dst_u, j, i,
326 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_u );
327 PIX_SET_UV( 2, p_dst_v, j, i,
328 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_v );
335 static void cinepak_Getv1( cinepak_context_t *p_context,
336 int i_strip, int i_x, int i_y,
337 int i_x2, int i_y2, uint8_t *p_data )
342 uint8_t *p_dst_y, *p_dst_u, *p_dst_v;
343 #define PIX_SET_Y( x, y, v ) \
344 p_dst_y[(x) + (y)* p_context->i_stride[0]] = (v);
346 #define PIX_SET_UV( i,p, x, y, v ) \
347 p[(x) + (y)* (p_context->i_stride[i])] = (v);
349 i_index = *(p_data++);
352 p_dst_y = p_context->p_pix[0] + p_context->i_stride[0] * i_y + i_x;
353 p_dst_u = p_context->p_pix[1] + p_context->i_stride[1] * (i_y/2) + (i_x/2);
354 p_dst_v = p_context->p_pix[2] + p_context->i_stride[2] * (i_y/2) + (i_x/2);
356 for( i = 0; i < 2; i++ )
358 for( j = 0; j < 2; j ++ )
360 PIX_SET_Y( 2*j + 0, 2*i + 0,
361 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
362 PIX_SET_Y( 2*j + 1, 2*i + 0,
363 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
364 PIX_SET_Y( 2*j + 0, 2*i + 1,
365 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
366 PIX_SET_Y( 2*j + 1, 2*i + 1,
367 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
369 PIX_SET_UV( 1,p_dst_u, j, i,
370 p_context->codebook_v1[i_strip][i_index].i_u );
371 PIX_SET_UV( 2,p_dst_v, j, i,
372 p_context->codebook_v1[i_strip][i_index].i_v );
380 /*****************************************************************************
381 * The function that decode one frame
382 *****************************************************************************/
383 static int cinepak_decode_frame( cinepak_context_t *p_context,
384 int i_length, uint8_t *p_data )
390 int i_width, i_height;
393 int i_strip_x1 =0, i_strip_y1=0;
394 int i_strip_x2 =0, i_strip_y2=0;
398 /* Broken header or no data */
403 i_frame_flags = *(p_data++);
404 i_frame_size = GET3BYTES( p_data );
405 i_width = GET2BYTES( p_data );
406 i_height = GET2BYTES( p_data );
407 i_frame_strips = GET2BYTES( p_data );
409 if( !i_frame_size || !i_width || !i_height )
415 /* Check if we have a picture buffer with good size */
416 if( ( p_context->i_width != i_width ) ||
417 ( p_context->i_height != i_height ) )
420 for( i = 0; i < 3; i++ )
422 FREE( p_context->p_pix[i] );
425 p_context->i_width = i_width;
426 p_context->i_height = i_height;
428 p_context->i_stride[0] = ( i_width + 3 ) & 0xfffc;
429 p_context->i_stride[1] = p_context->i_stride[2] =
430 p_context->i_stride[0] / 2;
432 p_context->i_lines[0] = ( i_height + 3 ) & 0xfffc;
433 p_context->i_lines[1] = p_context->i_lines[2] =
434 p_context->i_lines[0] /2;
436 for( i = 0; i < 3; i++ )
438 p_context->p_pix[i] = malloc( p_context->i_stride[i] *
439 p_context->i_lines[i] );
440 /* Set it to all black */
441 memset( p_context->p_pix[i], ( i == 0 ) ? 0 : 128 ,
442 p_context->i_stride[i] * p_context->i_lines[i] );
446 if( i_frame_size != i_length )
448 i_length = __MIN( i_length, i_frame_size );
452 if( i_frame_strips >= CINEPAK_MAXSTRIP )
454 i_frame_strips = CINEPAK_MAXSTRIP;
457 /* Now decode each strip */
458 for( i_strip = 0; i_strip < i_frame_strips; i_strip++ )
468 i_strip_id = GET2BYTES( p_data );
469 i_strip_size = GET2BYTES( p_data );
470 i_strip_size = __MIN( i_strip_size, i_length );
471 /* FIXME I don't really understand how it's work; */
472 i_strip_y1 = i_strip_y2 + GET2BYTES( p_data );
473 i_strip_x1 = GET2BYTES( p_data );
474 i_strip_y2 = i_strip_y2 + GET2BYTES( p_data );
475 i_strip_x2 = GET2BYTES( p_data );
477 i_length -= i_strip_size;
480 /* init codebook , if needed */
481 if( ( i_strip > 0 )&&( !(i_frame_flags&0x01) ) )
483 memcpy( &p_context->codebook_v1[i_strip],
484 &p_context->codebook_v1[i_strip-1],
485 sizeof(cinepak_codebook_t[256] ) );
487 memcpy( &p_context->codebook_v4[i_strip],
488 &p_context->codebook_v4[i_strip-1],
489 sizeof(cinepak_codebook_t[256] ) );
492 /* Now parse all chunk in this strip */
493 while( i_strip_size > 0 )
495 cinepak_codebook_t (*p_codebook)[CINEPAK_MAXSTRIP][256];
500 uint32_t i_vector_flags;
503 int i_x, i_y; /* (0,0) begin in fact at (x1,y1) ... */
505 i_chunk_id = GET2BYTES( p_data );
506 i_chunk_size = GET2BYTES( p_data );
507 i_chunk_size = __MIN( i_chunk_size, i_strip_size );
508 i_strip_size -= i_chunk_size;
514 if( i_chunk_size < 0 )
521 case( 0x2000 ): /* 12bits v4 Intra*/
522 case( 0x2200 ): /* 12bits v1 Intra*/
523 case( 0x2400 ): /* 8bits v4 Intra*/
524 case( 0x2600 ): /* 8bits v1 Intra */
525 i_mode = ( ( i_chunk_id&0x0400 ) == 0 );
526 p_codebook = ( i_chunk_id&0x0200 ) ?
527 &p_context->codebook_v1 :
528 &p_context->codebook_v4;
530 i_count = __MIN( i_chunk_size / ( i_mode ? 6 : 4 ), 256 );
532 for( i = 0; i < i_count; i++ )
534 cinepak_LoadCodebook( &((*p_codebook)[i_strip][i]),
536 i_mode&~p_context->b_grayscale );
537 p_data += i_mode ? 6 : 4;
538 i_chunk_size -= i_mode ? 6 : 4;
542 case( 0x2100 ): /* selective 12bits v4 Inter*/
543 case( 0x2300 ): /* selective 12bits v1 Inter*/
544 case( 0x2500 ): /* selective 8bits v4 Inter*/
545 case( 0x2700 ): /* selective 8bits v1 Inter*/
546 i_mode = ( ( i_chunk_id&0x0400 ) == 0 );
547 p_codebook = ( i_chunk_id&0x0200 ) ?
548 &p_context->codebook_v1 :
549 &p_context->codebook_v4;
552 while( (i_chunk_size > 4)&&(i_index<256))
554 i_vector_flags = GET4BYTES( p_data );
556 for( i = 0; i < 32; i++ )
558 if( ( i_chunk_size < ( i_mode ? 6 : 4 ) )
559 || (i_index >= 256 ) )
563 if( i_vector_flags&0x80000000UL )
565 cinepak_LoadCodebook(
566 &((*p_codebook)[i_strip][i_index]),
567 p_data, i_mode&~p_context->b_grayscale );
569 p_data += i_mode ? 6 : 4;
570 i_chunk_size -= i_mode ? 6 : 4;
573 i_vector_flags <<= 1;
578 case( 0x3000 ): /* load image Intra */
579 while( (i_chunk_size >= 4 )&&(i_y<i_strip_y2-i_strip_y1) )
581 i_vector_flags = GET4BYTES( p_data );
586 for( i = 0; i < 32; i++ )
588 if( ( i_y >= i_strip_y2 - i_strip_y1) ||
589 ( i_chunk_size<=0 ) )
593 if( i_vector_flags&0x80000000UL )
595 cinepak_Getv4( p_context,
599 i_strip_x2, i_strip_y2,
606 cinepak_Getv1( p_context,
610 i_strip_x2, i_strip_y2,
617 if( i_x >= i_strip_x2 - i_strip_x1 )
622 i_vector_flags <<= 1;
627 case( 0x3100 ): /* load image Inter */
628 while( ( i_chunk_size > 4 )&&( i_y < i_strip_y2 - i_strip_y1) )
631 i_vector_flags = GET4BYTES( p_data );
633 i_mask = 0x80000000UL;
635 while( (i_chunk_size > 0 ) && ( i_mask )
636 && ( i_y < i_strip_y2 - i_strip_y1 ) )
638 if( i_vector_flags&i_mask )
643 if( i_chunk_size < 4 )
647 i_vector_flags = GET4BYTES( p_data );
649 i_mask = 0x80000000UL;
651 if( i_vector_flags&i_mask )
653 if( i_chunk_size < 4 ) break;
654 cinepak_Getv4( p_context,
658 i_strip_x2, i_strip_y2,
665 if( i_chunk_size < 1 ) break;
666 cinepak_Getv1( p_context,
670 i_strip_x2, i_strip_y2,
679 if( i_x >= i_strip_x2 - i_strip_x1 )
688 case( 0x3200 ): /* load intra picture but all v1*/
689 while( ( i_chunk_size > 0 ) &&
690 ( i_y < i_strip_y2 - i_strip_y1 ) )
692 cinepak_Getv1( p_context,
696 i_strip_x2, i_strip_y2,
702 if( i_x >= i_strip_x2 - i_strip_x1 )
714 p_data += i_chunk_size ; /* skip remains bytes */