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,
145 static int Opaque_32bpp( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
147 static int Opaque_8bpp( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
150 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
151 vlc_value_t oldval, vlc_value_t newval, void *p_data );
152 static int Position( vlc_object_t *p_this, char const *psz_cmd,
153 vlc_value_t oldval, vlc_value_t newval, void *p_data );
155 /*****************************************************************************
156 * Open: probe the decoder and return score
157 *****************************************************************************
158 * Tries to launch a decoder and return score so that the interface is able
160 *****************************************************************************/
161 static int Open( vlc_object_t *p_this )
163 decoder_t *p_dec = (decoder_t *) p_this;
164 decoder_sys_t *p_sys = NULL;
166 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
171 p_dec->pf_decode_sub = Decode;
172 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
175 msg_Err( p_dec, "out of memory" );
178 memset( p_sys, 0, sizeof(decoder_sys_t) );
180 #ifdef HAVE_FFMPEG_SWSCALE_H
181 p_sys->p_image = image_HandlerCreate( VLC_OBJECT(p_dec) );
182 if( !p_sys->p_image )
185 msg_Err( p_dec, "out of memory" );
190 p_sys->b_update = VLC_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 #ifdef HAVE_FFMPEG_SWSCALE_H
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 #ifdef HAVE_FFMPEG_SWSCALE_H
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 vlc_bool_t b_cached = VLC_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 != VLC_TRUE ) )
304 p_sys->b_update = VLC_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 #ifdef HAVE_FFMPEG_SWSCALE_H
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 = VLC_TRUE;
351 p_spu->b_absolute = VLC_FALSE;
352 p_spu->b_pausable = VLC_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;
378 msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
382 #ifdef HAVE_FFMPEG_SWSCALE_H
383 video_format_t fmt_in;
384 picture_t *p_pic, *p_dest;
386 p_pic = ( picture_t * ) malloc( sizeof( picture_t ) );
389 msg_Err( p_dec, "out of memory" );
393 memset( &fmt_in, 0, sizeof( video_format_t ) );
394 memset( p_pic, 0, sizeof( picture_t ) );
397 fmt_in.i_chroma = VLC_FOURCC('R','G','B','A');
399 vout_AllocatePicture( VLC_OBJECT(p_dec), p_pic, fmt_in.i_chroma,
400 fmt_in.i_width, fmt_in.i_height, fmt_in.i_aspect );
401 if( !p_pic->i_planes )
403 free( p_pic->p_data_orig );
408 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
409 p_pic->p->p_pixels, 1, 1 );
411 p_pic->p->i_lines = p_page.rows * 10;
412 p_pic->p->i_pitch = p_page.columns * 12 * 4;
415 msg_Dbg( p_dec, "page %x-%x(%d,%d)",
416 p_page.pgno, p_page.subno,
417 p_page.rows, p_page.columns );
419 p_dest = image_Convert( p_sys->p_image, p_pic, &fmt_in,
420 &p_spu->p_region->fmt );
423 free( p_pic->p_data_orig );
425 msg_Err( p_dec, "chroma conversion failed" );
428 OpaquePage( p_dec, p_page, p_spu->p_region->fmt, &p_dest );
429 vout_CopyPicture( VLC_OBJECT(p_dec), &(p_spu->p_region->picture),
432 free( p_pic->p_data_orig );
435 free( p_dest->p_data_orig );
440 vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
441 p_spu->p_region->picture.p->p_pixels, 1, 1 );
443 p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
444 p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
446 p_pic = &(p_spu->p_region->picture);
447 OpaquePage( p_dec, p_page, fmt, &p_pic );
453 vbi_unref_page( &p_page );
454 block_Release( p_block );
458 vbi_unref_page( &p_page );
461 p_dec->pf_spu_buffer_del( p_dec, p_spu );
465 block_Release( p_block );
469 static void event_handler( vbi_event *ev, void *user_data )
471 decoder_t *p_dec = (decoder_t *)user_data;
472 decoder_sys_t *p_sys = p_dec->p_sys;
474 if( ev->type == VBI_EVENT_TTX_PAGE )
476 /* msg_Info( p_dec, "Page %03x.%02x ",
477 ev->ev.ttx_page.pgno,
478 ev->ev.ttx_page.subno & 0xFF);
480 if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
481 p_sys->b_update = VLC_TRUE;
483 if( ev->ev.ttx_page.clock_update )
484 msg_Dbg( p_dec, "clock" );
485 /* if( ev->ev.ttx_page.header_update )
486 msg_Dbg( p_dec, "header" );
489 else if( ev->type == VBI_EVENT_CAPTION )
490 msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
491 else if( ev->type == VBI_EVENT_NETWORK )
492 msg_Dbg( p_dec, "Network change" );
493 else if( ev->type == VBI_EVENT_ASPECT )
494 msg_Dbg( p_dec, "Aspect update" );
495 else if( ev->type == VBI_EVENT_NETWORK )
496 msg_Dbg( p_dec, "Program info received" );
499 static int OpaquePage( decoder_t *p_dec, vbi_page p_page,
500 video_format_t fmt, picture_t **p_src )
502 int result = VLC_EGENERIC;
504 /* Kludge since zvbi doesn't provide an option to specify opacity. */
505 switch( fmt.i_chroma )
507 case VLC_FOURCC('R','G','B','A' ):
508 result = Opaque_32bpp( p_dec, p_page, fmt, p_src );
510 case VLC_FOURCC('Y','U','V','A' ):
511 result = Opaque_8bpp( p_dec, p_page, fmt, p_src );
514 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
520 static int Opaque_32bpp( decoder_t *p_dec, vbi_page p_page,
521 video_format_t fmt, picture_t **p_src )
523 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
524 uint32_t *p_begin, *p_end;
525 unsigned int x = 0, y = 0;
528 /* Kludge since zvbi doesn't provide an option to specify opacity. */
529 switch( fmt.i_chroma )
531 case VLC_FOURCC('R','G','B','A' ):
532 p_begin = (uint32_t *)(*p_src)->p->p_pixels;
533 p_end = (uint32_t *)(*p_src)->p->p_pixels +
534 ( fmt.i_width * fmt.i_height );
537 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
541 for( ; p_begin < p_end; p_begin++ )
543 opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
546 /* Show video instead of this character */
547 case VBI_TRANSPARENT_SPACE:
550 /* To make the boxed text "closed captioning" transparent
551 * change VLC_TRUE to VLC_FALSE.
554 if( p_sys->b_opaque )
556 /* Full text transparency. only foreground color is show */
557 case VBI_TRANSPARENT_FULL:
560 /* Transparency for boxed text */
561 case VBI_SEMI_TRANSPARENT:
562 if( (*p_begin & 0xffffff00) == 0xff )
567 if( x >= fmt.i_width )
577 static int Opaque_8bpp( decoder_t *p_dec, vbi_page p_page,
578 video_format_t fmt, picture_t **p_src )
580 decoder_sys_t *p_sys = (decoder_sys_t *) p_dec->p_sys;
581 uint8_t *p_begin, *p_end;
582 uint32_t i_width = 0;
583 unsigned int x = 0, y = 0;
586 /* Kludge since zvbi doesn't provide an option to specify opacity. */
587 switch( fmt.i_chroma )
589 case VLC_FOURCC('Y','U','V','A' ):
590 p_begin = (uint8_t *)(*p_src)->p[A_PLANE].p_pixels;
591 p_end = (uint8_t *)(*p_src)->p[A_PLANE].p_pixels +
592 ( fmt.i_height * (*p_src)->p[A_PLANE].i_pitch );
593 i_width = (*p_src)->p[A_PLANE].i_pitch;
596 msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
600 for( ; p_begin < p_end; p_begin++ )
602 opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
605 /* Show video instead of this character */
606 case VBI_TRANSPARENT_SPACE:
609 /* To make the boxed text "closed captioning" transparent
610 * change VLC_TRUE to VLC_FALSE.
613 if( p_sys->b_opaque )
615 /* Full text transparency. only foreground color is show */
616 case VBI_TRANSPARENT_FULL:
619 /* Transparency for boxed text */
620 case VBI_SEMI_TRANSPARENT:
621 if( (*p_begin & 0xffffff00) == 0xff )
636 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
637 vlc_value_t oldval, vlc_value_t newval, void *p_data )
639 decoder_sys_t *p_sys = p_data;
641 if( (newval.i_int > 0) && (newval.i_int < 999) )
642 p_sys->i_wanted_page = newval.i_int;
647 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
648 vlc_value_t oldval, vlc_value_t newval, void *p_data )
650 decoder_sys_t *p_sys = p_data;
653 p_sys->b_opaque = newval.b_bool;
657 static int Position( vlc_object_t *p_this, char const *psz_cmd,
658 vlc_value_t oldval, vlc_value_t newval, void *p_data )
660 decoder_sys_t *p_sys = p_data;
663 p_sys->i_align = newval.i_int;