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_wanted_page;
 127     unsigned int      i_last_page;
 128     bool              b_update;
 129     bool              b_opaque;
 130
 131     /* Subtitles as text */
 132     bool              b_text;
 133
 134     /* Positioning of Teletext images */
 135     int               i_align;
 136 };
 137
 138 static subpicture_t *Decode( decoder_t *, block_t ** );
 139
 140 static void event_handler( vbi_event *ev, void *user_data );
 141 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 142                         vlc_value_t oldval, vlc_value_t newval, void *p_data );
 143 static int OpaquePage( decoder_t *p_dec, vbi_page p_page, video_format_t fmt,
 144                         picture_t **p_src );
 145
 146 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
 147                    vlc_value_t oldval, vlc_value_t newval, void *p_data );
 148 static int Position( vlc_object_t *p_this, char const *psz_cmd,
 149                      vlc_value_t oldval, vlc_value_t newval, void *p_data );
 150
 151 /*****************************************************************************
 152  * Open: probe the decoder and return score
 153  *****************************************************************************
 154  * Tries to launch a decoder and return score so that the interface is able
 155  * to chose.
 156  *****************************************************************************/
 157 static int Open( vlc_object_t *p_this )
 158 {
 159     decoder_t     *p_dec = (decoder_t *) p_this;
 160     decoder_sys_t *p_sys = NULL;
 161
 162     if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
 163         return VLC_EGENERIC;
 164
 165     p_dec->pf_decode_sub = Decode;
 166     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
 167     if( p_sys == NULL )
 168         return VLC_ENOMEM;
 169     memset( p_sys, 0, sizeof(decoder_sys_t) );
 170
 171     p_sys->b_update = false;
 172     p_sys->p_vbi_dec = vbi_decoder_new();
 173     p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
 174
 175     if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
 176     {
 177         msg_Err( p_dec, "VBI decoder/demux could not be created." );
 178         Close( p_this );
 179         return VLC_ENOMEM;
 180     }
 181
 182     vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
 183                                 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
 184                                 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
 185                                 event_handler, p_dec );
 186
 187     /* Create the var on vlc_global. */
 188     p_sys->i_wanted_page = var_CreateGetInteger( p_dec, "vbi-page" );
 189     var_AddCallback( p_dec, "vbi-page",
 190                      RequestPage, p_sys );
 191
 192     p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
 193     var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
 194
 195     p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
 196     var_AddCallback( p_dec, "vbi-position", Position, p_sys );
 197
 198     p_sys->b_text = var_CreateGetBool( p_dec, "vbi-text" );
 199 //    var_AddCallback( p_dec, "vbi-text", Text, p_sys );
 200
 201     es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
 202     if( p_sys->b_text )
 203         p_dec->fmt_out.video.i_chroma = VLC_FOURCC('T','E','X','T');
 204     else
 205         p_dec->fmt_out.video.i_chroma = VLC_FOURCC('R','G','B','A');
 206     return VLC_SUCCESS;
 207 }
 208
 209 /*****************************************************************************
 210  * Close:
 211  *****************************************************************************/
 212 static void Close( vlc_object_t *p_this )
 213 {
 214     decoder_t     *p_dec = (decoder_t*) p_this;
 215     decoder_sys_t *p_sys = p_dec->p_sys;
 216
 217     var_Destroy( p_dec, "vbi-opaque" );
 218     var_Destroy( p_dec, "vbi-page" );
 219     var_DelCallback( p_dec, "vbi-page", RequestPage, p_sys );
 220     var_DelCallback( p_dec, "vbi-opaque", Opaque, p_sys );
 221
 222     if( p_sys->p_vbi_dec ) vbi_decoder_delete( p_sys->p_vbi_dec );
 223     if( p_sys->p_dvb_demux ) vbi_dvb_demux_delete( p_sys->p_dvb_demux );
 224     free( p_sys );
 225 }
 226
 227 #define MAX_SLICES 32
 228
 229 /*****************************************************************************
 230  * Decode:
 231  *****************************************************************************/
 232 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 233 {
 234     decoder_sys_t   *p_sys = (decoder_sys_t *) p_dec->p_sys;
 235     block_t         *p_block;
 236     subpicture_t    *p_spu = NULL;
 237     video_format_t  fmt;
 238     bool            b_cached = false;
 239     vbi_page        p_page;
 240     const uint8_t   *p_pos;
 241     unsigned int    i_left;
 242
 243     if( (pp_block == NULL) || (*pp_block == NULL) )
 244         return NULL;
 245
 246     p_block = *pp_block;
 247     *pp_block = NULL;
 248
 249     p_pos = p_block->p_buffer;
 250     i_left = p_block->i_buffer;
 251
 252     while( i_left > 0 )
 253     {
 254         vbi_sliced      p_sliced[MAX_SLICES];
 255         unsigned int    i_lines = 0;
 256         int64_t         i_pts;
 257
 258         i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
 259                                      MAX_SLICES, &i_pts, &p_pos, &i_left );
 260
 261         if( i_lines > 0 )
 262             vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
 263     }
 264
 265     /* Try to see if the page we want is in the cache yet */
 266     b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
 267                                   vbi_dec2bcd( p_sys->i_wanted_page ),
 268                                   VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
 269                                   25, FALSE );
 270
 271     if( !b_cached )
 272         goto error;
 273
 274     if( ( p_sys->i_wanted_page == p_sys->i_last_page ) &&
 275         ( p_sys->b_update != true ) )
 276         goto error;
 277
 278     p_sys->b_update = false;
 279     p_sys->i_last_page = p_sys->i_wanted_page;
 280 #ifdef ZVBI_DEBUG
 281     msg_Dbg( p_dec, "we now have page: %d ready for display",
 282               p_sys->i_wanted_page );
 283 #endif
 284     /* If there is a page or sub to render, then we do that here */
 285     /* Create the subpicture unit */
 286     p_spu = p_dec->pf_spu_buffer_new( p_dec );
 287     if( !p_spu )
 288     {
 289         msg_Warn( p_dec, "can't get spu buffer" );
 290         goto error;
 291     }
 292
 293     /* Create a new subpicture region */
 294     memset( &fmt, 0, sizeof(video_format_t) );
 295     fmt.i_chroma = p_sys->b_text ? VLC_FOURCC('T','E','X','T') :
 296                                    VLC_FOURCC('R','G','B','A');
 297     fmt.i_aspect = p_sys->b_text ? 0 : VOUT_ASPECT_FACTOR;
 298     if( !p_sys->b_text )
 299     {
 300         fmt.i_sar_num = fmt.i_sar_den = 1;
 301         fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
 302         fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
 303     }
 304     fmt.i_bits_per_pixel = p_sys->b_text ? 0 : 32;
 305     fmt.i_x_offset = fmt.i_y_offset = 0;
 306
 307     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
 308     if( p_spu->p_region == NULL )
 309     {
 310         msg_Err( p_dec, "cannot allocate SPU region" );
 311         goto error;
 312     }
 313
 314     p_spu->p_region->i_x = 0;
 315     p_spu->p_region->i_y = 0;
 316     p_spu->p_region->i_align = p_sys->i_align;
 317
 318     /* Normal text subs, easy markup */
 319     p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM;
 320
 321     p_spu->i_start = (mtime_t) p_block->i_pts;
 322     p_spu->i_stop = (mtime_t) 0;
 323     p_spu->b_ephemer = true;
 324     p_spu->b_absolute = false;
 325     p_spu->b_pausable = true;
 326     if( !p_sys->b_text )
 327     {
 328         p_spu->i_width = fmt.i_width;
 329         p_spu->i_height = fmt.i_height;
 330         p_spu->i_original_picture_width = p_page.columns * 12;
 331         p_spu->i_original_picture_height = p_page.rows * 10;
 332     }
 333
 334 #ifdef WORDS_BIGENDIAN
 335 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_BE
 336 #else
 337 # define ZVBI_PIXFMT_RGBA32 VBI_PIXFMT_RGBA32_LE
 338 #endif
 339
 340     if( p_sys->b_text )
 341     {
 342         unsigned int i_textsize = 7000;
 343         int i_total;
 344         char p_text[7000];
 345
 346         i_total = vbi_print_page_region( &p_page, p_text, i_textsize,
 347                         "UTF-8", 0, 0, 0, 0, p_page.columns, p_page.rows );
 348         p_text[i_total] = '\0';
 349         /* Strip off the pagenumber */
 350         if( i_total <= 40 ) goto error;
 351         p_spu->p_region->psz_text = strdup( &p_text[8] );
 352
 353 #ifdef ZVBI_DEBUG
 354         msg_Info( p_dec, "page %x-%x(%d)\n%s", p_page.pgno, p_page.subno, i_total, p_text );
 355 #endif
 356     }
 357     else
 358     {
 359         picture_t *p_pic;
 360
 361         vbi_draw_vt_page( &p_page, ZVBI_PIXFMT_RGBA32,
 362                           p_spu->p_region->picture.p->p_pixels, 1, 1 );
 363
 364         p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
 365         p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
 366
 367         p_pic = &(p_spu->p_region->picture);
 368         OpaquePage( p_dec, p_page, fmt, &p_pic );
 369     }
 370
 371 #undef ZVBI_PIXFMT_RGBA32
 372
 373     vbi_unref_page( &p_page );
 374     block_Release( p_block );
 375     return p_spu;
 376
 377 error:
 378     vbi_unref_page( &p_page );
 379     if( p_spu != NULL )
 380     {
 381         p_dec->pf_spu_buffer_del( p_dec, p_spu );
 382         p_spu = NULL;
 383     }
 384
 385     block_Release( p_block );
 386     return NULL;
 387 }
 388
 389 static void event_handler( vbi_event *ev, void *user_data )
 390 {
 391     decoder_t *p_dec        = (decoder_t *)user_data;
 392     decoder_sys_t *p_sys    = p_dec->p_sys;
 393
 394     if( ev->type == VBI_EVENT_TTX_PAGE )
 395     {
 396 #ifdef ZVBI_DEBUG
 397         msg_Info( p_dec, "Page %03x.%02x ",
 398                     ev->ev.ttx_page.pgno,
 399                     ev->ev.ttx_page.subno & 0xFF);
 400 #endif
 401         if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
 402             p_sys->b_update = true;
 403
 404         if( ev->ev.ttx_page.clock_update )
 405             msg_Dbg( p_dec, "clock" );
 406 #ifdef ZVBI_DEBUG
 407         if( ev->ev.ttx_page.header_update )
 408             msg_Dbg( p_dec, "header" );
 409 #endif
 410     }
 411     else if( ev->type == VBI_EVENT_CAPTION )
 412         msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
 413     else if( ev->type == VBI_EVENT_NETWORK )
 414         msg_Dbg( p_dec, "Network change" );
 415     else if( ev->type == VBI_EVENT_ASPECT )
 416         msg_Dbg( p_dec, "Aspect update" );
 417     else if( ev->type == VBI_EVENT_NETWORK )
 418         msg_Dbg( p_dec, "Program info received" );
 419 }
 420
 421 static int OpaquePage( decoder_t *p_dec, vbi_page p_page,
 422                        video_format_t fmt, picture_t **p_src )
 423 {
 424     decoder_sys_t   *p_sys = (decoder_sys_t *) p_dec->p_sys;
 425     uint32_t        *p_begin, *p_end;
 426     unsigned int    x = 0, y = 0;
 427     vbi_opacity     opacity;
 428
 429     assert( fmt.i_chroma == VLC_FOURCC('R','G','B','A' ) );
 430
 431     /* Kludge since zvbi doesn't provide an option to specify opacity. */
 432     switch( fmt.i_chroma )
 433     {
 434         case VLC_FOURCC('R','G','B','A' ):
 435             p_begin = (uint32_t *)(*p_src)->p->p_pixels;
 436             p_end   = (uint32_t *)(*p_src)->p->p_pixels +
 437                     ( fmt.i_width * fmt.i_height );
 438             break;
 439         default:
 440             msg_Err( p_dec, "chroma not supported %4.4s", (char *)&fmt.i_chroma );
 441             return VLC_EGENERIC;
 442     }
 443
 444     for( ; p_begin < p_end; p_begin++ )
 445     {
 446         opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
 447         switch( opacity )
 448         {
 449         /* Show video instead of this character */
 450         case VBI_TRANSPARENT_SPACE:
 451             *p_begin = 0;
 452             break;
 453         /* To make the boxed text "closed captioning" transparent
 454          * change true to false.
 455          */
 456         case VBI_OPAQUE:
 457             if( p_sys->b_opaque )
 458                 break;
 459         /* Full text transparency. only foreground color is show */
 460         case VBI_TRANSPARENT_FULL:
 461             *p_begin = 0;
 462             break;
 463         /* Transparency for boxed text */
 464         case VBI_SEMI_TRANSPARENT:
 465             if( (*p_begin & 0xffffff00) == 0xff )
 466                 *p_begin = 0;
 467             break;
 468         }
 469         x++;
 470         if( x >= fmt.i_width )
 471         {
 472             x = 0;
 473             y++;
 474         }
 475     }
 476     /* end of kludge */
 477     return VLC_SUCCESS;
 478
 479 }
 480
 481 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 482                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 483 {
 484     decoder_sys_t   *p_sys = p_data;
 485     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 486
 487     if( (newval.i_int > 0) && (newval.i_int < 999) )
 488         p_sys->i_wanted_page = newval.i_int;
 489
 490     return VLC_SUCCESS;
 491 }
 492
 493 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
 494                    vlc_value_t oldval, vlc_value_t newval, void *p_data )
 495 {
 496     decoder_sys_t *p_sys = p_data;
 497     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 498
 499     if( p_sys )
 500         p_sys->b_opaque = newval.b_bool;
 501     return VLC_SUCCESS;
 502 }
 503
 504 static int Position( vlc_object_t *p_this, char const *psz_cmd,
 505                      vlc_value_t oldval, vlc_value_t newval, void *p_data )
 506 {
 507     decoder_sys_t *p_sys = p_data;
 508     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
 509
 510     if( p_sys )
 511         p_sys->i_align = newval.i_int;
 512     return VLC_SUCCESS;
 513 }