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)
45 #include <vlc_plugin.h>
52 #include "vlc_codec.h"
53 #include "vlc_image.h"
56 DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE = 0x02,
57 DATA_UNIT_EBU_TELETEXT_SUBTITLE = 0x03,
58 DATA_UNIT_EBU_TELETEXT_INVERTED = 0x0C,
60 DATA_UNIT_ZVBI_WSS_CPR1204 = 0xB4,
61 DATA_UNIT_ZVBI_CLOSED_CAPTION_525 = 0xB5,
62 DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525 = 0xB6,
66 DATA_UNIT_CLOSED_CAPTION = 0xC5,
67 DATA_UNIT_MONOCHROME_SAMPLES = 0xC6,
69 DATA_UNIT_STUFFING = 0xFF,
72 /*****************************************************************************
74 *****************************************************************************/
75 static int Open ( vlc_object_t * );
76 static void Close( vlc_object_t * );
77 static subpicture_t *Decode( decoder_t *, block_t ** );
79 #define PAGE_TEXT N_("Teletext page")
80 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
81 "Default page is index 100")
83 #define OPAQUE_TEXT N_("Text is always opaque")
84 #define OPAQUE_LONGTEXT N_("Setting vbi-opaque to false " \
85 "makes the boxed text transparent." )
87 #define POS_TEXT N_("Teletext alignment")
88 #define POS_LONGTEXT N_( \
89 "You can enforce the teletext position on the video " \
90 "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
91 "also use combinations of these values, eg. 6 = top-right).")
93 #define TELX_TEXT N_("Teletext text subtitles")
94 #define TELX_LONGTEXT N_( "Output teletext subtitles as text " \
95 "instead of as RGBA" )
99 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
100 static const char *const ppsz_pos_descriptions[] =
101 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
102 N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
105 set_description( N_("VBI and Teletext decoder") );
106 set_shortname( N_("VBI & Teletext") );
107 set_capability( "decoder", 51 );
108 set_category( CAT_INPUT );
109 set_subcategory( SUBCAT_INPUT_SCODEC );
110 set_callbacks( Open, Close );
112 add_integer( "vbi-page", 100, NULL,
113 PAGE_TEXT, PAGE_LONGTEXT, false );
114 add_bool( "vbi-opaque", true, NULL,
115 OPAQUE_TEXT, OPAQUE_LONGTEXT, false );
116 add_integer( "vbi-position", 4, NULL, POS_TEXT, POS_LONGTEXT, false );
117 change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
118 add_bool( "vbi-text", false, NULL,
119 TELX_TEXT, TELX_LONGTEXT, false );
122 /****************************************************************************
124 ****************************************************************************/
128 vbi_decoder * p_vbi_dec;
129 vbi_dvb_demux * p_dvb_demux;
130 unsigned int i_wanted_page;
131 unsigned int i_last_page;
135 /* Subtitles as text */
138 /* Positioning of Teletext images */
142 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
143 image_handler_t *p_image;
147 static void event_handler( vbi_event *ev, void *user_data );
148 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
149 vlc_value_t oldval, vlc_value_t newval, void *p_data );
150 static int OpaquePage( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
152 static int Opaque_32bpp( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
154 static int Opaque_8bpp( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
157 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
158 vlc_value_t oldval, vlc_value_t newval, void *p_data );
159 static int Position( vlc_object_t *p_this, char const *psz_cmd,
160 vlc_value_t oldval, vlc_value_t newval, void *p_data );
162 /*****************************************************************************
163 * Open: probe the decoder and return score
164 *****************************************************************************
165 * Tries to launch a decoder and return score so that the interface is able
167 *****************************************************************************/
168 static int Open( vlc_object_t *p_this )
170 decoder_t *p_dec = (decoder_t *) p_this;
171 decoder_sys_t *p_sys = NULL;
173 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
176 p_dec->pf_decode_sub = Decode;
177 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
180 memset( p_sys, 0, sizeof(decoder_sys_t) );
182 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
183 p_sys->p_image = image_HandlerCreate( VLC_OBJECT(p_dec) );
184 if( !p_sys->p_image )
191 p_sys->b_update = false;
192 p_sys->p_vbi_dec = vbi_decoder_new();
193 p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
195 if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
197 msg_Err( p_dec, "VBI decoder/demux could not be created." );
202 vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
203 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
204 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
205 event_handler, p_dec );
207 /* Create the var on vlc_global. */
208 p_sys->i_wanted_page = var_CreateGetInteger( p_dec, "vbi-page" );
209 var_AddCallback( p_dec, "vbi-page",
210 RequestPage, p_sys );
212 p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
213 var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
215 p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
216 var_AddCallback( p_dec, "vbi-position", Position, p_sys );
218 p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
219 // var_AddCallback( p_dec, "vbi-text", Text, p_sys );
221 es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
223 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('T','E','X','T');
225 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
226 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('Y','U','V','A');
228 p_dec->fmt_out.video.i_chroma = VLC_FOURCC('R','G','B','A');
233 /*****************************************************************************
235 *****************************************************************************/
236 static void Close( vlc_object_t *p_this )
238 decoder_t *p_dec = (decoder_t*) p_this;
239 decoder_sys_t *p_sys = p_dec->p_sys;
241 var_Destroy( p_dec, "vbi-opaque" );
242 var_Destroy( p_dec, "vbi-page" );
243 var_DelCallback( p_dec, "vbi-page", RequestPage, p_sys );
244 var_DelCallback( p_dec, "vbi-opaque", Opaque, p_sys );
246 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
247 if( p_sys->p_image ) image_HandlerDelete( p_sys->p_image );
249 if( p_sys->p_vbi_dec ) vbi_decoder_delete( p_sys->p_vbi_dec );
250 if( p_sys->p_dvb_demux ) vbi_dvb_demux_delete( p_sys->p_dvb_demux );
254 #define MAX_SLICES 32
256 /*****************************************************************************
258 *****************************************************************************/
259 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
261 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
263 subpicture_t *p_spu = NULL;
265 bool b_cached = false;
267 const uint8_t *p_pos;
270 if( (pp_block == NULL) || (*pp_block == NULL) )
276 p_pos = p_block->p_buffer;
277 i_left = p_block->i_buffer;
281 vbi_sliced p_sliced[MAX_SLICES];
282 unsigned int i_lines = 0;
285 i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
286 MAX_SLICES, &i_pts, &p_pos, &i_left );
289 vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
292 /* Try to see if the page we want is in the cache yet */
293 b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
294 vbi_dec2bcd( p_sys->i_wanted_page ),
295 VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
301 if( ( p_sys->i_wanted_page == p_sys->i_last_page ) &&
302 ( p_sys->b_update != true ) )
305 p_sys->b_update = false;
306 p_sys->i_last_page = p_sys->i_wanted_page;
308 msg_Dbg( p_dec, "we now have page: %d ready for display",
309 p_sys->i_wanted_page );
311 /* If there is a page or sub to render, then we do that here */
312 /* Create the subpicture unit */
313 p_spu = p_dec->pf_spu_buffer_new( p_dec );
316 msg_Warn( p_dec, "can't get spu buffer" );
320 /* Create a new subpicture region */
321 memset( &fmt, 0, sizeof(video_format_t) );
322 fmt.i_chroma = p_sys->b_text ? VLC_FOURCC('T','E','X','T') :
323 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
324 VLC_FOURCC('Y','U','V','A');
326 VLC_FOURCC('R','G','B','A');
328 fmt.i_aspect = p_sys->b_text ? 0 : VOUT_ASPECT_FACTOR;
331 fmt.i_sar_num = fmt.i_sar_den = 1;
332 fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
333 fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
335 fmt.i_bits_per_pixel = p_sys->b_text ? 0 : 32;
336 fmt.i_x_offset = fmt.i_y_offset = 0;
338 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
339 if( p_spu->p_region == NULL )
341 msg_Err( p_dec, "cannot allocate SPU region" );
345 p_spu->p_region->i_x = 0;
346 p_spu->p_region->i_y = 0;
347 p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM;
349 /* Normal text subs, easy markup */
350 p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM;
352 p_spu->i_start = (mtime_t) p_block->i_pts;
353 p_spu->i_stop = (mtime_t) 0;
354 p_spu->b_ephemer = true;
355 p_spu->b_absolute = false;
356 p_spu->b_pausable = true;
359 p_spu->i_width = fmt.i_width;
360 p_spu->i_height = fmt.i_height;
361 p_spu->i_original_picture_width = p_page.columns * 12;
362 p_spu->i_original_picture_height = p_page.rows * 10;
365 #ifdef WORDS_BIGENDIAN
366 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
368 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
373 unsigned int i_textsize = 7000;
377 i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
378 "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
379 p_text[i_total] = '\0';
380 /* Strip off the pagenumber */
381 if( i_total <= 40 ) goto error;
382 p_spu->p_region->psz_text = strdup( &p_text[8] );
384 p_spu->p_region->fmt.i_height = p_spu->p_region->fmt.i_visible_height = p_page.rows + 1;
386 msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
391 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_TREE)
392 video_format_t fmt_in;
393 picture_t *p_pic, *p_dest;
395 p_pic = ( picture_t * ) malloc( sizeof( picture_t ) );
399 memset( &fmt_in, 0, sizeof( video_format_t ) );
400 memset( p_pic, 0, sizeof( picture_t ) );
403 fmt_in.i_chroma = VLC_FOURCC('R','G','B','A');
405 vout_AllocatePicture( VLC_OBJECT(p_dec), p_pic, fmt_in.i_chroma,
406 fmt_in.i_width, fmt_in.i_height, fmt_in.i_aspect );
407 if( !p_pic->i_planes )
409 free( p_pic->p_data_orig );
414 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
415 p_pic->p->p_pixels, 1, 1 );
417 p_pic->p->i_lines = p_page.rows * 10;
418 p_pic->p->i_pitch = p_page.columns * 12 * 4;
421 msg_Dbg( p_dec, "page %x-%x(%d,%d)",
422 p_page.pgno, p_page.subno,
423 p_page.rows, p_page.columns );
425 p_dest = image_Convert( p_sys->p_image, p_pic, &fmt_in,
426 &p_spu->p_region->fmt );
429 free( p_pic->p_data_orig );
431 msg_Err( p_dec, "chroma conversion failed" );
434 OpaquePage( p_dec, p_page, p_spu->p_region->fmt, &p_dest );
435 vout_CopyPicture( VLC_OBJECT(p_dec), &(p_spu->p_region->picture),
438 free( p_pic->p_data_orig );
441 free( p_dest->p_data_orig );
446 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
447 p_spu->p_region->picture.p->p_pixels, 1, 1 );
449 p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
450 p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
452 p_pic = &(p_spu->p_region->picture);
453 OpaquePage( p_dec, p_page, fmt, &p_pic );
457 #undef ZVBI_PIXFMT_RGBA32
459 vbi_unref_page( &p_page );
460 block_Release( p_block );
464 vbi_unref_page( &p_page );
467 p_dec->pf_spu_buffer_del( p_dec, p_spu );
471 block_Release( p_block );
475 static void event_handler( vbi_event *ev, void *user_data )
477 decoder_t *p_dec = (decoder_t *)user_data;
478 decoder_sys_t *p_sys = p_dec->p_sys;
480 if( ev->type == VBI_EVENT_TTX_PAGE )
483 msg_Info( p_dec, "Page %03x.%02x ",
484 ev->ev.ttx_page.pgno,
485 ev->ev.ttx_page.subno & 0xFF);
487 if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
488 p_sys->b_update = true;
490 if( ev->ev.ttx_page.clock_update )
491 msg_Dbg( p_dec, "clock" );
493 if( ev->ev.ttx_page.header_update )
494 msg_Dbg( p_dec, "header" );
497 else if( ev->type == VBI_EVENT_CAPTION )
498 msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
499 else if( ev->type == VBI_EVENT_NETWORK )
500 msg_Dbg( p_dec, "Network change" );
501 else if( ev->type == VBI_EVENT_ASPECT )
502 msg_Dbg( p_dec, "Aspect update" );
503 else if( ev->type == VBI_EVENT_NETWORK )
504 msg_Dbg( p_dec, "Program info received" );
507 static int OpaquePage( decoder_t *p_dec, vbi_page p_page,
508 video_format_t fmt, picture_t **p_src )
510 int result = VLC_EGENERIC;
512 /* Kludge since zvbi doesn't provide an option to specify opacity. */
513 switch( fmt.i_chroma )
515 case VLC_FOURCC('R','G','B','A' ):
516 result = Opaque_32bpp( p_dec, p_page, fmt, p_src );
518 case VLC_FOURCC('Y','U','V','A' ):
519 result = Opaque_8bpp( p_dec, p_page, fmt, p_src );
522 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
528 static int Opaque_32bpp( decoder_t *p_dec, vbi_page p_page,
529 video_format_t fmt, picture_t **p_src )
531 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
532 uint32_t *p_begin, *p_end;
533 unsigned int x = 0, y = 0;
536 /* Kludge since zvbi doesn't provide an option to specify opacity. */
537 switch( fmt.i_chroma )
539 case VLC_FOURCC('R','G','B','A' ):
540 p_begin = (uint32_t *)(*p_src)->p->p_pixels;
541 p_end = (uint32_t *)(*p_src)->p->p_pixels +
542 ( fmt.i_width * fmt.i_height );
545 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
549 for( ; p_begin < p_end; p_begin++ )
551 opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
554 /* Show video instead of this character */
555 case VBI_TRANSPARENT_SPACE:
558 /* To make the boxed text "closed captioning" transparent
559 * change true to false.
562 if( p_sys->b_opaque )
564 /* Full text transparency. only foreground color is show */
565 case VBI_TRANSPARENT_FULL:
568 /* Transparency for boxed text */
569 case VBI_SEMI_TRANSPARENT:
570 if( (*p_begin & 0xffffff00) == 0xff )
575 if( x >= fmt.i_width )
585 static int Opaque_8bpp( decoder_t *p_dec, vbi_page p_page,
586 video_format_t fmt, picture_t **p_src )
588 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
589 uint8_t *p_begin, *p_end;
590 uint32_t i_width = 0;
591 unsigned int x = 0, y = 0;
594 /* Kludge since zvbi doesn't provide an option to specify opacity. */
595 switch( fmt.i_chroma )
597 case VLC_FOURCC('Y','U','V','A' ):
598 p_begin = (uint8_t *)(*p_src)->p[A_PLANE].p_pixels;
599 p_end = (uint8_t *)(*p_src)->p[A_PLANE].p_pixels +
600 ( fmt.i_height * (*p_src)->p[A_PLANE].i_pitch );
601 i_width = (*p_src)->p[A_PLANE].i_pitch;
604 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
608 for( ; p_begin < p_end; p_begin++ )
610 opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
613 /* Show video instead of this character */
614 case VBI_TRANSPARENT_SPACE:
617 /* To make the boxed text "closed captioning" transparent
618 * change true to false.
621 if( p_sys->b_opaque )
623 /* Full text transparency. only foreground color is show */
624 case VBI_TRANSPARENT_FULL:
627 /* Transparency for boxed text */
628 case VBI_SEMI_TRANSPARENT:
629 if( (*p_begin & 0xffffff00) == 0xff )
644 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
645 vlc_value_t oldval, vlc_value_t newval, void *p_data )
647 decoder_sys_t *p_sys = p_data;
648 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
650 if( (newval.i_int > 0) && (newval.i_int < 999) )
651 p_sys->i_wanted_page = newval.i_int;
656 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
657 vlc_value_t oldval, vlc_value_t newval, void *p_data )
659 decoder_sys_t *p_sys = p_data;
660 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
663 p_sys->b_opaque = newval.b_bool;
667 static int Position( vlc_object_t *p_this, char const *psz_cmd,
668 vlc_value_t oldval, vlc_value_t newval, void *p_data )
670 decoder_sys_t *p_sys = p_data;
671 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
674 p_sys->i_align = newval.i_int;