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

   1 /*****************************************************************************
   2  * dvbsub.c : DVB subtitles decoder
   3  *            DVB subtitles encoder (developed for Anevia, www.anevia.com)
   4  *****************************************************************************
   5  * Copyright (C) 2003 ANEVIA
   6  * Copyright (C) 2003-2004 VideoLAN
   7  * $Id$
   8  *
   9  * Authors: Gildas Bazin <gbazin@videolan.org>
  10  *          Damien LUCAS <damien.lucas@anevia.com>
  11  *          Laurent Aimar <fenrir@via.ecp.fr>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  26  *****************************************************************************/
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30 #include <vlc/vlc.h>
  31 #include <vlc/vout.h>
  32 #include <vlc/decoder.h>
  33 #include <vlc/sout.h>
  34
  35 #include "vlc_bits.h"
  36
  37 //#define DEBUG_DVBSUB 1
  38
  39 /*****************************************************************************
  40  * Module descriptor.
  41  *****************************************************************************/
  42 static int  Open ( vlc_object_t * );
  43 static void Close( vlc_object_t * );
  44 static subpicture_t *Decode( decoder_t *, block_t ** );
  45
  46 static int OpenEncoder  ( vlc_object_t * );
  47 static void CloseEncoder( vlc_object_t * );
  48 static block_t *Encode  ( encoder_t *, subpicture_t * );
  49
  50 vlc_module_begin();
  51     set_description( _("DVB subtitles decoder") );
  52     set_capability( "decoder", 50 );
  53     set_callbacks( Open, Close );
  54
  55 #   define ENC_CFG_PREFIX "sout-dvbsub-"
  56     add_submodule();
  57     set_description( _("DVB subtitles encoder") );
  58     set_capability( "encoder", 100 );
  59     set_callbacks( OpenEncoder, CloseEncoder );
  60 vlc_module_end();
  61
  62 static const char *ppsz_enc_options[] = { NULL };
  63
  64 /****************************************************************************
  65  * Local structures
  66  ****************************************************************************
  67  * Those structures refer closely to the ETSI 300 743 Object model
  68  ****************************************************************************/
  69
  70 /* The object definition gives the position of the object in a region */
  71 typedef struct dvbsub_objectdef_s
  72 {
  73     int i_id;
  74     int i_type;
  75     int i_x;
  76     int i_y;
  77     int i_fg_pc;
  78     int i_bg_pc;
  79
  80 } dvbsub_objectdef_t;
  81
  82 /* The entry in the palette CLUT */
  83 typedef struct
  84 {
  85     uint8_t                 Y;
  86     uint8_t                 Cr;
  87     uint8_t                 Cb;
  88     uint8_t                 T;
  89
  90 } dvbsub_color_t;
  91
  92 /* */
  93 typedef struct dvbsub_clut_s
  94 {
  95     uint8_t                 i_id;
  96     uint8_t                 i_version;
  97     dvbsub_color_t          c_2b[4];
  98     dvbsub_color_t          c_4b[16];
  99     dvbsub_color_t          c_8b[256];
 100
 101     struct dvbsub_clut_s    *p_next;
 102
 103 } dvbsub_clut_t;
 104
 105 /* The Region is an aera on the image
 106  * with a list of the object definitions associated and a CLUT */
 107 typedef struct dvbsub_region_s
 108 {
 109     int i_id;
 110     int i_version;
 111     int i_x;
 112     int i_y;
 113     int i_width;
 114     int i_height;
 115     int i_level_comp;
 116     int i_depth;
 117     int i_clut;
 118
 119     uint8_t *p_pixbuf;
 120
 121     int                    i_object_defs;
 122     dvbsub_objectdef_t     *p_object_defs;
 123
 124     struct dvbsub_region_s *p_next;
 125
 126 } dvbsub_region_t;
 127
 128 /* The object definition gives the position of the object in a region */
 129 typedef struct dvbsub_regiondef_s
 130 {
 131     int i_id;
 132     int i_x;
 133     int i_y;
 134
 135 } dvbsub_regiondef_t;
 136
 137 /* The page defines the list of regions */
 138 typedef struct
 139 {
 140     int i_id;
 141     int i_timeout;
 142     int i_state;
 143     int i_version;
 144
 145     int                i_region_defs;
 146     dvbsub_regiondef_t *p_region_defs;
 147
 148 } dvbsub_page_t;
 149
 150 struct decoder_sys_t
 151 {
 152     bs_t            bs;
 153
 154     /* Decoder internal data */
 155     int             i_id;
 156     int             i_ancillary_id;
 157     mtime_t         i_pts;
 158
 159     dvbsub_page_t   *p_page;
 160     dvbsub_region_t *p_regions;
 161     dvbsub_clut_t   *p_cluts;
 162     dvbsub_clut_t   default_clut;
 163 };
 164
 165
 166 // List of different SEGMENT TYPES
 167 // According to EN 300-743, table 2
 168 #define DVBSUB_ST_PAGE_COMPOSITION      0x10
 169 #define DVBSUB_ST_REGION_COMPOSITION    0x11
 170 #define DVBSUB_ST_CLUT_DEFINITION       0x12
 171 #define DVBSUB_ST_OBJECT_DATA           0x13
 172 #define DVBSUB_ST_ENDOFDISPLAY          0x80
 173 #define DVBSUB_ST_STUFFING              0xff
 174 // List of different OBJECT TYPES
 175 // According to EN 300-743, table 6
 176 #define DVBSUB_OT_BASIC_BITMAP          0x00
 177 #define DVBSUB_OT_BASIC_CHAR            0x01
 178 #define DVBSUB_OT_COMPOSITE_STRING      0x02
 179 // Pixel DATA TYPES
 180 // According to EN 300-743, table 9
 181 #define DVBSUB_DT_2BP_CODE_STRING       0x10
 182 #define DVBSUB_DT_4BP_CODE_STRING       0x11
 183 #define DVBSUB_DT_8BP_CODE_STRING       0x12
 184 #define DVBSUB_DT_24_TABLE_DATA         0x20
 185 #define DVBSUB_DT_28_TABLE_DATA         0x21
 186 #define DVBSUB_DT_48_TABLE_DATA         0x22
 187 #define DVBSUB_DT_END_LINE              0xf0
 188 // List of different Page Composition Segment state
 189 // According to EN 300-743, 7.2.1 table 3
 190 #define DVBSUB_PCS_STATE_ACQUISITION    0x01
 191 #define DVBSUB_PCS_STATE_CHANGE         0x10
 192
 193 /*****************************************************************************
 194  * Local prototypes
 195  *****************************************************************************/
 196 static void decode_segment( decoder_t *, bs_t * );
 197 static void decode_page_composition( decoder_t *, bs_t * );
 198 static void decode_region_composition( decoder_t *, bs_t * );
 199 static void decode_object( decoder_t *, bs_t * );
 200 static void decode_clut( decoder_t *, bs_t * );
 201 static void free_all( decoder_t * );
 202
 203 static void default_clut_init( decoder_t * );
 204
 205 static subpicture_t *render( decoder_t * );
 206
 207 /*****************************************************************************
 208  * Open: probe the decoder and return score
 209  *****************************************************************************
 210  * Tries to launch a decoder and return score so that the interface is able
 211  * to chose.
 212  *****************************************************************************/
 213 static int Open( vlc_object_t *p_this )
 214 {
 215     decoder_t     *p_dec = (decoder_t *) p_this;
 216     decoder_sys_t *p_sys;
 217
 218     if( p_dec->fmt_in.i_codec != VLC_FOURCC('d','v','b','s') )
 219     {
 220         return VLC_EGENERIC;
 221     }
 222
 223     p_dec->pf_decode_sub = Decode;
 224     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
 225     memset( p_sys, 0, sizeof(decoder_sys_t) );
 226
 227     p_sys->i_pts          = 0;
 228     p_sys->i_id           = p_dec->fmt_in.subs.dvb.i_id & 0xFFFF;
 229     p_sys->i_ancillary_id = p_dec->fmt_in.subs.dvb.i_id >> 16;
 230     p_sys->p_regions      = NULL;
 231     p_sys->p_cluts        = NULL;
 232     p_sys->p_page         = NULL;
 233
 234     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 'd','v','b','s' ) );
 235
 236     default_clut_init( p_dec );
 237
 238     return VLC_SUCCESS;
 239 }
 240
 241 /*****************************************************************************
 242  * Close:
 243  *****************************************************************************/
 244 static void Close( vlc_object_t *p_this )
 245 {
 246     decoder_t     *p_dec = (decoder_t*) p_this;
 247     decoder_sys_t *p_sys = p_dec->p_sys;
 248
 249     free_all( p_dec );
 250     free( p_sys );
 251 }
 252
 253 /*****************************************************************************
 254  * Decode:
 255  *****************************************************************************/
 256 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 257 {
 258     decoder_sys_t *p_sys = p_dec->p_sys;
 259     block_t       *p_block;
 260     subpicture_t  *p_spu = NULL;
 261
 262     if( pp_block == NULL || *pp_block == NULL ) return NULL;
 263     p_block = *pp_block;
 264     *pp_block = NULL;
 265
 266     p_sys->i_pts = p_block->i_pts;
 267     if( p_sys->i_pts <= 0 )
 268     {
 269 #ifdef DEBUG_DVBSUB
 270         /* Some DVB channels send stuffing segments in non-dated packets so
 271          * don't complain too loudly. */
 272         msg_Warn( p_dec, "non dated subtitle" );
 273 #endif
 274         block_Release( p_block );
 275         return NULL;
 276     }
 277
 278     bs_init( &p_sys->bs, p_block->p_buffer, p_block->i_buffer );
 279
 280     if( bs_read( &p_sys->bs, 8 ) != 0x20 ) /* Data identifier */
 281     {
 282         msg_Dbg( p_dec, "invalid data identifier" );
 283         block_Release( p_block );
 284         return NULL;
 285     }
 286
 287     if( bs_read( &p_sys->bs, 8 ) ) /* Subtitle stream id */
 288     {
 289         msg_Dbg( p_dec, "invalid subtitle stream id" );
 290         block_Release( p_block );
 291         return NULL;
 292     }
 293
 294 #ifdef DEBUG_DVBSUB
 295     msg_Dbg( p_dec, "subtitle packet received: "I64Fd, p_sys->i_pts );
 296 #endif
 297
 298     while( bs_show( &p_sys->bs, 8 ) == 0x0f ) /* Sync byte */
 299     {
 300         decode_segment( p_dec, &p_sys->bs );
 301     }
 302
 303     if( bs_read( &p_sys->bs, 8 ) != 0xff ) /* End marker */
 304     {
 305         msg_Warn( p_dec, "end marker not found (corrupted subtitle ?)" );
 306         block_Release( p_block );
 307         return NULL;
 308     }
 309
 310     /* Check if the page is to be displayed */
 311     if( p_sys->p_page ) p_spu = render( p_dec );
 312
 313     block_Release( p_block );
 314
 315     return p_spu;
 316 }
 317
 318 /* following functions are local */
 319
 320 /*****************************************************************************
 321  * default_clut_init: default clut as defined in EN 300-743 section 10
 322  *****************************************************************************/
 323 static void default_clut_init( decoder_t *p_dec )
 324 {
 325     decoder_sys_t *p_sys = p_dec->p_sys;
 326     uint8_t i;
 327
 328 #define RGB_TO_Y(r, g, b) ((int16_t) 77 * r + 150 * g + 29 * b) / 256;
 329 #define RGB_TO_U(r, g, b) ((int16_t) -44 * r - 87 * g + 131 * b) / 256;
 330 #define RGB_TO_V(r, g, b) ((int16_t) 131 * r - 110 * g - 21 * b) / 256;
 331
 332     /* 4 entries CLUT */
 333     for( i = 0; i < 4; i++ )
 334     {
 335         uint8_t R = 0, G = 0, B = 0, T = 0;
 336
 337         if( !(i & 0x2) && !(i & 0x1) ) T = 0xFF;
 338         else if( !(i & 0x2) && (i & 0x1) ) R = G = B = 0xFF;
 339         else if( (i & 0x2) && !(i & 0x1) ) R = G = B = 0;
 340         else R = G = B = 0x7F;
 341
 342         p_sys->default_clut.c_2b[i].Y = RGB_TO_Y(R,G,B);
 343         p_sys->default_clut.c_2b[i].Cr = RGB_TO_U(R,G,B);
 344         p_sys->default_clut.c_2b[i].Cb = RGB_TO_V(R,G,B);
 345         p_sys->default_clut.c_2b[i].T = T;
 346     }
 347
 348     /* 16 entries CLUT */
 349     for( i = 0; i < 16; i++ )
 350     {
 351         uint8_t R = 0, G = 0, B = 0, T = 0;
 352
 353         if( !(i & 0x8) )
 354         {
 355             if( !(i & 0x4) && !(i & 0x2) && !(i & 0x1) )
 356             {
 357                 T = 0xFF;
 358             }
 359             else
 360             {
 361                 R = (i & 0x1) ? 0xFF : 0;
 362                 G = (i & 0x2) ? 0xFF : 0;
 363                 B = (i & 0x4) ? 0xFF : 0;
 364             }
 365         }
 366         else
 367         {
 368             R = (i & 0x1) ? 0x7F : 0;
 369             G = (i & 0x2) ? 0x7F : 0;
 370             B = (i & 0x4) ? 0x7F : 0;
 371         }
 372
 373         p_sys->default_clut.c_4b[i].Y = RGB_TO_Y(R,G,B);
 374         p_sys->default_clut.c_4b[i].Cr = RGB_TO_U(R,G,B);
 375         p_sys->default_clut.c_4b[i].Cb = RGB_TO_V(R,G,B);
 376         p_sys->default_clut.c_4b[i].T = T;
 377     }
 378
 379     /* 256 entries CLUT (TODO) */
 380     memset( p_sys->default_clut.c_8b, 0xFF, 256 * sizeof(dvbsub_color_t) );
 381 }
 382
 383 static void decode_segment( decoder_t *p_dec, bs_t *s )
 384 {
 385     decoder_sys_t *p_sys = p_dec->p_sys;
 386     int i_type;
 387     int i_page_id;
 388     int i_size;
 389
 390     /* sync_byte (already checked) */
 391     bs_skip( s, 8 );
 392
 393     /* segment type */
 394     i_type = bs_read( s, 8 );
 395
 396     /* page id */
 397     i_page_id = bs_read( s, 16 );
 398
 399     /* segment size */
 400     i_size = bs_show( s, 16 );
 401
 402     if( i_page_id != p_sys->i_id && i_page_id != p_sys->i_ancillary_id )
 403     {
 404 #ifdef DEBUG_DVBSUB
 405         msg_Dbg( p_dec, "subtitle skipped (page id: %i, %i)",
 406                  i_page_id, p_sys->i_id );
 407 #endif
 408         bs_skip( s,  8 * ( 2 + i_size ) );
 409         return;
 410     }
 411
 412 #ifdef DEBUG_DVBSUB
 413     if( i_page_id == p_sys->i_id )
 414         msg_Dbg( p_dec, "segment (id: %i)", i_page_id );
 415     else
 416         msg_Dbg( p_dec, "ancillary segment (id: %i)", i_page_id );
 417 #endif
 418
 419     switch( i_type )
 420     {
 421     case DVBSUB_ST_PAGE_COMPOSITION:
 422 #ifdef DEBUG_DVBSUB
 423         msg_Dbg( p_dec, "decode_page_composition" );
 424 #endif
 425         decode_page_composition( p_dec, s );
 426         break;
 427
 428     case DVBSUB_ST_REGION_COMPOSITION:
 429 #ifdef DEBUG_DVBSUB
 430         msg_Dbg( p_dec, "decode_region_composition" );
 431 #endif
 432         decode_region_composition( p_dec, s );
 433         break;
 434
 435     case DVBSUB_ST_CLUT_DEFINITION:
 436 #ifdef DEBUG_DVBSUB
 437         msg_Dbg( p_dec, "decode_clut" );
 438 #endif
 439         decode_clut( p_dec, s );
 440         break;
 441
 442     case DVBSUB_ST_OBJECT_DATA:
 443 #ifdef DEBUG_DVBSUB
 444         msg_Dbg( p_dec, "decode_object" );
 445 #endif
 446         decode_object( p_dec, s );
 447         break;
 448
 449     case DVBSUB_ST_ENDOFDISPLAY:
 450 #ifdef DEBUG_DVBSUB
 451         msg_Dbg( p_dec, "end of display" );
 452 #endif
 453         bs_skip( s,  8 * ( 2 + i_size ) );
 454         break;
 455
 456     case DVBSUB_ST_STUFFING:
 457 #ifdef DEBUG_DVBSUB
 458         msg_Dbg( p_dec, "skip stuffing" );
 459 #endif
 460         bs_skip( s,  8 * ( 2 + i_size ) );
 461         break;
 462
 463     default:
 464         msg_Warn( p_dec, "unsupported segment type: (%04x)", i_type );
 465         bs_skip( s,  8 * ( 2 + i_size ) );
 466         break;
 467     }
 468 }
 469
 470 static void decode_clut( decoder_t *p_dec, bs_t *s )
 471 {
 472     decoder_sys_t *p_sys = p_dec->p_sys;
 473     uint16_t      i_segment_length;
 474     uint16_t      i_processed_length;
 475     dvbsub_clut_t *p_clut;
 476     int           i_id, i_version;
 477
 478     i_segment_length = bs_read( s, 16 );
 479     i_id             = bs_read( s, 8 );
 480     i_version        = bs_read( s, 4 );
 481
 482     /* Check if we already have this clut */
 483     for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut->p_next )
 484     {
 485         if( p_clut->i_id == i_id ) break;
 486     }
 487
 488     /* Check version number */
 489     if( p_clut && p_clut->i_version == i_version )
 490     {
 491         /* Nothing to do */
 492         bs_skip( s, 8 * i_segment_length - 12 );
 493         return;
 494     }
 495
 496     if( !p_clut )
 497     {
 498 #ifdef DEBUG_DVBSUB
 499         msg_Dbg( p_dec, "new clut: %i", i_id );
 500 #endif
 501         p_clut = malloc( sizeof(dvbsub_clut_t) );
 502         p_clut->p_next = p_sys->p_cluts;
 503         p_sys->p_cluts = p_clut;
 504     }
 505
 506     /* Initialize to default clut */
 507     *p_clut = p_sys->default_clut;
 508
 509     /* We don't have this version of the CLUT: Parse it */
 510     p_clut->i_version = i_version;
 511     p_clut->i_id = i_id;
 512     bs_skip( s, 4 ); /* Reserved bits */
 513     i_processed_length = 2;
 514     while( i_processed_length < i_segment_length )
 515     {
 516         uint8_t y, cb, cr, t;
 517         uint8_t i_id;
 518         uint8_t i_type;
 519
 520         i_id = bs_read( s, 8 );
 521         i_type = bs_read( s, 3 );
 522
 523         bs_skip( s, 4 );
 524
 525         if( bs_read( s, 1 ) )
 526         {
 527             y  = bs_read( s, 8 );
 528             cr = bs_read( s, 8 );
 529             cb = bs_read( s, 8 );
 530             t  = bs_read( s, 8 );
 531             i_processed_length += 6;
 532         }
 533         else
 534         {
 535             y  = bs_read( s, 6 ) << 2;
 536             cr = bs_read( s, 4 ) << 4;
 537             cb = bs_read( s, 4 ) << 4;
 538             t  = bs_read( s, 2 ) << 6;
 539             i_processed_length += 4;
 540         }
 541
 542         /* We are not entirely compliant here as full transparency is indicated
 543          * with a luma value of zero, not a transparency value of 0xff
 544          * (full transparency would actually be 0xff + 1). */
 545
 546         if( y == 0 )
 547         {
 548             cr = cb = 0;
 549             t  = 0xff;
 550         }
 551
 552         /* According to EN 300-743 section 7.2.3 note 1, type should
 553          * not have more than 1 bit set to one, but some streams don't
 554          * respect this note. */
 555
 556         if( i_type & 0x04)
 557         {
 558             p_clut->c_2b[i_id].Y = y;
 559             p_clut->c_2b[i_id].Cr = cr;
 560             p_clut->c_2b[i_id].Cb = cb;
 561             p_clut->c_2b[i_id].T = t;
 562         }
 563         if( i_type & 0x02)
 564         {
 565             p_clut->c_4b[i_id].Y = y;
 566             p_clut->c_4b[i_id].Cr = cr;
 567             p_clut->c_4b[i_id].Cb = cb;
 568             p_clut->c_4b[i_id].T = t;
 569         }
 570         if( i_type & 0x01)
 571         {
 572             p_clut->c_8b[i_id].Y = y;
 573             p_clut->c_8b[i_id].Cr = cr;
 574             p_clut->c_8b[i_id].Cb = cb;
 575             p_clut->c_8b[i_id].T = t;
 576         }
 577     }
 578 }
 579
 580 static void decode_page_composition( decoder_t *p_dec, bs_t *s )
 581 {
 582     decoder_sys_t *p_sys = p_dec->p_sys;
 583     int i_version, i_state, i_segment_length, i_timeout, i;
 584
 585     /* A page is composed by 0 or more region */
 586
 587     i_segment_length = bs_read( s, 16 );
 588     i_timeout = bs_read( s, 8 );
 589     i_version = bs_read( s, 4 );
 590     i_state = bs_read( s, 2 );
 591     bs_skip( s, 2 ); /* Reserved */
 592
 593     if( i_state == DVBSUB_PCS_STATE_CHANGE )
 594     {
 595         /* End of an epoch, reset decoder buffer */
 596 #ifdef DEBUG_DVBSUB
 597         msg_Dbg( p_dec, "page composition mode change" );
 598 #endif
 599         free_all( p_dec );
 600     }
 601     else if( !p_sys->p_page && i_state != DVBSUB_PCS_STATE_ACQUISITION )
 602     {
 603         /* Not a full PCS, we need to wait for one */
 604         msg_Dbg( p_dec, "didn't receive an acquisition page yet" );
 605
 606 #if 0 /* Try to start decoding even without an acquisition page */
 607         bs_skip( s,  8 * (i_segment_length - 2) );
 608         return;
 609 #endif
 610     }
 611
 612 #ifdef DEBUG_DVBSUB
 613     if( i_state == DVBSUB_PCS_STATE_ACQUISITION )
 614         msg_Dbg( p_dec, "acquisition page composition" );
 615 #endif
 616
 617     /* Check version number */
 618     if( p_sys->p_page && p_sys->p_page->i_version == i_version )
 619     {
 620         bs_skip( s,  8 * (i_segment_length - 2) );
 621         return;
 622     }
 623     else if( p_sys->p_page )
 624     {
 625         if( p_sys->p_page->i_region_defs )
 626             free( p_sys->p_page->p_region_defs );
 627         p_sys->p_page->i_region_defs = 0;
 628     }
 629
 630     if( !p_sys->p_page )
 631     {
 632 #ifdef DEBUG_DVBSUB
 633         msg_Dbg( p_dec, "new page" );
 634 #endif
 635         /* Allocate a new page */
 636         p_sys->p_page = malloc( sizeof(dvbsub_page_t) );
 637     }
 638
 639     p_sys->p_page->i_version = i_version;
 640     p_sys->p_page->i_timeout = i_timeout;
 641
 642     /* Number of regions */
 643     p_sys->p_page->i_region_defs = (i_segment_length - 2) / 6;
 644
 645     if( p_sys->p_page->i_region_defs == 0 ) return;
 646
 647     p_sys->p_page->p_region_defs =
 648         malloc( p_sys->p_page->i_region_defs * sizeof(dvbsub_region_t) );
 649     for( i = 0; i < p_sys->p_page->i_region_defs; i++ )
 650     {
 651         p_sys->p_page->p_region_defs[i].i_id = bs_read( s, 8 );
 652         bs_skip( s, 8 ); /* Reserved */
 653         p_sys->p_page->p_region_defs[i].i_x = bs_read( s, 16 );
 654         p_sys->p_page->p_region_defs[i].i_y = bs_read( s, 16 );
 655
 656 #ifdef DEBUG_DVBSUB
 657         msg_Dbg( p_dec, "page_composition, region %i (%i,%i)",
 658                  i, p_sys->p_page->p_region_defs[i].i_x,
 659                  p_sys->p_page->p_region_defs[i].i_y );
 660 #endif
 661     }
 662 }
 663
 664 static void decode_region_composition( decoder_t *p_dec, bs_t *s )
 665 {
 666     decoder_sys_t *p_sys = p_dec->p_sys;
 667     dvbsub_region_t *p_region, **pp_region = &p_sys->p_regions;
 668     int i_segment_length, i_processed_length, i_id, i_version;
 669     int i_width, i_height, i_level_comp, i_depth, i_clut;
 670     int i_8_bg, i_4_bg, i_2_bg;
 671     vlc_bool_t b_fill;
 672
 673     i_segment_length = bs_read( s, 16 );
 674     i_id = bs_read( s, 8 );
 675     i_version = bs_read( s, 4 );
 676
 677     /* Check if we already have this region */
 678     for( p_region = p_sys->p_regions; p_region != NULL;
 679          p_region = p_region->p_next )
 680     {
 681         pp_region = &p_region->p_next;
 682         if( p_region->i_id == i_id ) break;
 683     }
 684
 685     /* Check version number */
 686     if( p_region && p_region->i_version == i_version )
 687     {
 688         bs_skip( s, 8 * (i_segment_length - 1) - 4 );
 689         return;
 690     }
 691
 692     if( !p_region )
 693     {
 694 #ifdef DEBUG_DVBSUB
 695         msg_Dbg( p_dec, "new region: %i", i_id );
 696 #endif
 697         p_region = *pp_region = malloc( sizeof(dvbsub_region_t) );
 698         memset( p_region, 0, sizeof(dvbsub_region_t) );
 699         p_region->p_object_defs = NULL;
 700         p_region->p_pixbuf = NULL;
 701         p_region->p_next = NULL;
 702     }
 703
 704     /* Region attributes */
 705     p_region->i_id = i_id;
 706     p_region->i_version = i_version;
 707     b_fill = bs_read( s, 1 );
 708     bs_skip( s, 3 ); /* Reserved */
 709
 710     i_width = bs_read( s, 16 );
 711     i_height = bs_read( s, 16 );
 712     i_level_comp = bs_read( s, 3 );
 713     i_depth = bs_read( s, 3 );
 714     bs_skip( s, 2 ); /* Reserved */
 715     i_clut = bs_read( s, 8 );
 716
 717     i_8_bg = bs_read( s, 8 );
 718     i_4_bg = bs_read( s, 4 );
 719     i_2_bg = bs_read( s, 2 );
 720     bs_skip( s, 2 ); /* Reserved */
 721     p_region->i_object_defs    = 0;
 722
 723     /* Extra sanity checks */
 724     if( p_region->i_width != i_width || p_region->i_height != i_height )
 725     {
 726         if( p_region->p_pixbuf )
 727         {
 728             msg_Dbg( p_dec, "region size changed (not allowed)" );
 729             free( p_region->p_pixbuf );
 730         }
 731
 732         p_region->p_pixbuf = malloc( i_height * i_width );
 733         p_region->i_depth = 0;
 734         b_fill = VLC_TRUE;
 735     }
 736     if( p_region->i_depth && (p_region->i_depth != i_depth ||
 737         p_region->i_level_comp != i_level_comp || p_region->i_clut != i_clut) )
 738     {
 739         msg_Dbg( p_dec, "region parameters changed (not allowed)" );
 740     }
 741
 742     /* Erase background of region */
 743     if( b_fill )
 744     {
 745         int i_background = (p_region->i_depth == 1) ? i_2_bg :
 746             (p_region->i_depth == 2) ? i_4_bg : i_8_bg;
 747         memset( p_region->p_pixbuf, i_background, i_width * i_height );
 748     }
 749
 750     p_region->i_width = i_width;
 751     p_region->i_height = i_height;
 752     p_region->i_level_comp = i_level_comp;
 753     p_region->i_depth = i_depth;
 754     p_region->i_clut = i_clut;
 755
 756     /* List of objects in the region */
 757     i_processed_length = 10;
 758     while( i_processed_length < i_segment_length )
 759     {
 760         dvbsub_objectdef_t *p_obj;
 761
 762         /* We create a new object */
 763         p_region->i_object_defs++;
 764         p_region->p_object_defs =
 765             realloc( p_region->p_object_defs,
 766                      sizeof(dvbsub_objectdef_t) * p_region->i_object_defs );
 767
 768         /* We parse object properties */
 769         p_obj = &p_region->p_object_defs[p_region->i_object_defs - 1];
 770         p_obj->i_id         = bs_read( s, 16 );
 771         p_obj->i_type       = bs_read( s, 2 );
 772         bs_skip( s, 2 ); /* Provider */
 773         p_obj->i_x          = bs_read( s, 12 );
 774         bs_skip( s, 4 ); /* Reserved */
 775         p_obj->i_y          = bs_read( s, 12 );
 776
 777         i_processed_length += 6;
 778
 779         if( p_obj->i_type == DVBSUB_OT_BASIC_CHAR ||
 780             p_obj->i_type == DVBSUB_OT_COMPOSITE_STRING )
 781         {
 782             p_obj->i_fg_pc =  bs_read( s, 8 );
 783             p_obj->i_bg_pc =  bs_read( s, 8 );
 784             i_processed_length += 2;
 785         }
 786     }
 787 }
 788
 789 static void dvbsub_render_pdata( decoder_t *, dvbsub_region_t *, int, int,
 790                                  uint8_t *, int );
 791 static void dvbsub_pdata2bpp( bs_t *, uint8_t *, int, int * );
 792 static void dvbsub_pdata4bpp( bs_t *, uint8_t *, int, int * );
 793 static void dvbsub_pdata8bpp( bs_t *, uint8_t *, int, int * );
 794
 795 static void decode_object( decoder_t *p_dec, bs_t *s )
 796 {
 797     decoder_sys_t *p_sys = p_dec->p_sys;
 798     dvbsub_region_t *p_region;
 799     int i_segment_length, i_coding_method, i_version, i_id, i;
 800     vlc_bool_t b_non_modify_color;
 801
 802     i_segment_length = bs_read( s, 16 );
 803     i_id             = bs_read( s, 16 );
 804     i_version        = bs_read( s, 4 );
 805     i_coding_method  = bs_read( s, 2 );
 806
 807     if( i_coding_method )
 808     {
 809         /* TODO: DVB subtitling as characters */
 810         msg_Dbg( p_dec, "DVB subtitling as characters is not handled!" );
 811         bs_skip( s, 8 * (i_segment_length - 2) - 6 );
 812         return;
 813     }
 814
 815     /* Check if the object needs to be rendered in at least one
 816      * of the regions */
 817     for( p_region = p_sys->p_regions; p_region != NULL;
 818          p_region = p_region->p_next )
 819     {
 820         for( i = 0; i < p_region->i_object_defs; i++ )
 821             if( p_region->p_object_defs[i].i_id == i_id ) break;
 822
 823         if( i != p_region->i_object_defs ) break;
 824     }
 825     if( !p_region )
 826     {
 827         bs_skip( s, 8 * (i_segment_length - 2) - 6 );
 828         return;
 829     }
 830
 831 #ifdef DEBUG_DVBSUB
 832     msg_Dbg( p_dec, "new object: %i", i_id );
 833 #endif
 834
 835     b_non_modify_color = bs_read( s, 1 );
 836     bs_skip( s, 1 ); /* Reserved */
 837
 838     if( i_coding_method == 0x00 )
 839     {
 840         int i_topfield, i_bottomfield;
 841         uint8_t *p_topfield, *p_bottomfield;
 842
 843         i_topfield    = bs_read( s, 16 );
 844         i_bottomfield = bs_read( s, 16 );
 845         p_topfield    = s->p_start + bs_pos( s ) / 8;
 846         p_bottomfield = p_topfield + i_topfield;
 847
 848         bs_skip( s, 8 * (i_segment_length - 7) );
 849
 850         /* Sanity check */
 851         if( i_segment_length < i_topfield + i_bottomfield + 7 ||
 852             s->p_start + i_topfield + i_bottomfield > s->p_end )
 853         {
 854             msg_Dbg( p_dec, "corrupted object data" );
 855             return;
 856         }
 857
 858         for( p_region = p_sys->p_regions; p_region != NULL;
 859              p_region = p_region->p_next )
 860         {
 861             for( i = 0; i < p_region->i_object_defs; i++ )
 862             {
 863                 if( p_region->p_object_defs[i].i_id != i_id ) continue;
 864
 865                 dvbsub_render_pdata( p_dec, p_region,
 866                                      p_region->p_object_defs[i].i_x,
 867                                      p_region->p_object_defs[i].i_y,
 868                                      p_topfield, i_topfield );
 869
 870                 if( i_bottomfield )
 871                 {
 872                     dvbsub_render_pdata( p_dec, p_region,
 873                                          p_region->p_object_defs[i].i_x,
 874                                          p_region->p_object_defs[i].i_y + 1,
 875                                          p_bottomfield, i_bottomfield );
 876                 }
 877                 else
 878                 {
 879                     /* Duplicate the top field */
 880                     dvbsub_render_pdata( p_dec, p_region,
 881                                          p_region->p_object_defs[i].i_x,
 882                                          p_region->p_object_defs[i].i_y + 1,
 883                                          p_topfield, i_topfield );
 884                 }
 885             }
 886         }
 887     }
 888     else
 889     {
 890         /* TODO: DVB subtitling as characters */
 891     }
 892
 893 #ifdef DEBUG_DVBSUB
 894     msg_Dbg( p_dec, "end object: %i", i_id );
 895 #endif
 896 }
 897
 898 static void dvbsub_render_pdata( decoder_t *p_dec, dvbsub_region_t *p_region,
 899                                  int i_x, int i_y,
 900                                  uint8_t *p_field, int i_field )
 901 {
 902     uint8_t *p_pixbuf;
 903     int i_offset = 0;
 904     bs_t bs;
 905
 906     /* Sanity check */
 907     if( !p_region->p_pixbuf )
 908     {
 909         msg_Err( p_dec, "region %i has no pixel buffer!", p_region->i_id );
 910         return;
 911     }
 912     if( i_y < 0 || i_x < 0 || i_y >= p_region->i_height ||
 913         i_x >= p_region->i_width )
 914     {
 915         msg_Dbg( p_dec, "invalid offset (%i,%i)", i_x, i_y );
 916         return;
 917     }
 918
 919     p_pixbuf = p_region->p_pixbuf + i_y * p_region->i_width;
 920     bs_init( &bs, p_field, i_field );
 921
 922     while( !bs_eof( &bs ) )
 923     {
 924         /* Sanity check */
 925         if( i_y >= p_region->i_height ) return;
 926
 927         switch( bs_read( &bs, 8 ) )
 928         {
 929         case 0x10:
 930             dvbsub_pdata2bpp( &bs, p_pixbuf + i_x, p_region->i_width - i_x,
 931                               &i_offset );
 932             break;
 933
 934         case 0x11:
 935             dvbsub_pdata4bpp( &bs, p_pixbuf + i_x, p_region->i_width - i_x,
 936                               &i_offset );
 937             break;
 938
 939         case 0x12:
 940             dvbsub_pdata8bpp( &bs, p_pixbuf + i_x, p_region->i_width - i_x,
 941                               &i_offset );
 942             break;
 943
 944         case 0x20:
 945         case 0x21:
 946         case 0x22:
 947             /* We don't use map tables */
 948             break;
 949
 950         case 0xf0: /* End of line code */
 951             p_pixbuf += 2*p_region->i_width;
 952             i_offset = 0; i_y += 2;
 953             break;
 954         }
 955     }
 956 }
 957
 958 static void dvbsub_pdata2bpp( bs_t *s, uint8_t *p, int i_width, int *pi_off )
 959 {
 960     vlc_bool_t b_stop = 0;
 961
 962     while( !b_stop && !bs_eof( s ) )
 963     {
 964         int i_count = 0, i_color = 0;
 965
 966         if( (i_color = bs_read( s, 2 )) != 0x00 )
 967         {
 968             i_count = 1;
 969         }
 970         else
 971         {
 972             if( bs_read( s, 1 ) == 0x01 )         // Switch1
 973             {
 974                 i_count = 3 + bs_read( s, 3 );
 975                 i_color = bs_read( s, 2 );
 976             }
 977             else
 978             {
 979                 if( bs_read( s, 1 ) == 0x00 )     //Switch2
 980                 {
 981                     switch( bs_read( s, 2 ) )     //Switch3
 982                     {
 983                     case 0x00:
 984                         b_stop = 1;
 985                         break;
 986                     case 0x01:
 987                         i_count = 2;
 988                         break;
 989                     case 0x02:
 990                         i_count =  12 + bs_read( s, 4 );
 991                         i_color = bs_read( s, 2 );
 992                         break;
 993                     case 0x03:
 994                         i_count =  29 + bs_read( s, 8 );
 995                         i_color = bs_read( s, 2 );
 996                         break;
 997                     default:
 998                         break;
 999                     }
1000                 }
1001                 else
1002                 {
1003                     /* 1 pixel color 0 */
1004                     i_count = 0;
1005                 }
1006             }
1007         }
1008
1009         if( !i_count ) continue;
1010
1011         /* Sanity check */
1012         if( i_count + *pi_off > i_width ) break;
1013
1014         if( i_count == 1 ) p[*pi_off] = i_color;
1015         else memset( p + *pi_off, i_color, i_count );
1016
1017         (*pi_off) += i_count;
1018     }
1019
1020     bs_align( s );
1021 }
1022
1023 static void dvbsub_pdata4bpp( bs_t *s, uint8_t *p, int i_width, int *pi_off )
1024 {
1025     vlc_bool_t b_stop = 0;
1026
1027     while( !b_stop && !bs_eof( s ) )
1028     {
1029         int i_count = 0, i_color = 0;
1030
1031         if( (i_color = bs_read( s, 4 )) != 0x00 )
1032         {
1033             /* Add 1 pixel */
1034             i_count = 1;
1035         }
1036         else
1037         {
1038             if( bs_read( s, 1 ) == 0x00 )           // Switch1
1039             {
1040                 if( bs_show( s, 3 ) != 0x00 )
1041                 {
1042                     i_count = 2 + bs_read( s, 3 );
1043                 }
1044                 else
1045                 {
1046                     bs_skip( s, 3 );
1047                     b_stop = 1;
1048                 }
1049             }
1050             else
1051             {
1052                 if( bs_read( s, 1 ) == 0x00)        //Switch2
1053                 {
1054                     i_count =  4 + bs_read( s, 2 );
1055                     i_color = bs_read( s, 4 );
1056                 }
1057                 else
1058                 {
1059                     switch ( bs_read( s, 2 ) )     //Switch3
1060                     {
1061                     case 0x0:
1062                         i_count = 1;
1063                         break;
1064                     case 0x1:
1065                         i_count = 2;
1066                         break;
1067                     case 0x2:
1068                         i_count = 9 + bs_read( s, 4 );
1069                         i_color = bs_read( s, 4 );
1070                         break;
1071                     case 0x3:
1072                         i_count= 25 + bs_read( s, 8 );
1073                         i_color = bs_read( s, 4 );
1074                         break;
1075                     }
1076                 }
1077             }
1078         }
1079
1080         if( !i_count ) continue;
1081
1082         /* Sanity check */
1083         if( i_count + *pi_off > i_width ) break;
1084
1085         if( i_count == 1 ) p[*pi_off] = i_color;
1086         else memset( p + *pi_off, i_color, i_count );
1087
1088         (*pi_off) += i_count;
1089     }
1090
1091     bs_align( s );
1092 }
1093
1094 static void dvbsub_pdata8bpp( bs_t *s, uint8_t *p, int i_width, int *pi_off )
1095 {
1096     vlc_bool_t b_stop = 0;
1097
1098     while( !b_stop && !bs_eof( s ) )
1099     {
1100         int i_count = 0, i_color = 0;
1101
1102         if( (i_color = bs_read( s, 8 )) != 0x00 )
1103         {
1104             /* Add 1 pixel */
1105             i_count = 1;
1106         }
1107         else
1108         {
1109             if( bs_read( s, 1 ) == 0x00 )           // Switch1
1110             {
1111                 if( bs_show( s, 7 ) != 0x00 )
1112                 {
1113                     i_count = bs_read( s, 7 );
1114                 }
1115                 else
1116                 {
1117                     bs_skip( s, 7 );
1118                     b_stop = 1;
1119                 }
1120             }
1121             else
1122             {
1123                 i_count = bs_read( s, 7 );
1124                 i_color = bs_read( s, 8 );
1125             }
1126         }
1127
1128         if( !i_count ) continue;
1129
1130         /* Sanity check */
1131         if( i_count + *pi_off > i_width ) break;
1132
1133         if( i_count == 1 ) p[*pi_off] = i_color;
1134         else memset( p + *pi_off, i_color, i_count );
1135
1136         (*pi_off) += i_count;
1137     }
1138
1139     bs_align( s );
1140 }
1141
1142 static void free_all( decoder_t *p_dec )
1143 {
1144     decoder_sys_t *p_sys = p_dec->p_sys;
1145     dvbsub_region_t *p_reg, *p_reg_next;
1146     dvbsub_clut_t *p_clut, *p_clut_next;
1147
1148     for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut_next )
1149     {
1150         p_clut_next = p_clut->p_next;
1151         free( p_clut );
1152     }
1153     p_sys->p_cluts = NULL;
1154
1155     for( p_reg = p_sys->p_regions; p_reg != NULL; p_reg = p_reg_next )
1156     {
1157         p_reg_next = p_reg->p_next;
1158         if( p_reg->i_object_defs ) free( p_reg->p_object_defs );
1159         if( p_reg->p_pixbuf ) free( p_reg->p_pixbuf );
1160         free( p_reg );
1161     }
1162     p_sys->p_regions = NULL;
1163
1164     if( p_sys->p_page )
1165     {
1166         if( p_sys->p_page->i_region_defs )
1167             free( p_sys->p_page->p_region_defs );
1168         free( p_sys->p_page );
1169     }
1170     p_sys->p_page = NULL;
1171 }
1172
1173 static subpicture_t *render( decoder_t *p_dec )
1174 {
1175     decoder_sys_t *p_sys = p_dec->p_sys;
1176     subpicture_t *p_spu;
1177     subpicture_region_t **pp_spu_region;
1178     int i, j, i_timeout = 0;
1179
1180     /* Allocate the subpicture internal data. */
1181     p_spu = p_dec->pf_spu_buffer_new( p_dec );
1182     if( !p_spu ) return NULL;
1183
1184     pp_spu_region = &p_spu->p_region;
1185
1186     /* Loop on region definitions */
1187 #ifdef DEBUG_DVBSUB
1188     if( p_sys->p_page )
1189         msg_Dbg( p_dec, "rendering %i regions", p_sys->p_page->i_region_defs );
1190 #endif
1191
1192     for( i = 0; p_sys->p_page && i < p_sys->p_page->i_region_defs; i++ )
1193     {
1194         dvbsub_region_t     *p_region;
1195         dvbsub_regiondef_t  *p_regiondef;
1196         dvbsub_clut_t       *p_clut;
1197         dvbsub_color_t      *p_color;
1198         subpicture_region_t *p_spu_region;
1199         uint8_t *p_src, *p_dst;
1200         video_format_t fmt;
1201         int i_pitch;
1202
1203         i_timeout = p_sys->p_page->i_timeout;
1204
1205         p_regiondef = &p_sys->p_page->p_region_defs[i];
1206
1207 #ifdef DEBUG_DVBSUB
1208         msg_Dbg( p_dec, "rendering region %i (%i,%i)", i,
1209                  p_regiondef->i_x, p_regiondef->i_y );
1210 #endif
1211
1212         /* Find associated region */
1213         for( p_region = p_sys->p_regions; p_region != NULL;
1214              p_region = p_region->p_next )
1215         {
1216             if( p_regiondef->i_id == p_region->i_id ) break;
1217         }
1218
1219         if( !p_region )
1220         {
1221             msg_Dbg( p_dec, "region %i not found", p_regiondef->i_id );
1222             continue;
1223         }
1224
1225         /* Find associated CLUT */
1226         for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut->p_next )
1227         {
1228             if( p_region->i_clut == p_clut->i_id ) break;
1229         }
1230         if( !p_clut )
1231         {
1232             msg_Dbg( p_dec, "clut %i not found", p_region->i_clut );
1233             continue;
1234         }
1235
1236         /* Create new SPU region */
1237         memset( &fmt, 0, sizeof(video_format_t) );
1238         fmt.i_chroma = VLC_FOURCC('Y','U','V','P');
1239         fmt.i_aspect = VOUT_ASPECT_FACTOR;
1240         fmt.i_width = fmt.i_visible_width = p_region->i_width;
1241         fmt.i_height = fmt.i_visible_height = p_region->i_height;
1242         fmt.i_x_offset = fmt.i_y_offset = 0;
1243         p_spu_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
1244         if( !p_region )
1245         {
1246             msg_Err( p_dec, "cannot allocate SPU region" );
1247             continue;
1248         }
1249         p_spu_region->i_x = p_regiondef->i_x;
1250         p_spu_region->i_y = p_regiondef->i_y;
1251         *pp_spu_region = p_spu_region;
1252         pp_spu_region = &p_spu_region->p_next;
1253
1254         /* Build palette */
1255         fmt.p_palette->i_entries = p_region->i_depth == 1 ? 4 :
1256             p_region->i_depth == 2 ? 16 : 256;
1257         p_color = (p_region->i_depth == 1) ? p_clut->c_2b :
1258             (p_region->i_depth == 2) ? p_clut->c_4b : p_clut->c_8b;
1259         for( j = 0; j < fmt.p_palette->i_entries; j++ )
1260         {
1261             fmt.p_palette->palette[j][0] = p_color[j].Y;
1262             fmt.p_palette->palette[j][1] = p_color[j].Cr;
1263             fmt.p_palette->palette[j][2] = p_color[j].Cb;
1264             fmt.p_palette->palette[j][3] = 0xff - p_color[j].T;
1265         }
1266
1267         p_src = p_region->p_pixbuf;
1268         p_dst = p_spu_region->picture.Y_PIXELS;
1269         i_pitch = p_spu_region->picture.Y_PITCH;
1270
1271         /* Copy pixel buffer */
1272         for( j = 0; j < p_region->i_height; j++ )
1273         {
1274             memcpy( p_dst, p_src, p_region->i_width );
1275             p_src += p_region->i_width;
1276             p_dst += i_pitch;
1277         }
1278     }
1279
1280     /* Set the pf_render callback */
1281     p_spu->i_start = p_sys->i_pts;
1282     p_spu->i_stop = p_spu->i_start + i_timeout * 1000000;
1283     p_spu->b_ephemer = VLC_TRUE;
1284
1285     return p_spu;
1286 }
1287
1288 /*****************************************************************************
1289  * encoder_sys_t : encoder descriptor
1290  *****************************************************************************/
1291 struct encoder_sys_t
1292 {
1293     unsigned int i_page_ver;
1294     unsigned int i_region_ver;
1295     unsigned int i_clut_ver;
1296
1297     /*
1298      * Input properties
1299      */
1300     /*
1301      * Common properties
1302      */
1303     mtime_t i_pts;
1304 };
1305
1306 static void encode_page_composition( encoder_t *, bs_t *, subpicture_t * );
1307 static void encode_clut( encoder_t *, bs_t *, subpicture_t * );
1308 static void encode_region_composition( encoder_t *, bs_t *, subpicture_t * );
1309 static void encode_object( encoder_t *, bs_t *, subpicture_t * );
1310
1311 /*****************************************************************************
1312  * OpenEncoder: probe the encoder and return score
1313  *****************************************************************************/
1314 static int OpenEncoder( vlc_object_t *p_this )
1315 {
1316     encoder_t *p_enc = (encoder_t *)p_this;
1317     encoder_sys_t *p_sys;
1318
1319     if( p_enc->fmt_out.i_codec != VLC_FOURCC('d','v','b','s') &&
1320         !p_enc->b_force )
1321     {
1322         return VLC_EGENERIC;
1323     }
1324
1325     /* Allocate the memory needed to store the decoder's structure */
1326     if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
1327     {
1328         msg_Err( p_enc, "out of memory" );
1329         return VLC_EGENERIC;
1330     }
1331     p_enc->p_sys = p_sys;
1332
1333     p_enc->pf_encode_sub = Encode;
1334     p_enc->fmt_out.i_codec = VLC_FOURCC('d','v','b','s');
1335     p_enc->fmt_out.subs.dvb.i_id  = 1 << 16 | 1;
1336
1337     sout_CfgParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
1338
1339     p_sys->i_page_ver = 0;
1340     p_sys->i_region_ver = 0;
1341     p_sys->i_clut_ver = 0;
1342
1343     return VLC_SUCCESS;
1344 }
1345
1346 /****************************************************************************
1347  * Encode: the whole thing
1348  ****************************************************************************/
1349 static block_t *Encode( encoder_t *p_enc, subpicture_t *p_subpic )
1350 {
1351     bs_t bits, *s = &bits;
1352     block_t *p_block;
1353
1354     if( !p_subpic || !p_subpic->p_region ) return 0;
1355
1356     msg_Dbg( p_enc, "encoding subpicture" );
1357
1358     p_block = block_New( p_enc, 64000 );
1359     bs_init( s, p_block->p_buffer, p_block->i_buffer );
1360
1361     bs_write( s, 8, 0x20 ); /* Data identifier */
1362     bs_write( s, 8, 0x0 ); /* Subtitle stream id */
1363
1364     encode_page_composition( p_enc, s, p_subpic );
1365     encode_region_composition( p_enc, s, p_subpic );
1366     encode_clut( p_enc, s, p_subpic );
1367     encode_object( p_enc, s, p_subpic );
1368
1369     /* End of display */
1370     bs_write( s, 8, 0x0f ); /* Sync byte */
1371     bs_write( s, 8, DVBSUB_ST_ENDOFDISPLAY ); /* Segment type */
1372     bs_write( s, 16, 1 ); /* Page id */
1373     bs_write( s, 16, 0 ); /* Segment length */
1374
1375     bs_write( s, 8, 0xff ); /* End marker */
1376     p_block->i_buffer = bs_pos( s ) / 8;
1377     p_block->i_pts = p_block->i_dts = p_subpic->i_start;
1378     if( !p_subpic->b_ephemer && p_subpic->i_stop )
1379         p_block->i_length = p_subpic->i_stop - p_subpic->i_start;
1380
1381     msg_Dbg( p_enc, "subpicture encoded properly" );
1382
1383     return p_block;
1384 }
1385
1386 /*****************************************************************************
1387  * CloseEncoder: encoder destruction
1388  *****************************************************************************/
1389 static void CloseEncoder( vlc_object_t *p_this )
1390 {
1391     encoder_t *p_enc = (encoder_t *)p_this;
1392     encoder_sys_t *p_sys = p_enc->p_sys;
1393
1394     free( p_sys );
1395 }
1396
1397 static void encode_page_composition( encoder_t *p_enc, bs_t *s,
1398                                      subpicture_t *p_subpic )
1399 {
1400     encoder_sys_t *p_sys = p_enc->p_sys;
1401     subpicture_region_t *p_region;
1402     int i_regions;
1403
1404     bs_write( s, 8, 0x0f ); /* Sync byte */
1405     bs_write( s, 8, DVBSUB_ST_PAGE_COMPOSITION ); /* Segment type */
1406     bs_write( s, 16, 1 ); /* Page id */
1407
1408     for( i_regions = 0, p_region = p_subpic->p_region; p_region;
1409          p_region = p_region->p_next, i_regions++ );
1410
1411     bs_write( s, 16, i_regions * 6 + 2 ); /* Segment length */
1412
1413     bs_write( s, 8, 5 ); /* Timeout */
1414     bs_write( s, 4, p_sys->i_page_ver++ );
1415     bs_write( s, 2, DVBSUB_PCS_STATE_ACQUISITION );
1416     bs_write( s, 2, 0 ); /* Reserved */
1417
1418     for( i_regions = 0, p_region = p_subpic->p_region; p_region;
1419          p_region = p_region->p_next, i_regions++ )
1420     {
1421         bs_write( s, 8, i_regions );
1422         bs_write( s, 8, 0 ); /* Reserved */
1423         bs_write( s, 16, p_region->i_x );
1424         bs_write( s, 16, p_region->i_y );
1425     }
1426 }
1427
1428 static void encode_clut( encoder_t *p_enc, bs_t *s, subpicture_t *p_subpic )
1429 {
1430     encoder_sys_t *p_sys = p_enc->p_sys;
1431     subpicture_region_t *p_region = p_subpic->p_region;
1432     video_palette_t *p_pal;
1433     int i;
1434
1435     /* Sanity check */
1436     if( !p_region || !p_region->fmt.p_palette ||
1437         p_region->fmt.i_chroma != VLC_FOURCC('Y','U','V','P') ) return;
1438
1439     bs_write( s, 8, 0x0f ); /* Sync byte */
1440     bs_write( s, 8, DVBSUB_ST_CLUT_DEFINITION ); /* Segment type */
1441     bs_write( s, 16, 1 ); /* Page id */
1442
1443     p_pal = p_region->fmt.p_palette;
1444
1445     bs_write( s, 16, p_pal->i_entries * 6 + 2 ); /* Segment length */
1446     bs_write( s, 8, 1 ); /* Clut id */
1447     bs_write( s, 4, p_sys->i_clut_ver++ );
1448     bs_write( s, 4, 0 ); /* Reserved */
1449
1450     for( i = 0; i < p_pal->i_entries; i++ )
1451     {
1452         bs_write( s, 8, i ); /* Clut entry id */
1453         bs_write( s, 1, p_pal->i_entries == 4 );   /* 2bit/entry flag */
1454         bs_write( s, 1, p_pal->i_entries == 16 );  /* 4bit/entry flag */
1455         bs_write( s, 1, p_pal->i_entries == 256 ); /* 8bit/entry flag */
1456         bs_write( s, 4, 0 ); /* Reserved */
1457         bs_write( s, 1, 1 ); /* Full range flag */
1458         bs_write( s, 8, p_pal->palette[i][0] ); /* Y value */
1459         bs_write( s, 8, p_pal->palette[i][1] ); /* Cr value */
1460         bs_write( s, 8, p_pal->palette[i][2] ); /* Cb value */
1461         bs_write( s, 8, 0xff - p_pal->palette[i][3] ); /* T value */
1462     }
1463 }
1464
1465 static void encode_region_composition( encoder_t *p_enc, bs_t *s,
1466                                        subpicture_t *p_subpic )
1467 {
1468     encoder_sys_t *p_sys = p_enc->p_sys;
1469     subpicture_region_t *p_region;
1470     int i_regions;
1471
1472     for( i_regions = 0, p_region = p_subpic->p_region; p_region;
1473          p_region = p_region->p_next, i_regions++ )
1474     {
1475         video_palette_t *p_pal = p_region->fmt.p_palette;
1476         int i_depth = p_pal->i_entries == 4 ? 0x1 :
1477             p_pal->i_entries == 16 ? 0x2 : 0x3;
1478
1479         bs_write( s, 8, 0x0f ); /* Sync byte */
1480         bs_write( s, 8, DVBSUB_ST_REGION_COMPOSITION ); /* Segment type */
1481         bs_write( s, 16, 1 ); /* Page id */
1482
1483         bs_write( s, 16, 10 + 6 ); /* Segment length */
1484         bs_write( s, 8, i_regions );
1485         bs_write( s, 4, p_sys->i_region_ver++ );
1486
1487         /* Region attributes */
1488         bs_write( s, 1, 0 ); /* Fill */
1489         bs_write( s, 3, 0 ); /* Reserved */
1490         bs_write( s, 16, p_region->fmt.i_visible_width );
1491         bs_write( s, 16, p_region->fmt.i_visible_height );
1492         bs_write( s, 3, i_depth );  /* Region level of compatibility */
1493         bs_write( s, 3, i_depth  ); /* Region depth */
1494         bs_write( s, 2, 0 ); /* Reserved */
1495         bs_write( s, 8, 1 ); /* Clut id */
1496         bs_write( s, 8, 0 ); /* region 8bit pixel code */
1497         bs_write( s, 4, 0 ); /* region 4bit pixel code */
1498         bs_write( s, 2, 0 ); /* region 2bit pixel code */
1499         bs_write( s, 2, 0 ); /* Reserved */
1500
1501         /* In our implementation we only have 1 object per region */
1502         bs_write( s, 16, i_regions );
1503         bs_write( s, 2, DVBSUB_OT_BASIC_BITMAP );
1504         bs_write( s, 2, 0 ); /* object provider flag */
1505         bs_write( s, 12, 0 ); /* object horizontal position */
1506         bs_write( s, 4, 0 ); /* Reserved */
1507         bs_write( s, 12, 0 ); /* object vertical position */
1508     }
1509 }
1510
1511 static void encode_pixel_data( encoder_t *p_enc, bs_t *s,
1512                                subpicture_region_t *p_region,
1513                                vlc_bool_t b_top );
1514
1515 static void encode_object( encoder_t *p_enc, bs_t *s, subpicture_t *p_subpic )
1516 {
1517     encoder_sys_t   *p_sys = p_enc->p_sys;
1518     subpicture_region_t *p_region;
1519     int i_regions;
1520
1521     int i_length_pos, i_update_pos, i_pixel_data_pos;
1522
1523     for( i_regions = 0, p_region = p_subpic->p_region; p_region;
1524          p_region = p_region->p_next, i_regions++ )
1525     {
1526         bs_write( s, 8, 0x0f ); /* Sync byte */
1527         bs_write( s, 8, DVBSUB_ST_OBJECT_DATA ); /* Segment type */
1528         bs_write( s, 16, 1 ); /* Page id */
1529
1530         i_length_pos = bs_pos( s );
1531         bs_write( s, 16, 0 ); /* Segment length */
1532         bs_write( s, 16, i_regions ); /* Object id */
1533         bs_write( s, 4, p_sys->i_region_ver++ );
1534         bs_write( s, 2, 0 ); /* object coding method */
1535
1536         bs_write( s, 1, 0 ); /* non modifying color flag */
1537         bs_write( s, 1, 0 ); /* Reserved */
1538
1539         i_update_pos = bs_pos( s );
1540         bs_write( s, 16, 0 ); /* topfield data block length */
1541         bs_write( s, 16, 0 ); /* bottomfield data block length */
1542
1543         /* Top field */
1544         i_pixel_data_pos = bs_pos( s );
1545         encode_pixel_data( p_enc, s, p_region, VLC_TRUE );
1546         i_pixel_data_pos = ( bs_pos( s ) - i_pixel_data_pos ) / 8;
1547         SetWBE( &s->p_start[i_update_pos/8], i_pixel_data_pos );
1548
1549         /* Bottom field */
1550         i_pixel_data_pos = bs_pos( s );
1551         encode_pixel_data( p_enc, s, p_region, VLC_FALSE );
1552         i_pixel_data_pos = ( bs_pos( s ) - i_pixel_data_pos ) / 8;
1553         SetWBE( &s->p_start[i_update_pos/8+2], i_pixel_data_pos );
1554
1555         /* Stuffing for word alignment */
1556         bs_align_0( s );
1557         if( bs_pos( s ) % 16 ) bs_write( s, 8, 0 );
1558
1559         /* Update segment length */
1560         SetWBE( &s->p_start[i_length_pos/8], (bs_pos(s) - i_length_pos)/8 -2 );
1561     }
1562 }
1563
1564 static void encode_pixel_line_2bp( encoder_t *p_enc, bs_t *s,
1565                                    subpicture_region_t *p_region,
1566                                    int i_line );
1567 static void encode_pixel_line_4bp( encoder_t *p_enc, bs_t *s,
1568                                    subpicture_region_t *p_region,
1569                                    int i_line );
1570 static void encode_pixel_data( encoder_t *p_enc, bs_t *s,
1571                                subpicture_region_t *p_region,
1572                                vlc_bool_t b_top )
1573 {
1574     unsigned int i_line;
1575
1576     /* Sanity check */
1577     if( p_region->fmt.i_chroma != VLC_FOURCC('Y','U','V','P') ) return;
1578
1579     /* Encode line by line */
1580     for( i_line = !b_top; i_line < p_region->fmt.i_visible_height;
1581          i_line += 2 )
1582     {
1583         switch( p_region->fmt.p_palette->i_entries )
1584         {
1585         case 4:
1586             bs_write( s, 8, 0x10 ); /* 2 bit/pixel code string */
1587             encode_pixel_line_2bp( p_enc, s, p_region, i_line );
1588             break;
1589
1590         case 16:
1591             bs_write( s, 8, 0x11 ); /* 4 bit/pixel code string */
1592             encode_pixel_line_4bp( p_enc, s, p_region, i_line );
1593             break;
1594
1595         default:
1596             msg_Err( p_enc, "subpicture palette (%i) not handled",
1597                      p_region->fmt.p_palette->i_entries );
1598             break;
1599         }
1600
1601         bs_write( s, 8, 0xf0 ); /* End of object line code */
1602     }
1603 }
1604
1605 static void encode_pixel_line_2bp( encoder_t *p_enc, bs_t *s,
1606                                    subpicture_region_t *p_region,
1607                                    int i_line )
1608 {
1609     unsigned int i, i_length = 0;
1610     int i_pitch = p_region->picture.p->i_pitch;
1611     uint8_t *p_data = &p_region->picture.p->p_pixels[ i_pitch * i_line ];
1612     int i_last_pixel = p_data[0];
1613
1614     for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
1615     {
1616         if( i != p_region->fmt.i_visible_width &&
1617             p_data[i] == i_last_pixel && i_length != 284 )
1618         {
1619             i_length++;
1620             continue;
1621         }
1622
1623         if( i_length == 1 || i_length == 11 || i_length == 28 )
1624         {
1625             /* 2bit/pixel code */
1626             if( i_last_pixel ) bs_write( s, 2, i_last_pixel );
1627             else
1628             {
1629                 bs_write( s, 2, 0 );
1630                 bs_write( s, 1, 0 );
1631                 bs_write( s, 1, 1 ); /* pseudo color 0 */
1632             }
1633             i_length--;
1634         }
1635
1636         if( i_length == 2 )
1637         {
1638             if( i_last_pixel )
1639             {
1640                 bs_write( s, 2, i_last_pixel );
1641                 bs_write( s, 2, i_last_pixel );
1642             }
1643             else
1644             {
1645                 bs_write( s, 2, 0 );
1646                 bs_write( s, 1, 0 );
1647                 bs_write( s, 1, 0 );
1648                 bs_write( s, 2, 1 ); /* 2 * pseudo color 0 */
1649             }
1650         }
1651         else if( i_length > 2 )
1652         {
1653             bs_write( s, 2, 0 );
1654             if( i_length <= 10 )
1655             {
1656                 bs_write( s, 1, 1 );
1657                 bs_write( s, 3, i_length - 3 );
1658                 bs_write( s, 2, i_last_pixel );
1659             }
1660             else
1661             {
1662                 bs_write( s, 1, 0 );
1663                 bs_write( s, 1, 0 );
1664
1665                 if( i_length <= 27 )
1666                 {
1667                     bs_write( s, 2, 2 );
1668                     bs_write( s, 4, i_length - 12 );
1669                     bs_write( s, 2, i_last_pixel );
1670                 }
1671                 else
1672                 {
1673                     bs_write( s, 2, 3 );
1674                     bs_write( s, 8, i_length - 29 );
1675                     bs_write( s, 2, i_last_pixel );
1676                 }
1677             }
1678         }
1679
1680         if( i == p_region->fmt.i_visible_width ) break;
1681
1682         i_last_pixel = p_data[i];
1683         i_length = 1;
1684     }
1685
1686     /* Stop */
1687     bs_write( s, 2, 0 );
1688     bs_write( s, 1, 0 );
1689     bs_write( s, 1, 0 );
1690     bs_write( s, 2, 0 );
1691
1692     /* Stuffing */
1693     bs_align_0( s );
1694 }
1695
1696 static void encode_pixel_line_4bp( encoder_t *p_enc, bs_t *s,
1697                                    subpicture_region_t *p_region,
1698                                    int i_line )
1699 {
1700     unsigned int i, i_length = 0;
1701     int i_pitch = p_region->picture.p->i_pitch;
1702     uint8_t *p_data = &p_region->picture.p->p_pixels[ i_pitch * i_line ];
1703     int i_last_pixel = p_data[0];
1704
1705     for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
1706     {
1707         if( i != p_region->fmt.i_visible_width &&
1708             p_data[i] == i_last_pixel && i_length != 1 )
1709         {
1710             i_length++;
1711             continue;
1712         }
1713
1714         if( i_length == 1 )
1715         {
1716             /* 4bit/pixel code */
1717             if( i_last_pixel ) bs_write( s, 4, i_last_pixel );
1718             else
1719             {
1720                 bs_write( s, 4, 0 );
1721                 bs_write( s, 1, 1 );
1722                 bs_write( s, 1, 1 );
1723                 bs_write( s, 2, 0 ); /* pseudo color 0 */
1724             }
1725         }
1726
1727         if( i == p_region->fmt.i_visible_width ) break;
1728
1729         i_last_pixel = p_data[i];
1730         i_length = 1;
1731     }
1732
1733     /* Stop */
1734     bs_write( s, 8, 0 );
1735
1736     /* Stuffing */
1737     bs_align_0( s );
1738 }