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"
47 #include "vlc_image.h"
50 DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE = 0x02,
51 DATA_UNIT_EBU_TELETEXT_SUBTITLE = 0x03,
52 DATA_UNIT_EBU_TELETEXT_INVERTED = 0x0C,
54 DATA_UNIT_ZVBI_WSS_CPR1204 = 0xB4,
55 DATA_UNIT_ZVBI_CLOSED_CAPTION_525 = 0xB5,
56 DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525 = 0xB6,
60 DATA_UNIT_CLOSED_CAPTION = 0xC5,
61 DATA_UNIT_MONOCHROME_SAMPLES = 0xC6,
63 DATA_UNIT_STUFFING = 0xFF,
66 /*****************************************************************************
68 *****************************************************************************/
69 static int Open ( vlc_object_t * );
70 static void Close( vlc_object_t * );
71 static subpicture_t *Decode( decoder_t *, block_t ** );
73 #define PAGE_TEXT N_("Teletext page")
74 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
75 "Default page is index 100")
77 #define OPAQUE_TEXT N_("Text is always opaque")
78 #define OPAQUE_LONGTEXT N_("Setting vbi-opaque to false " \
79 "makes the boxed text transparent." )
81 #define POS_TEXT N_("Teletext alignment")
82 #define POS_LONGTEXT N_( \
83 "You can enforce the teletext position on the video " \
84 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
85 "also use combinations of these values, eg. 6 = top-right).")
87 #define TELX_TEXT N_("Teletext text subtitles")
88 #define TELX_LONGTEXT N_( "Output teletext subtitles as text " \
89 "instead of as RGBA" )
91 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
92 static const char *ppsz_pos_descriptions[] =
93 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
94 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
97 set_description( _("VBI and Teletext decoder") );
98 set_shortname( "VBI & Teletext" );
99 set_capability( "decoder", 51 );
100 set_category( CAT_INPUT );
101 set_subcategory( SUBCAT_INPUT_SCODEC );
102 set_callbacks( Open, Close );
104 add_integer( "vbi-page", 100, NULL,
105 PAGE_TEXT, PAGE_LONGTEXT, VLC_FALSE );
106 add_bool( "vbi-opaque", VLC_TRUE, NULL,
107 OPAQUE_TEXT, OPAQUE_LONGTEXT, VLC_FALSE );
108 add_integer( "vbi-position", 4, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
109 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
110 add_bool( "vbi-text", VLC_FALSE, NULL,
111 TELX_TEXT, TELX_LONGTEXT, VLC_FALSE );
114 /****************************************************************************
116 ****************************************************************************/
120 vbi_decoder * p_vbi_dec;
121 vbi_dvb_demux * p_dvb_demux;
122 unsigned int i_wanted_page;
123 unsigned int i_last_page;
127 /* Subtitles as text */
130 /* Positioning of Teletext images */
134 static void event_handler( vbi_event *ev, void *user_data );
135 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
136 vlc_value_t oldval, vlc_value_t newval, void *p_data );
137 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
138 vlc_value_t oldval, vlc_value_t newval, void *p_data );
139 static int Position( vlc_object_t *p_this, char const *psz_cmd,
140 vlc_value_t oldval, vlc_value_t newval, void *p_data );
142 /*****************************************************************************
143 * Open: probe the decoder and return score
144 *****************************************************************************
145 * Tries to launch a decoder and return score so that the interface is able
147 *****************************************************************************/
148 static int Open( vlc_object_t *p_this )
150 decoder_t *p_dec = (decoder_t *) p_this;
151 decoder_sys_t *p_sys = NULL;
153 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
158 p_dec->pf_decode_sub = Decode;
159 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
162 msg_Err( p_dec, "out of memory" );
166 memset( p_sys, 0, sizeof(decoder_sys_t) );
168 p_sys->p_vbi_dec = vbi_decoder_new();
169 p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
171 if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
173 msg_Err( p_dec, "VBI decoder/demux could not be created." );
178 vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
179 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
180 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
181 event_handler, p_dec );
183 /* Create the var on vlc_global. */
184 p_sys->i_wanted_page = var_CreateGetInteger( p_dec->p_libvlc, "vbi-page" );
185 var_AddCallback( p_dec->p_libvlc, "vbi-page",
186 RequestPage, p_sys );
188 p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
189 var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
191 p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
192 var_AddCallback( p_dec, "vbi-position", Position, p_sys );
194 p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
195 // var_AddCallback( p_dec, "vbi-text", Text, p_sys );
200 /*****************************************************************************
202 *****************************************************************************/
203 static void Close( vlc_object_t *p_this )
205 decoder_t *p_dec = (decoder_t*) p_this;
206 decoder_sys_t *p_sys = p_dec->p_sys;
208 if( p_sys->p_vbi_dec ) vbi_decoder_delete( p_sys->p_vbi_dec );
209 if( p_sys->p_dvb_demux ) vbi_dvb_demux_delete( p_sys->p_dvb_demux );
213 #define MAX_SLICES 32
215 /*****************************************************************************
217 *****************************************************************************/
218 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
220 decoder_sys_t *p_sys = p_dec->p_sys;
222 subpicture_t *p_spu = NULL;
224 vlc_bool_t b_cached = VLC_FALSE;
226 const uint8_t *p_pos;
230 uint32_t *p_begin, *p_end;
231 unsigned int x = 0, y = 0;
233 /* end part of kludge */
235 if( (pp_block == NULL) || (*pp_block == NULL) )
240 p_pos = p_block->p_buffer;
241 i_left = p_block->i_buffer;
245 vbi_sliced p_sliced[MAX_SLICES];
246 unsigned int i_lines = 0;
249 i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
250 MAX_SLICES, &i_pts, &p_pos, &i_left );
253 vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
256 /* Try to see if the page we want is in the cache yet */
257 b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
258 vbi_dec2bcd( p_sys->i_wanted_page ),
259 VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
265 if( (p_sys->i_wanted_page == p_sys->i_last_page) &&
266 (p_sys->b_update != VLC_TRUE) )
269 p_sys->i_last_page = p_sys->i_wanted_page;
270 p_sys->b_update = VLC_FALSE;
271 msg_Dbg( p_dec, "we now have page: %d ready for display",
272 p_sys->i_wanted_page );
274 /* If there is a page or sub to render, then we do that here */
275 /* Create the subpicture unit */
276 p_spu = p_dec->pf_spu_buffer_new( p_dec );
279 msg_Warn( p_dec, "can't get spu buffer" );
283 /* Create a new subpicture region */
284 memset( &fmt, 0, sizeof(video_format_t) );
285 fmt.i_chroma = p_sys->b_text ? VLC_FOURCC('T','E','X','T') : VLC_FOURCC('R','G','B','A');
286 fmt.i_aspect = p_sys->b_text ? 0 : VOUT_ASPECT_FACTOR;
287 fmt.i_sar_num = fmt.i_sar_den = 1;
288 fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
289 fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
290 fmt.i_bits_per_pixel = p_sys->b_text ? 0 : 32;
291 fmt.i_x_offset = fmt.i_y_offset = 0;
293 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
294 if( p_spu->p_region == NULL )
296 msg_Err( p_dec, "cannot allocate SPU region" );
300 p_spu->p_region->i_x = 0;
301 p_spu->p_region->i_y = 0;
302 p_spu->p_region->i_align = SUBPICTURE_ALIGN_TOP;
304 /* Normal text subs, easy markup */
305 p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM;
307 p_spu->i_start = p_block->i_pts;
308 p_spu->i_stop = (mtime_t) 0;
309 p_spu->b_ephemer = VLC_TRUE;
310 p_spu->b_absolute = VLC_FALSE;
311 p_spu->b_pausable = VLC_TRUE;
312 p_spu->i_original_picture_width = p_page.columns * 12;
313 p_spu->i_original_picture_height = p_page.rows * 10;
317 unsigned int i_total, i_textsize = 7000;
320 i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
321 "ASCII", 0, 0, 0, 0, p_page.columns,
323 p_text[i_total] = '\0';
324 /* Strip off the pagenumber */
325 if( i_total <= 8 ) goto error;
326 p_spu->p_region->psz_text = strdup( &p_text[8] );
328 msg_Dbg( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
332 vbi_draw_vt_page( &p_page, VBI_PIXFMT_RGBA32_LE,
333 p_spu->p_region->picture.p->p_pixels, 1, 1 );
334 p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
335 p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
338 /* Kludge since zvbi doesn't provide an option to specify opacity. */
339 if( p_sys->b_opaque && !p_sys->b_text )
341 p_begin = (uint32_t *)p_spu->p_region->picture.p->p_pixels;
342 p_end = (uint32_t *)p_spu->p_region->picture.p->p_pixels+(fmt.i_width * fmt.i_height);
344 for( ; p_begin < p_end; p_begin++ )
346 opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
349 /* Show video instead of this character */
350 case VBI_TRANSPARENT_SPACE:
353 /* To make the boxed text "closed captioning" transparent
354 * change VLC_TRUE to VLC_FALSE.
357 if( p_sys->b_opaque )
359 /* Full text transparency. only foreground color is show */
360 case VBI_TRANSPARENT_FULL:
361 /* Transparency for boxed text */
362 case VBI_SEMI_TRANSPARENT:
363 if( (*p_begin & 0xffffff00) == 0xff )
370 if( x >= fmt.i_width )
379 vbi_unref_page( &p_page );
380 block_Release( p_block );
384 vbi_unref_page( &p_page );
387 p_dec->pf_spu_buffer_del( p_dec, p_spu );
391 block_Release( p_block );
395 static void event_handler( vbi_event *ev, void *user_data )
397 decoder_t *p_dec = (decoder_t *)user_data;
398 decoder_sys_t *p_sys = p_dec->p_sys;
400 if( ev->type == VBI_EVENT_TTX_PAGE )
402 /* msg_Dbg( p_dec, "Page %03x.%02x ",
403 ev->ev.ttx_page.pgno,
404 ev->ev.ttx_page.subno & 0xFF);
406 if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
407 p_sys->b_update = VLC_TRUE;
409 if( ev->ev.ttx_page.clock_update )
410 msg_Dbg( p_dec, "clock" );
411 if( ev->ev.ttx_page.header_update )
412 msg_Dbg( p_dec, "header" );
414 else if( ev->type == VBI_EVENT_CAPTION )
415 msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
416 else if( ev->type == VBI_EVENT_NETWORK )
417 msg_Dbg( p_dec, "Network change" );
418 else if( ev->type == VBI_EVENT_ASPECT )
419 msg_Dbg( p_dec, "Aspect update" );
420 else if( ev->type == VBI_EVENT_NETWORK )
421 msg_Dbg( p_dec, "Program info received" );
424 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
425 vlc_value_t oldval, vlc_value_t newval, void *p_data )
427 decoder_sys_t *p_sys = p_data;
429 if( (newval.i_int > 0) && (newval.i_int < 999) )
430 p_sys->i_wanted_page = newval.i_int;
435 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
436 vlc_value_t oldval, vlc_value_t newval, void *p_data )
438 decoder_sys_t *p_sys = p_data;
441 p_sys->b_opaque = newval.b_bool;
445 static int Position( vlc_object_t *p_this, char const *psz_cmd,
446 vlc_value_t oldval, vlc_value_t newval, void *p_data )
448 decoder_sys_t *p_sys = p_data;
451 p_sys->i_align = newval.i_int;