1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2000-2001 VideoLAN
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Laurent Aimar <fenrir@via.ecp.fr>
9 * Gildas Bazin <gbazin@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
31 #include <vlc/decoder.h>
35 /*****************************************************************************
37 *****************************************************************************/
38 static int ParseControlSeq( decoder_t *, subpicture_t *, subpicture_data_t *);
39 static int ParseRLE ( decoder_t *, subpicture_t *, subpicture_data_t *);
40 static void Render ( decoder_t *, subpicture_t *, subpicture_data_t *);
42 /*****************************************************************************
43 * AddNibble: read a nibble from a source packet and add it to our integer.
44 *****************************************************************************/
45 static inline unsigned int AddNibble( unsigned int i_code,
46 uint8_t *p_src, int *pi_index )
50 return( i_code << 4 | ( p_src[(*pi_index)++ >> 1] & 0xf ) );
54 return( i_code << 4 | p_src[(*pi_index)++ >> 1] >> 4 );
58 /*****************************************************************************
59 * ParsePacket: parse an SPU packet and send it to the video output
60 *****************************************************************************
61 * This function parses the SPU packet and, if valid, sends it to the
63 *****************************************************************************/
64 subpicture_t * E_(ParsePacket)( decoder_t *p_dec )
66 decoder_sys_t *p_sys = p_dec->p_sys;
67 subpicture_data_t *p_spu_data;
70 /* Allocate the subpicture internal data. */
71 p_spu = p_dec->pf_spu_buffer_new( p_dec );
72 if( !p_spu ) return NULL;
74 /* Rationale for the "p_spudec->i_rle_size * 4": we are going to
75 * expand the RLE stuff so that we won't need to read nibbles later
76 * on. This will speed things up a lot. Plus, we'll only need to do
77 * this stupid interlacing stuff once. */
78 p_spu_data = malloc( sizeof(subpicture_data_t) + 4 * p_sys->i_rle_size );
79 p_spu_data->p_data = (uint8_t *)p_spu_data + sizeof(subpicture_data_t);
80 p_spu_data->b_palette = VLC_FALSE;
81 p_spu_data->b_auto_crop = VLC_FALSE;
82 p_spu_data->i_y_top_offset = 0;
83 p_spu_data->i_y_bottom_offset = 0;
85 p_spu_data->pi_alpha[0] = 0x00;
86 p_spu_data->pi_alpha[1] = 0x0f;
87 p_spu_data->pi_alpha[2] = 0x0f;
88 p_spu_data->pi_alpha[3] = 0x0f;
90 /* Get display time now. If we do it later, we may miss the PTS. */
91 p_spu_data->i_pts = p_sys->i_pts;
93 /* Getting the control part */
94 if( ParseControlSeq( p_dec, p_spu, p_spu_data ) )
96 /* There was a parse error, delete the subpicture */
97 p_dec->pf_spu_buffer_del( p_dec, p_spu );
101 /* We try to display it */
102 if( ParseRLE( p_dec, p_spu, p_spu_data ) )
104 /* There was a parse error, delete the subpicture */
105 p_dec->pf_spu_buffer_del( p_dec, p_spu );
109 msg_Dbg( p_dec, "total size: 0x%x, RLE offsets: 0x%x 0x%x",
111 p_spu_data->pi_offset[0], p_spu_data->pi_offset[1] );
113 Render( p_dec, p_spu, p_spu_data );
119 /*****************************************************************************
120 * ParseControlSeq: parse all SPU control sequences
121 *****************************************************************************
122 * This is the most important part in SPU decoding. We get dates, palette
123 * information, coordinates, and so on. For more information on the
124 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
125 *****************************************************************************/
126 static int ParseControlSeq( decoder_t *p_dec, subpicture_t *p_spu,
127 subpicture_data_t *p_spu_data )
129 decoder_sys_t *p_sys = p_dec->p_sys;
131 /* Our current index in the SPU packet */
132 unsigned int i_index = p_sys->i_rle_size + 4;
134 /* The next start-of-control-sequence index and the previous one */
135 unsigned int i_next_seq = 0, i_cur_seq = 0;
137 /* Command and date */
138 uint8_t i_command = SPU_CMD_END;
141 unsigned int i, pi_alpha[4];
143 /* Initialize the structure */
144 p_spu->i_start = p_spu->i_stop = 0;
145 p_spu->b_ephemer = VLC_FALSE;
149 if( (int)i_index >= p_sys->i_spu_size + 1 )
152 * XXX only on test by loop as p_sys->buffer is bigger than needed
153 * to avoid checking at each access
158 /* If we just read a command sequence, read the next one;
159 * otherwise, go on with the commands of the current sequence. */
160 if( i_command == SPU_CMD_END )
162 /* Get the control sequence date */
163 date = (mtime_t)GetWBE( &p_sys->buffer[i_index] ) * 11000;
164 /* FIXME How to access i_rate
165 * p_spudec->bit_stream.p_pes->i_rate / DEFAULT_RATE;
170 i_next_seq = GetWBE( &p_sys->buffer[i_index+2] );
172 /* Skip what we just read */
176 i_command = p_sys->buffer[i_index++];
180 case SPU_CMD_FORCE_DISPLAY: /* 00 (force displaying) */
181 p_spu->i_start = p_spu_data->i_pts + date;
182 p_spu->b_ephemer = VLC_TRUE;
185 /* Convert the dates in seconds to PTS values */
186 case SPU_CMD_START_DISPLAY: /* 01 (start displaying) */
187 p_spu->i_start = p_spu_data->i_pts + date;
190 case SPU_CMD_STOP_DISPLAY: /* 02 (stop displaying) */
191 p_spu->i_stop = p_spu_data->i_pts + date;
194 case SPU_CMD_SET_PALETTE:
196 /* 03xxxx (palette) */
197 if( p_dec->fmt_in.subs.spu.palette[0] == 0xBeeF )
201 p_spu_data->b_palette = VLC_TRUE;
203 idx[0] = (p_sys->buffer[i_index+0]>>4)&0x0f;
204 idx[1] = (p_sys->buffer[i_index+0])&0x0f;
205 idx[2] = (p_sys->buffer[i_index+1]>>4)&0x0f;
206 idx[3] = (p_sys->buffer[i_index+1])&0x0f;
208 for( i = 0; i < 4 ; i++ )
210 uint32_t i_color = p_dec->fmt_in.subs.spu.palette[1+idx[i]];
212 /* FIXME: this job should be done sooner */
213 p_spu_data->pi_yuv[3-i][0] = (i_color>>16) & 0xff;
214 p_spu_data->pi_yuv[3-i][1] = (i_color>>0) & 0xff;
215 p_spu_data->pi_yuv[3-i][2] = (i_color>>8) & 0xff;
222 case SPU_CMD_SET_ALPHACHANNEL: /* 04xxxx (alpha channel) */
223 pi_alpha[3] = (p_sys->buffer[i_index+0]>>4)&0x0f;
224 pi_alpha[2] = (p_sys->buffer[i_index+0])&0x0f;
225 pi_alpha[1] = (p_sys->buffer[i_index+1]>>4)&0x0f;
226 pi_alpha[0] = (p_sys->buffer[i_index+1])&0x0f;
228 /* Ignore blank alpha palette. Sometimes spurious blank
229 * alpha palettes are present - dunno why. */
230 if( pi_alpha[0] | pi_alpha[1] | pi_alpha[2] | pi_alpha[3] )
232 p_spu_data->pi_alpha[0] = pi_alpha[0];
233 p_spu_data->pi_alpha[1] = pi_alpha[1];
234 p_spu_data->pi_alpha[2] = pi_alpha[2];
235 p_spu_data->pi_alpha[3] = pi_alpha[3];
239 msg_Warn( p_dec, "ignoring blank alpha palette" );
245 case SPU_CMD_SET_COORDINATES: /* 05xxxyyyxxxyyy (coordinates) */
246 p_spu->i_x = (p_sys->buffer[i_index+0]<<4)|
247 ((p_sys->buffer[i_index+1]>>4)&0x0f);
248 p_spu->i_width = (((p_sys->buffer[i_index+1]&0x0f)<<8)|
249 p_sys->buffer[i_index+2]) - p_spu->i_x + 1;
251 p_spu->i_y = (p_sys->buffer[i_index+3]<<4)|
252 ((p_sys->buffer[i_index+4]>>4)&0x0f);
253 p_spu->i_height = (((p_sys->buffer[i_index+4]&0x0f)<<8)|
254 p_sys->buffer[i_index+5]) - p_spu->i_y + 1;
256 /* Auto crop fullscreen subtitles */
257 if( p_spu->i_height > 250 )
258 p_spu_data->b_auto_crop = VLC_TRUE;
263 case SPU_CMD_SET_OFFSETS: /* 06xxxxyyyy (byte offsets) */
264 p_spu_data->pi_offset[0] = GetWBE(&p_sys->buffer[i_index+0]) - 4;
265 p_spu_data->pi_offset[1] = GetWBE(&p_sys->buffer[i_index+2]) - 4;
269 case SPU_CMD_END: /* ff (end) */
272 default: /* xx (unknown command) */
273 msg_Warn( p_dec, "unknown command 0x%.2x", i_command );
277 /* We need to check for quit commands here */
283 } while( i_command != SPU_CMD_END || i_index == i_next_seq );
285 /* Check that the next sequence index matches the current one */
286 if( i_next_seq != i_cur_seq )
288 msg_Err( p_dec, "index mismatch (0x%.4x != 0x%.4x)",
289 i_next_seq, i_cur_seq );
293 if( (int)i_index > p_sys->i_spu_size )
295 msg_Err( p_dec, "uh-oh, we went too far (0x%.4x > 0x%.4x)",
296 i_index, p_sys->i_spu_size );
300 if( !p_spu->i_start )
302 msg_Err( p_dec, "no `start display' command" );
305 if( p_spu->i_stop <= p_spu->i_start && !p_spu->b_ephemer )
307 /* This subtitle will live for 5 seconds or until the next subtitle */
308 p_spu->i_stop = p_spu->i_start + (mtime_t)500 * 11000;
309 p_spu->b_ephemer = VLC_TRUE;
312 /* Get rid of padding bytes */
313 if( p_sys->i_spu_size > (int)i_index + 1 )
315 /* Zero or one padding byte, are quite usual
316 * More than one padding byte - this is very strange, but
317 * we can deal with it */
318 msg_Warn( p_dec, "%i padding bytes, we usually get 0 or 1 of them",
319 p_sys->i_spu_size - i_index );
322 /* Successfully parsed ! */
326 /*****************************************************************************
327 * ParseRLE: parse the RLE part of the subtitle
328 *****************************************************************************
329 * This part parses the subtitle graphical data and stores it in a more
330 * convenient structure for later decoding. For more information on the
331 * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
332 *****************************************************************************/
333 static int ParseRLE( decoder_t *p_dec, subpicture_t * p_spu,
334 subpicture_data_t *p_spu_data )
336 decoder_sys_t *p_sys = p_dec->p_sys;
337 uint8_t *p_src = &p_sys->buffer[4];
341 unsigned int i_width = p_spu->i_width;
342 unsigned int i_height = p_spu->i_height;
343 unsigned int i_x, i_y;
345 uint16_t *p_dest = (uint16_t *)p_spu_data->p_data;
347 /* The subtitles are interlaced, we need two offsets */
348 unsigned int i_id = 0; /* Start on the even SPU layer */
349 unsigned int pi_table[ 2 ];
350 unsigned int *pi_offset;
353 vlc_bool_t b_empty_top = VLC_TRUE;
354 unsigned int i_skipped_top = 0, i_skipped_bottom = 0;
355 unsigned int i_transparent_code = 0;
357 /* Colormap statistics */
359 int stats[4]; stats[0] = stats[1] = stats[2] = stats[3] = 0;
361 pi_table[ 0 ] = p_spu_data->pi_offset[ 0 ] << 1;
362 pi_table[ 1 ] = p_spu_data->pi_offset[ 1 ] << 1;
364 for( i_y = 0 ; i_y < i_height ; i_y++ )
366 pi_offset = pi_table + i_id;
368 for( i_x = 0 ; i_x < i_width ; i_x += i_code >> 2 )
370 i_code = AddNibble( 0, p_src, pi_offset );
374 i_code = AddNibble( i_code, p_src, pi_offset );
378 i_code = AddNibble( i_code, p_src, pi_offset );
382 i_code = AddNibble( i_code, p_src, pi_offset );
384 if( i_code < 0x0100 )
386 /* If the 14 first bits are set to 0, then it's a
387 * new line. We emulate it. */
388 if( i_code < 0x0004 )
390 i_code |= ( i_width - i_x ) << 2;
394 /* We have a boo boo ! */
395 msg_Err( p_dec, "unknown RLE code "
404 if( ( (i_code >> 2) + i_x + i_y * i_width ) > i_height * i_width )
406 msg_Err( p_dec, "out of bounds, %i at (%i,%i) is out of %ix%i",
407 i_code >> 2, i_x, i_y, i_width, i_height );
411 /* Try to find the border color */
412 if( p_spu_data->pi_alpha[ i_code & 0x3 ] != 0x00 )
414 i_border = i_code & 0x3;
415 stats[i_border] += i_code >> 2;
418 /* Auto crop subtitles (a lot more optimized) */
419 if( p_spu_data->b_auto_crop )
423 /* We assume that if the first line is transparent, then
424 * it is using the palette index for the
425 * (background) transparent color */
426 if( (i_code >> 2) == i_width &&
427 p_spu_data->pi_alpha[ i_code & 0x3 ] == 0x00 )
429 i_transparent_code = i_code;
433 p_spu_data->b_auto_crop = VLC_FALSE;
437 if( i_code == i_transparent_code )
441 /* This is a blank top line, we skip it */
446 /* We can't be sure the current lines will be skipped,
447 * so we store the code just in case. */
454 /* We got a valid code, store it */
457 /* Valid code means no blank line */
458 b_empty_top = VLC_FALSE;
459 i_skipped_bottom = 0;
468 /* Check that we didn't go too far */
471 msg_Err( p_dec, "i_x overflowed, %i > %i", i_x, i_width );
475 /* Byte-align the stream */
476 if( *pi_offset & 0x1 )
485 /* We shouldn't get any padding bytes */
488 msg_Err( p_dec, "padding bytes found in RLE sequence" );
489 msg_Err( p_dec, "send mail to <sam@zoy.org> if you "
490 "want to help debugging this" );
492 /* Skip them just in case */
493 while( i_y < i_height )
495 *p_dest++ = i_width << 2;
502 msg_Dbg( p_dec, "valid subtitle, size: %ix%i, position: %i,%i",
503 p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );
505 /* Crop if necessary */
506 if( i_skipped_top || i_skipped_bottom )
508 int i_y = p_spu->i_y + i_skipped_top;
509 int i_height = p_spu->i_height - (i_skipped_top + i_skipped_bottom);
511 p_spu_data->i_y_top_offset = i_skipped_top;
512 p_spu_data->i_y_bottom_offset = i_skipped_bottom;
513 msg_Dbg( p_dec, "cropped to: %ix%i, position: %i,%i",
514 p_spu->i_width, i_height, p_spu->i_x, i_y );
517 /* Handle color if no palette was found */
518 if( !p_spu_data->b_palette )
520 int i, i_inner = -1, i_shade = -1;
522 /* Set the border color */
523 p_spu_data->pi_yuv[i_border][0] = 0x00;
524 p_spu_data->pi_yuv[i_border][1] = 0x80;
525 p_spu_data->pi_yuv[i_border][2] = 0x80;
528 /* Find the inner colors */
529 for( i = 0 ; i < 4 && i_inner == -1 ; i++ )
537 for( ; i < 4 && i_shade == -1 ; i++ )
541 if( stats[i] > stats[i_inner] )
553 /* Set the inner color */
556 p_spu_data->pi_yuv[i_inner][0] = 0xff;
557 p_spu_data->pi_yuv[i_inner][1] = 0x80;
558 p_spu_data->pi_yuv[i_inner][2] = 0x80;
561 /* Set the anti-aliasing color */
564 p_spu_data->pi_yuv[i_shade][0] = 0x80;
565 p_spu_data->pi_yuv[i_shade][1] = 0x80;
566 p_spu_data->pi_yuv[i_shade][2] = 0x80;
569 msg_Dbg( p_dec, "using custom palette (border %i, inner %i, shade %i)",
570 i_border, i_inner, i_shade );
576 static void Render( decoder_t *p_dec, subpicture_t *p_spu,
577 subpicture_data_t *p_spu_data )
580 int i_x, i_y, i_len, i_color, i_pitch;
581 uint16_t *p_source = (uint16_t *)p_spu_data->p_data;
584 /* Create a new subpicture region */
585 memset( &fmt, 0, sizeof(video_format_t) );
586 fmt.i_chroma = VLC_FOURCC('Y','U','V','P');
587 fmt.i_aspect = VOUT_ASPECT_FACTOR;
588 fmt.i_width = fmt.i_visible_width = p_spu->i_width;
589 fmt.i_height = fmt.i_visible_height = p_spu->i_height -
590 p_spu_data->i_y_top_offset - p_spu_data->i_y_bottom_offset;
591 fmt.i_x_offset = fmt.i_y_offset = 0;
592 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
593 if( !p_spu->p_region )
595 msg_Err( p_dec, "cannot allocate SPU region" );
599 p_spu->p_region->i_x = 0;
600 p_spu->p_region->i_y = p_spu_data->i_y_top_offset;
601 p_p = p_spu->p_region->picture.p->p_pixels;
602 i_pitch = p_spu->p_region->picture.p->i_pitch;
605 fmt.p_palette->i_entries = 4;
606 for( i_x = 0; i_x < fmt.p_palette->i_entries; i_x++ )
608 fmt.p_palette->palette[i_x][0] = p_spu_data->pi_yuv[i_x][0];
609 fmt.p_palette->palette[i_x][1] = p_spu_data->pi_yuv[i_x][1];
610 fmt.p_palette->palette[i_x][2] = p_spu_data->pi_yuv[i_x][2];
611 fmt.p_palette->palette[i_x][3] =
612 p_spu_data->pi_alpha[i_x] == 0xf ? 0xff :
613 p_spu_data->pi_alpha[i_x] << 4;
616 /* Draw until we reach the bottom of the subtitle */
617 for( i_y = 0; i_y < (int)fmt.i_height * i_pitch; i_y += i_pitch )
619 /* Draw until we reach the end of the line */
620 for( i_x = 0 ; i_x < (int)fmt.i_width; i_x += i_len )
622 /* Get the RLE part, then draw the line */
623 i_color = *p_source & 0x3;
624 i_len = *p_source++ >> 2;
625 memset( p_p + i_x + i_y, i_color, i_len );