1 /*****************************************************************************
2 * zvbi.c : VBI and Teletext PES demux and decoder using libzvbi
3 *****************************************************************************
4 * Copyright (C) 2007, M2X
7 * Authors: Derk-Jan Hartman <djhartman at m2x dot nl>
8 * Jean-Paul Saman <jpsaman at m2x dot nl>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
24 /*****************************************************************************
26 * information on teletext format can be found here :
27 * http://pdc.ro.nu/teletext.html
29 *****************************************************************************/
31 /* This module implements:
32 * ETSI EN 301 775: VBI data in PES
33 * ETSI EN 300 472: EBU Teletext data in PES
34 * ETSI EN 300 706: Enhanced Teletext (libzvbi)
35 * ETSI EN 300 231: Video Programme System [VPS] (libzvbi)
36 * ETSI EN 300 294: 625-line Wide Screen Signaling [WSS] (libzvbi)
37 * EIA-608 Revision A: Closed Captioning [CC] (libzvbi)
44 #include <vlc_common.h>
45 #include <vlc_plugin.h>
50 #include "vlc_codec.h"
52 /*****************************************************************************
54 *****************************************************************************/
55 static int Open ( vlc_object_t * );
56 static void Close( vlc_object_t * );
58 #define PAGE_TEXT N_("Teletext page")
59 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
60 "Default page is index 100")
62 #define OPAQUE_TEXT N_("Text is always opaque")
63 #define OPAQUE_LONGTEXT N_("Setting vbi-opaque to false " \
64 "makes the boxed text transparent." )
66 #define POS_TEXT N_("Teletext alignment")
67 #define POS_LONGTEXT N_( \
68 "You can enforce the teletext position on the video " \
69 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
70 "also use combinations of these values, eg. 6 = top-right).")
72 #define TELX_TEXT N_("Teletext text subtitles")
73 #define TELX_LONGTEXT N_( "Output teletext subtitles as text " \
74 "instead of as RGBA" )
76 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
77 static const char *const ppsz_pos_descriptions[] =
78 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
79 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
82 set_description( N_("VBI and Teletext decoder") );
83 set_shortname( N_("VBI & Teletext") );
84 set_capability( "decoder", 51 );
85 set_category( CAT_INPUT );
86 set_subcategory( SUBCAT_INPUT_SCODEC );
87 set_callbacks( Open, Close );
89 add_integer( "vbi-page", 100, NULL,
90 PAGE_TEXT, PAGE_LONGTEXT, false );
91 add_bool( "vbi-opaque", true, NULL,
92 OPAQUE_TEXT, OPAQUE_LONGTEXT, false );
93 add_integer( "vbi-position", 4, NULL, POS_TEXT, POS_LONGTEXT, false );
94 change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL );
95 add_bool( "vbi-text", false, NULL,
96 TELX_TEXT, TELX_LONGTEXT, false );
99 /****************************************************************************
101 ****************************************************************************/
103 // #define ZVBI_DEBUG
105 //Guessing table for missing "default region triplet"
106 static const int pi_default_triplet[] = {
109 24,24,24,24, //ssc scr slv rum
110 32,32,32,32,32, //est lit rus bul ukr
115 static const char *const ppsz_default_triplet[] = {
118 "ssc", "scr", "slv", "rum",
119 "est", "lit", "rus", "bul", "ukr",
127 ZVBI_KEY_RED = 'r' << 0x16,
128 ZVBI_KEY_GREEN = 'g' << 0x16,
129 ZVBI_KEY_YELLOW = 'y' << 0x16,
130 ZVBI_KEY_BLUE = 'b' << 0x16,
131 ZVBI_KEY_INDEX = 'i' << 0x16,
135 DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE = 0x02,
136 DATA_UNIT_EBU_TELETEXT_SUBTITLE = 0x03,
137 DATA_UNIT_EBU_TELETEXT_INVERTED = 0x0C,
139 DATA_UNIT_ZVBI_WSS_CPR1204 = 0xB4,
140 DATA_UNIT_ZVBI_CLOSED_CAPTION_525 = 0xB5,
141 DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525 = 0xB6,
143 DATA_UNIT_VPS = 0xC3,
144 DATA_UNIT_WSS = 0xC4,
145 DATA_UNIT_CLOSED_CAPTION = 0xC5,
146 DATA_UNIT_MONOCHROME_SAMPLES = 0xC6,
148 DATA_UNIT_STUFFING = 0xFF,
153 vbi_decoder * p_vbi_dec;
154 vbi_dvb_demux * p_dvb_demux;
155 unsigned int i_last_page;
157 bool b_text; /* Subtitles as text */
159 vlc_mutex_t lock; /* Lock to protect the following variables */
160 /* Positioning of Teletext images */
163 unsigned int i_wanted_page;
171 static subpicture_t *Decode( decoder_t *, block_t ** );
173 static subpicture_t *Subpicture( decoder_t *p_dec, video_format_t *p_fmt,
175 int i_columns, int i_rows,
176 int i_align, mtime_t i_pts );
178 static void EventHandler( vbi_event *ev, void *user_data );
179 static int OpaquePage( picture_t *p_src, const vbi_page p_page,
180 const video_format_t fmt, bool b_opaque );
182 /* Properties callbacks */
183 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
184 vlc_value_t oldval, vlc_value_t newval, void *p_data );
185 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
186 vlc_value_t oldval, vlc_value_t newval, void *p_data );
187 static int Position( vlc_object_t *p_this, char const *psz_cmd,
188 vlc_value_t oldval, vlc_value_t newval, void *p_data );
190 /*****************************************************************************
191 * Open: probe the decoder and return score
192 *****************************************************************************
193 * Tries to launch a decoder and return score so that the interface is able
195 *****************************************************************************/
196 static int Open( vlc_object_t *p_this )
198 decoder_t *p_dec = (decoder_t *) p_this;
199 decoder_sys_t *p_sys = NULL;
201 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
204 p_dec->pf_decode_sub = Decode;
205 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
208 memset( p_sys, 0, sizeof(decoder_sys_t) );
210 p_sys->b_update = false;
211 p_sys->p_vbi_dec = vbi_decoder_new();
212 p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
213 vlc_mutex_init( &p_sys->lock );
215 if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
217 msg_Err( p_dec, "VBI decoder/demux could not be created." );
222 /* Some broadcasters in countries with level 1 and level 1.5 still not send a G0 to do
223 * matches against table 32 of ETSI 300 706. We try to do some best effort guessing
224 * This is not perfect, but might handle some cases where we know the vbi language
225 * is known. It would be better if people started sending G0 */
226 for( int i = 0; ppsz_default_triplet[i] != NULL; i++ )
228 if( p_dec->fmt_in.psz_language && !strcasecmp( p_dec->fmt_in.psz_language, ppsz_default_triplet[i] ) )
230 vbi_teletext_set_default_region( p_sys->p_vbi_dec, pi_default_triplet[i]);
231 msg_Dbg( p_dec, "overwriting default zvbi region: %d", pi_default_triplet[i] );
235 vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE | VBI_EVENT_NETWORK |
237 VBI_EVENT_CAPTION | VBI_EVENT_TRIGGER |
238 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO | VBI_EVENT_NETWORK_ID |
240 0 , EventHandler, p_dec );
242 /* Create the var on vlc_global. */
243 p_sys->i_wanted_page = var_CreateGetInteger( p_dec, "vbi-page" );
244 var_AddCallback( p_dec, "vbi-page",
245 RequestPage, p_sys );
247 /* Check if the Teletext track has a known "initial page". */
248 if( p_sys->i_wanted_page == 100 && p_dec->fmt_in.subs.dvb.i_id != -1 )
250 int i_wanted_magazine = p_dec->fmt_in.subs.dvb.i_id >> 16;
251 if( i_wanted_magazine == 0 )
252 i_wanted_magazine = 8;
253 p_sys->i_wanted_page = vbi_bcd2dec(p_dec->fmt_in.subs.dvb.i_id & 0xff);
254 p_sys->i_wanted_page += 100*i_wanted_magazine;
257 p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
258 var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
260 p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
261 var_AddCallback( p_dec, "vbi-position", Position, p_sys );
263 p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
264 // var_AddCallback( p_dec, "vbi-text", Text, p_sys );
266 es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
268 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('T','E','X','T');
270 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('R','G','B','A');
274 /*****************************************************************************
276 *****************************************************************************/
277 static void Close( vlc_object_t *p_this )
279 decoder_t *p_dec = (decoder_t*) p_this;
280 decoder_sys_t *p_sys = p_dec->p_sys;
282 var_DelCallback( p_dec, "vbi-position", Position, p_sys );
283 var_DelCallback( p_dec, "vbi-opaque", Opaque, p_sys );
284 var_DelCallback( p_dec, "vbi-page", RequestPage, p_sys );
286 vlc_mutex_destroy( &p_sys->lock );
288 if( p_sys->p_vbi_dec )
289 vbi_decoder_delete( p_sys->p_vbi_dec );
290 if( p_sys->p_dvb_demux )
291 vbi_dvb_demux_delete( p_sys->p_dvb_demux );
295 #define MAX_SLICES 32
297 #ifdef WORDS_BIGENDIAN
298 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
300 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
304 /*****************************************************************************
306 *****************************************************************************/
307 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
309 decoder_sys_t *p_sys = p_dec->p_sys;
311 subpicture_t *p_spu = NULL;
313 bool b_cached = false;
315 const uint8_t *p_pos;
318 if( (pp_block == NULL) || (*pp_block == NULL) )
324 p_pos = p_block->p_buffer;
325 i_left = p_block->i_buffer;
329 vbi_sliced p_sliced[MAX_SLICES];
330 unsigned int i_lines = 0;
333 i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
334 MAX_SLICES, &i_pts, &p_pos, &i_left );
337 vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
341 vlc_mutex_lock( &p_sys->lock );
342 const int i_align = p_sys->i_align;
343 const unsigned int i_wanted_page = p_sys->i_wanted_page;
344 const bool b_opaque = p_sys->b_opaque;
345 vlc_mutex_unlock( &p_sys->lock );
348 /* Try to see if the page we want is in the cache yet */
349 b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
350 vbi_dec2bcd( i_wanted_page ),
351 VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
354 if( i_wanted_page == p_sys->i_last_page && !p_sys->b_update )
359 if( p_sys->i_last_page != i_wanted_page )
361 /* We need to reset the subtitle */
362 p_spu = Subpicture( p_dec, &fmt, true,
363 p_page.columns, p_page.rows,
364 i_align, p_block->i_pts );
367 p_spu->p_region->psz_text = strdup("");
369 p_sys->b_update = true;
370 p_sys->i_last_page = i_wanted_page;
376 p_sys->b_update = false;
377 p_sys->i_last_page = i_wanted_page;
379 msg_Dbg( p_dec, "we now have page: %d ready for display",
382 /* If there is a page or sub to render, then we do that here */
383 /* Create the subpicture unit */
384 p_spu = Subpicture( p_dec, &fmt, p_sys->b_text,
385 p_page.columns, p_page.rows,
386 i_align, p_block->i_pts );
392 unsigned int i_textsize = 7000;
394 char p_text[i_textsize+1];
396 i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
397 "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
398 p_text[i_total] = '\0';
399 /* Strip off the pagenumber */
402 p_spu->p_region->psz_text = strdup( &p_text[8] );
405 msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
410 picture_t *p_pic = &p_spu->p_region->picture;
412 /* ZVBI is stupid enough to assume pitch == width */
413 p_pic->p->i_pitch = 4 * fmt.i_width;
414 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
415 p_spu->p_region->picture.p->p_pixels, 1, 1 );
417 vlc_mutex_lock( &p_sys->lock );
418 memcpy( p_sys->nav_link, &p_page.nav_link, sizeof( p_sys->nav_link )) ;
419 vlc_mutex_unlock( &p_sys->lock );
421 OpaquePage( p_pic, p_page, fmt, b_opaque );
425 vbi_unref_page( &p_page );
426 block_Release( p_block );
430 vbi_unref_page( &p_page );
433 p_dec->pf_spu_buffer_del( p_dec, p_spu );
437 block_Release( p_block );
441 static subpicture_t *Subpicture( decoder_t *p_dec, video_format_t *p_fmt,
443 int i_columns, int i_rows, int i_align,
449 /* If there is a page or sub to render, then we do that here */
450 /* Create the subpicture unit */
451 p_spu = p_dec->pf_spu_buffer_new( p_dec );
454 msg_Warn( p_dec, "can't get spu buffer" );
458 memset( &fmt, 0, sizeof(video_format_t) );
459 fmt.i_chroma = b_text ? VLC_FOURCC('T','E','X','T') :
460 VLC_FOURCC('R','G','B','A');
461 fmt.i_aspect = b_text ? 0 : VOUT_ASPECT_FACTOR;
464 fmt.i_bits_per_pixel = 0;
468 fmt.i_sar_num = fmt.i_sar_den = 1;
469 fmt.i_width = fmt.i_visible_width = i_columns * 12;
470 fmt.i_height = fmt.i_visible_height = i_rows * 10;
471 fmt.i_bits_per_pixel = 32;
473 fmt.i_x_offset = fmt.i_y_offset = 0;
475 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
476 if( p_spu->p_region == NULL )
478 msg_Err( p_dec, "cannot allocate SPU region" );
479 p_dec->pf_spu_buffer_del( p_dec, p_spu );
483 p_spu->p_region->i_x = 0;
484 p_spu->p_region->i_y = 0;
485 p_spu->p_region->i_align = i_align;
487 /* Normal text subs, easy markup */
488 p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM;
490 p_spu->i_start = i_pts;
492 p_spu->b_ephemer = true;
493 p_spu->b_absolute = false;
494 p_spu->b_pausable = true;
500 p_spu->i_original_picture_width = fmt.i_width;
502 p_spu->i_original_picture_height = fmt.i_height;
510 static void EventHandler( vbi_event *ev, void *user_data )
512 decoder_t *p_dec = (decoder_t *)user_data;
513 decoder_sys_t *p_sys = p_dec->p_sys;
515 if( ev->type == VBI_EVENT_TTX_PAGE )
518 msg_Info( p_dec, "Page %03x.%02x ",
519 ev->ev.ttx_page.pgno,
520 ev->ev.ttx_page.subno & 0xFF);
522 if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
523 p_sys->b_update = true;
525 if( ev->ev.ttx_page.clock_update )
526 msg_Dbg( p_dec, "clock" );
527 if( ev->ev.ttx_page.header_update )
528 msg_Dbg( p_dec, "header" );
531 else if( ev->type == VBI_EVENT_CLOSE )
532 msg_Dbg( p_dec, "Close event" );
533 else if( ev->type == VBI_EVENT_CAPTION )
534 msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
535 else if( ev->type == VBI_EVENT_NETWORK )
537 msg_Dbg( p_dec, "Network change");
538 vbi_network n = ev->ev.network;
539 msg_Dbg( p_dec, "Network id:%d name: %s, call: %s ", n.nuid, n.name, n.call );
541 else if( ev->type == VBI_EVENT_TRIGGER )
542 msg_Dbg( p_dec, "Trigger event" );
543 else if( ev->type == VBI_EVENT_ASPECT )
544 msg_Dbg( p_dec, "Aspect update" );
545 else if( ev->type == VBI_EVENT_PROG_INFO )
546 msg_Dbg( p_dec, "Program info received" );
547 else if( ev->type == VBI_EVENT_NETWORK_ID )
548 msg_Dbg( p_dec, "Network ID changed" );
551 static int OpaquePage( picture_t *p_src, const vbi_page p_page,
552 const video_format_t fmt, bool b_opaque )
556 assert( fmt.i_chroma == VLC_FOURCC('R','G','B','A' ) );
558 /* Kludge since zvbi doesn't provide an option to specify opacity. */
559 for( y = 0; y < fmt.i_height; y++ )
561 for( x = 0; x < fmt.i_width; x++ )
563 const vbi_opacity opacity = p_page.text[ y/10 * p_page.columns + x/12 ].opacity;
564 uint32_t *p_pixel = (uint32_t*)&p_src->p->p_pixels[y * p_src->p->i_pitch + 4*x];
567 /* Show video instead of this character */
568 case VBI_TRANSPARENT_SPACE:
571 /* To make the boxed text "closed captioning" transparent
572 * change true to false.
577 /* Full text transparency. only foreground color is show */
578 case VBI_TRANSPARENT_FULL:
581 /* Transparency for boxed text */
582 case VBI_SEMI_TRANSPARENT:
583 if( (*p_pixel) == 0xff000000 && 0 ) /* Disabled until someone implement borders */
594 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
595 vlc_value_t oldval, vlc_value_t newval, void *p_data )
597 decoder_sys_t *p_sys = p_data;
598 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
600 vlc_mutex_lock( &p_sys->lock );
601 switch( newval.i_int )
604 p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[0].pgno );
607 p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[1].pgno );
609 case ZVBI_KEY_YELLOW:
610 p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[2].pgno );
613 p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[3].pgno );
616 p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[5].pgno ); /* #4 is SKIPPED */
619 if( newval.i_int > 0 && newval.i_int < 999 )
620 p_sys->i_wanted_page = newval.i_int;
621 vlc_mutex_unlock( &p_sys->lock );
626 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
627 vlc_value_t oldval, vlc_value_t newval, void *p_data )
629 decoder_sys_t *p_sys = p_data;
630 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
632 vlc_mutex_lock( &p_sys->lock );
633 p_sys->b_opaque = newval.b_bool;
634 vlc_mutex_unlock( &p_sys->lock );
639 static int Position( vlc_object_t *p_this, char const *psz_cmd,
640 vlc_value_t oldval, vlc_value_t newval, void *p_data )
642 decoder_sys_t *p_sys = p_data;
643 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
645 vlc_mutex_lock( &p_sys->lock );
646 p_sys->i_align = newval.i_int;
647 vlc_mutex_unlock( &p_sys->lock );