git.sesse.net Git - vlc/blob - modules/codec/spudec/parse.c

   1 /*****************************************************************************
   2  * parse.c: SPU parser
   3  *****************************************************************************
   4  * Copyright (C) 2000-2001 VideoLAN
   5  * $Id: parse.c,v 1.10 2003/01/30 19:14:17 gbazin 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_DelCallback( p_spu->p_sys->p_input,
 170                              "highlight", CropCallback, p_spu );
 171             var_AddCallback( p_spu->p_sys->p_input,
 172                              "highlight", CropCallback, p_spu );
 173             vlc_mutex_unlock( p_mutex );
 174         }
 175     }
 176
 177     /* Allocate the temporary buffer we will parse */
 178     p_src = malloc( p_spudec->i_rle_size );
 179
 180     if( p_src == NULL )
 181     {
 182         msg_Err( p_spudec->p_fifo, "out of memory" );
 183         vout_DestroySubPicture( p_spudec->p_vout, p_spu );
 184         return;
 185     }
 186
 187     /* Get RLE data */
 188     for( i_offset = 0; i_offset < p_spudec->i_rle_size;
 189          i_offset += SPU_CHUNK_SIZE )
 190     {
 191         GetChunk( &p_spudec->bit_stream, p_src + i_offset,
 192                   ( i_offset + SPU_CHUNK_SIZE < p_spudec->i_rle_size ) ?
 193                   SPU_CHUNK_SIZE : p_spudec->i_rle_size - i_offset );
 194
 195         /* Abort subtitle parsing if we were requested to stop */
 196         if( p_spudec->p_fifo->b_die )
 197         {
 198             free( p_src );
 199             vout_DestroySubPicture( p_spudec->p_vout, p_spu );
 200             return;
 201         }
 202     }
 203
 204 #if 0
 205     /* Dump the subtitle info */
 206     intf_WarnHexDump( 5, p_spu->p_sys->p_data, p_spudec->i_rle_size );
 207 #endif
 208
 209     /* Getting the control part */
 210     if( ParseControlSeq( p_spudec, p_spu ) )
 211     {
 212         /* There was a parse error, delete the subpicture */
 213         free( p_src );
 214         vout_DestroySubPicture( p_spudec->p_vout, p_spu );
 215         return;
 216     }
 217
 218     /* At this point, no more GetBit() command is needed, so we have all
 219      * the data we need to tell whether the subtitle is valid. Thus we
 220      * try to display it and we ignore b_die. */
 221
 222     if( ParseRLE( p_spudec, p_spu, p_src ) )
 223     {
 224         /* There was a parse error, delete the subpicture */
 225         free( p_src );
 226         vout_DestroySubPicture( p_spudec->p_vout, p_spu );
 227         return;
 228     }
 229
 230     msg_Dbg( p_spudec->p_fifo, "total size: 0x%x, RLE offsets: 0x%x 0x%x",
 231              p_spudec->i_spu_size,
 232              p_spu->p_sys->pi_offset[0], p_spu->p_sys->pi_offset[1] );
 233
 234     /* SPU is finished - we can ask the video output to display it */
 235     vout_DisplaySubPicture( p_spudec->p_vout, p_spu );
 236
 237     /* TODO: do stuff! */
 238
 239     /* Clean up */
 240     free( p_src );
 241 }
 242
 243 /*****************************************************************************
 244  * ParseControlSeq: parse all SPU control sequences
 245  *****************************************************************************
 246  * This is the most important part in SPU decoding. We get dates, palette
 247  * information, coordinates, and so on. For more information on the
 248  * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
 249  *****************************************************************************/
 250 static int ParseControlSeq( spudec_thread_t *p_spudec,
 251                                   subpicture_t * p_spu )
 252 {
 253     /* Our current index in the SPU packet */
 254     unsigned int i_index = p_spudec->i_rle_size + 4;
 255
 256     /* The next start-of-control-sequence index and the previous one */
 257     unsigned int i_next_seq = 0, i_cur_seq = 0;
 258
 259     /* Command and date */
 260     uint8_t i_command = SPU_CMD_END;
 261     mtime_t date = 0;
 262
 263     unsigned int i, pi_alpha[4];
 264
 265     /* Initialize the structure */
 266     p_spu->i_start = p_spu->i_stop = 0;
 267     p_spu->b_ephemer = VLC_FALSE;
 268
 269     do
 270     {
 271         /* If we just read a command sequence, read the next one;
 272          * otherwise, go on with the commands of the current sequence. */
 273         if( i_command == SPU_CMD_END )
 274         {
 275             /* Get the control sequence date */
 276             date = (mtime_t)GetBits( &p_spudec->bit_stream, 16 ) * 11000
 277                     * p_spudec->bit_stream.p_pes->i_rate / DEFAULT_RATE;
 278
 279             /* Next offset */
 280             i_cur_seq = i_index;
 281             i_next_seq = GetBits( &p_spudec->bit_stream, 16 );
 282
 283             /* Skip what we just read */
 284             i_index += 4;
 285         }
 286
 287         i_command = GetBits( &p_spudec->bit_stream, 8 );
 288         i_index++;
 289
 290         switch( i_command )
 291         {
 292         case SPU_CMD_FORCE_DISPLAY: /* 00 (force displaying) */
 293             p_spu->i_start = p_spu->p_sys->i_pts + date;
 294             p_spu->b_ephemer = VLC_TRUE;
 295             break;
 296
 297         /* Convert the dates in seconds to PTS values */
 298         case SPU_CMD_START_DISPLAY: /* 01 (start displaying) */
 299             p_spu->i_start = p_spu->p_sys->i_pts + date;
 300             break;
 301
 302         case SPU_CMD_STOP_DISPLAY: /* 02 (stop displaying) */
 303             p_spu->i_stop = p_spu->p_sys->i_pts + date;
 304             break;
 305
 306         case SPU_CMD_SET_PALETTE:
 307
 308             /* 03xxxx (palette) */
 309             if( p_spudec->p_fifo->p_demux_data
 310                  && *(int*)p_spudec->p_fifo->p_demux_data == 0xBeeF )
 311             {
 312                 uint32_t i_color;
 313
 314                 p_spu->p_sys->b_palette = VLC_TRUE;
 315                 for( i = 0; i < 4 ; i++ )
 316                 {
 317                     i_color = ((uint32_t*)((char*)p_spudec->p_fifo->
 318                                 p_demux_data + sizeof(int)))[
 319                                   GetBits(&p_spudec->bit_stream, 4) ];
 320
 321                     /* FIXME: this job should be done sooner */
 322                     p_spu->p_sys->pi_yuv[3-i][0] = (i_color>>16) & 0xff;
 323                     p_spu->p_sys->pi_yuv[3-i][1] = (i_color>>0) & 0xff;
 324                     p_spu->p_sys->pi_yuv[3-i][2] = (i_color>>8) & 0xff;
 325                 }
 326             }
 327             else
 328             {
 329                 RemoveBits( &p_spudec->bit_stream, 16 );
 330             }
 331             i_index += 2;
 332
 333             break;
 334
 335         case SPU_CMD_SET_ALPHACHANNEL: /* 04xxxx (alpha channel) */
 336             pi_alpha[3] = GetBits( &p_spudec->bit_stream, 4 );
 337             pi_alpha[2] = GetBits( &p_spudec->bit_stream, 4 );
 338             pi_alpha[1] = GetBits( &p_spudec->bit_stream, 4 );
 339             pi_alpha[0] = GetBits( &p_spudec->bit_stream, 4 );
 340
 341             /* Ignore blank alpha palette. Sometimes spurious blank
 342              * alpha palettes are present - dunno why. */
 343             if( pi_alpha[0] | pi_alpha[1] | pi_alpha[2] | pi_alpha[3] )
 344             {
 345                 p_spu->p_sys->pi_alpha[0] = pi_alpha[0];
 346                 p_spu->p_sys->pi_alpha[1] = pi_alpha[1];
 347                 p_spu->p_sys->pi_alpha[2] = pi_alpha[2];
 348                 p_spu->p_sys->pi_alpha[3] = pi_alpha[3];
 349             }
 350             else
 351             {
 352                 msg_Warn( p_spudec->p_fifo, "ignoring blank alpha palette" );
 353             }
 354
 355             i_index += 2;
 356             break;
 357
 358         case SPU_CMD_SET_COORDINATES: /* 05xxxyyyxxxyyy (coordinates) */
 359             p_spu->i_x = GetBits( &p_spudec->bit_stream, 12 );
 360             p_spu->i_width = GetBits( &p_spudec->bit_stream, 12 )
 361                               - p_spu->i_x + 1;
 362
 363             p_spu->i_y = GetBits( &p_spudec->bit_stream, 12 );
 364             p_spu->i_height = GetBits( &p_spudec->bit_stream, 12 )
 365                                - p_spu->i_y + 1;
 366
 367             i_index += 6;
 368             break;
 369
 370         case SPU_CMD_SET_OFFSETS: /* 06xxxxyyyy (byte offsets) */
 371             p_spu->p_sys->pi_offset[0] =
 372                 GetBits( &p_spudec->bit_stream, 16 ) - 4;
 373
 374             p_spu->p_sys->pi_offset[1] =
 375                 GetBits( &p_spudec->bit_stream, 16 ) - 4;
 376
 377             i_index += 4;
 378             break;
 379
 380         case SPU_CMD_END: /* ff (end) */
 381             break;
 382
 383         default: /* xx (unknown command) */
 384             msg_Err( p_spudec->p_fifo, "unknown command 0x%.2x",
 385                                        i_command );
 386             return VLC_EGENERIC;
 387         }
 388
 389         /* We need to check for quit commands here */
 390         if( p_spudec->p_fifo->b_die )
 391         {
 392             return VLC_EGENERIC;
 393         }
 394
 395     } while( i_command != SPU_CMD_END || i_index == i_next_seq );
 396
 397     /* Check that the next sequence index matches the current one */
 398     if( i_next_seq != i_cur_seq )
 399     {
 400         msg_Err( p_spudec->p_fifo, "index mismatch (0x%.4x != 0x%.4x)",
 401                                    i_next_seq, i_cur_seq );
 402         return VLC_EGENERIC;
 403     }
 404
 405     if( i_index > p_spudec->i_spu_size )
 406     {
 407         msg_Err( p_spudec->p_fifo, "uh-oh, we went too far (0x%.4x > 0x%.4x)",
 408                                    i_index, p_spudec->i_spu_size );
 409         return VLC_EGENERIC;
 410     }
 411
 412     if( !p_spu->i_start )
 413     {
 414         msg_Err( p_spudec->p_fifo, "no `start display' command" );
 415     }
 416
 417     if( p_spu->i_stop <= p_spu->i_start && !p_spu->b_ephemer )
 418     {
 419         /* This subtitle will live for 5 seconds or until the next subtitle */
 420         p_spu->i_stop = p_spu->i_start + (mtime_t)500 * 11000
 421                          * p_spudec->bit_stream.p_pes->i_rate / DEFAULT_RATE;
 422         p_spu->b_ephemer = VLC_TRUE;
 423     }
 424
 425     /* Get rid of padding bytes */
 426     switch( p_spudec->i_spu_size - i_index )
 427     {
 428         /* Zero or one padding byte, quite usual */
 429         case 1:
 430             RemoveBits( &p_spudec->bit_stream, 8 );
 431             i_index++;
 432         case 0:
 433             break;
 434
 435         /* More than one padding byte - this is very strange, but
 436          * we can deal with it */
 437         default:
 438             msg_Warn( p_spudec->p_fifo,
 439                       "%i padding bytes, we usually get 0 or 1 of them",
 440                       p_spudec->i_spu_size - i_index );
 441
 442             while( i_index < p_spudec->i_spu_size )
 443             {
 444                 RemoveBits( &p_spudec->bit_stream, 8 );
 445                 i_index++;
 446             }
 447
 448             break;
 449     }
 450
 451     /* Successfully parsed ! */
 452     return VLC_SUCCESS;
 453 }
 454
 455 /*****************************************************************************
 456  * ParseRLE: parse the RLE part of the subtitle
 457  *****************************************************************************
 458  * This part parses the subtitle graphical data and stores it in a more
 459  * convenient structure for later decoding. For more information on the
 460  * subtitles format, see http://sam.zoy.org/doc/dvd/subtitles/index.html
 461  *****************************************************************************/
 462 static int ParseRLE( spudec_thread_t *p_spudec,
 463                      subpicture_t * p_spu, uint8_t * p_src )
 464 {
 465     unsigned int i_code;
 466
 467     unsigned int i_width = p_spu->i_width;
 468     unsigned int i_height = p_spu->i_height;
 469     unsigned int i_x, i_y;
 470
 471     uint16_t *p_dest = (uint16_t *)p_spu->p_sys->p_data;
 472
 473     /* The subtitles are interlaced, we need two offsets */
 474     unsigned int  i_id = 0;                   /* Start on the even SPU layer */
 475     unsigned int  pi_table[ 2 ];
 476     unsigned int *pi_offset;
 477
 478 #if 0 /* cropping */
 479     vlc_bool_t b_empty_top = VLC_TRUE,
 480                b_empty_bottom = VLC_FALSE;
 481     unsigned int i_skipped_top = 0,
 482                  i_skipped_bottom = 0;
 483 #endif
 484
 485     /* Colormap statistics */
 486     int i_border = -1;
 487     int stats[4]; stats[0] = stats[1] = stats[2] = stats[3] = 0;
 488
 489     pi_table[ 0 ] = p_spu->p_sys->pi_offset[ 0 ] << 1;
 490     pi_table[ 1 ] = p_spu->p_sys->pi_offset[ 1 ] << 1;
 491
 492     for( i_y = 0 ; i_y < i_height ; i_y++ )
 493     {
 494         pi_offset = pi_table + i_id;
 495
 496         for( i_x = 0 ; i_x < i_width ; i_x += i_code >> 2 )
 497         {
 498             i_code = AddNibble( 0, p_src, pi_offset );
 499
 500             if( i_code < 0x04 )
 501             {
 502                 i_code = AddNibble( i_code, p_src, pi_offset );
 503
 504                 if( i_code < 0x10 )
 505                 {
 506                     i_code = AddNibble( i_code, p_src, pi_offset );
 507
 508                     if( i_code < 0x040 )
 509                     {
 510                         i_code = AddNibble( i_code, p_src, pi_offset );
 511
 512                         if( i_code < 0x0100 )
 513                         {
 514                             /* If the 14 first bits are set to 0, then it's a
 515                              * new line. We emulate it. */
 516                             if( i_code < 0x0004 )
 517                             {
 518                                 i_code |= ( i_width - i_x ) << 2;
 519                             }
 520                             else
 521                             {
 522                                 /* We have a boo boo ! */
 523                                 msg_Err( p_spudec->p_fifo, "unknown RLE code "
 524                                          "0x%.4x", i_code );
 525                                 return VLC_EGENERIC;
 526                             }
 527                         }
 528                     }
 529                 }
 530             }
 531
 532             if( ( (i_code >> 2) + i_x + i_y * i_width ) > i_height * i_width )
 533             {
 534                 msg_Err( p_spudec->p_fifo,
 535                          "out of bounds, %i at (%i,%i) is out of %ix%i",
 536                          i_code >> 2, i_x, i_y, i_width, i_height );
 537                 return VLC_EGENERIC;
 538             }
 539
 540             /* Try to find the border color */
 541             if( p_spu->p_sys->pi_alpha[ i_code & 0x3 ] != 0x00 )
 542             {
 543                 i_border = i_code & 0x3;
 544                 stats[i_border] += i_code >> 2;
 545             }
 546
 547 #if 0 /* cropping */
 548             if( (i_code >> 2) == i_width
 549                  && p_spu->p_sys->pi_alpha[ i_code & 0x3 ] == 0x00 )
 550             {
 551                 if( b_empty_top )
 552                 {
 553                     /* This is a blank top line, we skip it */
 554                     i_skipped_top++;
 555                 }
 556                 else
 557                 {
 558                     /* We can't be sure the current lines will be skipped,
 559                      * so we store the code just in case. */
 560                     *p_dest++ = i_code;
 561
 562                     b_empty_bottom = VLC_TRUE;
 563                     i_skipped_bottom++;
 564                 }
 565             }
 566             else
 567             {
 568                 /* We got a valid code, store it */
 569                 *p_dest++ = i_code;
 570
 571                 /* Valid code means no blank line */
 572                 b_empty_top = VLC_FALSE;
 573                 b_empty_bottom = VLC_FALSE;
 574                 i_skipped_bottom = 0;
 575             }
 576 #else
 577             *p_dest++ = i_code;
 578 #endif
 579         }
 580
 581         /* Check that we didn't go too far */
 582         if( i_x > i_width )
 583         {
 584             msg_Err( p_spudec->p_fifo, "i_x overflowed, %i > %i",
 585                                        i_x, i_width );
 586             return VLC_EGENERIC;
 587         }
 588
 589         /* Byte-align the stream */
 590         if( *pi_offset & 0x1 )
 591         {
 592             (*pi_offset)++;
 593         }
 594
 595         /* Swap fields */
 596         i_id = ~i_id & 0x1;
 597     }
 598
 599     /* We shouldn't get any padding bytes */
 600     if( i_y < i_height )
 601     {
 602         msg_Err( p_spudec->p_fifo, "padding bytes found in RLE sequence" );
 603         msg_Err( p_spudec->p_fifo, "send mail to <sam@zoy.org> if you "
 604                                    "want to help debugging this" );
 605
 606         /* Skip them just in case */
 607         while( i_y < i_height )
 608         {
 609             *p_dest++ = i_width << 2;
 610             i_y++;
 611         }
 612
 613         return VLC_EGENERIC;
 614     }
 615
 616     msg_Dbg( p_spudec->p_fifo, "valid subtitle, size: %ix%i, position: %i,%i",
 617              p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );
 618
 619 #if 0 /* cropping */
 620     /* Crop if necessary */
 621     if( i_skipped_top || i_skipped_bottom )
 622     {
 623         p_spu->i_y += i_skipped_top;
 624         p_spu->i_height -= i_skipped_top + i_skipped_bottom;
 625
 626         msg_Dbg( p_spudec->p_fifo, "cropped to: %ix%i, position: %i,%i",
 627                  p_spu->i_width, p_spu->i_height, p_spu->i_x, p_spu->i_y );
 628     }
 629 #endif
 630
 631     /* Handle color if no palette was found */
 632     if( !p_spu->p_sys->b_palette )
 633     {
 634         int i, i_inner = -1, i_shade = -1;
 635
 636         /* Set the border color */
 637         p_spu->p_sys->pi_yuv[i_border][0] = 0x00;
 638         p_spu->p_sys->pi_yuv[i_border][1] = 0x80;
 639         p_spu->p_sys->pi_yuv[i_border][2] = 0x80;
 640         stats[i_border] = 0;
 641
 642         /* Find the inner colors */
 643         for( i = 0 ; i < 4 && i_inner == -1 ; i++ )
 644         {
 645             if( stats[i] )
 646             {
 647                 i_inner = i;
 648             }
 649         }
 650
 651         for(       ; i < 4 && i_shade == -1 ; i++ )
 652         {
 653             if( stats[i] )
 654             {
 655                 if( stats[i] > stats[i_inner] )
 656                 {
 657                     i_shade = i_inner;
 658                     i_inner = i;
 659                 }
 660                 else
 661                 {
 662                     i_shade = i;
 663                 }
 664             }
 665         }
 666
 667         /* Set the inner color */
 668         if( i_inner != -1 )
 669         {
 670             p_spu->p_sys->pi_yuv[i_inner][0] = 0xff;
 671             p_spu->p_sys->pi_yuv[i_inner][1] = 0x80;
 672             p_spu->p_sys->pi_yuv[i_inner][2] = 0x80;
 673         }
 674
 675         /* Set the anti-aliasing color */
 676         if( i_shade != -1 )
 677         {
 678             p_spu->p_sys->pi_yuv[i_shade][0] = 0x80;
 679             p_spu->p_sys->pi_yuv[i_shade][1] = 0x80;
 680             p_spu->p_sys->pi_yuv[i_shade][2] = 0x80;
 681         }
 682
 683         msg_Dbg( p_spudec->p_fifo,
 684                  "using custom palette (border %i, inner %i, shade %i)",
 685                  i_border, i_inner, i_shade );
 686     }
 687
 688     return VLC_SUCCESS;
 689 }
 690
 691 /*****************************************************************************
 692  * DestroySPU: subpicture destructor
 693  *****************************************************************************/
 694 static void DestroySPU( subpicture_t *p_spu )
 695 {
 696     if( p_spu->p_sys->p_input )
 697     {
 698         /* Detach from our input thread */
 699         var_DelCallback( p_spu->p_sys->p_input, "highlight",
 700                          CropCallback, p_spu );
 701         vlc_object_release( p_spu->p_sys->p_input );
 702     }
 703
 704     vlc_mutex_destroy( &p_spu->p_sys->lock );
 705     free( p_spu->p_sys );
 706 }
 707
 708 /*****************************************************************************
 709  * UpdateSPU: update subpicture settings
 710  *****************************************************************************
 711  * This function is called from CropCallback and at initialization time, to
 712  * retrieve crop information from the input.
 713  *****************************************************************************/
 714 static void UpdateSPU( subpicture_t *p_spu, vlc_object_t *p_object )
 715 {
 716     vlc_value_t val;
 717
 718     if( var_Get( p_object, "highlight", &val ) )
 719     {
 720         return;
 721     }
 722
 723     p_spu->p_sys->b_crop = val.b_bool;
 724     if( !p_spu->p_sys->b_crop )
 725     {
 726         return;
 727     }
 728
 729     var_Get( p_object, "x-start", &val );
 730     p_spu->p_sys->i_x_start = val.i_int;
 731     var_Get( p_object, "y-start", &val );
 732     p_spu->p_sys->i_y_start = val.i_int;
 733     var_Get( p_object, "x-end", &val );
 734     p_spu->p_sys->i_x_end = val.i_int;
 735     var_Get( p_object, "y-end", &val );
 736     p_spu->p_sys->i_y_end = val.i_int;
 737
 738 #if 0
 739     if( var_Get( p_object, "color", &val ) == VLC_SUCCESS )
 740     {
 741         p_spu->p_sys->pi_color[0] = ((uint8_t *)val.p_address)[0];
 742         p_spu->p_sys->pi_color[1] = ((uint8_t *)val.p_address)[1];
 743         p_spu->p_sys->pi_color[2] = ((uint8_t *)val.p_address)[2];
 744         p_spu->p_sys->pi_color[3] = ((uint8_t *)val.p_address)[3];
 745     }
 746 #endif
 747
 748     if( var_Get( p_object, "contrast", &val ) == VLC_SUCCESS )
 749     {
 750         p_spu->p_sys->pi_alpha[0] = ((uint8_t *)val.p_address)[0];
 751         p_spu->p_sys->pi_alpha[1] = ((uint8_t *)val.p_address)[1];
 752         p_spu->p_sys->pi_alpha[2] = ((uint8_t *)val.p_address)[2];
 753         p_spu->p_sys->pi_alpha[3] = ((uint8_t *)val.p_address)[3];
 754     }
 755 }
 756
 757 /*****************************************************************************
 758  * CropCallback: called when the highlight properties are changed
 759  *****************************************************************************
 760  * This callback is called from the input thread when we need cropping
 761  *****************************************************************************/
 762 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
 763                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 764 {
 765     UpdateSPU( (subpicture_t *)p_data, p_object );
 766
 767     return VLC_SUCCESS;
 768 }
 769