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

   1 /*****************************************************************************
   2  * svcdsub.c : Overlay Graphics Text (SVCD subtitles) decoder
   3  *****************************************************************************
   4  * Copyright (C) 2003, 2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Rocky Bernstein
   8  *          Gildas Bazin <gbazin@videolan.org>
   9  *          Julio Sanchez Fernandez (http://subhandler.sourceforge.net)
  10  *          Laurent Aimar <fenrir@via.ecp.fr>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <vlc_common.h>
  35 #include <vlc_plugin.h>
  36 #include <vlc_codec.h>
  37 #include <vlc_bits.h>
  38
  39 /*****************************************************************************
  40  * Module descriptor.
  41  *****************************************************************************/
  42 static int  DecoderOpen   ( vlc_object_t * );
  43 static int  PacketizerOpen( vlc_object_t * );
  44 static void DecoderClose  ( vlc_object_t * );
  45
  46 #define DEBUG_TEXT N_("Enable debug")
  47
  48 #define DEBUG_LONGTEXT  \
  49     N_("This integer when viewed in binary is a debugging mask\n" \
  50     "calls                 1\n" \
  51     "packet assembly info  2\n" )
  52
  53 vlc_module_begin ()
  54     set_description( N_("Philips OGT (SVCD subtitle) decoder") )
  55     set_shortname( N_("SVCD subtitles") )
  56     set_category( CAT_INPUT )
  57     set_subcategory( SUBCAT_INPUT_SCODEC )
  58     set_capability( "decoder", 50 )
  59     set_callbacks( DecoderOpen, DecoderClose )
  60
  61     add_integer ( MODULE_STRING "-debug", 0, NULL,
  62                   DEBUG_TEXT, DEBUG_LONGTEXT, true )
  63
  64     add_submodule ()
  65     set_description( N_("Philips OGT (SVCD subtitle) packetizer") )
  66     set_capability( "packetizer", 50 )
  67     set_callbacks( PacketizerOpen, DecoderClose )
  68 vlc_module_end ()
  69
  70 /*****************************************************************************
  71  * Local prototypes
  72  *****************************************************************************/
  73 static subpicture_t *Decode( decoder_t *, block_t ** );
  74 static block_t *Packetize  ( decoder_t *, block_t ** );
  75 static block_t *Reassemble ( decoder_t *, block_t * );
  76 static void ParseHeader( decoder_t *, block_t * );
  77 static subpicture_t *DecodePacket( decoder_t *, block_t * );
  78 static void SVCDSubRenderImage( decoder_t *, block_t *, subpicture_region_t * );
  79
  80 #define DECODE_DBG_CALL        1 /* calls */
  81 #define DECODE_DBG_PACKET      2 /* packet assembly info */
  82
  83 #define GETINT16(p) ( (p[0] <<  8) +   p[1] )  ; p +=2;
  84
  85 #define GETINT32(p) ( (p[0] << 24) +  (p[1] << 16) +    \
  86                       (p[2] <<  8) +  (p[3]) ) ; p += 4;
  87
  88 typedef enum  {
  89   SUBTITLE_BLOCK_EMPTY    = 0,
  90   SUBTITLE_BLOCK_PARTIAL  = 1,
  91   SUBTITLE_BLOCK_COMPLETE = 2
  92 } packet_state_t;
  93
  94 #ifndef DECODE_DEBUG
  95 #define DECODE_DEBUG 1
  96 #endif
  97 #if DECODE_DEBUG
  98 #define dbg_print(mask, s, args...) \
  99    if (p_sys && p_sys->i_debug & mask) \
 100      msg_Dbg(p_dec, "%s: "s, __func__ , ##args)
 101 #else
 102 #define dbg_print(mask, s, args...)
 103 #endif
 104
 105 struct decoder_sys_t
 106 {
 107   int      i_debug;       /* debugging mask */
 108
 109   packet_state_t i_state; /* data-gathering state for this subtitle */
 110
 111   block_t  *p_spu;        /* Bytes of the packet. */
 112
 113   uint16_t i_image;       /* image number in the subtitle stream */
 114   uint8_t  i_packet;      /* packet number for above image number */
 115
 116   size_t   i_spu_size;     /* goal for subtitle_data_pos while gathering,
 117                              size of used subtitle_data later */
 118
 119   uint16_t i_image_offset;      /* offset from subtitle_data to compressed
 120                                    image data */
 121   size_t i_image_length;           /* size of the compressed image data */
 122   size_t second_field_offset;      /* offset of odd raster lines */
 123   size_t metadata_offset;          /* offset to data describing the image */
 124   size_t metadata_length;          /* length of metadata */
 125
 126   mtime_t i_duration;   /* how long to display the image, 0 stands
 127                            for "until next subtitle" */
 128
 129   uint16_t i_x_start, i_y_start; /* position of top leftmost pixel of
 130                                     image when displayed */
 131   uint16_t i_width, i_height;    /* dimensions in pixels of image */
 132
 133   uint8_t p_palette[4][4];       /* Palette of colors used in subtitle */
 134 };
 135
 136 /*****************************************************************************
 137  * DecoderOpen: open/initialize the svcdsub decoder.
 138  *****************************************************************************/
 139 static int DecoderOpen( vlc_object_t *p_this )
 140 {
 141     decoder_t     *p_dec = (decoder_t*)p_this;
 142     decoder_sys_t *p_sys;
 143
 144     if( p_dec->fmt_in.i_codec != VLC_CODEC_OGT )
 145         return VLC_EGENERIC;
 146
 147     p_dec->p_sys = p_sys = calloc( 1, sizeof( decoder_sys_t ) );
 148     if( p_sys == NULL )
 149         return VLC_ENOMEM;
 150
 151     p_sys->i_debug = var_InheritInteger( p_this, MODULE_STRING "-debug" );
 152
 153     p_sys->i_image = -1;
 154
 155     p_sys->i_state = SUBTITLE_BLOCK_EMPTY;
 156     p_sys->p_spu   = NULL;
 157
 158     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_CODEC_OGT );
 159
 160     p_dec->pf_decode_sub = Decode;
 161     p_dec->pf_packetize  = Packetize;
 162
 163     dbg_print( (DECODE_DBG_CALL) , "");
 164     return VLC_SUCCESS;
 165 }
 166
 167 /*****************************************************************************
 168  * PacketizerOpen: open/initialize the svcdsub packetizer.
 169  *****************************************************************************/
 170 static int PacketizerOpen( vlc_object_t *p_this )
 171 {
 172     if( DecoderOpen( p_this ) != VLC_SUCCESS ) return VLC_EGENERIC;
 173
 174     return VLC_SUCCESS;
 175 }
 176
 177 /*****************************************************************************
 178  * DecoderClose: closes the svcdsub decoder/packetizer.
 179  *****************************************************************************/
 180 void DecoderClose( vlc_object_t *p_this )
 181 {
 182     decoder_t     *p_dec = (decoder_t*)p_this;
 183     decoder_sys_t *p_sys = p_dec->p_sys;
 184
 185     if( p_sys->p_spu ) block_ChainRelease( p_sys->p_spu );
 186     free( p_sys );
 187 }
 188
 189 /*****************************************************************************
 190  * Decode:
 191  *****************************************************************************/
 192 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 193 {
 194     block_t *p_block, *p_spu;
 195     decoder_sys_t *p_sys = p_dec->p_sys;
 196
 197     dbg_print( (DECODE_DBG_CALL) , "");
 198
 199     if( pp_block == NULL || *pp_block == NULL ) return NULL;
 200
 201     p_block = *pp_block;
 202     *pp_block = NULL;
 203
 204     if( !(p_spu = Reassemble( p_dec, p_block )) ) return NULL;
 205
 206     /* Parse and decode */
 207     return DecodePacket( p_dec, p_spu );
 208 }
 209
 210 /*****************************************************************************
 211  * Packetize:
 212  *****************************************************************************/
 213 static block_t *Packetize( decoder_t *p_dec, block_t **pp_block )
 214 {
 215     block_t *p_block, *p_spu;
 216
 217     if( pp_block == NULL || *pp_block == NULL ) return NULL;
 218
 219     p_block = *pp_block;
 220     *pp_block = NULL;
 221
 222     if( !(p_spu = Reassemble( p_dec, p_block )) ) return NULL;
 223
 224     p_spu->i_dts = p_spu->i_pts;
 225     p_spu->i_length = 0;
 226
 227     return p_spu;
 228 }
 229
 230 /*****************************************************************************
 231  Reassemble:
 232
 233  The data for single screen subtitle may come in one of many
 234  non-contiguous packets of a stream. This routine is called when the
 235  next packet in the stream comes in. The job of this routine is to
 236  parse the header, if this is the beginning, and combine the packets
 237  into one complete subtitle unit.
 238
 239  If everything is complete, we will return a block. Otherwise return
 240  NULL.
 241
 242
 243  The format of the beginning of the subtitle packet that is used here.
 244
 245    size    description
 246    -------------------------------------------
 247    byte    subtitle channel (0..7) in bits 0-3
 248    byte    subtitle packet number of this subtitle image 0-N,
 249            if the subtitle packet is complete, the top bit of the byte is 1.
 250    uint16  subtitle image number
 251
 252  *****************************************************************************/
 253 #define SPU_HEADER_LEN 5
 254
 255 static block_t *Reassemble( decoder_t *p_dec, block_t *p_block )
 256 {
 257     decoder_sys_t *p_sys = p_dec->p_sys;
 258     uint8_t *p_buffer;
 259     uint16_t i_expected_image;
 260     uint8_t  i_packet, i_expected_packet;
 261
 262     if( p_block->i_buffer < SPU_HEADER_LEN )
 263     {
 264         msg_Dbg( p_dec, "invalid packet header (size %zu < %u)" ,
 265                  p_block->i_buffer, SPU_HEADER_LEN );
 266         block_Release( p_block );
 267         return NULL;
 268     }
 269
 270     p_buffer = p_block->p_buffer;
 271
 272     /* Attach to our input thread and see if subtitle is selected. */
 273     {
 274         vlc_object_t * p_input;
 275         vlc_value_t val;
 276
 277         p_input = vlc_object_find( p_dec, VLC_OBJECT_INPUT, FIND_PARENT );
 278
 279         if( !p_input ) return NULL;
 280
 281         if( var_Get( p_input, "sub-track", &val ) )
 282         {
 283             vlc_object_release( p_input );
 284             return NULL;
 285         }
 286
 287         vlc_object_release( p_input );
 288         dbg_print( (DECODE_DBG_PACKET),
 289                    "val.i_int %x p_buffer[i] %x", val.i_int, p_buffer[1]);
 290
 291         /* The dummy ES that the menu selection uses has an 0x70 at
 292            the head which we need to strip off. */
 293         if( val.i_int == -1 || (val.i_int & 0x03) != p_buffer[1] )
 294         {
 295             dbg_print( DECODE_DBG_PACKET, "subtitle not for us.\n");
 296             return NULL;
 297         }
 298     }
 299
 300     if( p_sys->i_state == SUBTITLE_BLOCK_EMPTY )
 301     {
 302         i_expected_image  = p_sys->i_image + 1;
 303         i_expected_packet = 0;
 304     }
 305     else
 306     {
 307         i_expected_image  = p_sys->i_image;
 308         i_expected_packet = p_sys->i_packet + 1;
 309     }
 310
 311     p_buffer += 2;
 312
 313     if( *p_buffer & 0x80 )
 314     {
 315         p_sys->i_state = SUBTITLE_BLOCK_COMPLETE;
 316         i_packet       = *p_buffer++ & 0x7F;
 317     }
 318     else
 319     {
 320         p_sys->i_state = SUBTITLE_BLOCK_PARTIAL;
 321         i_packet       = *p_buffer++;
 322     }
 323
 324     p_sys->i_image = GETINT16(p_buffer);
 325
 326     if( p_sys->i_image != i_expected_image )
 327     {
 328         msg_Warn( p_dec, "expected subtitle image %u but found %u",
 329                   i_expected_image, p_sys->i_image );
 330     }
 331
 332     if( i_packet != i_expected_packet )
 333     {
 334         msg_Warn( p_dec, "expected subtitle image packet %u but found %u",
 335                   i_expected_packet, i_packet );
 336     }
 337
 338     p_block->p_buffer += SPU_HEADER_LEN;
 339     p_block->i_buffer -= SPU_HEADER_LEN;
 340
 341     p_sys->i_packet = i_packet;
 342     /* First packet in the subtitle block */
 343     if( !p_sys->i_packet ) ParseHeader( p_dec, p_block );
 344
 345     block_ChainAppend( &p_sys->p_spu, p_block );
 346
 347     if( p_sys->i_state == SUBTITLE_BLOCK_COMPLETE )
 348     {
 349         block_t *p_spu = block_ChainGather( p_sys->p_spu );
 350
 351         if( p_spu->i_buffer != p_sys->i_spu_size )
 352         {
 353             msg_Warn( p_dec, "subtitle packets size=%zu should be %zu",
 354                       p_spu->i_buffer, p_sys->i_spu_size );
 355         }
 356
 357     dbg_print( (DECODE_DBG_PACKET),
 358                  "subtitle packet complete, size=%zu", p_spu->i_buffer );
 359
 360         p_sys->i_state = SUBTITLE_BLOCK_EMPTY;
 361         p_sys->p_spu = 0;
 362         return p_spu;
 363     }
 364
 365     return NULL;
 366 }
 367
 368 /******************************************************************************
 369   The format is roughly as follows (everything is big-endian):
 370
 371    size     description
 372    -------------------------------------------
 373    byte     subtitle channel (0..7) in bits 0-3
 374    byte     subtitle packet number of this subtitle image 0-N,
 375             if the subtitle packet is complete, the top bit of the byte is 1.
 376    u_int16  subtitle image number
 377    u_int16  length in bytes of the rest
 378    byte     option flags, unknown meaning except bit 3 (0x08) indicates
 379             presence of the duration field
 380    byte     unknown
 381    u_int32  duration in 1/90000ths of a second (optional), start time
 382             is as indicated by the PTS in the PES header
 383    u_int32  xpos
 384    u_int32  ypos
 385    u_int32  width (must be even)
 386    u_int32  height (must be even)
 387    byte[16] palette, 4 palette entries, each contains values for
 388             Y, U, V and transparency, 0 standing for transparent
 389    byte     command,
 390             cmd>>6==1 indicates shift
 391             (cmd>>4)&3 is direction from, (0=top,1=left,2=right,3=bottom)
 392    u_int32  shift duration in 1/90000ths of a second
 393    u_int16  offset of odd-numbered scanlines - subtitle images are
 394             given in interlace order
 395    byte[]   limited RLE image data in interlace order (0,2,4... 1,3,5) with
 396             2-bits per palette number
 397 ******************************************************************************/
 398 static void ParseHeader( decoder_t *p_dec, block_t *p_block )
 399 {
 400     decoder_sys_t *p_sys = p_dec->p_sys;
 401     uint8_t *p = p_block->p_buffer;
 402     uint8_t i_options, i_options2, i_cmd, i_cmd_arg;
 403     int i;
 404
 405     p_sys->i_spu_size = GETINT16(p);
 406     i_options  = *p++;
 407     i_options2 = *p++;
 408
 409     if( i_options & 0x08 ) { p_sys->i_duration = GETINT32(p); }
 410     else p_sys->i_duration = 0; /* Ephemer subtitle */
 411     p_sys->i_duration *= 100 / 9;
 412
 413     p_sys->i_x_start = GETINT16(p);
 414     p_sys->i_y_start = GETINT16(p);
 415     p_sys->i_width   = GETINT16(p);
 416     p_sys->i_height  = GETINT16(p);
 417
 418     for( i = 0; i < 4; i++ )
 419     {
 420         p_sys->p_palette[i][0] = *p++; /* Y */
 421         p_sys->p_palette[i][2] = *p++; /* Cr / V */
 422         p_sys->p_palette[i][1] = *p++; /* Cb / U */
 423         p_sys->p_palette[i][3] = *p++; /* T */
 424     }
 425
 426     i_cmd = *p++;
 427     /* We do not really know this, FIXME */
 428     if( i_cmd ) {i_cmd_arg = GETINT32(p);}
 429
 430     /* Actually, this is measured against a different origin, so we have to
 431      * adjust it */
 432     p_sys->second_field_offset = GETINT16(p);
 433     p_sys->i_image_offset  = p - p_block->p_buffer;
 434     p_sys->i_image_length  = p_sys->i_spu_size - p_sys->i_image_offset;
 435     p_sys->metadata_length = p_sys->i_image_offset;
 436
 437   if( p_sys->i_debug & DECODE_DBG_PACKET )
 438   {
 439       msg_Dbg( p_dec, "x-start: %d, y-start: %d, width: %d, height %d, "
 440            "spu size: %zu, duration: %"PRIu64" (d:%zu p:%"PRIu16")",
 441            p_sys->i_x_start, p_sys->i_y_start,
 442            p_sys->i_width, p_sys->i_height,
 443            p_sys->i_spu_size, p_sys->i_duration,
 444            p_sys->i_image_length, p_sys->i_image_offset);
 445
 446       for( i = 0; i < 4; i++ )
 447       {
 448           msg_Dbg( p_dec, "palette[%d]= T: %2x, Y: %2x, u: %2x, v: %2x", i,
 449            p_sys->p_palette[i][3], p_sys->p_palette[i][0],
 450            p_sys->p_palette[i][1], p_sys->p_palette[i][2] );
 451       }
 452   }
 453 }
 454
 455 /*****************************************************************************
 456  * DecodePacket: parse and decode an subtitle packet
 457  *****************************************************************************
 458  * This function parses and decodes an SPU packet and, if valid, returns a
 459  * subpicture.
 460  *****************************************************************************/
 461 static subpicture_t *DecodePacket( decoder_t *p_dec, block_t *p_data )
 462 {
 463     decoder_sys_t *p_sys = p_dec->p_sys;
 464     subpicture_t  *p_spu;
 465     subpicture_region_t *p_region;
 466     video_format_t fmt;
 467     video_palette_t palette;
 468     int i;
 469
 470     /* Allocate the subpicture internal data. */
 471     p_spu = decoder_NewSubpicture( p_dec, NULL );
 472     if( !p_spu ) return NULL;
 473
 474     p_spu->i_start = p_data->i_pts;
 475     p_spu->i_stop  = p_data->i_pts + p_sys->i_duration;
 476     p_spu->b_ephemer = true;
 477
 478     /* Create new subtitle region */
 479     memset( &fmt, 0, sizeof(video_format_t) );
 480     fmt.i_chroma = VLC_CODEC_YUVP;
 481
 482     /**
 483        The video on which the subtitle sits, is scaled, probably
 484        4:3. However subtitle bitmaps assume an 1:1 aspect ratio.
 485
 486        FIXME: We should get the video aspect ratio from somewhere.
 487        Two candidates are the video and the other possibility would be
 488        the access module.
 489     */
 490     fmt.i_sar_num = p_sys->i_height;
 491     fmt.i_sar_den = p_sys->i_width;
 492
 493     fmt.i_width = fmt.i_visible_width = p_sys->i_width;
 494     fmt.i_height = fmt.i_visible_height = p_sys->i_height;
 495     fmt.i_x_offset = fmt.i_y_offset = 0;
 496     fmt.p_palette = &palette;
 497     fmt.p_palette->i_entries = 4;
 498     for( i = 0; i < fmt.p_palette->i_entries; i++ )
 499     {
 500         fmt.p_palette->palette[i][0] = p_sys->p_palette[i][0];
 501         fmt.p_palette->palette[i][1] = p_sys->p_palette[i][1];
 502         fmt.p_palette->palette[i][2] = p_sys->p_palette[i][2];
 503         fmt.p_palette->palette[i][3] = p_sys->p_palette[i][3];
 504     }
 505
 506     p_region = subpicture_region_New( &fmt );
 507     if( !p_region )
 508     {
 509         msg_Err( p_dec, "cannot allocate SVCD subtitle region" );
 510         decoder_DeleteSubpicture( p_dec, p_spu );
 511         return NULL;
 512     }
 513
 514     p_spu->p_region = p_region;
 515     p_region->i_x = p_sys->i_x_start;
 516     p_region->i_y = p_sys->i_y_start;
 517
 518     SVCDSubRenderImage( p_dec, p_data, p_region );
 519
 520     return p_spu;
 521 }
 522
 523 /*****************************************************************************
 524  * SVCDSubRenderImage: reorders bytes of image data in subpicture region.
 525  *****************************************************************************
 526
 527  The image is encoded using two bits per pixel that select a palette
 528  entry except that value 0 starts a limited run-length encoding for
 529  color 0.  When 0 is seen, the next two bits encode one less than the
 530  number of pixels, so we can encode run lengths from 1 to 4. These get
 531  filled with the color in palette entry 0.
 532
 533  The encoding of each line is padded to a whole number of bytes.  The
 534  first field is padded to an even byte length and the complete subtitle
 535  is padded to a 4-byte multiple that always include one zero byte at
 536  the end.
 537
 538  However we'll transform this so that that the RLE is expanded and
 539  interlacing will also be removed.
 540  *****************************************************************************/
 541 static void SVCDSubRenderImage( decoder_t *p_dec, block_t *p_data,
 542                 subpicture_region_t *p_region )
 543 {
 544     decoder_sys_t *p_sys = p_dec->p_sys;
 545     uint8_t *p_dest = p_region->p_picture->Y_PIXELS;
 546     int i_field;            /* The subtitles are interlaced */
 547     int i_row, i_column;    /* scanline row/column number */
 548     uint8_t i_color, i_count;
 549     bs_t bs;
 550
 551     bs_init( &bs, p_data->p_buffer + p_sys->i_image_offset,
 552              p_data->i_buffer - p_sys->i_image_offset );
 553
 554     for( i_field = 0; i_field < 2; i_field++ )
 555     {
 556         for( i_row = i_field; i_row < p_sys->i_height; i_row += 2 )
 557         {
 558             for( i_column = 0; i_column < p_sys->i_width; i_column++ )
 559             {
 560                 i_color = bs_read( &bs, 2 );
 561                 if( i_color == 0 && (i_count = bs_read( &bs, 2 )) )
 562                 {
 563                     i_count = __MIN( i_count, p_sys->i_width - i_column );
 564                     memset( &p_dest[i_row * p_region->p_picture->Y_PITCH +
 565                                     i_column], 0, i_count + 1 );
 566                     i_column += i_count;
 567                     continue;
 568                 }
 569
 570                 p_dest[i_row * p_region->p_picture->Y_PITCH + i_column] = i_color;
 571             }
 572
 573             bs_align( &bs );
 574         }
 575
 576         /* odd field */
 577         bs_init( &bs, p_data->p_buffer + p_sys->i_image_offset +
 578                  p_sys->second_field_offset,
 579                  p_data->i_buffer - p_sys->i_image_offset -
 580                  p_sys->second_field_offset );
 581     }
 582 }