1 /*****************************************************************************
2 * cinepak.c: cinepak video decoder
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
5 * $Id: cinepak.c,v 1.5 2002/10/24 09:37:48 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 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
31 #include <vlc/decoder.h>
32 #include <vlc/input.h>
35 #include <unistd.h> /* getpid() */
41 #ifdef HAVE_SYS_TIMES_H
42 # include <sys/times.h>
47 /*****************************************************************************
49 *****************************************************************************/
50 static int OpenDecoder ( vlc_object_t * );
51 static int RunDecoder ( decoder_fifo_t * );
52 static int InitThread ( videodec_thread_t * );
53 static void EndThread ( videodec_thread_t * );
54 static void DecodeThread ( videodec_thread_t * );
56 /*****************************************************************************
58 *****************************************************************************/
60 set_description( "Cinepak video decoder" );
61 set_capability( "decoder", 70 );
62 set_callbacks( OpenDecoder, NULL );
65 /*****************************************************************************
66 * OpenDecoder: probe the decoder and return score
67 *****************************************************************************
68 * Tries to launch a decoder and return score so that the interface is able
70 *****************************************************************************/
71 static int OpenDecoder( vlc_object_t *p_this )
73 decoder_fifo_t *p_fifo = (decoder_fifo_t*) p_this;
75 switch( p_fifo->i_fourcc )
77 case VLC_FOURCC('c','v','i','d'):
78 case VLC_FOURCC('C','V','I','D'):
79 p_fifo->pf_run = RunDecoder;
86 /*****************************************************************************
87 * RunDecoder: this function is called just after the thread is created
88 *****************************************************************************/
89 static int RunDecoder( decoder_fifo_t *p_fifo )
91 videodec_thread_t *p_vdec;
94 if ( !(p_vdec = (videodec_thread_t*)malloc( sizeof(videodec_thread_t))) )
96 msg_Err( p_fifo, "out of memory" );
97 DecoderError( p_fifo );
100 memset( p_vdec, 0, sizeof( videodec_thread_t ) );
102 p_vdec->p_fifo = p_fifo;
104 if( InitThread( p_vdec ) != 0 )
106 DecoderError( p_fifo );
110 while( (!p_vdec->p_fifo->b_die) && (!p_vdec->p_fifo->b_error) )
112 DecodeThread( p_vdec );
115 if( ( b_error = p_vdec->p_fifo->b_error ) )
117 DecoderError( p_vdec->p_fifo );
131 /*****************************************************************************
133 *****************************************************************************/
135 static inline u16 GetWBE( u8 *p_buff )
137 return( (p_buff[0]<<8) + p_buff[1] );
140 static inline u32 GetDWBE( u8 *p_buff )
142 return( (p_buff[0] << 24) + ( p_buff[1] <<16 ) +
143 ( p_buff[2] <<8 ) + p_buff[3] );
146 #define GET2BYTES( p ) \
149 #define GET3BYTES( p ) \
150 (GetDWBE( p ) >> 8); p+= 3;
152 #define GET4BYTES( p ) \
159 static inline void __GetFrame( videodec_thread_t *p_vdec )
162 data_packet_t *p_data;
165 p_pes = GetPES( p_vdec->p_fifo );
166 p_vdec->i_pts = p_pes->i_pts;
168 while( ( !p_pes->i_nb_data )||( !p_pes->i_pes_size ) )
170 p_pes = NextPES( p_vdec->p_fifo );
172 p_vdec->i_framesize = p_pes->i_pes_size;
173 if( p_pes->i_nb_data == 1 )
175 p_vdec->p_framedata = p_pes->p_first->p_payload_start;
178 /* get a buffer and gather all data packet */
179 p_vdec->p_framedata = p_buffer = malloc( p_pes->i_pes_size );
180 p_data = p_pes->p_first;
183 p_vdec->p_fifo->p_vlc->pf_memcpy( p_buffer, p_data->p_payload_start,
184 p_data->p_payload_end - p_data->p_payload_start );
185 p_buffer += p_data->p_payload_end - p_data->p_payload_start;
186 p_data = p_data->p_next;
190 static inline void __NextFrame( videodec_thread_t *p_vdec )
194 p_pes = GetPES( p_vdec->p_fifo );
195 if( p_pes->i_nb_data != 1 )
197 free( p_vdec->p_framedata ); /* FIXME keep this buffer */
199 NextPES( p_vdec->p_fifo );
202 static int cinepak_CheckVout( vout_thread_t *p_vout,
211 if( ( p_vout->render.i_width != i_width )||
212 ( p_vout->render.i_height != i_height )||
213 ( p_vout->render.i_chroma != VLC_FOURCC('I','4','2','0') )||
214 ( p_vout->render.i_aspect != VOUT_ASPECT_FACTOR * i_width / i_height) )
226 static vout_thread_t *cinepak_CreateVout( videodec_thread_t *p_vdec,
230 vout_thread_t *p_vout;
232 if( (!i_width)||(!i_height) )
234 return( NULL ); /* Can't create a new vout without display size */
237 /* Spawn a video output if there is none. First we look for our children,
238 * then we look for any other vout that might be available. */
239 p_vout = vlc_object_find( p_vdec->p_fifo, VLC_OBJECT_VOUT,
243 p_vout = vlc_object_find( p_vdec->p_fifo, VLC_OBJECT_VOUT,
249 if( !cinepak_CheckVout( p_vout, i_width, i_height ) )
251 /* We are not interested in this format, close this vout */
252 vlc_object_detach( p_vout );
253 vlc_object_release( p_vout );
254 vout_DestroyThread( p_vout );
259 /* This video output is cool! Hijack it. */
260 vlc_object_detach( p_vout );
261 vlc_object_attach( p_vout, p_vdec->p_fifo );
262 vlc_object_release( p_vout );
268 msg_Dbg( p_vdec->p_fifo, "no vout present, spawning one" );
270 p_vout = vout_CreateThread( p_vdec->p_fifo,
273 VLC_FOURCC('I','4','2','0'),
274 VOUT_ASPECT_FACTOR * i_width / i_height );
280 void cinepak_LoadCodebook( cinepak_codebook_t *p_codebook,
284 int i, i_y[4], i_u, i_v, i_Cb, i_Cr;
287 #define FIX( x ) ( (int)( (x) * ( 1L << SCALEBITS ) + 0.5 ) )
289 for( i = 0; i < 4; i++ )
291 i_y[i] = (u8)( *(p_data++) );
295 i_u = (s8)( *(p_data++) );
296 i_v = (s8)( *(p_data++) );
305 | Y | | 1 -0.0655 0.0110 | | CY |
306 | Cb | = | 0 1.1656 -0.0062 | | CU |
307 | Cr | | 0 0.0467 1.4187 | | CV |
309 i_uv = ( FIX( -0.0655 ) * i_u + FIX( 0.0110 ) * i_v ) >> SCALEBITS;
310 for( i = 0; i < 4; i++ )
314 i_Cb = ( FIX( 1.1656 ) * i_u + FIX( -0.0062 ) * i_v ) >> SCALEBITS;
315 i_Cr = ( FIX( 0.0467 ) * i_u + FIX( 1.4187 ) * i_v ) >> SCALEBITS;
317 for( i = 0; i < 4; i++ )
319 p_codebook->i_y[i] = __MIN( __MAX( 0, i_y[i] ), 255 );
321 p_codebook->i_u = __MIN( __MAX( 0, i_Cb + 128 ), 255 );
322 p_codebook->i_v = __MIN( __MAX( 0, i_Cr + 128 ), 255 );
328 void cinepak_Getv4( cinepak_context_t *p_context,
337 u8 *p_dst_y, *p_dst_u, *p_dst_v;
338 #define PIX_SET_Y( x, y, v ) \
339 p_dst_y[(x) + (y)* p_context->i_stride[0]] = (v);
341 #define PIX_SET_UV( i, p, x, y, v ) \
342 p[(x) + (y)* (p_context->i_stride[i])] = (v);
344 for( i = 0; i < 4; i++ )
346 i_index[i] = *(p_data++);
350 p_dst_y = p_context->p_pix[0] + p_context->i_stride[0] * i_y + i_x;
351 p_dst_u = p_context->p_pix[1] + p_context->i_stride[1] * (i_y/2) + (i_x/2);
352 p_dst_v = p_context->p_pix[2] + p_context->i_stride[2] * (i_y/2) + (i_x/2);
354 for( i = 0; i < 2; i++ )
356 for( j = 0; j < 2; j ++ )
358 PIX_SET_Y( 2*j + 0, 2*i + 0,
359 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[0]);
360 PIX_SET_Y( 2*j + 1, 2*i + 0,
361 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[1]);
362 PIX_SET_Y( 2*j + 0, 2*i + 1,
363 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[2]);
364 PIX_SET_Y( 2*j + 1, 2*i + 1,
365 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_y[3]);
367 PIX_SET_UV( 1, p_dst_u, j, i,
368 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_u );
369 PIX_SET_UV( 2, p_dst_v, j, i,
370 p_context->codebook_v4[i_strip][i_index[j+2*i]].i_v );
377 void cinepak_Getv1( cinepak_context_t *p_context,
386 u8 *p_dst_y, *p_dst_u, *p_dst_v;
387 #define PIX_SET_Y( x, y, v ) \
388 p_dst_y[(x) + (y)* p_context->i_stride[0]] = (v);
390 #define PIX_SET_UV( i,p, x, y, v ) \
391 p[(x) + (y)* (p_context->i_stride[i])] = (v);
393 i_index = *(p_data++);
396 p_dst_y = p_context->p_pix[0] + p_context->i_stride[0] * i_y + i_x;
397 p_dst_u = p_context->p_pix[1] + p_context->i_stride[1] * (i_y/2) + (i_x/2);
398 p_dst_v = p_context->p_pix[2] + p_context->i_stride[2] * (i_y/2) + (i_x/2);
400 for( i = 0; i < 2; i++ )
402 for( j = 0; j < 2; j ++ )
404 PIX_SET_Y( 2*j + 0, 2*i + 0,
405 p_context->codebook_v1[i_strip][i_index].i_y[0] );
406 PIX_SET_Y( 2*j + 1, 2*i + 0,
407 p_context->codebook_v1[i_strip][i_index].i_y[1] );
408 PIX_SET_Y( 2*j + 0, 2*i + 1,
409 p_context->codebook_v1[i_strip][i_index].i_y[2] );
410 PIX_SET_Y( 2*j + 1, 2*i + 1,
411 p_context->codebook_v1[i_strip][i_index].i_y[3] );
413 PIX_SET_UV( 1,p_dst_u, j, i,
414 p_context->codebook_v1[i_strip][i_index].i_u );
415 PIX_SET_UV( 2,p_dst_v, j, i,
416 p_context->codebook_v1[i_strip][i_index].i_v );
424 /*****************************************************************************
425 * The function that decode one frame
426 *****************************************************************************/
427 int cinepak_decode_frame( cinepak_context_t *p_context,
428 int i_length, u8 *p_data )
434 int i_width, i_height;
437 int i_strip_x1 =0, i_strip_y1=0;
438 int i_strip_x2 =0, i_strip_y2=0;
442 /* Broken header or no data */
447 i_frame_flags = *(p_data++);
448 i_frame_size = GET3BYTES( p_data );
449 i_width = GET2BYTES( p_data );
450 i_height = GET2BYTES( p_data );
451 i_frame_strips = GET2BYTES( p_data );
453 /* Check if we have a picture buffer with good size */
454 if( ( p_context->i_width != i_width )||
455 ( p_context->i_height != i_height ) )
458 for( i = 0; i < 3; i++ )
460 FREE( p_context->p_pix[i] );
463 p_context->i_width = i_width;
464 p_context->i_height = i_height;
466 p_context->i_stride[0] = ( i_width + 3)&0xfffc;
467 p_context->i_stride[1] = p_context->i_stride[2] =
468 p_context->i_stride[0] / 2;
470 p_context->i_lines[0] = ( i_height + 3 )&0xfffc;
471 p_context->i_lines[1] = p_context->i_lines[2] =
472 p_context->i_lines[0] /2;
474 for( i = 0; i < 3; i++ )
476 p_context->p_pix[i] = malloc( p_context->i_stride[i] *
477 p_context->i_lines[i] );
478 /* Set it to all black */
479 memset( p_context->p_pix[i], ( i == 0 ) ? 0 : 128 ,
480 p_context->i_stride[i] * p_context->i_lines[i] );
484 if( i_frame_size != i_length )
486 i_length = __MIN( i_length, i_frame_size );
490 if( i_frame_strips >= CINEPAK_MAXSTRIP )
492 i_frame_strips = CINEPAK_MAXSTRIP;
495 /* Now decode each strip */
497 for( i_strip = 0; i_strip < i_frame_strips; i_strip++ )
508 i_strip_id = GET2BYTES( p_data );
509 i_strip_size = GET2BYTES( p_data );
510 i_strip_size = __MIN( i_strip_size, i_length );
511 /* FIXME I don't really understand how it's work; */
512 i_strip_y1 = i_strip_y2 + GET2BYTES( p_data );
513 i_strip_x1 = GET2BYTES( p_data );
514 i_strip_y2 = i_strip_y2 + GET2BYTES( p_data );
515 i_strip_x2 = GET2BYTES( p_data );
517 i_length -= i_strip_size;
520 /* init codebook , if needed */
521 if( ( i_strip > 0 )&&( !(i_frame_flags&0x01) ) )
523 memcpy( &p_context->codebook_v1[i_strip],
524 &p_context->codebook_v1[i_strip-1],
525 sizeof(cinepak_codebook_t[256] ) );
527 memcpy( &p_context->codebook_v4[i_strip],
528 &p_context->codebook_v4[i_strip-1],
529 sizeof(cinepak_codebook_t[256] ) );
532 /* Now parse all chunk in this strip */
533 while( i_strip_size > 0 )
535 cinepak_codebook_t (*p_codebook)[CINEPAK_MAXSTRIP][256];
543 int i_x, i_y; /* (0,0) begin in fact at (x1,y1) ... */
545 i_chunk_id = GET2BYTES( p_data );
546 i_chunk_size = GET2BYTES( p_data );
547 i_chunk_size = __MIN( i_chunk_size, i_strip_size );
548 i_strip_size -= i_chunk_size;
554 if( i_chunk_size < 0 )
561 case( 0x2000 ): /* 12bits v4 Intra*/
562 case( 0x2200 ): /* 12bits v1 Intra*/
563 case( 0x2400 ): /* 8bits v4 Intra*/
564 case( 0x2600 ): /* 8bits v1 Intra */
565 i_mode = ( ( i_chunk_id&0x0400 ) == 0 );
566 p_codebook = ( i_chunk_id&0x0200 ) ?
567 &p_context->codebook_v1 :
568 &p_context->codebook_v4;
570 i_count = __MIN( i_chunk_size / ( i_mode ? 6 : 4 ), 256 );
572 for( i = 0; i < i_count; i++ )
574 cinepak_LoadCodebook( &((*p_codebook)[i_strip][i]),
576 i_mode&~p_context->b_grayscale );
577 p_data += i_mode ? 6 : 4;
578 i_chunk_size -= i_mode ? 6 : 4;
582 case( 0x2100 ): /* selective 12bits v4 Inter*/
583 case( 0x2300 ): /* selective 12bits v1 Inter*/
584 case( 0x2500 ): /* selective 8bits v4 Inter*/
585 case( 0x2700 ): /* selective 8bits v1 Inter*/
586 i_mode = ( ( i_chunk_id&0x0400 ) == 0 );
587 p_codebook = ( i_chunk_id&0x0200 ) ?
588 &p_context->codebook_v1 :
589 &p_context->codebook_v4;
592 while( (i_chunk_size > 4)&&(i_index<256))
594 i_vector_flags = GET4BYTES( p_data );
596 for( i = 0; i < 32; i++ )
598 if( ( i_chunk_size < ( i_mode ? 6 : 4 ) )||(i_index >= 256 ))
602 if( i_vector_flags&0x80000000UL )
604 cinepak_LoadCodebook( &((*p_codebook)[i_strip][i_index]),
606 i_mode&~p_context->b_grayscale );
608 p_data += i_mode ? 6 : 4;
609 i_chunk_size -= i_mode ? 6 : 4;
612 i_vector_flags <<= 1;
617 case( 0x3000 ): /* load image Intra */
618 while( (i_chunk_size >= 4 )&&(i_y<i_strip_y2-i_strip_y1) )
620 i_vector_flags = GET4BYTES( p_data );
625 for( i = 0; i < 32; i++ )
627 if( ( i_y >= i_strip_y2 - i_strip_y1)||
632 if( i_vector_flags&0x80000000UL )
634 cinepak_Getv4( p_context,
638 i_strip_x2, i_strip_y2,
645 cinepak_Getv1( p_context,
649 i_strip_x2, i_strip_y2,
656 if( i_x >= i_strip_x2 - i_strip_x1 )
661 i_vector_flags <<= 1;
666 case( 0x3100 ): /* load image Inter */
667 while( ( i_chunk_size > 4 )&&( i_y < i_strip_y2 - i_strip_y1) )
670 i_vector_flags = GET4BYTES( p_data );
672 i_mask = 0x80000000UL;
674 while((i_chunk_size > 0 )&&( i_mask )&&( i_y < i_strip_y2 - i_strip_y1 ))
676 if( i_vector_flags&i_mask)
681 if( i_chunk_size < 4 )
685 i_vector_flags = GET4BYTES( p_data );
687 i_mask = 0x80000000UL;
689 if( i_vector_flags&i_mask )
691 if( i_chunk_size < 4 ) break;
692 cinepak_Getv4( p_context,
696 i_strip_x2, i_strip_y2,
703 if( i_chunk_size < 1 ) break;
704 cinepak_Getv1( p_context,
708 i_strip_x2, i_strip_y2,
717 if( i_x >= i_strip_x2 - i_strip_x1 )
726 case( 0x3200 ): /* load intra picture but all v1*/
727 while( ( i_chunk_size > 0 )&&
728 ( i_y < i_strip_y2 - i_strip_y1) )
730 cinepak_Getv1( p_context,
734 i_strip_x2, i_strip_y2,
740 if( i_x >= i_strip_x2 - i_strip_x1 )
755 p_data += i_chunk_size ; /* skip remains bytes */
765 /*****************************************************************************
767 * Functions that initialize, decode and end the decoding process
769 *****************************************************************************/
771 /*****************************************************************************
772 * InitThread: initialize vdec output thread
773 *****************************************************************************
774 * This function is called from decoder_Run and performs the second step
775 * of the initialization. It returns 0 on success. Note that the thread's
776 * flag are not modified inside this function.
777 *****************************************************************************/
779 static int InitThread( videodec_thread_t *p_vdec )
782 /* This will be created after the first decoded frame */
783 if( !(p_vdec->p_context = malloc( sizeof( cinepak_context_t ) ) ) )
785 msg_Err( p_vdec->p_fifo, "out of memory" );
787 memset( p_vdec->p_context, 0, sizeof( cinepak_context_t ) );
789 if( config_GetInt( p_vdec->p_fifo, "grayscale" ) )
791 p_vdec->p_context->b_grayscale = 1;
795 p_vdec->p_context->b_grayscale = 0;
798 p_vdec->p_vout = NULL;
799 msg_Dbg( p_vdec->p_fifo, "cinepak decoder started" );
804 /*****************************************************************************
805 * DecodeThread: Called for decode one frame
806 *****************************************************************************/
807 static void DecodeThread( videodec_thread_t *p_vdec )
813 picture_t *p_pic; /* videolan picture */
815 __GetFrame( p_vdec );
817 i_status = cinepak_decode_frame( p_vdec->p_context,
819 p_vdec->p_framedata );
820 __NextFrame( p_vdec );
824 msg_Warn( p_vdec->p_fifo, "cannot decode one frame (%d bytes)",
825 p_vdec->i_framesize );
830 if( !cinepak_CheckVout( p_vdec->p_vout,
831 p_vdec->p_context->i_width,
832 p_vdec->p_context->i_height ) )
835 cinepak_CreateVout( p_vdec,
836 p_vdec->p_context->i_width,
837 p_vdec->p_context->i_height );
839 if( !p_vdec->p_vout )
841 msg_Err( p_vdec->p_fifo, "cannot create vout" );
842 p_vdec->p_fifo->b_error = 1; /* abort */
847 /* Send decoded frame to vout */
848 while( !(p_pic = vout_CreatePicture( p_vdec->p_vout, 0, 0, 0 ) ) )
850 if( p_vdec->p_fifo->b_die || p_vdec->p_fifo->b_error )
854 msleep( VOUT_OUTMEM_SLEEP );
857 for( i_plane = 0; i_plane < 3; i_plane++ )
861 p_dst = p_pic->p[i_plane].p_pixels;
862 p_src = p_vdec->p_context->p_pix[i_plane];
864 i_lines = __MIN( p_vdec->p_context->i_lines[i_plane],
865 p_pic->p[i_plane].i_lines );
866 for( i_line = 0; i_line < i_lines; i_line++ )
870 __MIN( p_pic->p[i_plane].i_pitch,
871 p_vdec->p_context->i_stride[i_plane] ) );
872 p_dst += p_pic->p[i_plane].i_pitch;
873 p_src += p_vdec->p_context->i_stride[i_plane];
877 vout_DatePicture( p_vdec->p_vout, p_pic, p_vdec->i_pts);
878 vout_DisplayPicture( p_vdec->p_vout, p_pic );
884 /*****************************************************************************
885 * EndThread: thread destruction
886 *****************************************************************************
887 * This function is called when the thread ends after a sucessful
889 *****************************************************************************/
890 static void EndThread( videodec_thread_t *p_vdec )
898 msg_Dbg( p_vdec->p_fifo, "cinepak decoder stopped" );
900 for( i = 0; i < 3; i++ )
902 FREE( p_vdec->p_context->p_pix[i] );
905 free( p_vdec->p_context );
907 if( p_vdec->p_vout != NULL )
909 /* We are about to die. Reattach video output to p_vlc. */
910 vlc_object_detach( p_vdec->p_vout );
911 vlc_object_attach( p_vdec->p_vout, p_vdec->p_fifo->p_vlc );