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)
47 #include "vlc_codec.h"
48 #include "vlc_image.h"
51 DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE = 0x02,
52 DATA_UNIT_EBU_TELETEXT_SUBTITLE = 0x03,
53 DATA_UNIT_EBU_TELETEXT_INVERTED = 0x0C,
55 DATA_UNIT_ZVBI_WSS_CPR1204 = 0xB4,
56 DATA_UNIT_ZVBI_CLOSED_CAPTION_525 = 0xB5,
57 DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525 = 0xB6,
61 DATA_UNIT_CLOSED_CAPTION = 0xC5,
62 DATA_UNIT_MONOCHROME_SAMPLES = 0xC6,
64 DATA_UNIT_STUFFING = 0xFF,
67 /*****************************************************************************
69 *****************************************************************************/
70 static int Open ( vlc_object_t * );
71 static void Close( vlc_object_t * );
72 static subpicture_t *Decode( decoder_t *, block_t ** );
74 #define PAGE_TEXT N_("Teletext page")
75 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
76 "Default page is index 100")
78 #define OPAQUE_TEXT N_("Text is always opaque")
79 #define OPAQUE_LONGTEXT N_("Setting vbi-opaque to false " \
80 "makes the boxed text transparent." )
82 #define POS_TEXT N_("Teletext alignment")
83 #define POS_LONGTEXT N_( \
84 "You can enforce the teletext position on the video " \
85 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
86 "also use combinations of these values, eg. 6 = top-right).")
88 #define TELX_TEXT N_("Teletext text subtitles")
89 #define TELX_LONGTEXT N_( "Output teletext subtitles as text " \
90 "instead of as RGBA" )
92 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
93 static const char *ppsz_pos_descriptions[] =
94 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
95 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
98 set_description( _("VBI and Teletext decoder") );
99 set_shortname( "VBI & Teletext" );
100 set_capability( "decoder", 51 );
101 set_category( CAT_INPUT );
102 set_subcategory( SUBCAT_INPUT_SCODEC );
103 set_callbacks( Open, Close );
105 add_integer( "vbi-page", 100, NULL,
106 PAGE_TEXT, PAGE_LONGTEXT, VLC_FALSE );
107 add_bool( "vbi-opaque", VLC_TRUE, NULL,
108 OPAQUE_TEXT, OPAQUE_LONGTEXT, VLC_FALSE );
109 add_integer( "vbi-position", 4, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
110 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
111 add_bool( "vbi-text", VLC_FALSE, NULL,
112 TELX_TEXT, TELX_LONGTEXT, VLC_FALSE );
115 /****************************************************************************
117 ****************************************************************************/
121 vbi_decoder * p_vbi_dec;
122 vbi_dvb_demux * p_dvb_demux;
123 unsigned int i_wanted_page;
124 unsigned int i_last_page;
128 /* Subtitles as text */
131 /* Positioning of Teletext images */
135 #ifdef HAVE_FFMPEG_SWSCALE_H
136 image_handler_t *p_image;
140 static void event_handler( vbi_event *ev, void *user_data );
141 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
142 vlc_value_t oldval, vlc_value_t newval, void *p_data );
143 static int OpaquePage( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
146 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
147 vlc_value_t oldval, vlc_value_t newval, void *p_data );
148 static int Position( vlc_object_t *p_this, char const *psz_cmd,
149 vlc_value_t oldval, vlc_value_t newval, void *p_data );
151 /*****************************************************************************
152 * Open: probe the decoder and return score
153 *****************************************************************************
154 * Tries to launch a decoder and return score so that the interface is able
156 *****************************************************************************/
157 static int Open( vlc_object_t *p_this )
159 decoder_t *p_dec = (decoder_t *) p_this;
160 decoder_sys_t *p_sys = NULL;
162 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
167 p_dec->pf_decode_sub = Decode;
168 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
171 msg_Err( p_dec, "out of memory" );
174 memset( p_sys, 0, sizeof(decoder_sys_t) );
176 #ifdef HAVE_FFMPEG_SWSCALE_H
177 p_sys->p_image = image_HandlerCreate( VLC_OBJECT(p_dec) );
178 if( !p_sys->p_image )
181 msg_Err( p_dec, "out of memory" );
186 p_sys->p_vbi_dec = vbi_decoder_new();
187 p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
189 if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
191 msg_Err( p_dec, "VBI decoder/demux could not be created." );
196 vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
197 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
198 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
199 event_handler, p_dec );
201 /* Create the var on vlc_global. */
202 p_sys->i_wanted_page = var_CreateGetInteger( p_dec->p_libvlc, "vbi-page" );
203 var_AddCallback( p_dec->p_libvlc, "vbi-page",
204 RequestPage, p_sys );
206 p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
207 var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
209 p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
210 var_AddCallback( p_dec, "vbi-position", Position, p_sys );
212 p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
213 // var_AddCallback( p_dec, "vbi-text", Text, p_sys );
215 es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
217 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('T','E','X','T');
219 #ifdef HAVE_FFMPEG_SWSCALE_H
220 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('Y','U','V','A');
222 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('R','G','B','A');
227 /*****************************************************************************
229 *****************************************************************************/
230 static void Close( vlc_object_t *p_this )
232 decoder_t *p_dec = (decoder_t*) p_this;
233 decoder_sys_t *p_sys = p_dec->p_sys;
235 #ifdef HAVE_FFMPEG_SWSCALE_H
236 if( p_sys->p_image ) image_HandlerDelete( p_sys->p_image );
238 if( p_sys->p_vbi_dec ) vbi_decoder_delete( p_sys->p_vbi_dec );
239 if( p_sys->p_dvb_demux ) vbi_dvb_demux_delete( p_sys->p_dvb_demux );
243 #define MAX_SLICES 32
245 /*****************************************************************************
247 *****************************************************************************/
248 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
250 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
252 subpicture_t *p_spu = NULL;
254 vlc_bool_t b_cached = VLC_FALSE;
256 const uint8_t *p_pos;
259 if( (pp_block == NULL) || (*pp_block == NULL) )
264 p_pos = p_block->p_buffer;
265 i_left = p_block->i_buffer;
269 vbi_sliced p_sliced[MAX_SLICES];
270 unsigned int i_lines = 0;
273 i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
274 MAX_SLICES, &i_pts, &p_pos, &i_left );
277 vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
280 /* Try to see if the page we want is in the cache yet */
281 b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
282 vbi_dec2bcd( p_sys->i_wanted_page ),
283 VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
289 if( ( p_sys->i_wanted_page == p_sys->i_last_page ) &&
290 ( p_sys->b_update != VLC_TRUE ) )
293 p_sys->i_last_page = p_sys->i_wanted_page;
294 p_sys->b_update = VLC_FALSE;
296 msg_Dbg( p_dec, "we now have page: %d ready for display",
297 p_sys->i_wanted_page );
299 /* If there is a page or sub to render, then we do that here */
300 /* Create the subpicture unit */
301 p_spu = p_dec->pf_spu_buffer_new( p_dec );
304 msg_Warn( p_dec, "can't get spu buffer" );
308 /* Create a new subpicture region */
309 memset( &fmt, 0, sizeof(video_format_t) );
310 fmt.i_chroma = p_sys->b_text ? VLC_FOURCC('T','E','X','T') :
311 #ifdef HAVE_FFMPEG_SWSCALE_H
312 VLC_FOURCC('Y','U','V','A');
314 VLC_FOURCC('R','G','B','A');
316 fmt.i_aspect = p_sys->b_text ? 0 : VOUT_ASPECT_FACTOR;
317 fmt.i_sar_num = fmt.i_sar_den = 1;
318 fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
319 fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
320 fmt.i_bits_per_pixel = p_sys->b_text ? 0 : 32;
321 fmt.i_x_offset = fmt.i_y_offset = 0;
323 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
324 if( p_spu->p_region == NULL )
326 msg_Err( p_dec, "cannot allocate SPU region" );
330 p_spu->p_region->i_x = 0;
331 p_spu->p_region->i_y = 0;
332 p_spu->p_region->i_align = SUBPICTURE_ALIGN_TOP;
334 /* Normal text subs, easy markup */
335 p_spu->i_flags = SUBPICTURE_ALIGN_TOP;
337 p_spu->i_start = (mtime_t) p_block->i_pts;
338 p_spu->i_stop = (mtime_t) 0;
339 p_spu->b_ephemer = VLC_TRUE;
340 p_spu->b_absolute = VLC_FALSE;
341 p_spu->b_pausable = VLC_TRUE;
342 p_spu->i_width = fmt.i_width;
343 p_spu->i_height = fmt.i_height;
344 p_spu->i_original_picture_width = p_page.columns * 12;
345 p_spu->i_original_picture_height = p_page.rows * 10;
347 #ifdef WORDS_BIGENDIAN
348 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
350 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
355 unsigned int i_textsize = 7000;
359 i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
360 "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
361 p_text[i_total] = '\0';
362 /* Strip off the pagenumber */
363 if( i_total <= 40 ) goto error;
364 p_spu->p_region->psz_text = strdup( &p_text[8] );
366 p_spu->p_region->fmt.i_height = p_spu->p_region->fmt.i_visible_height = p_page.rows + 1;
367 msg_Dbg( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
371 #ifdef HAVE_FFMPEG_SWSCALE_H
372 video_format_t fmt_in;
373 picture_t *p_pic, *p_dest;
375 p_pic = ( picture_t * ) malloc( sizeof( picture_t ) );
378 msg_Err( p_dec, "out of memory" );
382 memset( &fmt_in, 0, sizeof( video_format_t ) );
383 memset( p_pic, 0, sizeof( picture_t ) );
385 fmt_in = p_spu->p_region->fmt;
386 fmt_in.i_chroma = VLC_FOURCC('R','G','B','A');
388 vout_AllocatePicture( VLC_OBJECT(p_dec), p_pic, fmt_in.i_chroma,
389 fmt_in.i_width, fmt_in.i_height, fmt_in.i_aspect );
391 if( !p_pic->i_planes )
393 free( p_pic->p_data_orig );
398 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
399 p_pic->p->p_pixels, 1, 1 );
401 p_pic->p->i_lines = p_page.rows * 10;
402 p_pic->p->i_pitch = p_page.columns * 12 * 4;
404 OpaquePage( p_dec, p_page, fmt_in, &p_pic );
407 msg_Dbg( p_dec, "page %x-%x(%d,%d)",
408 p_page.pgno, p_page.subno,
409 p_page.rows, p_page.columns );
411 p_dest = image_Convert( p_sys->p_image, p_pic, &fmt_in,
412 &p_spu->p_region->fmt );
415 free( p_pic->p_data_orig );
417 msg_Err( p_dec, "chroma conversion failed" );
421 vout_CopyPicture( VLC_OBJECT(p_dec), &p_spu->p_region->picture,
424 free( p_pic->p_data_orig );
427 free( p_dest->p_data_orig );
432 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
433 p_spu->p_region->picture.p->p_pixels, 1, 1 );
435 p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
436 p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
438 p_pic = &(p_spu->p_region->picture);
439 OpaquePage( p_dec, p_page, fmt, &p_pic );
445 vbi_unref_page( &p_page );
446 block_Release( p_block );
450 vbi_unref_page( &p_page );
453 p_dec->pf_spu_buffer_del( p_dec, p_spu );
457 block_Release( p_block );
461 static void event_handler( vbi_event *ev, void *user_data )
463 decoder_t *p_dec = (decoder_t *)user_data;
464 decoder_sys_t *p_sys = p_dec->p_sys;
466 if( ev->type == VBI_EVENT_TTX_PAGE )
468 /* msg_Dbg( p_dec, "Page %03x.%02x ",
469 ev->ev.ttx_page.pgno,
470 ev->ev.ttx_page.subno & 0xFF);
472 if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
473 p_sys->b_update = VLC_TRUE;
475 if( ev->ev.ttx_page.clock_update )
476 msg_Dbg( p_dec, "clock" );
477 if( ev->ev.ttx_page.header_update )
478 msg_Dbg( p_dec, "header" );
480 else if( ev->type == VBI_EVENT_CAPTION )
481 msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
482 else if( ev->type == VBI_EVENT_NETWORK )
483 msg_Dbg( p_dec, "Network change" );
484 else if( ev->type == VBI_EVENT_ASPECT )
485 msg_Dbg( p_dec, "Aspect update" );
486 else if( ev->type == VBI_EVENT_NETWORK )
487 msg_Dbg( p_dec, "Program info received" );
490 static int OpaquePage( decoder_t *p_dec, vbi_page p_page,
491 video_format_t fmt, picture_t **p_src )
493 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
494 uint32_t *p_begin, *p_end;
495 unsigned int x = 0, y = 0;
498 /* Kludge since zvbi doesn't provide an option to specify opacity. */
499 if( ( fmt.i_chroma != VLC_FOURCC('R','G','B','A' ) ) &&
500 ( fmt.i_chroma != VLC_FOURCC('Y','U','V','A' ) ) )
502 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
506 switch( fmt.i_chroma )
508 case VLC_FOURCC('R','G','B','A' ):
509 p_begin = (uint32_t *)(*p_src)->p->p_pixels;
510 p_end = (uint32_t *)(*p_src)->p->p_pixels+(fmt.i_width * fmt.i_height);
512 case VLC_FOURCC('Y','U','V','A' ):
513 p_begin = (uint32_t *)(*p_src)->p[A_PLANE].p_pixels;
514 p_end = (uint32_t *)(*p_src)->p[A_PLANE].p_pixels +
515 ( (*p_src)->p[A_PLANE].i_lines * (*p_src)->p[A_PLANE].i_pitch );
518 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
522 for( ; p_begin < p_end; p_begin++ )
524 opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
527 /* Show video instead of this character */
528 case VBI_TRANSPARENT_SPACE:
531 /* To make the boxed text "closed captioning" transparent
532 * change VLC_TRUE to VLC_FALSE.
535 if( p_sys->b_opaque )
537 /* Full text transparency. only foreground color is show */
538 case VBI_TRANSPARENT_FULL:
539 /* Transparency for boxed text */
540 case VBI_SEMI_TRANSPARENT:
541 if( (*p_begin & 0xffffff00) == 0xff )
548 if( x >= fmt.i_width )
558 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
559 vlc_value_t oldval, vlc_value_t newval, void *p_data )
561 decoder_sys_t *p_sys = p_data;
563 if( (newval.i_int > 0) && (newval.i_int < 999) )
564 p_sys->i_wanted_page = newval.i_int;
569 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
570 vlc_value_t oldval, vlc_value_t newval, void *p_data )
572 decoder_sys_t *p_sys = p_data;
575 p_sys->b_opaque = newval.b_bool;
579 static int Position( vlc_object_t *p_this, char const *psz_cmd,
580 vlc_value_t oldval, vlc_value_t newval, void *p_data )
582 decoder_sys_t *p_sys = p_data;
585 p_sys->i_align = newval.i_int;