1 /*****************************************************************************
2 * spu_decoder.c : spu decoder thread
3 *****************************************************************************
4 * Copyright (C) 2000 VideoLAN
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
21 *****************************************************************************/
23 /* repompé sur video_decoder.c
24 * FIXME: passer en terminate/destroy avec les signaux supplémentaires ?? */
26 /*****************************************************************************
28 *****************************************************************************/
31 #include <stdlib.h> /* malloc(), free() */
32 #include <sys/types.h> /* on BSD, uio.h needs types.h */
33 #include <sys/uio.h> /* for input.h */
34 #include <unistd.h> /* getpid() */
43 #include "debug.h" /* ASSERT */
46 #include "input_netlist.h"
47 #include "decoder_fifo.h"
50 #include "video_output.h"
52 #include "spu_decoder.h"
57 static int InitThread ( spudec_thread_t *p_spudec );
58 static void RunThread ( spudec_thread_t *p_spudec );
59 static void ErrorThread ( spudec_thread_t *p_spudec );
60 static void EndThread ( spudec_thread_t *p_spudec );
62 #define GetWord( i ) \
63 i = GetByte( &p_spudec->bit_stream ) << 8; \
64 i += GetByte( &p_spudec->bit_stream ); \
67 /*****************************************************************************
68 * spudec_CreateThread: create a spu decoder thread
69 *****************************************************************************/
70 spudec_thread_t * spudec_CreateThread( input_thread_t * p_input )
72 spudec_thread_t * p_spudec;
74 intf_DbgMsg("spudec debug: creating spu decoder thread\n");
76 /* Allocate the memory needed to store the thread's structure */
77 if ( (p_spudec = (spudec_thread_t *)malloc( sizeof(spudec_thread_t) )) == NULL )
79 intf_ErrMsg("spudec error: not enough memory for spudec_CreateThread() to create the new thread\n");
84 * Initialize the thread properties
87 p_spudec->b_error = 0;
90 * Initialize the input properties
92 /* Initialize the decoder fifo's data lock and conditional variable and set
93 * its buffer as empty */
94 vlc_mutex_init( &p_spudec->fifo.data_lock );
95 vlc_cond_init( &p_spudec->fifo.data_wait );
96 p_spudec->fifo.i_start = 0;
97 p_spudec->fifo.i_end = 0;
98 /* Initialize the bit stream structure */
99 p_spudec->bit_stream.p_input = p_input;
100 p_spudec->bit_stream.p_decoder_fifo = &p_spudec->fifo;
101 p_spudec->bit_stream.fifo.buffer = 0;
102 p_spudec->bit_stream.fifo.i_available = 0;
104 /* Get the video output informations */
105 p_spudec->p_vout = p_input->p_vout;
107 /* Spawn the spu decoder thread */
108 if ( vlc_thread_create(&p_spudec->thread_id, "spu decoder",
109 (vlc_thread_func_t)RunThread, (void *)p_spudec) )
111 intf_ErrMsg("spudec error: can't spawn spu decoder thread\n");
116 intf_DbgMsg("spudec debug: spu decoder thread (%p) created\n", p_spudec);
120 /*****************************************************************************
121 * spudec_DestroyThread: destroy a spu decoder thread
122 *****************************************************************************
123 * Destroy and terminate thread. This function will return 0 if the thread could
124 * be destroyed, and non 0 else. The last case probably means that the thread
125 * was still active, and another try may succeed.
126 *****************************************************************************/
127 void spudec_DestroyThread( spudec_thread_t *p_spudec )
129 intf_DbgMsg("spudec debug: requesting termination of spu decoder thread %p\n", p_spudec);
131 /* Ask thread to kill itself */
134 /* Warn the decoder that we're quitting */
135 vlc_mutex_lock( &p_spudec->fifo.data_lock );
136 vlc_cond_signal( &p_spudec->fifo.data_wait );
137 vlc_mutex_unlock( &p_spudec->fifo.data_lock );
139 /* Waiting for the decoder thread to exit */
140 /* Remove this as soon as the "status" flag is implemented */
141 vlc_thread_join( p_spudec->thread_id );
144 /* following functions are local */
146 /*****************************************************************************
147 * InitThread: initialize spu decoder thread
148 *****************************************************************************
149 * This function is called from RunThread and performs the second step of the
150 * initialization. It returns 0 on success. Note that the thread's flag are not
151 * modified inside this function.
152 *****************************************************************************/
153 static int InitThread( spudec_thread_t *p_spudec )
155 intf_DbgMsg("spudec debug: initializing spu decoder thread %p\n", p_spudec);
157 /* Our first job is to initialize the bit stream structure with the
158 * beginning of the input stream */
159 vlc_mutex_lock( &p_spudec->fifo.data_lock );
160 while ( DECODER_FIFO_ISEMPTY(p_spudec->fifo) )
162 if ( p_spudec->b_die )
164 vlc_mutex_unlock( &p_spudec->fifo.data_lock );
167 vlc_cond_wait( &p_spudec->fifo.data_wait, &p_spudec->fifo.data_lock );
170 p_spudec->bit_stream.p_ts = DECODER_FIFO_START( p_spudec->fifo )->p_first_ts;
171 p_spudec->bit_stream.p_byte = p_spudec->bit_stream.p_ts->buffer + p_spudec->bit_stream.p_ts->i_payload_start;
172 p_spudec->bit_stream.p_end = p_spudec->bit_stream.p_ts->buffer + p_spudec->bit_stream.p_ts->i_payload_end;
173 vlc_mutex_unlock( &p_spudec->fifo.data_lock );
175 /* Mark thread as running and return */
176 intf_DbgMsg( "spudec debug: InitThread(%p) succeeded\n", p_spudec );
180 /*****************************************************************************
181 * RunThread: spu decoder thread
182 *****************************************************************************
183 * spu decoder thread. This function does only return when the thread is
185 *****************************************************************************/
186 static void RunThread( spudec_thread_t *p_spudec )
188 intf_DbgMsg("spudec debug: running spu decoder thread (%p) (pid == %i)\n",
192 * Initialize thread and free configuration
194 p_spudec->b_error = InitThread( p_spudec );
199 * Main loop - it is not executed if an error occured during
202 while( (!p_spudec->b_die) && (!p_spudec->b_error) )
209 boolean_t b_finished;
210 unsigned char * p_spu_data;
211 subpicture_t * p_spu = NULL;
213 while( !DECODER_FIFO_ISEMPTY(p_spudec->fifo) )
215 /* wait for the next SPU ID.
216 * XXX: We trash 0xff bytes since they come from
217 * an incomplete previous packet */
220 i_packet_size = GetByte( &p_spudec->bit_stream );
222 while( i_packet_size == 0xff );
224 if( p_spudec->b_die )
227 /* the total size - should equal the sum of the
228 * PES packet size that form the SPU packet */
229 i_packet_size = ( i_packet_size << 8 )
230 + GetByte( &p_spudec->bit_stream );
233 /* get the useful PES size (real size - 10) */
234 i_pes_size = DECODER_FIFO_START(p_spudec->fifo)->i_pes_size - 9;
237 /* the RLE stuff size */
238 GetWord( i_rle_size );
240 /* if the values we got aren't too strange, decode the data */
241 if( i_rle_size < i_packet_size )
243 /* allocate the subpicture.
244 * FIXME: we should check if the allocation failed */
245 p_spu = vout_CreateSubPicture( p_spudec->p_vout,
246 DVD_SUBPICTURE, i_rle_size );
247 p_spu_data = p_spu->p_data;
249 /* get display time */
250 p_spu->begin_date = p_spu->end_date
251 = DECODER_FIFO_START(p_spudec->fifo)->i_pts;
253 /* getting the RLE part */
254 while( i_index++ < i_rle_size )
256 /* skip the leading byte of a PES */
257 /* FIXME: this part definitely looks strange */
258 if ( !((i_index + 3) % i_pes_size) )
262 *p_spu_data++ = GetByte( &p_spudec->bit_stream );
265 /* getting the control part */
276 /* next offset, no next offset if == i_index-5 */
278 b_finished = ( i_index - 5 >= i_word );
282 i_cmd = GetByte( &p_spudec->bit_stream );
288 /* 00 (force displaying) */
290 /* FIXME: here we have to calculate dates. It's
291 * around i_date * 10000 but I don't know
295 /* 01 (start displaying) */
296 p_spu->begin_date += ( i_date * 10000 );
299 /* 02 (stop displaying) */
300 p_spu->end_date += ( i_date * 10000 );
303 /* 03xxxx (palette) */
307 /* 04xxxx (alpha channel) */
311 /* 05xxxyyyxxxyyy (coordinates) */
312 i_word = GetByte( &p_spudec->bit_stream );
313 p_spu->i_x = (i_word << 4)
314 | GetBits( &p_spudec->bit_stream, 4 );
316 i_word = GetBits( &p_spudec->bit_stream, 4 );
317 p_spu->i_width = p_spu->i_x - ( (i_word << 8)
318 | GetByte( &p_spudec->bit_stream ) ) + 1;
320 i_word = GetByte( &p_spudec->bit_stream );
321 p_spu->i_y = (i_word << 4)
322 | GetBits( &p_spudec->bit_stream, 4 );
324 i_word = GetBits( &p_spudec->bit_stream, 4 );
325 p_spu->i_height = p_spu->i_y - ( (i_word << 8)
326 | GetByte( &p_spudec->bit_stream ) ) + 1;
331 /* 06xxxxyyyy (byte offsets) */
333 p_spu->type.spu.i_offset[0] = i_word - 4;
335 p_spu->type.spu.i_offset[1] = i_word - 4;
341 /* ?? (unknown command) */
345 while( i_cmd != 0xff );
347 while( !b_finished );
349 /* SPU is finished - we can display it */
350 vout_DisplaySubPicture( p_spudec->p_vout, p_spu );
354 /* Unexpected PES packet - trash it */
355 intf_ErrMsg( "spudec: trying to recover from bad packet\n" );
356 vlc_mutex_lock( &p_spudec->fifo.data_lock );
357 input_NetlistFreePES( p_spudec->bit_stream.p_input,
358 DECODER_FIFO_START(p_spudec->fifo) );
359 DECODER_FIFO_INCSTART( p_spudec->fifo );
360 vlc_mutex_unlock( &p_spudec->fifo.data_lock );
369 if( p_spudec->b_error )
371 ErrorThread( p_spudec );
377 EndThread( p_spudec );
380 /*****************************************************************************
381 * ErrorThread: RunThread() error loop
382 *****************************************************************************
383 * This function is called when an error occured during thread main's loop. The
384 * thread can still receive feed, but must be ready to terminate as soon as
386 *****************************************************************************/
387 static void ErrorThread( spudec_thread_t *p_spudec )
389 /* We take the lock, because we are going to read/write the start/end
390 * indexes of the decoder fifo */
391 vlc_mutex_lock( &p_spudec->fifo.data_lock );
393 /* Wait until a `die' order is sent */
394 while( !p_spudec->b_die )
396 /* Trash all received PES packets */
397 while( !DECODER_FIFO_ISEMPTY(p_spudec->fifo) )
399 input_NetlistFreePES( p_spudec->bit_stream.p_input, DECODER_FIFO_START(p_spudec->fifo) );
400 DECODER_FIFO_INCSTART( p_spudec->fifo );
403 /* Waiting for the input thread to put new PES packets in the fifo */
404 vlc_cond_wait( &p_spudec->fifo.data_wait, &p_spudec->fifo.data_lock );
407 /* We can release the lock before leaving */
408 vlc_mutex_unlock( &p_spudec->fifo.data_lock );
411 /*****************************************************************************
412 * EndThread: thread destruction
413 *****************************************************************************
414 * This function is called when the thread ends after a sucessful
416 *****************************************************************************/
417 static void EndThread( spudec_thread_t *p_spudec )
419 intf_DbgMsg( "spudec debug: destroying spu decoder thread %p\n", p_spudec );
421 intf_DbgMsg( "spudec debug: spu decoder thread %p destroyed\n", p_spudec);