1 /*****************************************************************************
2 * spu_decoder.c : spu decoder thread
3 *****************************************************************************
4 * Copyright (C) 2000 VideoLAN
5 * $Id: spu_decoder.c,v 1.40 2001/05/06 04:32:02 sam 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 /*****************************************************************************
26 *****************************************************************************/
29 #include <unistd.h> /* getpid() */
30 #ifdef WIN32 /* getpid() for win32 is located in process.h */
34 #include <stdlib.h> /* malloc(), free() */
35 #include <string.h> /* memcpy(), memset() */
44 #include "stream_control.h"
45 #include "input_ext-dec.h"
48 #include "video_output.h"
50 #include "spu_decoder.h"
52 #include "main.h" /* XXX: remove this later */
54 /*****************************************************************************
56 *****************************************************************************/
57 static int InitThread ( spudec_thread_t * );
58 static void RunThread ( spudec_thread_t * );
59 static void ErrorThread ( spudec_thread_t * );
60 static void EndThread ( spudec_thread_t * );
62 static int SyncPacket ( spudec_thread_t * );
63 static void ParsePacket ( spudec_thread_t * );
64 static int ParseControlSequences( spudec_thread_t *, subpicture_t * );
65 static int ParseRLE ( u8 *, subpicture_t * );
67 /*****************************************************************************
68 * spudec_CreateThread: create a spu decoder thread
69 *****************************************************************************/
70 vlc_thread_t spudec_CreateThread( vdec_config_t * p_config )
72 spudec_thread_t * p_spudec;
74 /* Allocate the memory needed to store the thread's structure */
75 p_spudec = (spudec_thread_t *)malloc( sizeof(spudec_thread_t) );
77 if ( p_spudec == NULL )
79 intf_ErrMsg( "spudec error: not enough memory "
80 "for spudec_CreateThread() to create the new thread" );
85 * Initialize the thread properties
87 p_spudec->p_config = p_config;
89 p_spudec->p_fifo = p_config->decoder_config.p_decoder_fifo;
91 /* XXX: The vout request and fifo opening will eventually be here */
93 /* Spawn an audio output if there is none */
94 vlc_mutex_lock( &p_vout_bank->lock );
96 if( p_vout_bank->i_count == 0 )
98 intf_Msg( "spudec: no vout present, spawning one" );
100 p_spudec->p_vout = vout_CreateThread( NULL );
102 /* Everything failed */
103 if( p_spudec->p_vout == NULL )
105 intf_Msg( "spudec: can't open vout, aborting" );
106 vlc_mutex_unlock( &p_vout_bank->lock );
112 p_vout_bank->pp_vout[ p_vout_bank->i_count ] = p_spudec->p_vout;
113 p_vout_bank->i_count++;
117 /* Take the first video output FIXME: take the best one */
118 p_spudec->p_vout = p_vout_bank->pp_vout[ 0 ];
121 vlc_mutex_unlock( &p_vout_bank->lock );
123 /* Spawn the spu decoder thread */
124 if ( vlc_thread_create(&p_spudec->thread_id, "spu decoder",
125 (vlc_thread_func_t)RunThread, (void *)p_spudec) )
127 intf_ErrMsg( "spudec error: can't spawn spu decoder thread" );
132 return( p_spudec->thread_id );
135 /* following functions are local */
137 /*****************************************************************************
138 * InitThread: initialize spu decoder thread
139 *****************************************************************************
140 * This function is called from RunThread and performs the second step of the
141 * initialization. It returns 0 on success. Note that the thread's flag are not
142 * modified inside this function.
143 *****************************************************************************/
144 static int InitThread( spudec_thread_t *p_spudec )
146 p_spudec->p_config->decoder_config.pf_init_bit_stream(
147 &p_spudec->bit_stream,
148 p_spudec->p_config->decoder_config.p_decoder_fifo, NULL, NULL );
150 /* Mark thread as running and return */
154 /*****************************************************************************
155 * RunThread: spu decoder thread
156 *****************************************************************************
157 * spu decoder thread. This function only returns when the thread is
159 *****************************************************************************/
160 static void RunThread( spudec_thread_t *p_spudec )
162 intf_WarnMsg( 1, "spudec: spu decoder thread %i spawned", getpid() );
165 * Initialize thread and free configuration
167 p_spudec->p_fifo->b_error = InitThread( p_spudec );
170 * Main loop - it is not executed if an error occured during
173 while( (!p_spudec->p_fifo->b_die) && (!p_spudec->p_fifo->b_error) )
175 if( !SyncPacket( p_spudec ) )
177 ParsePacket( p_spudec );
184 if( p_spudec->p_fifo->b_error )
186 ErrorThread( p_spudec );
190 intf_WarnMsg( 1, "spudec: destroying spu decoder thread %i", getpid() );
191 EndThread( p_spudec );
194 /*****************************************************************************
195 * ErrorThread: RunThread() error loop
196 *****************************************************************************
197 * This function is called when an error occured during thread main's loop. The
198 * thread can still receive feed, but must be ready to terminate as soon as
200 *****************************************************************************/
201 static void ErrorThread( spudec_thread_t *p_spudec )
203 /* We take the lock, because we are going to read/write the start/end
204 * indexes of the decoder fifo */
205 vlc_mutex_lock( &p_spudec->p_fifo->data_lock );
207 /* Wait until a `die' order is sent */
208 while( !p_spudec->p_fifo->b_die )
210 /* Trash all received PES packets */
211 while( !DECODER_FIFO_ISEMPTY(*p_spudec->p_fifo) )
213 p_spudec->p_fifo->pf_delete_pes( p_spudec->p_fifo->p_packets_mgt,
214 DECODER_FIFO_START(*p_spudec->p_fifo) );
215 DECODER_FIFO_INCSTART( *p_spudec->p_fifo );
218 /* Waiting for the input thread to put new PES packets in the fifo */
219 vlc_cond_wait( &p_spudec->p_fifo->data_wait,
220 &p_spudec->p_fifo->data_lock );
223 /* We can release the lock before leaving */
224 vlc_mutex_unlock( &p_spudec->p_fifo->data_lock );
227 /*****************************************************************************
228 * EndThread: thread destruction
229 *****************************************************************************
230 * This function is called when the thread ends after a sucessful
232 *****************************************************************************/
233 static void EndThread( spudec_thread_t *p_spudec )
235 free( p_spudec->p_config );
239 /*****************************************************************************
240 * SyncPacket: get in sync with the stream
241 *****************************************************************************
242 * This function makes a few sanity checks and returns 0 if it looks like we
243 * are at the beginning of a subpicture packet.
244 *****************************************************************************/
245 static int SyncPacket( spudec_thread_t *p_spudec )
247 /* Re-align the buffer on an 8-bit boundary */
248 RealignBits( &p_spudec->bit_stream );
250 /* The total SPU packet size, often bigger than a PS packet */
251 p_spudec->i_spu_size = GetBits( &p_spudec->bit_stream, 16 );
253 /* The RLE stuff size (remove 4 because we just read 32 bits) */
254 p_spudec->i_rle_size = ShowBits( &p_spudec->bit_stream, 16 ) - 4;
256 /* If the values we got are a bit strange, skip packet */
257 if( p_spudec->i_rle_size >= p_spudec->i_spu_size )
262 RemoveBits( &p_spudec->bit_stream, 16 );
267 /*****************************************************************************
268 * ParsePacket: parse an SPU packet and send it to the video output
269 *****************************************************************************
270 * This function parses the SPU packet and, if valid, sends it to the
272 *****************************************************************************/
273 static void ParsePacket( spudec_thread_t *p_spudec )
275 subpicture_t * p_spu;
278 /* We cannot display a subpicture with no date */
279 if( DECODER_FIFO_START(*p_spudec->p_fifo)->i_pts == 0 )
284 /* Allocate the subpicture internal data. */
285 p_spu = vout_CreateSubPicture( p_spudec->p_vout, DVD_SUBPICTURE,
286 p_spudec->i_rle_size * 4 );
287 /* Rationale for the "p_spudec->i_rle_size * 4": we are going to
288 * expand the RLE stuff so that we won't need to read nibbles later
289 * on. This will speed things up a lot. Plus, we'll only need to do
290 * this stupid interlacing stuff once. */
297 /* Get display time now. If we do it later, we may miss a PTS. */
298 p_spu->begin_date = p_spu->end_date
299 = DECODER_FIFO_START(*p_spudec->p_fifo)->i_pts;
301 /* Allocate the temporary buffer we will parse */
302 p_src = malloc( p_spudec->i_rle_size );
306 intf_ErrMsg( "spudec error: could not allocate p_src" );
307 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
312 GetChunk( &p_spudec->bit_stream, p_src, p_spudec->i_rle_size );
315 /* Dump the subtitle info */
316 intf_WarnHexDump( 0, p_spu->p_data, p_spudec->i_rle_size );
319 /* Getting the control part */
320 if( ParseControlSequences( p_spudec, p_spu ) )
322 /* There was a parse error, delete the subpicture */
324 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
328 if( ParseRLE( p_src, p_spu ) )
330 /* There was a parse error, delete the subpicture */
332 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
336 intf_WarnMsg( 1, "spudec: got a valid %ix%i subtitle at (%i,%i), "
337 "RLE offsets: 0x%x 0x%x",
338 p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y,
339 p_spu->type.spu.i_offset[0], p_spu->type.spu.i_offset[1] );
341 /* SPU is finished - we can ask the video output to display it */
342 vout_DisplaySubPicture( p_spudec->p_vout, p_spu );
348 /*****************************************************************************
349 * ParseControlSequences: parse all SPU control sequences
350 *****************************************************************************
351 * This is the most important part in SPU decoding. We get dates, palette
352 * information, coordinates, and so on. For more information on the
353 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
354 *****************************************************************************/
355 static int ParseControlSequences( spudec_thread_t *p_spudec,
356 subpicture_t * p_spu )
358 /* Our current index in the SPU packet */
359 int i_index = p_spudec->i_rle_size + 4;
361 /* The next start-of-control-sequence index and the previous one */
362 int i_next_index = 0, i_prev_index;
364 /* Command time and date */
370 /* Get the control sequence date */
371 i_date = GetBits( &p_spudec->bit_stream, 16 );
374 i_prev_index = i_next_index;
375 i_next_index = GetBits( &p_spudec->bit_stream, 16 );
377 /* Skip what we just read */
382 i_command = GetBits( &p_spudec->bit_stream, 8 );
387 case SPU_CMD_FORCE_DISPLAY:
389 /* 00 (force displaying) */
392 /* Convert the dates in seconds to PTS values */
393 case SPU_CMD_START_DISPLAY:
395 /* 01 (start displaying) */
396 p_spu->begin_date += ( i_date * 11000 );
400 case SPU_CMD_STOP_DISPLAY:
402 /* 02 (stop displaying) */
403 p_spu->end_date += ( i_date * 11000 );
407 case SPU_CMD_SET_PALETTE:
409 /* 03xxxx (palette) - trashed */
410 RemoveBits( &p_spudec->bit_stream, 16 );
415 case SPU_CMD_SET_ALPHACHANNEL:
417 /* 04xxxx (alpha channel) - trashed */
418 RemoveBits( &p_spudec->bit_stream, 16 );
423 case SPU_CMD_SET_COORDINATES:
425 /* 05xxxyyyxxxyyy (coordinates) */
426 p_spu->i_x = GetBits( &p_spudec->bit_stream, 12 );
427 p_spu->i_width = GetBits( &p_spudec->bit_stream, 12 )
430 p_spu->i_y = GetBits( &p_spudec->bit_stream, 12 );
431 p_spu->i_height = GetBits( &p_spudec->bit_stream, 12 )
438 case SPU_CMD_SET_OFFSETS:
440 /* 06xxxxyyyy (byte offsets) */
441 p_spu->type.spu.i_offset[0] =
442 GetBits( &p_spudec->bit_stream, 16 ) - 4;
444 p_spu->type.spu.i_offset[1] =
445 GetBits( &p_spudec->bit_stream, 16 ) - 4;
458 /* xx (unknown command) */
459 intf_ErrMsg( "spudec error: unknown command 0x%.2x",
464 } while( i_command != SPU_CMD_END );
466 } while( i_index == i_next_index );
468 /* Check that the last index matches the previous one */
469 if( i_next_index != i_prev_index )
471 intf_ErrMsg( "spudec error: index mismatch (0x%.4x != 0x%.4x)",
472 i_next_index, i_prev_index );
476 if( i_index > p_spudec->i_spu_size )
478 intf_ErrMsg( "spudec error: uh-oh, we went too far (0x%.4x > 0x%.4x)",
479 i_index, p_spudec->i_spu_size );
483 /* Get rid of padding bytes */
484 switch( p_spudec->i_spu_size - i_index )
488 RemoveBits( &p_spudec->bit_stream, 8 );
493 /* Zero or one padding byte, quite usual */
499 /* More than one padding byte - this is very strange, but
500 * we can deal with it */
501 intf_WarnMsg( 2, "spudec warning: %i padding bytes, we usually "
503 p_spudec->i_spu_size - i_index );
505 while( i_index < p_spudec->i_spu_size )
507 RemoveBits( &p_spudec->bit_stream, 8 );
514 /* Successfully parsed ! */
518 /*****************************************************************************
519 * ParseRLE: parse the RLE part of the subtitle
520 *****************************************************************************
521 * This part parses the subtitle graphical data and stores it in a more
522 * convenient structure for later decoding. For more information on the
523 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
524 *****************************************************************************/
525 static int ParseRLE( u8 *p_src, subpicture_t * p_spu )
528 unsigned int i_id = 0;
530 unsigned int i_width = p_spu->i_width;
531 unsigned int i_height = p_spu->i_height;
532 unsigned int i_x, i_y;
534 u16 *p_dest = (u16 *)p_spu->p_data;
536 /* The subtitles are interlaced, we need two offsets */
537 unsigned int pi_table[ 2 ];
538 unsigned int *pi_offset;
540 pi_table[ 0 ] = p_spu->type.spu.i_offset[ 0 ] << 1;
541 pi_table[ 1 ] = p_spu->type.spu.i_offset[ 1 ] << 1;
543 for( i_y = 0 ; i_y < i_height ; i_y++ )
545 pi_offset = pi_table + i_id;
547 for( i_x = 0 ; i_x < i_width ; i_x += i_code >> 2 )
549 i_code = AddNibble( 0, p_src, pi_offset );
553 i_code = AddNibble( i_code, p_src, pi_offset );
557 i_code = AddNibble( i_code, p_src, pi_offset );
561 i_code = AddNibble( i_code, p_src, pi_offset );
563 if( i_code < 0x0100 )
565 /* If the 14 first bits are set to 0, then it's a
566 * new line. We emulate it. */
567 if( i_code < 0x0004 )
569 i_code |= ( i_width - i_x ) << 2;
573 /* We have a boo boo ! */
574 intf_ErrMsg( "spudec error: unknown RLE code "
583 if( ( (i_code >> 2) + i_x + i_y * i_width ) > i_height * i_width )
585 intf_ErrMsg( "spudec error: out of bounds, %i at (%i,%i) is "
587 i_code >> 2, i_x, i_y, i_width, i_height);
591 /* We got a valid code, store it */
595 /* Check that we didn't go too far */
598 intf_ErrMsg( "spudec error: i_x overflowed, %i > %i",
603 /* Byte-align the stream */
604 if( *pi_offset & 0x1 )
613 /* FIXME: we shouldn't need these padding bytes */
614 while( i_y < i_height )
616 *p_dest++ = i_width << 2;