]> git.sesse.net Git - vlc/blob - modules/codec/zvbi.c
zvbi: Use the "initial page" as signaled by the TS demuxer.
[vlc] / modules / codec / zvbi.c
1 /*****************************************************************************
2  * zvbi.c : VBI and Teletext PES demux and decoder using libzvbi
3  *****************************************************************************
4  * Copyright (C) 2007, M2X
5  * $Id$
6  *
7  * Authors: Derk-Jan Hartman <djhartman at m2x dot nl>
8  *          Jean-Paul Saman <jpsaman at m2x dot nl>
9  *
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.
14  *
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.
19  *
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 /*****************************************************************************
25  *
26  * information on teletext format can be found here :
27  * http://pdc.ro.nu/teletext.html
28  *
29  *****************************************************************************/
30
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)
38  */
39
40 #ifdef HAVE_CONFIG_H
41 # include "config.h"
42 #endif
43
44 #include <vlc_common.h>
45 #include <vlc_plugin.h>
46 #include <assert.h>
47 #include <libzvbi.h>
48
49 #include "vlc_vout.h"
50 #include "vlc_codec.h"
51
52 /*****************************************************************************
53  * Module descriptor.
54  *****************************************************************************/
55 static int  Open ( vlc_object_t * );
56 static void Close( vlc_object_t * );
57
58 #define PAGE_TEXT N_("Teletext page")
59 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
60         "Default page is index 100")
61
62 #define OPAQUE_TEXT N_("Text is always opaque")
63 #define OPAQUE_LONGTEXT N_("Setting vbi-opaque to false " \
64         "makes the boxed text transparent." )
65
66 #define POS_TEXT N_("Teletext alignment")
67 #define POS_LONGTEXT N_( \
68   "You can enforce the teletext position on the video " \
69   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
70   "also use combinations of these values, eg. 6 = top-right).")
71
72 #define TELX_TEXT N_("Teletext text subtitles")
73 #define TELX_LONGTEXT N_( "Output teletext subtitles as text " \
74   "instead of as RGBA" )
75
76 static const int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
77 static const char *const ppsz_pos_descriptions[] =
78 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
79   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
80
81 vlc_module_begin();
82     set_description( N_("VBI and Teletext decoder") );
83     set_shortname( N_("VBI & Teletext") );
84     set_capability( "decoder", 51 );
85     set_category( CAT_INPUT );
86     set_subcategory( SUBCAT_INPUT_SCODEC );
87     set_callbacks( Open, Close );
88
89     add_integer( "vbi-page", 100, NULL,
90                  PAGE_TEXT, PAGE_LONGTEXT, false );
91     add_bool( "vbi-opaque", true, NULL,
92                  OPAQUE_TEXT, OPAQUE_LONGTEXT, false );
93     add_integer( "vbi-position", 4, NULL, POS_TEXT, POS_LONGTEXT, false );
94         change_integer_list( pi_pos_values, ppsz_pos_descriptions, NULL );
95     add_bool( "vbi-text", false, NULL,
96               TELX_TEXT, TELX_LONGTEXT, false );
97 vlc_module_end();
98
99 /****************************************************************************
100  * Local structures
101  ****************************************************************************/
102
103 // #define ZVBI_DEBUG
104
105 typedef enum {
106     DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE     = 0x02,
107     DATA_UNIT_EBU_TELETEXT_SUBTITLE         = 0x03,
108     DATA_UNIT_EBU_TELETEXT_INVERTED         = 0x0C,
109
110     DATA_UNIT_ZVBI_WSS_CPR1204              = 0xB4,
111     DATA_UNIT_ZVBI_CLOSED_CAPTION_525       = 0xB5,
112     DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525   = 0xB6,
113
114     DATA_UNIT_VPS                           = 0xC3,
115     DATA_UNIT_WSS                           = 0xC4,
116     DATA_UNIT_CLOSED_CAPTION                = 0xC5,
117     DATA_UNIT_MONOCHROME_SAMPLES            = 0xC6,
118
119     DATA_UNIT_STUFFING                      = 0xFF,
120 } data_unit_id;
121
122 struct decoder_sys_t
123 {
124     vbi_decoder *     p_vbi_dec;
125     vbi_dvb_demux *   p_dvb_demux;
126     unsigned int      i_last_page;
127     bool              b_update;
128     bool              b_text;   /* Subtitles as text */
129
130     vlc_mutex_t       lock; /* Lock to protect the following variables */
131     /* Positioning of Teletext images */
132     int               i_align;
133     /* */
134     unsigned int      i_wanted_page;
135     /* */
136     bool              b_opaque;
137 };
138
139 static subpicture_t *Decode( decoder_t *, block_t ** );
140
141 static subpicture_t *Subpicture( decoder_t *p_dec, video_format_t *p_fmt,
142                                  bool b_text,
143                                  int i_columns, int i_rows,
144                                  int i_align, mtime_t i_pts );
145
146 static void EventHandler( vbi_event *ev, void *user_data );
147 static int OpaquePage( picture_t *p_src, const vbi_page p_page,
148                        const video_format_t fmt, bool b_opaque );
149
150 /* Properties callbacks */
151 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
152                         vlc_value_t oldval, vlc_value_t newval, void *p_data );
153 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
154                    vlc_value_t oldval, vlc_value_t newval, void *p_data );
155 static int Position( vlc_object_t *p_this, char const *psz_cmd,
156                      vlc_value_t oldval, vlc_value_t newval, void *p_data );
157
158 /*****************************************************************************
159  * Open: probe the decoder and return score
160  *****************************************************************************
161  * Tries to launch a decoder and return score so that the interface is able
162  * to chose.
163  *****************************************************************************/
164 static int Open( vlc_object_t *p_this )
165 {
166     decoder_t     *p_dec = (decoder_t *) p_this;
167     decoder_sys_t *p_sys = NULL;
168
169     if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
170         return VLC_EGENERIC;
171
172     p_dec->pf_decode_sub = Decode;
173     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
174     if( p_sys == NULL )
175         return VLC_ENOMEM;
176     memset( p_sys, 0, sizeof(decoder_sys_t) );
177
178     p_sys->b_update = false;
179     p_sys->p_vbi_dec = vbi_decoder_new();
180     p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
181     vlc_mutex_init( &p_sys->lock );
182
183     if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
184     {
185         msg_Err( p_dec, "VBI decoder/demux could not be created." );
186         Close( p_this );
187         return VLC_ENOMEM;
188     }
189
190     vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
191                                 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
192                                 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
193                                 EventHandler, p_dec );
194
195     /* Create the var on vlc_global. */
196     p_sys->i_wanted_page = var_CreateGetInteger( p_dec, "vbi-page" );
197     var_AddCallback( p_dec, "vbi-page",
198                      RequestPage, p_sys );
199
200     /* Check if the Teletext track has a known "initial page". */
201     if( p_sys->i_wanted_page == 100 && p_dec->fmt_in.subs.dvb.i_id != -1 )
202     {
203         int i_wanted_magazine = p_dec->fmt_in.subs.dvb.i_id >> 16;
204         if( i_wanted_magazine == 0 )
205             i_wanted_magazine = 8;
206         p_sys->i_wanted_page = vbi_bcd2dec(p_dec->fmt_in.subs.dvb.i_id & 0xff);
207         p_sys->i_wanted_page += 100*i_wanted_magazine;
208     }
209
210     p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
211     var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
212
213     p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
214     var_AddCallback( p_dec, "vbi-position", Position, p_sys );
215
216     p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
217 //    var_AddCallback( p_dec, "vbi-text", Text, p_sys );
218
219     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
220     if( p_sys->b_text )
221         p_dec->fmt_out.video.i_chroma = VLC_FOURCC('T','E','X','T');
222     else
223         p_dec->fmt_out.video.i_chroma = VLC_FOURCC('R','G','B','A');
224     return VLC_SUCCESS;
225 }
226
227 /*****************************************************************************
228  * Close:
229  *****************************************************************************/
230 static void Close( vlc_object_t *p_this )
231 {
232     decoder_t     *p_dec = (decoder_t*) p_this;
233     decoder_sys_t *p_sys = p_dec->p_sys;
234
235     var_DelCallback( p_dec, "vbi-position", Position, p_sys );
236     var_DelCallback( p_dec, "vbi-opaque", Opaque, p_sys );
237     var_DelCallback( p_dec, "vbi-page", RequestPage, p_sys );
238
239     vlc_mutex_destroy( &p_sys->lock );
240
241     if( p_sys->p_vbi_dec )
242         vbi_decoder_delete( p_sys->p_vbi_dec );
243     if( p_sys->p_dvb_demux )
244         vbi_dvb_demux_delete( p_sys->p_dvb_demux );
245     free( p_sys );
246 }
247
248 #define MAX_SLICES 32
249
250 #ifdef WORDS_BIGENDIAN
251 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
252 #else
253 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
254 #endif
255
256
257 /*****************************************************************************
258  * Decode:
259  *****************************************************************************/
260 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
261 {
262     decoder_sys_t   *p_sys = p_dec->p_sys;
263     block_t         *p_block;
264     subpicture_t    *p_spu = NULL;
265     video_format_t  fmt;
266     bool            b_cached = false;
267     vbi_page        p_page;
268     const uint8_t   *p_pos;
269     unsigned int    i_left;
270
271     if( (pp_block == NULL) || (*pp_block == NULL) )
272         return NULL;
273
274     p_block = *pp_block;
275     *pp_block = NULL;
276
277     p_pos = p_block->p_buffer;
278     i_left = p_block->i_buffer;
279
280     while( i_left > 0 )
281     {
282         vbi_sliced      p_sliced[MAX_SLICES];
283         unsigned int    i_lines = 0;
284         int64_t         i_pts;
285
286         i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
287                                      MAX_SLICES, &i_pts, &p_pos, &i_left );
288
289         if( i_lines > 0 )
290             vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
291     }
292
293     /* */
294     vlc_mutex_lock( &p_sys->lock );
295     const int i_align = p_sys->i_align;
296     const unsigned int i_wanted_page = p_sys->i_wanted_page;
297     const bool b_opaque = p_sys->b_opaque;
298     vlc_mutex_unlock( &p_sys->lock );
299
300
301     /* Try to see if the page we want is in the cache yet */
302     b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
303                                   vbi_dec2bcd( i_wanted_page ),
304                                   VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
305                                   25, FALSE );
306
307     if( i_wanted_page == p_sys->i_last_page && !p_sys->b_update )
308         goto error;
309
310     if( !b_cached )
311     {
312         if( p_sys->i_last_page != i_wanted_page )
313         {
314             /* We need to reset the subtitle */
315             p_spu = Subpicture( p_dec, &fmt, true,
316                                 p_page.columns, p_page.rows,
317                                 i_align, p_block->i_pts );
318             if( !p_spu )
319                 goto error;
320             p_spu->p_region->psz_text = strdup("");
321
322             p_sys->b_update = true;
323             p_sys->i_last_page = i_wanted_page;
324             goto exit;
325         }
326         goto error;
327     }
328
329     p_sys->b_update = false;
330     p_sys->i_last_page = i_wanted_page;
331 #ifdef ZVBI_DEBUG
332     msg_Dbg( p_dec, "we now have page: %d ready for display",
333              i_wanted_page );
334 #endif
335     /* If there is a page or sub to render, then we do that here */
336     /* Create the subpicture unit */
337     p_spu = Subpicture( p_dec, &fmt, p_sys->b_text,
338                         p_page.columns, p_page.rows,
339                         i_align, p_block->i_pts );
340     if( !p_spu )
341         goto error;
342
343     if( p_sys->b_text )
344     {
345         unsigned int i_textsize = 7000;
346         int i_total;
347         char p_text[i_textsize+1];
348
349         i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
350                         "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
351         p_text[i_total] = '\0';
352         /* Strip off the pagenumber */
353         if( i_total <= 40 )
354             goto error;
355         p_spu->p_region->psz_text = strdup( &p_text[8] );
356
357 #ifdef ZVBI_DEBUG
358         msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
359 #endif
360     }
361     else
362     {
363         picture_t *p_pic = &p_spu->p_region->picture;
364
365         /* ZVBI is stupid enough to assume pitch == width */
366         p_pic->p->i_pitch = 4 * fmt.i_width;
367         vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
368                           p_spu->p_region->picture.p->p_pixels, 1, 1 );
369
370         OpaquePage( p_pic, p_page, fmt, b_opaque );
371     }
372
373 exit:
374     vbi_unref_page( &p_page );
375     block_Release( p_block );
376     return p_spu;
377
378 error:
379     vbi_unref_page( &p_page );
380     if( p_spu != NULL )
381     {
382         p_dec->pf_spu_buffer_del( p_dec, p_spu );
383         p_spu = NULL;
384     }
385
386     block_Release( p_block );
387     return NULL;
388 }
389
390 static subpicture_t *Subpicture( decoder_t *p_dec, video_format_t *p_fmt,
391                                  bool b_text,
392                                  int i_columns, int i_rows, int i_align,
393                                  mtime_t i_pts )
394 {
395     video_format_t fmt;
396     subpicture_t *p_spu;
397
398     /* If there is a page or sub to render, then we do that here */
399     /* Create the subpicture unit */
400     p_spu = p_dec->pf_spu_buffer_new( p_dec );
401     if( !p_spu )
402     {
403         msg_Warn( p_dec, "can't get spu buffer" );
404         return NULL;
405     }
406
407     memset( &fmt, 0, sizeof(video_format_t) );
408     fmt.i_chroma = b_text ? VLC_FOURCC('T','E','X','T') :
409                                    VLC_FOURCC('R','G','B','A');
410     fmt.i_aspect = b_text ? 0 : VOUT_ASPECT_FACTOR;
411     if( b_text )
412     {
413         fmt.i_bits_per_pixel = 0;
414     }
415     else
416     {
417         fmt.i_sar_num = fmt.i_sar_den = 1;
418         fmt.i_width = fmt.i_visible_width = i_columns * 12;
419         fmt.i_height = fmt.i_visible_height = i_rows * 10;
420         fmt.i_bits_per_pixel = 32;
421     }
422     fmt.i_x_offset = fmt.i_y_offset = 0;
423
424     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
425     if( p_spu->p_region == NULL )
426     {
427         msg_Err( p_dec, "cannot allocate SPU region" );
428         p_dec->pf_spu_buffer_del( p_dec, p_spu );
429         return NULL;
430     }
431
432     p_spu->p_region->i_x = 0;
433     p_spu->p_region->i_y = 0;
434     p_spu->p_region->i_align = i_align;
435
436     /* Normal text subs, easy markup */
437     p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM;
438
439     p_spu->i_start = i_pts;
440     p_spu->i_stop = 0;
441     p_spu->b_ephemer = true;
442     p_spu->b_absolute = false;
443     p_spu->b_pausable = true;
444
445
446     if( !b_text )
447     {
448         p_spu->i_width =
449         p_spu->i_original_picture_width = fmt.i_width;
450         p_spu->i_height =
451         p_spu->i_original_picture_height = fmt.i_height;
452     }
453
454     /* */
455     *p_fmt = fmt;
456     return p_spu;
457 }
458
459 static void EventHandler( vbi_event *ev, void *user_data )
460 {
461     decoder_t *p_dec        = (decoder_t *)user_data;
462     decoder_sys_t *p_sys    = p_dec->p_sys;
463
464     if( ev->type == VBI_EVENT_TTX_PAGE )
465     {
466 #ifdef ZVBI_DEBUG
467         msg_Info( p_dec, "Page %03x.%02x ",
468                     ev->ev.ttx_page.pgno,
469                     ev->ev.ttx_page.subno & 0xFF);
470 #endif
471         if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
472             p_sys->b_update = true;
473
474         if( ev->ev.ttx_page.clock_update )
475             msg_Dbg( p_dec, "clock" );
476 #ifdef ZVBI_DEBUG
477         if( ev->ev.ttx_page.header_update )
478             msg_Dbg( p_dec, "header" );
479 #endif
480     }
481     else if( ev->type == VBI_EVENT_CAPTION )
482         msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
483     else if( ev->type == VBI_EVENT_NETWORK )
484         msg_Dbg( p_dec, "Network change" );
485     else if( ev->type == VBI_EVENT_ASPECT )
486         msg_Dbg( p_dec, "Aspect update" );
487     else if( ev->type == VBI_EVENT_NETWORK )
488         msg_Dbg( p_dec, "Program info received" );
489 }
490
491 static int OpaquePage( picture_t *p_src, const vbi_page p_page,
492                        const video_format_t fmt, bool b_opaque )
493 {
494     unsigned int    x, y;
495
496     assert( fmt.i_chroma == VLC_FOURCC('R','G','B','A' ) );
497
498     /* Kludge since zvbi doesn't provide an option to specify opacity. */
499     for( y = 0; y < fmt.i_height; y++ )
500     {
501         for( x = 0; x < fmt.i_width; x++ )
502         {
503             const vbi_opacity opacity = p_page.text[ y/10 * p_page.columns + x/12 ].opacity;
504             uint32_t *p_pixel = (uint32_t*)&p_src->p->p_pixels[y * p_src->p->i_pitch + 4*x];
505             switch( opacity )
506             {
507             /* Show video instead of this character */
508             case VBI_TRANSPARENT_SPACE:
509                 *p_pixel = 0;
510                 break;
511             /* To make the boxed text "closed captioning" transparent
512              * change true to false.
513              */
514             case VBI_OPAQUE:
515                 if( b_opaque )
516                     break;
517             /* Full text transparency. only foreground color is show */
518             case VBI_TRANSPARENT_FULL:
519                 *p_pixel = 0;
520                 break;
521             /* Transparency for boxed text */
522             case VBI_SEMI_TRANSPARENT:
523                 if( (*p_pixel) == 0xff000000 && 0 ) /* Disabled until someone implement borders */
524                     *p_pixel = 0;
525                 break;
526             }
527         }
528     }
529     /* end of kludge */
530     return VLC_SUCCESS;
531 }
532
533 /* Callbacks */
534 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
535                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
536 {
537     decoder_sys_t *p_sys = p_data;
538     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
539
540     vlc_mutex_lock( &p_sys->lock );
541     if( newval.i_int > 0 && newval.i_int < 999 )
542         p_sys->i_wanted_page = newval.i_int;
543     vlc_mutex_unlock( &p_sys->lock );
544
545     return VLC_SUCCESS;
546 }
547
548 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
549                    vlc_value_t oldval, vlc_value_t newval, void *p_data )
550 {
551     decoder_sys_t *p_sys = p_data;
552     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
553
554     vlc_mutex_lock( &p_sys->lock );
555     p_sys->b_opaque = newval.b_bool;
556     vlc_mutex_unlock( &p_sys->lock );
557
558     return VLC_SUCCESS;
559 }
560
561 static int Position( vlc_object_t *p_this, char const *psz_cmd,
562                      vlc_value_t oldval, vlc_value_t newval, void *p_data )
563 {
564     decoder_sys_t *p_sys = p_data;
565     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
566
567     vlc_mutex_lock( &p_sys->lock );
568     p_sys->i_align = newval.i_int;
569     vlc_mutex_unlock( &p_sys->lock );
570
571     return VLC_SUCCESS;
572 }