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