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> for M2X
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
23 /*****************************************************************************
25 * information on teletext format can be found here :
26 * http://pdc.ro.nu/teletext.html
28 *****************************************************************************/
30 /* This module implements:
31 * ETSI EN 301 775: VBI data in PES
32 * ETSI EN 300 472: EBU Teletext data in PES
33 * ETSI EN 300 706: Enhanced Teletext (libzvbi)
34 * ETSI EN 300 231: Video Programme System [VPS] (libzvbi)
35 * ETSI EN 300 294: 625-line Wide Screen Signaling [WSS] (libzvbi)
36 * EIA-608 Revision A: Closed Captioning [CC] (libzvbi)
46 #include "vlc_codec.h"
49 DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE = 0x02,
50 DATA_UNIT_EBU_TELETEXT_SUBTITLE = 0x03,
51 DATA_UNIT_EBU_TELETEXT_INVERTED = 0x0C,
53 DATA_UNIT_ZVBI_WSS_CPR1204 = 0xB4,
54 DATA_UNIT_ZVBI_CLOSED_CAPTION_525 = 0xB5,
55 DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525 = 0xB6,
59 DATA_UNIT_CLOSED_CAPTION = 0xC5,
60 DATA_UNIT_MONOCHROME_SAMPLES = 0xC6,
62 DATA_UNIT_STUFFING = 0xFF,
65 /*****************************************************************************
67 *****************************************************************************/
68 static int Open ( vlc_object_t * );
69 static void Close( vlc_object_t * );
70 static subpicture_t *Decode( decoder_t *, block_t ** );
72 #define PAGE_TEXT N_("Teletext page")
73 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
74 "Default page is index 100")
76 #define OPAQUE_TEXT N_("Text is always opaque")
77 #define OPAQUE_LONGTEXT N_("Setting vbi-opaque to false " \
78 "makes the boxed text transparent." )
81 set_description( _("VBI and Teletext decoder") );
82 set_shortname( "VBI & Teletext" );
83 set_capability( "decoder", 51 );
84 set_category( CAT_INPUT );
85 set_subcategory( SUBCAT_INPUT_SCODEC );
86 set_callbacks( Open, Close );
88 add_integer( "vbi-page", 100, NULL,
89 PAGE_TEXT, PAGE_LONGTEXT, VLC_FALSE );
90 add_bool( "vbi-opaque", VLC_TRUE, NULL,
91 OPAQUE_TEXT, OPAQUE_LONGTEXT, VLC_FALSE );
94 /****************************************************************************
96 ****************************************************************************/
100 vbi_decoder * p_vbi_dec;
101 vbi_dvb_demux * p_dvb_demux;
102 unsigned int i_wanted_page;
103 unsigned int i_last_page;
108 static void event_handler( vbi_event *ev, void *user_data );
109 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
110 vlc_value_t oldval, vlc_value_t newval, void *p_data );
111 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
112 vlc_value_t oldval, vlc_value_t newval, void *p_data );
114 /*****************************************************************************
115 * Open: probe the decoder and return score
116 *****************************************************************************
117 * Tries to launch a decoder and return score so that the interface is able
119 *****************************************************************************/
120 static int Open( vlc_object_t *p_this )
122 decoder_t *p_dec = (decoder_t *) p_this;
123 decoder_sys_t *p_sys = NULL;
125 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
130 p_dec->pf_decode_sub = Decode;
131 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
134 msg_Err( p_dec, "out of memory" );
138 memset( p_sys, 0, sizeof(decoder_sys_t) );
140 p_sys->p_vbi_dec = vbi_decoder_new();
141 p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
143 if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
145 msg_Err( p_dec, "VBI decoder/demux could not be created." );
150 vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
151 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
152 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
153 event_handler, p_dec );
155 /* Create the var on vlc_global. */
156 p_sys->i_wanted_page = var_CreateGetInteger( p_dec->p_libvlc_global,
158 var_AddCallback( p_dec->p_libvlc_global, "vbi-page",
159 RequestPage, p_sys );
161 p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
162 var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
166 /*****************************************************************************
168 *****************************************************************************/
169 static void Close( vlc_object_t *p_this )
171 decoder_t *p_dec = (decoder_t*) p_this;
172 decoder_sys_t *p_sys = p_dec->p_sys;
174 if( p_sys->p_vbi_dec )
175 vbi_decoder_delete( p_sys->p_vbi_dec );
176 if( p_sys->p_dvb_demux )
177 vbi_dvb_demux_delete( p_sys->p_dvb_demux );
181 #define MAX_SLICES 32
183 /*****************************************************************************
185 *****************************************************************************/
186 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
188 decoder_sys_t *p_sys = p_dec->p_sys;
190 subpicture_t *p_spu = NULL;
192 vlc_bool_t b_cached = VLC_FALSE;
198 uint32_t *p_begin, *p_end;
199 unsigned int x = 0, y = 0;
201 /* end part of kludge */
203 if( (pp_block == NULL) || (*pp_block == NULL) )
208 p_pos = p_block->p_buffer;
209 i_left = p_block->i_buffer;
213 vbi_sliced p_sliced[MAX_SLICES];
214 unsigned int i_lines = 0;
217 i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
218 MAX_SLICES, &i_pts, &p_pos, &i_left );
221 vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
224 /* Try to see if the page we want is in the cache yet */
225 b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
226 vbi_dec2bcd( p_sys->i_wanted_page ),
227 VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
233 if( (p_sys->i_wanted_page == p_sys->i_last_page) &&
234 (p_sys->b_update != VLC_TRUE) )
237 p_sys->i_last_page = p_sys->i_wanted_page;
238 p_sys->b_update = VLC_FALSE;
239 msg_Dbg( p_dec, "we now have page: %d ready for display",
240 p_sys->i_wanted_page );
242 /* If there is a page or sub to render, then we do that here */
243 /* Create the subpicture unit */
244 p_spu = p_dec->pf_spu_buffer_new( p_dec );
247 msg_Warn( p_dec, "can't get spu buffer" );
251 /* Create a new subpicture region */
252 memset( &fmt, 0, sizeof(video_format_t) );
253 fmt.i_chroma = VLC_FOURCC('R','G','B','A');
254 fmt.i_aspect = VOUT_ASPECT_FACTOR;
255 fmt.i_sar_num = fmt.i_sar_den = 1;
256 fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
257 fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
258 fmt.i_bits_per_pixel = 32;
259 fmt.i_x_offset = fmt.i_y_offset = 0;
261 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
262 if( p_spu->p_region == NULL )
264 msg_Err( p_dec, "cannot allocate SPU region" );
268 p_spu->p_region->i_x = 0;
269 p_spu->p_region->i_y = 0;
271 /* Normal text subs, easy markup */
272 p_spu->i_flags = SUBPICTURE_ALIGN_TOP;
274 p_spu->i_start = p_block->i_pts;
276 p_spu->b_ephemer = VLC_TRUE;
277 p_spu->b_absolute = VLC_FALSE;
278 p_spu->b_pausable = VLC_TRUE;
279 p_spu->i_original_picture_width = p_page.columns * 12;
280 p_spu->i_original_picture_height = p_page.rows * 10;
282 vbi_draw_vt_page( &p_page, VBI_PIXFMT_RGBA32_LE,
283 p_spu->p_region->picture.p->p_pixels, 1, 1 );
284 p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
285 p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
287 /* Kludge since zvbi doesn't provide an option to specify opacity. */
288 p_begin = (uint32_t *)p_spu->p_region->picture.p->p_pixels;
289 p_end = (uint32_t *)p_spu->p_region->picture.p->p_pixels+(fmt.i_width * fmt.i_height);
291 for( ; p_begin < p_end; p_begin++ )
293 opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
296 /* Show video instead of this character */
297 case VBI_TRANSPARENT_SPACE:
300 /* To make the boxed text "closed captioning" transparent
301 * change VLC_TRUE to VLC_FALSE.
304 if( p_sys->b_opaque )
306 /* Full text transparency. only foreground color is show */
307 case VBI_TRANSPARENT_FULL:
308 /* Transparency for boxed text */
309 case VBI_SEMI_TRANSPARENT:
310 if( (*p_begin & 0xffffff00) == 0xff )
317 if( x >= fmt.i_width )
326 unsigned int i_total, i_textsize = 7000;
329 i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
330 "ISO-8859-1", 0, 0, 0, 0, p_page.columns,
332 p_text[i_total] = '\0';
334 msg_Dbg( p_dec, "page %x-%x\n%s", p_page.pgno, p_page.subno, p_text );
337 vbi_unref_page( &p_page );
338 block_Release( p_block );
342 vbi_unref_page( &p_page );
345 p_dec->pf_spu_buffer_del( p_dec, p_spu );
349 block_Release( p_block );
353 static void event_handler( vbi_event *ev, void *user_data)
355 decoder_t *p_dec = (decoder_t *)user_data;
356 decoder_sys_t *p_sys = p_dec->p_sys;
358 if( ev->type == VBI_EVENT_TTX_PAGE )
360 /* msg_Dbg( p_dec, "Page %03x.%02x ",
361 ev->ev.ttx_page.pgno,
362 ev->ev.ttx_page.subno & 0xFF);
364 if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
365 p_sys->b_update = VLC_TRUE;
367 if( ev->ev.ttx_page.clock_update )
368 msg_Dbg( p_dec, "clock" );
369 if( ev->ev.ttx_page.header_update )
370 msg_Dbg( p_dec, "header" );
372 else if( ev->type == VBI_EVENT_CAPTION )
373 msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
374 else if( ev->type == VBI_EVENT_NETWORK )
375 msg_Dbg( p_dec, "Network change" );
376 else if( ev->type == VBI_EVENT_ASPECT )
377 msg_Dbg( p_dec, "Aspect update" );
378 else if( ev->type == VBI_EVENT_NETWORK )
379 msg_Dbg( p_dec, "Program info received" );
382 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
383 vlc_value_t oldval, vlc_value_t newval, void *p_data )
385 decoder_sys_t *p_sys = p_data;
387 if( (newval.i_int > 0) && (newval.i_int < 999) )
388 p_sys->i_wanted_page = newval.i_int;
393 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
394 vlc_value_t oldval, vlc_value_t newval, void *p_data )
396 decoder_sys_t *p_sys = p_data;
399 p_sys->b_opaque = newval.b_bool;