1 /*****************************************************************************
2 * spu_decoder.c : spu decoder thread
3 *****************************************************************************
4 * Copyright (C) 2000 VideoLAN
5 * $Id: spu_decoder.c,v 1.38 2001/04/28 03:36:25 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 /*****************************************************************************
54 *****************************************************************************/
55 static int InitThread ( spudec_thread_t * );
56 static void RunThread ( spudec_thread_t * );
57 static void ErrorThread ( spudec_thread_t * );
58 static void EndThread ( spudec_thread_t * );
60 static int SyncPacket ( spudec_thread_t * );
61 static void ParsePacket ( spudec_thread_t * );
62 static int ParseControlSequences( spudec_thread_t *, subpicture_t * );
63 static int ParseRLE ( u8 *, subpicture_t * );
65 /*****************************************************************************
66 * spudec_CreateThread: create a spu decoder thread
67 *****************************************************************************/
68 vlc_thread_t spudec_CreateThread( vdec_config_t * p_config )
70 spudec_thread_t * p_spudec;
72 /* Allocate the memory needed to store the thread's structure */
73 p_spudec = (spudec_thread_t *)malloc( sizeof(spudec_thread_t) );
75 if ( p_spudec == NULL )
77 intf_ErrMsg( "spudec error: not enough memory "
78 "for spudec_CreateThread() to create the new thread" );
83 * Initialize the thread properties
85 p_spudec->p_config = p_config;
86 p_spudec->p_fifo = p_config->decoder_config.p_decoder_fifo;
88 /* Get the video output informations */
89 p_spudec->p_vout = p_config->p_vout;
91 /* Spawn the spu decoder thread */
92 if ( vlc_thread_create(&p_spudec->thread_id, "spu decoder",
93 (vlc_thread_func_t)RunThread, (void *)p_spudec) )
95 intf_ErrMsg( "spudec error: can't spawn spu decoder thread" );
100 return( p_spudec->thread_id );
103 /* following functions are local */
105 /*****************************************************************************
106 * InitThread: initialize spu decoder thread
107 *****************************************************************************
108 * This function is called from RunThread and performs the second step of the
109 * initialization. It returns 0 on success. Note that the thread's flag are not
110 * modified inside this function.
111 *****************************************************************************/
112 static int InitThread( spudec_thread_t *p_spudec )
114 p_spudec->p_config->decoder_config.pf_init_bit_stream(
115 &p_spudec->bit_stream,
116 p_spudec->p_config->decoder_config.p_decoder_fifo, NULL, NULL );
118 /* Mark thread as running and return */
122 /*****************************************************************************
123 * RunThread: spu decoder thread
124 *****************************************************************************
125 * spu decoder thread. This function only returns when the thread is
127 *****************************************************************************/
128 static void RunThread( spudec_thread_t *p_spudec )
130 intf_WarnMsg( 1, "spudec: spu decoder thread %i spawned", getpid() );
133 * Initialize thread and free configuration
135 p_spudec->p_fifo->b_error = InitThread( p_spudec );
138 * Main loop - it is not executed if an error occured during
141 while( (!p_spudec->p_fifo->b_die) && (!p_spudec->p_fifo->b_error) )
143 if( !SyncPacket( p_spudec ) )
145 ParsePacket( p_spudec );
152 if( p_spudec->p_fifo->b_error )
154 ErrorThread( p_spudec );
158 intf_WarnMsg( 1, "spudec: destroying spu decoder thread %i", getpid() );
159 EndThread( p_spudec );
162 /*****************************************************************************
163 * ErrorThread: RunThread() error loop
164 *****************************************************************************
165 * This function is called when an error occured during thread main's loop. The
166 * thread can still receive feed, but must be ready to terminate as soon as
168 *****************************************************************************/
169 static void ErrorThread( spudec_thread_t *p_spudec )
171 /* We take the lock, because we are going to read/write the start/end
172 * indexes of the decoder fifo */
173 vlc_mutex_lock( &p_spudec->p_fifo->data_lock );
175 /* Wait until a `die' order is sent */
176 while( !p_spudec->p_fifo->b_die )
178 /* Trash all received PES packets */
179 while( !DECODER_FIFO_ISEMPTY(*p_spudec->p_fifo) )
181 p_spudec->p_fifo->pf_delete_pes( p_spudec->p_fifo->p_packets_mgt,
182 DECODER_FIFO_START(*p_spudec->p_fifo) );
183 DECODER_FIFO_INCSTART( *p_spudec->p_fifo );
186 /* Waiting for the input thread to put new PES packets in the fifo */
187 vlc_cond_wait( &p_spudec->p_fifo->data_wait,
188 &p_spudec->p_fifo->data_lock );
191 /* We can release the lock before leaving */
192 vlc_mutex_unlock( &p_spudec->p_fifo->data_lock );
195 /*****************************************************************************
196 * EndThread: thread destruction
197 *****************************************************************************
198 * This function is called when the thread ends after a sucessful
200 *****************************************************************************/
201 static void EndThread( spudec_thread_t *p_spudec )
203 free( p_spudec->p_config );
207 /*****************************************************************************
208 * SyncPacket: get in sync with the stream
209 *****************************************************************************
210 * This function makes a few sanity checks and returns 0 if it looks like we
211 * are at the beginning of a subpicture packet.
212 *****************************************************************************/
213 static int SyncPacket( spudec_thread_t *p_spudec )
215 /* Re-align the buffer on an 8-bit boundary */
216 RealignBits( &p_spudec->bit_stream );
218 /* The total SPU packet size, often bigger than a PS packet */
219 p_spudec->i_spu_size = GetBits( &p_spudec->bit_stream, 16 );
221 /* The RLE stuff size (remove 4 because we just read 32 bits) */
222 p_spudec->i_rle_size = ShowBits( &p_spudec->bit_stream, 16 ) - 4;
224 /* If the values we got are a bit strange, skip packet */
225 if( p_spudec->i_rle_size >= p_spudec->i_spu_size )
230 RemoveBits( &p_spudec->bit_stream, 16 );
235 /*****************************************************************************
236 * ParsePacket: parse an SPU packet and send it to the video output
237 *****************************************************************************
238 * This function parses the SPU packet and, if valid, sends it to the
240 *****************************************************************************/
241 static void ParsePacket( spudec_thread_t *p_spudec )
243 subpicture_t * p_spu;
246 /* We cannot display a subpicture with no date */
247 if( DECODER_FIFO_START(*p_spudec->p_fifo)->i_pts == 0 )
252 /* Allocate the subpicture internal data. */
253 p_spu = vout_CreateSubPicture( p_spudec->p_vout, DVD_SUBPICTURE,
254 p_spudec->i_rle_size * 4 );
255 /* Rationale for the "p_spudec->i_rle_size * 4": we are going to
256 * expand the RLE stuff so that we won't need to read nibbles later
257 * on. This will speed things up a lot. Plus, we'll only need to do
258 * this stupid interlacing stuff once. */
265 /* Get display time now. If we do it later, we may miss a PTS. */
266 p_spu->begin_date = p_spu->end_date
267 = DECODER_FIFO_START(*p_spudec->p_fifo)->i_pts;
269 /* Allocate the temporary buffer we will parse */
270 p_src = malloc( p_spudec->i_rle_size );
274 intf_ErrMsg( "spudec error: could not allocate p_src" );
275 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
280 GetChunk( &p_spudec->bit_stream, p_src, p_spudec->i_rle_size );
283 /* Dump the subtitle info */
284 intf_WarnHexDump( 0, p_spu->p_data, p_spudec->i_rle_size );
287 /* Getting the control part */
288 if( ParseControlSequences( p_spudec, p_spu ) )
290 /* There was a parse error, delete the subpicture */
292 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
296 if( ParseRLE( p_src, p_spu ) )
298 /* There was a parse error, delete the subpicture */
300 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
304 intf_WarnMsg( 1, "spudec: got a valid %ix%i subtitle at (%i,%i), "
305 "RLE offsets: 0x%x 0x%x",
306 p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y,
307 p_spu->type.spu.i_offset[0], p_spu->type.spu.i_offset[1] );
309 /* SPU is finished - we can ask the video output to display it */
310 vout_DisplaySubPicture( p_spudec->p_vout, p_spu );
316 /*****************************************************************************
317 * ParseControlSequences: parse all SPU control sequences
318 *****************************************************************************
319 * This is the most important part in SPU decoding. We get dates, palette
320 * information, coordinates, and so on. For more information on the
321 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
322 *****************************************************************************/
323 static int ParseControlSequences( spudec_thread_t *p_spudec,
324 subpicture_t * p_spu )
326 /* Our current index in the SPU packet */
327 int i_index = p_spudec->i_rle_size + 4;
329 /* The next start-of-control-sequence index and the previous one */
330 int i_next_index = 0, i_prev_index;
332 /* Command time and date */
338 /* Get the control sequence date */
339 i_date = GetBits( &p_spudec->bit_stream, 16 );
342 i_prev_index = i_next_index;
343 i_next_index = GetBits( &p_spudec->bit_stream, 16 );
345 /* Skip what we just read */
350 i_command = GetBits( &p_spudec->bit_stream, 8 );
355 case SPU_CMD_FORCE_DISPLAY:
357 /* 00 (force displaying) */
360 /* Convert the dates in seconds to PTS values */
361 case SPU_CMD_START_DISPLAY:
363 /* 01 (start displaying) */
364 p_spu->begin_date += ( i_date * 11000 );
368 case SPU_CMD_STOP_DISPLAY:
370 /* 02 (stop displaying) */
371 p_spu->end_date += ( i_date * 11000 );
375 case SPU_CMD_SET_PALETTE:
377 /* 03xxxx (palette) - trashed */
378 RemoveBits( &p_spudec->bit_stream, 16 );
383 case SPU_CMD_SET_ALPHACHANNEL:
385 /* 04xxxx (alpha channel) - trashed */
386 RemoveBits( &p_spudec->bit_stream, 16 );
391 case SPU_CMD_SET_COORDINATES:
393 /* 05xxxyyyxxxyyy (coordinates) */
394 p_spu->i_x = GetBits( &p_spudec->bit_stream, 12 );
395 p_spu->i_width = GetBits( &p_spudec->bit_stream, 12 )
398 p_spu->i_y = GetBits( &p_spudec->bit_stream, 12 );
399 p_spu->i_height = GetBits( &p_spudec->bit_stream, 12 )
406 case SPU_CMD_SET_OFFSETS:
408 /* 06xxxxyyyy (byte offsets) */
409 p_spu->type.spu.i_offset[0] =
410 GetBits( &p_spudec->bit_stream, 16 ) - 4;
412 p_spu->type.spu.i_offset[1] =
413 GetBits( &p_spudec->bit_stream, 16 ) - 4;
426 /* xx (unknown command) */
427 intf_ErrMsg( "spudec error: unknown command 0x%.2x",
432 } while( i_command != SPU_CMD_END );
434 } while( i_index == i_next_index );
436 /* Check that the last index matches the previous one */
437 if( i_next_index != i_prev_index )
439 intf_ErrMsg( "spudec error: index mismatch (0x%.4x != 0x%.4x)",
440 i_next_index, i_prev_index );
444 if( i_index > p_spudec->i_spu_size )
446 intf_ErrMsg( "spudec error: uh-oh, we went too far (0x%.4x > 0x%.4x)",
447 i_index, p_spudec->i_spu_size );
451 /* Get rid of padding bytes */
452 switch( p_spudec->i_spu_size - i_index )
456 RemoveBits( &p_spudec->bit_stream, 8 );
461 /* Zero or one padding byte, quite usual */
467 /* More than one padding byte - this is very strange, but
468 * we can deal with it */
469 intf_WarnMsg( 2, "spudec warning: %i padding bytes, we usually "
471 p_spudec->i_spu_size - i_index );
473 while( i_index < p_spudec->i_spu_size )
475 RemoveBits( &p_spudec->bit_stream, 8 );
482 /* Successfully parsed ! */
486 /*****************************************************************************
487 * ParseRLE: parse the RLE part of the subtitle
488 *****************************************************************************
489 * This part parses the subtitle graphical data and stores it in a more
490 * convenient structure for later decoding. For more information on the
491 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
492 *****************************************************************************/
493 static int ParseRLE( u8 *p_src, subpicture_t * p_spu )
496 unsigned int i_id = 0;
498 unsigned int i_width = p_spu->i_width;
499 unsigned int i_height = p_spu->i_height;
500 unsigned int i_x, i_y;
502 u16 *p_dest = (u16 *)p_spu->p_data;
504 /* The subtitles are interlaced, we need two offsets */
505 unsigned int pi_table[ 2 ];
506 unsigned int *pi_offset;
508 pi_table[ 0 ] = p_spu->type.spu.i_offset[ 0 ] << 1;
509 pi_table[ 1 ] = p_spu->type.spu.i_offset[ 1 ] << 1;
511 for( i_y = 0 ; i_y < i_height ; i_y++ )
513 pi_offset = pi_table + i_id;
515 for( i_x = 0 ; i_x < i_width ; i_x += i_code >> 2 )
517 i_code = AddNibble( 0, p_src, pi_offset );
521 i_code = AddNibble( i_code, p_src, pi_offset );
525 i_code = AddNibble( i_code, p_src, pi_offset );
529 i_code = AddNibble( i_code, p_src, pi_offset );
531 if( i_code < 0x0100 )
533 /* If the 14 first bits are set to 0, then it's a
534 * new line. We emulate it. */
535 if( i_code < 0x0004 )
537 i_code |= ( i_width - i_x ) << 2;
541 /* We have a boo boo ! */
542 intf_ErrMsg( "spudec error: unknown RLE code "
551 if( ( (i_code >> 2) + i_x + i_y * i_width ) > i_height * i_width )
553 intf_ErrMsg( "spudec error: out of bounds, %i at (%i,%i) is "
555 i_code >> 2, i_x, i_y, i_width, i_height);
559 /* We got a valid code, store it */
563 /* Check that we didn't go too far */
566 intf_ErrMsg( "spudec error: i_x overflowed, %i > %i",
571 /* Byte-align the stream */
572 if( *pi_offset & 0x1 )
581 /* FIXME: we shouldn't need these padding bytes */
582 while( i_y < i_height )
584 *p_dest++ = i_width << 2;