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)
51 #include "vlc_codec.h"
52 #include "vlc_image.h"
55 DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE = 0x02,
56 DATA_UNIT_EBU_TELETEXT_SUBTITLE = 0x03,
57 DATA_UNIT_EBU_TELETEXT_INVERTED = 0x0C,
59 DATA_UNIT_ZVBI_WSS_CPR1204 = 0xB4,
60 DATA_UNIT_ZVBI_CLOSED_CAPTION_525 = 0xB5,
61 DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525 = 0xB6,
65 DATA_UNIT_CLOSED_CAPTION = 0xC5,
66 DATA_UNIT_MONOCHROME_SAMPLES = 0xC6,
68 DATA_UNIT_STUFFING = 0xFF,
71 /*****************************************************************************
73 *****************************************************************************/
74 static int Open ( vlc_object_t * );
75 static void Close( vlc_object_t * );
76 static subpicture_t *Decode( decoder_t *, block_t ** );
78 #define PAGE_TEXT N_("Teletext page")
79 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
80 "Default page is index 100")
82 #define OPAQUE_TEXT N_("Text is always opaque")
83 #define OPAQUE_LONGTEXT N_("Setting vbi-opaque to false " \
84 "makes the boxed text transparent." )
86 #define POS_TEXT N_("Teletext alignment")
87 #define POS_LONGTEXT N_( \
88 "You can enforce the teletext position on the video " \
89 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
90 "also use combinations of these values, eg. 6 = top-right).")
92 #define TELX_TEXT N_("Teletext text subtitles")
93 #define TELX_LONGTEXT N_( "Output teletext subtitles as text " \
94 "instead of as RGBA" )
98 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
99 static const char *ppsz_pos_descriptions[] =
100 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
101 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
104 set_description( _("VBI and Teletext decoder") );
105 set_shortname( "VBI & Teletext" );
106 set_capability( "decoder", 51 );
107 set_category( CAT_INPUT );
108 set_subcategory( SUBCAT_INPUT_SCODEC );
109 set_callbacks( Open, Close );
111 add_integer( "vbi-page", 100, NULL,
112 PAGE_TEXT, PAGE_LONGTEXT, false );
113 add_bool( "vbi-opaque", true, NULL,
114 OPAQUE_TEXT, OPAQUE_LONGTEXT, false );
115 add_integer( "vbi-position", 4, NULL, POS_TEXT, POS_LONGTEXT, false );
116 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
117 add_bool( "vbi-text", false, NULL,
118 TELX_TEXT, TELX_LONGTEXT, false );
121 /****************************************************************************
123 ****************************************************************************/
127 vbi_decoder * p_vbi_dec;
128 vbi_dvb_demux * p_dvb_demux;
129 unsigned int i_wanted_page;
130 unsigned int i_last_page;
134 /* Subtitles as text */
137 /* Positioning of Teletext images */
141 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
142 image_handler_t *p_image;
146 static void event_handler( vbi_event *ev, void *user_data );
147 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
148 vlc_value_t oldval, vlc_value_t newval, void *p_data );
149 static int OpaquePage( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
151 static int Opaque_32bpp( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
153 static int Opaque_8bpp( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
156 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
157 vlc_value_t oldval, vlc_value_t newval, void *p_data );
158 static int Position( vlc_object_t *p_this, char const *psz_cmd,
159 vlc_value_t oldval, vlc_value_t newval, void *p_data );
161 /*****************************************************************************
162 * Open: probe the decoder and return score
163 *****************************************************************************
164 * Tries to launch a decoder and return score so that the interface is able
166 *****************************************************************************/
167 static int Open( vlc_object_t *p_this )
169 decoder_t *p_dec = (decoder_t *) p_this;
170 decoder_sys_t *p_sys = NULL;
172 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
175 p_dec->pf_decode_sub = Decode;
176 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
179 memset( p_sys, 0, sizeof(decoder_sys_t) );
181 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
182 p_sys->p_image = image_HandlerCreate( VLC_OBJECT(p_dec) );
183 if( !p_sys->p_image )
190 p_sys->b_update = false;
191 p_sys->p_vbi_dec = vbi_decoder_new();
192 p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
194 if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
196 msg_Err( p_dec, "VBI decoder/demux could not be created." );
201 vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
202 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
203 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
204 event_handler, p_dec );
206 /* Create the var on vlc_global. */
207 p_sys->i_wanted_page = var_CreateGetInteger( p_dec, "vbi-page" );
208 var_AddCallback( p_dec, "vbi-page",
209 RequestPage, p_sys );
211 p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
212 var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
214 p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
215 var_AddCallback( p_dec, "vbi-position", Position, p_sys );
217 p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
218 // var_AddCallback( p_dec, "vbi-text", Text, p_sys );
220 es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
222 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('T','E','X','T');
224 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
225 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('Y','U','V','A');
227 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('R','G','B','A');
232 /*****************************************************************************
234 *****************************************************************************/
235 static void Close( vlc_object_t *p_this )
237 decoder_t *p_dec = (decoder_t*) p_this;
238 decoder_sys_t *p_sys = p_dec->p_sys;
240 var_Destroy( p_dec, "vbi-opaque" );
241 var_Destroy( p_dec, "vbi-page" );
242 var_DelCallback( p_dec, "vbi-page", RequestPage, p_sys );
243 var_DelCallback( p_dec, "vbi-opaque", Opaque, p_sys );
245 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
246 if( p_sys->p_image ) image_HandlerDelete( p_sys->p_image );
248 if( p_sys->p_vbi_dec ) vbi_decoder_delete( p_sys->p_vbi_dec );
249 if( p_sys->p_dvb_demux ) vbi_dvb_demux_delete( p_sys->p_dvb_demux );
253 #define MAX_SLICES 32
255 /*****************************************************************************
257 *****************************************************************************/
258 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
260 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
262 subpicture_t *p_spu = NULL;
264 bool b_cached = false;
266 const uint8_t *p_pos;
269 if( (pp_block == NULL) || (*pp_block == NULL) )
275 p_pos = p_block->p_buffer;
276 i_left = p_block->i_buffer;
280 vbi_sliced p_sliced[MAX_SLICES];
281 unsigned int i_lines = 0;
284 i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
285 MAX_SLICES, &i_pts, &p_pos, &i_left );
288 vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
291 /* Try to see if the page we want is in the cache yet */
292 b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
293 vbi_dec2bcd( p_sys->i_wanted_page ),
294 VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
300 if( ( p_sys->i_wanted_page == p_sys->i_last_page ) &&
301 ( p_sys->b_update != true ) )
304 p_sys->b_update = false;
305 p_sys->i_last_page = p_sys->i_wanted_page;
307 msg_Dbg( p_dec, "we now have page: %d ready for display",
308 p_sys->i_wanted_page );
310 /* If there is a page or sub to render, then we do that here */
311 /* Create the subpicture unit */
312 p_spu = p_dec->pf_spu_buffer_new( p_dec );
315 msg_Warn( p_dec, "can't get spu buffer" );
319 /* Create a new subpicture region */
320 memset( &fmt, 0, sizeof(video_format_t) );
321 fmt.i_chroma = p_sys->b_text ? VLC_FOURCC('T','E','X','T') :
322 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
323 VLC_FOURCC('Y','U','V','A');
325 VLC_FOURCC('R','G','B','A');
327 fmt.i_aspect = p_sys->b_text ? 0 : VOUT_ASPECT_FACTOR;
328 fmt.i_sar_num = fmt.i_sar_den = 1;
329 fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
330 fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
331 fmt.i_bits_per_pixel = p_sys->b_text ? 0 : 32;
332 fmt.i_x_offset = fmt.i_y_offset = 0;
334 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
335 if( p_spu->p_region == NULL )
337 msg_Err( p_dec, "cannot allocate SPU region" );
341 p_spu->p_region->i_x = 0;
342 p_spu->p_region->i_y = 0;
343 p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM;
345 /* Normal text subs, easy markup */
346 p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM;
348 p_spu->i_start = (mtime_t) p_block->i_dts;
349 p_spu->i_stop = (mtime_t) 0;
350 p_spu->b_ephemer = true;
351 p_spu->b_absolute = false;
352 p_spu->b_pausable = true;
353 p_spu->i_width = fmt.i_width;
354 p_spu->i_height = fmt.i_height;
355 p_spu->i_original_picture_width = p_page.columns * 12;
356 p_spu->i_original_picture_height = p_page.rows * 10;
358 #ifdef WORDS_BIGENDIAN
359 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
361 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
366 unsigned int i_textsize = 7000;
370 i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
371 "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
372 p_text[i_total] = '\0';
373 /* Strip off the pagenumber */
374 if( i_total <= 40 ) goto error;
375 p_spu->p_region->psz_text = strdup( &p_text[8] );
377 p_spu->p_region->fmt.i_height = p_spu->p_region->fmt.i_visible_height = p_page.rows + 1;
379 msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
384 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
385 video_format_t fmt_in;
386 picture_t *p_pic, *p_dest;
388 p_pic = ( picture_t * ) malloc( sizeof( picture_t ) );
391 msg_Err( p_dec, "out of memory" );
395 memset( &fmt_in, 0, sizeof( video_format_t ) );
396 memset( p_pic, 0, sizeof( picture_t ) );
399 fmt_in.i_chroma = VLC_FOURCC('R','G','B','A');
401 vout_AllocatePicture( VLC_OBJECT(p_dec), p_pic, fmt_in.i_chroma,
402 fmt_in.i_width, fmt_in.i_height, fmt_in.i_aspect );
403 if( !p_pic->i_planes )
405 free( p_pic->p_data_orig );
410 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
411 p_pic->p->p_pixels, 1, 1 );
413 p_pic->p->i_lines = p_page.rows * 10;
414 p_pic->p->i_pitch = p_page.columns * 12 * 4;
417 msg_Dbg( p_dec, "page %x-%x(%d,%d)",
418 p_page.pgno, p_page.subno,
419 p_page.rows, p_page.columns );
421 p_dest = image_Convert( p_sys->p_image, p_pic, &fmt_in,
422 &p_spu->p_region->fmt );
425 free( p_pic->p_data_orig );
427 msg_Err( p_dec, "chroma conversion failed" );
430 OpaquePage( p_dec, p_page, p_spu->p_region->fmt, &p_dest );
431 vout_CopyPicture( VLC_OBJECT(p_dec), &(p_spu->p_region->picture),
434 free( p_pic->p_data_orig );
437 free( p_dest->p_data_orig );
442 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
443 p_spu->p_region->picture.p->p_pixels, 1, 1 );
445 p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
446 p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
448 p_pic = &(p_spu->p_region->picture);
449 OpaquePage( p_dec, p_page, fmt, &p_pic );
453 #undef ZVBI_PIXFMT_RGBA32
455 vbi_unref_page( &p_page );
456 block_Release( p_block );
460 vbi_unref_page( &p_page );
463 p_dec->pf_spu_buffer_del( p_dec, p_spu );
467 block_Release( p_block );
471 static void event_handler( vbi_event *ev, void *user_data )
473 decoder_t *p_dec = (decoder_t *)user_data;
474 decoder_sys_t *p_sys = p_dec->p_sys;
476 if( ev->type == VBI_EVENT_TTX_PAGE )
479 msg_Info( p_dec, "Page %03x.%02x ",
480 ev->ev.ttx_page.pgno,
481 ev->ev.ttx_page.subno & 0xFF);
483 if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
484 p_sys->b_update = true;
486 if( ev->ev.ttx_page.clock_update )
487 msg_Dbg( p_dec, "clock" );
489 if( ev->ev.ttx_page.header_update )
490 msg_Dbg( p_dec, "header" );
493 else if( ev->type == VBI_EVENT_CAPTION )
494 msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
495 else if( ev->type == VBI_EVENT_NETWORK )
496 msg_Dbg( p_dec, "Network change" );
497 else if( ev->type == VBI_EVENT_ASPECT )
498 msg_Dbg( p_dec, "Aspect update" );
499 else if( ev->type == VBI_EVENT_NETWORK )
500 msg_Dbg( p_dec, "Program info received" );
503 static int OpaquePage( decoder_t *p_dec, vbi_page p_page,
504 video_format_t fmt, picture_t **p_src )
506 int result = VLC_EGENERIC;
508 /* Kludge since zvbi doesn't provide an option to specify opacity. */
509 switch( fmt.i_chroma )
511 case VLC_FOURCC('R','G','B','A' ):
512 result = Opaque_32bpp( p_dec, p_page, fmt, p_src );
514 case VLC_FOURCC('Y','U','V','A' ):
515 result = Opaque_8bpp( p_dec, p_page, fmt, p_src );
518 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
524 static int Opaque_32bpp( decoder_t *p_dec, vbi_page p_page,
525 video_format_t fmt, picture_t **p_src )
527 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
528 uint32_t *p_begin, *p_end;
529 unsigned int x = 0, y = 0;
532 /* Kludge since zvbi doesn't provide an option to specify opacity. */
533 switch( fmt.i_chroma )
535 case VLC_FOURCC('R','G','B','A' ):
536 p_begin = (uint32_t *)(*p_src)->p->p_pixels;
537 p_end = (uint32_t *)(*p_src)->p->p_pixels +
538 ( fmt.i_width * fmt.i_height );
541 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
545 for( ; p_begin < p_end; p_begin++ )
547 opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
550 /* Show video instead of this character */
551 case VBI_TRANSPARENT_SPACE:
554 /* To make the boxed text "closed captioning" transparent
555 * change true to false.
558 if( p_sys->b_opaque )
560 /* Full text transparency. only foreground color is show */
561 case VBI_TRANSPARENT_FULL:
564 /* Transparency for boxed text */
565 case VBI_SEMI_TRANSPARENT:
566 if( (*p_begin & 0xffffff00) == 0xff )
571 if( x >= fmt.i_width )
581 static int Opaque_8bpp( decoder_t *p_dec, vbi_page p_page,
582 video_format_t fmt, picture_t **p_src )
584 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
585 uint8_t *p_begin, *p_end;
586 uint32_t i_width = 0;
587 unsigned int x = 0, y = 0;
590 /* Kludge since zvbi doesn't provide an option to specify opacity. */
591 switch( fmt.i_chroma )
593 case VLC_FOURCC('Y','U','V','A' ):
594 p_begin = (uint8_t *)(*p_src)->p[A_PLANE].p_pixels;
595 p_end = (uint8_t *)(*p_src)->p[A_PLANE].p_pixels +
596 ( fmt.i_height * (*p_src)->p[A_PLANE].i_pitch );
597 i_width = (*p_src)->p[A_PLANE].i_pitch;
600 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
604 for( ; p_begin < p_end; p_begin++ )
606 opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
609 /* Show video instead of this character */
610 case VBI_TRANSPARENT_SPACE:
613 /* To make the boxed text "closed captioning" transparent
614 * change true to false.
617 if( p_sys->b_opaque )
619 /* Full text transparency. only foreground color is show */
620 case VBI_TRANSPARENT_FULL:
623 /* Transparency for boxed text */
624 case VBI_SEMI_TRANSPARENT:
625 if( (*p_begin & 0xffffff00) == 0xff )
640 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
641 vlc_value_t oldval, vlc_value_t newval, void *p_data )
643 decoder_sys_t *p_sys = p_data;
644 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
646 if( (newval.i_int > 0) && (newval.i_int < 999) )
647 p_sys->i_wanted_page = newval.i_int;
652 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
653 vlc_value_t oldval, vlc_value_t newval, void *p_data )
655 decoder_sys_t *p_sys = p_data;
656 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
659 p_sys->b_opaque = newval.b_bool;
663 static int Position( vlc_object_t *p_this, char const *psz_cmd,
664 vlc_value_t oldval, vlc_value_t newval, void *p_data )
666 decoder_sys_t *p_sys = p_data;
667 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
670 p_sys->i_align = newval.i_int;