1 /*****************************************************************************
2 * cvd.c : CVD Subtitle decoder thread
3 *****************************************************************************
4 * Copyright (C) 2003 VideoLAN
5 * $Id: cvd.c,v 1.3 2003/12/29 04:47:44 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 1
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
203 *****************************************************************************/
205 Reassemble( decoder_t *p_dec, block_t **pp_block )
207 decoder_sys_t *p_sys = p_dec->p_sys;
211 if( pp_block == NULL || *pp_block == NULL )
218 if( p_block->i_buffer < SPU_HEADER_LEN )
220 msg_Dbg( p_dec, "invalid packet header (size %d < %d)" ,
221 p_block->i_buffer, SPU_HEADER_LEN );
222 block_Release( p_block );
226 p_buffer = p_block->p_buffer;
228 dbg_print( (DECODE_DBG_CALL|DECODE_DBG_PACKET),
229 "header: 0x%02x 0x%02x 0x%02x 0x%02x, 0x%02x, 0x%02x, size: %i",
230 p_buffer[1], p_buffer[2], p_buffer[3], p_buffer[4],
231 p_buffer[5], p_buffer[6],
234 if( config_GetInt( p_dec, "spu-channel" ) != p_buffer[0] )
237 /* There is little data on the format, but it does not seem to have a
238 good way to detect the first packet in the subtitle. It seems,
239 however, that it has a valid pts while later packets for the same
242 if ( p_sys->state == SUBTITLE_BLOCK_EMPTY && p_block->i_pts == 0 ) {
244 "first packet expected but no PTS present -- skipped\n");
248 if ( p_sys->subtitle_data_pos == 0 ) {
249 /* First packet in the subtitle block */
250 E_(ParseHeader)( p_dec, p_buffer, p_block );
251 VCDSubInitSubtitleData(p_sys);
254 /* FIXME - remove append_data and use chainappend */
255 VCDSubAppendData( p_dec, p_buffer, p_block->i_buffer - 1 );
257 block_ChainAppend( &p_sys->p_block, p_block );
259 p_sys->i_spu += p_block->i_buffer - SPU_HEADER_LEN;
261 if ( p_sys->subtitle_data_pos == p_sys->i_spu_size ) {
262 /* last packet in subtitle block. */
264 uint8_t *p = p_sys->subtitle_data + p_sys->metadata_offset+1;
265 uint8_t *p_end = p + p_sys->metadata_length;
267 dbg_print( (DECODE_DBG_PACKET),
268 "subtitle packet complete, size=%d", p_sys->i_spu );
270 p_sys->state = SUBTITLE_BLOCK_COMPLETE;
274 for ( ; p < p_end; p += 4 ) {
278 case 0x04: /* Display duration in 1/90000ths of a second */
280 p_sys->i_duration = (p[1]<<16) + (p[2]<<8) + p[3];
282 dbg_print( DECODE_DBG_PACKET,
283 "subtitle display duration %u", p_sys->i_duration);
286 case 0x0c: /* Unknown */
287 dbg_print( DECODE_DBG_PACKET,
288 "subtitle command unknown 0x%0x 0x%0x 0x%0x 0x%0x\n",
289 p[0], p[1], p[2], p[3]);
292 case 0x17: /* Position */
293 p_sys->i_x_start = ((p[1]&0x0f)<<6) + (p[2]>>2);
294 p_sys->i_y_start = ((p[2]&0x03)<<8) + p[3];
295 dbg_print( DECODE_DBG_PACKET,
296 "start position (%d,%d): %.2x %.2x %.2x",
297 p_sys->i_x_start, p_sys->i_y_start,
301 case 0x1f: /* Coordinates of the image bottom right */
303 int lastx = ((p[1]&0x0f)<<6) + (p[2]>>2);
304 int lasty = ((p[2]&0x03)<<8) + p[3];
305 p_sys->i_width = lastx - p_sys->i_x_start + 1;
306 p_sys->i_height = lasty - p_sys->i_y_start + 1;
307 dbg_print( DECODE_DBG_PACKET,
308 "end position: (%d,%d): %.2x %.2x %.2x, w x h: %d x %d",
309 lastx, lasty, p[1], p[2], p[3],
310 p_sys->i_width, p_sys->i_height );
320 uint8_t v = p[0]-0x24;
322 /* Primary Palette */
323 dbg_print( DECODE_DBG_PACKET,
324 "primary palette %d (y,u,v): (0x%0x,0x%0x,0x%0x)",
325 v, p[1], p[2], p[3]);
327 p_sys->pi_palette[v].s.y = p[1];
328 p_sys->pi_palette[v].s.u = p[2];
329 p_sys->pi_palette[v].s.v = p[3];
339 uint8_t v = p[0]-0x2c;
341 dbg_print( DECODE_DBG_PACKET,
342 "highlight palette %d (y,u,v): (0x%0x,0x%0x,0x%0x)",
343 v, p[1], p[2], p[3]);
345 /* Highlight Palette */
346 p_sys->pi_palette_highlight[v].s.y = p[1];
347 p_sys->pi_palette_highlight[v].s.u = p[2];
348 p_sys->pi_palette_highlight[v].s.v = p[3];
353 /* transparency for primary palette */
354 p_sys->pi_palette[0].s.t = p[3] & 0x0f;
355 p_sys->pi_palette[1].s.t = p[3] >> 4;
356 p_sys->pi_palette[2].s.t = p[2] & 0x0f;
357 p_sys->pi_palette[3].s.t = p[2] >> 4;
359 dbg_print( DECODE_DBG_PACKET,
360 "transparancy for primary palette (y,u,v): "
367 /* transparency for highlight palette */
368 p_sys->pi_palette_highlight[0].s.t = p[2] & 0x0f;
369 p_sys->pi_palette_highlight[1].s.t = p[2] >> 4;
370 p_sys->pi_palette_highlight[2].s.t = p[1] & 0x0f;
371 p_sys->pi_palette_highlight[3].s.t = p[1] >> 4;
373 dbg_print( DECODE_DBG_PACKET,
374 "transparancy for highlight palette (y,u,v): "
381 /* offset to first field data, we correct to make it relative
382 to comp_image_offset (usually 4) */
383 p_sys->first_field_offset =
384 (p[2] << 8) + p[3] - p_sys->comp_image_offset;
385 dbg_print( DECODE_DBG_PACKET,
386 "first_field_offset %d", p_sys->first_field_offset);
390 /* offset to second field data, we correct to make it relative to
391 comp_image_offset (usually 4) */
392 p_sys->second_field_offset =
393 (p[2] << 8) + p[3] - p_sys->comp_image_offset;
394 dbg_print( DECODE_DBG_PACKET,
395 "second_field_offset %d", p_sys->second_field_offset);
400 "unknown sequence in control header "
401 "0x%0x 0x%0x 0x%0x 0x%0x",
402 p[0], p[1], p[2], p[3]);
404 p_sys->subtitle_data_pos = 0;
407 return p_sys->p_block;
409 /* Not last block in subtitle, so wait for another. */
410 p_sys->state = SUBTITLE_BLOCK_PARTIAL;