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_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, 0 );
  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     p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
 201     var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
 202
 203     p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
 204     var_AddCallback( p_dec, "vbi-position", Position, p_sys );
 205
 206     p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
 207 //    var_AddCallback( p_dec, "vbi-text", Text, p_sys );
 208
 209     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
 210     if( p_sys->b_text )
 211         p_dec->fmt_out.video.i_chroma = VLC_FOURCC('T','E','X','T');
 212     else
 213         p_dec->fmt_out.video.i_chroma = VLC_FOURCC('R','G','B','A');
 214     return VLC_SUCCESS;
 215 }
 216
 217 /*****************************************************************************
 218  * Close:
 219  *****************************************************************************/
 220 static void Close( vlc_object_t *p_this )
 221 {
 222     decoder_t     *p_dec = (decoder_t*) p_this;
 223     decoder_sys_t *p_sys = p_dec->p_sys;
 224
 225     var_DelCallback( p_dec, "vbi-position", Position, p_sys );
 226     var_DelCallback( p_dec, "vbi-opaque", Opaque, p_sys );
 227     var_DelCallback( p_dec, "vbi-page", RequestPage, p_sys );
 228
 229     vlc_mutex_destroy( &p_sys->lock );
 230
 231     if( p_sys->p_vbi_dec )
 232         vbi_decoder_delete( p_sys->p_vbi_dec );
 233     if( p_sys->p_dvb_demux )
 234         vbi_dvb_demux_delete( p_sys->p_dvb_demux );
 235     free( p_sys );
 236 }
 237
 238 #define MAX_SLICES 32
 239
 240 #ifdef WORDS_BIGENDIAN
 241 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
 242 #else
 243 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
 244 #endif
 245
 246
 247 /*****************************************************************************
 248  * Decode:
 249  *****************************************************************************/
 250 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 251 {
 252     decoder_sys_t   *p_sys = p_dec->p_sys;
 253     block_t         *p_block;
 254     subpicture_t    *p_spu = NULL;
 255     video_format_t  fmt;
 256     bool            b_cached = false;
 257     vbi_page        p_page;
 258     const uint8_t   *p_pos;
 259     unsigned int    i_left;
 260
 261     if( (pp_block == NULL) || (*pp_block == NULL) )
 262         return NULL;
 263
 264     p_block = *pp_block;
 265     *pp_block = NULL;
 266
 267     p_pos = p_block->p_buffer;
 268     i_left = p_block->i_buffer;
 269
 270     while( i_left > 0 )
 271     {
 272         vbi_sliced      p_sliced[MAX_SLICES];
 273         unsigned int    i_lines = 0;
 274         int64_t         i_pts;
 275
 276         i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
 277                                      MAX_SLICES, &i_pts, &p_pos, &i_left );
 278
 279         if( i_lines > 0 )
 280             vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
 281     }
 282
 283     /* */
 284     vlc_mutex_lock( &p_sys->lock );
 285     const int i_align = p_sys->i_align;
 286     const unsigned int i_wanted_page = p_sys->i_wanted_page;
 287     const bool b_opaque = p_sys->b_opaque;
 288     vlc_mutex_unlock( &p_sys->lock );
 289
 290
 291     /* Try to see if the page we want is in the cache yet */
 292     b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
 293                                   vbi_dec2bcd( i_wanted_page ),
 294                                   VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
 295                                   25, FALSE );
 296
 297     if( i_wanted_page == p_sys->i_last_page && !p_sys->b_update )
 298         goto error;
 299
 300     if( !b_cached )
 301     {
 302         if( p_sys->i_last_page != i_wanted_page )
 303         {
 304             /* We need to reset the subtitle */
 305             p_spu = Subpicture( p_dec, &fmt, true,
 306                                 p_page.columns, p_page.rows,
 307                                 i_align, p_block->i_pts );
 308             if( !p_spu )
 309                 goto error;
 310             p_spu->p_region->psz_text = strdup("");
 311
 312             p_sys->b_update = true;
 313             p_sys->i_last_page = i_wanted_page;
 314             goto exit;
 315         }
 316         goto error;
 317     }
 318
 319     p_sys->b_update = false;
 320     p_sys->i_last_page = i_wanted_page;
 321 #ifdef ZVBI_DEBUG
 322     msg_Dbg( p_dec, "we now have page: %d ready for display",
 323              i_wanted_page );
 324 #endif
 325     /* If there is a page or sub to render, then we do that here */
 326     /* Create the subpicture unit */
 327     p_spu = Subpicture( p_dec, &fmt, p_sys->b_text,
 328                         p_page.columns, p_page.rows,
 329                         i_align, p_block->i_pts );
 330     if( !p_spu )
 331         goto error;
 332
 333     if( p_sys->b_text )
 334     {
 335         unsigned int i_textsize = 7000;
 336         int i_total;
 337         char p_text[i_textsize+1];
 338
 339         i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
 340                         "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
 341         p_text[i_total] = '\0';
 342         /* Strip off the pagenumber */
 343         if( i_total <= 40 )
 344             goto error;
 345         p_spu->p_region->psz_text = strdup( &p_text[8] );
 346
 347 #ifdef ZVBI_DEBUG
 348         msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
 349 #endif
 350     }
 351     else
 352     {
 353         picture_t *p_pic = &p_spu->p_region->picture;
 354
 355         /* ZVBI is stupid enough to assume pitch == width */
 356         p_pic->p->i_pitch = 4 * fmt.i_width;
 357         vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
 358                           p_spu->p_region->picture.p->p_pixels, 1, 1 );
 359
 360         OpaquePage( p_pic, p_page, fmt, b_opaque );
 361     }
 362
 363 exit:
 364     vbi_unref_page( &p_page );
 365     block_Release( p_block );
 366     return p_spu;
 367
 368 error:
 369     vbi_unref_page( &p_page );
 370     if( p_spu != NULL )
 371     {
 372         p_dec->pf_spu_buffer_del( p_dec, p_spu );
 373         p_spu = NULL;
 374     }
 375
 376     block_Release( p_block );
 377     return NULL;
 378 }
 379
 380 static subpicture_t *Subpicture( decoder_t *p_dec, video_format_t *p_fmt,
 381                                  bool b_text,
 382                                  int i_columns, int i_rows, int i_align,
 383                                  mtime_t i_pts )
 384 {
 385     video_format_t fmt;
 386     subpicture_t *p_spu;
 387
 388     /* If there is a page or sub to render, then we do that here */
 389     /* Create the subpicture unit */
 390     p_spu = p_dec->pf_spu_buffer_new( p_dec );
 391     if( !p_spu )
 392     {
 393         msg_Warn( p_dec, "can't get spu buffer" );
 394         return NULL;
 395     }
 396
 397     memset( &fmt, 0, sizeof(video_format_t) );
 398     fmt.i_chroma = b_text ? VLC_FOURCC('T','E','X','T') :
 399                                    VLC_FOURCC('R','G','B','A');
 400     fmt.i_aspect = b_text ? 0 : VOUT_ASPECT_FACTOR;
 401     if( b_text )
 402     {
 403         fmt.i_bits_per_pixel = 0;
 404     }
 405     else
 406     {
 407         fmt.i_sar_num = fmt.i_sar_den = 1;
 408         fmt.i_width = fmt.i_visible_width = i_columns * 12;
 409         fmt.i_height = fmt.i_visible_height = i_rows * 10;
 410         fmt.i_bits_per_pixel = 32;
 411     }
 412     fmt.i_x_offset = fmt.i_y_offset = 0;
 413
 414     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
 415     if( p_spu->p_region == NULL )
 416     {
 417         msg_Err( p_dec, "cannot allocate SPU region" );
 418         p_dec->pf_spu_buffer_del( p_dec, p_spu );
 419         return NULL;
 420     }
 421
 422     p_spu->p_region->i_x = 0;
 423     p_spu->p_region->i_y = 0;
 424     p_spu->p_region->i_align = i_align;
 425
 426     /* Normal text subs, easy markup */
 427     p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM;
 428
 429     p_spu->i_start = i_pts;
 430     p_spu->i_stop = 0;
 431     p_spu->b_ephemer = true;
 432     p_spu->b_absolute = false;
 433     p_spu->b_pausable = true;
 434
 435
 436     if( !b_text )
 437     {
 438         p_spu->i_width =
 439         p_spu->i_original_picture_width = fmt.i_width;
 440         p_spu->i_height =
 441         p_spu->i_original_picture_height = fmt.i_height;
 442     }
 443
 444     /* */
 445     *p_fmt = fmt;
 446     return p_spu;
 447 }
 448
 449 static void EventHandler( vbi_event *ev, void *user_data )
 450 {
 451     decoder_t *p_dec        = (decoder_t *)user_data;
 452     decoder_sys_t *p_sys    = p_dec->p_sys;
 453
 454     if( ev->type == VBI_EVENT_TTX_PAGE )
 455     {
 456 #ifdef ZVBI_DEBUG
 457         msg_Info( p_dec, "Page %03x.%02x ",
 458                     ev->ev.ttx_page.pgno,
 459                     ev->ev.ttx_page.subno & 0xFF);
 460 #endif
 461         if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
 462             p_sys->b_update = true;
 463
 464         if( ev->ev.ttx_page.clock_update )
 465             msg_Dbg( p_dec, "clock" );
 466 #ifdef ZVBI_DEBUG
 467         if( ev->ev.ttx_page.header_update )
 468             msg_Dbg( p_dec, "header" );
 469 #endif
 470     }
 471     else if( ev->type == VBI_EVENT_CAPTION )
 472         msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
 473     else if( ev->type == VBI_EVENT_NETWORK )
 474         msg_Dbg( p_dec, "Network change" );
 475     else if( ev->type == VBI_EVENT_ASPECT )
 476         msg_Dbg( p_dec, "Aspect update" );
 477     else if( ev->type == VBI_EVENT_NETWORK )
 478         msg_Dbg( p_dec, "Program info received" );
 479 }
 480
 481 static int OpaquePage( picture_t *p_src, const vbi_page p_page,
 482                        const video_format_t fmt, bool b_opaque )
 483 {
 484     unsigned int    x, y;
 485
 486     assert( fmt.i_chroma == VLC_FOURCC('R','G','B','A' ) );
 487
 488     /* Kludge since zvbi doesn't provide an option to specify opacity. */
 489     for( y = 0; y < fmt.i_height; y++ )
 490     {
 491         for( x = 0; x < fmt.i_width; x++ )
 492         {
 493             const vbi_opacity opacity = p_page.text[ y/10 * p_page.columns + x/12 ].opacity;
 494             uint32_t *p_pixel = (uint32_t*)&p_src->p->p_pixels[y * p_src->p->i_pitch + 4*x];
 495             switch( opacity )
 496             {
 497             /* Show video instead of this character */
 498             case VBI_TRANSPARENT_SPACE:
 499                 *p_pixel = 0;
 500                 break;
 501             /* To make the boxed text "closed captioning" transparent
 502              * change true to false.
 503              */
 504             case VBI_OPAQUE:
 505                 if( b_opaque )
 506                     break;
 507             /* Full text transparency. only foreground color is show */
 508             case VBI_TRANSPARENT_FULL:
 509                 *p_pixel = 0;
 510                 break;
 511             /* Transparency for boxed text */
 512             case VBI_SEMI_TRANSPARENT:
 513                 if( (*p_pixel) == 0xff000000 && 0 ) /* Disabled until someone implement borders */
 514                     *p_pixel = 0;
 515                 break;
 516             }
 517         }
 518     }
 519     /* end of kludge */
 520     return VLC_SUCCESS;
 521 }
 522
 523 /* Callbacks */
 524 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 525                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 526 {
 527     decoder_sys_t *p_sys = p_data;
 528     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 529
 530     vlc_mutex_lock( &p_sys->lock );
 531     if( newval.i_int > 0 && newval.i_int < 999 )
 532         p_sys->i_wanted_page = newval.i_int;
 533     vlc_mutex_unlock( &p_sys->lock );
 534
 535     return VLC_SUCCESS;
 536 }
 537
 538 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
 539                    vlc_value_t oldval, vlc_value_t newval, void *p_data )
 540 {
 541     decoder_sys_t *p_sys = p_data;
 542     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 543
 544     vlc_mutex_lock( &p_sys->lock );
 545     p_sys->b_opaque = newval.b_bool;
 546     vlc_mutex_unlock( &p_sys->lock );
 547
 548     return VLC_SUCCESS;
 549 }
 550
 551 static int Position( vlc_object_t *p_this, char const *psz_cmd,
 552                      vlc_value_t oldval, vlc_value_t newval, void *p_data )
 553 {
 554     decoder_sys_t *p_sys = p_data;
 555     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 556
 557     vlc_mutex_lock( &p_sys->lock );
 558     p_sys->i_align = newval.i_int;
 559     vlc_mutex_unlock( &p_sys->lock );
 560
 561     return VLC_SUCCESS;
 562 }