1 /*****************************************************************************
2 * spu_decoder.c : spu decoder thread
3 *****************************************************************************
4 * Copyright (C) 2000-2001 VideoLAN
5 * $Id: spu_decoder.c,v 1.4 2001/11/28 15:08:06 massiot Exp $
7 * Authors: Samuel Hocevar <sam@zoy.org>
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 #define MODULE_NAME spu_dec
25 #include "modules_inner.h"
27 /*****************************************************************************
29 *****************************************************************************/
33 #include <unistd.h> /* getpid() */
36 #ifdef WIN32 /* getpid() for win32 is located in process.h */
40 #include <stdlib.h> /* malloc(), free() */
41 #include <string.h> /* memcpy(), memset() */
50 #include "video_output.h"
53 #include "modules_export.h"
54 #include "stream_control.h"
55 #include "input_ext-dec.h"
57 #include "spu_decoder.h"
59 /*****************************************************************************
61 *****************************************************************************/
62 static int spu_dec_Probe ( probedata_t * );
63 static int spu_dec_Run ( decoder_config_t * );
64 static int spu_dec_Init ( spudec_thread_t * );
65 static void spu_dec_ErrorThread ( spudec_thread_t * );
66 static void spu_dec_EndThread ( spudec_thread_t * );
68 static int SyncPacket ( spudec_thread_t * );
69 static void ParsePacket ( spudec_thread_t * );
70 static int ParseControlSequences( spudec_thread_t *, subpicture_t * );
71 static int ParseRLE ( spudec_thread_t *, subpicture_t *, u8 * );
73 /*****************************************************************************
75 *****************************************************************************/
76 void _M( spu_dec_getfunctions )( function_list_t * p_function_list )
78 p_function_list->pf_probe = spu_dec_Probe;
79 p_function_list->functions.dec.pf_RunThread = spu_dec_Run;
82 /*****************************************************************************
83 * Build configuration tree.
84 *****************************************************************************/
86 ADD_WINDOW( "Configuration for SPU decoder module" )
87 ADD_COMMENT( "Nothing to configure" )
91 p_module->i_capabilities = MODULE_CAPABILITY_DEC;
92 p_module->psz_longname = "subtitles decoder module";
96 _M( spu_dec_getfunctions )( &p_module->p_functions->dec );
99 MODULE_DEACTIVATE_START
100 MODULE_DEACTIVATE_STOP
102 /*****************************************************************************
103 * spu_dec_Probe: probe the decoder and return score
104 *****************************************************************************
105 * Tries to launch a decoder and return score so that the interface is able
107 *****************************************************************************/
108 static int spu_dec_Probe( probedata_t *p_data )
110 if( p_data->i_type == DVD_SPU_ES )
116 /*****************************************************************************
117 * spu_dec_Run: this function is called just after the thread is created
118 *****************************************************************************/
119 static int spu_dec_Run( decoder_config_t * p_config )
121 spudec_thread_t * p_spudec;
123 intf_WarnMsg( 3, "spudec: thread launched. Initializing ..." );
125 /* Allocate the memory needed to store the thread's structure */
126 p_spudec = (spudec_thread_t *)malloc( sizeof(spudec_thread_t) );
128 if ( p_spudec == NULL )
130 intf_ErrMsg( "spudec error: not enough memory "
131 "for spudec_CreateThread() to create the new thread" );
136 * Initialize the thread properties
138 p_spudec->p_config = p_config;
140 p_spudec->p_fifo = p_config->p_decoder_fifo;
143 * Initialize thread and free configuration
145 p_spudec->p_fifo->b_error = spu_dec_Init( p_spudec );
148 * Main loop - it is not executed if an error occured during
151 while( (!p_spudec->p_fifo->b_die) && (!p_spudec->p_fifo->b_error) )
153 if( !SyncPacket( p_spudec ) )
155 ParsePacket( p_spudec );
162 if( p_spudec->p_fifo->b_error )
164 spu_dec_ErrorThread( p_spudec );
168 spu_dec_EndThread( p_spudec );
170 if( p_spudec->p_fifo->b_error )
179 /* following functions are local */
181 /*****************************************************************************
182 * spu_dec_Init: initialize spu decoder thread
183 *****************************************************************************
184 * This function is called from RunThread and performs the second step of the
185 * initialization. It returns 0 on success. Note that the thread's flag are not
186 * modified inside this function.
187 *****************************************************************************/
188 static int spu_dec_Init( spudec_thread_t *p_spudec )
190 /* Spawn a video output if there is none */
191 vlc_mutex_lock( &p_vout_bank->lock );
193 if( p_vout_bank->i_count == 0 )
195 intf_WarnMsg( 1, "spudec: no vout present, spawning one" );
197 p_spudec->p_vout = vout_CreateThread( NULL, 0, 0 );
199 /* Everything failed */
200 if( p_spudec->p_vout == NULL )
202 intf_Msg( "spudec: can't open vout, aborting" );
203 vlc_mutex_unlock( &p_vout_bank->lock );
209 p_vout_bank->pp_vout[ p_vout_bank->i_count ] = p_spudec->p_vout;
210 p_vout_bank->i_count++;
214 /* Take the first video output FIXME: take the best one */
215 p_spudec->p_vout = p_vout_bank->pp_vout[ 0 ];
218 vlc_mutex_unlock( &p_vout_bank->lock );
219 p_spudec->p_config->pf_init_bit_stream(
220 &p_spudec->bit_stream,
221 p_spudec->p_config->p_decoder_fifo, NULL, NULL );
223 /* Mark thread as running and return */
227 /*****************************************************************************
228 * spu_dec_ErrorThread: spu_dec_Run() error loop
229 *****************************************************************************
230 * This function is called when an error occured during thread main's loop. The
231 * thread can still receive feed, but must be ready to terminate as soon as
233 *****************************************************************************/
234 static void spu_dec_ErrorThread( spudec_thread_t *p_spudec )
236 /* We take the lock, because we are going to read/write the start/end
237 * indexes of the decoder fifo */
238 vlc_mutex_lock( &p_spudec->p_fifo->data_lock );
240 /* Wait until a `die' order is sent */
241 while( !p_spudec->p_fifo->b_die )
243 /* Trash all received PES packets */
244 while( !DECODER_FIFO_ISEMPTY(*p_spudec->p_fifo) )
246 p_spudec->p_fifo->pf_delete_pes( p_spudec->p_fifo->p_packets_mgt,
247 DECODER_FIFO_START(*p_spudec->p_fifo) );
248 DECODER_FIFO_INCSTART( *p_spudec->p_fifo );
251 /* Waiting for the input thread to put new PES packets in the fifo */
252 vlc_cond_wait( &p_spudec->p_fifo->data_wait,
253 &p_spudec->p_fifo->data_lock );
256 /* We can release the lock before leaving */
257 vlc_mutex_unlock( &p_spudec->p_fifo->data_lock );
260 /*****************************************************************************
261 * spu_dec_EndThread: thread destruction
262 *****************************************************************************
263 * This function is called when the thread ends after a sucessful
265 *****************************************************************************/
266 static void spu_dec_EndThread( spudec_thread_t *p_spudec )
271 /*****************************************************************************
272 * SyncPacket: get in sync with the stream
273 *****************************************************************************
274 * This function makes a few sanity checks and returns 0 if it looks like we
275 * are at the beginning of a subpicture packet.
276 *****************************************************************************/
277 static int SyncPacket( spudec_thread_t *p_spudec )
279 /* Re-align the buffer on an 8-bit boundary */
280 RealignBits( &p_spudec->bit_stream );
282 /* The total SPU packet size, often bigger than a PS packet */
283 p_spudec->i_spu_size = GetBits( &p_spudec->bit_stream, 16 );
285 /* The RLE stuff size (remove 4 because we just read 32 bits) */
286 p_spudec->i_rle_size = ShowBits( &p_spudec->bit_stream, 16 ) - 4;
288 /* If the values we got are a bit strange, skip packet */
289 if( !p_spudec->i_spu_size
290 || ( p_spudec->i_rle_size >= p_spudec->i_spu_size ) )
295 RemoveBits( &p_spudec->bit_stream, 16 );
300 /*****************************************************************************
301 * ParsePacket: parse an SPU packet and send it to the video output
302 *****************************************************************************
303 * This function parses the SPU packet and, if valid, sends it to the
305 *****************************************************************************/
306 static void ParsePacket( spudec_thread_t *p_spudec )
308 subpicture_t * p_spu;
310 unsigned int i_offset;
312 intf_WarnMsg( 3, "spudec: trying to gather a 0x%.2x long subtitle",
313 p_spudec->i_spu_size );
315 /* We cannot display a subpicture with no date */
316 if( DECODER_FIFO_START(*p_spudec->p_fifo)->i_pts == 0 )
318 intf_WarnMsg( 3, "spudec error: subtitle without a date" );
322 /* Allocate the subpicture internal data. */
323 p_spu = vout_CreateSubPicture( p_spudec->p_vout, DVD_SUBPICTURE,
324 p_spudec->i_rle_size * 4 );
325 /* Rationale for the "p_spudec->i_rle_size * 4": we are going to
326 * expand the RLE stuff so that we won't need to read nibbles later
327 * on. This will speed things up a lot. Plus, we'll only need to do
328 * this stupid interlacing stuff once. */
335 /* Get display time now. If we do it later, we may miss the PTS. */
336 p_spudec->i_pts = DECODER_FIFO_START(*p_spudec->p_fifo)->i_pts;
338 /* Allocate the temporary buffer we will parse */
339 p_src = malloc( p_spudec->i_rle_size );
343 intf_ErrMsg( "spudec error: could not allocate p_src" );
344 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
350 i_offset + SPU_CHUNK_SIZE < p_spudec->i_rle_size;
351 i_offset += SPU_CHUNK_SIZE )
353 GetChunk( &p_spudec->bit_stream, p_src + i_offset, SPU_CHUNK_SIZE );
355 /* Abort subtitle parsing if we were requested to stop */
356 if( p_spudec->p_fifo->b_die )
359 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
364 GetChunk( &p_spudec->bit_stream, p_src + i_offset,
365 p_spudec->i_rle_size - i_offset );
368 /* Dump the subtitle info */
369 intf_WarnHexDump( 5, p_spu->p_data, p_spudec->i_rle_size );
372 /* Getting the control part */
373 if( ParseControlSequences( p_spudec, p_spu ) )
375 /* There was a parse error, delete the subpicture */
377 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
381 /* At this point, no more GetBit() command is needed, so we have all
382 * the data we need to tell whether the subtitle is valid. Thus we
383 * try to display it and we ignore b_die. */
385 if( ParseRLE( p_spudec, p_spu, p_src ) )
387 /* There was a parse error, delete the subpicture */
389 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
393 intf_WarnMsg( 3, "spudec: total size: 0x%x, RLE offsets: 0x%x 0x%x",
394 p_spudec->i_spu_size,
395 p_spu->type.spu.i_offset[0], p_spu->type.spu.i_offset[1] );
397 /* SPU is finished - we can ask the video output to display it */
398 vout_DisplaySubPicture( p_spudec->p_vout, p_spu );
404 /*****************************************************************************
405 * ParseControlSequences: parse all SPU control sequences
406 *****************************************************************************
407 * This is the most important part in SPU decoding. We get dates, palette
408 * information, coordinates, and so on. For more information on the
409 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
410 *****************************************************************************/
411 static int ParseControlSequences( spudec_thread_t *p_spudec,
412 subpicture_t * p_spu )
414 /* Our current index in the SPU packet */
415 int i_index = p_spudec->i_rle_size + 4;
417 /* The next start-of-control-sequence index and the previous one */
418 int i_next_seq, i_cur_seq;
420 /* Command time and date */
424 /* XXX: temporary variables */
425 boolean_t b_force_display = 0;
427 /* Initialize the structure */
428 p_spu->i_start = p_spu->i_stop = 0;
429 p_spu->b_ephemer = 0;
433 /* Get the control sequence date */
434 i_date = GetBits( &p_spudec->bit_stream, 16 );
438 i_next_seq = GetBits( &p_spudec->bit_stream, 16 );
440 /* Skip what we just read */
445 i_command = GetBits( &p_spudec->bit_stream, 8 );
450 case SPU_CMD_FORCE_DISPLAY:
452 /* 00 (force displaying) */
453 p_spu->i_start = p_spudec->i_pts + ( i_date * 11000 );
458 /* Convert the dates in seconds to PTS values */
459 case SPU_CMD_START_DISPLAY:
461 /* 01 (start displaying) */
462 p_spu->i_start = p_spudec->i_pts + ( i_date * 11000 );
466 case SPU_CMD_STOP_DISPLAY:
468 /* 02 (stop displaying) */
469 p_spu->i_stop = p_spudec->i_pts + ( i_date * 11000 );
473 case SPU_CMD_SET_PALETTE:
475 /* 03xxxx (palette) - trashed */
476 RemoveBits( &p_spudec->bit_stream, 16 );
481 case SPU_CMD_SET_ALPHACHANNEL:
483 /* 04xxxx (alpha channel) - trashed */
484 RemoveBits( &p_spudec->bit_stream, 16 );
489 case SPU_CMD_SET_COORDINATES:
491 /* 05xxxyyyxxxyyy (coordinates) */
492 p_spu->i_x = GetBits( &p_spudec->bit_stream, 12 );
493 p_spu->i_width = GetBits( &p_spudec->bit_stream, 12 )
496 p_spu->i_y = GetBits( &p_spudec->bit_stream, 12 );
497 p_spu->i_height = GetBits( &p_spudec->bit_stream, 12 )
504 case SPU_CMD_SET_OFFSETS:
506 /* 06xxxxyyyy (byte offsets) */
507 p_spu->type.spu.i_offset[0] =
508 GetBits( &p_spudec->bit_stream, 16 ) - 4;
510 p_spu->type.spu.i_offset[1] =
511 GetBits( &p_spudec->bit_stream, 16 ) - 4;
524 /* xx (unknown command) */
525 intf_ErrMsg( "spudec error: unknown command 0x%.2x",
530 /* We need to check for quit commands here */
531 if( p_spudec->p_fifo->b_die )
536 } while( i_command != SPU_CMD_END );
538 } while( i_index == i_next_seq );
540 /* Check that the next sequence index matches the current one */
541 if( i_next_seq != i_cur_seq )
543 intf_ErrMsg( "spudec error: index mismatch (0x%.4x != 0x%.4x)",
544 i_next_seq, i_cur_seq );
548 if( i_index > p_spudec->i_spu_size )
550 intf_ErrMsg( "spudec error: uh-oh, we went too far (0x%.4x > 0x%.4x)",
551 i_index, p_spudec->i_spu_size );
555 if( !p_spu->i_start )
557 intf_ErrMsg( "spudec error: no `start display' command" );
562 /* This subtitle will live for 5 seconds or until the next subtitle */
563 p_spu->i_stop = p_spu->i_start + 500 * 11000;
564 p_spu->b_ephemer = 1;
567 /* Get rid of padding bytes */
568 switch( p_spudec->i_spu_size - i_index )
570 /* Zero or one padding byte, quite usual */
572 RemoveBits( &p_spudec->bit_stream, 8 );
577 /* More than one padding byte - this is very strange, but
578 * we can deal with it */
580 intf_WarnMsg( 2, "spudec warning: %i padding bytes, we usually "
581 "get 0 or 1 of them",
582 p_spudec->i_spu_size - i_index );
584 while( i_index < p_spudec->i_spu_size )
586 RemoveBits( &p_spudec->bit_stream, 8 );
593 if( b_force_display )
595 intf_ErrMsg( "spudec: \"force display\" command" );
596 intf_ErrMsg( "spudec: send mail to <sam@zoy.org> if you "
597 "want to help debugging this" );
600 /* Successfully parsed ! */
604 /*****************************************************************************
605 * ParseRLE: parse the RLE part of the subtitle
606 *****************************************************************************
607 * This part parses the subtitle graphical data and stores it in a more
608 * convenient structure for later decoding. For more information on the
609 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
610 *****************************************************************************/
611 static int ParseRLE( spudec_thread_t *p_spudec,
612 subpicture_t * p_spu, u8 * p_src )
616 unsigned int i_width = p_spu->i_width;
617 unsigned int i_height = p_spu->i_height;
618 unsigned int i_x, i_y;
620 u16 *p_dest = (u16 *)p_spu->p_data;
622 /* The subtitles are interlaced, we need two offsets */
623 unsigned int i_id = 0; /* Start on the even SPU layer */
624 unsigned int pi_table[ 2 ];
625 unsigned int *pi_offset;
627 boolean_t b_empty_top = 1,
629 unsigned int i_skipped_top = 0,
630 i_skipped_bottom = 0;
632 pi_table[ 0 ] = p_spu->type.spu.i_offset[ 0 ] << 1;
633 pi_table[ 1 ] = p_spu->type.spu.i_offset[ 1 ] << 1;
635 for( i_y = 0 ; i_y < i_height ; i_y++ )
637 pi_offset = pi_table + i_id;
639 for( i_x = 0 ; i_x < i_width ; i_x += i_code >> 2 )
641 i_code = AddNibble( 0, p_src, pi_offset );
645 i_code = AddNibble( i_code, p_src, pi_offset );
649 i_code = AddNibble( i_code, p_src, pi_offset );
653 i_code = AddNibble( i_code, p_src, pi_offset );
655 if( i_code < 0x0100 )
657 /* If the 14 first bits are set to 0, then it's a
658 * new line. We emulate it. */
659 if( i_code < 0x0004 )
661 i_code |= ( i_width - i_x ) << 2;
665 /* We have a boo boo ! */
666 intf_ErrMsg( "spudec error: unknown RLE code "
675 if( ( (i_code >> 2) + i_x + i_y * i_width ) > i_height * i_width )
677 intf_ErrMsg( "spudec error: out of bounds, %i at (%i,%i) is "
679 i_code >> 2, i_x, i_y, i_width, i_height );
683 if( i_code == (i_width << 2) ) /* FIXME: we assume 0 is transp */
687 /* This is a blank top line, we skip it */
692 /* We can't be sure the current lines will be skipped,
693 * so we store the code just in case. */
702 /* We got a valid code, store it */
705 /* Valid code means no blank line */
708 i_skipped_bottom = 0;
712 /* Check that we didn't go too far */
715 intf_ErrMsg( "spudec error: i_x overflowed, %i > %i",
720 /* Byte-align the stream */
721 if( *pi_offset & 0x1 )
730 /* We shouldn't get any padding bytes */
733 intf_ErrMsg( "spudec: padding bytes found in RLE sequence" );
734 intf_ErrMsg( "spudec: send mail to <sam@zoy.org> if you "
735 "want to help debugging this" );
737 /* Skip them just in case */
738 while( i_y < i_height )
740 *p_dest++ = i_width << 2;
747 intf_WarnMsg( 3, "spudec: valid subtitle, size: %ix%i, position: %i,%i",
748 p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );
750 /* Crop if necessary */
751 if( i_skipped_top || i_skipped_bottom )
753 p_spu->i_y += i_skipped_top;
754 p_spu->i_height -= i_skipped_top + i_skipped_bottom;
756 intf_WarnMsg( 3, "spudec: cropped to: %ix%i, position: %i,%i",
757 p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );