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, 0 );
95 add_bool( "vbi-text", false, NULL,
96 TELX_TEXT, TELX_LONGTEXT, false );
99 /****************************************************************************
101 ****************************************************************************/
103 // #define ZVBI_DEBUG
106 DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE = 0x02,
107 DATA_UNIT_EBU_TELETEXT_SUBTITLE = 0x03,
108 DATA_UNIT_EBU_TELETEXT_INVERTED = 0x0C,
110 DATA_UNIT_ZVBI_WSS_CPR1204 = 0xB4,
111 DATA_UNIT_ZVBI_CLOSED_CAPTION_525 = 0xB5,
112 DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525 = 0xB6,
114 DATA_UNIT_VPS = 0xC3,
115 DATA_UNIT_WSS = 0xC4,
116 DATA_UNIT_CLOSED_CAPTION = 0xC5,
117 DATA_UNIT_MONOCHROME_SAMPLES = 0xC6,
119 DATA_UNIT_STUFFING = 0xFF,
124 vbi_decoder * p_vbi_dec;
125 vbi_dvb_demux * p_dvb_demux;
126 unsigned int i_last_page;
128 bool b_text; /* Subtitles as text */
130 vlc_mutex_t lock; /* Lock to protect the following variables */
131 /* Positioning of Teletext images */
134 unsigned int i_wanted_page;
139 static subpicture_t *Decode( decoder_t *, block_t ** );
141 static void EventHandler( vbi_event *ev, void *user_data );
142 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
143 vlc_value_t oldval, vlc_value_t newval, void *p_data );
144 static int OpaquePage( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
145 picture_t *p_src, bool b_opaque );
147 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
148 vlc_value_t oldval, vlc_value_t newval, void *p_data );
149 static int Position( vlc_object_t *p_this, char const *psz_cmd,
150 vlc_value_t oldval, vlc_value_t newval, void *p_data );
152 /*****************************************************************************
153 * Open: probe the decoder and return score
154 *****************************************************************************
155 * Tries to launch a decoder and return score so that the interface is able
157 *****************************************************************************/
158 static int Open( vlc_object_t *p_this )
160 decoder_t *p_dec = (decoder_t *) p_this;
161 decoder_sys_t *p_sys = NULL;
163 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
166 p_dec->pf_decode_sub = Decode;
167 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
170 memset( p_sys, 0, sizeof(decoder_sys_t) );
172 p_sys->b_update = false;
173 p_sys->p_vbi_dec = vbi_decoder_new();
174 p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
175 vlc_mutex_init( &p_sys->lock );
177 if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
179 msg_Err( p_dec, "VBI decoder/demux could not be created." );
184 vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
185 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
186 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
187 EventHandler, p_dec );
189 /* Create the var on vlc_global. */
190 p_sys->i_wanted_page = var_CreateGetInteger( p_dec, "vbi-page" );
191 var_AddCallback( p_dec, "vbi-page",
192 RequestPage, p_sys );
194 p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
195 var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
197 p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
198 var_AddCallback( p_dec, "vbi-position", Position, p_sys );
200 p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
201 // var_AddCallback( p_dec, "vbi-text", Text, p_sys );
203 es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
205 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('T','E','X','T');
207 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('R','G','B','A');
211 /*****************************************************************************
213 *****************************************************************************/
214 static void Close( vlc_object_t *p_this )
216 decoder_t *p_dec = (decoder_t*) p_this;
217 decoder_sys_t *p_sys = p_dec->p_sys;
219 var_DelCallback( p_dec, "vbi-position", Position, p_sys );
220 var_DelCallback( p_dec, "vbi-opaque", Opaque, p_sys );
221 var_DelCallback( p_dec, "vbi-page", RequestPage, p_sys );
223 vlc_mutex_destroy( &p_sys->lock );
225 if( p_sys->p_vbi_dec )
226 vbi_decoder_delete( p_sys->p_vbi_dec );
227 if( p_sys->p_dvb_demux )
228 vbi_dvb_demux_delete( p_sys->p_dvb_demux );
232 #define MAX_SLICES 32
234 #ifdef WORDS_BIGENDIAN
235 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
237 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
241 /*****************************************************************************
243 *****************************************************************************/
244 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
246 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
248 subpicture_t *p_spu = NULL;
250 bool b_cached = false;
252 const uint8_t *p_pos;
255 if( (pp_block == NULL) || (*pp_block == NULL) )
261 p_pos = p_block->p_buffer;
262 i_left = p_block->i_buffer;
266 vbi_sliced p_sliced[MAX_SLICES];
267 unsigned int i_lines = 0;
270 i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
271 MAX_SLICES, &i_pts, &p_pos, &i_left );
274 vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
278 vlc_mutex_lock( &p_sys->lock );
279 const int i_align = p_sys->i_align;
280 const unsigned int i_wanted_page = p_sys->i_wanted_page;
281 const bool b_opaque = p_sys->b_opaque;
282 vlc_mutex_unlock( &p_sys->lock );
285 /* Try to see if the page we want is in the cache yet */
286 b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
287 vbi_dec2bcd( i_wanted_page ),
288 VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
294 if( ( i_wanted_page == p_sys->i_last_page ) &&
295 ( p_sys->b_update != true ) )
298 p_sys->b_update = false;
299 p_sys->i_last_page = i_wanted_page;
301 msg_Dbg( p_dec, "we now have page: %d ready for display",
304 /* If there is a page or sub to render, then we do that here */
305 /* Create the subpicture unit */
306 p_spu = p_dec->pf_spu_buffer_new( p_dec );
309 msg_Warn( p_dec, "can't get spu buffer" );
313 /* Create a new subpicture region */
314 memset( &fmt, 0, sizeof(video_format_t) );
315 fmt.i_chroma = p_sys->b_text ? VLC_FOURCC('T','E','X','T') :
316 VLC_FOURCC('R','G','B','A');
317 fmt.i_aspect = p_sys->b_text ? 0 : VOUT_ASPECT_FACTOR;
320 fmt.i_bits_per_pixel = 0;
324 fmt.i_sar_num = fmt.i_sar_den = 1;
325 fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
326 fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
327 fmt.i_bits_per_pixel = 32;
329 fmt.i_x_offset = fmt.i_y_offset = 0;
331 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
332 if( p_spu->p_region == NULL )
334 msg_Err( p_dec, "cannot allocate SPU region" );
338 p_spu->p_region->i_x = 0;
339 p_spu->p_region->i_y = 0;
340 p_spu->p_region->i_align = i_align;
342 /* Normal text subs, easy markup */
343 p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM;
345 p_spu->i_start = (mtime_t) p_block->i_pts;
346 p_spu->i_stop = (mtime_t) 0;
347 p_spu->b_ephemer = true;
348 p_spu->b_absolute = false;
349 p_spu->b_pausable = true;
353 unsigned int i_textsize = 7000;
357 i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
358 "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
359 p_text[i_total] = '\0';
360 /* Strip off the pagenumber */
363 p_spu->p_region->psz_text = strdup( &p_text[8] );
366 msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
371 picture_t *p_pic = &p_spu->p_region->picture;
373 /* ZVBI is stupid enough to assume pitch == width */
374 p_pic->p->i_pitch = 4 * fmt.i_width;
375 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
376 p_spu->p_region->picture.p->p_pixels, 1, 1 );
378 OpaquePage( p_dec, p_page, fmt, &p_spu->p_region->picture, b_opaque );
382 p_spu->i_original_picture_width = fmt.i_width;
384 p_spu->i_original_picture_height = fmt.i_height;
387 vbi_unref_page( &p_page );
388 block_Release( p_block );
392 vbi_unref_page( &p_page );
395 p_dec->pf_spu_buffer_del( p_dec, p_spu );
399 block_Release( p_block );
403 static void EventHandler( vbi_event *ev, void *user_data )
405 decoder_t *p_dec = (decoder_t *)user_data;
406 decoder_sys_t *p_sys = p_dec->p_sys;
408 if( ev->type == VBI_EVENT_TTX_PAGE )
411 msg_Info( p_dec, "Page %03x.%02x ",
412 ev->ev.ttx_page.pgno,
413 ev->ev.ttx_page.subno & 0xFF);
415 if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
416 p_sys->b_update = true;
418 if( ev->ev.ttx_page.clock_update )
419 msg_Dbg( p_dec, "clock" );
421 if( ev->ev.ttx_page.header_update )
422 msg_Dbg( p_dec, "header" );
425 else if( ev->type == VBI_EVENT_CAPTION )
426 msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
427 else if( ev->type == VBI_EVENT_NETWORK )
428 msg_Dbg( p_dec, "Network change" );
429 else if( ev->type == VBI_EVENT_ASPECT )
430 msg_Dbg( p_dec, "Aspect update" );
431 else if( ev->type == VBI_EVENT_NETWORK )
432 msg_Dbg( p_dec, "Program info received" );
435 static int OpaquePage( decoder_t *p_dec, vbi_page p_page,
436 video_format_t fmt, picture_t *p_src, bool b_opaque )
438 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
441 assert( fmt.i_chroma == VLC_FOURCC('R','G','B','A' ) );
443 /* Kludge since zvbi doesn't provide an option to specify opacity. */
444 for( y = 0; y < fmt.i_height; y++ )
446 for( x = 0; x < fmt.i_width; x++ )
448 const vbi_opacity opacity = p_page.text[ y/10 * p_page.columns + x/12 ].opacity;
449 uint32_t *p_pixel = (uint32_t*)&p_src->p->p_pixels[y * p_src->p->i_pitch + 4*x];
452 /* Show video instead of this character */
453 case VBI_TRANSPARENT_SPACE:
456 /* To make the boxed text "closed captioning" transparent
457 * change true to false.
462 /* Full text transparency. only foreground color is show */
463 case VBI_TRANSPARENT_FULL:
466 /* Transparency for boxed text */
467 case VBI_SEMI_TRANSPARENT:
468 if( (*p_pixel & 0xffffff00) == 0xff ) /* FIXME cannot be true ? */
479 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
480 vlc_value_t oldval, vlc_value_t newval, void *p_data )
482 decoder_sys_t *p_sys = p_data;
483 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
485 vlc_mutex_lock( &p_sys->lock );
486 if( newval.i_int > 0 && newval.i_int < 999 )
487 p_sys->i_wanted_page = newval.i_int;
488 vlc_mutex_unlock( &p_sys->lock );
493 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
494 vlc_value_t oldval, vlc_value_t newval, void *p_data )
496 decoder_sys_t *p_sys = p_data;
497 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
499 vlc_mutex_lock( &p_sys->lock );
500 p_sys->b_opaque = newval.b_bool;
501 vlc_mutex_unlock( &p_sys->lock );
506 static int Position( vlc_object_t *p_this, char const *psz_cmd,
507 vlc_value_t oldval, vlc_value_t newval, void *p_data )
509 decoder_sys_t *p_sys = p_data;
510 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
512 vlc_mutex_lock( &p_sys->lock );
513 p_sys->i_align = newval.i_int;
514 vlc_mutex_unlock( &p_sys->lock );