1 /*****************************************************************************
2 * cinepak.c: cinepak video decoder
3 *****************************************************************************
4 * Copyright (C) 1999-2001 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_plugin.h>
34 #include <vlc_codec.h>
36 /*****************************************************************************
38 *****************************************************************************/
39 static int OpenDecoder ( vlc_object_t * );
40 static void CloseDecoder( vlc_object_t * );
43 set_description( _("Cinepak video decoder") );
44 set_capability( "decoder", 100 );
45 set_category( CAT_INPUT );
46 set_subcategory( SUBCAT_INPUT_VCODEC );
47 set_callbacks( OpenDecoder, CloseDecoder );
51 /*****************************************************************************
53 *****************************************************************************/
54 #define CINEPAK_MAXSTRIP 32
65 int b_grayscale; /* force to grayscale */
68 unsigned int i_height;
73 uint8_t *p_y, *p_u, *p_v;
75 int i_stride[3]; /* our 3 planes */
79 cinepak_codebook_t codebook_v1[CINEPAK_MAXSTRIP][256];
80 cinepak_codebook_t codebook_v4[CINEPAK_MAXSTRIP][256];
84 /*****************************************************************************
85 * decoder_sys_t : decoder descriptor
86 *****************************************************************************/
92 cinepak_context_t context;
95 static picture_t *DecodeBlock ( decoder_t *, block_t ** );
97 static int cinepak_decode_frame( cinepak_context_t *, size_t, uint8_t * );
99 /*****************************************************************************
100 * OpenDecoder: probe the decoder and return score
101 *****************************************************************************
102 * Tries to launch a decoder and return score so that the interface is able
104 *****************************************************************************/
105 static int OpenDecoder( vlc_object_t *p_this )
107 decoder_t *p_dec = (decoder_t*)p_this;
108 decoder_sys_t *p_sys;
111 if( p_dec->fmt_in.i_codec != VLC_FOURCC('c','v','i','d') &&
112 p_dec->fmt_in.i_codec != VLC_FOURCC('C','V','I','D') )
117 /* Allocate the memory needed to store the decoder's structure */
118 if( ( p_dec->p_sys = p_sys = malloc(sizeof(decoder_sys_t)) ) == NULL )
120 msg_Err( p_dec, "out of memory" );
123 memset( &p_sys->context, 0, sizeof( cinepak_context_t ) );
125 var_Create( p_dec, "grayscale", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
126 var_Get( p_dec, "grayscale", &val );
127 p_sys->context.b_grayscale = val.b_bool;
129 p_dec->pf_decode_video = DecodeBlock;
131 msg_Dbg( p_dec, "cinepak decoder started" );
136 /****************************************************************************
137 * DecodeBlock: the whole thing
138 ****************************************************************************
139 * This function must be fed with whole frames.
140 ****************************************************************************/
141 static picture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
143 decoder_sys_t *p_sys = p_dec->p_sys;
144 int i_status, i_plane;
145 uint8_t *p_dst, *p_src;
149 if( !pp_block || !*pp_block )
156 i_status = cinepak_decode_frame( &p_sys->context, p_block->i_buffer,
160 msg_Warn( p_dec, "cannot decode one frame (%d bytes)",
162 block_Release( p_block );
166 p_dec->fmt_out.video.i_width = p_sys->context.i_width;
167 p_dec->fmt_out.video.i_height = p_sys->context.i_height;
168 p_dec->fmt_out.video.i_aspect = p_sys->context.i_width
169 * VOUT_ASPECT_FACTOR / p_sys->context.i_height;
170 p_dec->fmt_out.i_codec = VLC_FOURCC('I','4','2','0');
172 /* Get a new picture */
173 if( ( p_pic = p_dec->pf_vout_buffer_new( p_dec ) ) )
175 for( i_plane = 0; i_plane < 3; i_plane++ )
179 p_dst = p_pic->p[i_plane].p_pixels;
180 p_src = p_sys->context.p_pix[i_plane];
182 i_lines = __MIN( p_sys->context.i_lines[i_plane],
183 p_pic->p[i_plane].i_visible_lines );
184 for( i_line = 0; i_line < i_lines; i_line++ )
186 memcpy( p_dst, p_src,
187 __MIN( p_pic->p[i_plane].i_pitch,
188 p_sys->context.i_stride[i_plane] ) );
189 p_dst += p_pic->p[i_plane].i_pitch;
190 p_src += p_sys->context.i_stride[i_plane];
194 p_pic->date = p_block->i_pts ? p_block->i_pts : p_block->i_dts;
197 block_Release( p_block );
201 /*****************************************************************************
202 * CloseDecoder: decoder destruction
203 *****************************************************************************/
204 static void CloseDecoder( vlc_object_t *p_this )
206 decoder_t *p_dec = (decoder_t *)p_this;
207 decoder_sys_t *p_sys = p_dec->p_sys;
210 msg_Dbg( p_dec, "cinepak decoder stopped" );
212 for( i = 0; i < 3; i++ )
213 free( p_sys->context.p_pix[i] );
218 /*****************************************************************************
220 *****************************************************************************/
222 #define GET2BYTES( p ) \
225 #define GET3BYTES( p ) \
226 (GetDWBE( p ) >> 8); p+= 3;
228 #define GET4BYTES( p ) \
231 static void cinepak_LoadCodebook( cinepak_codebook_t *p_codebook,
232 uint8_t *p_data, int b_grayscale )
234 int i, i_y[4], i_u, i_v, i_Cb, i_Cr;
237 #define FIX( x ) ( (int)( (x) * ( 1L << SCALEBITS ) + 0.5 ) )
239 for( i = 0; i < 4; i++ )
241 i_y[i] = (uint8_t)( *(p_data++) );
245 i_u = (int8_t)( *(p_data++) );
246 i_v = (int8_t)( *(p_data++) );
255 | Y | | 1 -0.0655 0.0110 | | CY |
256 | Cb | = | 0 1.1656 -0.0062 | | CU |
257 | Cr | | 0 0.0467 1.4187 | | CV |
259 i_uv = ( FIX( -0.0655 ) * i_u + FIX( 0.0110 ) * i_v ) >> SCALEBITS;
260 for( i = 0; i < 4; i++ )
264 i_Cb = ( FIX( 1.1656 ) * i_u + FIX( -0.0062 ) * i_v ) >> SCALEBITS;
265 i_Cr = ( FIX( 0.0467 ) * i_u + FIX( 1.4187 ) * i_v ) >> SCALEBITS;
267 for( i = 0; i < 4; i++ )
269 p_codebook->i_y[i] = __MIN( __MAX( 0, i_y[i] ), 255 );
271 p_codebook->i_u = __MIN( __MAX( 0, i_Cb + 128 ), 255 );
272 p_codebook->i_v = __MIN( __MAX( 0, i_Cr + 128 ), 255 );
278 static void cinepak_Getv4( cinepak_context_t *p_context,
279 int i_strip, int i_x, int i_y,
285 size_t y_max = p_context->i_stride[0] * ( i_y + 5 ) + i_x + 5;
286 size_t u_max = p_context->i_stride[1] * ( ( i_y/2 ) + 2 ) + 2 + ( i_x / 2 );
287 size_t v_max = p_context->i_stride[2] * ( ( i_y/2 ) + 2 ) + 2 + ( i_x / 2 );
288 size_t y_siz = p_context->i_stride[0] * p_context->i_lines[0];
289 size_t u_siz = p_context->i_stride[1] * p_context->i_lines[1];
290 size_t v_siz = p_context->i_stride[2] * p_context->i_lines[2];
292 if( y_max >= y_siz || u_max >= u_siz || v_max >= v_siz )
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,
342 size_t y_max = p_context->i_stride[0] * ( i_y + 5 ) + i_x + 5;
343 size_t u_max = p_context->i_stride[1] * ( ( i_y/2 ) + 2 ) + 2 + ( i_x / 2 );
344 size_t v_max = p_context->i_stride[2] * ( ( i_y/2 ) + 2 ) + 2 + ( i_x / 2 );
345 size_t y_siz = p_context->i_stride[0] * p_context->i_lines[0];
346 size_t u_siz = p_context->i_stride[1] * p_context->i_lines[1];
347 size_t v_siz = p_context->i_stride[2] * p_context->i_lines[2];
349 if( y_max >= y_siz || u_max >= u_siz || v_max >= v_siz )
352 uint8_t *p_dst_y, *p_dst_u, *p_dst_v;
353 #define PIX_SET_Y( x, y, v ) \
354 p_dst_y[(x) + (y)* p_context->i_stride[0]] = (v);
356 #define PIX_SET_UV( i,p, x, y, v ) \
357 p[(x) + (y)* (p_context->i_stride[i])] = (v);
359 i_index = *(p_data++);
362 p_dst_y = p_context->p_pix[0] + p_context->i_stride[0] * i_y + i_x;
363 p_dst_u = p_context->p_pix[1] + p_context->i_stride[1] * (i_y/2) + (i_x/2);
364 p_dst_v = p_context->p_pix[2] + p_context->i_stride[2] * (i_y/2) + (i_x/2);
366 for( i = 0; i < 2; i++ )
368 for( j = 0; j < 2; j ++ )
370 PIX_SET_Y( 2*j + 0, 2*i + 0,
371 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
372 PIX_SET_Y( 2*j + 1, 2*i + 0,
373 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
374 PIX_SET_Y( 2*j + 0, 2*i + 1,
375 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
376 PIX_SET_Y( 2*j + 1, 2*i + 1,
377 p_context->codebook_v1[i_strip][i_index].i_y[2*i+j] );
379 PIX_SET_UV( 1,p_dst_u, j, i,
380 p_context->codebook_v1[i_strip][i_index].i_u );
381 PIX_SET_UV( 2,p_dst_v, j, i,
382 p_context->codebook_v1[i_strip][i_index].i_v );
390 /*****************************************************************************
391 * The function that decode one frame
392 *****************************************************************************/
393 static int cinepak_decode_frame( cinepak_context_t *p_context,
394 size_t i_length, uint8_t *p_data )
398 int8_t i_frame_flags;
399 uint32_t i_frame_size;
400 uint16_t i_width, i_height;
401 uint16_t i_frame_strips;
403 int i_strip_x1 =0, i_strip_y1=0;
404 int i_strip_x2 =0, i_strip_y2=0;
408 /* Broken header or no data */
413 i_frame_flags = *(p_data++);
414 i_frame_size = GET3BYTES( p_data );
415 i_width = GET2BYTES( p_data );
416 i_height = GET2BYTES( p_data );
417 i_frame_strips = GET2BYTES( p_data );
419 if( !i_frame_size || !i_width || !i_height ||
420 i_width > 0xffff-3 || i_height > 0xffff-3)
426 /* Check if we have a picture buffer with good size */
427 if( ( p_context->i_width != i_width ) ||
428 ( p_context->i_height != i_height ) )
431 for( i = 0; i < 3; i++ )
433 free( p_context->p_pix[i] );
436 p_context->i_width = i_width;
437 p_context->i_height = i_height;
439 p_context->i_stride[0] = ( i_width + 3 ) & 0xfffc;
440 p_context->i_stride[1] = p_context->i_stride[2] =
441 p_context->i_stride[0] / 2;
443 p_context->i_lines[0] = ( i_height + 3 ) & 0xfffc;
444 p_context->i_lines[1] = p_context->i_lines[2] =
445 p_context->i_lines[0] /2;
447 for( i = 0; i < 3; i++ )
449 p_context->p_pix[i] = malloc( p_context->i_stride[i] *
450 p_context->i_lines[i] );
451 /* Set it to all black */
452 memset( p_context->p_pix[i], ( i == 0 ) ? 0 : 128 ,
453 p_context->i_stride[i] * p_context->i_lines[i] );
457 if( i_frame_size != i_length )
459 i_length = __MIN( i_length, i_frame_size );
463 if( i_frame_strips >= CINEPAK_MAXSTRIP )
465 i_frame_strips = CINEPAK_MAXSTRIP;
468 /* Now decode each strip */
469 for( i_strip = 0; i_strip < i_frame_strips; i_strip++ )
471 uint16_t i_strip_size;
478 p_data += 2; /* int16_t i_strip_id = GET2BYTES( p_data ); */
480 i_strip_size = GET2BYTES( p_data );
481 i_strip_size = __MIN( i_strip_size, i_length );
482 /* FIXME I don't really understand how it works; */
483 i_strip_y1 = i_strip_y2 + GET2BYTES( p_data );
484 i_strip_x1 = GET2BYTES( p_data );
485 i_strip_y2 = i_strip_y2 + GET2BYTES( p_data );
486 i_strip_x2 = GET2BYTES( p_data );
488 i_length -= i_strip_size;
491 /* init codebook , if needed */
492 if( ( i_strip > 0 )&&( !(i_frame_flags&0x01) ) )
494 memcpy( &p_context->codebook_v1[i_strip],
495 &p_context->codebook_v1[i_strip-1],
496 sizeof(cinepak_codebook_t[256] ) );
498 memcpy( &p_context->codebook_v4[i_strip],
499 &p_context->codebook_v4[i_strip-1],
500 sizeof(cinepak_codebook_t[256] ) );
503 /* Now parse all chunk in this strip */
504 while( i_strip_size > 0 )
506 cinepak_codebook_t (*p_codebook)[CINEPAK_MAXSTRIP][256];
511 uint32_t i_vector_flags;
514 int i_x, i_y; /* (0,0) begin in fact at (x1,y1) ... */
516 i_chunk_id = GET2BYTES( p_data );
517 i_chunk_size = GET2BYTES( p_data );
518 i_chunk_size = __MIN( i_chunk_size, i_strip_size );
519 i_strip_size -= i_chunk_size;
525 if( i_chunk_size < 0 )
532 case( 0x2000 ): /* 12bits v4 Intra*/
533 case( 0x2200 ): /* 12bits v1 Intra*/
534 case( 0x2400 ): /* 8bits v4 Intra*/
535 case( 0x2600 ): /* 8bits v1 Intra */
536 i_mode = ( ( i_chunk_id&0x0400 ) == 0 );
537 p_codebook = ( i_chunk_id&0x0200 ) ?
538 &p_context->codebook_v1 :
539 &p_context->codebook_v4;
541 i_count = __MIN( i_chunk_size / ( i_mode ? 6 : 4 ), 256 );
543 for( i = 0; i < i_count; i++ )
545 cinepak_LoadCodebook( &((*p_codebook)[i_strip][i]),
547 i_mode&~p_context->b_grayscale );
548 p_data += i_mode ? 6 : 4;
549 i_chunk_size -= i_mode ? 6 : 4;
553 case( 0x2100 ): /* selective 12bits v4 Inter*/
554 case( 0x2300 ): /* selective 12bits v1 Inter*/
555 case( 0x2500 ): /* selective 8bits v4 Inter*/
556 case( 0x2700 ): /* selective 8bits v1 Inter*/
557 i_mode = ( ( i_chunk_id&0x0400 ) == 0 );
558 p_codebook = ( i_chunk_id&0x0200 ) ?
559 &p_context->codebook_v1 :
560 &p_context->codebook_v4;
563 while( (i_chunk_size > 4)&&(i_index<256))
565 i_vector_flags = GET4BYTES( p_data );
567 for( i = 0; i < 32; i++ )
569 if( ( i_chunk_size < ( i_mode ? 6 : 4 ) )
570 || (i_index >= 256 ) )
574 if( i_vector_flags&0x80000000UL )
576 cinepak_LoadCodebook(
577 &((*p_codebook)[i_strip][i_index]),
578 p_data, i_mode&~p_context->b_grayscale );
580 p_data += i_mode ? 6 : 4;
581 i_chunk_size -= i_mode ? 6 : 4;
584 i_vector_flags <<= 1;
589 case( 0x3000 ): /* load image Intra */
590 while( (i_chunk_size >= 4 )&&(i_y<i_strip_y2-i_strip_y1) )
592 i_vector_flags = GET4BYTES( p_data );
597 for( i = 0; i < 32; i++ )
599 if( ( i_y >= i_strip_y2 - i_strip_y1) ||
600 ( i_chunk_size<=0 ) )
604 if( i_vector_flags&0x80000000UL )
606 cinepak_Getv4( p_context,
616 cinepak_Getv1( p_context,
626 if( i_x >= i_strip_x2 - i_strip_x1 )
631 i_vector_flags <<= 1;
636 case( 0x3100 ): /* load image Inter */
637 while( ( i_chunk_size > 4 )&&( i_y < i_strip_y2 - i_strip_y1) )
640 i_vector_flags = GET4BYTES( p_data );
642 i_mask = 0x80000000UL;
644 while( (i_chunk_size > 0 ) && ( i_mask )
645 && ( i_y < i_strip_y2 - i_strip_y1 ) )
647 if( i_vector_flags&i_mask )
652 if( i_chunk_size < 4 )
656 i_vector_flags = GET4BYTES( p_data );
658 i_mask = 0x80000000UL;
660 if( i_vector_flags&i_mask )
662 if( i_chunk_size < 4 ) break;
663 cinepak_Getv4( p_context,
673 if( i_chunk_size < 1 ) break;
674 cinepak_Getv1( p_context,
686 if( i_x >= i_strip_x2 - i_strip_x1 )
695 case( 0x3200 ): /* load intra picture but all v1*/
696 while( ( i_chunk_size > 0 ) &&
697 ( i_y < i_strip_y2 - i_strip_y1 ) )
699 cinepak_Getv1( p_context,
708 if( i_x >= i_strip_x2 - i_strip_x1 )
720 p_data += i_chunk_size ; /* skip remains bytes */