1 /*****************************************************************************
2 * cvd.c : CVD Subtitle decoder thread
3 *****************************************************************************
4 * Copyright (C) 2003 VideoLAN
5 * $Id: cvd.c,v 1.1 2003/12/28 04:51:52 rocky Exp $
7 * Authors: Rocky Bernstein
9 * Julio Sanchez Fernandez (http://subhandler.sourceforge.net)
10 * Samuel Hocevar <sam@zoy.org>
11 * Laurent Aimar <fenrir@via.ecp.fr>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
26 *****************************************************************************/
28 /*****************************************************************************
30 *****************************************************************************/
33 #include <vlc/decoder.h>
39 #define DEBUG_LONGTEXT N_( \
40 "This integer when viewed in binary is a debugging mask\n" \
43 "packet assembly info 4\n" \
45 "image transformations 16\n" \
48 /*****************************************************************************
50 *****************************************************************************/
51 static int DecoderOpen ( vlc_object_t * );
52 static int PacketizerOpen( vlc_object_t * );
55 set_description( _("CVD subtitle decoder") );
56 set_capability( "decoder", 50 );
57 set_callbacks( DecoderOpen, VCDSubClose );
59 add_integer ( MODULE_STRING "-debug", 0, NULL,
60 N_("set debug mask for additional debugging."),
61 N_(DEBUG_LONGTEXT), VLC_TRUE );
64 set_description( _("Chaoji VCD subtitle packetizer") );
65 set_capability( "packetizer", 50 );
66 set_callbacks( PacketizerOpen, VCDSubClose );
69 /*****************************************************************************
71 *****************************************************************************/
73 static block_t *Reassemble( decoder_t *, block_t ** );
74 static void Decode ( decoder_t *, block_t ** );
75 static block_t *Packetize( decoder_t *, block_t ** );
78 /*****************************************************************************
80 *****************************************************************************
81 * Tries to launch a decoder and return score so that the interface is able
83 *****************************************************************************/
85 DecoderOpen( vlc_object_t *p_this )
87 decoder_t *p_dec = (decoder_t*)p_this;
90 if( p_dec->fmt_in.i_codec != VLC_FOURCC( 'c','v','d',' ' ) )
96 p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
98 p_sys->i_debug = config_GetInt( p_this, MODULE_STRING "-debug" );
99 p_sys->b_packetizer = VLC_FALSE;
100 p_sys->p_vout = NULL;
102 p_sys->subtitle_data = NULL;
104 VCDSubInitSubtitleBlock( p_sys );
106 es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 'c','v','d',' ' ) );
109 p_dec->pf_decode_sub = Decode;
110 p_dec->pf_packetize = Packetize;
112 dbg_print( (DECODE_DBG_CALL|DECODE_DBG_EXT) , "");
117 /*****************************************************************************
119 *****************************************************************************
120 * Tries to launch a decoder and return score so that the interface is able
122 *****************************************************************************/
123 static int PacketizerOpen( vlc_object_t *p_this )
125 decoder_t *p_dec = (decoder_t*)p_this;
127 if( DecoderOpen( p_this ) )
131 p_dec->p_sys->b_packetizer = VLC_TRUE;
136 /*****************************************************************************
138 *****************************************************************************/
140 Decode ( decoder_t *p_dec, block_t **pp_block )
142 decoder_sys_t *p_sys = p_dec->p_sys;
143 block_t *p_spu = Reassemble( p_dec, pp_block );
145 dbg_print( (DECODE_DBG_CALL) , "");
149 p_sys->i_spu = block_ChainExtract( p_spu, p_sys->buffer, 65536 );
150 p_sys->i_pts = p_spu->i_pts;
151 block_ChainRelease( p_spu );
153 if( ( p_sys->p_vout = VCDSubFindVout( p_dec ) ) )
155 /* Parse and decode */
156 E_(ParsePacket)( p_dec );
158 vlc_object_release( p_sys->p_vout );
161 VCDSubInitSubtitleBlock ( p_sys );
166 /*****************************************************************************
168 *****************************************************************************/
170 Packetize( decoder_t *p_dec, block_t **pp_block )
172 decoder_sys_t *p_sys = p_dec->p_sys;
173 block_t *p_spu = Reassemble( p_dec, pp_block );
177 p_spu->i_dts = p_spu->i_pts;
180 VCDSubInitSubtitleBlock( p_sys );
182 return block_ChainGather( p_spu );
187 /* following functions are local */
189 #define SPU_HEADER_LEN 5
191 /*****************************************************************************
194 The data for single screen subtitle may come in one of many
195 non-contiguous packets of a stream. This routine is called when the
196 next packet in the stream comes in. The job of this routine is to
197 parse the header, if this is the beginning, and combine the packets
198 into one complete subtitle unit.
200 If everything is complete, we will return a block. Otherwise return
204 The format of the beginning of the subtitle packet that is used here.
207 -------------------------------------------
208 byte subtitle channel (0..7) in bits 0-3
209 byte subtitle packet number of this subtitle image 0-N,
210 if the subtitle packet is complete, the top bit of the byte is 1.
211 uint16 subtitle image number
213 *****************************************************************************/
215 Reassemble( decoder_t *p_dec, block_t **pp_block )
217 decoder_sys_t *p_sys = p_dec->p_sys;
220 uint16_t i_expected_image;
221 uint8_t i_packet, i_expected_packet;
223 if( pp_block == NULL || *pp_block == NULL )
230 if( p_block->i_buffer < SPU_HEADER_LEN )
232 msg_Dbg( p_dec, "invalid packet header (size %d < %d)" ,
233 p_block->i_buffer, SPU_HEADER_LEN );
234 block_Release( p_block );
238 p_buffer = p_block->p_buffer;
240 dbg_print( (DECODE_DBG_CALL|DECODE_DBG_PACKET),
241 "header: 0x%02x 0x%02x 0x%02x 0x%02x, size: %i",
242 p_buffer[1], p_buffer[2], p_buffer[3], p_buffer[4],
245 if( config_GetInt( p_dec, "spu-channel" ) != p_buffer[1] )
248 if ( p_sys->state == SUBTITLE_BLOCK_EMPTY ) {
249 i_expected_image = p_sys->i_image+1;
250 i_expected_packet = 0;
252 i_expected_image = p_sys->i_image;
253 i_expected_packet = p_sys->i_packet+1;
258 if ( *p_buffer & 0x80 ) {
259 p_sys->state = SUBTITLE_BLOCK_COMPLETE;
260 i_packet = ( *p_buffer++ & 0x7F );
262 p_sys->state = SUBTITLE_BLOCK_PARTIAL;
263 i_packet = *p_buffer++;
266 p_sys->i_image = GETINT16(p_buffer);
268 if ( p_sys->i_image != i_expected_image ) {
269 msg_Warn( p_dec, "expecting subtitle image %u but found %u",
270 i_expected_image, p_sys->i_image );
273 if ( i_packet != i_expected_packet ) {
274 msg_Warn( p_dec, "expecting subtitle image packet %u but found %u",
275 i_expected_packet, i_packet);
278 p_sys->i_packet = i_packet;
280 if ( p_sys->i_packet == 0 ) {
281 /* First packet in the subtitle block */
282 E_(ParseHeader)( p_dec, p_buffer, p_block );
283 VCDSubInitSubtitleData(p_sys);
286 /* FIXME - remove append_data and use chainappend */
287 VCDSubAppendData( p_dec, p_buffer, p_block->i_buffer - 5 );
289 block_ChainAppend( &p_sys->p_block, p_block );
291 p_sys->i_spu += p_block->i_buffer - SPU_HEADER_LEN;
293 if (p_sys->state == SUBTITLE_BLOCK_COMPLETE)
295 if( p_sys->i_spu != p_sys->i_spu_size )
297 msg_Warn( p_dec, "SPU packets size=%d should be %d",
298 p_sys->i_spu, p_sys->i_spu_size );
301 dbg_print( (DECODE_DBG_PACKET),
302 "subtitle packet complete, size=%d", p_sys->i_spu );
304 return p_sys->p_block;