]> git.sesse.net Git - vlc/blob - modules/codec/dvbsub.c
Forward port of branches/0.8.1-jpsaman-thedj revision 12070. The OSD menu subsystem...
[vlc] / 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-2005 VideoLAN (Centrale Réseaux) and its contributors
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  *          Jean-Paul Saman <jpsaman #_at_# m2x dot nl> 
13  *
14  * This program is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or
17  * (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
27  *****************************************************************************/
28 /*****************************************************************************
29  * Preamble
30  *
31  * FIXME:
32  * DVB subtitles coded as strings of characters are not handled correctly.
33  * The character codes in the string should actually be indexes refering to a
34  * character table identified in the subtitle descriptor.
35  *****************************************************************************/
36 #include <vlc/vlc.h>
37 #include <vlc/vout.h>
38 #include <vlc/decoder.h>
39 #include <vlc/sout.h>
40
41 #include "vlc_bits.h"
42
43 /* #define DEBUG_DVBSUB 1 */
44
45 #define POSX_TEXT N_("X coordinate of the subpicture")
46 #define POSX_LONGTEXT N_("You can reposition the subpicture by providing another value here." )
47  
48 #define POSY_TEXT N_("Y coordinate of the subpicture")
49 #define POSY_LONGTEXT N_("You can reposition the subpicture by providing another value here." )
50
51 #define POS_TEXT N_("Subpicture position")
52 #define POS_LONGTEXT N_( \
53   "You can enforce the subpicture position on the video " \
54   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
55   "also use combinations of these values).")
56
57 #define ENC_POSX_TEXT N_("X coordinate of the encoded subpicture")
58 #define ENC_POSX_LONGTEXT N_("You can reposition the subpicture by providing another value here." )
59
60 #define ENC_POSY_TEXT N_("Y coordinate of encoded the subpicture")
61 #define ENC_POSY_LONGTEXT N_("You can reposition the subpicture by providing another value here." )
62
63 #define TIMEOUT_TEXT N_("Timeout of subpictures")
64 #define TIMEOUT_LONGTEXT N_( \
65     "Subpictures get a default timeout of 15 seconds added to their remaining time." \
66     "This will ensure that they are at least the specified time visible.")
67
68 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
69 static char *ppsz_pos_descriptions[] =
70 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
71   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
72
73 /*****************************************************************************
74  * Module descriptor.
75  *****************************************************************************/
76 static int  Open ( vlc_object_t * );
77 static void Close( vlc_object_t * );
78 static subpicture_t *Decode( decoder_t *, block_t ** );
79
80 static int OpenEncoder  ( vlc_object_t * );
81 static void CloseEncoder( vlc_object_t * );
82 static block_t *Encode  ( encoder_t *, subpicture_t * );
83
84 vlc_module_begin();
85 #   define DVBSUB_CFG_PREFIX "dvbsub-"
86     set_description( _("DVB subtitles decoder") );
87     set_capability( "decoder", 50 );
88     set_category( CAT_INPUT );
89     set_subcategory( SUBCAT_INPUT_SCODEC );
90     set_callbacks( Open, Close );
91     
92     add_integer( DVBSUB_CFG_PREFIX "position", 8, NULL, POS_TEXT, POS_LONGTEXT, VLC_TRUE );
93         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
94     add_integer( DVBSUB_CFG_PREFIX "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, VLC_FALSE );
95     add_integer( DVBSUB_CFG_PREFIX "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, VLC_FALSE );    
96
97 #   define ENC_CFG_PREFIX "sout-dvbsub-"
98     add_submodule();
99     set_description( _("DVB subtitles encoder") );
100     set_capability( "encoder", 100 );
101     set_callbacks( OpenEncoder, CloseEncoder );
102     
103     add_integer( ENC_CFG_PREFIX "x", -1, NULL, ENC_POSX_TEXT, ENC_POSX_LONGTEXT, VLC_FALSE );
104     add_integer( ENC_CFG_PREFIX "y", -1, NULL, ENC_POSY_TEXT, ENC_POSY_LONGTEXT, VLC_FALSE );
105     add_integer( ENC_CFG_PREFIX "timeout", 15, NULL, TIMEOUT_TEXT, TIMEOUT_LONGTEXT, VLC_FALSE );    
106 vlc_module_end();
107
108 static const char *ppsz_enc_options[] = { NULL };
109
110 /****************************************************************************
111  * Local structures
112  ****************************************************************************
113  * Those structures refer closely to the ETSI 300 743 Object model
114  ****************************************************************************/
115
116 /* The object definition gives the position of the object in a region */
117 typedef struct dvbsub_objectdef_s
118 {
119     int i_id;
120     int i_type;
121     int i_x;
122     int i_y;
123     int i_fg_pc;
124     int i_bg_pc;
125     char *psz_text; /* for string of characters objects */
126
127 } dvbsub_objectdef_t;
128
129 /* The entry in the palette CLUT */
130 typedef struct
131 {
132     uint8_t                 Y;
133     uint8_t                 Cr;
134     uint8_t                 Cb;
135     uint8_t                 T;
136
137 } dvbsub_color_t;
138
139 /* */
140 typedef struct dvbsub_clut_s
141 {
142     uint8_t                 i_id;
143     uint8_t                 i_version;
144     dvbsub_color_t          c_2b[4];
145     dvbsub_color_t          c_4b[16];
146     dvbsub_color_t          c_8b[256];
147
148     struct dvbsub_clut_s    *p_next;
149
150 } dvbsub_clut_t;
151
152 /* The Region is an aera on the image
153  * with a list of the object definitions associated and a CLUT */
154 typedef struct dvbsub_region_s
155 {
156     int i_id;
157     int i_version;
158     int i_x;
159     int i_y;
160     int i_width;
161     int i_height;
162     int i_level_comp;
163     int i_depth;
164     int i_clut;
165
166     uint8_t *p_pixbuf;
167
168     int                    i_object_defs;
169     dvbsub_objectdef_t     *p_object_defs;
170
171     struct dvbsub_region_s *p_next;
172
173 } dvbsub_region_t;
174
175 /* The object definition gives the position of the object in a region */
176 typedef struct dvbsub_regiondef_s
177 {
178     int i_id;
179     int i_x;
180     int i_y;
181
182 } dvbsub_regiondef_t;
183
184 /* The page defines the list of regions */
185 typedef struct
186 {
187     int i_id;
188     int i_timeout; /* in seconds */
189     int i_state;
190     int i_version;
191
192     int                i_region_defs;
193     dvbsub_regiondef_t *p_region_defs;
194
195 } dvbsub_page_t;
196
197 struct decoder_sys_t
198 {
199     bs_t            bs;
200
201     /* Decoder internal data */
202     int             i_id;
203     int             i_ancillary_id;
204     mtime_t         i_pts;
205
206     vlc_bool_t      b_absolute;
207     int             i_spu_position;
208     int             i_spu_x;
209     int             i_spu_y;
210     
211     vlc_bool_t      b_page;
212     dvbsub_page_t   *p_page;
213     dvbsub_region_t *p_regions;
214     dvbsub_clut_t   *p_cluts;
215     dvbsub_clut_t   default_clut;
216 };
217
218
219 // List of different SEGMENT TYPES
220 // According to EN 300-743, table 2
221 #define DVBSUB_ST_PAGE_COMPOSITION      0x10
222 #define DVBSUB_ST_REGION_COMPOSITION    0x11
223 #define DVBSUB_ST_CLUT_DEFINITION       0x12
224 #define DVBSUB_ST_OBJECT_DATA           0x13
225 #define DVBSUB_ST_ENDOFDISPLAY          0x80
226 #define DVBSUB_ST_STUFFING              0xff
227 // List of different OBJECT TYPES
228 // According to EN 300-743, table 6
229 #define DVBSUB_OT_BASIC_BITMAP          0x00
230 #define DVBSUB_OT_BASIC_CHAR            0x01
231 #define DVBSUB_OT_COMPOSITE_STRING      0x02
232 // Pixel DATA TYPES
233 // According to EN 300-743, table 9
234 #define DVBSUB_DT_2BP_CODE_STRING       0x10
235 #define DVBSUB_DT_4BP_CODE_STRING       0x11
236 #define DVBSUB_DT_8BP_CODE_STRING       0x12
237 #define DVBSUB_DT_24_TABLE_DATA         0x20
238 #define DVBSUB_DT_28_TABLE_DATA         0x21
239 #define DVBSUB_DT_48_TABLE_DATA         0x22
240 #define DVBSUB_DT_END_LINE              0xf0
241 // List of different Page Composition Segment state
242 // According to EN 300-743, 7.2.1 table 3
243 #define DVBSUB_PCS_STATE_ACQUISITION    0x01
244 #define DVBSUB_PCS_STATE_CHANGE         0x10
245
246 /*****************************************************************************
247  * Local prototypes
248  *****************************************************************************/
249 static void decode_segment( decoder_t *, bs_t * );
250 static void decode_page_composition( decoder_t *, bs_t * );
251 static void decode_region_composition( decoder_t *, bs_t * );
252 static void decode_object( decoder_t *, bs_t * );
253 static void decode_clut( decoder_t *, bs_t * );
254 static void free_all( decoder_t * );
255
256 static void default_clut_init( decoder_t * );
257
258 static subpicture_t *render( decoder_t * );
259
260 /*****************************************************************************
261  * Open: probe the decoder and return score
262  *****************************************************************************
263  * Tries to launch a decoder and return score so that the interface is able
264  * to chose.
265  *****************************************************************************/
266 static int Open( vlc_object_t *p_this )
267 {
268     decoder_t     *p_dec = (decoder_t *) p_this;
269     decoder_sys_t *p_sys;
270     vlc_value_t    val;
271     int posx, posy;    
272
273     if( p_dec->fmt_in.i_codec != VLC_FOURCC('d','v','b','s') )
274     {
275         return VLC_EGENERIC;
276     }
277
278     p_dec->pf_decode_sub = Decode;
279     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
280     memset( p_sys, 0, sizeof(decoder_sys_t) );
281
282     p_sys->i_pts          = (mtime_t) 0;    
283     p_sys->i_id           = p_dec->fmt_in.subs.dvb.i_id & 0xFFFF;
284     p_sys->i_ancillary_id = p_dec->fmt_in.subs.dvb.i_id >> 16;
285
286     p_sys->p_regions      = NULL;
287     p_sys->p_cluts        = NULL;
288     p_sys->p_page         = NULL;
289    
290     var_Create( p_this, DVBSUB_CFG_PREFIX "position", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
291     var_Get( p_this, DVBSUB_CFG_PREFIX "position", &val );
292     p_sys->i_spu_position = val.i_int;
293     var_Create( p_this, DVBSUB_CFG_PREFIX "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
294     var_Get( p_this, DVBSUB_CFG_PREFIX "x", &val );
295     posx = val.i_int;
296     var_Create( p_this, DVBSUB_CFG_PREFIX "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
297     var_Get( p_this, DVBSUB_CFG_PREFIX "y", &val );
298     posy = val.i_int;
299  
300     /* Check if subpicture position was overridden */
301     p_sys->b_absolute = VLC_TRUE;
302     if( posx < 0 || posy < 0)
303     {
304         p_sys->b_absolute = VLC_FALSE;
305         p_sys->i_spu_x = 0;
306         p_sys->i_spu_y = 0;
307     }
308     else if( posx >= 0 || posy >= 0 )
309     {
310         p_sys->i_spu_x = posx;
311         p_sys->i_spu_y = posy;
312     }
313     else if( p_sys->i_spu_x < 0 || p_sys->i_spu_y < 0 )
314     {
315         p_sys->b_absolute = VLC_FALSE;
316         p_sys->i_spu_x = 0;
317         p_sys->i_spu_y = 0;
318     }
319     
320     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 'd','v','b','s' ) );
321
322     default_clut_init( p_dec );
323
324     return VLC_SUCCESS;
325 }
326
327 /*****************************************************************************
328  * Close:
329  *****************************************************************************/
330 static void Close( vlc_object_t *p_this )
331 {
332     decoder_t     *p_dec = (decoder_t*) p_this;
333     decoder_sys_t *p_sys = p_dec->p_sys;
334
335     var_Destroy( p_this, DVBSUB_CFG_PREFIX "x" );
336     var_Destroy( p_this, DVBSUB_CFG_PREFIX "y" );
337     var_Destroy( p_this, DVBSUB_CFG_PREFIX "position" );    
338     
339     free_all( p_dec );
340     free( p_sys );
341 }
342
343 /*****************************************************************************
344  * Decode:
345  *****************************************************************************/
346 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
347 {
348     decoder_sys_t *p_sys = p_dec->p_sys;
349     block_t       *p_block;
350     subpicture_t  *p_spu = NULL;
351
352     if( pp_block == NULL || *pp_block == NULL ) return NULL;
353     p_block = *pp_block;
354     *pp_block = NULL;
355
356     p_sys->i_pts = p_block->i_pts;
357     if( p_sys->i_pts <= 0 )
358     {
359 #ifdef DEBUG_DVBSUB
360         /* Some DVB channels send stuffing segments in non-dated packets so
361          * don't complain too loudly. */
362         msg_Warn( p_dec, "non dated subtitle" );
363 #endif
364         block_Release( p_block );
365         return NULL;
366     }
367
368     bs_init( &p_sys->bs, p_block->p_buffer, p_block->i_buffer );
369
370     if( bs_read( &p_sys->bs, 8 ) != 0x20 ) /* Data identifier */
371     {
372         msg_Dbg( p_dec, "invalid data identifier" );
373         block_Release( p_block );
374         return NULL;
375     }
376
377     if( bs_read( &p_sys->bs, 8 ) ) /* Subtitle stream id */
378     {
379         msg_Dbg( p_dec, "invalid subtitle stream id" );
380         block_Release( p_block );
381         return NULL;
382     }
383
384 #ifdef DEBUG_DVBSUB
385     msg_Dbg( p_dec, "subtitle packet received: "I64Fd, p_sys->i_pts );
386 #endif
387
388     p_sys->b_page = VLC_FALSE;
389     while( bs_show( &p_sys->bs, 8 ) == 0x0f ) /* Sync byte */
390     {
391         decode_segment( p_dec, &p_sys->bs );
392     }
393
394     if( bs_read( &p_sys->bs, 8 ) != 0xff ) /* End marker */
395     {
396         msg_Warn( p_dec, "end marker not found (corrupted subtitle ?)" );
397         block_Release( p_block );
398         return NULL;
399     }
400
401     /* Check if the page is to be displayed */
402     if( p_sys->p_page && p_sys->b_page ) p_spu = render( p_dec );
403
404     block_Release( p_block );
405
406     return p_spu;
407 }
408
409 /* following functions are local */
410
411 /*****************************************************************************
412  * default_clut_init: default clut as defined in EN 300-743 section 10
413  *****************************************************************************/
414 static void default_clut_init( decoder_t *p_dec )
415 {
416     decoder_sys_t *p_sys = p_dec->p_sys;
417     uint8_t i;
418
419 #define RGB_TO_Y(r, g, b) ((int16_t) 77 * r + 150 * g + 29 * b) / 256;
420 #define RGB_TO_U(r, g, b) ((int16_t) -44 * r - 87 * g + 131 * b) / 256;
421 #define RGB_TO_V(r, g, b) ((int16_t) 131 * r - 110 * g - 21 * b) / 256;
422
423     /* 4 entries CLUT */
424     for( i = 0; i < 4; i++ )
425     {
426         uint8_t R = 0, G = 0, B = 0, T = 0;
427
428         if( !(i & 0x2) && !(i & 0x1) ) T = 0xFF;
429         else if( !(i & 0x2) && (i & 0x1) ) R = G = B = 0xFF;
430         else if( (i & 0x2) && !(i & 0x1) ) R = G = B = 0;
431         else R = G = B = 0x7F;
432
433         p_sys->default_clut.c_2b[i].Y = RGB_TO_Y(R,G,B);
434         p_sys->default_clut.c_2b[i].Cr = RGB_TO_U(R,G,B);
435         p_sys->default_clut.c_2b[i].Cb = RGB_TO_V(R,G,B);
436         p_sys->default_clut.c_2b[i].T = T;
437     }
438
439     /* 16 entries CLUT */
440     for( i = 0; i < 16; i++ )
441     {
442         uint8_t R = 0, G = 0, B = 0, T = 0;
443
444         if( !(i & 0x8) )
445         {
446             if( !(i & 0x4) && !(i & 0x2) && !(i & 0x1) )
447             {
448                 T = 0xFF;
449             }
450             else
451             {
452                 R = (i & 0x1) ? 0xFF : 0;
453                 G = (i & 0x2) ? 0xFF : 0;
454                 B = (i & 0x4) ? 0xFF : 0;
455             }
456         }
457         else
458         {
459             R = (i & 0x1) ? 0x7F : 0;
460             G = (i & 0x2) ? 0x7F : 0;
461             B = (i & 0x4) ? 0x7F : 0;
462         }
463
464         p_sys->default_clut.c_4b[i].Y = RGB_TO_Y(R,G,B);
465         p_sys->default_clut.c_4b[i].Cr = RGB_TO_U(R,G,B);
466         p_sys->default_clut.c_4b[i].Cb = RGB_TO_V(R,G,B);
467         p_sys->default_clut.c_4b[i].T = T;
468     }
469
470     /* 256 entries CLUT */
471     memset( p_sys->default_clut.c_8b, 0xFF, 256 * sizeof(dvbsub_color_t) );
472 }
473
474 static void decode_segment( decoder_t *p_dec, bs_t *s )
475 {
476     decoder_sys_t *p_sys = p_dec->p_sys;
477     int i_type;
478     int i_page_id;
479     int i_size;
480
481     /* sync_byte (already checked) */
482     bs_skip( s, 8 );
483
484     /* segment type */
485     i_type = bs_read( s, 8 );
486
487     /* page id */
488     i_page_id = bs_read( s, 16 );
489
490     /* segment size */
491     i_size = bs_show( s, 16 );
492
493     if( i_page_id != p_sys->i_id && i_page_id != p_sys->i_ancillary_id )
494     {
495 #ifdef DEBUG_DVBSUB
496         msg_Dbg( p_dec, "subtitle skipped (page id: %i, %i)",
497                  i_page_id, p_sys->i_id );
498 #endif
499         bs_skip( s,  8 * ( 2 + i_size ) );
500         return;
501     }
502
503     if( p_sys->i_ancillary_id != p_sys->i_id &&
504         i_type == DVBSUB_ST_PAGE_COMPOSITION &&
505         i_page_id == p_sys->i_ancillary_id )
506     {
507 #ifdef DEBUG_DVBSUB
508         msg_Dbg( p_dec, "skipped invalid ancillary subtitle packet" );
509 #endif
510         bs_skip( s,  8 * ( 2 + i_size ) );
511         return;
512     }
513
514 #ifdef DEBUG_DVBSUB
515     if( i_page_id == p_sys->i_id )
516         msg_Dbg( p_dec, "segment (id: %i)", i_page_id );
517     else
518         msg_Dbg( p_dec, "ancillary segment (id: %i)", i_page_id );
519 #endif
520
521     switch( i_type )
522     {
523     case DVBSUB_ST_PAGE_COMPOSITION:
524 #ifdef DEBUG_DVBSUB
525         msg_Dbg( p_dec, "decode_page_composition" );
526 #endif
527         decode_page_composition( p_dec, s );
528         break;
529
530     case DVBSUB_ST_REGION_COMPOSITION:
531 #ifdef DEBUG_DVBSUB
532         msg_Dbg( p_dec, "decode_region_composition" );
533 #endif
534         decode_region_composition( p_dec, s );
535         break;
536
537     case DVBSUB_ST_CLUT_DEFINITION:
538 #ifdef DEBUG_DVBSUB
539         msg_Dbg( p_dec, "decode_clut" );
540 #endif
541         decode_clut( p_dec, s );
542         break;
543
544     case DVBSUB_ST_OBJECT_DATA:
545 #ifdef DEBUG_DVBSUB
546         msg_Dbg( p_dec, "decode_object" );
547 #endif
548         decode_object( p_dec, s );
549         break;
550
551     case DVBSUB_ST_ENDOFDISPLAY:
552 #ifdef DEBUG_DVBSUB
553         msg_Dbg( p_dec, "end of display" );
554 #endif
555         bs_skip( s,  8 * ( 2 + i_size ) );
556         break;
557
558     case DVBSUB_ST_STUFFING:
559 #ifdef DEBUG_DVBSUB
560         msg_Dbg( p_dec, "skip stuffing" );
561 #endif
562         bs_skip( s,  8 * ( 2 + i_size ) );
563         break;
564
565     default:
566         msg_Warn( p_dec, "unsupported segment type: (%04x)", i_type );
567         bs_skip( s,  8 * ( 2 + i_size ) );
568         break;
569     }
570 }
571
572 static void decode_clut( decoder_t *p_dec, bs_t *s )
573 {
574     decoder_sys_t *p_sys = p_dec->p_sys;
575     uint16_t      i_segment_length;
576     uint16_t      i_processed_length;
577     dvbsub_clut_t *p_clut, *p_next;
578     int           i_id, i_version;
579
580     i_segment_length = bs_read( s, 16 );
581     i_id             = bs_read( s, 8 );
582     i_version        = bs_read( s, 4 );
583
584     /* Check if we already have this clut */
585     for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut->p_next )
586     {
587         if( p_clut->i_id == i_id ) break;
588     }
589
590     /* Check version number */
591     if( p_clut && p_clut->i_version == i_version )
592     {
593         /* Nothing to do */
594         bs_skip( s, 8 * i_segment_length - 12 );
595         return;
596     }
597
598     if( !p_clut )
599     {
600 #ifdef DEBUG_DVBSUB
601         msg_Dbg( p_dec, "new clut: %i", i_id );
602 #endif
603         p_clut = malloc( sizeof(dvbsub_clut_t) );
604         p_clut->p_next = p_sys->p_cluts;
605         p_sys->p_cluts = p_clut;
606     }
607
608     /* Initialize to default clut */
609     p_next = p_clut->p_next;
610     *p_clut = p_sys->default_clut;
611     p_clut->p_next = p_next;
612
613     /* We don't have this version of the CLUT: Parse it */
614     p_clut->i_version = i_version;
615     p_clut->i_id = i_id;
616     bs_skip( s, 4 ); /* Reserved bits */
617     i_processed_length = 2;
618     while( i_processed_length < i_segment_length )
619     {
620         uint8_t y, cb, cr, t;
621         uint8_t i_id;
622         uint8_t i_type;
623
624         i_id = bs_read( s, 8 );
625         i_type = bs_read( s, 3 );
626
627         bs_skip( s, 4 );
628
629         if( bs_read( s, 1 ) )
630         {
631             y  = bs_read( s, 8 );
632             cr = bs_read( s, 8 );
633             cb = bs_read( s, 8 );
634             t  = bs_read( s, 8 );
635             i_processed_length += 6;
636         }
637         else
638         {
639             y  = bs_read( s, 6 ) << 2;
640             cr = bs_read( s, 4 ) << 4;
641             cb = bs_read( s, 4 ) << 4;
642             t  = bs_read( s, 2 ) << 6;
643             i_processed_length += 4;
644         }
645
646         /* We are not entirely compliant here as full transparency is indicated
647          * with a luma value of zero, not a transparency value of 0xff
648          * (full transparency would actually be 0xff + 1). */
649         if( y == 0 )
650         {
651             cr = cb = 0;
652             t  = 0xff;
653         }
654
655         /* According to EN 300-743 section 7.2.3 note 1, type should
656          * not have more than 1 bit set to one, but some streams don't
657          * respect this note. */
658         if( i_type & 0x04 && i_id < 4 )
659         {
660             p_clut->c_2b[i_id].Y = y;
661             p_clut->c_2b[i_id].Cr = cr;
662             p_clut->c_2b[i_id].Cb = cb;
663             p_clut->c_2b[i_id].T = t;
664         }
665         if( i_type & 0x02 && i_id < 16 )
666         {
667             p_clut->c_4b[i_id].Y = y;
668             p_clut->c_4b[i_id].Cr = cr;
669             p_clut->c_4b[i_id].Cb = cb;
670             p_clut->c_4b[i_id].T = t;
671         }
672         if( i_type & 0x01 )
673         {
674             p_clut->c_8b[i_id].Y = y;
675             p_clut->c_8b[i_id].Cr = cr;
676             p_clut->c_8b[i_id].Cb = cb;
677             p_clut->c_8b[i_id].T = t;
678         }
679     }
680 }
681
682 static void decode_page_composition( decoder_t *p_dec, bs_t *s )
683 {
684     decoder_sys_t *p_sys = p_dec->p_sys;
685     int i_version, i_state, i_segment_length, i_timeout, i;
686
687     /* A page is composed by 0 or more region */
688
689     i_segment_length = bs_read( s, 16 );
690     i_timeout = bs_read( s, 8 );
691     i_version = bs_read( s, 4 );
692     i_state = bs_read( s, 2 );
693     bs_skip( s, 2 ); /* Reserved */
694
695     if( i_state == DVBSUB_PCS_STATE_CHANGE )
696     {
697         /* End of an epoch, reset decoder buffer */
698 #ifdef DEBUG_DVBSUB
699         msg_Dbg( p_dec, "page composition mode change" );
700 #endif
701         free_all( p_dec );
702     }
703     else if( !p_sys->p_page && i_state != DVBSUB_PCS_STATE_ACQUISITION &&
704              i_state != DVBSUB_PCS_STATE_CHANGE )
705     {
706         /* Not a full PCS, we need to wait for one */
707         msg_Dbg( p_dec, "didn't receive an acquisition page yet" );
708
709 #if 0
710         /* Try to start decoding even without an acquisition page */
711         bs_skip( s,  8 * (i_segment_length - 2) );
712         return;
713 #endif
714     }
715
716 #ifdef DEBUG_DVBSUB
717     if( i_state == DVBSUB_PCS_STATE_ACQUISITION )
718         msg_Dbg( p_dec, "acquisition page composition" );
719 #endif
720
721     /* Check version number */
722     if( p_sys->p_page && p_sys->p_page->i_version == i_version )
723     {
724         bs_skip( s,  8 * (i_segment_length - 2) );
725         return;
726     }
727     else if( p_sys->p_page )
728     {
729         if( p_sys->p_page->i_region_defs )
730             free( p_sys->p_page->p_region_defs );
731         p_sys->p_page->i_region_defs = 0;
732     }
733
734     if( !p_sys->p_page )
735     {
736 #ifdef DEBUG_DVBSUB
737         msg_Dbg( p_dec, "new page" );
738 #endif
739         /* Allocate a new page */
740         p_sys->p_page = malloc( sizeof(dvbsub_page_t) );
741     }
742
743     p_sys->p_page->i_version = i_version;
744     p_sys->p_page->i_timeout = i_timeout;
745     p_sys->b_page = VLC_TRUE;
746
747     /* Number of regions */
748     p_sys->p_page->i_region_defs = (i_segment_length - 2) / 6;
749
750     if( p_sys->p_page->i_region_defs == 0 ) return;
751
752     p_sys->p_page->p_region_defs =
753         malloc( p_sys->p_page->i_region_defs * sizeof(dvbsub_region_t) );
754     for( i = 0; i < p_sys->p_page->i_region_defs; i++ )
755     {
756         p_sys->p_page->p_region_defs[i].i_id = bs_read( s, 8 );
757         bs_skip( s, 8 ); /* Reserved */
758         p_sys->p_page->p_region_defs[i].i_x = bs_read( s, 16 );
759         p_sys->p_page->p_region_defs[i].i_y = bs_read( s, 16 );
760
761 #ifdef DEBUG_DVBSUB
762         msg_Dbg( p_dec, "page_composition, region %i (%i,%i)",
763                  i, p_sys->p_page->p_region_defs[i].i_x,
764                  p_sys->p_page->p_region_defs[i].i_y );
765 #endif
766     }
767 }
768
769 static void decode_region_composition( decoder_t *p_dec, bs_t *s )
770 {
771     decoder_sys_t *p_sys = p_dec->p_sys;
772     dvbsub_region_t *p_region, **pp_region = &p_sys->p_regions;
773     int i_segment_length, i_processed_length, i_id, i_version;
774     int i_width, i_height, i_level_comp, i_depth, i_clut;
775     int i_8_bg, i_4_bg, i_2_bg;
776     vlc_bool_t b_fill;
777
778     i_segment_length = bs_read( s, 16 );
779     i_id = bs_read( s, 8 );
780     i_version = bs_read( s, 4 );
781
782     /* Check if we already have this region */
783     for( p_region = p_sys->p_regions; p_region != NULL;
784          p_region = p_region->p_next )
785     {
786         pp_region = &p_region->p_next;
787         if( p_region->i_id == i_id ) break;
788     }
789
790     /* Check version number */
791     if( p_region && p_region->i_version == i_version )
792     {
793         bs_skip( s, 8 * (i_segment_length - 1) - 4 );
794         return;
795     }
796
797     if( !p_region )
798     {
799 #ifdef DEBUG_DVBSUB
800         msg_Dbg( p_dec, "new region: %i", i_id );
801 #endif
802         p_region = *pp_region = malloc( sizeof(dvbsub_region_t) );
803         memset( p_region, 0, sizeof(dvbsub_region_t) );
804         p_region->p_object_defs = NULL;
805         p_region->p_pixbuf = NULL;
806         p_region->p_next = NULL;
807     }
808
809     /* Region attributes */
810     p_region->i_id = i_id;
811     p_region->i_version = i_version;
812     b_fill = bs_read( s, 1 );
813     bs_skip( s, 3 ); /* Reserved */
814
815     i_width = bs_read( s, 16 );
816     i_height = bs_read( s, 16 );
817     i_level_comp = bs_read( s, 3 );
818     i_depth = bs_read( s, 3 );
819     bs_skip( s, 2 ); /* Reserved */
820     i_clut = bs_read( s, 8 );
821
822     i_8_bg = bs_read( s, 8 );
823     i_4_bg = bs_read( s, 4 );
824     i_2_bg = bs_read( s, 2 );
825     bs_skip( s, 2 ); /* Reserved */
826
827     /* Free old object defs */
828     while( p_region->i_object_defs )
829     {
830         int i = p_region->i_object_defs - 1;
831         if( p_region->p_object_defs[i].psz_text )
832             free( p_region->p_object_defs[i].psz_text );
833         if( !i ) free( p_region->p_object_defs );
834
835         p_region->i_object_defs--;
836     }
837     p_region->p_object_defs = NULL;
838
839     /* Extra sanity checks */
840     if( p_region->i_width != i_width || p_region->i_height != i_height )
841     {
842         if( p_region->p_pixbuf )
843         {
844             msg_Dbg( p_dec, "region size changed (not allowed)" );
845             free( p_region->p_pixbuf );
846         }
847
848         p_region->p_pixbuf = malloc( i_height * i_width );
849         p_region->i_depth = 0;
850         b_fill = VLC_TRUE;
851     }
852     if( p_region->i_depth && (p_region->i_depth != i_depth ||
853         p_region->i_level_comp != i_level_comp || p_region->i_clut != i_clut) )
854     {
855         msg_Dbg( p_dec, "region parameters changed (not allowed)" );
856     }
857
858     /* Erase background of region */
859     if( b_fill )
860     {
861         int i_background = (p_region->i_depth == 1) ? i_2_bg :
862             (p_region->i_depth == 2) ? i_4_bg : i_8_bg;
863         memset( p_region->p_pixbuf, i_background, i_width * i_height );
864     }
865
866     p_region->i_width = i_width;
867     p_region->i_height = i_height;
868     p_region->i_level_comp = i_level_comp;
869     p_region->i_depth = i_depth;
870     p_region->i_clut = i_clut;
871
872     /* List of objects in the region */
873     i_processed_length = 10;
874     while( i_processed_length < i_segment_length )
875     {
876         dvbsub_objectdef_t *p_obj;
877
878         /* We create a new object */
879         p_region->i_object_defs++;
880         p_region->p_object_defs =
881             realloc( p_region->p_object_defs,
882                      sizeof(dvbsub_objectdef_t) * p_region->i_object_defs );
883
884         /* We parse object properties */
885         p_obj = &p_region->p_object_defs[p_region->i_object_defs - 1];
886         p_obj->i_id         = bs_read( s, 16 );
887         p_obj->i_type       = bs_read( s, 2 );
888         bs_skip( s, 2 ); /* Provider */
889         p_obj->i_x          = bs_read( s, 12 );
890         bs_skip( s, 4 ); /* Reserved */
891         p_obj->i_y          = bs_read( s, 12 );
892         p_obj->psz_text     = 0;
893
894         i_processed_length += 6;
895
896         if( p_obj->i_type == DVBSUB_OT_BASIC_CHAR ||
897             p_obj->i_type == DVBSUB_OT_COMPOSITE_STRING )
898         {
899             p_obj->i_fg_pc =  bs_read( s, 8 );
900             p_obj->i_bg_pc =  bs_read( s, 8 );
901             i_processed_length += 2;
902         }
903     }
904 }
905
906 static void dvbsub_render_pdata( decoder_t *, dvbsub_region_t *, int, int,
907                                  uint8_t *, int );
908 static void dvbsub_pdata2bpp( bs_t *, uint8_t *, int, int * );
909 static void dvbsub_pdata4bpp( bs_t *, uint8_t *, int, int * );
910 static void dvbsub_pdata8bpp( bs_t *, uint8_t *, int, int * );
911
912 static void decode_object( decoder_t *p_dec, bs_t *s )
913 {
914     decoder_sys_t *p_sys = p_dec->p_sys;
915     dvbsub_region_t *p_region;
916     int i_segment_length, i_coding_method, i_version, i_id, i;
917     vlc_bool_t b_non_modify_color;
918
919     /* ETSI 300-743 paragraph 7.2.4
920      * sync_byte, segment_type and page_id have already been processed.
921      */
922     i_segment_length = bs_read( s, 16 );
923     i_id             = bs_read( s, 16 );
924     i_version        = bs_read( s, 4 );
925     i_coding_method  = bs_read( s, 2 );
926
927     if( i_coding_method > 1 )
928     {
929         msg_Dbg( p_dec, "Unknown DVB subtitling coding %d is not handled!", i_coding_method );
930         bs_skip( s, 8 * (i_segment_length - 2) - 6 );
931         return;
932     }
933
934     /* Check if the object needs to be rendered in at least one
935      * of the regions */
936     for( p_region = p_sys->p_regions; p_region != NULL;
937          p_region = p_region->p_next )
938     {
939         for( i = 0; i < p_region->i_object_defs; i++ )
940             if( p_region->p_object_defs[i].i_id == i_id ) break;
941
942         if( i != p_region->i_object_defs ) break;
943     }
944     if( !p_region )
945     {
946         bs_skip( s, 8 * (i_segment_length - 2) - 6 );
947         return;
948     }
949
950 #ifdef DEBUG_DVBSUB
951     msg_Dbg( p_dec, "new object: %i", i_id );
952 #endif
953
954     b_non_modify_color = bs_read( s, 1 );
955     bs_skip( s, 1 ); /* Reserved */
956
957     if( i_coding_method == 0x00 )
958     {
959         int i_topfield, i_bottomfield;
960         uint8_t *p_topfield, *p_bottomfield;
961
962         i_topfield    = bs_read( s, 16 );
963         i_bottomfield = bs_read( s, 16 );
964         p_topfield    = s->p_start + bs_pos( s ) / 8;
965         p_bottomfield = p_topfield + i_topfield;
966
967         bs_skip( s, 8 * (i_segment_length - 7) );
968
969         /* Sanity check */
970         if( i_segment_length < i_topfield + i_bottomfield + 7 ||
971             p_topfield + i_topfield + i_bottomfield > s->p_end )
972         {
973             msg_Dbg( p_dec, "corrupted object data" );
974             return;
975         }
976
977         for( p_region = p_sys->p_regions; p_region != NULL;
978              p_region = p_region->p_next )
979         {
980             for( i = 0; i < p_region->i_object_defs; i++ )
981             {
982                 if( p_region->p_object_defs[i].i_id != i_id ) continue;
983
984                 dvbsub_render_pdata( p_dec, p_region,
985                                      p_region->p_object_defs[i].i_x,
986                                      p_region->p_object_defs[i].i_y,
987                                      p_topfield, i_topfield );
988
989                 if( i_bottomfield )
990                 {
991                     dvbsub_render_pdata( p_dec, p_region,
992                                          p_region->p_object_defs[i].i_x,
993                                          p_region->p_object_defs[i].i_y + 1,
994                                          p_bottomfield, i_bottomfield );
995                 }
996                 else
997                 {
998                     /* Duplicate the top field */
999                     dvbsub_render_pdata( p_dec, p_region,
1000                                          p_region->p_object_defs[i].i_x,
1001                                          p_region->p_object_defs[i].i_y + 1,
1002                                          p_topfield, i_topfield );
1003                 }
1004             }
1005         }
1006     }
1007     else
1008     {
1009         /* DVB subtitling as characters */
1010         int i_number_of_codes = bs_read( s, 8 );
1011         uint8_t* p_start = s->p_start + bs_pos( s ) / 8;
1012
1013         /* Sanity check */
1014         if( i_segment_length <  i_number_of_codes*2 + 4 ||
1015             p_start + i_number_of_codes*2 > s->p_end )
1016         {
1017             msg_Dbg( p_dec, "corrupted object data" );
1018             return;
1019         }
1020
1021         for( p_region = p_sys->p_regions; p_region != NULL;
1022              p_region = p_region->p_next )
1023         {
1024             for( i = 0; i < p_region->i_object_defs; i++ )
1025             {
1026                 int j;
1027
1028                 if( p_region->p_object_defs[i].i_id != i_id ) continue;
1029
1030                 p_region->p_object_defs[i].psz_text =
1031                     realloc( p_region->p_object_defs[i].psz_text,
1032                              i_number_of_codes + 1 );
1033
1034                 for( j = 0; j < i_number_of_codes; j++ )
1035                 {
1036                     p_region->p_object_defs[i].psz_text[j] = bs_read( s, 16 );
1037                 }
1038                 p_region->p_object_defs[i].psz_text[j] = 0;
1039             }
1040         }
1041     }
1042
1043 #ifdef DEBUG_DVBSUB
1044     msg_Dbg( p_dec, "end object: %i", i_id );
1045 #endif
1046 }
1047
1048 static void dvbsub_render_pdata( decoder_t *p_dec, dvbsub_region_t *p_region,
1049                                  int i_x, int i_y,
1050                                  uint8_t *p_field, int i_field )
1051 {
1052     uint8_t *p_pixbuf;
1053     int i_offset = 0;
1054     bs_t bs;
1055
1056     /* Sanity check */
1057     if( !p_region->p_pixbuf )
1058     {
1059         msg_Err( p_dec, "region %i has no pixel buffer!", p_region->i_id );
1060         return;
1061     }
1062     if( i_y < 0 || i_x < 0 || i_y >= p_region->i_height ||
1063         i_x >= p_region->i_width )
1064     {
1065         msg_Dbg( p_dec, "invalid offset (%i,%i)", i_x, i_y );
1066         return;
1067     }
1068
1069     p_pixbuf = p_region->p_pixbuf + i_y * p_region->i_width;
1070     bs_init( &bs, p_field, i_field );
1071
1072     while( !bs_eof( &bs ) )
1073     {
1074         /* Sanity check */
1075         if( i_y >= p_region->i_height ) return;
1076
1077         switch( bs_read( &bs, 8 ) )
1078         {
1079         case 0x10:
1080             dvbsub_pdata2bpp( &bs, p_pixbuf + i_x, p_region->i_width - i_x,
1081                               &i_offset );
1082             break;
1083
1084         case 0x11:
1085             dvbsub_pdata4bpp( &bs, p_pixbuf + i_x, p_region->i_width - i_x,
1086                               &i_offset );
1087             break;
1088
1089         case 0x12:
1090             dvbsub_pdata8bpp( &bs, p_pixbuf + i_x, p_region->i_width - i_x,
1091                               &i_offset );
1092             break;
1093
1094         case 0x20:
1095         case 0x21:
1096         case 0x22:
1097             /* We don't use map tables */
1098             break;
1099
1100         case 0xf0: /* End of line code */
1101             p_pixbuf += 2*p_region->i_width;
1102             i_offset = 0; i_y += 2;
1103             break;
1104         }
1105     }
1106 }
1107
1108 static void dvbsub_pdata2bpp( bs_t *s, uint8_t *p, int i_width, int *pi_off )
1109 {
1110     vlc_bool_t b_stop = 0;
1111
1112     while( !b_stop && !bs_eof( s ) )
1113     {
1114         int i_count = 0, i_color = 0;
1115
1116         if( (i_color = bs_read( s, 2 )) != 0x00 )
1117         {
1118             i_count = 1;
1119         }
1120         else
1121         {
1122             if( bs_read( s, 1 ) == 0x01 )         // Switch1
1123             {
1124                 i_count = 3 + bs_read( s, 3 );
1125                 i_color = bs_read( s, 2 );
1126             }
1127             else
1128             {
1129                 if( bs_read( s, 1 ) == 0x00 )     //Switch2
1130                 {
1131                     switch( bs_read( s, 2 ) )     //Switch3
1132                     {
1133                     case 0x00:
1134                         b_stop = 1;
1135                         break;
1136                     case 0x01:
1137                         i_count = 2;
1138                         break;
1139                     case 0x02:
1140                         i_count =  12 + bs_read( s, 4 );
1141                         i_color = bs_read( s, 2 );
1142                         break;
1143                     case 0x03:
1144                         i_count =  29 + bs_read( s, 8 );
1145                         i_color = bs_read( s, 2 );
1146                         break;
1147                     default:
1148                         break;
1149                     }
1150                 }
1151                 else
1152                 {
1153                     /* 1 pixel color 0 */
1154                     i_count = 1;
1155                 }
1156             }
1157         }
1158
1159         if( !i_count ) continue;
1160
1161         /* Sanity check */
1162         if( i_count + *pi_off > i_width ) break;
1163
1164         if( i_count == 1 ) p[*pi_off] = i_color;
1165         else memset( p + *pi_off, i_color, i_count );
1166
1167         (*pi_off) += i_count;
1168     }
1169
1170     bs_align( s );
1171 }
1172
1173 static void dvbsub_pdata4bpp( bs_t *s, uint8_t *p, int i_width, int *pi_off )
1174 {
1175     vlc_bool_t b_stop = 0;
1176
1177     while( !b_stop && !bs_eof( s ) )
1178     {
1179         int i_count = 0, i_color = 0;
1180
1181         if( (i_color = bs_read( s, 4 )) != 0x00 )
1182         {
1183             /* Add 1 pixel */
1184             i_count = 1;
1185         }
1186         else
1187         {
1188             if( bs_read( s, 1 ) == 0x00 )           // Switch1
1189             {
1190                 if( bs_show( s, 3 ) != 0x00 )
1191                 {
1192                     i_count = 2 + bs_read( s, 3 );
1193                 }
1194                 else
1195                 {
1196                     bs_skip( s, 3 );
1197                     b_stop = 1;
1198                 }
1199             }
1200             else
1201             {
1202                 if( bs_read( s, 1 ) == 0x00)        //Switch2
1203                 {
1204                     i_count =  4 + bs_read( s, 2 );
1205                     i_color = bs_read( s, 4 );
1206                 }
1207                 else
1208                 {
1209                     switch ( bs_read( s, 2 ) )     //Switch3
1210                     {
1211                     case 0x0:
1212                         i_count = 1;
1213                         break;
1214                     case 0x1:
1215                         i_count = 2;
1216                         break;
1217                     case 0x2:
1218                         i_count = 9 + bs_read( s, 4 );
1219                         i_color = bs_read( s, 4 );
1220                         break;
1221                     case 0x3:
1222                         i_count= 25 + bs_read( s, 8 );
1223                         i_color = bs_read( s, 4 );
1224                         break;
1225                     }
1226                 }
1227             }
1228         }
1229
1230         if( !i_count ) continue;
1231
1232         /* Sanity check */
1233         if( i_count + *pi_off > i_width ) break;
1234
1235         if( i_count == 1 ) p[*pi_off] = i_color;
1236         else memset( p + *pi_off, i_color, i_count );
1237
1238         (*pi_off) += i_count;
1239     }
1240
1241     bs_align( s );
1242 }
1243
1244 static void dvbsub_pdata8bpp( bs_t *s, uint8_t *p, int i_width, int *pi_off )
1245 {
1246     vlc_bool_t b_stop = 0;
1247
1248     while( !b_stop && !bs_eof( s ) )
1249     {
1250         int i_count = 0, i_color = 0;
1251
1252         if( (i_color = bs_read( s, 8 )) != 0x00 )
1253         {
1254             /* Add 1 pixel */
1255             i_count = 1;
1256         }
1257         else
1258         {
1259             if( bs_read( s, 1 ) == 0x00 )           // Switch1
1260             {
1261                 if( bs_show( s, 7 ) != 0x00 )
1262                 {
1263                     i_count = bs_read( s, 7 );
1264                 }
1265                 else
1266                 {
1267                     bs_skip( s, 7 );
1268                     b_stop = 1;
1269                 }
1270             }
1271             else
1272             {
1273                 i_count = bs_read( s, 7 );
1274                 i_color = bs_read( s, 8 );
1275             }
1276         }
1277
1278         if( !i_count ) continue;
1279
1280         /* Sanity check */
1281         if( i_count + *pi_off > i_width ) break;
1282
1283         if( i_count == 1 ) p[*pi_off] = i_color;
1284         else memset( p + *pi_off, i_color, i_count );
1285
1286         (*pi_off) += i_count;
1287     }
1288
1289     bs_align( s );
1290 }
1291
1292 static void free_all( decoder_t *p_dec )
1293 {
1294     decoder_sys_t *p_sys = p_dec->p_sys;
1295     dvbsub_region_t *p_reg, *p_reg_next;
1296     dvbsub_clut_t *p_clut, *p_clut_next;
1297
1298     for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut_next )
1299     {
1300         p_clut_next = p_clut->p_next;
1301         free( p_clut );
1302     }
1303     p_sys->p_cluts = NULL;
1304
1305     for( p_reg = p_sys->p_regions; p_reg != NULL; p_reg = p_reg_next )
1306     {
1307         int i;
1308
1309         p_reg_next = p_reg->p_next;
1310         for( i = 0; i < p_reg->i_object_defs; i++ )
1311             if( p_reg->p_object_defs[i].psz_text )
1312                 free( p_reg->p_object_defs[i].psz_text );
1313         if( p_reg->i_object_defs ) free( p_reg->p_object_defs );
1314         if( p_reg->p_pixbuf ) free( p_reg->p_pixbuf );
1315         free( p_reg );
1316     }
1317     p_sys->p_regions = NULL;
1318
1319     if( p_sys->p_page )
1320     {
1321         if( p_sys->p_page->i_region_defs )
1322             free( p_sys->p_page->p_region_defs );
1323         free( p_sys->p_page );
1324     }
1325     p_sys->p_page = NULL;
1326 }
1327
1328 static subpicture_t *render( decoder_t *p_dec )
1329 {
1330     decoder_sys_t *p_sys = p_dec->p_sys;
1331     subpicture_t *p_spu;
1332     subpicture_region_t **pp_spu_region;
1333     int i, j, i_timeout = 0;
1334
1335     /* Allocate the subpicture internal data. */
1336     p_spu = p_dec->pf_spu_buffer_new( p_dec );
1337     if( !p_spu ) return NULL;
1338
1339     pp_spu_region = &p_spu->p_region;
1340
1341     /* Loop on region definitions */
1342 #ifdef DEBUG_DVBSUB
1343     if( p_sys->p_page )
1344         msg_Dbg( p_dec, "rendering %i regions", p_sys->p_page->i_region_defs );
1345 #endif
1346
1347     for( i = 0; p_sys->p_page && i < p_sys->p_page->i_region_defs; i++ )
1348     {
1349         dvbsub_region_t     *p_region;
1350         dvbsub_regiondef_t  *p_regiondef;
1351         dvbsub_clut_t       *p_clut;
1352         dvbsub_color_t      *p_color;
1353         subpicture_region_t *p_spu_region;
1354         uint8_t *p_src, *p_dst;
1355         video_format_t fmt;
1356         int i_pitch;
1357
1358         i_timeout = p_sys->p_page->i_timeout;
1359
1360         p_regiondef = &p_sys->p_page->p_region_defs[i];
1361
1362 #ifdef DEBUG_DVBSUB
1363         msg_Dbg( p_dec, "rendering region %i (%i,%i)", i,
1364                  p_regiondef->i_x, p_regiondef->i_y );
1365 #endif
1366
1367         /* Find associated region */
1368         for( p_region = p_sys->p_regions; p_region != NULL;
1369              p_region = p_region->p_next )
1370         {
1371             if( p_regiondef->i_id == p_region->i_id ) break;
1372         }
1373
1374         if( !p_region )
1375         {
1376             msg_Dbg( p_dec, "region %i not found", p_regiondef->i_id );
1377             continue;
1378         }
1379
1380         /* Find associated CLUT */
1381         for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut->p_next )
1382         {
1383             if( p_region->i_clut == p_clut->i_id ) break;
1384         }
1385         if( !p_clut )
1386         {
1387             msg_Dbg( p_dec, "clut %i not found", p_region->i_clut );
1388             continue;
1389         }
1390
1391         /* Create new SPU region */
1392         memset( &fmt, 0, sizeof(video_format_t) );
1393         fmt.i_chroma = VLC_FOURCC('Y','U','V','P');
1394         fmt.i_aspect = 0; /* 0 means use aspect ratio of background video */
1395         fmt.i_width = fmt.i_visible_width = p_region->i_width;
1396         fmt.i_height = fmt.i_visible_height = p_region->i_height;
1397         fmt.i_x_offset = fmt.i_y_offset = 0;
1398         p_spu_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
1399         if( !p_region )
1400         {
1401             msg_Err( p_dec, "cannot allocate SPU region" );
1402             continue;
1403         }
1404         p_spu_region->i_x = p_regiondef->i_x;
1405         p_spu_region->i_y = p_regiondef->i_y;
1406         *pp_spu_region = p_spu_region;
1407         pp_spu_region = &p_spu_region->p_next;
1408
1409         /* Build palette */
1410         fmt.p_palette->i_entries = p_region->i_depth == 1 ? 4 :
1411             p_region->i_depth == 2 ? 16 : 256;
1412         p_color = (p_region->i_depth == 1) ? p_clut->c_2b :
1413             (p_region->i_depth == 2) ? p_clut->c_4b : p_clut->c_8b;
1414         for( j = 0; j < fmt.p_palette->i_entries; j++ )
1415         {
1416             fmt.p_palette->palette[j][0] = p_color[j].Y;
1417             fmt.p_palette->palette[j][1] = p_color[j].Cr;
1418             fmt.p_palette->palette[j][2] = p_color[j].Cb;
1419             fmt.p_palette->palette[j][3] = 0xff - p_color[j].T;
1420         }
1421
1422         p_src = p_region->p_pixbuf;
1423         p_dst = p_spu_region->picture.Y_PIXELS;
1424         i_pitch = p_spu_region->picture.Y_PITCH;
1425
1426         /* Copy pixel buffer */
1427         for( j = 0; j < p_region->i_height; j++ )
1428         {
1429             memcpy( p_dst, p_src, p_region->i_width );
1430             p_src += p_region->i_width;
1431             p_dst += i_pitch;
1432         }
1433
1434         /* Check subtitles encoded as strings of characters
1435          * (since there are not rendered in the pixbuffer) */
1436         for( j = 0; j < p_region->i_object_defs; j++ )
1437         {
1438             dvbsub_objectdef_t *p_object_def = &p_region->p_object_defs[i];
1439
1440             if( p_object_def->i_type != 1 || !p_object_def->psz_text )
1441                 continue;
1442
1443             /* Create new SPU region */
1444             memset( &fmt, 0, sizeof(video_format_t) );
1445             fmt.i_chroma = VLC_FOURCC('T','E','X','T');
1446             fmt.i_aspect = VOUT_ASPECT_FACTOR;
1447             fmt.i_width = fmt.i_visible_width = p_region->i_width;
1448             fmt.i_height = fmt.i_visible_height = p_region->i_height;
1449             fmt.i_x_offset = fmt.i_y_offset = 0;
1450             p_spu_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
1451             if( !p_region )
1452             {
1453                 msg_Err( p_dec, "cannot allocate SPU region" );
1454                 continue;
1455             }
1456
1457             p_spu_region->psz_text = strdup( p_object_def->psz_text );
1458             p_spu_region->i_x = p_regiondef->i_x + p_object_def->i_x;
1459             p_spu_region->i_y = p_regiondef->i_y + p_object_def->i_y;
1460             *pp_spu_region = p_spu_region;
1461             pp_spu_region = &p_spu_region->p_next;
1462         }
1463     }
1464
1465     /* Set the pf_render callback */
1466     p_spu->i_start = p_sys->i_pts;
1467     p_spu->i_stop = p_spu->i_start + (mtime_t) (i_timeout * 1000000);
1468     p_spu->b_ephemer = VLC_TRUE;
1469     p_spu->b_fade = VLC_TRUE;
1470         
1471     /* Correct positioning of SPU */
1472     p_spu->b_absolute = p_sys->b_absolute;
1473     p_spu->i_flags = p_sys->i_spu_position;
1474     p_spu->i_x = p_sys->i_spu_x;
1475     p_spu->i_y = p_sys->i_spu_y;    
1476
1477     return p_spu;
1478 }
1479
1480 /*****************************************************************************
1481  * encoder_sys_t : encoder descriptor
1482  *****************************************************************************/
1483 typedef struct encoder_region_t
1484 {
1485     int i_width;
1486     int i_height;
1487
1488 } encoder_region_t;
1489
1490 struct encoder_sys_t
1491 {
1492     unsigned int i_page_ver;
1493     unsigned int i_region_ver;
1494     unsigned int i_clut_ver;
1495
1496     int i_regions;
1497     encoder_region_t *p_regions;
1498
1499     mtime_t i_pts;
1500     
1501     /* subpicture positioning */
1502     int i_offset_x;
1503     int i_offset_y;
1504     int i_timeout_delay;    
1505 };
1506
1507 static void encode_page_composition( encoder_t *, bs_t *, subpicture_t * );
1508 static void encode_clut( encoder_t *, bs_t *, subpicture_t * );
1509 static void encode_region_composition( encoder_t *, bs_t *, subpicture_t * );
1510 static void encode_object( encoder_t *, bs_t *, subpicture_t * );
1511
1512 /*****************************************************************************
1513  * OpenEncoder: probe the encoder and return score
1514  *****************************************************************************/
1515 static int OpenEncoder( vlc_object_t *p_this )
1516 {
1517     encoder_t *p_enc = (encoder_t *)p_this;
1518     encoder_sys_t *p_sys;
1519     vlc_value_t val;
1520
1521     if( p_enc->fmt_out.i_codec != VLC_FOURCC('d','v','b','s') &&
1522         !p_enc->b_force )
1523     {
1524         return VLC_EGENERIC;
1525     }
1526
1527     /* Allocate the memory needed to store the decoder's structure */
1528     if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
1529     {
1530         msg_Err( p_enc, "out of memory" );
1531         return VLC_EGENERIC;
1532     }
1533     p_enc->p_sys = p_sys;
1534
1535     p_enc->pf_encode_sub = Encode;
1536     p_enc->fmt_out.i_codec = VLC_FOURCC('d','v','b','s');
1537     p_enc->fmt_out.subs.dvb.i_id  = 1 << 16 | 1;
1538
1539     sout_CfgParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
1540
1541     p_sys->i_page_ver = 0;
1542     p_sys->i_region_ver = 0;
1543     p_sys->i_clut_ver = 0;
1544     p_sys->i_regions = 0;
1545     p_sys->p_regions = 0;
1546
1547     var_Create( p_this, ENC_CFG_PREFIX "x", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
1548     var_Get( p_this, ENC_CFG_PREFIX "x", &val );
1549     p_sys->i_offset_x = val.i_int;
1550     var_Create( p_this, ENC_CFG_PREFIX "y", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
1551     var_Get( p_this, ENC_CFG_PREFIX "y", &val );
1552     p_sys->i_offset_y = val.i_int;
1553     var_Create( p_this, ENC_CFG_PREFIX "timeout", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
1554     var_Get( p_this, ENC_CFG_PREFIX "timeout", &val );
1555     p_sys->i_timeout_delay = val.i_int;    
1556     
1557     return VLC_SUCCESS;
1558 }
1559
1560 /* FIXME: this routine is a hack to convert VLC_FOURCC('Y','U','V','A') 
1561  *        into VLC_FOURCC('Y','U','V','P')
1562  */
1563 static subpicture_t *YuvaYuvp( encoder_t *p_enc, subpicture_t *p_subpic )
1564 {
1565     subpicture_region_t *p_region = NULL;
1566      
1567     for( p_region = p_subpic->p_region; p_region; p_region = p_region->p_next )
1568     {
1569         video_format_t *p_fmt = &p_region->fmt;
1570         int i = 0, j = 0, n = 0, p = 0;
1571         int i_max_entries = 256;
1572
1573 #ifdef RANDOM_DITHERING
1574         int i_seed = 0xdeadbeef; /* random seed */
1575 #else
1576         int *pi_delta;
1577 #endif
1578         int i_pixels = p_region->picture.p[0].i_visible_lines
1579                         * p_region->picture.p[0].i_pitch;
1580         int i_iterator = p_region->picture.p[0].i_visible_lines * 3 / 4
1581                             * p_region->picture.p[0].i_pitch
1582                         + p_region->picture.p[0].i_pitch * 1 / 3;
1583         int i_tolerance = 0;
1584     
1585         p_fmt->i_chroma = VLC_FOURCC('Y','U','V','P');
1586         p_fmt->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
1587         p_fmt->p_palette->i_entries = 0;
1588     
1589         /* Find best iterator using Euclide’s algorithm */
1590         for( ; i_iterator > 1 ; i_iterator-- )
1591         {
1592             int a = i_pixels;
1593             int b = i_iterator;
1594             int c;
1595     
1596             while( b )
1597             {
1598                 c = a % b;
1599                 a = b;
1600                 b = c;
1601             }
1602     
1603             if( a == 1 )
1604             {
1605                 break;
1606             }
1607         }
1608     
1609         /* Count colors, build best palette */
1610         for( i_tolerance = 0; i_tolerance < 128; i_tolerance++ )
1611         {
1612             vlc_bool_t b_success = VLC_TRUE;
1613             p_fmt->p_palette->i_entries = 0;
1614     
1615             for( i = 0; i < i_pixels ; )
1616             {
1617                 uint8_t y, u, v, a;
1618                 y = p_region->picture.p[0].p_pixels[i];
1619                 u = p_region->picture.p[1].p_pixels[i];
1620                 v = p_region->picture.p[2].p_pixels[i];
1621                 a = p_region->picture.p[3].p_pixels[i];
1622                 for( j = 0; j < p_fmt->p_palette->i_entries; j++ )
1623                 {
1624                     if( abs((int)p_fmt->p_palette->palette[j][0] - (int)y) <= i_tolerance &&
1625                         abs((int)p_fmt->p_palette->palette[j][1] - (int)u) <= i_tolerance &&
1626                         abs((int)p_fmt->p_palette->palette[j][2] - (int)v) <= i_tolerance &&
1627                         abs((int)p_fmt->p_palette->palette[j][3] - (int)a) <= i_tolerance / 2 )
1628                     {
1629                         break;
1630                     }
1631                 }
1632                 if( j == p_fmt->p_palette->i_entries )
1633                 {
1634                     p_fmt->p_palette->palette[j][0] = y;
1635                     p_fmt->p_palette->palette[j][1] = u;
1636                     p_fmt->p_palette->palette[j][2] = v;
1637                     p_fmt->p_palette->palette[j][3] = a;
1638                     p_fmt->p_palette->i_entries++;
1639                 }
1640                 if( p_fmt->p_palette->i_entries >= i_max_entries )
1641                 {
1642                     b_success = VLC_FALSE;
1643                     break;
1644                 }
1645                 i += i_iterator;
1646                 if( i > i_pixels )
1647                 {
1648                     i -= i_pixels;
1649                 }
1650             }
1651     
1652             if( b_success )
1653             {
1654                 break;
1655             }
1656         }
1657     
1658 #if DEBUG_DVBSUB
1659         msg_Dbg( p_enc, "best palette has %d colors", p_fmt->p_palette->i_entries );
1660 #endif
1661
1662 #ifndef RANDOM_DITHERING
1663         pi_delta = malloc( ( p_region->picture.p[0].i_pitch + 1 )
1664                             * sizeof(int) * 4  );
1665         for( i = 0; i < (p_region->picture.p[0].i_pitch + 1) * 4 ; i++ )
1666         {
1667             pi_delta[ i ] = 0;
1668         }
1669 #endif
1670
1671         /* Fill image with our new colours */
1672         for( p = 0; p < p_region->picture.p[0].i_visible_lines ; p++ )
1673         {
1674             int i_ydelta = 0, i_udelta = 0, i_vdelta = 0, i_adelta = 0;
1675     
1676             for( n = 0; n < p_region->picture.p[0].i_pitch ; n++ )
1677             {
1678                 int i_offset = p * p_region->picture.p[0].i_pitch + n;
1679                 int y, u, v, a;
1680                 int i_mindist, i_best;
1681     
1682                 y = (int)p_region->picture.p[0].p_pixels[i_offset];
1683                 u = (int)p_region->picture.p[1].p_pixels[i_offset];
1684                 v = (int)p_region->picture.p[2].p_pixels[i_offset];
1685                 a = (int)p_region->picture.p[3].p_pixels[i_offset];
1686     
1687                 /* Add dithering compensation */
1688 #ifdef RANDOM_DITHERING
1689                 y += ((i_seed & 0xff) - 0x80) * i_tolerance / 0x80;
1690                 u += (((i_seed >> 8) & 0xff) - 0x80) * i_tolerance / 0x80;
1691                 v += (((i_seed >> 16) & 0xff) - 0x80) * i_tolerance / 0x80;
1692                 a += (((i_seed >> 24) & 0xff) - 0x80) * i_tolerance / 0x80;
1693 #else
1694                 y += i_ydelta + pi_delta[ n * 4 ];
1695                 u += i_udelta + pi_delta[ n * 4 + 1 ];
1696                 v += i_vdelta + pi_delta[ n * 4 + 2 ];
1697                 a += i_adelta + pi_delta[ n * 4 + 3 ];
1698 #endif
1699
1700                 /* Find best colour in palette */
1701                 for( i_mindist = 99999999, i_best = 0, j = 0; j < p_fmt->p_palette->i_entries; j++ )
1702                 {
1703                     int i_dist = 0;
1704     
1705                     i_dist += abs((int)p_fmt->p_palette->palette[j][0] - y);
1706                     i_dist += abs((int)p_fmt->p_palette->palette[j][1] - u);
1707                     i_dist += abs((int)p_fmt->p_palette->palette[j][2] - v);
1708                     i_dist += 2 * abs((int)p_fmt->p_palette->palette[j][3] - a);
1709     
1710                     if( i_dist < i_mindist )
1711                     {
1712                         i_mindist = i_dist;
1713                         i_best = j;
1714                     }
1715                 }
1716     
1717                 /* Set pixel to best color */
1718                 p_region->picture.p[0].p_pixels[i_offset] = i_best;
1719     
1720                 /* Update dithering state */
1721 #ifdef RANDOM_DITHERING
1722                 i_seed = (i_seed * 0x1283837) ^ 0x789479 ^ (i_seed >> 13);
1723 #else
1724                 i_ydelta = y - (int)p_fmt->p_palette->palette[i_best][0];
1725                 i_udelta = u - (int)p_fmt->p_palette->palette[i_best][1];
1726                 i_vdelta = v - (int)p_fmt->p_palette->palette[i_best][2];
1727                 i_adelta = a - (int)p_fmt->p_palette->palette[i_best][3];
1728                 pi_delta[ n * 4 ] = i_ydelta * 3 / 8;
1729                 pi_delta[ n * 4 + 1 ] = i_udelta * 3 / 8;
1730                 pi_delta[ n * 4 + 2 ] = i_vdelta * 3 / 8;
1731                 pi_delta[ n * 4 + 3 ] = i_adelta * 3 / 8;
1732                 i_ydelta = i_ydelta * 5 / 8;
1733                 i_udelta = i_udelta * 5 / 8;
1734                 i_vdelta = i_vdelta * 5 / 8;
1735                 i_adelta = i_adelta * 5 / 8;
1736 #endif
1737             }
1738         }
1739 #ifndef RANDOM_DITHERING
1740         free( pi_delta );
1741 #endif
1742
1743         /* pad palette */
1744         for( i = p_fmt->p_palette->i_entries; i < i_max_entries; i++ )
1745         {
1746             p_fmt->p_palette->palette[i][0] = 0;
1747             p_fmt->p_palette->palette[i][1] = 0;
1748             p_fmt->p_palette->palette[i][2] = 0;
1749             p_fmt->p_palette->palette[i][3] = 0;
1750         }
1751         p_fmt->p_palette->i_entries = i_max_entries;
1752 #if DEBUG_DVBSUB
1753         msg_Dbg( p_enc, "best palette has %d colors", p_fmt->p_palette->i_entries );
1754 #endif
1755     }
1756     return p_subpic;
1757 } /* End of hack */
1758
1759 /****************************************************************************
1760  * Encode: the whole thing
1761  ****************************************************************************/
1762 static block_t *Encode( encoder_t *p_enc, subpicture_t *p_subpic )
1763 {
1764     subpicture_t *p_temp = NULL;
1765     subpicture_region_t *p_region = NULL;
1766     bs_t bits, *s = &bits;
1767     block_t *p_block;
1768
1769     if( !p_subpic || !p_subpic->p_region ) return NULL;
1770     
1771     /* FIXME: this is a hack to convert VLC_FOURCC('Y','U','V','A') into
1772      *  VLC_FOURCC('Y','U','V','P')
1773      */
1774     p_region = p_subpic->p_region;
1775     if( p_region->fmt.i_chroma == VLC_FOURCC('Y','U','V','A') )
1776     {
1777         p_temp = YuvaYuvp( p_enc, p_subpic );
1778         if( !p_temp )
1779         {
1780             msg_Dbg( p_enc, "no picture in subpicture" );
1781             return NULL;
1782         }
1783         p_region = p_subpic->p_region;
1784     }
1785     /* Sanity check */
1786     if( !p_region ) return NULL;
1787     if( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') &&
1788         p_region->fmt.i_chroma != VLC_FOURCC('Y','U','V','P') ) return NULL;
1789     
1790     if( p_region->fmt.p_palette &&
1791         ( p_region->fmt.p_palette->i_entries != 4 ) &&
1792         ( p_region->fmt.p_palette->i_entries != 16 ) &&
1793         ( p_region->fmt.p_palette->i_entries != 256 ) )
1794     {
1795         msg_Err( p_enc, "subpicture palette (%d) not handled",
1796                     p_region->fmt.p_palette->i_entries );
1797         return NULL;
1798     }
1799     /* End of hack */
1800     
1801 #if DEBUG_DVBSUB
1802     msg_Dbg( p_enc, "encoding subpicture" );
1803 #endif
1804     p_block = block_New( p_enc, 64000 );
1805     bs_init( s, p_block->p_buffer, p_block->i_buffer );
1806
1807     bs_write( s, 8, 0x20 ); /* Data identifier */
1808     bs_write( s, 8, 0x0 );  /* Subtitle stream id */
1809
1810     encode_page_composition( p_enc, s, p_subpic );
1811     encode_region_composition( p_enc, s, p_subpic );
1812     encode_clut( p_enc, s, p_subpic );
1813     encode_object( p_enc, s, p_subpic );
1814
1815     /* End of display */
1816     bs_write( s, 8, 0x0f ); /* Sync byte */
1817     bs_write( s, 8, DVBSUB_ST_ENDOFDISPLAY ); /* Segment type */
1818     bs_write( s, 16, 1 );  /* Page id */
1819     bs_write( s, 16, 0 );  /* Segment length */
1820
1821     bs_write( s, 8, 0xff );/* End marker */
1822     p_block->i_buffer = bs_pos( s ) / 8;
1823     p_block->i_pts = p_block->i_dts = p_subpic->i_start;
1824     if( !p_subpic->b_ephemer && p_subpic->i_stop > p_subpic->i_start )
1825     {
1826         block_t *p_block_stop;
1827
1828         p_block->i_length = p_subpic->i_stop - p_subpic->i_start;
1829
1830         /* Send another (empty) subtitle to signal the end of display */
1831         p_block_stop = block_New( p_enc, 64000 );
1832         bs_init( s, p_block_stop->p_buffer, p_block_stop->i_buffer );
1833         bs_write( s, 8, 0x20 ); /* Data identifier */
1834         bs_write( s, 8, 0x0 );  /* Subtitle stream id */
1835         encode_page_composition( p_enc, s, 0 );
1836         bs_write( s, 8, 0x0f ); /* Sync byte */
1837         bs_write( s, 8, DVBSUB_ST_ENDOFDISPLAY ); /* Segment type */
1838         bs_write( s, 16, 1 );  /* Page id */
1839         bs_write( s, 16, 0 );  /* Segment length */
1840         bs_write( s, 8, 0xff );/* End marker */
1841         p_block_stop->i_buffer = bs_pos( s ) / 8;
1842         p_block_stop->i_pts = p_block_stop->i_dts = p_subpic->i_stop;
1843         block_ChainAppend( &p_block, p_block_stop );
1844         p_block_stop->i_length = 100000; /* p_subpic->i_stop - p_subpic->i_start; */
1845     }
1846 #ifdef DEBUG_DVBSUB
1847     msg_Dbg( p_enc, "subpicture encoded properly" );
1848 #endif
1849     return p_block;
1850 }
1851
1852 /*****************************************************************************
1853  * CloseEncoder: encoder destruction
1854  *****************************************************************************/
1855 static void CloseEncoder( vlc_object_t *p_this )
1856 {
1857     encoder_t *p_enc = (encoder_t *)p_this;
1858     encoder_sys_t *p_sys = p_enc->p_sys;
1859
1860     var_Destroy( p_this , ENC_CFG_PREFIX "x" );
1861     var_Destroy( p_this , ENC_CFG_PREFIX "y" );
1862     var_Destroy( p_this , ENC_CFG_PREFIX "timeout" );    
1863
1864     if( p_sys->i_regions ) free( p_sys->p_regions );
1865     free( p_sys );
1866 }
1867
1868 static void encode_page_composition( encoder_t *p_enc, bs_t *s,
1869                                      subpicture_t *p_subpic )
1870 {
1871     encoder_sys_t *p_sys = p_enc->p_sys;
1872     subpicture_region_t *p_region;
1873     vlc_bool_t b_mode_change = VLC_FALSE;
1874     int i_regions, i_timeout;
1875
1876     bs_write( s, 8, 0x0f ); /* Sync byte */
1877     bs_write( s, 8, DVBSUB_ST_PAGE_COMPOSITION ); /* Segment type */
1878     bs_write( s, 16, 1 ); /* Page id */
1879
1880     for( i_regions = 0, p_region = p_subpic ? p_subpic->p_region : 0;
1881          p_region; p_region = p_region->p_next, i_regions++ )
1882     {
1883         if( i_regions >= p_sys->i_regions )
1884         {
1885             encoder_region_t region;
1886             region.i_width = region.i_height = 0;
1887             p_sys->p_regions =
1888                 realloc( p_sys->p_regions, sizeof(encoder_region_t) *
1889                          (p_sys->i_regions + 1) );
1890             p_sys->p_regions[p_sys->i_regions++] = region;
1891         }
1892
1893         if( p_sys->p_regions[i_regions].i_width <
1894             (int)p_region->fmt.i_visible_width )
1895         {
1896             b_mode_change = VLC_TRUE;
1897             msg_Dbg( p_enc, "region %i width change: %i -> %i",
1898                      i_regions, p_sys->p_regions[i_regions].i_width,
1899                      p_region->fmt.i_visible_width );
1900             p_sys->p_regions[i_regions].i_width =
1901                 p_region->fmt.i_visible_width;
1902         }
1903         if( p_sys->p_regions[i_regions].i_height <
1904             (int)p_region->fmt.i_visible_height )
1905         {
1906             b_mode_change = VLC_TRUE;
1907             msg_Dbg( p_enc, "region %i height change: %i -> %i",
1908                      i_regions, p_sys->p_regions[i_regions].i_height,
1909                      p_region->fmt.i_visible_height );
1910             p_sys->p_regions[i_regions].i_height =
1911                 p_region->fmt.i_visible_height;
1912         }
1913     }
1914
1915     bs_write( s, 16, i_regions * 6 + 2 ); /* Segment length */
1916
1917     i_timeout = 0;
1918     if( p_subpic && !p_subpic->b_ephemer &&
1919         p_subpic->i_stop > p_subpic->i_start )
1920     {
1921         i_timeout = (p_subpic->i_stop - p_subpic->i_start) / 1000000;
1922     }
1923
1924     bs_write( s, 8, i_timeout + p_sys->i_timeout_delay ); /* Timeout */    
1925     bs_write( s, 4, p_sys->i_page_ver++ );
1926     bs_write( s, 2, b_mode_change ?
1927               DVBSUB_PCS_STATE_CHANGE : DVBSUB_PCS_STATE_ACQUISITION );
1928     bs_write( s, 2, 0 ); /* Reserved */
1929
1930     for( i_regions = 0, p_region = p_subpic ? p_subpic->p_region : 0;
1931          p_region; p_region = p_region->p_next, i_regions++ )
1932     {
1933         bs_write( s, 8, i_regions );
1934         bs_write( s, 8, 0 ); /* Reserved */
1935         if( (p_sys->i_offset_x > 0) && (p_sys->i_offset_y > 0) )
1936         {
1937             bs_write( s, 16, p_sys->i_offset_x ); /* override x position */
1938             bs_write( s, 16, p_sys->i_offset_y ); /* override y position */
1939         }
1940         else
1941         {
1942             bs_write( s, 16, p_region->i_x );
1943             bs_write( s, 16, p_region->i_y );
1944         }
1945     }
1946 }
1947
1948 static void encode_clut( encoder_t *p_enc, bs_t *s, subpicture_t *p_subpic )
1949 {
1950     encoder_sys_t *p_sys = p_enc->p_sys;
1951     subpicture_region_t *p_region = p_subpic->p_region;
1952     video_palette_t *p_pal, pal;
1953     int i;
1954
1955     /* Sanity check */
1956     if( !p_region ) return;
1957
1958     if( p_region->fmt.i_chroma == VLC_FOURCC('Y','U','V','P') )
1959     {
1960         p_pal = p_region->fmt.p_palette;
1961     }
1962     else
1963     {
1964         pal.i_entries = 4;
1965         for( i = 0; i < 4; i++ )
1966         {
1967             pal.palette[i][0] = 0;
1968             pal.palette[i][1] = 0;
1969             pal.palette[i][2] = 0;
1970             pal.palette[i][3] = 0;
1971         }
1972         p_pal = &pal;
1973     }
1974
1975     bs_write( s, 8, 0x0f ); /* Sync byte */
1976     bs_write( s, 8, DVBSUB_ST_CLUT_DEFINITION ); /* Segment type */
1977     bs_write( s, 16, 1 );  /* Page id */
1978
1979     bs_write( s, 16, p_pal->i_entries * 6 + 2 ); /* Segment length */
1980     bs_write( s, 8, 1 ); /* Clut id */
1981     bs_write( s, 4, p_sys->i_clut_ver++ );
1982     bs_write( s, 4, 0 ); /* Reserved */
1983
1984     for( i = 0; i < p_pal->i_entries; i++ )
1985     {
1986         bs_write( s, 8, i ); /* Clut entry id */
1987         bs_write( s, 1, p_pal->i_entries == 4 );   /* 2bit/entry flag */
1988         bs_write( s, 1, p_pal->i_entries == 16 );  /* 4bit/entry flag */
1989         bs_write( s, 1, p_pal->i_entries == 256 ); /* 8bit/entry flag */
1990         bs_write( s, 4, 0 ); /* Reserved */
1991         bs_write( s, 1, 1 ); /* Full range flag */
1992         bs_write( s, 8, p_pal->palette[i][3] ?  /* Y value */
1993                   (p_pal->palette[i][0] ? p_pal->palette[i][0] : 16) : 0 );
1994         bs_write( s, 8, p_pal->palette[i][1] ); /* Cr value */
1995         bs_write( s, 8, p_pal->palette[i][2] ); /* Cb value */
1996         bs_write( s, 8, 0xff - p_pal->palette[i][3] ); /* T value */
1997     }
1998 }
1999
2000 static void encode_region_composition( encoder_t *p_enc, bs_t *s,
2001                                        subpicture_t *p_subpic )
2002 {
2003     encoder_sys_t *p_sys = p_enc->p_sys;
2004     subpicture_region_t *p_region;
2005     int i_region;
2006
2007     for( i_region = 0, p_region = p_subpic->p_region; p_region;
2008          p_region = p_region->p_next, i_region++ )
2009     {
2010         int i_entries = 4, i_depth = 0x1, i_bg = 0;
2011         vlc_bool_t b_text =
2012             p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T');
2013
2014         if( !b_text )
2015         {
2016             video_palette_t *p_pal = p_region->fmt.p_palette;
2017         
2018             if( !p_pal )
2019             {
2020                 msg_Err( p_enc, "subpicture has no palette - ignoring it" );
2021                 break;
2022             }
2023
2024             i_entries = p_pal->i_entries;
2025             i_depth = i_entries == 4 ? 0x1 : i_entries == 16 ? 0x2 : 0x3;
2026
2027             for( i_bg = 0; i_bg < p_pal->i_entries; i_bg++ )
2028             {
2029                 if( !p_pal->palette[i_bg][3] ) break;
2030             }
2031         }
2032
2033         bs_write( s, 8, 0x0f ); /* Sync byte */
2034         bs_write( s, 8, DVBSUB_ST_REGION_COMPOSITION ); /* Segment type */
2035         bs_write( s, 16, 1 );   /* Page id */
2036
2037         bs_write( s, 16, 10 + 6 + (b_text ? 2 : 0) ); /* Segment length */
2038         bs_write( s, 8, i_region );
2039         bs_write( s, 4, p_sys->i_region_ver++ );
2040
2041         /* Region attributes */
2042         bs_write( s, 1, i_bg < i_entries ); /* Fill */
2043         bs_write( s, 3, 0 ); /* Reserved */
2044         bs_write( s, 16, p_sys->p_regions[i_region].i_width );
2045         bs_write( s, 16, p_sys->p_regions[i_region].i_height );
2046         bs_write( s, 3, i_depth );  /* Region level of compatibility */
2047         bs_write( s, 3, i_depth  ); /* Region depth */
2048         bs_write( s, 2, 0 ); /* Reserved */
2049         bs_write( s, 8, 1 ); /* Clut id */
2050         bs_write( s, 8, i_bg ); /* region 8bit pixel code */
2051         bs_write( s, 4, i_bg ); /* region 4bit pixel code */
2052         bs_write( s, 2, i_bg ); /* region 2bit pixel code */
2053         bs_write( s, 2, 0 ); /* Reserved */
2054
2055         /* In our implementation we only have 1 object per region */
2056         bs_write( s, 16, i_region );
2057         bs_write( s, 2, b_text ? DVBSUB_OT_BASIC_CHAR:DVBSUB_OT_BASIC_BITMAP );
2058         bs_write( s, 2, 0 ); /* object provider flag */
2059         bs_write( s, 12, 0 );/* object horizontal position */
2060         bs_write( s, 4, 0 ); /* Reserved */
2061         bs_write( s, 12, 0 );/* object vertical position */
2062
2063         if( b_text )
2064         {
2065             bs_write( s, 8, 1 ); /* foreground pixel code */
2066             bs_write( s, 8, 0 ); /* background pixel code */
2067         }
2068     }
2069 }
2070
2071 static void encode_pixel_data( encoder_t *p_enc, bs_t *s,
2072                                subpicture_region_t *p_region,
2073                                vlc_bool_t b_top );
2074
2075 static void encode_object( encoder_t *p_enc, bs_t *s, subpicture_t *p_subpic )
2076 {
2077     encoder_sys_t *p_sys = p_enc->p_sys;
2078     subpicture_region_t *p_region;
2079     int i_region;
2080
2081     int i_length_pos, i_update_pos, i_pixel_data_pos;
2082
2083     for( i_region = 0, p_region = p_subpic->p_region; p_region;
2084          p_region = p_region->p_next, i_region++ )
2085     {
2086         bs_write( s, 8, 0x0f ); /* Sync byte */
2087         bs_write( s, 8, DVBSUB_ST_OBJECT_DATA ); /* Segment type */
2088         bs_write( s, 16, 1 ); /* Page id */
2089
2090         i_length_pos = bs_pos( s );
2091         bs_write( s, 16, 0 ); /* Segment length */
2092         bs_write( s, 16, i_region ); /* Object id */
2093         bs_write( s, 4, p_sys->i_region_ver++ );
2094
2095         /* object coding method */
2096         switch( p_region->fmt.i_chroma )
2097         {
2098         case VLC_FOURCC( 'Y','U','V','P' ):
2099             bs_write( s, 2, 0 );
2100             break;
2101         case VLC_FOURCC( 'T','E','X','T' ):
2102             bs_write( s, 2, 1 );
2103             break;
2104         default:
2105             msg_Err( p_enc, "FOURCC %d not supported by encoder.", p_region->fmt.i_chroma );
2106             continue;
2107         }
2108
2109         bs_write( s, 1, 0 ); /* non modifying color flag */
2110         bs_write( s, 1, 0 ); /* Reserved */
2111
2112         if( p_region->fmt.i_chroma == VLC_FOURCC( 'T','E','X','T' ) )
2113         {
2114             int i_size, i;
2115
2116             if( !p_region->psz_text ) continue;
2117
2118             i_size = __MIN( strlen( p_region->psz_text ), 256 );
2119
2120             bs_write( s, 8, i_size ); /* number of characters in string */
2121             for( i = 0; i < i_size; i++ )
2122             {
2123                 bs_write( s, 16, p_region->psz_text[i] );
2124             }     
2125
2126             /* Update segment length */
2127             SetWBE( &s->p_start[i_length_pos/8],
2128                     (bs_pos(s) - i_length_pos)/8 -2 );
2129             continue;
2130         }
2131
2132         /* Coding of a bitmap object */
2133         i_update_pos = bs_pos( s );
2134         bs_write( s, 16, 0 ); /* topfield data block length */
2135         bs_write( s, 16, 0 ); /* bottomfield data block length */
2136
2137         /* Top field */
2138         i_pixel_data_pos = bs_pos( s );
2139         encode_pixel_data( p_enc, s, p_region, VLC_TRUE );
2140         i_pixel_data_pos = ( bs_pos( s ) - i_pixel_data_pos ) / 8;
2141         SetWBE( &s->p_start[i_update_pos/8], i_pixel_data_pos );
2142
2143         /* Bottom field */
2144         i_pixel_data_pos = bs_pos( s );
2145         encode_pixel_data( p_enc, s, p_region, VLC_FALSE );
2146         i_pixel_data_pos = ( bs_pos( s ) - i_pixel_data_pos ) / 8;
2147         SetWBE( &s->p_start[i_update_pos/8+2], i_pixel_data_pos );
2148
2149         /* Stuffing for word alignment */
2150         bs_align_0( s );
2151         if( bs_pos( s ) % 16 ) bs_write( s, 8, 0 );
2152
2153         /* Update segment length */
2154         SetWBE( &s->p_start[i_length_pos/8], (bs_pos(s) - i_length_pos)/8 -2 );
2155     }
2156 }
2157
2158 static void encode_pixel_line_2bp( encoder_t *p_enc, bs_t *s,
2159                                    subpicture_region_t *p_region,
2160                                    int i_line );
2161 static void encode_pixel_line_4bp( encoder_t *p_enc, bs_t *s,
2162                                    subpicture_region_t *p_region,
2163                                    int i_line );
2164 static void encode_pixel_line_8bp( encoder_t *p_enc, bs_t *s,
2165                                    subpicture_region_t *p_region,
2166                                    int i_line );
2167 static void encode_pixel_data( encoder_t *p_enc, bs_t *s,
2168                                subpicture_region_t *p_region,
2169                                vlc_bool_t b_top )
2170 {
2171     unsigned int i_line;
2172
2173     /* Sanity check */
2174     if( p_region->fmt.i_chroma != VLC_FOURCC('Y','U','V','P') ) return;
2175
2176     /* Encode line by line */
2177     for( i_line = !b_top; i_line < p_region->fmt.i_visible_height;
2178          i_line += 2 )
2179     {
2180         switch( p_region->fmt.p_palette->i_entries )
2181         {
2182         case 4:
2183             bs_write( s, 8, 0x10 ); /* 2 bit/pixel code string */
2184             encode_pixel_line_2bp( p_enc, s, p_region, i_line );
2185             break;
2186
2187         case 16:
2188             bs_write( s, 8, 0x11 ); /* 4 bit/pixel code string */
2189             encode_pixel_line_4bp( p_enc, s, p_region, i_line );
2190             break;
2191
2192         case 256:
2193             bs_write( s, 8, 0x12 ); /* 8 bit/pixel code string */
2194             encode_pixel_line_8bp( p_enc, s, p_region, i_line );
2195             break;
2196
2197         default:
2198             msg_Err( p_enc, "subpicture palette (%i) not handled",
2199                      p_region->fmt.p_palette->i_entries );
2200             break;
2201         }
2202
2203         bs_write( s, 8, 0xf0 ); /* End of object line code */
2204     }
2205 }
2206
2207 static void encode_pixel_line_2bp( encoder_t *p_enc, bs_t *s,
2208                                    subpicture_region_t *p_region,
2209                                    int i_line )
2210 {
2211     unsigned int i, i_length = 0;
2212     int i_pitch = p_region->picture.p->i_pitch;
2213     uint8_t *p_data = &p_region->picture.p->p_pixels[ i_pitch * i_line ];
2214     int i_last_pixel = p_data[0];
2215
2216     for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
2217     {
2218         if( i != p_region->fmt.i_visible_width &&
2219             p_data[i] == i_last_pixel && i_length != 284 )
2220         {
2221             i_length++;
2222             continue;
2223         }
2224
2225         if( i_length == 1 || i_length == 11 || i_length == 28 )
2226         {
2227             /* 2bit/pixel code */
2228             if( i_last_pixel ) bs_write( s, 2, i_last_pixel );
2229             else
2230             {
2231                 bs_write( s, 2, 0 );
2232                 bs_write( s, 1, 0 );
2233                 bs_write( s, 1, 1 ); /* pseudo color 0 */
2234             }
2235             i_length--;
2236         }
2237
2238         if( i_length == 2 )
2239         {
2240             if( i_last_pixel )
2241             {
2242                 bs_write( s, 2, i_last_pixel );
2243                 bs_write( s, 2, i_last_pixel );
2244             }
2245             else
2246             {
2247                 bs_write( s, 2, 0 );
2248                 bs_write( s, 1, 0 );
2249                 bs_write( s, 1, 0 );
2250                 bs_write( s, 2, 1 ); /* 2 * pseudo color 0 */
2251             }
2252         }
2253         else if( i_length > 2 )
2254         {
2255             bs_write( s, 2, 0 );
2256             if( i_length <= 10 )
2257             {
2258                 bs_write( s, 1, 1 );
2259                 bs_write( s, 3, i_length - 3 );
2260                 bs_write( s, 2, i_last_pixel );
2261             }
2262             else
2263             {
2264                 bs_write( s, 1, 0 );
2265                 bs_write( s, 1, 0 );
2266
2267                 if( i_length <= 27 )
2268                 {
2269                     bs_write( s, 2, 2 );
2270                     bs_write( s, 4, i_length - 12 );
2271                     bs_write( s, 2, i_last_pixel );
2272                 }
2273                 else
2274                 {
2275                     bs_write( s, 2, 3 );
2276                     bs_write( s, 8, i_length - 29 );
2277                     bs_write( s, 2, i_last_pixel );
2278                 }
2279             }
2280         }
2281
2282         if( i == p_region->fmt.i_visible_width ) break;
2283
2284         i_last_pixel = p_data[i];
2285         i_length = 1;
2286     }
2287
2288     /* Stop */
2289     bs_write( s, 2, 0 );
2290     bs_write( s, 1, 0 );
2291     bs_write( s, 1, 0 );
2292     bs_write( s, 2, 0 );
2293
2294     /* Stuffing */
2295     bs_align_0( s );
2296 }
2297
2298 static void encode_pixel_line_4bp( encoder_t *p_enc, bs_t *s,
2299                                    subpicture_region_t *p_region,
2300                                    int i_line )
2301 {
2302     unsigned int i, i_length = 0;
2303     int i_pitch = p_region->picture.p->i_pitch;
2304     uint8_t *p_data = &p_region->picture.p->p_pixels[ i_pitch * i_line ];
2305     int i_last_pixel = p_data[0];
2306
2307     for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
2308     {
2309         if( i != p_region->fmt.i_visible_width &&
2310             p_data[i] == i_last_pixel && i_length != 280 )
2311         {
2312             i_length++;
2313             continue;
2314         }
2315
2316         if( i_length == 1 || (i_length == 3 && i_last_pixel) || i_length == 8 )
2317         {
2318             /* 4bit/pixel code */
2319             if( i_last_pixel ) bs_write( s, 4, i_last_pixel );
2320             else
2321             {
2322                 bs_write( s, 4, 0 );
2323                 bs_write( s, 1, 1 );
2324                 bs_write( s, 1, 1 );
2325                 bs_write( s, 2, 0 ); /* pseudo color 0 */
2326             }
2327             i_length--;
2328         }
2329
2330         if( i_length == 2 )
2331         {
2332             if( i_last_pixel )
2333             {
2334                 bs_write( s, 4, i_last_pixel );
2335                 bs_write( s, 4, i_last_pixel );
2336             }
2337             else
2338             {
2339                 bs_write( s, 4, 0 );
2340                 bs_write( s, 1, 1 );
2341                 bs_write( s, 1, 1 );
2342                 bs_write( s, 2, 1 ); /* 2 * pseudo color 0 */
2343             }
2344         }
2345         else if( !i_last_pixel && i_length >= 3 && i_length <= 9 )
2346         {
2347             bs_write( s, 4, 0 );
2348             bs_write( s, 1, 0 );
2349             bs_write( s, 3, i_length - 2 ); /* (i_length - 2) * color 0 */
2350         }
2351         else if( i_length > 2 )
2352         {
2353             bs_write( s, 4, 0 );
2354             bs_write( s, 1, 1 );
2355
2356             if( i_length <= 7 )
2357             {
2358                 bs_write( s, 1, 0 );
2359                 bs_write( s, 2, i_length - 4 );
2360                 bs_write( s, 4, i_last_pixel );
2361             }
2362             else
2363             {
2364                 bs_write( s, 1, 1 );
2365
2366                 if( i_length <= 24 )
2367                 {
2368                     bs_write( s, 2, 2 );
2369                     bs_write( s, 4, i_length - 9 );
2370                     bs_write( s, 4, i_last_pixel );
2371                 }
2372                 else
2373                 {
2374                     bs_write( s, 2, 3 );
2375                     bs_write( s, 8, i_length - 25 );
2376                     bs_write( s, 4, i_last_pixel );
2377                 }
2378             }
2379         }
2380
2381         if( i == p_region->fmt.i_visible_width ) break;
2382
2383         i_last_pixel = p_data[i];
2384         i_length = 1;
2385     }
2386
2387     /* Stop */
2388     bs_write( s, 8, 0 );
2389
2390     /* Stuffing */
2391     bs_align_0( s );
2392 }
2393
2394 static void encode_pixel_line_8bp( encoder_t *p_enc, bs_t *s,
2395                                    subpicture_region_t *p_region,
2396                                    int i_line )
2397 {
2398     unsigned int i, i_length = 0;
2399     int i_pitch = p_region->picture.p->i_pitch;
2400     uint8_t *p_data = &p_region->picture.p->p_pixels[ i_pitch * i_line ];
2401     int i_last_pixel = p_data[0];
2402
2403     for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
2404     {
2405         if( i != p_region->fmt.i_visible_width &&
2406             p_data[i] == i_last_pixel && i_length != 127 )
2407         {
2408             i_length++;
2409             continue;
2410         }
2411
2412         if( i_length == 1 && i_last_pixel )
2413         {
2414             /* 8bit/pixel code */
2415             bs_write( s, 8, i_last_pixel );
2416         }
2417         else if( i_length == 2 && i_last_pixel )
2418         {
2419             /* 8bit/pixel code */
2420             bs_write( s, 8, i_last_pixel );
2421             bs_write( s, 8, i_last_pixel );
2422         }
2423         else if( i_length <= 127 )
2424         {
2425             bs_write( s, 8, 0 );
2426
2427             if( !i_last_pixel )
2428             {
2429                 bs_write( s, 1, 0 );
2430                 bs_write( s, 7, i_length ); /* pseudo color 0 */
2431             }
2432             else
2433             {
2434                 bs_write( s, 1, 1 );
2435                 bs_write( s, 7, i_length );
2436                 bs_write( s, 8, i_last_pixel );
2437             }
2438         }
2439
2440         if( i == p_region->fmt.i_visible_width ) break;
2441
2442         i_last_pixel = p_data[i];
2443         i_length = 1;
2444     }
2445
2446     /* Stop */
2447     bs_write( s, 8, 0 );
2448     bs_write( s, 8, 0 );
2449
2450     /* Stuffing */
2451     bs_align_0( s );
2452 }