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