1 /*****************************************************************************
2 * spu_decoder.c : spu decoder thread
3 *****************************************************************************
4 * Copyright (C) 2000 VideoLAN
5 * $Id: spu_decoder.c,v 1.47 2001/06/02 01:09:03 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 *****************************************************************************/
30 #include <unistd.h> /* getpid() */
33 #ifdef WIN32 /* getpid() for win32 is located in process.h */
37 #include <stdlib.h> /* malloc(), free() */
38 #include <string.h> /* memcpy(), memset() */
47 #include "stream_control.h"
48 #include "input_ext-dec.h"
51 #include "video_output.h"
53 #include "spu_decoder.h"
55 /*****************************************************************************
57 *****************************************************************************/
58 static int InitThread ( spudec_thread_t * );
59 static void RunThread ( spudec_thread_t * );
60 static void ErrorThread ( spudec_thread_t * );
61 static void EndThread ( spudec_thread_t * );
63 static int SyncPacket ( spudec_thread_t * );
64 static void ParsePacket ( spudec_thread_t * );
65 static int ParseControlSequences( spudec_thread_t *, subpicture_t * );
66 static int ParseRLE ( spudec_thread_t *, subpicture_t *, u8 * );
68 /*****************************************************************************
69 * spudec_CreateThread: create a spu decoder thread
70 *****************************************************************************/
71 vlc_thread_t spudec_CreateThread( vdec_config_t * p_config )
73 spudec_thread_t * p_spudec;
75 /* Allocate the memory needed to store the thread's structure */
76 p_spudec = (spudec_thread_t *)malloc( sizeof(spudec_thread_t) );
78 if ( p_spudec == NULL )
80 intf_ErrMsg( "spudec error: not enough memory "
81 "for spudec_CreateThread() to create the new thread" );
86 * Initialize the thread properties
88 p_spudec->p_config = p_config;
90 p_spudec->p_fifo = p_config->decoder_config.p_decoder_fifo;
92 /* Spawn a video output if there is none */
93 vlc_mutex_lock( &p_vout_bank->lock );
95 if( p_vout_bank->i_count == 0 )
97 intf_WarnMsg( 1, "spudec: no vout present, spawning one" );
99 p_spudec->p_vout = vout_CreateThread( NULL );
101 /* Everything failed */
102 if( p_spudec->p_vout == NULL )
104 intf_Msg( "spudec: can't open vout, aborting" );
105 vlc_mutex_unlock( &p_vout_bank->lock );
111 p_vout_bank->pp_vout[ p_vout_bank->i_count ] = p_spudec->p_vout;
112 p_vout_bank->i_count++;
116 /* Take the first video output FIXME: take the best one */
117 p_spudec->p_vout = p_vout_bank->pp_vout[ 0 ];
120 vlc_mutex_unlock( &p_vout_bank->lock );
122 /* Spawn the spu decoder thread */
123 if ( vlc_thread_create(&p_spudec->thread_id, "spu decoder",
124 (vlc_thread_func_t)RunThread, (void *)p_spudec) )
126 intf_ErrMsg( "spudec error: can't spawn spu decoder thread" );
131 return( p_spudec->thread_id );
134 /* following functions are local */
136 /*****************************************************************************
137 * InitThread: initialize spu decoder thread
138 *****************************************************************************
139 * This function is called from RunThread and performs the second step of the
140 * initialization. It returns 0 on success. Note that the thread's flag are not
141 * modified inside this function.
142 *****************************************************************************/
143 static int InitThread( spudec_thread_t *p_spudec )
145 p_spudec->p_config->decoder_config.pf_init_bit_stream(
146 &p_spudec->bit_stream,
147 p_spudec->p_config->decoder_config.p_decoder_fifo, NULL, NULL );
149 /* Mark thread as running and return */
153 /*****************************************************************************
154 * RunThread: spu decoder thread
155 *****************************************************************************
156 * spu decoder thread. This function only returns when the thread is
158 *****************************************************************************/
159 static void RunThread( spudec_thread_t *p_spudec )
161 intf_WarnMsg( 3, "spudec: spu decoder thread %i spawned", getpid() );
164 * Initialize thread and free configuration
166 p_spudec->p_fifo->b_error = InitThread( p_spudec );
169 * Main loop - it is not executed if an error occured during
172 while( (!p_spudec->p_fifo->b_die) && (!p_spudec->p_fifo->b_error) )
174 if( !SyncPacket( p_spudec ) )
176 ParsePacket( p_spudec );
183 if( p_spudec->p_fifo->b_error )
185 ErrorThread( p_spudec );
189 intf_WarnMsg( 3, "spudec: destroying spu decoder thread %i", getpid() );
190 EndThread( p_spudec );
193 /*****************************************************************************
194 * ErrorThread: RunThread() error loop
195 *****************************************************************************
196 * This function is called when an error occured during thread main's loop. The
197 * thread can still receive feed, but must be ready to terminate as soon as
199 *****************************************************************************/
200 static void ErrorThread( spudec_thread_t *p_spudec )
202 /* We take the lock, because we are going to read/write the start/end
203 * indexes of the decoder fifo */
204 vlc_mutex_lock( &p_spudec->p_fifo->data_lock );
206 /* Wait until a `die' order is sent */
207 while( !p_spudec->p_fifo->b_die )
209 /* Trash all received PES packets */
210 while( !DECODER_FIFO_ISEMPTY(*p_spudec->p_fifo) )
212 p_spudec->p_fifo->pf_delete_pes( p_spudec->p_fifo->p_packets_mgt,
213 DECODER_FIFO_START(*p_spudec->p_fifo) );
214 DECODER_FIFO_INCSTART( *p_spudec->p_fifo );
217 /* Waiting for the input thread to put new PES packets in the fifo */
218 vlc_cond_wait( &p_spudec->p_fifo->data_wait,
219 &p_spudec->p_fifo->data_lock );
222 /* We can release the lock before leaving */
223 vlc_mutex_unlock( &p_spudec->p_fifo->data_lock );
226 /*****************************************************************************
227 * EndThread: thread destruction
228 *****************************************************************************
229 * This function is called when the thread ends after a sucessful
231 *****************************************************************************/
232 static void EndThread( spudec_thread_t *p_spudec )
234 free( p_spudec->p_config );
238 /*****************************************************************************
239 * SyncPacket: get in sync with the stream
240 *****************************************************************************
241 * This function makes a few sanity checks and returns 0 if it looks like we
242 * are at the beginning of a subpicture packet.
243 *****************************************************************************/
244 static int SyncPacket( spudec_thread_t *p_spudec )
246 /* Re-align the buffer on an 8-bit boundary */
247 RealignBits( &p_spudec->bit_stream );
249 /* The total SPU packet size, often bigger than a PS packet */
250 p_spudec->i_spu_size = GetBits( &p_spudec->bit_stream, 16 );
252 /* The RLE stuff size (remove 4 because we just read 32 bits) */
253 p_spudec->i_rle_size = ShowBits( &p_spudec->bit_stream, 16 ) - 4;
255 /* If the values we got are a bit strange, skip packet */
256 if( !p_spudec->i_spu_size
257 || ( 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;
277 unsigned int i_offset;
279 intf_WarnMsg( 3, "spudec: trying to gather a 0x%.2x long subtitle",
280 p_spudec->i_spu_size );
282 /* We cannot display a subpicture with no date */
283 if( DECODER_FIFO_START(*p_spudec->p_fifo)->i_pts == 0 )
285 intf_WarnMsg( 3, "spudec error: subtitle without a date" );
289 /* Allocate the subpicture internal data. */
290 p_spu = vout_CreateSubPicture( p_spudec->p_vout, DVD_SUBPICTURE,
291 p_spudec->i_rle_size * 4 );
292 /* Rationale for the "p_spudec->i_rle_size * 4": we are going to
293 * expand the RLE stuff so that we won't need to read nibbles later
294 * on. This will speed things up a lot. Plus, we'll only need to do
295 * this stupid interlacing stuff once. */
302 /* Get display time now. If we do it later, we may miss the PTS. */
303 p_spudec->i_pts = DECODER_FIFO_START(*p_spudec->p_fifo)->i_pts;
305 /* Allocate the temporary buffer we will parse */
306 p_src = malloc( p_spudec->i_rle_size );
310 intf_ErrMsg( "spudec error: could not allocate p_src" );
311 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
317 i_offset + SPU_CHUNK_SIZE < p_spudec->i_rle_size;
318 i_offset += SPU_CHUNK_SIZE )
320 GetChunk( &p_spudec->bit_stream, p_src + i_offset, SPU_CHUNK_SIZE );
322 if( p_spudec->p_fifo->b_die )
325 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
330 GetChunk( &p_spudec->bit_stream, p_src + i_offset,
331 p_spudec->i_rle_size - i_offset );
334 /* Dump the subtitle info */
335 intf_WarnHexDump( 5, p_spu->p_data, p_spudec->i_rle_size );
338 /* Getting the control part */
339 if( p_spudec->p_fifo->b_die || ParseControlSequences( p_spudec, p_spu ) )
341 /* There was a parse error, delete the subpicture */
343 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
347 if( ParseRLE( p_spudec, p_spu, p_src ) )
349 /* There was a parse error, delete the subpicture */
351 vout_DestroySubPicture( p_spudec->p_vout, p_spu );
355 intf_WarnMsg( 3, "spudec: total size: 0x%x, RLE offsets: 0x%x 0x%x",
356 p_spudec->i_spu_size,
357 p_spu->type.spu.i_offset[0], p_spu->type.spu.i_offset[1] );
359 /* SPU is finished - we can ask the video output to display it */
360 vout_DisplaySubPicture( p_spudec->p_vout, p_spu );
366 /*****************************************************************************
367 * ParseControlSequences: parse all SPU control sequences
368 *****************************************************************************
369 * This is the most important part in SPU decoding. We get dates, palette
370 * information, coordinates, and so on. For more information on the
371 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
372 *****************************************************************************/
373 static int ParseControlSequences( spudec_thread_t *p_spudec,
374 subpicture_t * p_spu )
376 /* Our current index in the SPU packet */
377 int i_index = p_spudec->i_rle_size + 4;
379 /* The next start-of-control-sequence index and the previous one */
380 int i_next_seq, i_cur_seq;
382 /* Command time and date */
386 /* XXX: temporary variables */
387 boolean_t b_force_display = 0;
389 /* Initialize the structure */
390 p_spu->i_start = p_spu->i_stop = 0;
391 p_spu->b_ephemer = 0;
395 /* Get the control sequence date */
396 i_date = GetBits( &p_spudec->bit_stream, 16 );
400 i_next_seq = GetBits( &p_spudec->bit_stream, 16 );
402 /* Skip what we just read */
407 i_command = GetBits( &p_spudec->bit_stream, 8 );
412 case SPU_CMD_FORCE_DISPLAY:
414 /* 00 (force displaying) */
415 p_spu->i_start = p_spudec->i_pts + ( i_date * 11000 );
420 /* Convert the dates in seconds to PTS values */
421 case SPU_CMD_START_DISPLAY:
423 /* 01 (start displaying) */
424 p_spu->i_start = p_spudec->i_pts + ( i_date * 11000 );
428 case SPU_CMD_STOP_DISPLAY:
430 /* 02 (stop displaying) */
431 p_spu->i_stop = p_spudec->i_pts + ( i_date * 11000 );
435 case SPU_CMD_SET_PALETTE:
437 /* 03xxxx (palette) - trashed */
438 RemoveBits( &p_spudec->bit_stream, 16 );
443 case SPU_CMD_SET_ALPHACHANNEL:
445 /* 04xxxx (alpha channel) - trashed */
446 RemoveBits( &p_spudec->bit_stream, 16 );
451 case SPU_CMD_SET_COORDINATES:
453 /* 05xxxyyyxxxyyy (coordinates) */
454 p_spu->i_x = GetBits( &p_spudec->bit_stream, 12 );
455 p_spu->i_width = GetBits( &p_spudec->bit_stream, 12 )
458 p_spu->i_y = GetBits( &p_spudec->bit_stream, 12 );
459 p_spu->i_height = GetBits( &p_spudec->bit_stream, 12 )
466 case SPU_CMD_SET_OFFSETS:
468 /* 06xxxxyyyy (byte offsets) */
469 p_spu->type.spu.i_offset[0] =
470 GetBits( &p_spudec->bit_stream, 16 ) - 4;
472 p_spu->type.spu.i_offset[1] =
473 GetBits( &p_spudec->bit_stream, 16 ) - 4;
486 /* xx (unknown command) */
487 intf_ErrMsg( "spudec error: unknown command 0x%.2x",
492 } while( i_command != SPU_CMD_END );
494 } while( i_index == i_next_seq );
496 /* Check that the next sequence index matches the current one */
497 if( i_next_seq != i_cur_seq )
499 intf_ErrMsg( "spudec error: index mismatch (0x%.4x != 0x%.4x)",
500 i_next_seq, i_cur_seq );
504 if( i_index > p_spudec->i_spu_size )
506 intf_ErrMsg( "spudec error: uh-oh, we went too far (0x%.4x > 0x%.4x)",
507 i_index, p_spudec->i_spu_size );
511 if( !p_spu->i_start )
513 intf_ErrMsg( "spudec error: no `start display' command" );
518 /* This subtitle will live for 5 seconds or until the next subtitle */
519 p_spu->i_stop = p_spu->i_start + 500 * 11000;
520 p_spu->b_ephemer = 1;
523 /* Get rid of padding bytes */
524 switch( p_spudec->i_spu_size - i_index )
526 /* Zero or one padding byte, quite usual */
528 RemoveBits( &p_spudec->bit_stream, 8 );
533 /* More than one padding byte - this is very strange, but
534 * we can deal with it */
536 intf_WarnMsg( 2, "spudec warning: %i padding bytes, we usually "
538 p_spudec->i_spu_size - i_index );
540 while( i_index < p_spudec->i_spu_size )
542 RemoveBits( &p_spudec->bit_stream, 8 );
549 if( b_force_display )
551 intf_ErrMsg( "spudec: \"force display\" command" );
552 intf_ErrMsg( "spudec: send mail to <sam@zoy.org> if you "
553 "want to help debugging this" );
556 /* Successfully parsed ! */
560 /*****************************************************************************
561 * ParseRLE: parse the RLE part of the subtitle
562 *****************************************************************************
563 * This part parses the subtitle graphical data and stores it in a more
564 * convenient structure for later decoding. For more information on the
565 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
566 *****************************************************************************/
567 static int ParseRLE( spudec_thread_t *p_spudec,
568 subpicture_t * p_spu, u8 * p_src )
572 unsigned int i_width = p_spu->i_width;
573 unsigned int i_height = p_spu->i_height;
574 unsigned int i_x, i_y;
576 u16 *p_dest = (u16 *)p_spu->p_data;
578 /* The subtitles are interlaced, we need two offsets */
579 unsigned int i_id = 0; /* Start on the even SPU layer */
580 unsigned int pi_table[ 2 ];
581 unsigned int *pi_offset;
583 boolean_t b_empty_top = 1,
585 unsigned int i_skipped_top = 0,
586 i_skipped_bottom = 0;
588 pi_table[ 0 ] = p_spu->type.spu.i_offset[ 0 ] << 1;
589 pi_table[ 1 ] = p_spu->type.spu.i_offset[ 1 ] << 1;
591 for( i_y = 0 ; i_y < i_height ; i_y++ )
593 pi_offset = pi_table + i_id;
595 for( i_x = 0 ; i_x < i_width ; i_x += i_code >> 2 )
597 i_code = AddNibble( 0, p_src, pi_offset );
601 i_code = AddNibble( i_code, p_src, pi_offset );
605 i_code = AddNibble( i_code, p_src, pi_offset );
609 i_code = AddNibble( i_code, p_src, pi_offset );
611 if( i_code < 0x0100 )
613 /* If the 14 first bits are set to 0, then it's a
614 * new line. We emulate it. */
615 if( i_code < 0x0004 )
617 i_code |= ( i_width - i_x ) << 2;
621 /* We have a boo boo ! */
622 intf_ErrMsg( "spudec error: unknown RLE code "
631 if( ( (i_code >> 2) + i_x + i_y * i_width ) > i_height * i_width )
633 intf_ErrMsg( "spudec error: out of bounds, %i at (%i,%i) is "
635 i_code >> 2, i_x, i_y, i_width, i_height);
639 if( i_code == (i_width << 2) ) /* FIXME: we assume 0 is transp */
643 /* This is a blank top line, we skip it */
648 /* We can't be sure the current lines will be skipped,
649 * so we store the code just in case. */
658 /* We got a valid code, store it */
661 /* Valid code means no blank line */
664 i_skipped_bottom = 0;
668 /* Check that we didn't go too far */
671 intf_ErrMsg( "spudec error: i_x overflowed, %i > %i",
676 /* Byte-align the stream */
677 if( *pi_offset & 0x1 )
686 /* We shouldn't get any padding bytes */
689 intf_ErrMsg( "spudec: padding bytes found in RLE sequence" );
690 intf_ErrMsg( "spudec: send mail to <sam@zoy.org> if you "
691 "want to help debugging this" );
693 /* Skip them just in case */
694 while( i_y < i_height )
696 *p_dest++ = i_width << 2;
703 intf_WarnMsg( 3, "spudec: valid subtitle, size: %ix%i, position: %i,%i",
704 p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );
706 /* Crop if necessary */
707 if( i_skipped_top || i_skipped_bottom )
709 p_spu->i_y += i_skipped_top;
710 p_spu->i_height -= i_skipped_top + i_skipped_bottom;
712 intf_WarnMsg( 3, "spudec: cropped to: %ix%i, position: %i,%i",
713 p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );