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 */
45 #include "stream_control.h"
46 #include "input_ext-dec.h"
49 #include "video_output.h"
51 #include "spu_decoder.h"
56 static int InitThread ( spudec_thread_t *p_spudec );
57 static void RunThread ( spudec_thread_t *p_spudec );
58 static void ErrorThread ( spudec_thread_t *p_spudec );
59 static void EndThread ( spudec_thread_t *p_spudec );
61 #define GetWord( i ) \
62 i = GetByte( &p_spudec->bit_stream ) << 8; \
63 i += GetByte( &p_spudec->bit_stream ); \
66 /*****************************************************************************
67 * spudec_CreateThread: create a spu decoder thread
68 *****************************************************************************/
69 vlc_thread_t spudec_CreateThread( vdec_config_t * p_config )
71 spudec_thread_t * p_spudec;
73 intf_DbgMsg("spudec debug: creating spu decoder thread\n");
75 /* Allocate the memory needed to store the thread's structure */
76 if ( (p_spudec = (spudec_thread_t *)malloc( sizeof(spudec_thread_t) )) == NULL )
78 intf_ErrMsg("spudec error: not enough memory for spudec_CreateThread() to create the new thread\n");
83 * Initialize the thread properties
85 p_spudec->p_fifo->b_die = 0;
86 p_spudec->p_fifo->b_error = 0;
87 p_spudec->p_config = p_config;
88 p_spudec->p_fifo = p_config->decoder_config.p_decoder_fifo;
90 /* Get the video output informations */
91 p_spudec->p_vout = p_config->p_vout;
93 /* Spawn the spu decoder thread */
94 if ( vlc_thread_create(&p_spudec->thread_id, "spu decoder",
95 (vlc_thread_func_t)RunThread, (void *)p_spudec) )
97 intf_ErrMsg("spudec error: can't spawn spu decoder thread\n");
102 intf_DbgMsg("spudec debug: spu decoder thread (%p) created\n", p_spudec);
103 return( p_spudec->thread_id );
106 /* following functions are local */
108 /*****************************************************************************
109 * InitThread: initialize spu decoder thread
110 *****************************************************************************
111 * This function is called from RunThread and performs the second step of the
112 * initialization. It returns 0 on success. Note that the thread's flag are not
113 * modified inside this function.
114 *****************************************************************************/
115 static int InitThread( spudec_thread_t *p_spudec )
117 intf_DbgMsg("spudec debug: initializing spu decoder thread %p\n", p_spudec);
119 p_spudec->p_config->decoder_config.pf_init_bit_stream( &p_spudec->bit_stream,
120 p_spudec->p_config->decoder_config.p_decoder_fifo );
122 /* Mark thread as running and return */
123 intf_DbgMsg( "spudec debug: InitThread(%p) succeeded\n", p_spudec );
127 /*****************************************************************************
128 * RunThread: spu decoder thread
129 *****************************************************************************
130 * spu decoder thread. This function only returns when the thread is
132 *****************************************************************************/
133 static void RunThread( spudec_thread_t *p_spudec )
135 intf_DbgMsg("spudec debug: running spu decoder thread (%p) (pid == %i)\n",
139 * Initialize thread and free configuration
141 p_spudec->p_fifo->b_error = InitThread( p_spudec );
144 * Main loop - it is not executed if an error occured during
147 while( (!p_spudec->p_fifo->b_die) && (!p_spudec->p_fifo->b_error) )
154 boolean_t b_finished;
155 unsigned char * p_spu_data;
156 subpicture_t * p_spu = NULL;
158 while( !DECODER_FIFO_ISEMPTY(*p_spudec->p_fifo) )
160 /* wait for the next SPU ID.
161 * XXX: We trash 0xff bytes since they probably come from
162 * an incomplete previous packet */
165 i_packet_size = GetByte( &p_spudec->bit_stream );
167 while( i_packet_size == 0xff );
169 if( p_spudec->p_fifo->b_die )
172 /* the total size - should equal the sum of the
173 * PES packet size that form the SPU packet */
174 i_packet_size = ( i_packet_size << 8 )
175 + GetByte( &p_spudec->bit_stream );
178 /* get the useful PES size (real size - 10) */
179 i_pes_size = DECODER_FIFO_START(*p_spudec->p_fifo)->i_pes_size - 9;
182 /* the RLE stuff size */
183 GetWord( i_rle_size );
185 /* if the values we got aren't too strange, decode the data */
186 if( i_rle_size < i_packet_size )
188 /* allocate the subpicture.
189 * FIXME: we should check if the allocation failed */
190 p_spu = vout_CreateSubPicture( p_spudec->p_vout,
191 DVD_SUBPICTURE, i_rle_size );
192 p_spu_data = p_spu->p_data;
194 /* get display time */
195 p_spu->begin_date = p_spu->end_date
196 = DECODER_FIFO_START(*p_spudec->p_fifo)->i_pts;
198 /* getting the RLE part */
199 while( i_index++ < i_rle_size )
201 /* skip the leading byte of a PES */
202 /* FIXME: this part definitely looks strange */
203 if ( !((i_index + 3) % i_pes_size) )
207 *p_spu_data++ = GetByte( &p_spudec->bit_stream );
210 /* getting the control part */
221 /* next offset, no next offset if == i_index-5 */
223 b_finished = ( i_index - 5 >= i_word );
227 i_cmd = GetByte( &p_spudec->bit_stream );
232 case SPU_CMD_FORCE_DISPLAY:
233 /* 00 (force displaying) */
235 /* FIXME: here we have to calculate dates. It's
236 * around i_date * 12000 but I don't know
239 case SPU_CMD_START_DISPLAY:
240 /* 01 (start displaying) */
241 p_spu->begin_date += ( i_date * 12000 );
243 case SPU_CMD_STOP_DISPLAY:
244 /* 02 (stop displaying) */
245 p_spu->end_date += ( i_date * 12000 );
247 case SPU_CMD_SET_PALETTE:
248 /* 03xxxx (palette) */
251 case SPU_CMD_SET_ALPHACHANNEL:
252 /* 04xxxx (alpha channel) */
255 case SPU_CMD_SET_COORDINATES:
256 /* 05xxxyyyxxxyyy (coordinates) */
257 i_word = GetByte( &p_spudec->bit_stream );
258 p_spu->i_x = (i_word << 4)
259 | GetBits( &p_spudec->bit_stream, 4 );
261 i_word = GetBits( &p_spudec->bit_stream, 4 );
262 p_spu->i_width = p_spu->i_x - ( (i_word << 8)
263 | GetByte( &p_spudec->bit_stream ) ) + 1;
265 i_word = GetByte( &p_spudec->bit_stream );
266 p_spu->i_y = (i_word << 4)
267 | GetBits( &p_spudec->bit_stream, 4 );
269 i_word = GetBits( &p_spudec->bit_stream, 4 );
270 p_spu->i_height = p_spu->i_y - ( (i_word << 8)
271 | GetByte( &p_spudec->bit_stream ) ) + 1;
275 case SPU_CMD_SET_OFFSETS:
276 /* 06xxxxyyyy (byte offsets) */
278 p_spu->type.spu.i_offset[0] = i_word - 4;
280 p_spu->type.spu.i_offset[1] = i_word - 4;
286 /* ?? (unknown command) */
287 intf_ErrMsg( "spudec: unknown command 0x%.2x\n",
292 while( i_cmd != SPU_CMD_END );
294 while( !b_finished );
296 /* SPU is finished - we can tell the video output
298 vout_DisplaySubPicture( p_spudec->p_vout, p_spu );
302 /* Unexpected PES packet - trash it */
303 intf_ErrMsg( "spudec: trying to recover from bad packet\n" );
304 vlc_mutex_lock( &p_spudec->p_fifo->data_lock );
305 p_spudec->p_fifo->pf_delete_pes( p_spudec->p_fifo->p_packets_mgt,
306 DECODER_FIFO_START(*p_spudec->p_fifo) );
307 DECODER_FIFO_INCSTART( *p_spudec->p_fifo );
308 vlc_mutex_unlock( &p_spudec->p_fifo->data_lock );
317 if( p_spudec->p_fifo->b_error )
319 ErrorThread( p_spudec );
323 EndThread( p_spudec );
326 /*****************************************************************************
327 * ErrorThread: RunThread() error loop
328 *****************************************************************************
329 * This function is called when an error occured during thread main's loop. The
330 * thread can still receive feed, but must be ready to terminate as soon as
332 *****************************************************************************/
333 static void ErrorThread( spudec_thread_t *p_spudec )
335 /* We take the lock, because we are going to read/write the start/end
336 * indexes of the decoder fifo */
337 vlc_mutex_lock( &p_spudec->p_fifo->data_lock );
339 /* Wait until a `die' order is sent */
340 while( !p_spudec->p_fifo->b_die )
342 /* Trash all received PES packets */
343 while( !DECODER_FIFO_ISEMPTY(*p_spudec->p_fifo) )
345 p_spudec->p_fifo->pf_delete_pes( p_spudec->p_fifo->p_packets_mgt,
346 DECODER_FIFO_START(*p_spudec->p_fifo) );
347 DECODER_FIFO_INCSTART( *p_spudec->p_fifo );
350 /* Waiting for the input thread to put new PES packets in the fifo */
351 vlc_cond_wait( &p_spudec->p_fifo->data_wait, &p_spudec->p_fifo->data_lock );
354 /* We can release the lock before leaving */
355 vlc_mutex_unlock( &p_spudec->p_fifo->data_lock );
358 /*****************************************************************************
359 * EndThread: thread destruction
360 *****************************************************************************
361 * This function is called when the thread ends after a sucessful
363 *****************************************************************************/
364 static void EndThread( spudec_thread_t *p_spudec )
366 intf_DbgMsg( "spudec debug: destroying spu decoder thread %p\n", p_spudec );
368 intf_DbgMsg( "spudec debug: spu decoder thread %p destroyed\n", p_spudec);