e1dccc7013224097bdb574f543ee7c67c1ae9bf8
[vlc.git] / 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/vlc.h>
45 #include <assert.h>
46 #include <stdint.h>
47 #include <libzvbi.h>
48
49 #include "vlc_vout.h"
50 #include "vlc_bits.h"
51 #include "vlc_codec.h"
52 #include "vlc_image.h"
53
54 typedef enum {
55     DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE     = 0x02,
56     DATA_UNIT_EBU_TELETEXT_SUBTITLE         = 0x03,
57     DATA_UNIT_EBU_TELETEXT_INVERTED         = 0x0C,
58
59     DATA_UNIT_ZVBI_WSS_CPR1204              = 0xB4,
60     DATA_UNIT_ZVBI_CLOSED_CAPTION_525       = 0xB5,
61     DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525   = 0xB6,
62
63     DATA_UNIT_VPS                           = 0xC3,
64     DATA_UNIT_WSS                           = 0xC4,
65     DATA_UNIT_CLOSED_CAPTION                = 0xC5,
66     DATA_UNIT_MONOCHROME_SAMPLES            = 0xC6,
67
68     DATA_UNIT_STUFFING                      = 0xFF,
69 } data_unit_id;
70
71 /*****************************************************************************
72  * Module descriptor.
73  *****************************************************************************/
74 static int  Open ( vlc_object_t * );
75 static void Close( vlc_object_t * );
76 static subpicture_t *Decode( decoder_t *, block_t ** );
77
78 #define PAGE_TEXT N_("Teletext page")
79 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
80         "Default page is index 100")
81
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." )
85
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).")
91
92 #define TELX_TEXT N_("Teletext text subtitles")
93 #define TELX_LONGTEXT N_( "Output teletext subtitles as text " \
94   "instead of as RGBA" )
95
96 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
97 static const char *ppsz_pos_descriptions[] =
98 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
99   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
100
101 vlc_module_begin();
102     set_description( _("VBI and Teletext decoder") );
103     set_shortname( "VBI & Teletext" );
104     set_capability( "decoder", 51 );
105     set_category( CAT_INPUT );
106     set_subcategory( SUBCAT_INPUT_SCODEC );
107     set_callbacks( Open, Close );
108
109     add_integer( "vbi-page", 100, NULL,
110                  PAGE_TEXT, PAGE_LONGTEXT, VLC_FALSE );
111     add_bool( "vbi-opaque", VLC_TRUE, NULL,
112                  OPAQUE_TEXT, OPAQUE_LONGTEXT, VLC_FALSE );
113     add_integer( "vbi-position", 4, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
114         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
115     add_bool( "vbi-text", VLC_FALSE, NULL,
116               TELX_TEXT, TELX_LONGTEXT, VLC_FALSE );
117 vlc_module_end();
118
119 /****************************************************************************
120  * Local structures
121  ****************************************************************************/
122
123 struct decoder_sys_t
124 {
125     vbi_decoder *           p_vbi_dec;
126     vbi_dvb_demux *         p_dvb_demux;
127     unsigned int            i_wanted_page;
128     unsigned int            i_last_page;
129     vlc_bool_t              b_update;
130     vlc_bool_t              b_opaque;
131
132     /* Subtitles as text */
133     vlc_bool_t              b_text;
134
135     /* Positioning of Teletext images */
136     int                     i_align;
137
138     /* Misc */
139 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H)
140     image_handler_t         *p_image;
141 #endif
142 };
143
144 static void event_handler( vbi_event *ev, void *user_data );
145 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
146                         vlc_value_t oldval, vlc_value_t newval, void *p_data );
147 static int OpaquePage( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
148                         picture_t **p_src );
149 static int Opaque_32bpp( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
150                         picture_t **p_src );
151 static int Opaque_8bpp( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
152                         picture_t **p_src );
153
154 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
155                    vlc_value_t oldval, vlc_value_t newval, void *p_data );
156 static int Position( vlc_object_t *p_this, char const *psz_cmd,
157                      vlc_value_t oldval, vlc_value_t newval, void *p_data );
158
159 /*****************************************************************************
160  * Open: probe the decoder and return score
161  *****************************************************************************
162  * Tries to launch a decoder and return score so that the interface is able
163  * to chose.
164  *****************************************************************************/
165 static int Open( vlc_object_t *p_this )
166 {
167     decoder_t     *p_dec = (decoder_t *) p_this;
168     decoder_sys_t *p_sys = NULL;
169
170     if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
171     {
172         return VLC_EGENERIC;
173     }
174
175     p_dec->pf_decode_sub = Decode;
176     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
177     if( p_sys == NULL )
178     {
179         msg_Err( p_dec, "out of memory" );
180         return VLC_ENOMEM;
181     }
182     memset( p_sys, 0, sizeof(decoder_sys_t) );
183
184 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H)
185     p_sys->p_image = image_HandlerCreate( VLC_OBJECT(p_dec) );
186     if( !p_sys->p_image )
187     {
188         free( p_sys );
189         msg_Err( p_dec, "out of memory" );
190         return VLC_ENOMEM;
191     }
192 #endif
193
194     p_sys->b_update = VLC_FALSE;
195     p_sys->p_vbi_dec = vbi_decoder_new();
196     p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
197
198     if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
199     {
200         msg_Err( p_dec, "VBI decoder/demux could not be created." );
201         Close( p_this );
202         return VLC_ENOMEM;
203     }
204
205     vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
206                                 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
207                                 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
208                                 event_handler, p_dec );
209
210     /* Create the var on vlc_global. */
211     p_sys->i_wanted_page = var_CreateGetInteger( p_dec, "vbi-page" );
212     var_AddCallback( p_dec, "vbi-page",
213                      RequestPage, p_sys );
214
215     p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
216     var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
217
218     p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
219     var_AddCallback( p_dec, "vbi-position", Position, p_sys );
220
221     p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
222 //    var_AddCallback( p_dec, "vbi-text", Text, p_sys );
223
224     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
225     if( p_sys->b_text )
226         p_dec->fmt_out.video.i_chroma = VLC_FOURCC('T','E','X','T');
227     else
228 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H)
229         p_dec->fmt_out.video.i_chroma = VLC_FOURCC('Y','U','V','A');
230 #else
231         p_dec->fmt_out.video.i_chroma = VLC_FOURCC('R','G','B','A');
232 #endif
233     return VLC_SUCCESS;
234 }
235
236 /*****************************************************************************
237  * Close:
238  *****************************************************************************/
239 static void Close( vlc_object_t *p_this )
240 {
241     decoder_t     *p_dec = (decoder_t*) p_this;
242     decoder_sys_t *p_sys = p_dec->p_sys;
243
244     var_Destroy( p_dec, "vbi-opaque" );
245     var_Destroy( p_dec, "vbi-page" );
246     var_DelCallback( p_dec, "vbi-page", RequestPage, p_sys );
247     var_DelCallback( p_dec, "vbi-opaque", Opaque, p_sys );
248
249 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H)
250     if( p_sys->p_image ) image_HandlerDelete( p_sys->p_image );
251 #endif
252     if( p_sys->p_vbi_dec ) vbi_decoder_delete( p_sys->p_vbi_dec );
253     if( p_sys->p_dvb_demux ) vbi_dvb_demux_delete( p_sys->p_dvb_demux );
254     free( p_sys );
255 }
256
257 #define MAX_SLICES 32
258
259 /*****************************************************************************
260  * Decode:
261  *****************************************************************************/
262 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
263 {
264     decoder_sys_t   *p_sys = (decoder_sys_t *) p_dec->p_sys;
265     block_t         *p_block;
266     subpicture_t    *p_spu = NULL;
267     video_format_t  fmt;
268     vlc_bool_t      b_cached = VLC_FALSE;
269     vbi_page        p_page;
270     const uint8_t   *p_pos;
271     unsigned int    i_left;
272
273     if( (pp_block == NULL) || (*pp_block == NULL) )
274         return NULL;
275
276     p_block = *pp_block;
277     *pp_block = NULL;
278
279     p_pos = p_block->p_buffer;
280     i_left = p_block->i_buffer;
281
282     while( i_left > 0 )
283     {
284         vbi_sliced      p_sliced[MAX_SLICES];
285         unsigned int    i_lines = 0;
286         int64_t         i_pts;
287
288         i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
289                                      MAX_SLICES, &i_pts, &p_pos, &i_left );
290
291         if( i_lines > 0 )
292             vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
293     }
294
295     /* Try to see if the page we want is in the cache yet */
296     b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
297                                   vbi_dec2bcd( p_sys->i_wanted_page ),
298                                   VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
299                                   25, FALSE );
300
301     if( !b_cached )
302         goto error;
303
304     if( ( p_sys->i_wanted_page == p_sys->i_last_page ) &&
305         ( p_sys->b_update != VLC_TRUE ) )
306         goto error;
307
308     p_sys->b_update = VLC_FALSE;
309     p_sys->i_last_page = p_sys->i_wanted_page;
310 #if 0
311     msg_Dbg( p_dec, "we now have page: %d ready for display",
312               p_sys->i_wanted_page );
313 #endif
314     /* If there is a page or sub to render, then we do that here */
315     /* Create the subpicture unit */
316     p_spu = p_dec->pf_spu_buffer_new( p_dec );
317     if( !p_spu )
318     {
319         msg_Warn( p_dec, "can't get spu buffer" );
320         goto error;
321     }
322
323     /* Create a new subpicture region */
324     memset( &fmt, 0, sizeof(video_format_t) );
325     fmt.i_chroma = p_sys->b_text ? VLC_FOURCC('T','E','X','T') :
326 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H)
327                                    VLC_FOURCC('Y','U','V','A');
328 #else
329                                    VLC_FOURCC('R','G','B','A');
330 #endif
331     fmt.i_aspect = p_sys->b_text ? 0 : VOUT_ASPECT_FACTOR;
332     fmt.i_sar_num = fmt.i_sar_den = 1;
333     fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
334     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;
337
338     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
339     if( p_spu->p_region == NULL )
340     {
341         msg_Err( p_dec, "cannot allocate SPU region" );
342         goto error;
343     }
344
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;
348
349     /* Normal text subs, easy markup */
350     p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM;
351
352     p_spu->i_start = (mtime_t) p_block->i_dts;
353     p_spu->i_stop = (mtime_t) 0;
354     p_spu->b_ephemer = VLC_TRUE;
355     p_spu->b_absolute = VLC_FALSE;
356     p_spu->b_pausable = VLC_TRUE;
357     p_spu->i_width = fmt.i_width;
358     p_spu->i_height = fmt.i_height;
359     p_spu->i_original_picture_width = p_page.columns * 12;
360     p_spu->i_original_picture_height = p_page.rows * 10;
361
362 #ifdef WORDS_BIGENDIAN
363 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
364 #else
365 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
366 #endif
367
368     if( p_sys->b_text )
369     {
370         unsigned int i_textsize = 7000;
371         int i_total;
372         char p_text[7000];
373
374         i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
375                         "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
376         p_text[i_total] = '\0';
377         /* Strip off the pagenumber */
378         if( i_total <= 40 ) goto error;
379         p_spu->p_region->psz_text = strdup( &p_text[8] );
380
381         p_spu->p_region->fmt.i_height = p_spu->p_region->fmt.i_visible_height = p_page.rows + 1;
382         msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
383     }
384     else
385     {
386 #if defined(HAVE_FFMPEG_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H) || defined(HAVE_LIBSWSCALE_SWSCALE_H)
387         video_format_t fmt_in;
388         picture_t *p_pic, *p_dest;
389
390         p_pic = ( picture_t * ) malloc( sizeof( picture_t ) );
391         if( !p_pic )
392         {
393             msg_Err( p_dec, "out of memory" );
394             goto error;
395         }
396
397         memset( &fmt_in, 0, sizeof( video_format_t ) );
398         memset( p_pic, 0, sizeof( picture_t ) );
399
400         fmt_in = fmt;
401         fmt_in.i_chroma = VLC_FOURCC('R','G','B','A');
402
403         vout_AllocatePicture( VLC_OBJECT(p_dec), p_pic, fmt_in.i_chroma,
404                         fmt_in.i_width, fmt_in.i_height, fmt_in.i_aspect );
405         if( !p_pic->i_planes )
406         {
407             free( p_pic->p_data_orig );
408             free( p_pic );
409             goto error;
410         }
411
412         vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
413                           p_pic->p->p_pixels, 1, 1 );
414
415         p_pic->p->i_lines = p_page.rows * 10;
416         p_pic->p->i_pitch = p_page.columns * 12 * 4;
417
418 #if 0
419         msg_Dbg( p_dec, "page %x-%x(%d,%d)",
420                  p_page.pgno, p_page.subno,
421                  p_page.rows, p_page.columns );
422 #endif
423         p_dest = image_Convert( p_sys->p_image, p_pic, &fmt_in,
424                                 &p_spu->p_region->fmt );
425         if( !p_dest )
426         {
427             free( p_pic->p_data_orig );
428             free( p_pic );
429             msg_Err( p_dec, "chroma conversion failed" );
430             goto error;
431         }
432         OpaquePage( p_dec, p_page, p_spu->p_region->fmt, &p_dest );
433         vout_CopyPicture( VLC_OBJECT(p_dec), &(p_spu->p_region->picture),
434                           p_dest );
435
436         free( p_pic->p_data_orig );
437         free( p_pic );
438
439         free( p_dest->p_data_orig );
440         free( p_dest );
441 #else
442         picture_t *p_pic;
443
444         vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
445                           p_spu->p_region->picture.p->p_pixels, 1, 1 );
446
447         p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
448         p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
449
450         p_pic = &(p_spu->p_region->picture);
451         OpaquePage( p_dec, p_page, fmt, &p_pic );
452 #endif
453     }
454
455 #undef PIXFMT_RGBA32
456
457     vbi_unref_page( &p_page );
458     block_Release( p_block );
459     return p_spu;
460
461 error:
462     vbi_unref_page( &p_page );
463     if( p_spu != NULL )
464     {
465         p_dec->pf_spu_buffer_del( p_dec, p_spu );
466         p_spu = NULL;
467     }
468
469     block_Release( p_block );
470     return NULL;
471 }
472
473 static void event_handler( vbi_event *ev, void *user_data )
474 {
475     decoder_t *p_dec        = (decoder_t *)user_data;
476     decoder_sys_t *p_sys    = p_dec->p_sys;
477
478     if( ev->type == VBI_EVENT_TTX_PAGE )
479     {
480         /* msg_Info( p_dec, "Page %03x.%02x ",
481                     ev->ev.ttx_page.pgno,
482                     ev->ev.ttx_page.subno & 0xFF);
483         */
484         if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
485             p_sys->b_update = VLC_TRUE;
486
487         if( ev->ev.ttx_page.clock_update )
488             msg_Dbg( p_dec, "clock" );
489 /*        if( ev->ev.ttx_page.header_update )
490             msg_Dbg( p_dec, "header" );
491 */
492     }
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" );
501 }
502
503 static int OpaquePage( decoder_t *p_dec, vbi_page p_page,
504                        video_format_t fmt, picture_t **p_src )
505 {
506     int result = VLC_EGENERIC;
507
508     /* Kludge since zvbi doesn't provide an option to specify opacity. */
509     switch( fmt.i_chroma )
510     {
511         case VLC_FOURCC('R','G','B','A' ):
512             result = Opaque_32bpp( p_dec, p_page, fmt, p_src );
513             break;
514         case VLC_FOURCC('Y','U','V','A' ):
515             result = Opaque_8bpp( p_dec, p_page, fmt, p_src );
516             break;
517         default:
518             msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
519             return VLC_EGENERIC;
520     }
521     return result;
522 }
523
524 static int Opaque_32bpp( decoder_t *p_dec, vbi_page p_page,
525                          video_format_t fmt, picture_t **p_src )
526 {
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;
530     vbi_opacity     opacity;
531
532     /* Kludge since zvbi doesn't provide an option to specify opacity. */
533     switch( fmt.i_chroma )
534     {
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 );
539             break;
540         default:
541             msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
542             return VLC_EGENERIC;
543     }
544
545     for( ; p_begin < p_end; p_begin++ )
546     {
547         opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
548         switch( opacity )
549         {
550         /* Show video instead of this character */
551         case VBI_TRANSPARENT_SPACE:
552             *p_begin = 0;
553             break;
554         /* To make the boxed text "closed captioning" transparent
555          * change VLC_TRUE to VLC_FALSE.
556          */
557         case VBI_OPAQUE:
558             if( p_sys->b_opaque )
559                 break;
560         /* Full text transparency. only foreground color is show */
561         case VBI_TRANSPARENT_FULL:
562             *p_begin = 0;
563             break;
564         /* Transparency for boxed text */
565         case VBI_SEMI_TRANSPARENT:
566             if( (*p_begin & 0xffffff00) == 0xff )
567                 *p_begin = 0;
568             break;
569         }
570         x++;
571         if( x >= fmt.i_width )
572         {
573             x = 0;
574             y++;
575         }
576     }
577     /* end of kludge */
578     return VLC_SUCCESS;
579 }
580
581 static int Opaque_8bpp( decoder_t *p_dec, vbi_page p_page,
582                         video_format_t fmt, picture_t **p_src )
583 {
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;
588     vbi_opacity     opacity;
589
590     /* Kludge since zvbi doesn't provide an option to specify opacity. */
591     switch( fmt.i_chroma )
592     {
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;
598             break;
599         default:
600             msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
601             return VLC_EGENERIC;
602     }
603
604     for( ; p_begin < p_end; p_begin++ )
605     {
606         opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
607         switch( opacity )
608         {
609         /* Show video instead of this character */
610         case VBI_TRANSPARENT_SPACE:
611             *p_begin = 0;
612             break;
613         /* To make the boxed text "closed captioning" transparent
614          * change VLC_TRUE to VLC_FALSE.
615          */
616         case VBI_OPAQUE:
617             if( p_sys->b_opaque )
618                 break;
619         /* Full text transparency. only foreground color is show */
620         case VBI_TRANSPARENT_FULL:
621             *p_begin = 0;
622             break;
623         /* Transparency for boxed text */
624         case VBI_SEMI_TRANSPARENT:
625             if( (*p_begin & 0xffffff00) == 0xff )
626                 *p_begin = 0;
627             break;
628         }
629         x++;
630         if( x >= i_width )
631         {
632             x = 0;
633             y++;
634         }
635     }
636     /* end of kludge */
637     return VLC_SUCCESS;
638 }
639
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 )
642 {
643     decoder_sys_t   *p_sys = p_data;
644
645     if( (newval.i_int > 0) && (newval.i_int < 999) )
646         p_sys->i_wanted_page = newval.i_int;
647
648     return VLC_SUCCESS;
649 }
650
651 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
652                    vlc_value_t oldval, vlc_value_t newval, void *p_data )
653 {
654     decoder_sys_t *p_sys = p_data;
655
656     if( p_sys )
657         p_sys->b_opaque = newval.b_bool;
658     return VLC_SUCCESS;
659 }
660
661 static int Position( vlc_object_t *p_this, char const *psz_cmd,
662                      vlc_value_t oldval, vlc_value_t newval, void *p_data )
663 {
664     decoder_sys_t *p_sys = p_data;
665
666     if( p_sys )
667         p_sys->i_align = newval.i_int;
668     return VLC_SUCCESS;
669 }