]> git.sesse.net Git - vlc/blob - modules/codec/spudec/parse.c
* ./modules/codec/spudec/parse.c: set the duration of DVD subtitles
[vlc] / modules / codec / spudec / parse.c
1 /*****************************************************************************
2  * parse.c: SPU parser
3  *****************************************************************************
4  * Copyright (C) 2000-2001 VideoLAN
5  * $Id: parse.c,v 1.8 2003/01/09 10:12:42 sam Exp $
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <string.h>                                    /* memcpy(), memset() */
29
30 #include <vlc/vlc.h>
31 #include <vlc/vout.h>
32 #include <vlc/decoder.h>
33
34 #include "spudec.h"
35
36 /*****************************************************************************
37  * Local prototypes.
38  *****************************************************************************/
39 static int  ParseControlSeq  ( spudec_thread_t *, subpicture_t * );
40 static int  ParseRLE         ( spudec_thread_t *, subpicture_t *, uint8_t * );
41
42 static void DestroySPU       ( subpicture_t * );
43
44 static void UpdateSPU        ( subpicture_t *, vlc_object_t * );
45 static int  CropCallback     ( vlc_object_t *, char const *,
46                                vlc_value_t, vlc_value_t, void * );
47
48 /*****************************************************************************
49  * AddNibble: read a nibble from a source packet and add it to our integer.
50  *****************************************************************************/
51 static inline unsigned int AddNibble( unsigned int i_code,
52                                       uint8_t *p_src, int *pi_index )
53 {
54     if( *pi_index & 0x1 )
55     {
56         return( i_code << 4 | ( p_src[(*pi_index)++ >> 1] & 0xf ) );
57     }
58     else
59     {
60         return( i_code << 4 | p_src[(*pi_index)++ >> 1] >> 4 );
61     }
62 }
63
64 /*****************************************************************************
65  * SyncPacket: get in sync with the stream
66  *****************************************************************************
67  * This function makes a few sanity checks and returns 0 if it looks like we
68  * are at the beginning of a subpicture packet.
69  *****************************************************************************/
70 int E_(SyncPacket)( spudec_thread_t *p_spudec )
71 {
72     /* Re-align the buffer on an 8-bit boundary */
73     RealignBits( &p_spudec->bit_stream );
74
75     /* The total SPU packet size, often bigger than a PS packet */
76     p_spudec->i_spu_size = GetBits( &p_spudec->bit_stream, 16 );
77
78     /* The RLE stuff size (remove 4 because we just read 32 bits) */
79     p_spudec->i_rle_size = ShowBits( &p_spudec->bit_stream, 16 ) - 4;
80
81     /* If the values we got are a bit strange, skip packet */
82     if( !p_spudec->i_spu_size
83          || ( p_spudec->i_rle_size >= p_spudec->i_spu_size ) )
84     {
85         return VLC_EGENERIC;
86     }
87
88     RemoveBits( &p_spudec->bit_stream, 16 );
89
90     return VLC_SUCCESS;
91 }
92
93 /*****************************************************************************
94  * ParsePacket: parse an SPU packet and send it to the video output
95  *****************************************************************************
96  * This function parses the SPU packet and, if valid, sends it to the
97  * video output.
98  *****************************************************************************/
99 void E_(ParsePacket)( spudec_thread_t *p_spudec )
100 {
101     subpicture_t * p_spu;
102     uint8_t      * p_src;
103     unsigned int   i_offset;
104     mtime_t        i_pts;
105
106     msg_Dbg( p_spudec->p_fifo, "trying to gather a 0x%.2x long subtitle",
107                                p_spudec->i_spu_size );
108
109     /* We cannot display a subpicture with no date */
110     NextPTS( &p_spudec->bit_stream, &i_pts, NULL );
111     if( i_pts == 0 )
112     {
113         msg_Warn( p_spudec->p_fifo, "subtitle without a date" );
114         return;
115     }
116
117     /* Allocate the subpicture internal data. */
118     p_spu = vout_CreateSubPicture( p_spudec->p_vout, MEMORY_SUBPICTURE );
119
120     if( p_spu == NULL )
121     {
122         return;
123     }
124
125     /* Rationale for the "p_spudec->i_rle_size * 4": we are going to
126      * expand the RLE stuff so that we won't need to read nibbles later
127      * on. This will speed things up a lot. Plus, we'll only need to do
128      * this stupid interlacing stuff once. */
129     p_spu->p_sys = malloc( sizeof( subpicture_sys_t )
130                             + p_spudec->i_rle_size * 4 );
131
132     if( p_spu->p_sys == NULL )
133     {
134         vout_DestroySubPicture( p_spudec->p_vout, p_spu );
135         return;
136     }
137
138     /* Fill the p_spu structure */
139     vlc_mutex_init( p_spudec->p_fifo, &p_spu->p_sys->lock );
140
141     p_spu->pf_render = E_(RenderSPU);
142     p_spu->pf_destroy = DestroySPU;
143     p_spu->p_sys->p_data = (uint8_t*)p_spu->p_sys + sizeof( subpicture_sys_t );
144     p_spu->p_sys->b_palette = VLC_FALSE;
145
146     p_spu->p_sys->pi_alpha[0] = 0x00;
147     p_spu->p_sys->pi_alpha[1] = 0x0f;
148     p_spu->p_sys->pi_alpha[2] = 0x0f;
149     p_spu->p_sys->pi_alpha[3] = 0x0f;
150
151     p_spu->p_sys->b_crop = VLC_FALSE;
152
153     /* Get display time now. If we do it later, we may miss the PTS. */
154     p_spu->p_sys->i_pts = i_pts;
155
156     /* Attach to our input thread */
157     p_spu->p_sys->p_input = vlc_object_find( p_spudec->p_fifo,
158                                              VLC_OBJECT_INPUT, FIND_PARENT );
159     if( p_spu->p_sys->p_input )
160     {
161         vlc_value_t val;
162
163         if( !var_Get( p_spu->p_sys->p_input, "highlight-mutex", &val ) )
164         {
165             vlc_mutex_t *p_mutex = val.p_address;
166
167             vlc_mutex_lock( p_mutex );
168             UpdateSPU( p_spu, VLC_OBJECT(p_spu->p_sys->p_input) );
169             var_AddCallback( p_spu->p_sys->p_input,
170                              "highlight", CropCallback, p_spu );
171             vlc_mutex_unlock( p_mutex );
172         }
173     }
174
175     /* Allocate the temporary buffer we will parse */
176     p_src = malloc( p_spudec->i_rle_size );
177
178     if( p_src == NULL )
179     {
180         msg_Err( p_spudec->p_fifo, "out of memory" );
181         vout_DestroySubPicture( p_spudec->p_vout, p_spu );
182         return;
183     }
184
185     /* Get RLE data */
186     for( i_offset = 0; i_offset < p_spudec->i_rle_size;
187          i_offset += SPU_CHUNK_SIZE )
188     {
189         GetChunk( &p_spudec->bit_stream, p_src + i_offset,
190                   ( i_offset + SPU_CHUNK_SIZE < p_spudec->i_rle_size ) ?
191                   SPU_CHUNK_SIZE : p_spudec->i_rle_size - i_offset );
192
193         /* Abort subtitle parsing if we were requested to stop */
194         if( p_spudec->p_fifo->b_die )
195         {
196             free( p_src );
197             vout_DestroySubPicture( p_spudec->p_vout, p_spu );
198             return;
199         }
200     }
201
202 #if 0
203     /* Dump the subtitle info */
204     intf_WarnHexDump( 5, p_spu->p_sys->p_data, p_spudec->i_rle_size );
205 #endif
206
207     /* Getting the control part */
208     if( ParseControlSeq( p_spudec, p_spu ) )
209     {
210         /* There was a parse error, delete the subpicture */
211         free( p_src );
212         vout_DestroySubPicture( p_spudec->p_vout, p_spu );
213         return;
214     }
215
216     /* At this point, no more GetBit() command is needed, so we have all
217      * the data we need to tell whether the subtitle is valid. Thus we
218      * try to display it and we ignore b_die. */
219
220     if( ParseRLE( p_spudec, p_spu, p_src ) )
221     {
222         /* There was a parse error, delete the subpicture */
223         free( p_src );
224         vout_DestroySubPicture( p_spudec->p_vout, p_spu );
225         return;
226     }
227
228     msg_Dbg( p_spudec->p_fifo, "total size: 0x%x, RLE offsets: 0x%x 0x%x",
229              p_spudec->i_spu_size,
230              p_spu->p_sys->pi_offset[0], p_spu->p_sys->pi_offset[1] );
231
232     /* SPU is finished - we can ask the video output to display it */
233     vout_DisplaySubPicture( p_spudec->p_vout, p_spu );
234
235     /* TODO: do stuff! */
236
237     /* Clean up */
238     free( p_src );
239 }
240
241 /*****************************************************************************
242  * ParseControlSeq: parse all SPU control sequences
243  *****************************************************************************
244  * This is the most important part in SPU decoding. We get dates, palette
245  * information, coordinates, and so on. For more information on the
246  * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
247  *****************************************************************************/
248 static int ParseControlSeq( spudec_thread_t *p_spudec,
249                                   subpicture_t * p_spu )
250 {
251     /* Our current index in the SPU packet */
252     unsigned int i_index = p_spudec->i_rle_size + 4;
253
254     /* The next start-of-control-sequence index and the previous one */
255     unsigned int i_next_seq = 0, i_cur_seq = 0;
256
257     /* Command and date */
258     uint8_t i_command = SPU_CMD_END;
259     mtime_t date = 0;
260
261     unsigned int i, pi_alpha[4];
262
263     /* Initialize the structure */
264     p_spu->i_start = p_spu->i_stop = 0;
265     p_spu->b_ephemer = VLC_FALSE;
266
267     do
268     {
269         /* If we just read a command sequence, read the next one;
270          * otherwise, go on with the commands of the current sequence. */
271         if( i_command == SPU_CMD_END )
272         {
273             /* Get the control sequence date */
274             date = GetBits( &p_spudec->bit_stream, 16 ) * 11000
275                     * p_spudec->bit_stream.p_pes->i_rate / DEFAULT_RATE;
276
277             /* Next offset */
278             i_cur_seq = i_index;
279             i_next_seq = GetBits( &p_spudec->bit_stream, 16 );
280
281             /* Skip what we just read */
282             i_index += 4;
283         }
284
285         i_command = GetBits( &p_spudec->bit_stream, 8 );
286         i_index++;
287
288         switch( i_command )
289         {
290         case SPU_CMD_FORCE_DISPLAY: /* 00 (force displaying) */
291             p_spu->i_start = p_spu->p_sys->i_pts + date;
292             p_spu->b_ephemer = VLC_TRUE;
293             break;
294
295         /* Convert the dates in seconds to PTS values */
296         case SPU_CMD_START_DISPLAY: /* 01 (start displaying) */
297             p_spu->i_start = p_spu->p_sys->i_pts + date;
298             break;
299
300         case SPU_CMD_STOP_DISPLAY: /* 02 (stop displaying) */
301             p_spu->i_stop = p_spu->p_sys->i_pts + date;
302             break;
303
304         case SPU_CMD_SET_PALETTE:
305
306             /* 03xxxx (palette) */
307             if( p_spudec->p_fifo->p_demux_data
308                  && *(int*)p_spudec->p_fifo->p_demux_data == 0xBeeF )
309             {
310                 uint32_t i_color;
311
312                 p_spu->p_sys->b_palette = VLC_TRUE;
313                 for( i = 0; i < 4 ; i++ )
314                 {
315                     i_color = ((uint32_t*)((char*)p_spudec->p_fifo->
316                                 p_demux_data + sizeof(int)))[
317                                   GetBits(&p_spudec->bit_stream, 4) ];
318
319                     /* FIXME: this job should be done sooner */
320                     p_spu->p_sys->pi_yuv[3-i][0] = (i_color>>16) & 0xff;
321                     p_spu->p_sys->pi_yuv[3-i][1] = (i_color>>0) & 0xff;
322                     p_spu->p_sys->pi_yuv[3-i][2] = (i_color>>8) & 0xff;
323                 }
324             }
325             else
326             {
327                 RemoveBits( &p_spudec->bit_stream, 16 );
328             }
329             i_index += 2;
330
331             break;
332
333         case SPU_CMD_SET_ALPHACHANNEL: /* 04xxxx (alpha channel) */
334             pi_alpha[3] = GetBits( &p_spudec->bit_stream, 4 );
335             pi_alpha[2] = GetBits( &p_spudec->bit_stream, 4 );
336             pi_alpha[1] = GetBits( &p_spudec->bit_stream, 4 );
337             pi_alpha[0] = GetBits( &p_spudec->bit_stream, 4 );
338
339             /* Ignore blank alpha palette. Sometimes spurious blank
340              * alpha palettes are present - dunno why. */
341             if( pi_alpha[0] | pi_alpha[1] | pi_alpha[2] | pi_alpha[3] )
342             {
343                 p_spu->p_sys->pi_alpha[0] = pi_alpha[0];
344                 p_spu->p_sys->pi_alpha[1] = pi_alpha[1];
345                 p_spu->p_sys->pi_alpha[2] = pi_alpha[2];
346                 p_spu->p_sys->pi_alpha[3] = pi_alpha[3];
347             }
348             else
349             {
350                 msg_Warn( p_spudec->p_fifo, "ignoring blank alpha palette" );
351             }
352
353             i_index += 2;
354             break;
355
356         case SPU_CMD_SET_COORDINATES: /* 05xxxyyyxxxyyy (coordinates) */
357             p_spu->i_x = GetBits( &p_spudec->bit_stream, 12 );
358             p_spu->i_width = GetBits( &p_spudec->bit_stream, 12 )
359                               - p_spu->i_x + 1;
360
361             p_spu->i_y = GetBits( &p_spudec->bit_stream, 12 );
362             p_spu->i_height = GetBits( &p_spudec->bit_stream, 12 )
363                                - p_spu->i_y + 1;
364
365             i_index += 6;
366             break;
367
368         case SPU_CMD_SET_OFFSETS: /* 06xxxxyyyy (byte offsets) */
369             p_spu->p_sys->pi_offset[0] =
370                 GetBits( &p_spudec->bit_stream, 16 ) - 4;
371
372             p_spu->p_sys->pi_offset[1] =
373                 GetBits( &p_spudec->bit_stream, 16 ) - 4;
374
375             i_index += 4;
376             break;
377
378         case SPU_CMD_END: /* ff (end) */
379             break;
380
381         default: /* xx (unknown command) */
382             msg_Err( p_spudec->p_fifo, "unknown command 0x%.2x",
383                                        i_command );
384             return VLC_EGENERIC;
385         }
386
387         /* We need to check for quit commands here */
388         if( p_spudec->p_fifo->b_die )
389         {
390             return VLC_EGENERIC;
391         }
392
393     } while( i_command != SPU_CMD_END || i_index == i_next_seq );
394
395     /* Check that the next sequence index matches the current one */
396     if( i_next_seq != i_cur_seq )
397     {
398         msg_Err( p_spudec->p_fifo, "index mismatch (0x%.4x != 0x%.4x)",
399                                    i_next_seq, i_cur_seq );
400         return VLC_EGENERIC;
401     }
402
403     if( i_index > p_spudec->i_spu_size )
404     {
405         msg_Err( p_spudec->p_fifo, "uh-oh, we went too far (0x%.4x > 0x%.4x)",
406                                    i_index, p_spudec->i_spu_size );
407         return VLC_EGENERIC;
408     }
409
410     if( !p_spu->i_start )
411     {
412         msg_Err( p_spudec->p_fifo, "no `start display' command" );
413     }
414
415     if( p_spu->i_stop <= p_spu->i_start && !p_spu->b_ephemer )
416     {
417         /* This subtitle will live for 5 seconds or until the next subtitle */
418         p_spu->i_stop = p_spu->i_start + 500 * 11000
419                          * p_spudec->bit_stream.p_pes->i_rate / DEFAULT_RATE;;
420         p_spu->b_ephemer = VLC_TRUE;
421     }
422
423     /* Get rid of padding bytes */
424     switch( p_spudec->i_spu_size - i_index )
425     {
426         /* Zero or one padding byte, quite usual */
427         case 1:
428             RemoveBits( &p_spudec->bit_stream, 8 );
429             i_index++;
430         case 0:
431             break;
432
433         /* More than one padding byte - this is very strange, but
434          * we can deal with it */
435         default:
436             msg_Warn( p_spudec->p_fifo,
437                       "%i padding bytes, we usually get 0 or 1 of them",
438                       p_spudec->i_spu_size - i_index );
439
440             while( i_index < p_spudec->i_spu_size )
441             {
442                 RemoveBits( &p_spudec->bit_stream, 8 );
443                 i_index++;
444             }
445
446             break;
447     }
448
449     /* Successfully parsed ! */
450     return VLC_SUCCESS;
451 }
452
453 /*****************************************************************************
454  * ParseRLE: parse the RLE part of the subtitle
455  *****************************************************************************
456  * This part parses the subtitle graphical data and stores it in a more
457  * convenient structure for later decoding. For more information on the
458  * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
459  *****************************************************************************/
460 static int ParseRLE( spudec_thread_t *p_spudec,
461                      subpicture_t * p_spu, uint8_t * p_src )
462 {
463     unsigned int i_code;
464
465     unsigned int i_width = p_spu->i_width;
466     unsigned int i_height = p_spu->i_height;
467     unsigned int i_x, i_y;
468
469     uint16_t *p_dest = (uint16_t *)p_spu->p_sys->p_data;
470
471     /* The subtitles are interlaced, we need two offsets */
472     unsigned int  i_id = 0;                   /* Start on the even SPU layer */
473     unsigned int  pi_table[ 2 ];
474     unsigned int *pi_offset;
475
476 #if 0 /* cropping */
477     vlc_bool_t b_empty_top = VLC_TRUE,
478                b_empty_bottom = VLC_FALSE;
479     unsigned int i_skipped_top = 0,
480                  i_skipped_bottom = 0;
481 #endif
482
483     /* Colormap statistics */
484     int i_border = -1;
485     int stats[4]; stats[0] = stats[1] = stats[2] = stats[3] = 0;
486
487     pi_table[ 0 ] = p_spu->p_sys->pi_offset[ 0 ] << 1;
488     pi_table[ 1 ] = p_spu->p_sys->pi_offset[ 1 ] << 1;
489
490     for( i_y = 0 ; i_y < i_height ; i_y++ )
491     {
492         pi_offset = pi_table + i_id;
493
494         for( i_x = 0 ; i_x < i_width ; i_x += i_code >> 2 )
495         {
496             i_code = AddNibble( 0, p_src, pi_offset );
497
498             if( i_code < 0x04 )
499             {
500                 i_code = AddNibble( i_code, p_src, pi_offset );
501
502                 if( i_code < 0x10 )
503                 {
504                     i_code = AddNibble( i_code, p_src, pi_offset );
505
506                     if( i_code < 0x040 )
507                     {
508                         i_code = AddNibble( i_code, p_src, pi_offset );
509
510                         if( i_code < 0x0100 )
511                         {
512                             /* If the 14 first bits are set to 0, then it's a
513                              * new line. We emulate it. */
514                             if( i_code < 0x0004 )
515                             {
516                                 i_code |= ( i_width - i_x ) << 2;
517                             }
518                             else
519                             {
520                                 /* We have a boo boo ! */
521                                 msg_Err( p_spudec->p_fifo, "unknown RLE code "
522                                          "0x%.4x", i_code );
523                                 return VLC_EGENERIC;
524                             }
525                         }
526                     }
527                 }
528             }
529
530             if( ( (i_code >> 2) + i_x + i_y * i_width ) > i_height * i_width )
531             {
532                 msg_Err( p_spudec->p_fifo,
533                          "out of bounds, %i at (%i,%i) is out of %ix%i",
534                          i_code >> 2, i_x, i_y, i_width, i_height );
535                 return VLC_EGENERIC;
536             }
537
538             /* Try to find the border color */
539             if( p_spu->p_sys->pi_alpha[ i_code & 0x3 ] != 0x00 )
540             {
541                 i_border = i_code & 0x3;
542                 stats[i_border] += i_code >> 2;
543             }
544
545 #if 0 /* cropping */
546             if( (i_code >> 2) == i_width
547                  && p_spu->p_sys->pi_alpha[ i_code & 0x3 ] == 0x00 )
548             {
549                 if( b_empty_top )
550                 {
551                     /* This is a blank top line, we skip it */
552                     i_skipped_top++;
553                 }
554                 else
555                 {
556                     /* We can't be sure the current lines will be skipped,
557                      * so we store the code just in case. */
558                     *p_dest++ = i_code;
559
560                     b_empty_bottom = VLC_TRUE;
561                     i_skipped_bottom++;
562                 }
563             }
564             else
565             {
566                 /* We got a valid code, store it */
567                 *p_dest++ = i_code;
568
569                 /* Valid code means no blank line */
570                 b_empty_top = VLC_FALSE;
571                 b_empty_bottom = VLC_FALSE;
572                 i_skipped_bottom = 0;
573             }
574 #else
575             *p_dest++ = i_code;
576 #endif
577         }
578
579         /* Check that we didn't go too far */
580         if( i_x > i_width )
581         {
582             msg_Err( p_spudec->p_fifo, "i_x overflowed, %i > %i",
583                                        i_x, i_width );
584             return VLC_EGENERIC;
585         }
586
587         /* Byte-align the stream */
588         if( *pi_offset & 0x1 )
589         {
590             (*pi_offset)++;
591         }
592
593         /* Swap fields */
594         i_id = ~i_id & 0x1;
595     }
596
597     /* We shouldn't get any padding bytes */
598     if( i_y < i_height )
599     {
600         msg_Err( p_spudec->p_fifo, "padding bytes found in RLE sequence" );
601         msg_Err( p_spudec->p_fifo, "send mail to <sam@zoy.org> if you "
602                                    "want to help debugging this" );
603
604         /* Skip them just in case */
605         while( i_y < i_height )
606         {
607             *p_dest++ = i_width << 2;
608             i_y++;
609         }
610
611         return VLC_EGENERIC;
612     }
613
614     msg_Dbg( p_spudec->p_fifo, "valid subtitle, size: %ix%i, position: %i,%i",
615              p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );
616
617 #if 0 /* cropping */
618     /* Crop if necessary */
619     if( i_skipped_top || i_skipped_bottom )
620     {
621         p_spu->i_y += i_skipped_top;
622         p_spu->i_height -= i_skipped_top + i_skipped_bottom;
623
624         msg_Dbg( p_spudec->p_fifo, "cropped to: %ix%i, position: %i,%i",
625                  p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );
626     }
627 #endif
628
629     /* Handle color if no palette was found */
630     if( !p_spu->p_sys->b_palette )
631     {
632         int i, i_inner = -1, i_shade = -1;
633
634         /* Set the border color */
635         p_spu->p_sys->pi_yuv[i_border][0] = 0x00;
636         p_spu->p_sys->pi_yuv[i_border][1] = 0x80;
637         p_spu->p_sys->pi_yuv[i_border][2] = 0x80;
638         stats[i_border] = 0;
639
640         /* Find the inner colors */
641         for( i = 0 ; i < 4 && i_inner == -1 ; i++ )
642         {
643             if( stats[i] )
644             {
645                 i_inner = i;
646             }
647         }
648
649         for(       ; i < 4 && i_shade == -1 ; i++ )
650         {
651             if( stats[i] )
652             {
653                 if( stats[i] > stats[i_inner] )
654                 {
655                     i_shade = i_inner;
656                     i_inner = i;
657                 }
658                 else
659                 {
660                     i_shade = i;
661                 }
662             }
663         }
664
665         /* Set the inner color */
666         if( i_inner != -1 )
667         {
668             p_spu->p_sys->pi_yuv[i_inner][0] = 0xff;
669             p_spu->p_sys->pi_yuv[i_inner][1] = 0x80;
670             p_spu->p_sys->pi_yuv[i_inner][2] = 0x80;
671         }
672
673         /* Set the anti-aliasing color */
674         if( i_shade != -1 )
675         {
676             p_spu->p_sys->pi_yuv[i_shade][0] = 0x80;
677             p_spu->p_sys->pi_yuv[i_shade][1] = 0x80;
678             p_spu->p_sys->pi_yuv[i_shade][2] = 0x80;
679         }
680
681         msg_Dbg( p_spudec->p_fifo,
682                  "using custom palette (border %i, inner %i, shade %i)",
683                  i_border, i_inner, i_shade );
684     }
685
686     return VLC_SUCCESS;
687 }
688
689 /*****************************************************************************
690  * DestroySPU: subpicture destructor
691  *****************************************************************************/
692 static void DestroySPU( subpicture_t *p_spu )
693 {
694     if( p_spu->p_sys->p_input )
695     {
696         /* Detach from our input thread */
697         var_DelCallback( p_spu->p_sys->p_input, "highlight",
698                          CropCallback, p_spu );
699         vlc_object_release( p_spu->p_sys->p_input );
700     }
701
702     vlc_mutex_destroy( &p_spu->p_sys->lock );
703     free( p_spu->p_sys );
704 }
705
706 /*****************************************************************************
707  * UpdateSPU: update subpicture settings
708  *****************************************************************************
709  * This function is called from CropCallback and at initialization time, to
710  * retrieve crop information from the input.
711  *****************************************************************************/
712 static void UpdateSPU( subpicture_t *p_spu, vlc_object_t *p_object )
713 {
714     vlc_value_t val;
715
716     if( var_Get( p_object, "highlight", &val ) )
717     {
718         return;
719     }
720
721     p_spu->p_sys->b_crop = val.b_bool;
722     if( !p_spu->p_sys->b_crop )
723     {
724         return;
725     }
726
727     var_Get( p_object, "x-start", &val );
728     p_spu->p_sys->i_x_start = val.i_int;
729     var_Get( p_object, "y-start", &val );
730     p_spu->p_sys->i_y_start = val.i_int;
731     var_Get( p_object, "x-end", &val );
732     p_spu->p_sys->i_x_end = val.i_int;
733     var_Get( p_object, "y-end", &val );
734     p_spu->p_sys->i_y_end = val.i_int;
735
736 #if 0
737     if( var_Get( p_object, "color", &val ) == VLC_SUCCESS )
738     {
739         p_spu->p_sys->pi_color[0] = ((uint8_t *)val.p_address)[0];
740         p_spu->p_sys->pi_color[1] = ((uint8_t *)val.p_address)[1];
741         p_spu->p_sys->pi_color[2] = ((uint8_t *)val.p_address)[2];
742         p_spu->p_sys->pi_color[3] = ((uint8_t *)val.p_address)[3];
743     }
744 #endif
745
746     if( var_Get( p_object, "contrast", &val ) == VLC_SUCCESS )
747     {
748         p_spu->p_sys->pi_alpha[0] = ((uint8_t *)val.p_address)[0];
749         p_spu->p_sys->pi_alpha[1] = ((uint8_t *)val.p_address)[1];
750         p_spu->p_sys->pi_alpha[2] = ((uint8_t *)val.p_address)[2];
751         p_spu->p_sys->pi_alpha[3] = ((uint8_t *)val.p_address)[3];
752     }
753 }
754
755 /*****************************************************************************
756  * CropCallback: called when the highlight properties are changed
757  *****************************************************************************
758  * This callback is called from the input thread when we need cropping
759  *****************************************************************************/
760 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
761                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
762 {
763     UpdateSPU( (subpicture_t *)p_data, p_object );
764
765     return VLC_SUCCESS;
766 }
767