1 /*****************************************************************************
2 * dvbsub.c : DVB subtitles decoder thread
3 *****************************************************************************
4 * Copyright (C) 2003 ANEVIA
5 * Copyright (C) 2003-2004 VideoLAN
8 * Authors: Damien LUCAS <damien.lucas@anevia.com>
9 * Laurent Aimar <fenrir@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
30 #include <vlc/decoder.h>
34 /*****************************************************************************
36 *****************************************************************************/
37 static int Open ( vlc_object_t *p_this );
38 static void Close( vlc_object_t *p_this );
41 set_description( _("DVB subtitles decoder") );
42 set_capability( "decoder", 50 );
43 set_callbacks( Open, Close );
46 /****************************************************************************
48 ****************************************************************************
49 * Those structures refer closely to the ETSI 300 743 Object model
50 ****************************************************************************/
52 /* Storage of a RLE entry */
53 typedef struct dvbsub_rle_s
61 struct dvbsub_rle_s* p_next;
64 /* A subpicture image is a list of codes
65 * We need to store the length of each line since nothing specify in
66 * the standard that all lines shoudl have the same length
67 * WARNING: We assume here that a spu is less than 576 lines high */
73 dvbsub_rle_t* p_codes;
77 /* The object definition gives the position of the object in a region */
78 typedef struct dvbsub_objectdef_s
87 struct dvbsub_objectdef_s* p_next;
91 /* The Region is an aera on the image
92 * with a list of the object definitions associated
94 typedef struct dvbsub_region_s
97 uint8_t i_version_number;
103 uint8_t i_level_comp;
109 dvbsub_objectdef_t* p_object;
113 /* The page defines the list of regions */
119 uint8_t i_version_number;
120 uint8_t i_regions_number;
121 dvbsub_region_t* regions;
125 /* An object is constituted of 2 images (for interleaving) */
126 typedef struct dvbsub_object_s
129 uint8_t i_version_number;
130 uint8_t i_coding_method;
131 vlc_bool_t b_non_modify_color;
132 dvbsub_image_t* topfield;
133 dvbsub_image_t* bottomfield;
134 struct dvbsub_object_s* p_next;
138 /* The entry in the palette CLUT */
152 uint8_t i_version_number;
153 dvbsub_color_t c_2b[0xff];
154 dvbsub_color_t c_4b[0xff];
155 dvbsub_color_t c_8b[0xff];
163 dvbsub_image_t* p_rle_top;
164 dvbsub_image_t* p_rle_bot;
174 dvbsub_clut_t* p_clut[0xff];
175 dvbsub_page_t* p_page;
176 dvbsub_object_t* p_objects;
177 subpicture_t* p_spu[16];
178 int i_subpic_channel;
182 struct subpicture_sys_t
185 void * p_data; /* rle datas are stored */
186 vlc_object_t* p_input; /* Link to the input */
187 vlc_bool_t b_obsolete;
192 vout_thread_t *p_vout;
200 // List of different SEGMENT TYPES
201 // According to EN 300-743, table 2
202 #define DVBSUB_ST_PAGE_COMPOSITION 0x10
203 #define DVBSUB_ST_REGION_COMPOSITION 0x11
204 #define DVBSUB_ST_CLUT_DEFINITION 0x12
205 #define DVBSUB_ST_OBJECT_DATA 0x13
206 #define DVBSUB_ST_ENDOFDISPLAY 0x80
207 #define DVBSUB_ST_STUFFING 0xff
208 // List of different OBJECT TYPES
209 // According to EN 300-743, table 6
210 #define DVBSUB_OT_BASIC_BITMAP 0x00
211 #define DVBSUB_OT_BASIC_CHAR 0x01
212 #define DVBSUB_OT_COMPOSITE_STRING 0x02
214 // According to EN 300-743, table 9
215 #define DVBSUB_DT_2BP_CODE_STRING 0x10
216 #define DVBSUB_DT_4BP_CODE_STRING 0x11
217 #define DVBSUB_DT_8BP_CODE_STRING 0x12
218 #define DVBSUB_DT_24_TABLE_DATA 0x20
219 #define DVBSUB_DT_28_TABLE_DATA 0x21
220 #define DVBSUB_DT_48_TABLE_DATA 0x22
221 #define DVBSUB_DT_END_LINE 0xf0
223 /*****************************************************************************
225 *****************************************************************************/
226 static void Decode ( decoder_t *, block_t ** );
228 static vout_thread_t *FindVout( decoder_t * );
230 static int init( dvbsub_all_t *, int );
231 static void decode_segment( decoder_t *, dvbsub_all_t *, bs_t * );
232 static void render( dvbsub_all_t *, vout_thread_t * );
233 static void dvbsub( dvbsub_all_t * );
235 /*****************************************************************************
236 * Open: probe the decoder and return score
237 *****************************************************************************
238 * Tries to launch a decoder and return score so that the interface is able
240 *****************************************************************************/
241 static int Open( vlc_object_t *p_this )
243 decoder_t *p_dec = (decoder_t*) p_this;
244 decoder_sys_t *p_sys;
246 if( p_dec->fmt_in.i_codec != VLC_FOURCC('d','v','b','s') )
251 p_dec->pf_decode_sub = Decode;
252 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
254 p_sys->p_vout = NULL;
256 init( &p_sys->dvbsub, p_dec->fmt_in.subs.dvb.i_id );
258 es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 'd','v','b','s' ) );
263 /*****************************************************************************
265 *****************************************************************************/
266 static void Close( vlc_object_t *p_this )
268 decoder_t *p_dec = (decoder_t*) p_this;
269 decoder_sys_t *p_sys = p_dec->p_sys;
271 if( p_sys->p_vout && p_sys->p_vout->p_subpicture != NULL )
273 subpicture_t * p_subpic;
275 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
277 p_subpic = &p_sys->p_vout->p_subpicture[i_subpic];
278 if( p_subpic != NULL &&
279 ( p_subpic->i_status == RESERVED_SUBPICTURE ||
280 p_subpic->i_status == READY_SUBPICTURE ) )
282 vout_DestroySubPicture( p_sys->p_vout, p_subpic );
287 dvbsub( &p_sys->dvbsub );
292 /*****************************************************************************
294 *****************************************************************************/
295 static void Decode( decoder_t *p_dec, block_t **pp_block )
297 decoder_sys_t *p_sys = p_dec->p_sys;
299 vout_thread_t *p_last_vout;
301 if( pp_block == NULL || *pp_block == NULL )
308 p_sys->dvbsub.i_pts = p_block->i_pts;
309 if( p_sys->dvbsub.i_pts <= 0 )
311 msg_Warn( p_dec, "non dated subtitle" );
312 block_Release( p_block );
316 p_last_vout = p_sys->p_vout;
317 if( ( p_sys->p_vout = FindVout( p_dec ) ) )
319 int i_data_identifier;
320 int i_subtitle_stream_id;
321 int i_end_data_marker;
323 bs_init( &p_sys->bs, p_block->p_buffer, p_block->i_buffer );
325 i_data_identifier = bs_read( &p_sys->bs, 8 );
326 i_subtitle_stream_id = bs_read( &p_sys->bs, 8 );
330 if( bs_show( &p_sys->bs, 8 ) != 0x0f )
334 decode_segment( p_dec, &p_sys->dvbsub, &p_sys->bs );
336 i_end_data_marker = bs_read( &p_sys->bs, 8 );
338 if( p_last_vout != p_sys->p_vout )
340 p_sys->dvbsub.i_subpic_channel =
341 vout_RegisterOSDChannel( p_sys->p_vout );
344 /* Check if the page is to be displayed */
345 if( p_sys->dvbsub.p_page && p_sys->dvbsub.p_objects )
347 render( &p_sys->dvbsub, p_sys->p_vout );
350 vlc_object_release( p_sys->p_vout );
353 block_Release( p_block );
356 /* following functions are local */
357 /*****************************************************************************
358 * FindVout: Find a vout or wait for one to be created.
359 *****************************************************************************/
360 static vout_thread_t *FindVout( decoder_t *p_dec )
364 vout_thread_t *p_vout;
366 if( p_dec->b_die || p_dec->b_error )
370 p_vout = vlc_object_find( p_dec, VLC_OBJECT_VOUT, FIND_ANYWHERE );
375 msleep( VOUT_OUTMEM_SLEEP );
379 static int init( dvbsub_all_t *p_dvbsub, int i_id )
383 memset( p_dvbsub, 0, sizeof( dvbsub_all_t ) );
386 p_dvbsub->i_id = i_id;
387 p_dvbsub->p_page = NULL;
388 p_dvbsub->p_objects = NULL;
389 for( i = 0; i < 255; i++ )
391 p_dvbsub->p_clut[i] = NULL;
393 for( i = 0; i < 16; i++ )
395 p_dvbsub->p_spu[i] = NULL;
400 static void free_all( dvbsub_all_t * );
402 static void dvbsub( dvbsub_all_t *p_dvbsub )
404 free_all( p_dvbsub );
407 static void decode_clut( dvbsub_all_t *p_dvbsub, bs_t *s );
408 static void decode_page_composition( dvbsub_all_t *p_dvbsub, bs_t *s);
409 static void decode_region_composition( dvbsub_all_t *p_dvbsub, bs_t *s );
410 static void stop_display( dvbsub_all_t* p_dvbsub );
411 static void decode_object( dvbsub_all_t *p_dvbsub, bs_t *s );
413 static void free_page( dvbsub_page_t* p_p );
415 static void decode_segment( decoder_t *p_dec, dvbsub_all_t *p_dvbspu, bs_t *s )
425 i_type = bs_read( s, 8 );
428 i_page_id = bs_read( s, 16 );
431 i_size = bs_show( s, 16 );
433 if( i_page_id != p_dvbspu->i_id )
435 bs_skip( s, 8 * ( 2 + i_size ) );
441 case DVBSUB_ST_CLUT_DEFINITION:
443 msg_Dbg( p_dec, "subtitle dvbsub_decode_clut" );
445 decode_clut( p_dvbspu, s );
447 case DVBSUB_ST_PAGE_COMPOSITION:
449 msg_Dbg( p_dec, "subtitle dvbsub_decode_page_composition" );
451 decode_page_composition( p_dvbspu, s );
453 case DVBSUB_ST_REGION_COMPOSITION:
455 msg_Dbg( p_dec, "subtitle dvbsub_decode_region_composition" );
457 decode_region_composition( p_dvbspu, s );
459 case DVBSUB_ST_OBJECT_DATA:
461 msg_Dbg( p_dec, "subtitle dvbsub_decode_object" );
463 decode_object( p_dvbspu, s );
465 case DVBSUB_ST_ENDOFDISPLAY:
467 msg_Dbg( p_dec, "subtitle dvbsub_stop_display" );
469 stop_display( p_dvbspu );
471 case DVBSUB_ST_STUFFING:
473 msg_Warn( p_dec, "unsupported segment type: (%04x)", i_type );
474 bs_skip( s, 8 * ( 2 + i_size ) );
479 static void stop_display( dvbsub_all_t *p_dvbsub )
483 for( i = 0; p_dvbsub->p_spu[i] != NULL; i++ )
485 p_dvbsub->p_spu[i]->i_stop = p_dvbsub->i_pts;
489 static void decode_clut( dvbsub_all_t *p_dvbsub, bs_t *s )
491 uint16_t i_segment_length;
492 uint16_t i_processed_length;
495 uint8_t i_version_number;
497 i_segment_length = bs_read( s, 16 );
498 i_clut_id = bs_read( s, 8 );
499 i_version_number = bs_read( s, 4 );
501 // Check that this id doesn't not already exist
502 // with the same version number
503 // And allocate memory if necessary
504 if( p_dvbsub->p_clut[i_clut_id] != NULL)
506 if( p_dvbsub->p_clut[i_clut_id]->i_version_number == i_version_number )
508 //TODO skip the right number of bits
513 memset( p_dvbsub->p_clut[i_clut_id], 0, sizeof(dvbsub_clut_t) );
518 p_dvbsub->p_clut[i_clut_id] = malloc( sizeof(dvbsub_clut_t) );
520 clut = p_dvbsub->p_clut[i_clut_id];
522 /* We don't have this version of the CLUT: Parse it */
523 clut->i_version_number = i_version_number;
524 bs_skip( s, 4 ); /* Reserved bits */
525 i_processed_length = 2;
526 while( i_processed_length < i_segment_length )
528 uint8_t y, cb, cr, t;
532 i_id = bs_read( s, 8 );
533 i_type = bs_read( s, 3 );
537 if( bs_read( s, 1 ) )
540 cr = bs_read( s, 8 );
541 cb = bs_read( s, 8 );
543 i_processed_length += 6;
548 cr = bs_read( s, 4 );
549 cb = bs_read( s, 4 );
551 i_processed_length += 4;
554 /* According to EN 300-743 section 7.2.3 note 1, type should
555 * not have more than 1 bit set to one
556 But, some strams don't respect this note. */
560 clut->c_2b[i_id].Y = y;
561 clut->c_2b[i_id].Cr = cr;
562 clut->c_2b[i_id].Cb = cb;
563 clut->c_2b[i_id].T = t;
567 clut->c_4b[i_id].Y = y;
568 clut->c_4b[i_id].Cr = cr;
569 clut->c_4b[i_id].Cb = cb;
570 clut->c_4b[i_id].T = t;
574 clut->c_8b[i_id].Y = y;
575 clut->c_8b[i_id].Cr = cr;
576 clut->c_8b[i_id].Cb = cb;
577 clut->c_8b[i_id].T = t;
582 static void decode_page_composition( dvbsub_all_t *p_dvbsub, bs_t *s )
584 unsigned int i_version_number;
585 unsigned int i_state;
586 unsigned int i_segment_length;
590 i_segment_length = bs_read( s, 16 );
592 /* A page is composed by one or more region: */
593 i_timeout = bs_read( s, 8 );
594 i_version_number = bs_read( s, 4 );
595 i_state = bs_read( s, 2 );
597 /* TODO We assume it is a new page (i_state) */
598 if( p_dvbsub->p_page ) free_page( p_dvbsub->p_page );
600 bs_skip( s, 2 ); /* Reserved */
602 /* Allocate a new page */
603 p_dvbsub->p_page = malloc( sizeof(dvbsub_page_t) );
604 p_dvbsub->p_page->i_timeout = i_timeout;
606 /* Number of regions: */
607 p_dvbsub->p_page->i_regions_number = (i_segment_length-2) / 6;
609 /* Special workaround for CAVENA encoders: a page with no regions is sent
610 * instead of a 0x80 packet (End Of Display) */
611 if( p_dvbsub->p_page->i_regions_number == 0 )
613 stop_display( p_dvbsub );
615 /* End of workaround */
617 p_dvbsub->p_page->regions =
618 malloc( p_dvbsub->p_page->i_regions_number * sizeof(dvbsub_region_t) );
619 for( i = 0; i < p_dvbsub->p_page->i_regions_number; i++ )
621 p_dvbsub->p_page->regions[i].i_id = bs_read( s, 8 );
622 bs_skip( s, 8 ); /* Reserved */
623 p_dvbsub->p_page->regions[i].i_x = bs_read( s, 16 );
624 p_dvbsub->p_page->regions[i].i_y = bs_read( s, 16 );
625 p_dvbsub->p_page->regions[i].p_object = NULL;
630 static void decode_region_composition( dvbsub_all_t *p_dvbsub, bs_t *s )
632 dvbsub_region_t* p_region = NULL;
633 unsigned int i_segment_length;
634 unsigned int i_processed_length;
635 unsigned int i_region_id;
638 i_segment_length = bs_read( s, 16 );
641 i_region_id = bs_read( s, 8 );
642 for( i = 0; i < p_dvbsub->p_page->i_regions_number; i++ )
644 if( p_dvbsub->p_page->regions[i].i_id == i_region_id )
646 p_region = &(p_dvbsub->p_page->regions[i]);
650 if( p_region == NULL )
653 * The region has never been declared before
655 fprintf( stderr, "Decoding of undeclared region N/A\n" );
659 /* Skip version number and fill flag */
660 if( bs_show( s, 4 ) == p_region->i_version_number )
662 fprintf( stderr, "Skipping already known region N/A\n" );
663 /* TODO Skip the right number of bits */
666 /* Region attributes */
667 p_region->i_version_number = bs_read( s, 4 );
668 p_region->b_fill = bs_read( s, 1 );
669 bs_skip( s, 3 ); /* Reserved */
670 p_region->i_width = bs_read( s, 16 );
671 p_region->i_height = bs_read( s, 16 );
672 p_region->i_level_comp = bs_read( s, 3 );
673 p_region->i_depth = bs_read( s, 3 );
674 bs_skip( s, 2 ); /* Reserved */
675 p_region->i_clut = bs_read( s, 8 );
676 p_region->i_8bp_code = bs_read( s, 8 );
677 p_region->i_4bp_code = bs_read( s, 4 );
678 p_region->i_2bp_code = bs_read( s, 2 );
679 bs_skip( s, 2 ); /* Reserved */
681 /* List of objects in the region: */
682 /* We already skipped 10 bytes */
684 i_processed_length = 10;
685 while( i_processed_length < i_segment_length )
687 /* We create a new object */
688 dvbsub_objectdef_t *p_obj = malloc( sizeof(dvbsub_objectdef_t) );
690 /* We parse object properties */
691 p_obj->p_next = NULL;
692 p_obj->i_id = bs_read( s, 16 );
693 p_obj->i_type = bs_read( s, 2 );
694 p_obj->i_provider = bs_read( s, 2 );
695 p_obj->i_xoffset = bs_read( s, 12 );
696 bs_skip( s, 4 ); /* Reserved */
697 p_obj->i_yoffset = bs_read( s, 12 );
699 i_processed_length += 6;
701 if( p_obj->i_type == DVBSUB_OT_BASIC_CHAR ||
702 p_obj->i_type == DVBSUB_OT_COMPOSITE_STRING )
704 p_obj->i_fg_pc = bs_read( s, 8 );
705 p_obj->i_bg_pc = bs_read( s, 8 );
706 i_processed_length += 2;
710 if( p_region->p_object )
712 dvbsub_objectdef_t *p_o;
713 for( p_o = p_region->p_object; ; p_o = p_o->p_next )
715 if( p_o->p_next == NULL )
724 p_region->p_object = p_obj;
729 static dvbsub_image_t* dvbsub_parse_pdata( dvbsub_all_t *p_dvbsub, bs_t *s,
731 static uint16_t dvbsub_count0x11( bs_t *s, uint16_t* p,
732 dvbsub_image_t* p_image);
734 static void decode_object( dvbsub_all_t *p_dvbsub, bs_t *s )
736 dvbsub_object_t *p_obj;
737 uint16_t i_segment_length;
739 /* Memory Allocation */
740 p_obj = malloc( sizeof(dvbsub_object_t) );
741 p_obj->p_next = NULL;
743 i_segment_length = bs_read( s, 16 );
745 /* TODO Check we don't already have this object / this version */
746 p_obj->i_id = bs_read( s, 16 );
747 p_obj->i_version_number = bs_read( s, 4 );
748 p_obj->i_coding_method = bs_read( s, 2 );
749 p_obj->b_non_modify_color= bs_read( s, 1 );
750 bs_skip( s, 1 ); /* Reserved */
752 if( p_obj->i_coding_method == 0x00 )
754 uint16_t i_topfield_length;
755 uint16_t i_bottomfield_length;
757 i_topfield_length = bs_read( s, 16 );
758 i_bottomfield_length = bs_read( s, 16 );
761 dvbsub_parse_pdata( p_dvbsub, s, i_topfield_length );
763 dvbsub_parse_pdata( p_dvbsub, s, i_bottomfield_length );
767 bs_skip( s, (i_segment_length - 3 ) * 8 );
768 /*TODO: DVB subtitling as characters */
771 /* Add this object to the list of the page */
772 p_obj->p_next = p_dvbsub->p_objects;
773 p_dvbsub->p_objects = p_obj;
776 static dvbsub_image_t* dvbsub_parse_pdata( dvbsub_all_t *p_dvbsub, bs_t *s,
779 dvbsub_image_t* p_image;
780 uint16_t i_processed_length = 0;
781 uint16_t i_lines = 0;
782 uint16_t i_cols_last = 0;
784 p_image = malloc( sizeof(dvbsub_image_t) );
785 p_image->p_last = NULL;
787 memset( p_image->i_cols, 0, 576 * sizeof(uint16_t) );
789 /* Let's parse it a first time to determine the size of the buffer */
790 while( i_processed_length < length)
792 switch( bs_read( s, 8 ) )
795 fprintf(stderr, "0x10 N/A\n");
798 i_processed_length +=
799 1 + dvbsub_count0x11( s, &(p_image->i_cols[i_lines]),
803 fprintf(stderr, "0x12 N/A\n");
806 fprintf(stderr, "0x20 N/A\n");
809 fprintf(stderr, "0x21 N/A\n");
812 fprintf(stderr, "0x22 N/A\n");
815 i_processed_length++;
821 p_image->i_rows = i_lines;
822 p_image->i_cols[i_lines] = i_cols_last;
824 /* Check word-aligned bits */
825 if( bs_show( s, 8 ) == 0x00 )
833 static void add_rle_code( dvbsub_image_t *p, uint16_t num, uint8_t color )
835 if(p->p_last != NULL)
837 p->p_last->p_next = malloc( sizeof(dvbsub_rle_t) );
838 p->p_last = p->p_last->p_next;
842 p->p_codes = malloc( sizeof(dvbsub_rle_t) );
843 p->p_last = p->p_codes;
845 p->p_last->i_num = num;
846 p->p_last->i_color_code = color;
847 p->p_last->p_next = NULL;
850 static uint16_t dvbsub_count0x11( bs_t *s, uint16_t* p,
851 dvbsub_image_t* p_image )
853 uint16_t i_processed=0;
855 uint16_t i_count = 0;
860 if( (i_color = bs_read( s, 4 )) != 0x00 )
865 /* 1 pixel of color code '0000' */
866 add_rle_code( p_image, 1, i_color );
870 if( bs_read( s, 1 ) == 0x00 ) // Switch1
872 if( bs_show( s, 3 ) != 0x00 )
874 i_count = 2 + bs_read( s, 3 );
876 add_rle_code( p_image, i_count, 0x00 );
887 if( bs_read( s, 1 ) == 0x00) //Switch2
889 i_count = 4 + bs_read( s, 2 );
890 i_color = bs_read( s, 4 );
893 add_rle_code( p_image, i_count, i_color );
897 switch ( bs_read( s, 2 ) ) //Switch3
902 add_rle_code( p_image, 1, 0x00 );
907 add_rle_code( p_image, 2, 0x00 );
910 i_count = 9 + bs_read( s, 4 );
911 i_color = bs_read( s, 4 );
914 add_rle_code( p_image, i_count, i_color );
917 i_count= 25 + bs_read( s, 8 );
918 i_color = bs_read( s, 4 );
921 add_rle_code( p_image, i_count, i_color );
931 return ( i_processed + 7 ) / 8 ;
934 static void free_image (dvbsub_image_t* p_i)
937 dvbsub_rle_t* p2=NULL;
939 for( p1 = p_i->p_codes; p1 != NULL; p1=p2)
949 static void free_object (dvbsub_object_t* p_o)
954 static void free_objectdefs ( dvbsub_objectdef_t* p_o)
956 dvbsub_objectdef_t* p1;
957 dvbsub_objectdef_t* p2=NULL;
959 for( p1 = p_o; p1 != NULL; p1=p2)
967 static void free_regions (dvbsub_region_t* p_r, uint8_t nb)
971 for (i = 0; i<nb; i++) free_objectdefs ( p_r[i].p_object );
976 static void free_objects (dvbsub_object_t* p_o)
979 dvbsub_object_t* p2=NULL;
981 for( p1 = p_o; p1 != NULL; p1=p2)
984 free_image (p1->topfield);
985 free_image (p1->bottomfield);
990 static void free_clut ( dvbsub_clut_t* p_c )
995 static void free_page (dvbsub_page_t* p_p)
997 free_regions (p_p->regions, p_p->i_regions_number);
1002 static void free_spu( subpicture_t *p_spu )
1006 free_image(((dvbsub_render_t *)p_spu->p_sys->p_data)->p_rle_top);
1007 free_image(((dvbsub_render_t *)p_spu->p_sys->p_data)->p_rle_bot);
1008 free(p_spu->p_sys->p_data);
1009 free( p_spu->p_sys );
1010 p_spu->p_sys = NULL;
1014 static void free_all ( dvbsub_all_t* p_a )
1018 for(i=0; i<0xff; i++) if (p_a->p_clut[i]) free_clut ( p_a->p_clut[i] );
1019 for(i=0; i<16; i++) if (p_a->p_spu[i]) free_spu ( p_a->p_spu[i] );
1020 if(p_a->p_page) free_page( p_a->p_page );
1021 free_objects (p_a->p_objects);
1024 static void RenderYUY2( vout_thread_t *p_vout, picture_t *p_pic,
1025 const subpicture_t *p_spu )
1027 /* Common variables */
1033 dvbsub_render_t* p_r = ((dvbsub_render_t *)p_spu->p_sys->p_data);
1034 dvbsub_image_t* p_im = p_r->p_rle_top;
1037 p_desty = p_pic->Y_PIXELS;
1038 //let's render the 1st frame
1039 for(p_c = p_im->p_codes; p_c->p_next != NULL; p_c=p_c->p_next)
1041 //if( p_c->y != 0 && p_c->t < 0x20)
1042 if( p_c->y != 0 && p_c->t < 0x20)
1046 //memset(p_desty+ y*p_pic->Y_PITCH + x, p_c->y, p_c->i_num);
1047 // In YUY2 we have to set pixel per pixel
1048 for( i_cnt = 0; i_cnt < p_c->i_num; i_cnt+=2 )
1050 memset(p_desty+ y*p_pic->Y_PITCH + 2*x + i_cnt, p_c->y, 1);
1051 //memset(p_desty+ y*p_pic->Y_PITCH + 2*x + i_cnt+1, p_c->cr, 1);
1052 //memset(p_desty+ y*p_pic->Y_PITCH + 2*x + i_cnt+2, p_c->y, 1);
1053 //memset(p_desty+ y*p_pic->Y_PITCH + 2*x + i_cnt+3, p_c->cb, 1);
1057 if(j >= p_im->i_cols[i])
1061 if( i>= p_im->i_rows) break;
1063 //idem for the second frame
1064 p_im = p_r->p_rle_bot; i=0; j=0;
1065 for(p_c = p_im->p_codes; p_c->p_next != NULL; p_c=p_c->p_next)
1067 if( p_c->y != 0 && p_c->t < 0x20)
1071 //memset(p_desty+ y*p_pic->Y_PITCH + x, p_c->y, p_c->i_num);
1072 // In YUY2 we have to set pixel per pixel
1073 for( i_cnt = 0; i_cnt < p_c->i_num; i_cnt+=2 )
1075 memset(p_desty+ y*p_pic->Y_PITCH + 2*x + i_cnt, p_c->y, 1);
1076 //memset(p_desty+ y*p_pic->Y_PITCH + 2*x + i_cnt+1, p_c->cr, 1);
1077 //memset(p_desty+ y*p_pic->Y_PITCH + 2*x + i_cnt+2, p_c->y, 1);
1078 //memset(p_desty+ y*p_pic->Y_PITCH + 2*x + i_cnt+3, p_c->cb, 1);
1082 if(j >= p_im->i_cols[i])
1086 if( i>= p_im->i_rows) break;
1090 static void RenderI42x( vout_thread_t *p_vout, picture_t *p_pic,
1091 const subpicture_t *p_spu )
1093 /* Common variables */
1100 dvbsub_render_t* p_r = ((dvbsub_render_t *)p_spu->p_sys->p_data);
1101 dvbsub_image_t* p_im = p_r->p_rle_top;
1104 p_desty = p_pic->Y_PIXELS;
1105 p_destu = p_pic->U_PIXELS;
1106 p_destv = p_pic->V_PIXELS;
1107 //let's render the 1st frame
1108 for(p_c = p_im->p_codes; p_c->p_next != NULL; p_c=p_c->p_next)
1114 //memset(p_dest+ y*p_pic->U_PITCH*2 + x, p_c->cr, p_c->i_num);
1115 //memset(p_desty+ (y)*p_pic->Y_PITCH + x, p_c->cr, p_c->i_num);
1116 //memset(p_dest+ y*p_pic->V_PITCH*2 + x, p_c->cb, p_c->i_num);
1117 //memset(p_destu+ (y)*p_pic->Y_PITCH + x, p_c->cb, p_c->i_num);
1118 memset(p_desty+ y*p_pic->Y_PITCH + x, p_c->y, p_c->i_num);
1119 //memset(p_desty+ 2*y*p_pic->U_PITCH + x, p_c->cr, p_c->i_num);
1120 //memset(p_desty+ 2*y*p_pic->V_PITCH + x, p_c->cb, p_c->i_num);
1123 if(j >= p_im->i_cols[i])
1127 if( i>= p_im->i_rows) break;
1129 //idem for the second frame
1130 p_im = p_r->p_rle_bot; i=0; j=0;
1131 for(p_c = p_im->p_codes; p_c->p_next != NULL; p_c=p_c->p_next)
1133 if( p_c->y != 0 && p_c->t < 0x20)
1137 //memset(p_desty+ y*p_pic->U_PITCH*2 + x, p_c->cr, p_c->i_num);
1138 //memset(p_desty+ y*p_pic->V_PITCH*2 + x, p_c->cb, p_c->i_num);
1139 memset(p_desty+ y*p_pic->Y_PITCH + x, p_c->y, p_c->i_num);
1140 //memset(p_desty+ 2*y*p_pic->U_PITCH + x, p_c->cr, p_c->i_num);
1141 //memset(p_desty+ 2*y*p_pic->V_PITCH + x, p_c->cb, p_c->i_num);
1144 if(j >= p_im->i_cols[i])
1148 if( i>= p_im->i_rows) break;
1152 static void RenderDVBSUB( vout_thread_t *p_vout, picture_t *p_pic,
1153 const subpicture_t *p_spu )
1155 /* If we have changed the language on the fly */
1157 if( p_spu->p_sys == NULL || p_spu->p_sys->b_obsolete )
1162 switch( p_vout->output.i_chroma )
1164 /* I420 target, no scaling */
1165 case VLC_FOURCC('I','4','2','2'):
1166 case VLC_FOURCC('I','4','2','0'):
1167 case VLC_FOURCC('I','Y','U','V'):
1168 case VLC_FOURCC('Y','V','1','2'):
1169 /* As long as we just use Y info, I422 and YV12 are just equivalent
1170 * to I420. Remember to change it the day we'll take into account
1172 RenderI42x( p_vout, p_pic, p_spu );
1175 /* RV16 target, scaling */
1176 case VLC_FOURCC('R','V','1','6'):
1177 msg_Err(p_vout, "unimplemented chroma: RV16");
1178 /* RenderRV16( p_vout, p_pic, p_spu ); */
1181 /* RV32 target, scaling */
1182 case VLC_FOURCC('R','V','2','4'):
1183 case VLC_FOURCC('R','V','3','2'):
1184 msg_Err(p_vout, "unimplemented chroma: RV32");
1185 /* RenderRV32( p_vout, p_pic, p_spu ); */
1188 /* NVidia overlay, no scaling */
1189 case VLC_FOURCC('Y','U','Y','2'):
1190 RenderYUY2( p_vout, p_pic, p_spu );
1194 msg_Err( p_vout, "unknown chroma, can't render SPU" );
1199 static void dvbsub_Destroy( subpicture_t *p_spu )
1204 static void render( dvbsub_all_t *dvbsub, vout_thread_t *p_vout )
1206 dvbsub_region_t* p_region;
1207 dvbsub_objectdef_t* p_objectdef;
1208 dvbsub_object_t* p_o;
1209 dvbsub_object_t* p_object;
1210 dvbsub_object_t* p_object_old;
1211 dvbsub_render_t* p_render;
1215 /* loop on regions */
1216 for( i = 0; i < dvbsub->p_page->i_regions_number; i++ )
1218 p_region = &(dvbsub->p_page->regions[i]);
1220 /* loop on objects */
1221 for( p_objectdef = p_region->p_object; p_objectdef != NULL;
1222 p_objectdef = p_objectdef->p_next )
1224 /* Look for the right object */
1225 p_object = dvbsub->p_objects;
1226 while( !p_object && p_object->i_id != p_objectdef->i_id )
1228 p_object = p_object->p_next;
1233 msg_Err( p_vout, "internal decoder error");
1237 /* Allocate the render structure */
1238 p_render = malloc( sizeof(dvbsub_render_t) );
1239 p_render->i_x = p_region->i_x + p_objectdef->i_xoffset;
1240 p_render->i_y = p_region->i_y + p_objectdef->i_yoffset;
1241 p_render->p_rle_top = p_object->topfield;
1242 p_render->p_rle_bot = p_object->bottomfield;
1244 // if we did not recieved the CLUT yet
1245 if( !dvbsub->p_clut[p_region->i_clut] ) return;
1247 /* Compute the color datas according to the appropriate CLUT */
1248 for( p_c = p_render->p_rle_top->p_codes;
1249 p_c->p_next != NULL; p_c = p_c->p_next )
1251 //TODO We assume here we are working in 4bp
1252 p_c->y = dvbsub->p_clut[p_region->i_clut]->c_4b[p_c->i_color_code].Y;
1253 p_c->cr = dvbsub->p_clut[p_region->i_clut]->c_4b[p_c->i_color_code].Cr;
1254 p_c->cb = dvbsub->p_clut[p_region->i_clut]->c_4b[p_c->i_color_code].Cb;
1255 p_c->t = dvbsub->p_clut[p_region->i_clut]->c_4b[p_c->i_color_code].T;
1257 for( p_c = p_render->p_rle_bot->p_codes; p_c->p_next != NULL;
1260 //TODO We assume here we are working in 4bp
1261 p_c->y = dvbsub->p_clut[p_region->i_clut]->c_4b[p_c->i_color_code].Y;
1262 p_c->cr = dvbsub->p_clut[p_region->i_clut]->c_4b[p_c->i_color_code].Cr;
1263 p_c->cb = dvbsub->p_clut[p_region->i_clut]->c_4b[p_c->i_color_code].Cb;
1264 p_c->t = dvbsub->p_clut[p_region->i_clut]->c_4b[p_c->i_color_code].T;
1268 /* Allocate the subpicture internal data. */
1270 vout_CreateSubPicture( p_vout, dvbsub->i_subpic_channel,
1271 MEMORY_SUBPICTURE );
1272 if( dvbsub->p_spu[j] == NULL )
1274 msg_Err(p_vout, "Unable to allocate memory, skipping");
1277 /* Set the pf_render callback */
1278 dvbsub->p_spu[j]->pf_render = RenderDVBSUB;
1279 dvbsub->p_spu[j]->p_sys = malloc( sizeof(subpicture_sys_t) );
1280 dvbsub->p_spu[j]->p_sys->p_data = p_render;
1281 dvbsub->p_spu[j]->p_sys->b_obsolete = 0;
1282 dvbsub->p_spu[j]->pf_destroy = dvbsub_Destroy;
1283 dvbsub->p_spu[j]->i_start = dvbsub->i_pts;
1284 dvbsub->p_spu[j]->i_stop = dvbsub->p_spu[j]->i_start +
1285 dvbsub->p_page->i_timeout * 1000000;
1286 dvbsub->p_spu[j]->b_ephemer = VLC_FALSE;
1288 // At this stage, we have all we need in p_render
1289 // We need to free the object
1290 //Remove this object from the list
1291 p_object_old = p_object;
1292 if( p_object == dvbsub->p_objects )
1294 dvbsub->p_objects = p_object->p_next;
1298 for( p_o = dvbsub->p_objects; p_o->p_next != p_object;
1299 p_o = p_o->p_next );
1300 p_o->p_next = p_object->p_next;
1302 free_object(p_object_old);
1304 vout_DisplaySubPicture( p_vout, dvbsub->p_spu[j] );