access_http: use the user agent provided by the user: fix #4162
[vlc/asuraparaju-public.git] / modules / codec / dvbsub.c
blobfb7619cfa4a22e54605cce34572b852095c48024
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-2009 the VideoLAN team
7 * $Id$
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 * Derk-Jan Hartman <hartman #at# videolan dot org>
14 * Simon Hailes <simon _a_ screen.subtitling.com>
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software Foundation, Inc.,
28 * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
29 *****************************************************************************/
31 /*****************************************************************************
32 * Preamble
34 * FIXME:
35 * DVB subtitles coded as strings of characters are not handled correctly.
36 * The character codes in the string should actually be indexes referring to a
37 * character table identified in the subtitle descriptor.
39 * The spec is quite vague in this area, but what is meant is perhaps that it
40 * refers to the character index in the codepage belonging to the language
41 * specified in the subtitle descriptor. Potentially it's designed for widechar
42 * (but not for UTF-*) codepages.
43 *****************************************************************************
45 *****************************************************************************
46 * Notes on DDS (Display Definition Segment)
47 * -----------------------------------------
48 * DDS (Display Definition Segment) tells the decoder how the subtitle image
49 * relates to the video image.
50 * For SD, the subtitle image is always considered to be for display at
51 * 720x576 (although it's assumed that for NTSC, this is 720x480, this
52 * is not documented well) Also, for SD, the subtitle image is drawn 'on
53 * the glass' (i.e. after video scaling, letterbox, etc.)
54 * For 'HD' (subs marked type 0x14/0x24 in PSI), a DDS must be present,
55 * and the subs area is drawn onto the video area (scales if necessary).
56 * The DDS tells the decoder what resolution the subtitle images were
57 * intended for, and hence how to scale the subtitle images for a
58 * particular video size
59 * i.e. if HD video is presented as letterbox, the subs will be in the
60 * same place on the video as if the video was presented on an HD set
61 * indeed, if the HD video was pillarboxed by the decoder, the subs may
62 * be cut off as well as the video. The intent here is that the subs can
63 * be placed accurately on the video - something which was missed in the
64 * original spec.
66 * A DDS may also specify a window - this is where the subs images are moved so that the (0,0)
67 * origin of decode is offset.
68 ********************************************************************************************/
70 #ifdef HAVE_CONFIG_H
71 # include "config.h"
72 #endif
74 #include <vlc_common.h>
75 #include <vlc_plugin.h>
76 #include <vlc_codec.h>
77 #include <vlc_sout.h>
79 #include <vlc_bits.h>
81 /* #define DEBUG_DVBSUB 1 */
83 #define POSX_TEXT N_("Decoding X coordinate")
84 #define POSX_LONGTEXT N_("X coordinate of the rendered subtitle")
86 #define POSY_TEXT N_("Decoding Y coordinate")
87 #define POSY_LONGTEXT N_("Y coordinate of the rendered subtitle")
89 #define POS_TEXT N_("Subpicture position")
90 #define POS_LONGTEXT N_( \
91 "You can enforce the subpicture position on the video " \
92 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
93 "also use combinations of these values, e.g. 6=top-right).")
95 #define ENC_POSX_TEXT N_("Encoding X coordinate")
96 #define ENC_POSX_LONGTEXT N_("X coordinate of the encoded subtitle" )
97 #define ENC_POSY_TEXT N_("Encoding Y coordinate")
98 #define ENC_POSY_LONGTEXT N_("Y coordinate of the encoded subtitle" )
100 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
101 static const char *const ppsz_pos_descriptions[] =
102 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
103 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
105 /*****************************************************************************
106 * Module descriptor.
107 *****************************************************************************/
108 static int Open ( vlc_object_t * );
109 static void Close( vlc_object_t * );
110 static subpicture_t *Decode( decoder_t *, block_t ** );
112 static int OpenEncoder ( vlc_object_t * );
113 static void CloseEncoder( vlc_object_t * );
114 static block_t *Encode ( encoder_t *, subpicture_t * );
116 vlc_module_begin ()
117 # define DVBSUB_CFG_PREFIX "dvbsub-"
118 set_description( N_("DVB subtitles decoder") )
119 set_shortname( N_("DVB subtitles") )
120 set_capability( "decoder", 50 )
121 set_category( CAT_INPUT )
122 set_subcategory( SUBCAT_INPUT_SCODEC )
123 set_callbacks( Open, Close )
125 add_integer( DVBSUB_CFG_PREFIX "position", 8, NULL, POS_TEXT, POS_LONGTEXT, true )
126 change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL )
127 add_integer( DVBSUB_CFG_PREFIX "x", -1, NULL, POSX_TEXT, POSX_LONGTEXT, false )
128 add_integer( DVBSUB_CFG_PREFIX "y", -1, NULL, POSY_TEXT, POSY_LONGTEXT, false )
130 # define ENC_CFG_PREFIX "sout-dvbsub-"
131 add_submodule ()
132 set_description( N_("DVB subtitles encoder") )
133 set_capability( "encoder", 100 )
134 set_callbacks( OpenEncoder, CloseEncoder )
136 add_integer( ENC_CFG_PREFIX "x", -1, NULL, ENC_POSX_TEXT, ENC_POSX_LONGTEXT, false )
137 add_integer( ENC_CFG_PREFIX "y", -1, NULL, ENC_POSY_TEXT, ENC_POSY_LONGTEXT, false )
138 add_obsolete_integer( ENC_CFG_PREFIX "timeout" ) /* Suppressed since 0.8.5 */
139 vlc_module_end ()
141 static const char *const ppsz_enc_options[] = { "x", "y", NULL };
143 /****************************************************************************
144 * Local structures
145 ****************************************************************************
146 * Those structures refer closely to the ETSI 300 743 Object model
147 ****************************************************************************/
149 /* The object definition gives the position of the object in a region [7.2.5] */
150 typedef struct dvbsub_objectdef_s
152 int i_id;
153 int i_type;
154 int i_x;
155 int i_y;
156 int i_fg_pc;
157 int i_bg_pc;
158 char *psz_text; /* for string of characters objects */
160 } dvbsub_objectdef_t;
162 /* The entry in the palette CLUT */
163 typedef struct
165 uint8_t Y;
166 uint8_t Cr;
167 uint8_t Cb;
168 uint8_t T;
170 } dvbsub_color_t;
172 /* The displays dimensions [7.2.1] */
173 typedef struct dvbsub_display_s
175 uint8_t i_id;
176 uint8_t i_version;
178 int i_width;
179 int i_height;
181 bool b_windowed;
182 /* these values are only relevant if windowed */
183 int i_x;
184 int i_y;
185 int i_max_x;
186 int i_max_y;
188 } dvbsub_display_t;
190 /* [7.2.4] */
191 typedef struct dvbsub_clut_s
193 uint8_t i_id;
194 uint8_t i_version;
195 dvbsub_color_t c_2b[4];
196 dvbsub_color_t c_4b[16];
197 dvbsub_color_t c_8b[256];
199 struct dvbsub_clut_s *p_next;
201 } dvbsub_clut_t;
203 /* The Region is an aera on the image [7.2.3]
204 * with a list of the object definitions associated and a CLUT */
205 typedef struct dvbsub_region_s
207 int i_id;
208 int i_version;
209 int i_x;
210 int i_y;
211 int i_width;
212 int i_height;
213 int i_level_comp;
214 int i_depth;
215 int i_clut;
217 uint8_t *p_pixbuf;
219 int i_object_defs;
220 dvbsub_objectdef_t *p_object_defs;
222 struct dvbsub_region_s *p_next;
224 } dvbsub_region_t;
226 /* The object definition gives the position of the object in a region */
227 typedef struct dvbsub_regiondef_s
229 int i_id;
230 int i_x;
231 int i_y;
233 } dvbsub_regiondef_t;
235 /* The page defines the list of regions [7.2.2] */
236 typedef struct
238 int i_id;
239 int i_timeout; /* in seconds */
240 int i_state;
241 int i_version;
243 int i_region_defs;
244 dvbsub_regiondef_t *p_region_defs;
246 } dvbsub_page_t;
248 struct decoder_sys_t
250 bs_t bs;
252 /* Decoder internal data */
253 int i_id;
254 int i_ancillary_id;
255 mtime_t i_pts;
257 bool b_absolute;
258 int i_spu_position;
259 int i_spu_x;
260 int i_spu_y;
262 bool b_page;
263 dvbsub_page_t *p_page;
264 dvbsub_region_t *p_regions;
265 dvbsub_clut_t *p_cluts;
266 /* this is very small, so keep forever */
267 dvbsub_display_t display;
268 dvbsub_clut_t default_clut;
272 /* List of different SEGMENT TYPES */
273 /* According to EN 300-743, table 2 */
274 #define DVBSUB_ST_PAGE_COMPOSITION 0x10
275 #define DVBSUB_ST_REGION_COMPOSITION 0x11
276 #define DVBSUB_ST_CLUT_DEFINITION 0x12
277 #define DVBSUB_ST_OBJECT_DATA 0x13
278 #define DVBSUB_ST_DISPLAY_DEFINITION 0x14
279 #define DVBSUB_ST_ENDOFDISPLAY 0x80
280 #define DVBSUB_ST_STUFFING 0xff
281 /* List of different OBJECT TYPES */
282 /* According to EN 300-743, table 6 */
283 #define DVBSUB_OT_BASIC_BITMAP 0x00
284 #define DVBSUB_OT_BASIC_CHAR 0x01
285 #define DVBSUB_OT_COMPOSITE_STRING 0x02
286 /* Pixel DATA TYPES */
287 /* According to EN 300-743, table 9 */
288 #define DVBSUB_DT_2BP_CODE_STRING 0x10
289 #define DVBSUB_DT_4BP_CODE_STRING 0x11
290 #define DVBSUB_DT_8BP_CODE_STRING 0x12
291 #define DVBSUB_DT_24_TABLE_DATA 0x20
292 #define DVBSUB_DT_28_TABLE_DATA 0x21
293 #define DVBSUB_DT_48_TABLE_DATA 0x22
294 #define DVBSUB_DT_END_LINE 0xf0
295 /* List of different Page Composition Segment state */
296 /* According to EN 300-743, 7.2.1 table 3 */
297 #define DVBSUB_PCS_STATE_ACQUISITION 0x01
298 #define DVBSUB_PCS_STATE_CHANGE 0x02
300 /*****************************************************************************
301 * Local prototypes
302 *****************************************************************************/
303 static void decode_segment( decoder_t *, bs_t * );
304 static void decode_page_composition( decoder_t *, bs_t * );
305 static void decode_region_composition( decoder_t *, bs_t * );
306 static void decode_object( decoder_t *, bs_t * );
307 static void decode_display_definition( decoder_t *, bs_t * );
308 static void decode_clut( decoder_t *, bs_t * );
309 static void free_all( decoder_t * );
311 static void default_clut_init( decoder_t * );
312 static void default_dds_init( decoder_t * );
314 static subpicture_t *render( decoder_t * );
316 /*****************************************************************************
317 * Open: probe the decoder and return score
318 *****************************************************************************
319 * Tries to launch a decoder and return score so that the interface is able
320 * to chose.
321 *****************************************************************************/
322 static int Open( vlc_object_t *p_this )
324 decoder_t *p_dec = (decoder_t *) p_this;
325 decoder_sys_t *p_sys;
326 int i_posx, i_posy;
328 if( p_dec->fmt_in.i_codec != VLC_CODEC_DVBS )
330 return VLC_EGENERIC;
333 p_dec->pf_decode_sub = Decode;
334 p_sys = p_dec->p_sys = calloc( 1, sizeof(decoder_sys_t) );
335 if( !p_sys )
336 return VLC_ENOMEM;
338 p_sys->i_pts = VLC_TS_INVALID;
339 p_sys->i_id = p_dec->fmt_in.subs.dvb.i_id & 0xFFFF;
340 p_sys->i_ancillary_id = p_dec->fmt_in.subs.dvb.i_id >> 16;
342 p_sys->p_regions = NULL;
343 p_sys->p_cluts = NULL;
344 p_sys->p_page = NULL;
346 /* configure for SD res in case DDS is not present */
347 default_dds_init( p_dec );
349 p_sys->i_spu_position = var_CreateGetInteger( p_this,
350 DVBSUB_CFG_PREFIX "position" );
351 i_posx = var_CreateGetInteger( p_this, DVBSUB_CFG_PREFIX "x" );
352 i_posy = var_CreateGetInteger( p_this, DVBSUB_CFG_PREFIX "y" );
354 /* Check if subpicture position was overridden */
355 p_sys->b_absolute = true;
356 p_sys->i_spu_x = p_sys->i_spu_y = 0;
358 if( ( i_posx >= 0 ) && ( i_posy >= 0 ) )
360 p_sys->b_absolute = true;
361 p_sys->i_spu_x = i_posx;
362 p_sys->i_spu_y = i_posy;
365 p_dec->fmt_out.i_cat = SPU_ES;
366 p_dec->fmt_out.i_codec = 0;
368 default_clut_init( p_dec );
370 return VLC_SUCCESS;
373 /*****************************************************************************
374 * Close:
375 *****************************************************************************/
376 static void Close( vlc_object_t *p_this )
378 decoder_t *p_dec = (decoder_t*) p_this;
379 decoder_sys_t *p_sys = p_dec->p_sys;
381 var_Destroy( p_this, DVBSUB_CFG_PREFIX "x" );
382 var_Destroy( p_this, DVBSUB_CFG_PREFIX "y" );
383 var_Destroy( p_this, DVBSUB_CFG_PREFIX "position" );
385 free_all( p_dec );
386 free( p_sys );
389 /*****************************************************************************
390 * Decode:
391 *****************************************************************************/
392 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
394 decoder_sys_t *p_sys = p_dec->p_sys;
395 block_t *p_block;
396 subpicture_t *p_spu = NULL;
398 if( ( pp_block == NULL ) || ( *pp_block == NULL ) ) return NULL;
399 p_block = *pp_block;
400 *pp_block = NULL;
402 /* configure for SD res in case DDS is not present */
403 /* a change of PTS is a good indication we must get a new DDS */
404 if (p_sys->i_pts != p_block->i_pts)
405 default_dds_init( p_dec );
407 p_sys->i_pts = p_block->i_pts;
408 if( p_sys->i_pts <= VLC_TS_INVALID )
410 #ifdef DEBUG_DVBSUB
411 /* Some DVB channels send stuffing segments in non-dated packets so
412 * don't complain too loudly. */
413 msg_Warn( p_dec, "non dated subtitle" );
414 #endif
415 block_Release( p_block );
416 return NULL;
419 bs_init( &p_sys->bs, p_block->p_buffer, p_block->i_buffer );
421 if( bs_read( &p_sys->bs, 8 ) != 0x20 ) /* Data identifier */
423 msg_Dbg( p_dec, "invalid data identifier" );
424 block_Release( p_block );
425 return NULL;
428 if( bs_read( &p_sys->bs, 8 ) ) /* Subtitle stream id */
430 msg_Dbg( p_dec, "invalid subtitle stream id" );
431 block_Release( p_block );
432 return NULL;
435 #ifdef DEBUG_DVBSUB
436 msg_Dbg( p_dec, "subtitle packet received: %"PRId64, p_sys->i_pts );
437 #endif
439 p_sys->b_page = false;
440 while( bs_show( &p_sys->bs, 8 ) == 0x0f ) /* Sync byte */
442 decode_segment( p_dec, &p_sys->bs );
445 if( bs_read( &p_sys->bs, 8 ) != 0xff ) /* End marker */
447 msg_Warn( p_dec, "end marker not found (corrupted subtitle ?)" );
448 block_Release( p_block );
449 return NULL;
452 /* Check if the page is to be displayed */
453 if( p_sys->p_page && p_sys->b_page )
454 p_spu = render( p_dec );
456 block_Release( p_block );
458 return p_spu;
461 /* following functions are local */
463 /*****************************************************************************
464 * default_clut_init: default clut as defined in EN 300-743 section 10
465 *****************************************************************************/
466 static void default_clut_init( decoder_t *p_dec )
468 decoder_sys_t *p_sys = p_dec->p_sys;
469 uint8_t i;
471 #define RGB_TO_Y(r, g, b) ((int16_t) 77 * r + 150 * g + 29 * b) / 256;
472 #define RGB_TO_U(r, g, b) ((int16_t) -44 * r - 87 * g + 131 * b) / 256;
473 #define RGB_TO_V(r, g, b) ((int16_t) 131 * r - 110 * g - 21 * b) / 256;
475 /* 4 entries CLUT */
476 for( i = 0; i < 4; i++ )
478 uint8_t R = 0, G = 0, B = 0, T = 0;
480 if( !(i & 0x2) && !(i & 0x1) ) T = 0xFF;
481 else if( !(i & 0x2) && (i & 0x1) ) R = G = B = 0xFF;
482 else if( (i & 0x2) && !(i & 0x1) ) R = G = B = 0;
483 else R = G = B = 0x7F;
485 p_sys->default_clut.c_2b[i].Y = RGB_TO_Y(R,G,B);
486 p_sys->default_clut.c_2b[i].Cb = RGB_TO_V(R,G,B);
487 p_sys->default_clut.c_2b[i].Cr = RGB_TO_U(R,G,B);
488 p_sys->default_clut.c_2b[i].T = T;
491 /* 16 entries CLUT */
492 for( i = 0; i < 16; i++ )
494 uint8_t R = 0, G = 0, B = 0, T = 0;
496 if( !(i & 0x8) )
498 if( !(i & 0x4) && !(i & 0x2) && !(i & 0x1) )
500 T = 0xFF;
502 else
504 R = (i & 0x1) ? 0xFF : 0;
505 G = (i & 0x2) ? 0xFF : 0;
506 B = (i & 0x4) ? 0xFF : 0;
509 else
511 R = (i & 0x1) ? 0x7F : 0;
512 G = (i & 0x2) ? 0x7F : 0;
513 B = (i & 0x4) ? 0x7F : 0;
516 p_sys->default_clut.c_4b[i].Y = RGB_TO_Y(R,G,B);
517 p_sys->default_clut.c_4b[i].Cr = RGB_TO_V(R,G,B);
518 p_sys->default_clut.c_4b[i].Cb = RGB_TO_U(R,G,B);
519 p_sys->default_clut.c_4b[i].T = T;
522 /* 256 entries CLUT */
523 memset( p_sys->default_clut.c_8b, 0xFF, 256 * sizeof(dvbsub_color_t) );
526 static void decode_segment( decoder_t *p_dec, bs_t *s )
528 decoder_sys_t *p_sys = p_dec->p_sys;
529 int i_type;
530 int i_page_id;
531 int i_size;
533 /* sync_byte (already checked) */
534 bs_skip( s, 8 );
536 /* segment type */
537 i_type = bs_read( s, 8 );
539 /* page id */
540 i_page_id = bs_read( s, 16 );
542 /* segment size */
543 i_size = bs_show( s, 16 );
545 if( ( i_page_id != p_sys->i_id ) &&
546 ( i_page_id != p_sys->i_ancillary_id ) )
548 #ifdef DEBUG_DVBSUB
549 msg_Dbg( p_dec, "subtitle skipped (page id: %i, %i)",
550 i_page_id, p_sys->i_id );
551 #endif
552 bs_skip( s, 8 * ( 2 + i_size ) );
553 return;
556 if( ( p_sys->i_ancillary_id != p_sys->i_id ) &&
557 ( i_type == DVBSUB_ST_PAGE_COMPOSITION ) &&
558 ( i_page_id == p_sys->i_ancillary_id ) )
560 #ifdef DEBUG_DVBSUB
561 msg_Dbg( p_dec, "skipped invalid ancillary subtitle packet" );
562 #endif
563 bs_skip( s, 8 * ( 2 + i_size ) );
564 return;
567 #ifdef DEBUG_DVBSUB
568 if( i_page_id == p_sys->i_id )
569 msg_Dbg( p_dec, "segment (id: %i)", i_page_id );
570 else
571 msg_Dbg( p_dec, "ancillary segment (id: %i)", i_page_id );
572 #endif
574 switch( i_type )
576 case DVBSUB_ST_PAGE_COMPOSITION:
577 #ifdef DEBUG_DVBSUB
578 msg_Dbg( p_dec, "decode_page_composition" );
579 #endif
580 decode_page_composition( p_dec, s );
581 break;
583 case DVBSUB_ST_REGION_COMPOSITION:
584 #ifdef DEBUG_DVBSUB
585 msg_Dbg( p_dec, "decode_region_composition" );
586 #endif
587 decode_region_composition( p_dec, s );
588 break;
590 case DVBSUB_ST_CLUT_DEFINITION:
591 #ifdef DEBUG_DVBSUB
592 msg_Dbg( p_dec, "decode_clut" );
593 #endif
594 decode_clut( p_dec, s );
595 break;
597 case DVBSUB_ST_OBJECT_DATA:
598 #ifdef DEBUG_DVBSUB
599 msg_Dbg( p_dec, "decode_object" );
600 #endif
601 decode_object( p_dec, s );
602 break;
604 case DVBSUB_ST_DISPLAY_DEFINITION:
605 #ifdef DEBUG_DVBSUB
606 msg_Dbg( p_dec, "decode_display_definition" );
607 #endif
608 decode_display_definition( p_dec, s );
609 break;
611 case DVBSUB_ST_ENDOFDISPLAY:
612 #ifdef DEBUG_DVBSUB
613 msg_Dbg( p_dec, "end of display" );
614 #endif
615 bs_skip( s, 8 * ( 2 + i_size ) );
616 break;
618 case DVBSUB_ST_STUFFING:
619 #ifdef DEBUG_DVBSUB
620 msg_Dbg( p_dec, "skip stuffing" );
621 #endif
622 bs_skip( s, 8 * ( 2 + i_size ) );
623 break;
625 default:
626 msg_Warn( p_dec, "unsupported segment type: (%04x)", i_type );
627 bs_skip( s, 8 * ( 2 + i_size ) );
628 break;
632 static void decode_clut( decoder_t *p_dec, bs_t *s )
634 decoder_sys_t *p_sys = p_dec->p_sys;
635 uint16_t i_segment_length;
636 uint16_t i_processed_length;
637 dvbsub_clut_t *p_clut, *p_next;
638 int i_id, i_version;
640 i_segment_length = bs_read( s, 16 );
641 i_id = bs_read( s, 8 );
642 i_version = bs_read( s, 4 );
644 /* Check if we already have this clut */
645 for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut->p_next )
647 if( p_clut->i_id == i_id ) break;
650 /* Check version number */
651 if( p_clut && ( p_clut->i_version == i_version ) )
653 /* Nothing to do */
654 bs_skip( s, 8 * i_segment_length - 12 );
655 return;
658 if( !p_clut )
660 #ifdef DEBUG_DVBSUB
661 msg_Dbg( p_dec, "new clut: %i", i_id );
662 #endif
663 p_clut = malloc( sizeof( dvbsub_clut_t ) );
664 if( !p_clut )
665 return;
666 p_clut->p_next = p_sys->p_cluts;
667 p_sys->p_cluts = p_clut;
670 /* Initialize to default clut */
671 p_next = p_clut->p_next;
672 *p_clut = p_sys->default_clut;
673 p_clut->p_next = p_next;
675 /* We don't have this version of the CLUT: Parse it */
676 p_clut->i_version = i_version;
677 p_clut->i_id = i_id;
678 bs_skip( s, 4 ); /* Reserved bits */
679 i_processed_length = 2;
680 while( i_processed_length < i_segment_length )
682 uint8_t y, cb, cr, t;
683 uint8_t i_id;
684 uint8_t i_type;
686 i_id = bs_read( s, 8 );
687 i_type = bs_read( s, 3 );
689 bs_skip( s, 4 );
691 if( bs_read( s, 1 ) )
693 y = bs_read( s, 8 );
694 cr = bs_read( s, 8 );
695 cb = bs_read( s, 8 );
696 t = bs_read( s, 8 );
697 i_processed_length += 6;
699 else
701 y = bs_read( s, 6 ) << 2;
702 cr = bs_read( s, 4 ) << 4;
703 cb = bs_read( s, 4 ) << 4;
704 t = bs_read( s, 2 ) << 6;
705 i_processed_length += 4;
708 /* We are not entirely compliant here as full transparency is indicated
709 * with a luma value of zero, not a transparency value of 0xff
710 * (full transparency would actually be 0xff + 1). */
711 if( y == 0 )
713 cr = cb = 0;
714 t = 0xff;
717 /* According to EN 300-743 section 7.2.3 note 1, type should
718 * not have more than 1 bit set to one, but some streams don't
719 * respect this note. */
720 if( ( i_type & 0x04 ) && ( i_id < 4 ) )
722 p_clut->c_2b[i_id].Y = y;
723 p_clut->c_2b[i_id].Cr = cr;
724 p_clut->c_2b[i_id].Cb = cb;
725 p_clut->c_2b[i_id].T = t;
727 if( ( i_type & 0x02 ) && ( i_id < 16 ) )
729 p_clut->c_4b[i_id].Y = y;
730 p_clut->c_4b[i_id].Cr = cr;
731 p_clut->c_4b[i_id].Cb = cb;
732 p_clut->c_4b[i_id].T = t;
734 if( i_type & 0x01 )
736 p_clut->c_8b[i_id].Y = y;
737 p_clut->c_8b[i_id].Cr = cr;
738 p_clut->c_8b[i_id].Cb = cb;
739 p_clut->c_8b[i_id].T = t;
744 static void decode_page_composition( decoder_t *p_dec, bs_t *s )
746 decoder_sys_t *p_sys = p_dec->p_sys;
747 int i_version, i_state, i_segment_length, i_timeout, i;
749 /* A page is composed by 0 or more region */
750 i_segment_length = bs_read( s, 16 );
751 i_timeout = bs_read( s, 8 );
752 i_version = bs_read( s, 4 );
753 i_state = bs_read( s, 2 );
754 bs_skip( s, 2 ); /* Reserved */
756 if( i_state == DVBSUB_PCS_STATE_CHANGE )
758 /* End of an epoch, reset decoder buffer */
759 #ifdef DEBUG_DVBSUB
760 msg_Dbg( p_dec, "page composition mode change" );
761 #endif
762 free_all( p_dec );
764 else if( !p_sys->p_page && ( i_state != DVBSUB_PCS_STATE_ACQUISITION ) &&
765 ( i_state != DVBSUB_PCS_STATE_CHANGE ) )
767 /* Not a full PCS, we need to wait for one */
768 msg_Dbg( p_dec, "didn't receive an acquisition page yet" );
770 #if 0
771 /* Try to start decoding even without an acquisition page */
772 bs_skip( s, 8 * (i_segment_length - 2) );
773 return;
774 #endif
777 #ifdef DEBUG_DVBSUB
778 if( i_state == DVBSUB_PCS_STATE_ACQUISITION )
779 msg_Dbg( p_dec, "acquisition page composition" );
780 #endif
782 /* Check version number */
783 if( p_sys->p_page && ( p_sys->p_page->i_version == i_version ) )
785 bs_skip( s, 8 * (i_segment_length - 2) );
786 return;
788 else if( p_sys->p_page )
790 if( p_sys->p_page->i_region_defs )
791 free( p_sys->p_page->p_region_defs );
792 p_sys->p_page->p_region_defs = NULL;
793 p_sys->p_page->i_region_defs = 0;
796 if( !p_sys->p_page )
798 #ifdef DEBUG_DVBSUB
799 msg_Dbg( p_dec, "new page" );
800 #endif
801 /* Allocate a new page */
802 p_sys->p_page = malloc( sizeof(dvbsub_page_t) );
803 if( !p_sys->p_page )
804 return;
807 p_sys->p_page->i_version = i_version;
808 p_sys->p_page->i_timeout = i_timeout;
809 p_sys->b_page = true;
811 /* Number of regions */
812 p_sys->p_page->i_region_defs = (i_segment_length - 2) / 6;
814 if( p_sys->p_page->i_region_defs == 0 ) return;
816 p_sys->p_page->p_region_defs =
817 malloc( p_sys->p_page->i_region_defs * sizeof(dvbsub_region_t) );
818 if( p_sys->p_page->p_region_defs )
820 for( i = 0; i < p_sys->p_page->i_region_defs; i++ )
822 p_sys->p_page->p_region_defs[i].i_id = bs_read( s, 8 );
823 bs_skip( s, 8 ); /* Reserved */
824 p_sys->p_page->p_region_defs[i].i_x = bs_read( s, 16 );
825 p_sys->p_page->p_region_defs[i].i_y = bs_read( s, 16 );
827 #ifdef DEBUG_DVBSUB
828 msg_Dbg( p_dec, "page_composition, region %i (%i,%i)",
829 i, p_sys->p_page->p_region_defs[i].i_x,
830 p_sys->p_page->p_region_defs[i].i_y );
831 #endif
836 static void decode_region_composition( decoder_t *p_dec, bs_t *s )
838 decoder_sys_t *p_sys = p_dec->p_sys;
839 dvbsub_region_t *p_region, **pp_region = &p_sys->p_regions;
840 int i_segment_length, i_processed_length, i_id, i_version;
841 int i_width, i_height, i_level_comp, i_depth, i_clut;
842 int i_8_bg, i_4_bg, i_2_bg;
843 bool b_fill;
845 i_segment_length = bs_read( s, 16 );
846 i_id = bs_read( s, 8 );
847 i_version = bs_read( s, 4 );
849 /* Check if we already have this region */
850 for( p_region = p_sys->p_regions; p_region != NULL;
851 p_region = p_region->p_next )
853 pp_region = &p_region->p_next;
854 if( p_region->i_id == i_id ) break;
857 /* Check version number */
858 if( p_region && ( p_region->i_version == i_version ) )
860 bs_skip( s, 8 * (i_segment_length - 1) - 4 );
861 return;
864 if( !p_region )
866 #ifdef DEBUG_DVBSUB
867 msg_Dbg( p_dec, "new region: %i", i_id );
868 #endif
869 p_region = *pp_region = calloc( 1, sizeof(dvbsub_region_t) );
870 if( !p_region )
871 return;
872 p_region->p_object_defs = NULL;
873 p_region->p_pixbuf = NULL;
874 p_region->p_next = NULL;
877 /* Region attributes */
878 p_region->i_id = i_id;
879 p_region->i_version = i_version;
880 b_fill = bs_read( s, 1 );
881 bs_skip( s, 3 ); /* Reserved */
883 i_width = bs_read( s, 16 );
884 i_height = bs_read( s, 16 );
885 #ifdef DEBUG_DVBSUB
886 msg_Dbg( p_dec, " width=%d height=%d", i_width, i_height );
887 #endif
888 i_level_comp = bs_read( s, 3 );
889 i_depth = bs_read( s, 3 );
890 bs_skip( s, 2 ); /* Reserved */
891 i_clut = bs_read( s, 8 );
893 i_8_bg = bs_read( s, 8 );
894 i_4_bg = bs_read( s, 4 );
895 i_2_bg = bs_read( s, 2 );
896 bs_skip( s, 2 ); /* Reserved */
898 /* Free old object defs */
899 while( p_region->i_object_defs )
900 free( p_region->p_object_defs[--p_region->i_object_defs].psz_text );
902 free( p_region->p_object_defs );
903 p_region->p_object_defs = NULL;
905 /* Extra sanity checks */
906 if( ( p_region->i_width != i_width ) ||
907 ( p_region->i_height != i_height ) )
909 if( p_region->p_pixbuf )
911 msg_Dbg( p_dec, "region size changed (%dx%d->%dx%d)",
912 p_region->i_width, p_region->i_height, i_width, i_height );
913 free( p_region->p_pixbuf );
916 p_region->p_pixbuf = xmalloc( i_height * i_width );
917 p_region->i_depth = 0;
918 b_fill = true;
920 if( p_region->i_depth &&
921 ( ( p_region->i_depth != i_depth ) ||
922 ( p_region->i_level_comp != i_level_comp ) ||
923 ( p_region->i_clut != i_clut) ) )
925 msg_Dbg( p_dec, "region parameters changed (not allowed)" );
928 /* Erase background of region */
929 if( b_fill )
931 int i_background = ( p_region->i_depth == 1 ) ? i_2_bg :
932 ( ( p_region->i_depth == 2 ) ? i_4_bg : i_8_bg );
933 memset( p_region->p_pixbuf, i_background, i_width * i_height );
936 p_region->i_width = i_width;
937 p_region->i_height = i_height;
938 p_region->i_level_comp = i_level_comp;
939 p_region->i_depth = i_depth;
940 p_region->i_clut = i_clut;
942 /* List of objects in the region */
943 i_processed_length = 10;
944 while( i_processed_length < i_segment_length )
946 dvbsub_objectdef_t *p_obj;
948 /* We create a new object */
949 p_region->i_object_defs++;
950 p_region->p_object_defs = xrealloc( p_region->p_object_defs,
951 sizeof(dvbsub_objectdef_t) * p_region->i_object_defs );
953 /* We parse object properties */
954 p_obj = &p_region->p_object_defs[p_region->i_object_defs - 1];
955 p_obj->i_id = bs_read( s, 16 );
956 p_obj->i_type = bs_read( s, 2 );
957 bs_skip( s, 2 ); /* Provider */
958 p_obj->i_x = bs_read( s, 12 );
959 bs_skip( s, 4 ); /* Reserved */
960 p_obj->i_y = bs_read( s, 12 );
961 p_obj->psz_text = NULL;
963 i_processed_length += 6;
965 if( ( p_obj->i_type == DVBSUB_OT_BASIC_CHAR ) ||
966 ( p_obj->i_type == DVBSUB_OT_COMPOSITE_STRING ) )
968 p_obj->i_fg_pc = bs_read( s, 8 );
969 p_obj->i_bg_pc = bs_read( s, 8 );
970 i_processed_length += 2;
975 /* ETSI 300 743 [7.2.1] */
976 static void decode_display_definition( decoder_t *p_dec, bs_t *s )
978 decoder_sys_t *p_sys = p_dec->p_sys;
979 uint16_t i_segment_length;
980 uint16_t i_processed_length = 40;
981 int i_version;
983 i_segment_length = bs_read( s, 16 );
984 i_version = bs_read( s, 4 );
986 /* Check version number */
987 if( p_sys->display.i_version == i_version )
989 /* The definition did not change */
990 bs_skip( s, 8*i_segment_length - 4 );
991 return;
994 #ifdef DEBUG_DVBSUB
995 msg_Dbg( p_dec, "new display definition: %i", i_version );
996 #endif
998 /* We don't have this version of the display definition: Parse it */
999 p_sys->display.i_version = i_version;
1000 p_sys->display.b_windowed = bs_read( s, 1 );
1001 bs_skip( s, 3 ); /* Reserved bits */
1002 p_sys->display.i_width = bs_read( s, 16 )+1;
1003 p_sys->display.i_height = bs_read( s, 16 )+1;
1005 if( p_sys->display.b_windowed )
1007 #ifdef DEBUG_DVBSUB
1008 msg_Dbg( p_dec, "display definition with offsets (windowed)" );
1009 #endif
1010 /* Coordinates are measured from the top left corner */
1011 p_sys->display.i_x = bs_read( s, 16 );
1012 p_sys->display.i_max_x = bs_read( s, 16 );
1013 p_sys->display.i_y = bs_read( s, 16 );
1014 p_sys->display.i_max_y = bs_read( s, 16 );
1015 i_processed_length += 64;
1017 else
1019 /* if not windowed, setup the window variables to good defaults */
1020 /* not necessary, but to avoid future confusion.. */
1021 p_sys->display.i_x = 0;
1022 p_sys->display.i_max_x = p_sys->display.i_width-1;
1023 p_sys->display.i_y = 0;
1024 p_sys->display.i_max_y = p_sys->display.i_height-1;
1027 if( i_processed_length != i_segment_length*8 )
1029 msg_Err( p_dec, "processed length %d bytes != segment length %d bytes",
1030 i_processed_length / 8 , i_segment_length );
1033 #ifdef DEBUG_DVBSUB
1034 msg_Dbg( p_dec, "version: %d, width: %d, height: %d",
1035 p_sys->display.i_version, p_sys->display.i_width, p_sys->display.i_height );
1036 if( p_sys->display.b_windowed )
1037 msg_Dbg( p_dec, "xmin: %d, xmax: %d, ymin: %d, ymax: %d",
1038 p_sys->display.i_x, p_sys->display.i_max_x, p_sys->display.i_y, p_sys->display.i_max_y );
1039 #endif
1042 static void dvbsub_render_pdata( decoder_t *, dvbsub_region_t *, int, int,
1043 uint8_t *, int );
1044 static void dvbsub_pdata2bpp( bs_t *, uint8_t *, int, int * );
1045 static void dvbsub_pdata4bpp( bs_t *, uint8_t *, int, int * );
1046 static void dvbsub_pdata8bpp( bs_t *, uint8_t *, int, int * );
1048 static void decode_object( decoder_t *p_dec, bs_t *s )
1050 decoder_sys_t *p_sys = p_dec->p_sys;
1051 dvbsub_region_t *p_region;
1052 int i_segment_length, i_coding_method, i_version, i_id, i;
1053 bool b_non_modify_color;
1055 /* ETSI 300-743 paragraph 7.2.4
1056 * sync_byte, segment_type and page_id have already been processed.
1058 i_segment_length = bs_read( s, 16 );
1059 i_id = bs_read( s, 16 );
1060 i_version = bs_read( s, 4 );
1061 i_coding_method = bs_read( s, 2 );
1063 if( i_coding_method > 1 )
1065 msg_Dbg( p_dec, "unknown DVB subtitling coding %d is not handled!", i_coding_method );
1066 bs_skip( s, 8 * (i_segment_length - 2) - 6 );
1067 return;
1070 /* Check if the object needs to be rendered in at least one
1071 * of the regions */
1072 for( p_region = p_sys->p_regions; p_region != NULL;
1073 p_region = p_region->p_next )
1075 for( i = 0; i < p_region->i_object_defs; i++ )
1076 if( p_region->p_object_defs[i].i_id == i_id ) break;
1078 if( i != p_region->i_object_defs ) break;
1080 if( !p_region )
1082 bs_skip( s, 8 * (i_segment_length - 2) - 6 );
1083 return;
1086 #ifdef DEBUG_DVBSUB
1087 msg_Dbg( p_dec, "new object: %i", i_id );
1088 #endif
1090 b_non_modify_color = bs_read( s, 1 );
1091 bs_skip( s, 1 ); /* Reserved */
1093 if( i_coding_method == 0x00 )
1095 int i_topfield, i_bottomfield;
1096 uint8_t *p_topfield, *p_bottomfield;
1098 i_topfield = bs_read( s, 16 );
1099 i_bottomfield = bs_read( s, 16 );
1100 p_topfield = s->p_start + bs_pos( s ) / 8;
1101 p_bottomfield = p_topfield + i_topfield;
1103 bs_skip( s, 8 * (i_segment_length - 7) );
1105 /* Sanity check */
1106 if( ( i_segment_length < ( i_topfield + i_bottomfield + 7 ) ) ||
1107 ( ( p_topfield + i_topfield + i_bottomfield ) > s->p_end ) )
1109 msg_Dbg( p_dec, "corrupted object data" );
1110 return;
1113 for( p_region = p_sys->p_regions; p_region != NULL;
1114 p_region = p_region->p_next )
1116 for( i = 0; i < p_region->i_object_defs; i++ )
1118 if( p_region->p_object_defs[i].i_id != i_id ) continue;
1120 dvbsub_render_pdata( p_dec, p_region,
1121 p_region->p_object_defs[i].i_x,
1122 p_region->p_object_defs[i].i_y,
1123 p_topfield, i_topfield );
1125 if( i_bottomfield )
1127 dvbsub_render_pdata( p_dec, p_region,
1128 p_region->p_object_defs[i].i_x,
1129 p_region->p_object_defs[i].i_y + 1,
1130 p_bottomfield, i_bottomfield );
1132 else
1134 /* Duplicate the top field */
1135 dvbsub_render_pdata( p_dec, p_region,
1136 p_region->p_object_defs[i].i_x,
1137 p_region->p_object_defs[i].i_y + 1,
1138 p_topfield, i_topfield );
1143 else
1145 /* DVB subtitling as characters */
1146 int i_number_of_codes = bs_read( s, 8 );
1147 uint8_t* p_start = s->p_start + bs_pos( s ) / 8;
1149 /* Sanity check */
1150 if( ( i_segment_length < ( i_number_of_codes*2 + 4 ) ) ||
1151 ( ( p_start + i_number_of_codes*2 ) > s->p_end ) )
1153 msg_Dbg( p_dec, "corrupted object data" );
1154 return;
1157 for( p_region = p_sys->p_regions; p_region != NULL;
1158 p_region = p_region->p_next )
1160 for( i = 0; i < p_region->i_object_defs; i++ )
1162 int j;
1164 if( p_region->p_object_defs[i].i_id != i_id ) continue;
1166 p_region->p_object_defs[i].psz_text =
1167 xrealloc( p_region->p_object_defs[i].psz_text,
1168 i_number_of_codes + 1 );
1170 /* FIXME 16bits -> char ??? See Preamble */
1171 for( j = 0; j < i_number_of_codes; j++ )
1173 p_region->p_object_defs[i].psz_text[j] = (char)(bs_read( s, 16 ) & 0xFF);
1175 /* Null terminate the string */
1176 p_region->p_object_defs[i].psz_text[j] = 0;
1181 #ifdef DEBUG_DVBSUB
1182 msg_Dbg( p_dec, "end object: %i", i_id );
1183 #endif
1186 static void dvbsub_render_pdata( decoder_t *p_dec, dvbsub_region_t *p_region,
1187 int i_x, int i_y,
1188 uint8_t *p_field, int i_field )
1190 uint8_t *p_pixbuf;
1191 int i_offset = 0;
1192 bs_t bs;
1194 /* Sanity check */
1195 if( !p_region->p_pixbuf )
1197 msg_Err( p_dec, "region %i has no pixel buffer!", p_region->i_id );
1198 return;
1200 if( i_y < 0 || i_x < 0 || i_y >= p_region->i_height ||
1201 i_x >= p_region->i_width )
1203 msg_Dbg( p_dec, "invalid offset (%i,%i)", i_x, i_y );
1204 return;
1207 p_pixbuf = p_region->p_pixbuf + i_y * p_region->i_width;
1208 bs_init( &bs, p_field, i_field );
1210 while( !bs_eof( &bs ) )
1212 /* Sanity check */
1213 if( i_y >= p_region->i_height ) return;
1215 switch( bs_read( &bs, 8 ) )
1217 case 0x10:
1218 dvbsub_pdata2bpp( &bs, p_pixbuf + i_x, p_region->i_width - i_x,
1219 &i_offset );
1220 break;
1222 case 0x11:
1223 dvbsub_pdata4bpp( &bs, p_pixbuf + i_x, p_region->i_width - i_x,
1224 &i_offset );
1225 break;
1227 case 0x12:
1228 dvbsub_pdata8bpp( &bs, p_pixbuf + i_x, p_region->i_width - i_x,
1229 &i_offset );
1230 break;
1232 case 0x20:
1233 case 0x21:
1234 case 0x22:
1235 /* We don't use map tables */
1236 break;
1238 case 0xf0: /* End of line code */
1239 p_pixbuf += 2*p_region->i_width;
1240 i_offset = 0; i_y += 2;
1241 break;
1246 static void dvbsub_pdata2bpp( bs_t *s, uint8_t *p, int i_width, int *pi_off )
1248 bool b_stop = false;
1250 while( !b_stop && !bs_eof( s ) )
1252 int i_count = 0, i_color = 0;
1254 i_color = bs_read( s, 2 );
1255 if( i_color != 0x00 )
1257 i_count = 1;
1259 else
1261 if( bs_read( s, 1 ) == 0x01 ) // Switch1
1263 i_count = 3 + bs_read( s, 3 );
1264 i_color = bs_read( s, 2 );
1266 else
1268 if( bs_read( s, 1 ) == 0x00 ) //Switch2
1270 switch( bs_read( s, 2 ) ) //Switch3
1272 case 0x00:
1273 b_stop = true;
1274 break;
1275 case 0x01:
1276 i_count = 2;
1277 break;
1278 case 0x02:
1279 i_count = 12 + bs_read( s, 4 );
1280 i_color = bs_read( s, 2 );
1281 break;
1282 case 0x03:
1283 i_count = 29 + bs_read( s, 8 );
1284 i_color = bs_read( s, 2 );
1285 break;
1286 default:
1287 break;
1290 else
1292 /* 1 pixel color 0 */
1293 i_count = 1;
1298 if( !i_count ) continue;
1300 /* Sanity check */
1301 if( ( i_count + *pi_off ) > i_width ) break;
1303 if( i_count == 1 ) p[*pi_off] = i_color;
1304 else memset( ( p + *pi_off ), i_color, i_count );
1306 (*pi_off) += i_count;
1309 bs_align( s );
1312 static void dvbsub_pdata4bpp( bs_t *s, uint8_t *p, int i_width, int *pi_off )
1314 bool b_stop = false;
1316 while( !b_stop && !bs_eof( s ) )
1318 int i_count = 0, i_color = 0;
1320 i_color = bs_read( s, 4 );
1321 if( i_color != 0x00 )
1323 /* Add 1 pixel */
1324 i_count = 1;
1326 else
1328 if( bs_read( s, 1 ) == 0x00 ) // Switch1
1330 if( bs_show( s, 3 ) != 0x00 )
1332 i_count = 2 + bs_read( s, 3 );
1334 else
1336 bs_skip( s, 3 );
1337 b_stop = true;
1340 else
1342 if( bs_read( s, 1 ) == 0x00) //Switch2
1344 i_count = 4 + bs_read( s, 2 );
1345 i_color = bs_read( s, 4 );
1347 else
1349 switch ( bs_read( s, 2 ) ) //Switch3
1351 case 0x0:
1352 i_count = 1;
1353 break;
1354 case 0x1:
1355 i_count = 2;
1356 break;
1357 case 0x2:
1358 i_count = 9 + bs_read( s, 4 );
1359 i_color = bs_read( s, 4 );
1360 break;
1361 case 0x3:
1362 i_count= 25 + bs_read( s, 8 );
1363 i_color = bs_read( s, 4 );
1364 break;
1370 if( !i_count ) continue;
1372 /* Sanity check */
1373 if( ( i_count + *pi_off ) > i_width ) break;
1375 if( i_count == 1 ) p[*pi_off] = i_color;
1376 else memset( ( p + *pi_off ), i_color, i_count );
1378 (*pi_off) += i_count;
1381 bs_align( s );
1384 static void dvbsub_pdata8bpp( bs_t *s, uint8_t *p, int i_width, int *pi_off )
1386 bool b_stop = false;
1388 while( !b_stop && !bs_eof( s ) )
1390 int i_count = 0, i_color = 0;
1392 i_color = bs_read( s, 8 );
1393 if( i_color != 0x00 )
1395 /* Add 1 pixel */
1396 i_count = 1;
1398 else
1400 if( bs_read( s, 1 ) == 0x00 ) // Switch1
1402 if( bs_show( s, 7 ) != 0x00 )
1404 i_count = bs_read( s, 7 );
1406 else
1408 bs_skip( s, 7 );
1409 b_stop = true;
1412 else
1414 i_count = bs_read( s, 7 );
1415 i_color = bs_read( s, 8 );
1419 if( !i_count ) continue;
1421 /* Sanity check */
1422 if( ( i_count + *pi_off ) > i_width ) break;
1424 if( i_count == 1 ) p[*pi_off] = i_color;
1425 else memset( ( p + *pi_off ), i_color, i_count );
1427 (*pi_off) += i_count;
1430 bs_align( s );
1433 static void free_all( decoder_t *p_dec )
1435 decoder_sys_t *p_sys = p_dec->p_sys;
1436 dvbsub_region_t *p_reg, *p_reg_next;
1437 dvbsub_clut_t *p_clut, *p_clut_next;
1439 /*free( p_sys->p_display ); No longer malloced */
1441 for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut_next )
1443 p_clut_next = p_clut->p_next;
1444 free( p_clut );
1446 p_sys->p_cluts = NULL;
1448 for( p_reg = p_sys->p_regions; p_reg != NULL; p_reg = p_reg_next )
1450 int i;
1452 p_reg_next = p_reg->p_next;
1453 for( i = 0; i < p_reg->i_object_defs; i++ )
1454 free( p_reg->p_object_defs[i].psz_text );
1455 if( p_reg->i_object_defs ) free( p_reg->p_object_defs );
1456 free( p_reg->p_pixbuf );
1457 free( p_reg );
1459 p_sys->p_regions = NULL;
1461 if( p_sys->p_page )
1463 if( p_sys->p_page->i_region_defs )
1464 free( p_sys->p_page->p_region_defs );
1465 free( p_sys->p_page );
1467 p_sys->p_page = NULL;
1470 static subpicture_t *render( decoder_t *p_dec )
1472 decoder_sys_t *p_sys = p_dec->p_sys;
1473 subpicture_t *p_spu;
1474 subpicture_region_t **pp_spu_region;
1475 int i, j, i_timeout = 0;
1476 int i_base_x;
1477 int i_base_y;
1479 /* Allocate the subpicture internal data. */
1480 p_spu = decoder_NewSubpicture( p_dec, NULL );
1481 if( !p_spu )
1482 return NULL;
1484 p_spu->b_absolute = p_sys->b_absolute;
1485 /* Set the pf_render callback */
1486 p_spu->i_start = p_sys->i_pts;
1487 //p_spu->i_stop = (mtime_t) 0;
1488 p_spu->b_ephemer = true;
1489 //p_spu->b_fade = true;
1490 //p_spu->i_stop = p_spu->i_start + (mtime_t) (i_timeout * 1000000);
1491 p_spu->b_subtitle = true;
1493 /* Correct positioning of SPU */
1494 i_base_x = p_sys->i_spu_x;
1495 i_base_y = p_sys->i_spu_y;
1496 p_spu->i_original_picture_width = 720;
1497 p_spu->i_original_picture_height = 576;
1499 p_spu->i_original_picture_width = p_sys->display.i_width;
1500 p_spu->i_original_picture_height = p_sys->display.i_height;
1502 if( p_sys->display.b_windowed )
1504 /* From en_300743v01 - */
1505 /* the DDS is there to indicate intended size/position of text */
1506 /* the intended video area is ->i_width/height */
1507 /* the window is within this... SO... we should leave i_original_picture_width etc. as is */
1508 /* and ONLY change i_base_x. effectively i_max_x/y are only there to limit memory requirements*/
1509 /* we COULD use the upper limits to limit rendering to within these? */
1511 /* see notes on DDS at the top of the file */
1512 i_base_x += p_sys->display.i_x;
1513 i_base_y += p_sys->display.i_y;
1516 pp_spu_region = &p_spu->p_region;
1518 /* Loop on region definitions */
1519 #ifdef DEBUG_DVBSUB
1520 if( p_sys->p_page )
1521 msg_Dbg( p_dec, "rendering %i regions", p_sys->p_page->i_region_defs );
1522 #endif
1524 for( i = 0; p_sys->p_page && ( i < p_sys->p_page->i_region_defs ); i++ )
1526 dvbsub_region_t *p_region;
1527 dvbsub_regiondef_t *p_regiondef;
1528 dvbsub_clut_t *p_clut;
1529 dvbsub_color_t *p_color;
1530 subpicture_region_t *p_spu_region;
1531 uint8_t *p_src, *p_dst;
1532 video_format_t fmt;
1533 video_palette_t palette;
1534 int i_pitch;
1536 i_timeout = p_sys->p_page->i_timeout;
1538 p_regiondef = &p_sys->p_page->p_region_defs[i];
1540 /* Find associated region */
1541 for( p_region = p_sys->p_regions; p_region != NULL;
1542 p_region = p_region->p_next )
1544 if( p_regiondef->i_id == p_region->i_id ) break;
1547 #ifdef DEBUG_DVBSUB
1548 /* if a region exists, then print it's size */
1549 if (p_region)
1551 msg_Dbg( p_dec, "rendering region %i (%i,%i) to (%i,%i)", i,
1552 p_regiondef->i_x, p_regiondef->i_y,
1553 p_regiondef->i_x + p_region->i_width,
1554 p_regiondef->i_y + p_region->i_height );
1556 else
1558 msg_Dbg( p_dec, "rendering region %i (%i,%i) (no region matched to render)", i,
1559 p_regiondef->i_x, p_regiondef->i_y );
1561 #endif
1563 if( !p_region )
1565 msg_Dbg( p_dec, "region %i not found", p_regiondef->i_id );
1566 continue;
1569 /* Find associated CLUT */
1570 for( p_clut = p_sys->p_cluts; p_clut != NULL; p_clut = p_clut->p_next )
1572 if( p_region->i_clut == p_clut->i_id ) break;
1574 if( !p_clut )
1576 msg_Dbg( p_dec, "clut %i not found", p_region->i_clut );
1577 continue;
1580 /* FIXME: don't create a subpicture region with VLC CODEC YUVP
1581 * when it actually is a TEXT region */
1583 /* Create new SPU region */
1584 memset( &fmt, 0, sizeof(video_format_t) );
1585 fmt.i_chroma = VLC_CODEC_YUVP;
1586 fmt.i_sar_num = 0; /* 0 means use aspect ratio of background video */
1587 fmt.i_sar_den = 1;
1588 fmt.i_width = fmt.i_visible_width = p_region->i_width;
1589 fmt.i_height = fmt.i_visible_height = p_region->i_height;
1590 fmt.i_x_offset = fmt.i_y_offset = 0;
1591 fmt.p_palette = &palette;
1592 fmt.p_palette->i_entries = ( p_region->i_depth == 1 ) ? 4 :
1593 ( ( p_region->i_depth == 2 ) ? 16 : 256 );
1594 p_color = ( p_region->i_depth == 1 ) ? p_clut->c_2b :
1595 ( ( p_region->i_depth == 2 ) ? p_clut->c_4b : p_clut->c_8b );
1596 for( j = 0; j < fmt.p_palette->i_entries; j++ )
1598 fmt.p_palette->palette[j][0] = p_color[j].Y;
1599 fmt.p_palette->palette[j][1] = p_color[j].Cb; /* U == Cb */
1600 fmt.p_palette->palette[j][2] = p_color[j].Cr; /* V == Cr */
1601 fmt.p_palette->palette[j][3] = 0xff - p_color[j].T;
1604 p_spu_region = subpicture_region_New( &fmt );
1605 if( !p_spu_region )
1607 msg_Err( p_dec, "cannot allocate SPU region" );
1608 continue;
1610 p_spu_region->i_x = i_base_x + p_regiondef->i_x;
1611 p_spu_region->i_y = i_base_y + p_regiondef->i_y;
1612 p_spu_region->i_align = p_sys->i_spu_position;
1613 *pp_spu_region = p_spu_region;
1614 pp_spu_region = &p_spu_region->p_next;
1616 p_src = p_region->p_pixbuf;
1617 p_dst = p_spu_region->p_picture->Y_PIXELS;
1618 i_pitch = p_spu_region->p_picture->Y_PITCH;
1620 /* Copy pixel buffer */
1621 for( j = 0; j < p_region->i_height; j++ )
1623 memcpy( p_dst, p_src, p_region->i_width );
1624 p_src += p_region->i_width;
1625 p_dst += i_pitch;
1628 /* Check subtitles encoded as strings of characters
1629 * (since there are not rendered in the pixbuffer) */
1630 for( j = 0; j < p_region->i_object_defs; j++ )
1632 dvbsub_objectdef_t *p_object_def = &p_region->p_object_defs[j];
1634 if( ( p_object_def->i_type != 1 ) || !p_object_def->psz_text )
1635 continue;
1637 /* Create new SPU region */
1638 memset( &fmt, 0, sizeof(video_format_t) );
1639 fmt.i_chroma = VLC_CODEC_TEXT;
1640 fmt.i_sar_num = 1;
1641 fmt.i_sar_den = 1;
1642 fmt.i_width = fmt.i_visible_width = p_region->i_width;
1643 fmt.i_height = fmt.i_visible_height = p_region->i_height;
1644 fmt.i_x_offset = fmt.i_y_offset = 0;
1645 p_spu_region = subpicture_region_New( &fmt );
1647 p_spu_region->psz_text = strdup( p_object_def->psz_text );
1648 p_spu_region->i_x = i_base_x + p_regiondef->i_x + p_object_def->i_x;
1649 p_spu_region->i_y = i_base_y + p_regiondef->i_y + p_object_def->i_y;
1650 p_spu_region->i_align = p_sys->i_spu_position;
1651 *pp_spu_region = p_spu_region;
1652 pp_spu_region = &p_spu_region->p_next;
1656 return p_spu;
1659 /*****************************************************************************
1660 * encoder_sys_t : encoder descriptor
1661 *****************************************************************************/
1662 typedef struct encoder_region_t
1664 int i_width;
1665 int i_height;
1667 } encoder_region_t;
1669 struct encoder_sys_t
1671 unsigned int i_page_ver;
1672 unsigned int i_region_ver;
1673 unsigned int i_clut_ver;
1675 int i_regions;
1676 encoder_region_t *p_regions;
1678 mtime_t i_pts;
1680 /* subpicture positioning */
1681 int i_offset_x;
1682 int i_offset_y;
1685 static void encode_page_composition( encoder_t *, bs_t *, subpicture_t * );
1686 static void encode_clut( encoder_t *, bs_t *, subpicture_t * );
1687 static void encode_region_composition( encoder_t *, bs_t *, subpicture_t * );
1688 static void encode_object( encoder_t *, bs_t *, subpicture_t * );
1690 /*****************************************************************************
1691 * OpenEncoder: probe the encoder and return score
1692 *****************************************************************************/
1693 static int OpenEncoder( vlc_object_t *p_this )
1695 encoder_t *p_enc = (encoder_t *)p_this;
1696 encoder_sys_t *p_sys;
1698 if( ( p_enc->fmt_out.i_codec != VLC_CODEC_DVBS ) &&
1699 !p_enc->b_force )
1701 return VLC_EGENERIC;
1704 /* Allocate the memory needed to store the decoder's structure */
1705 if( ( p_sys = (encoder_sys_t *)malloc(sizeof(encoder_sys_t)) ) == NULL )
1706 return VLC_ENOMEM;
1707 p_enc->p_sys = p_sys;
1709 p_enc->pf_encode_sub = Encode;
1710 p_enc->fmt_out.i_codec = VLC_CODEC_DVBS;
1711 p_enc->fmt_out.subs.dvb.i_id = 1 << 16 | 1;
1713 config_ChainParse( p_enc, ENC_CFG_PREFIX, ppsz_enc_options, p_enc->p_cfg );
1715 p_sys->i_page_ver = 0;
1716 p_sys->i_region_ver = 0;
1717 p_sys->i_clut_ver = 0;
1718 p_sys->i_regions = 0;
1719 p_sys->p_regions = 0;
1721 p_sys->i_offset_x = var_CreateGetInteger( p_this, ENC_CFG_PREFIX "x" );
1722 p_sys->i_offset_y = var_CreateGetInteger( p_this, ENC_CFG_PREFIX "y" );
1724 return VLC_SUCCESS;
1727 /* FIXME: this routine is a hack to convert VLC_CODEC_YUVA
1728 * into VLC_CODEC_YUVP
1730 static subpicture_t *YuvaYuvp( subpicture_t *p_subpic )
1732 subpicture_region_t *p_region = NULL;
1734 if( !p_subpic ) return NULL;
1736 for( p_region = p_subpic->p_region; p_region; p_region = p_region->p_next )
1738 video_format_t *p_fmt = &p_region->fmt;
1739 int i = 0, j = 0, n = 0, p = 0;
1740 int i_max_entries = 256;
1742 #ifdef RANDOM_DITHERING
1743 int i_seed = 0xdeadbeef; /* random seed */
1744 #else
1745 int *pi_delta;
1746 #endif
1747 int i_pixels = p_region->p_picture->p[0].i_visible_lines
1748 * p_region->p_picture->p[0].i_pitch;
1749 int i_iterator = p_region->p_picture->p[0].i_visible_lines * 3 / 4
1750 * p_region->p_picture->p[0].i_pitch
1751 + p_region->p_picture->p[0].i_pitch * 1 / 3;
1752 int i_tolerance = 0;
1754 #ifdef DEBUG_DVBSUB1
1755 /* p_enc not valid here */
1756 msg_Dbg( p_enc, "YuvaYuvp: i_pixels=%d, i_iterator=%d", i_pixels, i_iterator );
1757 #endif
1758 p_fmt->i_chroma = VLC_CODEC_YUVP;
1759 p_fmt->p_palette = (video_palette_t *) malloc( sizeof( video_palette_t ) );
1760 if( !p_fmt->p_palette ) break;
1761 p_fmt->p_palette->i_entries = 0;
1763 /* Find best iterator using Euclide’s algorithm */
1764 for( ; i_iterator > 1 ; i_iterator-- )
1766 int a = i_pixels;
1767 int b = i_iterator;
1768 int c;
1770 while( b )
1772 c = a % b;
1773 a = b;
1774 b = c;
1777 if( a == 1 )
1779 break;
1783 /* Count colors, build best palette */
1784 for( i_tolerance = 0; i_tolerance < 128; i_tolerance++ )
1786 bool b_success = true;
1787 p_fmt->p_palette->i_entries = 0;
1789 for( i = 0; i < i_pixels ; )
1791 uint8_t y, u, v, a;
1792 y = p_region->p_picture->p[0].p_pixels[i];
1793 u = p_region->p_picture->p[1].p_pixels[i];
1794 v = p_region->p_picture->p[2].p_pixels[i];
1795 a = p_region->p_picture->p[3].p_pixels[i];
1796 for( j = 0; j < p_fmt->p_palette->i_entries; j++ )
1798 if( abs((int)p_fmt->p_palette->palette[j][0] - (int)y) <= i_tolerance &&
1799 abs((int)p_fmt->p_palette->palette[j][1] - (int)u) <= i_tolerance &&
1800 abs((int)p_fmt->p_palette->palette[j][2] - (int)v) <= i_tolerance &&
1801 abs((int)p_fmt->p_palette->palette[j][3] - (int)a) <= i_tolerance / 2 )
1803 break;
1806 if( j == p_fmt->p_palette->i_entries )
1808 p_fmt->p_palette->palette[j][0] = y;
1809 p_fmt->p_palette->palette[j][1] = u;
1810 p_fmt->p_palette->palette[j][2] = v;
1811 p_fmt->p_palette->palette[j][3] = a;
1812 p_fmt->p_palette->i_entries++;
1814 if( p_fmt->p_palette->i_entries >= i_max_entries )
1816 b_success = false;
1817 break;
1819 i += i_iterator;
1820 if( i > i_pixels )
1822 i -= i_pixels;
1826 if( b_success )
1828 break;
1832 #ifdef DEBUG_DVBSUB1
1833 /* p_enc not valid here */
1834 msg_Dbg( p_enc, "best palette has %d colors", p_fmt->p_palette->i_entries );
1835 #endif
1837 #ifndef RANDOM_DITHERING
1838 pi_delta = xmalloc( ( p_region->p_picture->p[0].i_pitch + 1 )
1839 * sizeof(int) * 4 );
1840 for( i = 0; i < (p_region->p_picture->p[0].i_pitch + 1) * 4 ; i++ )
1842 pi_delta[ i ] = 0;
1844 #endif
1846 /* Fill image with our new colours */
1847 for( p = 0; p < p_region->p_picture->p[0].i_visible_lines ; p++ )
1849 int i_ydelta = 0, i_udelta = 0, i_vdelta = 0, i_adelta = 0;
1851 for( n = 0; n < p_region->p_picture->p[0].i_pitch ; n++ )
1853 int i_offset = p * p_region->p_picture->p[0].i_pitch + n;
1854 int y, u, v, a;
1855 int i_mindist, i_best;
1857 y = (int)p_region->p_picture->p[0].p_pixels[i_offset];
1858 u = (int)p_region->p_picture->p[1].p_pixels[i_offset];
1859 v = (int)p_region->p_picture->p[2].p_pixels[i_offset];
1860 a = (int)p_region->p_picture->p[3].p_pixels[i_offset];
1862 /* Add dithering compensation */
1863 #ifdef RANDOM_DITHERING
1864 y += ((i_seed & 0xff) - 0x80) * i_tolerance / 0x80;
1865 u += (((i_seed >> 8) & 0xff) - 0x80) * i_tolerance / 0x80;
1866 v += (((i_seed >> 16) & 0xff) - 0x80) * i_tolerance / 0x80;
1867 a += (((i_seed >> 24) & 0xff) - 0x80) * i_tolerance / 0x80;
1868 #else
1869 y += i_ydelta + pi_delta[ n * 4 ];
1870 u += i_udelta + pi_delta[ n * 4 + 1 ];
1871 v += i_vdelta + pi_delta[ n * 4 + 2 ];
1872 a += i_adelta + pi_delta[ n * 4 + 3 ];
1873 #endif
1875 /* Find best colour in palette */
1876 for( i_mindist = 99999999, i_best = 0, j = 0; j < p_fmt->p_palette->i_entries; j++ )
1878 int i_dist = 0;
1880 i_dist += abs((int)p_fmt->p_palette->palette[j][0] - y);
1881 i_dist += abs((int)p_fmt->p_palette->palette[j][1] - u);
1882 i_dist += abs((int)p_fmt->p_palette->palette[j][2] - v);
1883 i_dist += 2 * abs((int)p_fmt->p_palette->palette[j][3] - a);
1885 if( i_dist < i_mindist )
1887 i_mindist = i_dist;
1888 i_best = j;
1892 /* Set pixel to best color */
1893 p_region->p_picture->p[0].p_pixels[i_offset] = i_best;
1895 /* Update dithering state */
1896 #ifdef RANDOM_DITHERING
1897 i_seed = (i_seed * 0x1283837) ^ 0x789479 ^ (i_seed >> 13);
1898 #else
1899 i_ydelta = y - (int)p_fmt->p_palette->palette[i_best][0];
1900 i_udelta = u - (int)p_fmt->p_palette->palette[i_best][1];
1901 i_vdelta = v - (int)p_fmt->p_palette->palette[i_best][2];
1902 i_adelta = a - (int)p_fmt->p_palette->palette[i_best][3];
1903 pi_delta[ n * 4 ] = i_ydelta * 3 / 8;
1904 pi_delta[ n * 4 + 1 ] = i_udelta * 3 / 8;
1905 pi_delta[ n * 4 + 2 ] = i_vdelta * 3 / 8;
1906 pi_delta[ n * 4 + 3 ] = i_adelta * 3 / 8;
1907 i_ydelta = i_ydelta * 5 / 8;
1908 i_udelta = i_udelta * 5 / 8;
1909 i_vdelta = i_vdelta * 5 / 8;
1910 i_adelta = i_adelta * 5 / 8;
1911 #endif
1914 #ifndef RANDOM_DITHERING
1915 free( pi_delta );
1916 #endif
1918 /* pad palette */
1919 for( i = p_fmt->p_palette->i_entries; i < i_max_entries; i++ )
1921 p_fmt->p_palette->palette[i][0] = 0;
1922 p_fmt->p_palette->palette[i][1] = 0;
1923 p_fmt->p_palette->palette[i][2] = 0;
1924 p_fmt->p_palette->palette[i][3] = 0;
1926 p_fmt->p_palette->i_entries = i_max_entries;
1927 #ifdef DEBUG_DVBSUB1
1928 /* p_enc not valid here */
1929 msg_Dbg( p_enc, "best palette has %d colors", p_fmt->p_palette->i_entries );
1930 #endif
1932 return p_subpic;
1933 } /* End of hack */
1935 /****************************************************************************
1936 * Encode: the whole thing
1937 ****************************************************************************/
1938 static block_t *Encode( encoder_t *p_enc, subpicture_t *p_subpic )
1940 subpicture_t *p_temp = NULL;
1941 subpicture_region_t *p_region = NULL;
1942 bs_t bits, *s = &bits;
1943 block_t *p_block;
1945 if( !p_subpic || !p_subpic->p_region ) return NULL;
1947 /* FIXME: this is a hack to convert VLC_CODEC_YUVA into
1948 * VLC_CODEC_YUVP
1950 p_region = p_subpic->p_region;
1951 if( p_region->fmt.i_chroma == VLC_CODEC_YUVA )
1953 p_temp = YuvaYuvp( p_subpic );
1954 if( !p_temp )
1956 msg_Err( p_enc, "no picture in subpicture" );
1957 return NULL;
1959 p_region = p_subpic->p_region;
1962 /* Sanity check */
1963 if( !p_region ) return NULL;
1965 if( ( p_region->fmt.i_chroma != VLC_CODEC_TEXT ) &&
1966 ( p_region->fmt.i_chroma != VLC_CODEC_YUVP ) )
1968 char psz_fourcc[5];
1969 memset( &psz_fourcc, 0, sizeof( psz_fourcc ) );
1970 vlc_fourcc_to_char( p_region->fmt.i_chroma, &psz_fourcc );
1971 msg_Err( p_enc, "chroma %4.4s not supported", psz_fourcc );
1972 return NULL;
1975 if( p_region->fmt.p_palette )
1977 switch( p_region->fmt.p_palette->i_entries )
1979 case 0:
1980 case 4:
1981 case 16:
1982 case 256:
1983 break;
1984 default:
1985 msg_Err( p_enc, "subpicture palette (%d) not handled",
1986 p_region->fmt.p_palette->i_entries );
1987 return NULL;
1990 /* End of hack */
1992 #ifdef DEBUG_DVBSUB
1993 msg_Dbg( p_enc, "encoding subpicture" );
1994 #endif
1995 p_block = block_New( p_enc, 64000 );
1996 bs_init( s, p_block->p_buffer, p_block->i_buffer );
1998 bs_write( s, 8, 0x20 ); /* Data identifier */
1999 bs_write( s, 8, 0x0 ); /* Subtitle stream id */
2001 encode_page_composition( p_enc, s, p_subpic );
2002 encode_region_composition( p_enc, s, p_subpic );
2003 encode_clut( p_enc, s, p_subpic );
2004 encode_object( p_enc, s, p_subpic );
2006 /* End of display */
2007 bs_write( s, 8, 0x0f ); /* Sync byte */
2008 bs_write( s, 8, DVBSUB_ST_ENDOFDISPLAY ); /* Segment type */
2009 bs_write( s, 16, 1 ); /* Page id */
2010 bs_write( s, 16, 0 ); /* Segment length */
2012 bs_write( s, 8, 0xff );/* End marker */
2013 p_block->i_buffer = bs_pos( s ) / 8;
2014 p_block->i_pts = p_block->i_dts = p_subpic->i_start;
2015 if( !p_subpic->b_ephemer && ( p_subpic->i_stop > p_subpic->i_start ) )
2017 block_t *p_block_stop;
2019 p_block->i_length = p_subpic->i_stop - p_subpic->i_start;
2021 /* Send another (empty) subtitle to signal the end of display */
2022 p_block_stop = block_New( p_enc, 64000 );
2023 bs_init( s, p_block_stop->p_buffer, p_block_stop->i_buffer );
2024 bs_write( s, 8, 0x20 ); /* Data identifier */
2025 bs_write( s, 8, 0x0 ); /* Subtitle stream id */
2026 encode_page_composition( p_enc, s, 0 );
2027 bs_write( s, 8, 0x0f ); /* Sync byte */
2028 bs_write( s, 8, DVBSUB_ST_ENDOFDISPLAY ); /* Segment type */
2029 bs_write( s, 16, 1 ); /* Page id */
2030 bs_write( s, 16, 0 ); /* Segment length */
2031 bs_write( s, 8, 0xff );/* End marker */
2032 p_block_stop->i_buffer = bs_pos( s ) / 8;
2033 p_block_stop->i_pts = p_block_stop->i_dts = p_subpic->i_stop;
2034 block_ChainAppend( &p_block, p_block_stop );
2035 p_block_stop->i_length = 100000; /* p_subpic->i_stop - p_subpic->i_start; */
2037 #ifdef DEBUG_DVBSUB
2038 msg_Dbg( p_enc, "subpicture encoded properly" );
2039 #endif
2040 return p_block;
2043 /*****************************************************************************
2044 * CloseEncoder: encoder destruction
2045 *****************************************************************************/
2046 static void CloseEncoder( vlc_object_t *p_this )
2048 encoder_t *p_enc = (encoder_t *)p_this;
2049 encoder_sys_t *p_sys = p_enc->p_sys;
2051 var_Destroy( p_this , ENC_CFG_PREFIX "x" );
2052 var_Destroy( p_this , ENC_CFG_PREFIX "y" );
2053 var_Destroy( p_this , ENC_CFG_PREFIX "timeout" );
2055 if( p_sys->i_regions ) free( p_sys->p_regions );
2056 free( p_sys );
2059 static void encode_page_composition( encoder_t *p_enc, bs_t *s,
2060 subpicture_t *p_subpic )
2062 encoder_sys_t *p_sys = p_enc->p_sys;
2063 subpicture_region_t *p_region;
2064 bool b_mode_change = false;
2065 int i_regions, i_timeout;
2067 bs_write( s, 8, 0x0f ); /* Sync byte */
2068 bs_write( s, 8, DVBSUB_ST_PAGE_COMPOSITION ); /* Segment type */
2069 bs_write( s, 16, 1 ); /* Page id */
2071 for( i_regions = 0, p_region = p_subpic ? p_subpic->p_region : 0;
2072 p_region; p_region = p_region->p_next, i_regions++ )
2074 if( i_regions >= p_sys->i_regions )
2076 encoder_region_t region;
2077 region.i_width = region.i_height = 0;
2078 p_sys->p_regions = xrealloc( p_sys->p_regions,
2079 sizeof(encoder_region_t) * (p_sys->i_regions + 1) );
2080 p_sys->p_regions[p_sys->i_regions++] = region;
2083 if( ( p_sys->p_regions[i_regions].i_width <
2084 (int)p_region->fmt.i_visible_width ) ||
2085 ( p_sys->p_regions[i_regions].i_width >
2086 (int)p_region->fmt.i_visible_width ) )
2088 b_mode_change = true;
2089 msg_Dbg( p_enc, "region %i width change: %i -> %i",
2090 i_regions, p_sys->p_regions[i_regions].i_width,
2091 p_region->fmt.i_visible_width );
2092 p_sys->p_regions[i_regions].i_width =
2093 p_region->fmt.i_visible_width;
2095 if( p_sys->p_regions[i_regions].i_height <
2096 (int)p_region->fmt.i_visible_height )
2098 b_mode_change = true;
2099 msg_Dbg( p_enc, "region %i height change: %i -> %i",
2100 i_regions, p_sys->p_regions[i_regions].i_height,
2101 p_region->fmt.i_visible_height );
2102 p_sys->p_regions[i_regions].i_height =
2103 p_region->fmt.i_visible_height;
2107 bs_write( s, 16, i_regions * 6 + 2 ); /* Segment length */
2109 i_timeout = 0;
2110 if( p_subpic && !p_subpic->b_ephemer &&
2111 ( p_subpic->i_stop > p_subpic->i_start ) )
2113 i_timeout = (p_subpic->i_stop - p_subpic->i_start) / 1000000;
2116 bs_write( s, 8, i_timeout ); /* Timeout */
2117 bs_write( s, 4, p_sys->i_page_ver++ );
2118 bs_write( s, 2, b_mode_change ?
2119 DVBSUB_PCS_STATE_CHANGE : DVBSUB_PCS_STATE_ACQUISITION );
2120 bs_write( s, 2, 0 ); /* Reserved */
2122 for( i_regions = 0, p_region = p_subpic ? p_subpic->p_region : 0;
2123 p_region; p_region = p_region->p_next, i_regions++ )
2125 bs_write( s, 8, i_regions );
2126 bs_write( s, 8, 0 ); /* Reserved */
2127 if( (p_sys->i_offset_x > 0) && (p_sys->i_offset_y > 0) )
2129 bs_write( s, 16, p_sys->i_offset_x ); /* override x position */
2130 bs_write( s, 16, p_sys->i_offset_y ); /* override y position */
2132 else
2134 bs_write( s, 16, p_region->i_x );
2135 bs_write( s, 16, p_region->i_y );
2140 static void encode_clut( encoder_t *p_enc, bs_t *s, subpicture_t *p_subpic )
2142 encoder_sys_t *p_sys = p_enc->p_sys;
2143 subpicture_region_t *p_region = p_subpic->p_region;
2144 video_palette_t *p_pal, pal;
2145 int i;
2147 /* Sanity check */
2148 if( !p_region ) return;
2150 if( p_region->fmt.i_chroma == VLC_CODEC_YUVP )
2152 p_pal = p_region->fmt.p_palette;
2154 else
2156 pal.i_entries = 4;
2157 for( i = 0; i < 4; i++ )
2159 pal.palette[i][0] = 0;
2160 pal.palette[i][1] = 0;
2161 pal.palette[i][2] = 0;
2162 pal.palette[i][3] = 0;
2164 p_pal = &pal;
2167 bs_write( s, 8, 0x0f ); /* Sync byte */
2168 bs_write( s, 8, DVBSUB_ST_CLUT_DEFINITION ); /* Segment type */
2169 bs_write( s, 16, 1 ); /* Page id */
2171 bs_write( s, 16, p_pal->i_entries * 6 + 2 ); /* Segment length */
2172 bs_write( s, 8, 1 ); /* Clut id */
2173 bs_write( s, 4, p_sys->i_clut_ver++ );
2174 bs_write( s, 4, 0 ); /* Reserved */
2176 for( i = 0; i < p_pal->i_entries; i++ )
2178 bs_write( s, 8, i ); /* Clut entry id */
2179 bs_write( s, 1, p_pal->i_entries == 4 ); /* 2bit/entry flag */
2180 bs_write( s, 1, p_pal->i_entries == 16 ); /* 4bit/entry flag */
2181 bs_write( s, 1, p_pal->i_entries == 256 ); /* 8bit/entry flag */
2182 bs_write( s, 4, 0 ); /* Reserved */
2183 bs_write( s, 1, 1 ); /* Full range flag */
2184 bs_write( s, 8, p_pal->palette[i][3] ? /* Y value */
2185 (p_pal->palette[i][0] ? p_pal->palette[i][0] : 16) : 0 );
2186 bs_write( s, 8, p_pal->palette[i][1] ); /* Cr value */
2187 bs_write( s, 8, p_pal->palette[i][2] ); /* Cb value */
2188 bs_write( s, 8, 0xff - p_pal->palette[i][3] ); /* T value */
2192 static void encode_region_composition( encoder_t *p_enc, bs_t *s,
2193 subpicture_t *p_subpic )
2195 encoder_sys_t *p_sys = p_enc->p_sys;
2196 subpicture_region_t *p_region;
2197 int i_region;
2199 for( i_region = 0, p_region = p_subpic->p_region; p_region;
2200 p_region = p_region->p_next, i_region++ )
2202 int i_entries = 4, i_depth = 0x1, i_bg = 0;
2203 bool b_text =
2204 ( p_region->fmt.i_chroma == VLC_CODEC_TEXT );
2206 if( !b_text )
2208 video_palette_t *p_pal = p_region->fmt.p_palette;
2210 if( !p_pal )
2212 msg_Err( p_enc, "subpicture has no palette - ignoring it" );
2213 break;
2216 i_entries = p_pal->i_entries;
2217 i_depth = i_entries == 4 ? 0x1 : i_entries == 16 ? 0x2 : 0x3;
2219 for( i_bg = 0; i_bg < p_pal->i_entries; i_bg++ )
2221 if( !p_pal->palette[i_bg][3] ) break;
2225 bs_write( s, 8, 0x0f ); /* Sync byte */
2226 bs_write( s, 8, DVBSUB_ST_REGION_COMPOSITION ); /* Segment type */
2227 bs_write( s, 16, 1 ); /* Page id */
2229 bs_write( s, 16, 10 + 6 + (b_text ? 2 : 0) ); /* Segment length */
2230 bs_write( s, 8, i_region );
2231 bs_write( s, 4, p_sys->i_region_ver++ );
2233 /* Region attributes */
2234 bs_write( s, 1, i_bg < i_entries ); /* Fill */
2235 bs_write( s, 3, 0 ); /* Reserved */
2236 bs_write( s, 16, p_sys->p_regions[i_region].i_width );
2237 bs_write( s, 16, p_sys->p_regions[i_region].i_height );
2238 bs_write( s, 3, i_depth ); /* Region level of compatibility */
2239 bs_write( s, 3, i_depth ); /* Region depth */
2240 bs_write( s, 2, 0 ); /* Reserved */
2241 bs_write( s, 8, 1 ); /* Clut id */
2242 bs_write( s, 8, i_bg ); /* region 8bit pixel code */
2243 bs_write( s, 4, i_bg ); /* region 4bit pixel code */
2244 bs_write( s, 2, i_bg ); /* region 2bit pixel code */
2245 bs_write( s, 2, 0 ); /* Reserved */
2247 /* In our implementation we only have 1 object per region */
2248 bs_write( s, 16, i_region );
2249 bs_write( s, 2, b_text ? DVBSUB_OT_BASIC_CHAR:DVBSUB_OT_BASIC_BITMAP );
2250 bs_write( s, 2, 0 ); /* object provider flag */
2251 bs_write( s, 12, 0 );/* object horizontal position */
2252 bs_write( s, 4, 0 ); /* Reserved */
2253 bs_write( s, 12, 0 );/* object vertical position */
2255 if( b_text )
2257 bs_write( s, 8, 1 ); /* foreground pixel code */
2258 bs_write( s, 8, 0 ); /* background pixel code */
2263 static void encode_pixel_data( encoder_t *p_enc, bs_t *s,
2264 subpicture_region_t *p_region,
2265 bool b_top );
2267 static void encode_object( encoder_t *p_enc, bs_t *s, subpicture_t *p_subpic )
2269 encoder_sys_t *p_sys = p_enc->p_sys;
2270 subpicture_region_t *p_region;
2271 int i_region;
2273 int i_length_pos, i_update_pos, i_pixel_data_pos;
2275 for( i_region = 0, p_region = p_subpic->p_region; p_region;
2276 p_region = p_region->p_next, i_region++ )
2278 bs_write( s, 8, 0x0f ); /* Sync byte */
2279 bs_write( s, 8, DVBSUB_ST_OBJECT_DATA ); /* Segment type */
2280 bs_write( s, 16, 1 ); /* Page id */
2282 i_length_pos = bs_pos( s );
2283 bs_write( s, 16, 0 ); /* Segment length */
2284 bs_write( s, 16, i_region ); /* Object id */
2285 bs_write( s, 4, p_sys->i_region_ver++ );
2287 /* object coding method */
2288 switch( p_region->fmt.i_chroma )
2290 case VLC_CODEC_YUVP:
2291 bs_write( s, 2, 0 );
2292 break;
2293 case VLC_CODEC_TEXT:
2294 bs_write( s, 2, 1 );
2295 break;
2296 default:
2297 msg_Err( p_enc, "FOURCC %d not supported by encoder.", p_region->fmt.i_chroma );
2298 continue;
2301 bs_write( s, 1, 0 ); /* non modifying color flag */
2302 bs_write( s, 1, 0 ); /* Reserved */
2304 if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
2306 int i_size, i;
2308 if( !p_region->psz_text ) continue;
2310 i_size = __MIN( strlen( p_region->psz_text ), 256 );
2312 bs_write( s, 8, i_size ); /* number of characters in string */
2313 for( i = 0; i < i_size; i++ )
2315 bs_write( s, 16, p_region->psz_text[i] );
2318 /* Update segment length */
2319 SetWBE( &s->p_start[i_length_pos/8],
2320 (bs_pos(s) - i_length_pos)/8 -2 );
2321 continue;
2324 /* Coding of a bitmap object */
2325 i_update_pos = bs_pos( s );
2326 bs_write( s, 16, 0 ); /* topfield data block length */
2327 bs_write( s, 16, 0 ); /* bottomfield data block length */
2329 /* Top field */
2330 i_pixel_data_pos = bs_pos( s );
2331 encode_pixel_data( p_enc, s, p_region, true );
2332 i_pixel_data_pos = ( bs_pos( s ) - i_pixel_data_pos ) / 8;
2333 SetWBE( &s->p_start[i_update_pos/8], i_pixel_data_pos );
2335 /* Bottom field */
2336 i_pixel_data_pos = bs_pos( s );
2337 encode_pixel_data( p_enc, s, p_region, false );
2338 i_pixel_data_pos = ( bs_pos( s ) - i_pixel_data_pos ) / 8;
2339 SetWBE( &s->p_start[i_update_pos/8+2], i_pixel_data_pos );
2341 /* Stuffing for word alignment */
2342 bs_align_0( s );
2343 if( bs_pos( s ) % 16 ) bs_write( s, 8, 0 );
2345 /* Update segment length */
2346 SetWBE( &s->p_start[i_length_pos/8], (bs_pos(s) - i_length_pos)/8 -2 );
2350 static void encode_pixel_line_2bp( bs_t *s, subpicture_region_t *p_region,
2351 int i_line );
2352 static void encode_pixel_line_4bp( bs_t *s, subpicture_region_t *p_region,
2353 int i_line );
2354 static void encode_pixel_line_8bp( bs_t *s, subpicture_region_t *p_region,
2355 int i_line );
2356 static void encode_pixel_data( encoder_t *p_enc, bs_t *s,
2357 subpicture_region_t *p_region,
2358 bool b_top )
2360 unsigned int i_line;
2362 /* Sanity check */
2363 if( p_region->fmt.i_chroma != VLC_CODEC_YUVP ) return;
2365 /* Encode line by line */
2366 for( i_line = !b_top; i_line < p_region->fmt.i_visible_height;
2367 i_line += 2 )
2369 switch( p_region->fmt.p_palette->i_entries )
2371 case 0:
2372 break;
2374 case 4:
2375 bs_write( s, 8, 0x10 ); /* 2 bit/pixel code string */
2376 encode_pixel_line_2bp( s, p_region, i_line );
2377 break;
2379 case 16:
2380 bs_write( s, 8, 0x11 ); /* 4 bit/pixel code string */
2381 encode_pixel_line_4bp( s, p_region, i_line );
2382 break;
2384 case 256:
2385 bs_write( s, 8, 0x12 ); /* 8 bit/pixel code string */
2386 encode_pixel_line_8bp( s, p_region, i_line );
2387 break;
2389 default:
2390 msg_Err( p_enc, "subpicture palette (%i) not handled",
2391 p_region->fmt.p_palette->i_entries );
2392 break;
2395 bs_write( s, 8, 0xf0 ); /* End of object line code */
2399 static void encode_pixel_line_2bp( bs_t *s, subpicture_region_t *p_region,
2400 int i_line )
2402 unsigned int i, i_length = 0;
2403 int i_pitch = p_region->p_picture->p->i_pitch;
2404 uint8_t *p_data = &p_region->p_picture->p->p_pixels[ i_pitch * i_line ];
2405 int i_last_pixel = p_data[0];
2407 for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
2409 if( ( i != p_region->fmt.i_visible_width ) &&
2410 ( p_data[i] == i_last_pixel ) && ( i_length != 284 ) )
2412 i_length++;
2413 continue;
2416 if( ( i_length == 1 ) || ( i_length == 11 ) || ( i_length == 28 ) )
2418 /* 2bit/pixel code */
2419 if( i_last_pixel )
2420 bs_write( s, 2, i_last_pixel );
2421 else
2423 bs_write( s, 2, 0 );
2424 bs_write( s, 1, 0 );
2425 bs_write( s, 1, 1 ); /* pseudo color 0 */
2427 i_length--;
2430 if( i_length == 2 )
2432 if( i_last_pixel )
2434 bs_write( s, 2, i_last_pixel );
2435 bs_write( s, 2, i_last_pixel );
2437 else
2439 bs_write( s, 2, 0 );
2440 bs_write( s, 1, 0 );
2441 bs_write( s, 1, 0 );
2442 bs_write( s, 2, 1 ); /* 2 * pseudo color 0 */
2445 else if( i_length > 2 )
2447 bs_write( s, 2, 0 );
2448 if( i_length <= 10 )
2450 bs_write( s, 1, 1 );
2451 bs_write( s, 3, i_length - 3 );
2452 bs_write( s, 2, i_last_pixel );
2454 else
2456 bs_write( s, 1, 0 );
2457 bs_write( s, 1, 0 );
2459 if( i_length <= 27 )
2461 bs_write( s, 2, 2 );
2462 bs_write( s, 4, i_length - 12 );
2463 bs_write( s, 2, i_last_pixel );
2465 else
2467 bs_write( s, 2, 3 );
2468 bs_write( s, 8, i_length - 29 );
2469 bs_write( s, 2, i_last_pixel );
2474 if( i == p_region->fmt.i_visible_width ) break;
2476 i_last_pixel = p_data[i];
2477 i_length = 1;
2480 /* Stop */
2481 bs_write( s, 2, 0 );
2482 bs_write( s, 1, 0 );
2483 bs_write( s, 1, 0 );
2484 bs_write( s, 2, 0 );
2486 /* Stuffing */
2487 bs_align_0( s );
2490 static void encode_pixel_line_4bp( bs_t *s, subpicture_region_t *p_region,
2491 int i_line )
2493 unsigned int i, i_length = 0;
2494 int i_pitch = p_region->p_picture->p->i_pitch;
2495 uint8_t *p_data = &p_region->p_picture->p->p_pixels[ i_pitch * i_line ];
2496 int i_last_pixel = p_data[0];
2498 for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
2500 if( i != p_region->fmt.i_visible_width &&
2501 p_data[i] == i_last_pixel && i_length != 280 )
2503 i_length++;
2504 continue;
2507 if( ( i_length == 1 ) ||
2508 ( ( i_length == 3 ) && i_last_pixel ) ||
2509 ( i_length == 8 ) )
2511 /* 4bit/pixel code */
2512 if( i_last_pixel )
2513 bs_write( s, 4, i_last_pixel );
2514 else
2516 bs_write( s, 4, 0 );
2517 bs_write( s, 1, 1 );
2518 bs_write( s, 1, 1 );
2519 bs_write( s, 2, 0 ); /* pseudo color 0 */
2521 i_length--;
2524 if( i_length == 2 )
2526 if( i_last_pixel )
2528 bs_write( s, 4, i_last_pixel );
2529 bs_write( s, 4, i_last_pixel );
2531 else
2533 bs_write( s, 4, 0 );
2534 bs_write( s, 1, 1 );
2535 bs_write( s, 1, 1 );
2536 bs_write( s, 2, 1 ); /* 2 * pseudo color 0 */
2539 else if( !i_last_pixel && ( i_length >= 3 ) && ( i_length <= 9 ) )
2541 bs_write( s, 4, 0 );
2542 bs_write( s, 1, 0 );
2543 bs_write( s, 3, i_length - 2 ); /* (i_length - 2) * color 0 */
2545 else if( i_length > 2 )
2547 bs_write( s, 4, 0 );
2548 bs_write( s, 1, 1 );
2550 if( i_length <= 7 )
2552 bs_write( s, 1, 0 );
2553 bs_write( s, 2, i_length - 4 );
2554 bs_write( s, 4, i_last_pixel );
2556 else
2558 bs_write( s, 1, 1 );
2560 if( i_length <= 24 )
2562 bs_write( s, 2, 2 );
2563 bs_write( s, 4, i_length - 9 );
2564 bs_write( s, 4, i_last_pixel );
2566 else
2568 bs_write( s, 2, 3 );
2569 bs_write( s, 8, i_length - 25 );
2570 bs_write( s, 4, i_last_pixel );
2575 if( i == p_region->fmt.i_visible_width ) break;
2577 i_last_pixel = p_data[i];
2578 i_length = 1;
2581 /* Stop */
2582 bs_write( s, 8, 0 );
2584 /* Stuffing */
2585 bs_align_0( s );
2588 static void encode_pixel_line_8bp( bs_t *s, subpicture_region_t *p_region,
2589 int i_line )
2591 unsigned int i, i_length = 0;
2592 int i_pitch = p_region->p_picture->p->i_pitch;
2593 uint8_t *p_data = &p_region->p_picture->p->p_pixels[ i_pitch * i_line ];
2594 int i_last_pixel = p_data[0];
2596 for( i = 0; i <= p_region->fmt.i_visible_width; i++ )
2598 if( ( i != p_region->fmt.i_visible_width ) &&
2599 ( p_data[i] == i_last_pixel ) && ( i_length != 127 ) )
2601 i_length++;
2602 continue;
2605 if( ( i_length == 1 ) && i_last_pixel )
2607 /* 8bit/pixel code */
2608 bs_write( s, 8, i_last_pixel );
2610 else if( ( i_length == 2 ) && i_last_pixel )
2612 /* 8bit/pixel code */
2613 bs_write( s, 8, i_last_pixel );
2614 bs_write( s, 8, i_last_pixel );
2616 else if( i_length <= 127 )
2618 bs_write( s, 8, 0 );
2620 if( !i_last_pixel )
2622 bs_write( s, 1, 0 );
2623 bs_write( s, 7, i_length ); /* pseudo color 0 */
2625 else
2627 bs_write( s, 1, 1 );
2628 bs_write( s, 7, i_length );
2629 bs_write( s, 8, i_last_pixel );
2633 if( i == p_region->fmt.i_visible_width ) break;
2635 i_last_pixel = p_data[i];
2636 i_length = 1;
2639 /* Stop */
2640 bs_write( s, 8, 0 );
2641 bs_write( s, 8, 0 );
2643 /* Stuffing */
2644 bs_align_0( s );
2648 static void default_dds_init( decoder_t * p_dec )
2650 decoder_sys_t *p_sys = p_dec->p_sys;
2652 /* see notes on DDS at the top of the file */
2654 /* configure for SD res in case DDS is not present */
2655 p_sys->display.i_version = 0xff; /* an invalid version so it's always different */
2656 p_sys->display.i_width = 720;
2657 p_sys->display.i_height = 576;
2658 p_sys->display.b_windowed = false;