git.sesse.net Git - vlc/blob - 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_codec.h>
  50 #include <vlc_osd.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 //Guessing table for missing "default region triplet"
 106 static const int pi_default_triplet[] = {
 107  0, 0,           // slo cze
 108  8,              // pol
 109  24,24,24,24,    //ssc scr slv rum
 110  32,32,32,32,32, //est lit rus bul ukr
 111  48,48,          //gre ell
 112  64,             //ara
 113  88,             //heb
 114  16 };           //default
 115 static const char *const ppsz_default_triplet[] = {
 116  "slo", "cze",
 117  "pol",
 118  "ssc", "scr", "slv", "rum",
 119  "est", "lit", "rus", "bul", "ukr",
 120  "gre", "ell",
 121  "ara",
 122  "heb",
 123  NULL
 124 };
 125
 126 typedef enum {
 127     ZVBI_KEY_RED    = 'r' << 16,
 128     ZVBI_KEY_GREEN  = 'g' << 16,
 129     ZVBI_KEY_YELLOW = 'y' << 16,
 130     ZVBI_KEY_BLUE   = 'b' << 16,
 131     ZVBI_KEY_INDEX  = 'i' << 16,
 132 } ttxt_key_id;
 133
 134 typedef enum {
 135     DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE     = 0x02,
 136     DATA_UNIT_EBU_TELETEXT_SUBTITLE         = 0x03,
 137     DATA_UNIT_EBU_TELETEXT_INVERTED         = 0x0C,
 138
 139     DATA_UNIT_ZVBI_WSS_CPR1204              = 0xB4,
 140     DATA_UNIT_ZVBI_CLOSED_CAPTION_525       = 0xB5,
 141     DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525   = 0xB6,
 142
 143     DATA_UNIT_VPS                           = 0xC3,
 144     DATA_UNIT_WSS                           = 0xC4,
 145     DATA_UNIT_CLOSED_CAPTION                = 0xC5,
 146     DATA_UNIT_MONOCHROME_SAMPLES            = 0xC6,
 147
 148     DATA_UNIT_STUFFING                      = 0xFF,
 149 } data_unit_id;
 150
 151 struct decoder_sys_t
 152 {
 153     vbi_decoder *     p_vbi_dec;
 154     vbi_dvb_demux *   p_dvb_demux;
 155     unsigned int      i_last_page;
 156     bool              b_update;
 157     bool              b_text;   /* Subtitles as text */
 158
 159     vlc_mutex_t       lock; /* Lock to protect the following variables */
 160     /* Positioning of Teletext images */
 161     int               i_align;
 162     /* */
 163     unsigned int      i_wanted_page;
 164     unsigned int      i_wanted_subpage;
 165     /* */
 166     bool              b_opaque;
 167     struct {
 168         int pgno, subno;
 169     }                 nav_link[6];
 170     int               i_key[3];
 171 };
 172
 173 static subpicture_t *Decode( decoder_t *, block_t ** );
 174
 175 static subpicture_t *Subpicture( decoder_t *p_dec, video_format_t *p_fmt,
 176                                  bool b_text,
 177                                  int i_columns, int i_rows,
 178                                  int i_align, mtime_t i_pts );
 179
 180 static void EventHandler( vbi_event *ev, void *user_data );
 181 static int OpaquePage( picture_t *p_src, const vbi_page p_page,
 182                        const video_format_t fmt, bool b_opaque );
 183
 184 /* Properties callbacks */
 185 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 186                         vlc_value_t oldval, vlc_value_t newval, void *p_data );
 187 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
 188                    vlc_value_t oldval, vlc_value_t newval, void *p_data );
 189 static int Position( vlc_object_t *p_this, char const *psz_cmd,
 190                      vlc_value_t oldval, vlc_value_t newval, void *p_data );
 191 static int EventKey( vlc_object_t *p_this, char const *psz_cmd,
 192                      vlc_value_t oldval, vlc_value_t newval, void *p_data );
 193
 194 /*****************************************************************************
 195  * Open: probe the decoder and return score
 196  *****************************************************************************
 197  * Tries to launch a decoder and return score so that the interface is able
 198  * to chose.
 199  *****************************************************************************/
 200 static int Open( vlc_object_t *p_this )
 201 {
 202     decoder_t     *p_dec = (decoder_t *) p_this;
 203     decoder_sys_t *p_sys = NULL;
 204
 205     if( p_dec->fmt_in.i_codec != VLC_CODEC_TELETEXT )
 206         return VLC_EGENERIC;
 207
 208     p_dec->pf_decode_sub = Decode;
 209     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
 210     if( p_sys == NULL )
 211         return VLC_ENOMEM;
 212     memset( p_sys, 0, sizeof(decoder_sys_t) );
 213
 214     p_sys->i_key[0] = p_sys->i_key[1] = p_sys->i_key[2] = '*' - '0';
 215     p_sys->b_update = false;
 216     p_sys->p_vbi_dec = vbi_decoder_new();
 217     p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
 218     vlc_mutex_init( &p_sys->lock );
 219
 220     if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
 221     {
 222         msg_Err( p_dec, "VBI decoder/demux could not be created." );
 223         Close( p_this );
 224         return VLC_ENOMEM;
 225     }
 226
 227     /* Some broadcasters in countries with level 1 and level 1.5 still not send a G0 to do
 228      * matches against table 32 of ETSI 300 706. We try to do some best effort guessing
 229      * This is not perfect, but might handle some cases where we know the vbi language
 230      * is known. It would be better if people started sending G0 */
 231     for( int i = 0; ppsz_default_triplet[i] != NULL; i++ )
 232     {
 233         if( p_dec->fmt_in.psz_language && !strcasecmp( p_dec->fmt_in.psz_language, ppsz_default_triplet[i] ) )
 234         {
 235             vbi_teletext_set_default_region( p_sys->p_vbi_dec, pi_default_triplet[i]);
 236             msg_Dbg( p_dec, "overwriting default zvbi region: %d", pi_default_triplet[i] );
 237         }
 238     }
 239
 240     vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE | VBI_EVENT_NETWORK |
 241 #ifdef ZVBI_DEBUG
 242                                 VBI_EVENT_CAPTION | VBI_EVENT_TRIGGER |
 243                                 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO | VBI_EVENT_NETWORK_ID |
 244 #endif
 245                                 0 , EventHandler, p_dec );
 246
 247     /* Create the var on vlc_global. */
 248     p_sys->i_wanted_page = var_CreateGetInteger( p_dec, "vbi-page" );
 249     var_AddCallback( p_dec, "vbi-page",
 250                      RequestPage, p_sys );
 251
 252     /* Check if the Teletext track has a known "initial page". */
 253     if( p_sys->i_wanted_page == 100 && p_dec->fmt_in.subs.teletext.i_magazine != -1 )
 254     {
 255         p_sys->i_wanted_page = 100 * p_dec->fmt_in.subs.teletext.i_magazine +
 256                                vbi_bcd2dec( p_dec->fmt_in.subs.teletext.i_page );
 257         var_SetInteger( p_dec, "vbi-page", p_sys->i_wanted_page );
 258     }
 259     p_sys->i_wanted_subpage = VBI_ANY_SUBNO;
 260
 261     p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
 262     var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
 263
 264     p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
 265     var_AddCallback( p_dec, "vbi-position", Position, p_sys );
 266
 267     p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
 268 //    var_AddCallback( p_dec, "vbi-text", Text, p_sys );
 269
 270     /* Listen for keys */
 271     var_AddCallback( p_dec->p_libvlc, "key-pressed", EventKey, p_dec );
 272
 273     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_CODEC_SPU );
 274     if( p_sys->b_text )
 275         p_dec->fmt_out.video.i_chroma = VLC_CODEC_TEXT;
 276     else
 277         p_dec->fmt_out.video.i_chroma = VLC_CODEC_RGBA;
 278     return VLC_SUCCESS;
 279 }
 280
 281 /*****************************************************************************
 282  * Close:
 283  *****************************************************************************/
 284 static void Close( vlc_object_t *p_this )
 285 {
 286     decoder_t     *p_dec = (decoder_t*) p_this;
 287     decoder_sys_t *p_sys = p_dec->p_sys;
 288
 289     var_DelCallback( p_dec, "vbi-position", Position, p_sys );
 290     var_DelCallback( p_dec, "vbi-opaque", Opaque, p_sys );
 291     var_DelCallback( p_dec, "vbi-page", RequestPage, p_sys );
 292     var_DelCallback( p_dec->p_libvlc, "key-pressed", EventKey, p_dec );
 293
 294     vlc_mutex_destroy( &p_sys->lock );
 295
 296     if( p_sys->p_vbi_dec )
 297         vbi_decoder_delete( p_sys->p_vbi_dec );
 298     if( p_sys->p_dvb_demux )
 299         vbi_dvb_demux_delete( p_sys->p_dvb_demux );
 300     free( p_sys );
 301 }
 302
 303 #define MAX_SLICES 32
 304
 305 #ifdef WORDS_BIGENDIAN
 306 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
 307 #else
 308 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
 309 #endif
 310
 311
 312 /*****************************************************************************
 313  * Decode:
 314  *****************************************************************************/
 315 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 316 {
 317     decoder_sys_t   *p_sys = p_dec->p_sys;
 318     block_t         *p_block;
 319     subpicture_t    *p_spu = NULL;
 320     video_format_t  fmt;
 321     bool            b_cached = false;
 322     vbi_page        p_page;
 323     const uint8_t   *p_pos;
 324     unsigned int    i_left;
 325     int64_t         i_pts = 0;
 326
 327     if( (pp_block == NULL) || (*pp_block == NULL) )
 328         return NULL;
 329
 330     p_block = *pp_block;
 331     *pp_block = NULL;
 332
 333     p_pos = p_block->p_buffer;
 334     i_left = p_block->i_buffer;
 335
 336     while( i_left > 0 )
 337     {
 338         vbi_sliced      p_sliced[MAX_SLICES];
 339         unsigned int    i_lines = 0;
 340
 341         i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
 342                                      MAX_SLICES, &i_pts, &p_pos, &i_left );
 343
 344         if( i_lines > 0 )
 345             vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
 346     }
 347
 348     /* */
 349     vlc_mutex_lock( &p_sys->lock );
 350     const int i_align = p_sys->i_align;
 351     const unsigned int i_wanted_page = p_sys->i_wanted_page;
 352     const unsigned int i_wanted_subpage = p_sys->i_wanted_subpage;
 353     const bool b_opaque = p_sys->b_opaque;
 354     vlc_mutex_unlock( &p_sys->lock );
 355
 356     /* Try to see if the page we want is in the cache yet */
 357     memset( &p_page, 0, sizeof(vbi_page) );
 358     b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
 359                                   vbi_dec2bcd( i_wanted_page ),
 360                                   i_wanted_subpage, VBI_WST_LEVEL_3p5,
 361                                   25, true );
 362
 363     if( i_wanted_page == p_sys->i_last_page && !p_sys->b_update )
 364         goto error;
 365
 366     i_pts = i_pts ? i_pts : p_block->i_pts;
 367     if( !b_cached )
 368     {
 369         if( p_sys->i_last_page != i_wanted_page )
 370         {
 371             /* We need to reset the subtitle */
 372             p_spu = Subpicture( p_dec, &fmt, true,
 373                                 p_page.columns, p_page.rows,
 374                                 i_align, i_pts );
 375             if( !p_spu )
 376                 goto error;
 377             p_spu->p_region->psz_text = strdup("");
 378
 379             p_sys->b_update = true;
 380             p_sys->i_last_page = i_wanted_page;
 381             goto exit;
 382         }
 383         goto error;
 384     }
 385
 386     p_sys->b_update = false;
 387     p_sys->i_last_page = i_wanted_page;
 388 #ifdef ZVBI_DEBUG
 389     msg_Dbg( p_dec, "we now have page: %d ready for display",
 390              i_wanted_page );
 391 #endif
 392     /* If there is a page or sub to render, then we do that here */
 393     /* Create the subpicture unit */
 394     p_spu = Subpicture( p_dec, &fmt, p_sys->b_text,
 395                         p_page.columns, p_page.rows,
 396                         i_align, i_pts );
 397     if( !p_spu )
 398         goto error;
 399
 400     if( p_sys->b_text )
 401     {
 402         unsigned int i_textsize = 7000;
 403         int i_total;
 404         char p_text[i_textsize+1];
 405
 406         i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
 407                         "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
 408         p_text[i_total] = '\0';
 409         /* Strip off the pagenumber */
 410         if( i_total <= 40 )
 411             goto error;
 412         p_spu->p_region->psz_text = strdup( &p_text[8] );
 413
 414 #ifdef ZVBI_DEBUG
 415         msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
 416 #endif
 417     }
 418     else
 419     {
 420         picture_t *p_pic = p_spu->p_region->p_picture;
 421
 422         /* ZVBI is stupid enough to assume pitch == width */
 423         p_pic->p->i_pitch = 4 * fmt.i_width;
 424         vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
 425                           p_spu->p_region->p_picture->p->p_pixels, 1, 1 );
 426
 427         vlc_mutex_lock( &p_sys->lock );
 428         memcpy( p_sys->nav_link, &p_page.nav_link, sizeof( p_sys->nav_link )) ;
 429         vlc_mutex_unlock( &p_sys->lock );
 430
 431         OpaquePage( p_pic, p_page, fmt, b_opaque );
 432     }
 433
 434 exit:
 435     vbi_unref_page( &p_page );
 436     block_Release( p_block );
 437     return p_spu;
 438
 439 error:
 440     vbi_unref_page( &p_page );
 441     if( p_spu != NULL )
 442     {
 443         decoder_DeleteSubpicture( p_dec, p_spu );
 444         p_spu = NULL;
 445     }
 446
 447     block_Release( p_block );
 448     return NULL;
 449 }
 450
 451 static subpicture_t *Subpicture( decoder_t *p_dec, video_format_t *p_fmt,
 452                                  bool b_text,
 453                                  int i_columns, int i_rows, int i_align,
 454                                  mtime_t i_pts )
 455 {
 456     video_format_t fmt;
 457     subpicture_t *p_spu;
 458
 459     /* If there is a page or sub to render, then we do that here */
 460     /* Create the subpicture unit */
 461     p_spu = decoder_NewSubpicture( p_dec );
 462     if( !p_spu )
 463     {
 464         msg_Warn( p_dec, "can't get spu buffer" );
 465         return NULL;
 466     }
 467
 468     memset( &fmt, 0, sizeof(video_format_t) );
 469     fmt.i_chroma = b_text ? VLC_CODEC_TEXT :
 470                                    VLC_CODEC_RGBA;
 471     if( b_text )
 472     {
 473         fmt.i_bits_per_pixel = 0;
 474         fmt.i_sar_num = 0;
 475         fmt.i_sar_den = 0;
 476     }
 477     else
 478     {
 479         fmt.i_sar_num = 1;
 480         fmt.i_sar_den = 1;
 481         fmt.i_width = fmt.i_visible_width = i_columns * 12;
 482         fmt.i_height = fmt.i_visible_height = i_rows * 10;
 483         fmt.i_bits_per_pixel = 32;
 484     }
 485     fmt.i_x_offset = fmt.i_y_offset = 0;
 486
 487     p_spu->p_region = subpicture_region_New( &fmt );
 488     if( p_spu->p_region == NULL )
 489     {
 490         msg_Err( p_dec, "cannot allocate SPU region" );
 491         decoder_DeleteSubpicture( p_dec, p_spu );
 492         return NULL;
 493     }
 494
 495     p_spu->p_region->i_x = 0;
 496     p_spu->p_region->i_y = 0;
 497     p_spu->p_region->i_align = i_align;
 498
 499     p_spu->i_start = i_pts;
 500     p_spu->i_stop = 0;
 501     p_spu->b_ephemer = true;
 502     p_spu->b_absolute = false;
 503
 504     if( !b_text )
 505     {
 506         p_spu->i_original_picture_width = fmt.i_width;
 507         p_spu->i_original_picture_height = fmt.i_height;
 508     }
 509
 510     /* */
 511     *p_fmt = fmt;
 512     return p_spu;
 513 }
 514
 515 static void EventHandler( vbi_event *ev, void *user_data )
 516 {
 517     decoder_t *p_dec        = (decoder_t *)user_data;
 518     decoder_sys_t *p_sys    = p_dec->p_sys;
 519
 520     if( ev->type == VBI_EVENT_TTX_PAGE )
 521     {
 522 #ifdef ZVBI_DEBUG
 523         msg_Info( p_dec, "Page %03x.%02x ",
 524                     ev->ev.ttx_page.pgno,
 525                     ev->ev.ttx_page.subno & 0xFF);
 526 #endif
 527         if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
 528             p_sys->b_update = true;
 529 #ifdef ZVBI_DEBUG
 530         if( ev->ev.ttx_page.clock_update )
 531             msg_Dbg( p_dec, "clock" );
 532         if( ev->ev.ttx_page.header_update )
 533             msg_Dbg( p_dec, "header" );
 534 #endif
 535     }
 536     else if( ev->type == VBI_EVENT_CLOSE )
 537         msg_Dbg( p_dec, "Close event" );
 538     else if( ev->type == VBI_EVENT_CAPTION )
 539         msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
 540     else if( ev->type == VBI_EVENT_NETWORK )
 541     {
 542         msg_Dbg( p_dec, "Network change");
 543         vbi_network n = ev->ev.network;
 544         msg_Dbg( p_dec, "Network id:%d name: %s, call: %s ", n.nuid, n.name, n.call );
 545     }
 546     else if( ev->type == VBI_EVENT_TRIGGER )
 547         msg_Dbg( p_dec, "Trigger event" );
 548     else if( ev->type == VBI_EVENT_ASPECT )
 549         msg_Dbg( p_dec, "Aspect update" );
 550     else if( ev->type == VBI_EVENT_PROG_INFO )
 551         msg_Dbg( p_dec, "Program info received" );
 552     else if( ev->type == VBI_EVENT_NETWORK_ID )
 553         msg_Dbg( p_dec, "Network ID changed" );
 554 }
 555
 556 static int OpaquePage( picture_t *p_src, const vbi_page p_page,
 557                        const video_format_t fmt, bool b_opaque )
 558 {
 559     unsigned int    x, y;
 560
 561     assert( fmt.i_chroma == VLC_CODEC_RGBA );
 562
 563     /* Kludge since zvbi doesn't provide an option to specify opacity. */
 564     for( y = 0; y < fmt.i_height; y++ )
 565     {
 566         for( x = 0; x < fmt.i_width; x++ )
 567         {
 568             const vbi_opacity opacity = p_page.text[ y/10 * p_page.columns + x/12 ].opacity;
 569             const int background = p_page.text[ y/10 * p_page.columns + x/12 ].background;
 570             uint32_t *p_pixel = (uint32_t*)&p_src->p->p_pixels[y * p_src->p->i_pitch + 4*x];
 571
 572             switch( opacity )
 573             {
 574             /* Show video instead of this character */
 575             case VBI_TRANSPARENT_SPACE:
 576                 *p_pixel = 0;
 577                 break;
 578             /* Display foreground and background color */
 579             /* To make the boxed text "closed captioning" transparent
 580              * change true to false.
 581              */
 582             case VBI_OPAQUE:
 583             /* alpha blend video into background color */
 584             case VBI_SEMI_TRANSPARENT:
 585                 if( b_opaque )
 586                     break;
 587             /* Full text transparency. only foreground color is show */
 588             case VBI_TRANSPARENT_FULL:
 589                 if( (*p_pixel) == (0xff000000 | p_page.color_map[background] ) )
 590                     *p_pixel = 0;
 591                 break;
 592             }
 593         }
 594     }
 595     /* end of kludge */
 596     return VLC_SUCCESS;
 597 }
 598
 599 /* Callbacks */
 600 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 601                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 602 {
 603     decoder_sys_t *p_sys = p_data;
 604     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 605
 606     vlc_mutex_lock( &p_sys->lock );
 607     switch( newval.i_int )
 608     {
 609         case ZVBI_KEY_RED:
 610             p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[0].pgno );
 611             p_sys->i_wanted_subpage = p_sys->nav_link[0].subno;
 612             break;
 613         case ZVBI_KEY_GREEN:
 614             p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[1].pgno );
 615             p_sys->i_wanted_subpage = p_sys->nav_link[1].subno;
 616             break;
 617         case ZVBI_KEY_YELLOW:
 618             p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[2].pgno );
 619             p_sys->i_wanted_subpage = p_sys->nav_link[2].subno;
 620             break;
 621         case ZVBI_KEY_BLUE:
 622             p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[3].pgno );
 623             p_sys->i_wanted_subpage = p_sys->nav_link[3].subno;
 624             break;
 625         case ZVBI_KEY_INDEX:
 626             p_sys->i_wanted_page = vbi_bcd2dec( p_sys->nav_link[5].pgno ); /* #4 is SKIPPED */
 627             p_sys->i_wanted_subpage = p_sys->nav_link[5].subno;
 628             break;
 629     }
 630     if( newval.i_int > 0 && newval.i_int < 999 )
 631     {
 632         p_sys->i_wanted_page = newval.i_int;
 633         p_sys->i_wanted_subpage = VBI_ANY_SUBNO;
 634     }
 635     vlc_mutex_unlock( &p_sys->lock );
 636
 637     return VLC_SUCCESS;
 638 }
 639
 640 static int Opaque( 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     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 645
 646     vlc_mutex_lock( &p_sys->lock );
 647     p_sys->b_opaque = newval.b_bool;
 648     p_sys->b_update = true;
 649     vlc_mutex_unlock( &p_sys->lock );
 650
 651     return VLC_SUCCESS;
 652 }
 653
 654 static int Position( vlc_object_t *p_this, char const *psz_cmd,
 655                      vlc_value_t oldval, vlc_value_t newval, void *p_data )
 656 {
 657     decoder_sys_t *p_sys = p_data;
 658     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 659
 660     vlc_mutex_lock( &p_sys->lock );
 661     p_sys->i_align = newval.i_int;
 662     vlc_mutex_unlock( &p_sys->lock );
 663
 664     return VLC_SUCCESS;
 665 }
 666
 667 static int EventKey( vlc_object_t *p_this, char const *psz_cmd,
 668                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 669 {
 670     decoder_t *p_dec = p_data;
 671     decoder_sys_t *p_sys = p_dec->p_sys;
 672
 673     VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 674
 675     /* FIXME: Capture + and - key for subpage browsing */
 676     if( newval.i_int == '-' || newval.i_int == '+' )
 677     {
 678         vlc_mutex_lock( &p_sys->lock );
 679         if( p_sys->i_wanted_subpage == VBI_ANY_SUBNO && newval.i_int == '+' )
 680             p_sys->i_wanted_subpage = vbi_dec2bcd(1);
 681         else if ( newval.i_int == '+' )
 682             p_sys->i_wanted_subpage = vbi_add_bcd( p_sys->i_wanted_subpage, 1);
 683         else if( newval.i_int == '-')
 684             p_sys->i_wanted_subpage = vbi_add_bcd( p_sys->i_wanted_subpage, 0xF9999999); /* BCD complement - 1 */
 685
 686         if ( !vbi_bcd_digits_greater( p_sys->i_wanted_subpage, 0x00 ) || vbi_bcd_digits_greater( p_sys->i_wanted_subpage, 0x99 ) )
 687                 p_sys->i_wanted_subpage = VBI_ANY_SUBNO;
 688         else
 689             vout_OSDMessage( p_this, DEFAULT_CHAN, "%s: %d", _("Subpage"), vbi_bcd2dec( p_sys->i_wanted_subpage) );
 690
 691         p_sys->b_update = true;
 692         vlc_mutex_unlock( &p_sys->lock );
 693     }
 694
 695     /* Capture 0-9 for page selection */
 696     if( newval.i_int < '0' || newval.i_int > '9' )
 697         return VLC_SUCCESS;
 698
 699     vlc_mutex_lock( &p_sys->lock );
 700     p_sys->i_key[0] = p_sys->i_key[1];
 701     p_sys->i_key[1] = p_sys->i_key[2];
 702     p_sys->i_key[2] = (int)(newval.i_int - '0');
 703     vout_OSDMessage( p_this, DEFAULT_CHAN, "%s: %c%c%c", _("Page"), (char)(p_sys->i_key[0]+'0'), (char)(p_sys->i_key[1]+'0'), (char)(p_sys->i_key[2]+'0') );
 704
 705     int i_new_page = 0;
 706
 707     if( p_sys->i_key[0] > 0 && p_sys->i_key[0] <= 8 &&
 708         p_sys->i_key[1] >= 0 && p_sys->i_key[1] <= 9 &&
 709         p_sys->i_key[2] >= 0 && p_sys->i_key[2] <= 9 )
 710     {
 711         i_new_page = p_sys->i_key[0]*100 + p_sys->i_key[1]*10 + p_sys->i_key[2];
 712         p_sys->i_key[0] = p_sys->i_key[1] = p_sys->i_key[2] = '*' - '0';
 713     }
 714     vlc_mutex_unlock( &p_sys->lock );
 715
 716     if( i_new_page > 0 )
 717         var_SetInteger( p_dec, "vbi-page", i_new_page );
 718
 719     return VLC_SUCCESS;
 720 }