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     /* TODO: initialize to default clut */
 507
 508     /* We don't have this version of the CLUT: Parse it */
 509     p_clut->i_version = i_version;
 510     p_clut->i_id = i_id;
 511     bs_skip( s, 4 ); /* Reserved bits */
 512     i_processed_length = 2;
 513     while( i_processed_length < i_segment_length )
 514     {
 515         uint8_t y, cb, cr, t;
 516         uint8_t i_id;
 517         uint8_t i_type;
 518
 519         i_id = bs_read( s, 8 );
 520         i_type = bs_read( s, 3 );
 521
 522         bs_skip( s, 4 );
 523
 524         if( bs_read( s, 1 ) )
 525         {
 526             y  = bs_read( s, 8 );
 527             cr = bs_read( s, 8 );
 528             cb = bs_read( s, 8 );
 529             t  = bs_read( s, 8 );
 530             i_processed_length += 6;
 531         }
 532         else
 533         {
 534             y  = bs_read( s, 6 ) << 2;
 535             cr = bs_read( s, 4 ) << 4;
 536             cb = bs_read( s, 4 ) << 4;
 537             t  = bs_read( s, 2 ) << 6;
 538             i_processed_length += 4;
 539         }
 540
 541         /* We are not entirely compliant here as full transparency is indicated
 542          * with a luma value of zero, not a transparency value of 0xff
 543          * (full transparency would actually be 0xff + 1). */
 544
 545         if( y == 0 )
 546         {
 547             cr = cb = 0;
 548             t  = 0xff;
 549         }
 550
 551         /* According to EN 300-743 section 7.2.3 note 1, type should
 552          * not have more than 1 bit set to one, but some streams don't
 553          * respect this note. */
 554
 555         if( i_type & 0x04)
 556         {
 557             p_clut->c_2b[i_id].Y = y;
 558             p_clut->c_2b[i_id].Cr = cr;
 559             p_clut->c_2b[i_id].Cb = cb;
 560             p_clut->c_2b[i_id].T = t;
 561         }
 562         if( i_type & 0x02)
 563         {
 564             p_clut->c_4b[i_id].Y = y;
 565             p_clut->c_4b[i_id].Cr = cr;
 566             p_clut->c_4b[i_id].Cb = cb;
 567             p_clut->c_4b[i_id].T = t;
 568         }
 569         if( i_type & 0x01)
 570         {
 571             p_clut->c_8b[i_id].Y = y;
 572             p_clut->c_8b[i_id].Cr = cr;
 573             p_clut->c_8b[i_id].Cb = cb;
 574             p_clut->c_8b[i_id].T = t;
 575         }
 576     }
 577 }
 578
 579 static void decode_page_composition( decoder_t *p_dec, bs_t *s )
 580 {
 581     decoder_sys_t *p_sys = p_dec->p_sys;
 582     int i_version, i_state, i_segment_length, i_timeout, i;
 583
 584     /* A page is composed by 0 or more region */
 585
 586     i_segment_length = bs_read( s, 16 );
 587     i_timeout = bs_read( s, 8 );
 588     i_version = bs_read( s, 4 );
 589     i_state = bs_read( s, 2 );
 590     bs_skip( s, 2 ); /* Reserved */
 591
 592     if( i_state == DVBSUB_PCS_STATE_CHANGE )
 593     {
 594         /* End of an epoch, reset decoder buffer */
 595 #ifdef DEBUG_DVBSUB
 596         msg_Dbg( p_dec, "page composition mode change" );
 597 #endif
 598         free_all( p_dec );
 599     }
 600     else if( !p_sys->p_page && i_state != DVBSUB_PCS_STATE_ACQUISITION )
 601     {
 602 #ifdef DEBUG_DVBSUB
 603         /* Not a full PCS, we need to wait for one */
 604         msg_Dbg( p_dec, "didn't receive an acquisition page yet" );
 605         bs_skip( s,  8 * (i_segment_length - 2) );
 606         return;
 607 #endif
 608     }
 609
 610 #ifdef DEBUG_DVBSUB
 611     if( i_state == DVBSUB_PCS_STATE_ACQUISITION )
 612         msg_Dbg( p_dec, "acquisition page composition" );
 613 #endif
 614
 615     /* Check version number */
 616     if( p_sys->p_page && p_sys->p_page->i_version == i_version )
 617     {
 618         bs_skip( s,  8 * (i_segment_length - 2) );
 619         return;
 620     }
 621     else if( p_sys->p_page )
 622     {
 623         if( p_sys->p_page->i_region_defs )
 624             free( p_sys->p_page->p_region_defs );
 625         p_sys->p_page->i_region_defs = 0;
 626     }
 627
 628     if( !p_sys->p_page )
 629     {
 630 #ifdef DEBUG_DVBSUB
 631         msg_Dbg( p_dec, "new page" );
 632 #endif
 633         /* Allocate a new page */
 634         p_sys->p_page = malloc( sizeof(dvbsub_page_t) );
 635     }
 636
 637     p_sys->p_page->i_version = i_version;
 638     p_sys->p_page->i_timeout = i_timeout;
 639
 640     /* Number of regions */
 641     p_sys->p_page->i_region_defs = (i_segment_length - 2) / 6;
 642
 643     if( p_sys->p_page->i_region_defs == 0 ) return;
 644
 645     p_sys->p_page->p_region_defs =
 646         malloc( p_sys->p_page->i_region_defs * sizeof(dvbsub_region_t) );
 647     for( i = 0; i < p_sys->p_page->i_region_defs; i++ )
 648     {
 649         p_sys->p_page->p_region_defs[i].i_id = bs_read( s, 8 );
 650         bs_skip( s, 8 ); /* Reserved */
 651         p_sys->p_page->p_region_defs[i].i_x = bs_read( s, 16 );
 652         p_sys->p_page->p_region_defs[i].i_y = bs_read( s, 16 );
 653
 654 #ifdef DEBUG_DVBSUB
 655         msg_Dbg( p_dec, "page_composition, region %i (%i,%i)",
 656                  i, p_sys->p_page->p_region_defs[i].i_x,
 657                  p_sys->p_page->p_region_defs[i].i_y );
 658 #endif
 659     }
 660 }
 661
 662 static void decode_region_composition( decoder_t *p_dec, bs_t *s )
 663 {
 664     decoder_sys_t *p_sys = p_dec->p_sys;
 665     dvbsub_region_t *p_region, **pp_region = &p_sys->p_regions;
 666     int i_segment_length, i_processed_length, i_id, i_version;
 667     int i_width, i_height, i_level_comp, i_depth, i_clut;
 668     int i_8_bg, i_4_bg, i_2_bg;
 669     vlc_bool_t b_fill;
 670
 671     i_segment_length = bs_read( s, 16 );
 672     i_id = bs_read( s, 8 );
 673     i_version = bs_read( s, 4 );
 674
 675     /* Check if we already have this region */
 676     for( p_region = p_sys->p_regions; p_region != NULL;
 677          p_region = p_region->p_next )
 678     {
 679         pp_region = &p_region->p_next;
 680         if( p_region->i_id == i_id ) break;
 681     }
 682
 683     /* Check version number */
 684     if( p_region && p_region->i_version == i_version )
 685     {
 686         bs_skip( s, 8 * (i_segment_length - 1) - 4 );
 687         return;
 688     }
 689
 690     if( !p_region )
 691     {
 692 #ifdef DEBUG_DVBSUB
 693         msg_Dbg( p_dec, "new region: %i", i_id );
 694 #endif
 695         p_region = *pp_region = malloc( sizeof(dvbsub_region_t) );
 696         memset( p_region, 0, sizeof(dvbsub_region_t) );
 697         p_region->p_object_defs = NULL;
 698         p_region->p_pixbuf = NULL;
 699         p_region->p_next = NULL;
 700     }
 701
 702     /* Region attributes */
 703     p_region->i_id = i_id;
 704     p_region->i_version = i_version;
 705     b_fill = bs_read( s, 1 );
 706     bs_skip( s, 3 ); /* Reserved */
 707
 708     i_width = bs_read( s, 16 );
 709     i_height = bs_read( s, 16 );
 710     i_level_comp = bs_read( s, 3 );
 711     i_depth = bs_read( s, 3 );
 712     bs_skip( s, 2 ); /* Reserved */
 713     i_clut = bs_read( s, 8 );
 714
 715     i_8_bg = bs_read( s, 8 );
 716     i_4_bg = bs_read( s, 4 );
 717     i_2_bg = bs_read( s, 2 );
 718     bs_skip( s, 2 ); /* Reserved */
 719     p_region->i_object_defs    = 0;
 720
 721     /* Extra sanity checks */
 722     if( p_region->i_width != i_width || p_region->i_height != i_height )
 723     {
 724         if( p_region->p_pixbuf )
 725         {
 726             msg_Dbg( p_dec, "region size changed (not allowed)" );
 727             free( p_region->p_pixbuf );
 728         }
 729
 730         p_region->p_pixbuf = malloc( i_height * i_width );
 731         b_fill = VLC_TRUE;
 732     }
 733     if( p_region->i_depth != i_depth ||
 734         p_region->i_level_comp != i_level_comp || p_region->i_clut != i_clut )
 735     {
 736         msg_Dbg( p_dec, "region parameters changed (not allowed)" );
 737     }
 738
 739     /* Erase background of region */
 740     if( b_fill )
 741     {
 742         int i_background = (p_region->i_depth == 1) ? i_2_bg :
 743             (p_region->i_depth == 2) ? i_4_bg : i_8_bg;
 744         memset( p_region->p_pixbuf, i_background, i_width * i_height );
 745     }
 746
 747     p_region->i_width = i_width;
 748     p_region->i_height = i_height;
 749     p_region->i_level_comp = i_level_comp;
 750     p_region->i_depth = i_depth;
 751     p_region->i_clut = i_clut;
 752
 753     /* List of objects in the region */
 754     i_processed_length = 10;
 755     while( i_processed_length < i_segment_length )
 756     {
 757         dvbsub_objectdef_t *p_obj;
 758
 759         /* We create a new object */
 760         p_region->i_object_defs++;
 761         p_region->p_object_defs =
 762             realloc( p_region->p_object_defs,
 763                      sizeof(dvbsub_objectdef_t) * p_region->i_object_defs );
 764
 765         /* We parse object properties */
 766         p_obj = &p_region->p_object_defs[p_region->i_object_defs - 1];
 767         p_obj->i_id         = bs_read( s, 16 );
 768         p_obj->i_type       = bs_read( s, 2 );
 769         bs_skip( s, 2 ); /* Provider */
 770         p_obj->i_x          = bs_read( s, 12 );
 771         bs_skip( s, 4 ); /* Reserved */
 772         p_obj->i_y          = bs_read( s, 12 );
 773
 774         i_processed_length += 6;
 775
 776         if( p_obj->i_type == DVBSUB_OT_BASIC_CHAR ||
 777             p_obj->i_type == DVBSUB_OT_COMPOSITE_STRING )
 778         {
 779             p_obj->i_fg_pc =  bs_read( s, 8 );
 780             p_obj->i_bg_pc =  bs_read( s, 8 );
 781             i_processed_length += 2;
 782         }
 783     }
 784 }
 785
 786 static void dvbsub_render_pdata( decoder_t *, dvbsub_region_t *, int, int,
 787                                  uint8_t *, int );
 788 static void dvbsub_pdata2bpp( bs_t *, uint8_t *, int * );
 789 static void dvbsub_pdata4bpp( bs_t *, uint8_t *, int * );
 790 static void dvbsub_pdata8bpp( bs_t *, uint8_t *, int * );
 791
 792 static void decode_object( decoder_t *p_dec, bs_t *s )
 793 {
 794     decoder_sys_t *p_sys = p_dec->p_sys;
 795     dvbsub_region_t *p_region;
 796     int i_segment_length, i_coding_method, i_version, i_id, i;
 797     vlc_bool_t b_non_modify_color;
 798
 799     i_segment_length = bs_read( s, 16 );
 800     i_id             = bs_read( s, 16 );
 801     i_version        = bs_read( s, 4 );
 802     i_coding_method  = bs_read( s, 2 );
 803
 804     if( i_coding_method )
 805     {
 806         /* TODO: DVB subtitling as characters */
 807         msg_Dbg( p_dec, "DVB subtitling as characters is not handled!" );
 808         bs_skip( s, 8 * (i_segment_length - 2) - 6 );
 809         return;
 810     }
 811
 812     /* Check if the object needs to be rendered in at least one
 813      * of the regions */
 814     for( p_region = p_sys->p_regions; p_region != NULL;
 815          p_region = p_region->p_next )
 816     {
 817         for( i = 0; i < p_region->i_object_defs; i++ )
 818             if( p_region->p_object_defs[i].i_id == i_id ) break;
 819
 820         if( i != p_region->i_object_defs ) break;
 821     }
 822     if( !p_region )
 823     {
 824         bs_skip( s, 8 * (i_segment_length - 2) - 6 );
 825         return;
 826     }
 827
 828 #ifdef DEBUG_DVBSUB
 829     msg_Dbg( p_dec, "new object: %i", i_id );
 830 #endif
 831
 832     b_non_modify_color = bs_read( s, 1 );
 833     bs_skip( s, 1 ); /* Reserved */
 834
 835     if( i_coding_method == 0x00 )
 836     {
 837         int i_topfield, i_bottomfield;
 838         uint8_t *p_topfield, *p_bottomfield;
 839
 840         i_topfield    = bs_read( s, 16 );
 841         i_bottomfield = bs_read( s, 16 );
 842         p_topfield    = s->p_start + bs_pos( s ) / 8;
 843         p_bottomfield = p_topfield + i_topfield;
 844
 845         bs_skip( s, 8 * (i_segment_length - 7) );
 846
 847         /* Sanity check */
 848         if( i_segment_length < i_topfield + i_bottomfield + 7 ||
 849             s->p_start + i_topfield + i_bottomfield > s->p_end )
 850         {
 851             msg_Dbg( p_dec, "corrupted object data" );
 852             return;
 853         }
 854
 855         for( p_region = p_sys->p_regions; p_region != NULL;
 856              p_region = p_region->p_next )
 857         {
 858             for( i = 0; i < p_region->i_object_defs; i++ )
 859             {
 860                 if( p_region->p_object_defs[i].i_id != i_id ) continue;
 861
 862                 dvbsub_render_pdata( p_dec, p_region,
 863                                      p_region->p_object_defs[i].i_x,
 864                                      p_region->p_object_defs[i].i_y,
 865                                      p_topfield, i_topfield );
 866
 867                 if( i_bottomfield )
 868                 {
 869                     dvbsub_render_pdata( p_dec, p_region,
 870                                          p_region->p_object_defs[i].i_x,
 871                                          p_region->p_object_defs[i].i_y + 1,
 872                                          p_bottomfield, i_bottomfield );
 873                 }
 874                 else
 875                 {
 876                     /* Duplicate the top field */
 877                     dvbsub_render_pdata( p_dec, p_region,
 878                                          p_region->p_object_defs[i].i_x,
 879                                          p_region->p_object_defs[i].i_y + 1,
 880                                          p_topfield, i_topfield );
 881                 }
 882             }
 883         }
 884     }
 885     else
 886     {
 887         /* TODO: DVB subtitling as characters */
 888     }
 889
 890 #ifdef DEBUG_DVBSUB
 891     msg_Dbg( p_dec, "end object: %i", i_id );
 892 #endif
 893 }
 894
 895 static void dvbsub_render_pdata( decoder_t *p_dec, dvbsub_region_t *p_region,
 896                                  int i_x, int i_y,
 897                                  uint8_t *p_field, int i_field )
 898 {
 899     uint8_t *p_pixbuf = p_region->p_pixbuf + i_y * p_region->i_width;
 900     bs_t bs;
 901     int i_offset = 0;
 902
 903     bs_init( &bs, p_field, i_field );
 904
 905     while( !bs_eof( &bs ) )
 906     {
 907         switch( bs_read( &bs, 8 ) )
 908         {
 909         case 0x10:
 910             dvbsub_pdata2bpp( &bs, p_pixbuf + i_x, &i_offset );
 911             break;
 912         case 0x11:
 913             dvbsub_pdata4bpp( &bs, p_pixbuf + i_x, &i_offset );
 914             break;
 915         case 0x12:
 916             dvbsub_pdata8bpp( &bs, p_pixbuf + i_x, &i_offset );
 917             break;
 918         case 0x20:
 919         case 0x21:
 920         case 0x22:
 921             /* We don't use map tables */
 922             break;
 923         case 0xf0:
 924             p_pixbuf += 2*p_region->i_width; /* End of line code */
 925             i_offset = 0;
 926             break;
 927         }
 928     }
 929 }
 930
 931 static void dvbsub_pdata2bpp( bs_t *s, uint8_t *p, int *pi_off )
 932 {
 933     vlc_bool_t b_stop = 0;
 934     uint16_t i_count = 0;
 935     uint8_t i_color = 0;
 936
 937     while( !b_stop && !bs_eof( s ) )
 938     {
 939         if( (i_color = bs_read( s, 2 )) != 0x00 )
 940         {
 941             p[*pi_off] = i_color;
 942             (*pi_off)++;
 943         }
 944         else
 945         {
 946             if( bs_read( s, 1 ) == 0x01 )         // Switch1
 947             {
 948                 i_count = 3 + bs_read( s, 3 );
 949                 i_color = bs_read( s, 2 );
 950                 memset( p + *pi_off, i_color, i_count );
 951                 (*pi_off) += i_count;
 952             }
 953             else
 954             {
 955                 if( bs_read( s, 1 ) == 0x00 )     //Switch2
 956                 {
 957                     switch( bs_read( s, 2 ) )     //Switch3
 958                     {
 959                     case 0x00:
 960                         b_stop=1;
 961                         break;
 962                     case 0x01:
 963                         memset( p + *pi_off, 0, 2 );
 964                         (*pi_off) += 2;
 965                         break;
 966                     case 0x02:
 967                         i_count =  12 + bs_read( s, 4 );
 968                         i_color = bs_read( s, 2 );
 969                         memset( p + *pi_off, i_color, i_count );
 970                         (*pi_off) += i_count;
 971                         break;
 972                     case 0x03:
 973                         i_count =  29 + bs_read( s, 8 );
 974                         i_color = bs_read( s, 2 );
 975                         memset( p + *pi_off, i_color, i_count );
 976                         (*pi_off) += i_count;
 977                         break;
 978                     default:
 979                         break;
 980                     }
 981                 }
 982                 else
 983                 {
 984                     /* 1 pixel color 0 */
 985                     p[*pi_off] = 0;
 986                     (*pi_off)++;
 987                 }
 988             }
 989         }
 990     }
 991
 992     bs_align( s );
 993 }
 994
 995 static void dvbsub_pdata4bpp( bs_t *s, uint8_t* p, int *pi_off )
 996 {
 997     vlc_bool_t b_stop = 0;
 998     uint16_t i_count = 0;
 999     uint8_t i_color = 0;
1000
1001     while( !b_stop && !bs_eof( s ) )
1002     {
1003         if( (i_color = bs_read( s, 4 )) != 0x00 )
1004         {
1005             /* Add 1 pixel */
1006             p[*pi_off] = i_color;
1007             (*pi_off)++;
1008         }
1009         else
1010         {
1011             if( bs_read( s, 1 ) == 0x00 )           // Switch1
1012             {
1013                 if( bs_show( s, 3 ) != 0x00 )
1014                 {
1015                     i_count = 2 + bs_read( s, 3 );
1016                     memset( p + *pi_off, 0, i_count );
1017                     (*pi_off) += i_count;
1018                 }
1019                 else
1020                 {
1021                     bs_skip( s, 3 );
1022                     b_stop=1;
1023                 }
1024             }
1025             else
1026             {
1027                 if( bs_read( s, 1 ) == 0x00)        //Switch2
1028                 {
1029                     i_count =  4 + bs_read( s, 2 );
1030                     i_color = bs_read( s, 4 );
1031                     memset( p + *pi_off, i_color, i_count );
1032                     (*pi_off) += i_count;
1033                 }
1034                 else
1035                 {
1036                     switch ( bs_read( s, 2 ) )     //Switch3
1037                     {
1038                         case 0x0:
1039                             memset( p + *pi_off, 0, 1 );
1040                             (*pi_off) += 1;
1041                             break;
1042                         case 0x1:
1043                             memset( p + *pi_off, 0, 2 );
1044                             (*pi_off) += 2;
1045                             break;
1046                         case 0x2:
1047                              i_count = 9 + bs_read( s, 4 );
1048                              i_color = bs_read( s, 4 );
1049                              memset( p + *pi_off, i_color, i_count );
1050                              (*pi_off) += i_count;
1051                              break;
1052                         case 0x3:
1053                              i_count= 25 + bs_read( s, 8 );
1054                              i_color = bs_read( s, 4 );
1055                              memset( p + *pi_off, i_color, i_count );
1056                              (*pi_off) += i_count;
1057                              break;
1058                     }
1059                 }
1060             }
1061         }
1062     }
1063
1064     bs_align( s );
1065 }
1066
1067 static void dvbsub_pdata8bpp( bs_t *s, uint8_t* p, int *pi_off )
1068 {
1069     vlc_bool_t b_stop = 0;
1070     uint16_t i_count = 0;
1071     uint8_t i_color = 0;
1072
1073     while( !b_stop && !bs_eof( s ) )
1074     {
1075         if( (i_color = bs_read( s, 8 )) != 0x00 )
1076         {
1077             /* Add 1 pixel */
1078             p[*pi_off] = i_color;
1079             (*pi_off)++;
1080         }
1081         else
1082         {
1083             if( bs_read( s, 1 ) == 0x00 )           // Switch1
1084             {
1085                 if( bs_show( s, 7 ) != 0x00 )
1086                 {
1087                     i_count = bs_read( s, 7 );
1088                     memset( p + *pi_off, 0, i_count );
1089                     (*pi_off) += i_count;
1090                 }
1091                 else
1092                 {
1093                     bs_skip( s, 7 );
1094                     b_stop = 1;
1095                 }
1096             }
1097             else
1098             {
1099                 i_count = bs_read( s, 7 );
1100                 i_color = bs_read( s, 8 );
1101                 memset( p + *pi_off, i_color, i_count );
1102                 (*pi_off) += i_count;
1103             }
1104         }
1105     }
1106
1107     bs_align( s );
1108 }
1109
1110 static void free_all( decoder_t *p_dec )
1111 {
1112     decoder_sys_t *p_sys = p_dec->p_sys;
1113     dvbsub_region_t *p_reg, *p_reg_next;
1114     dvbsub_clut_t *p_clut, *p_clut_next;
1115
1116     for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut_next )
1117     {
1118         p_clut_next = p_clut->p_next;
1119         free( p_clut );
1120     }
1121     p_sys->p_cluts = NULL;
1122
1123     for( p_reg = p_sys->p_regions; p_reg != NULL; p_reg = p_reg_next )
1124     {
1125         p_reg_next = p_reg->p_next;
1126         if( p_reg->i_object_defs ) free( p_reg->p_object_defs );
1127         if( p_reg->p_pixbuf ) free( p_reg->p_pixbuf );
1128         free( p_reg );
1129     }
1130     p_sys->p_regions = NULL;
1131
1132     if( p_sys->p_page )
1133     {
1134         if( p_sys->p_page->i_region_defs )
1135             free( p_sys->p_page->p_region_defs );
1136         free( p_sys->p_page );
1137     }
1138     p_sys->p_page = NULL;
1139 }
1140
1141 static subpicture_t *render( decoder_t *p_dec )
1142 {
1143     decoder_sys_t *p_sys = p_dec->p_sys;
1144     subpicture_t *p_spu;
1145     subpicture_region_t **pp_spu_region;
1146     int i, j, i_timeout = 0;
1147
1148     /* Allocate the subpicture internal data. */
1149     p_spu = p_dec->pf_spu_buffer_new( p_dec );
1150     if( !p_spu ) return NULL;
1151
1152     pp_spu_region = &p_spu->p_region;
1153
1154     /* Loop on region definitions */
1155 #ifdef DEBUG_DVBSUB
1156     if( p_sys->p_page )
1157         msg_Dbg( p_dec, "rendering %i regions", p_sys->p_page->i_region_defs );
1158 #endif
1159
1160     for( i = 0; p_sys->p_page && i < p_sys->p_page->i_region_defs; i++ )
1161     {
1162         dvbsub_region_t     *p_region;
1163         dvbsub_regiondef_t  *p_regiondef;
1164         dvbsub_clut_t       *p_clut;
1165         dvbsub_color_t      *p_color;
1166         subpicture_region_t *p_spu_region;
1167         uint8_t *p_src, *p_dst;
1168         video_format_t fmt;
1169         int i_pitch;
1170
1171         i_timeout = p_sys->p_page->i_timeout;
1172
1173         p_regiondef = &p_sys->p_page->p_region_defs[i];
1174
1175 #ifdef DEBUG_DVBSUB
1176         msg_Dbg( p_dec, "rendering region %i (%i,%i)", i,
1177                  p_regiondef->i_x, p_regiondef->i_y );
1178 #endif
1179
1180         /* Find associated region */
1181         for( p_region = p_sys->p_regions; p_region != NULL;
1182              p_region = p_region->p_next )
1183         {
1184             if( p_regiondef->i_id == p_region->i_id ) break;
1185         }
1186
1187         if( !p_region )
1188         {
1189             msg_Err( p_dec, "no region founddddd!!!" );
1190             continue;
1191         }
1192
1193         /* Find associated CLUT */
1194         for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut->p_next )
1195         {
1196             if( p_region->i_clut == p_clut->i_id ) break;
1197         }
1198         if( !p_clut )
1199         {
1200             msg_Warn( p_dec, "clut %i not found", p_region->i_clut );
1201             p_clut = &p_sys->default_clut;
1202         }
1203
1204         /* Create new SPU region */
1205         memset( &fmt, 0, sizeof(video_format_t) );
1206         fmt.i_chroma = VLC_FOURCC('Y','U','V','P');
1207         fmt.i_aspect = VOUT_ASPECT_FACTOR;
1208         fmt.i_width = fmt.i_visible_width = p_region->i_width;
1209         fmt.i_height = fmt.i_visible_height = p_region->i_height;
1210         fmt.i_x_offset = fmt.i_y_offset = 0;
1211         p_spu_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
1212         if( !p_region )
1213         {
1214             msg_Err( p_dec, "cannot allocate SPU region" );
1215             continue;
1216         }
1217         p_spu_region->i_x = p_regiondef->i_x;
1218         p_spu_region->i_y = p_regiondef->i_y;
1219         *pp_spu_region = p_spu_region;
1220         pp_spu_region = &p_spu_region->p_next;
1221
1222         /* Build palette */
1223         fmt.p_palette->i_entries = p_region->i_depth == 1 ? 4 :
1224             p_region->i_depth == 2 ? 16 : 256;
1225         p_color = (p_region->i_depth == 1) ? p_clut->c_2b :
1226             (p_region->i_depth == 2) ? p_clut->c_4b : p_clut->c_8b;
1227         for( j = 0; j < fmt.p_palette->i_entries; j++ )
1228         {
1229             fmt.p_palette->palette[j][0] = p_color[j].Y;
1230             fmt.p_palette->palette[j][1] = p_color[j].Cr;
1231             fmt.p_palette->palette[j][2] = p_color[j].Cb;
1232             fmt.p_palette->palette[j][3] = 0xff - p_color[j].T;
1233         }
1234
1235         p_src = p_region->p_pixbuf;
1236         p_dst = p_spu_region->picture.Y_PIXELS;
1237         i_pitch = p_spu_region->picture.Y_PITCH;
1238
1239         /* Copy pixel buffer */
1240         for( j = 0; j < p_region->i_height; j++ )
1241         {
1242             memcpy( p_dst, p_src, p_region->i_width );
1243             p_src += p_region->i_width;
1244             p_dst += i_pitch;
1245         }
1246     }
1247
1248     /* Set the pf_render callback */
1249     p_spu->i_start = p_sys->i_pts;
1250     p_spu->i_stop = p_spu->i_start + i_timeout * 1000000;
1251     p_spu->b_ephemer = VLC_TRUE;
1252
1253     return p_spu;
1254 }
1255
1256 /*****************************************************************************
1257  * encoder_sys_t : encoder descriptor
1258  *****************************************************************************/
1259 struct encoder_sys_t
1260 {
1261     unsigned int i_page_ver;
1262     unsigned int i_region_ver;
1263     unsigned int i_clut_ver;
1264
1265     /*
1266      * Input properties
1267      */
1268     /*
1269      * Common properties
1270      */
1271     mtime_t i_pts;
1272 };
1273
1274 static void encode_page_composition( encoder_t *, bs_t *, subpicture_t * );
1275 static void encode_clut( encoder_t *, bs_t *, subpicture_t * );
1276 static void encode_region_composition( encoder_t *, bs_t *, subpicture_t * );
1277 static void encode_object( encoder_t *, bs_t *, subpicture_t * );
1278
1279 /*****************************************************************************
1280  * OpenEncoder: probe the encoder and return score
1281  *****************************************************************************/
1282 static int OpenEncoder( vlc_object_t *p_this )
1283 {
1284     encoder_t *p_enc = (encoder_t *)p_this;
1285     encoder_sys_t *p_sys;
1286
1287     if( p_enc->fmt_out.i_codec != VLC_FOURCC('d','v','b','s') &&
1288         !p_enc->b_force )
1289     {
1290         return VLC_EGENERIC;
1291     }
1292
1293     /* Allocate the memory needed to store the decoder's structure */
1294     if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
1295     {
1296         msg_Err( p_enc, "out of memory" );
1297         return VLC_EGENERIC;
1298     }
1299     p_enc->p_sys = p_sys;
1300
1301     p_enc->pf_encode_sub = Encode;
1302     p_enc->fmt_out.i_codec = VLC_FOURCC('d','v','b','s');
1303     p_enc->fmt_out.subs.dvb.i_id  = 1 << 16 | 1;
1304
1305     sout_CfgParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
1306
1307     p_sys->i_page_ver = 0;
1308     p_sys->i_region_ver = 0;
1309     p_sys->i_clut_ver = 0;
1310
1311     return VLC_SUCCESS;
1312 }
1313
1314 /****************************************************************************
1315  * Encode: the whole thing
1316  ****************************************************************************/
1317 static block_t *Encode( encoder_t *p_enc, subpicture_t *p_subpic )
1318 {
1319     bs_t bits, *s = &bits;
1320     block_t *p_block;
1321
1322     if( !p_subpic || !p_subpic->p_region ) return 0;
1323
1324     msg_Dbg( p_enc, "encoding subpicture" );
1325
1326     p_block = block_New( p_enc, 64000 );
1327     bs_init( s, p_block->p_buffer, p_block->i_buffer );
1328
1329     bs_write( s, 8, 0x20 ); /* Data identifier */
1330     bs_write( s, 8, 0x0 ); /* Subtitle stream id */
1331
1332     encode_page_composition( p_enc, s, p_subpic );
1333     encode_region_composition( p_enc, s, p_subpic );
1334     encode_clut( p_enc, s, p_subpic );
1335     encode_object( p_enc, s, p_subpic );
1336
1337     /* End of display */
1338     bs_write( s, 8, 0x0f ); /* Sync byte */
1339     bs_write( s, 8, DVBSUB_ST_ENDOFDISPLAY ); /* Segment type */
1340     bs_write( s, 16, 1 ); /* Page id */
1341     bs_write( s, 16, 0 ); /* Segment length */
1342
1343     bs_write( s, 8, 0xff ); /* End marker */
1344     p_block->i_buffer = bs_pos( s ) / 8;
1345     p_block->i_pts = p_block->i_dts = p_subpic->i_start;
1346     if( !p_subpic->b_ephemer && p_subpic->i_stop )
1347         p_block->i_length = p_subpic->i_stop - p_subpic->i_start;
1348
1349     msg_Dbg( p_enc, "subpicture encoded properly" );
1350
1351     return p_block;
1352 }
1353
1354 /*****************************************************************************
1355  * CloseEncoder: encoder destruction
1356  *****************************************************************************/
1357 static void CloseEncoder( vlc_object_t *p_this )
1358 {
1359     encoder_t *p_enc = (encoder_t *)p_this;
1360     encoder_sys_t *p_sys = p_enc->p_sys;
1361
1362     free( p_sys );
1363 }
1364
1365 static void encode_page_composition( encoder_t *p_enc, bs_t *s,
1366                                      subpicture_t *p_subpic )
1367 {
1368     encoder_sys_t *p_sys = p_enc->p_sys;
1369     subpicture_region_t *p_region;
1370     int i_regions;
1371
1372     bs_write( s, 8, 0x0f ); /* Sync byte */
1373     bs_write( s, 8, DVBSUB_ST_PAGE_COMPOSITION ); /* Segment type */
1374     bs_write( s, 16, 1 ); /* Page id */
1375
1376     for( i_regions = 0, p_region = p_subpic->p_region; p_region;
1377          p_region = p_region->p_next, i_regions++ );
1378
1379     bs_write( s, 16, i_regions * 6 + 2 ); /* Segment length */
1380
1381     bs_write( s, 8, 5 ); /* Timeout */
1382     bs_write( s, 4, p_sys->i_page_ver++ );
1383     bs_write( s, 2, DVBSUB_PCS_STATE_ACQUISITION );
1384     bs_write( s, 2, 0 ); /* Reserved */
1385
1386     for( i_regions = 0, p_region = p_subpic->p_region; p_region;
1387          p_region = p_region->p_next, i_regions++ )
1388     {
1389         bs_write( s, 8, i_regions );
1390         bs_write( s, 8, 0 ); /* Reserved */
1391         bs_write( s, 16, p_region->i_x );
1392         bs_write( s, 16, p_region->i_y );
1393     }
1394 }
1395
1396 static void encode_clut( encoder_t *p_enc, bs_t *s, subpicture_t *p_subpic )
1397 {
1398     encoder_sys_t *p_sys = p_enc->p_sys;
1399     subpicture_region_t *p_region = p_subpic->p_region;
1400     video_palette_t *p_pal;
1401     int i;
1402
1403     /* Sanity check */
1404     if( !p_region || !p_region->fmt.p_palette ||
1405         p_region->fmt.i_chroma != VLC_FOURCC('Y','U','V','P') ) return;
1406
1407     bs_write( s, 8, 0x0f ); /* Sync byte */
1408     bs_write( s, 8, DVBSUB_ST_CLUT_DEFINITION ); /* Segment type */
1409     bs_write( s, 16, 1 ); /* Page id */
1410
1411     p_pal = p_region->fmt.p_palette;
1412
1413     bs_write( s, 16, p_pal->i_entries * 6 + 2 ); /* Segment length */
1414     bs_write( s, 8, 1 ); /* Clut id */
1415     bs_write( s, 4, p_sys->i_clut_ver++ );
1416     bs_write( s, 4, 0 ); /* Reserved */
1417
1418     for( i = 0; i < p_pal->i_entries; i++ )
1419     {
1420         bs_write( s, 8, i ); /* Clut entry id */
1421         bs_write( s, 1, p_pal->i_entries == 4 );   /* 2bit/entry flag */
1422         bs_write( s, 1, p_pal->i_entries == 16 );  /* 4bit/entry flag */
1423         bs_write( s, 1, p_pal->i_entries == 256 ); /* 8bit/entry flag */
1424         bs_write( s, 4, 0 ); /* Reserved */
1425         bs_write( s, 1, 1 ); /* Full range flag */
1426         bs_write( s, 8, p_pal->palette[i][0] ); /* Y value */
1427         bs_write( s, 8, p_pal->palette[i][1] ); /* Cr value */
1428         bs_write( s, 8, p_pal->palette[i][2] ); /* Cb value */
1429         bs_write( s, 8, 0xff - p_pal->palette[i][3] ); /* T value */
1430     }
1431 }
1432
1433 static void encode_region_composition( encoder_t *p_enc, bs_t *s,
1434                                        subpicture_t *p_subpic )
1435 {
1436     encoder_sys_t *p_sys = p_enc->p_sys;
1437     subpicture_region_t *p_region;
1438     int i_regions;
1439
1440     for( i_regions = 0, p_region = p_subpic->p_region; p_region;
1441          p_region = p_region->p_next, i_regions++ )
1442     {
1443         video_palette_t *p_pal = p_region->fmt.p_palette;
1444         int i_depth = p_pal->i_entries == 4 ? 0x1 :
1445             p_pal->i_entries == 16 ? 0x2 : 0x3;
1446
1447         bs_write( s, 8, 0x0f ); /* Sync byte */
1448         bs_write( s, 8, DVBSUB_ST_REGION_COMPOSITION ); /* Segment type */
1449         bs_write( s, 16, 1 ); /* Page id */
1450
1451         bs_write( s, 16, 10 + 6 ); /* Segment length */
1452         bs_write( s, 8, i_regions );
1453         bs_write( s, 4, p_sys->i_region_ver++ );
1454
1455         /* Region attributes */
1456         bs_write( s, 1, 0 ); /* Fill */
1457         bs_write( s, 3, 0 ); /* Reserved */
1458         bs_write( s, 16, p_region->fmt.i_visible_width );
1459         bs_write( s, 16, p_region->fmt.i_visible_height );
1460         bs_write( s, 3, i_depth );  /* Region level of compatibility */
1461         bs_write( s, 3, i_depth  ); /* Region depth */
1462         bs_write( s, 2, 0 ); /* Reserved */
1463         bs_write( s, 8, 1 ); /* Clut id */
1464         bs_write( s, 8, 0 ); /* region 8bit pixel code */
1465         bs_write( s, 4, 0 ); /* region 4bit pixel code */
1466         bs_write( s, 2, 0 ); /* region 2bit pixel code */
1467         bs_write( s, 2, 0 ); /* Reserved */
1468
1469         /* In our implementation we only have 1 object per region */
1470         bs_write( s, 16, i_regions );
1471         bs_write( s, 2, DVBSUB_OT_BASIC_BITMAP );
1472         bs_write( s, 2, 0 ); /* object provider flag */
1473         bs_write( s, 12, 0 ); /* object horizontal position */
1474         bs_write( s, 4, 0 ); /* Reserved */
1475         bs_write( s, 12, 0 ); /* object vertical position */
1476     }
1477 }
1478
1479 static void encode_pixel_data( encoder_t *p_enc, bs_t *s,
1480                                subpicture_region_t *p_region,
1481                                vlc_bool_t b_top );
1482
1483 static void encode_object( encoder_t *p_enc, bs_t *s, subpicture_t *p_subpic )
1484 {
1485     encoder_sys_t   *p_sys = p_enc->p_sys;
1486     subpicture_region_t *p_region;
1487     int i_regions;
1488
1489     int i_length_pos, i_update_pos, i_pixel_data_pos;
1490
1491     for( i_regions = 0, p_region = p_subpic->p_region; p_region;
1492          p_region = p_region->p_next, i_regions++ )
1493     {
1494         bs_write( s, 8, 0x0f ); /* Sync byte */
1495         bs_write( s, 8, DVBSUB_ST_OBJECT_DATA ); /* Segment type */
1496         bs_write( s, 16, 1 ); /* Page id */
1497
1498         i_length_pos = bs_pos( s );
1499         bs_write( s, 16, 0 ); /* Segment length */
1500         bs_write( s, 16, i_regions ); /* Object id */
1501         bs_write( s, 4, p_sys->i_region_ver++ );
1502         bs_write( s, 2, 0 ); /* object coding method */
1503
1504         bs_write( s, 1, 0 ); /* non modifying color flag */
1505         bs_write( s, 1, 0 ); /* Reserved */
1506
1507         i_update_pos = bs_pos( s );
1508         bs_write( s, 16, 0 ); /* topfield data block length */
1509         bs_write( s, 16, 0 ); /* bottomfield data block length */
1510
1511         /* Top field */
1512         i_pixel_data_pos = bs_pos( s );
1513         encode_pixel_data( p_enc, s, p_region, VLC_TRUE );
1514         i_pixel_data_pos = ( bs_pos( s ) - i_pixel_data_pos ) / 8;
1515         SetWBE( &s->p_start[i_update_pos/8], i_pixel_data_pos );
1516
1517         /* Bottom field */
1518         i_pixel_data_pos = bs_pos( s );
1519         encode_pixel_data( p_enc, s, p_region, VLC_FALSE );
1520         i_pixel_data_pos = ( bs_pos( s ) - i_pixel_data_pos ) / 8;
1521         SetWBE( &s->p_start[i_update_pos/8+2], i_pixel_data_pos );
1522
1523         /* Stuffing for word alignment */
1524         bs_align_0( s );
1525         if( bs_pos( s ) % 16 ) bs_write( s, 8, 0 );
1526
1527         /* Update segment length */
1528         SetWBE( &s->p_start[i_length_pos/8], (bs_pos(s) - i_length_pos)/8 -2 );
1529     }
1530 }
1531
1532 static void encode_pixel_line_2bp( encoder_t *p_enc, bs_t *s,
1533                                    subpicture_region_t *p_region,
1534                                    int i_line );
1535 static void encode_pixel_line_4bp( encoder_t *p_enc, bs_t *s,
1536                                    subpicture_region_t *p_region,
1537                                    int i_line );
1538 static void encode_pixel_data( encoder_t *p_enc, bs_t *s,
1539                                subpicture_region_t *p_region,
1540                                vlc_bool_t b_top )
1541 {
1542     unsigned int i_line;
1543
1544     /* Sanity check */
1545     if( p_region->fmt.i_chroma != VLC_FOURCC('Y','U','V','P') ) return;
1546
1547     /* Encode line by line */
1548     for( i_line = !b_top; i_line < p_region->fmt.i_visible_height;
1549          i_line += 2 )
1550     {
1551         switch( p_region->fmt.p_palette->i_entries )
1552         {
1553         case 4:
1554             bs_write( s, 8, 0x10 ); /* 2 bit/pixel code string */
1555             encode_pixel_line_2bp( p_enc, s, p_region, i_line );
1556             break;
1557
1558         case 16:
1559             bs_write( s, 8, 0x11 ); /* 4 bit/pixel code string */
1560             encode_pixel_line_4bp( p_enc, s, p_region, i_line );
1561             break;
1562
1563         default:
1564             msg_Err( p_enc, "subpicture palette (%i) not handled",
1565                      p_region->fmt.p_palette->i_entries );
1566             break;
1567         }
1568
1569         bs_write( s, 8, 0xf0 ); /* End of object line code */
1570     }
1571 }
1572
1573 static void encode_pixel_line_2bp( encoder_t *p_enc, bs_t *s,
1574                                    subpicture_region_t *p_region,
1575                                    int i_line )
1576 {
1577     unsigned int i, i_length = 0;
1578     int i_pitch = p_region->picture.p->i_pitch;
1579     uint8_t *p_data = &p_region->picture.p->p_pixels[ i_pitch * i_line ];
1580     int i_last_pixel = p_data[0];
1581
1582     for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
1583     {
1584         if( i != p_region->fmt.i_visible_width &&
1585             p_data[i] == i_last_pixel && i_length != 284 )
1586         {
1587             i_length++;
1588             continue;
1589         }
1590
1591         if( i_length == 1 || i_length == 11 || i_length == 28 )
1592         {
1593             /* 2bit/pixel code */
1594             if( i_last_pixel ) bs_write( s, 2, i_last_pixel );
1595             else
1596             {
1597                 bs_write( s, 2, 0 );
1598                 bs_write( s, 1, 0 );
1599                 bs_write( s, 1, 1 ); /* pseudo color 0 */
1600             }
1601             i_length--;
1602         }
1603
1604         if( i_length == 2 )
1605         {
1606             if( i_last_pixel )
1607             {
1608                 bs_write( s, 2, i_last_pixel );
1609                 bs_write( s, 2, i_last_pixel );
1610             }
1611             else
1612             {
1613                 bs_write( s, 2, 0 );
1614                 bs_write( s, 1, 0 );
1615                 bs_write( s, 1, 0 );
1616                 bs_write( s, 2, 1 ); /* 2 * pseudo color 0 */
1617             }
1618         }
1619         else if( i_length > 2 )
1620         {
1621             bs_write( s, 2, 0 );
1622             if( i_length <= 10 )
1623             {
1624                 bs_write( s, 1, 1 );
1625                 bs_write( s, 3, i_length - 3 );
1626                 bs_write( s, 2, i_last_pixel );
1627             }
1628             else
1629             {
1630                 bs_write( s, 1, 0 );
1631                 bs_write( s, 1, 0 );
1632
1633                 if( i_length <= 27 )
1634                 {
1635                     bs_write( s, 2, 2 );
1636                     bs_write( s, 4, i_length - 12 );
1637                     bs_write( s, 2, i_last_pixel );
1638                 }
1639                 else
1640                 {
1641                     bs_write( s, 2, 3 );
1642                     bs_write( s, 8, i_length - 29 );
1643                     bs_write( s, 2, i_last_pixel );
1644                 }
1645             }
1646         }
1647
1648         if( i == p_region->fmt.i_visible_width ) break;
1649
1650         i_last_pixel = p_data[i];
1651         i_length = 1;
1652     }
1653
1654     /* Stop */
1655     bs_write( s, 2, 0 );
1656     bs_write( s, 1, 0 );
1657     bs_write( s, 1, 0 );
1658     bs_write( s, 2, 0 );
1659
1660     /* Stuffing */
1661     bs_align_0( s );
1662 }
1663
1664 static void encode_pixel_line_4bp( encoder_t *p_enc, bs_t *s,
1665                                    subpicture_region_t *p_region,
1666                                    int i_line )
1667 {
1668     unsigned int i, i_length = 0;
1669     int i_pitch = p_region->picture.p->i_pitch;
1670     uint8_t *p_data = &p_region->picture.p->p_pixels[ i_pitch * i_line ];
1671     int i_last_pixel = p_data[0];
1672
1673     for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
1674     {
1675         if( i != p_region->fmt.i_visible_width &&
1676             p_data[i] == i_last_pixel && i_length != 1 )
1677         {
1678             i_length++;
1679             continue;
1680         }
1681
1682         if( i_length == 1 )
1683         {
1684             /* 4bit/pixel code */
1685             if( i_last_pixel ) bs_write( s, 4, i_last_pixel );
1686             else
1687             {
1688                 bs_write( s, 4, 0 );
1689                 bs_write( s, 1, 1 );
1690                 bs_write( s, 1, 1 );
1691                 bs_write( s, 2, 0 ); /* pseudo color 0 */
1692             }
1693         }
1694
1695         if( i == p_region->fmt.i_visible_width ) break;
1696
1697         i_last_pixel = p_data[i];
1698         i_length = 1;
1699     }
1700
1701     /* Stop */
1702     bs_write( s, 8, 0 );
1703
1704     /* Stuffing */
1705     bs_align_0( s );
1706 }