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> for M2X
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23 /*****************************************************************************
  24  *
  25  * information on teletext format can be found here :
  26  * http://pdc.ro.nu/teletext.html
  27  *
  28  *****************************************************************************/
  29
  30 /* This module implements:
  31  * ETSI EN 301 775: VBI data in PES
  32  * ETSI EN 300 472: EBU Teletext data in PES
  33  * ETSI EN 300 706: Enhanced Teletext (libzvbi)
  34  * ETSI EN 300 231: Video Programme System [VPS] (libzvbi)
  35  * ETSI EN 300 294: 625-line Wide Screen Signaling [WSS] (libzvbi)
  36  * EIA-608 Revision A: Closed Captioning [CC] (libzvbi)
  37  */
  38
  39 #include <vlc/vlc.h>
  40 #include <assert.h>
  41 #include <stdint.h>
  42 #include <libzvbi.h>
  43
  44 #include "vlc_vout.h"
  45 #include "vlc_bits.h"
  46 #include "vlc_codec.h"
  47 #include "vlc_image.h"
  48
  49 typedef enum {
  50     DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE     = 0x02,
  51     DATA_UNIT_EBU_TELETEXT_SUBTITLE         = 0x03,
  52     DATA_UNIT_EBU_TELETEXT_INVERTED         = 0x0C,
  53
  54     DATA_UNIT_ZVBI_WSS_CPR1204              = 0xB4,
  55     DATA_UNIT_ZVBI_CLOSED_CAPTION_525       = 0xB5,
  56     DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525   = 0xB6,
  57
  58     DATA_UNIT_VPS                           = 0xC3,
  59     DATA_UNIT_WSS                           = 0xC4,
  60     DATA_UNIT_CLOSED_CAPTION                = 0xC5,
  61     DATA_UNIT_MONOCHROME_SAMPLES            = 0xC6,
  62
  63     DATA_UNIT_STUFFING                      = 0xFF,
  64 } data_unit_id;
  65
  66 /*****************************************************************************
  67  * Module descriptor.
  68  *****************************************************************************/
  69 static int  Open ( vlc_object_t * );
  70 static void Close( vlc_object_t * );
  71 static subpicture_t *Decode( decoder_t *, block_t ** );
  72
  73 #define PAGE_TEXT N_("Teletext page")
  74 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
  75         "Default page is index 100")
  76
  77 #define OPAQUE_TEXT N_("Text is always opaque")
  78 #define OPAQUE_LONGTEXT N_("Setting vbi-opaque to false " \
  79         "makes the boxed text transparent." )
  80
  81 #define POS_TEXT N_("Teletext alignment")
  82 #define POS_LONGTEXT N_( \
  83   "You can enforce the teletext position on the video " \
  84   "(0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
  85   "also use combinations of these values, eg. 6 = top-right).")
  86
  87 static int pi_pos_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
  88 static const char *ppsz_pos_descriptions[] =
  89 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
  90   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
  91
  92 vlc_module_begin();
  93     set_description( _("VBI and Teletext decoder") );
  94     set_shortname( "VBI & Teletext" );
  95     set_capability( "decoder", 51 );
  96     set_category( CAT_INPUT );
  97     set_subcategory( SUBCAT_INPUT_SCODEC );
  98     set_callbacks( Open, Close );
  99
 100     add_integer( "vbi-page", 100, NULL,
 101                  PAGE_TEXT, PAGE_LONGTEXT, VLC_FALSE );
 102     add_bool( "vbi-opaque", VLC_TRUE, NULL,
 103                  OPAQUE_TEXT, OPAQUE_LONGTEXT, VLC_FALSE );
 104     add_integer( "vbi-position", 4, NULL, POS_TEXT, POS_LONGTEXT, VLC_FALSE );
 105         change_integer_list( pi_pos_values, ppsz_pos_descriptions, 0 );
 106 vlc_module_end();
 107
 108 /****************************************************************************
 109  * Local structures
 110  ****************************************************************************/
 111
 112 struct decoder_sys_t
 113 {
 114     vbi_decoder *           p_vbi_dec;
 115     vbi_dvb_demux *         p_dvb_demux;
 116     unsigned int            i_wanted_page;
 117     unsigned int            i_last_page;
 118     vlc_bool_t              b_update;
 119     vlc_bool_t              b_opaque;
 120
 121     /* Positioning of Teletext images */
 122     int                     i_align;
 123 };
 124
 125 static void event_handler( vbi_event *ev, void *user_data );
 126 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 127                         vlc_value_t oldval, vlc_value_t newval, void *p_data );
 128 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
 129                    vlc_value_t oldval, vlc_value_t newval, void *p_data );
 130 static int Position( vlc_object_t *p_this, char const *psz_cmd,
 131                      vlc_value_t oldval, vlc_value_t newval, void *p_data );
 132
 133 /*****************************************************************************
 134  * Open: probe the decoder and return score
 135  *****************************************************************************
 136  * Tries to launch a decoder and return score so that the interface is able
 137  * to chose.
 138  *****************************************************************************/
 139 static int Open( vlc_object_t *p_this )
 140 {
 141     decoder_t     *p_dec = (decoder_t *) p_this;
 142     decoder_sys_t *p_sys = NULL;
 143
 144     if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
 145     {
 146         return VLC_EGENERIC;
 147     }
 148
 149     p_dec->pf_decode_sub = Decode;
 150     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
 151     if( p_sys == NULL )
 152     {
 153         msg_Err( p_dec, "out of memory" );
 154         return VLC_ENOMEM;
 155
 156     }
 157     memset( p_sys, 0, sizeof(decoder_sys_t) );
 158
 159     p_sys->p_vbi_dec = vbi_decoder_new();
 160     p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
 161
 162     if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
 163     {
 164         msg_Err( p_dec, "VBI decoder/demux could not be created." );
 165         Close( p_this );
 166         return VLC_ENOMEM;
 167     }
 168
 169     vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
 170                                 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
 171                                 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
 172                                 event_handler, p_dec );
 173
 174     /* Create the var on vlc_global. */
 175     p_sys->i_wanted_page = var_CreateGetInteger( p_dec->p_libvlc, "vbi-page" );
 176     var_AddCallback( p_dec->p_libvlc, "vbi-page",
 177                      RequestPage, p_sys );
 178
 179     p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
 180     var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
 181
 182     p_sys->i_align = var_CreateGetInteger( p_dec, "vbi-position" );
 183     var_AddCallback( p_dec, "vbi-position", Position, p_sys );
 184
 185     return VLC_SUCCESS;
 186 }
 187
 188 /*****************************************************************************
 189  * Close:
 190  *****************************************************************************/
 191 static void Close( vlc_object_t *p_this )
 192 {
 193     decoder_t     *p_dec = (decoder_t*) p_this;
 194     decoder_sys_t *p_sys = p_dec->p_sys;
 195
 196     if( p_sys->p_vbi_dec ) vbi_decoder_delete( p_sys->p_vbi_dec );
 197     if( p_sys->p_dvb_demux ) vbi_dvb_demux_delete( p_sys->p_dvb_demux );
 198     free( p_sys );
 199 }
 200
 201 #define MAX_SLICES 32
 202
 203 /*****************************************************************************
 204  * Decode:
 205  *****************************************************************************/
 206 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 207 {
 208     decoder_sys_t   *p_sys = p_dec->p_sys;
 209     block_t         *p_block;
 210     subpicture_t    *p_spu = NULL;
 211     video_format_t  fmt;
 212     vlc_bool_t      b_cached = VLC_FALSE;
 213     vbi_page        p_page;
 214     const uint8_t   *p_pos;
 215     unsigned int    i_left;
 216
 217     /* part of kludge */
 218     uint32_t        *p_begin, *p_end;
 219     unsigned        int x = 0, y = 0;
 220     vbi_opacity     opacity;
 221     /* end part of kludge */
 222
 223     if( (pp_block == NULL) || (*pp_block == NULL) )
 224         return NULL;
 225     p_block = *pp_block;
 226     *pp_block = NULL;
 227
 228     p_pos = p_block->p_buffer;
 229     i_left = p_block->i_buffer;
 230
 231     while( i_left > 0 )
 232     {
 233         vbi_sliced      p_sliced[MAX_SLICES];
 234         unsigned int    i_lines = 0;
 235         int64_t         i_pts;
 236
 237         i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
 238                                      MAX_SLICES, &i_pts, &p_pos, &i_left );
 239
 240         if( i_lines > 0 )
 241             vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
 242     }
 243
 244     /* Try to see if the page we want is in the cache yet */
 245     b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
 246                                   vbi_dec2bcd( p_sys->i_wanted_page ),
 247                                   VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
 248                                   25, FALSE );
 249
 250     if( !b_cached )
 251         goto error;
 252
 253     if( (p_sys->i_wanted_page == p_sys->i_last_page) &&
 254          (p_sys->b_update != VLC_TRUE) )
 255         goto error;
 256
 257     p_sys->i_last_page = p_sys->i_wanted_page;
 258     p_sys->b_update = VLC_FALSE;
 259     msg_Dbg( p_dec, "we now have page: %d ready for display",
 260              p_sys->i_wanted_page );
 261
 262     /* If there is a page or sub to render, then we do that here */
 263     /* Create the subpicture unit */
 264     p_spu = p_dec->pf_spu_buffer_new( p_dec );
 265     if( !p_spu )
 266     {
 267         msg_Warn( p_dec, "can't get spu buffer" );
 268         goto error;
 269     }
 270
 271     /* Create a new subpicture region */
 272     memset( &fmt, 0, sizeof(video_format_t) );
 273     fmt.i_chroma = VLC_FOURCC('R','G','B','A');
 274     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 275     fmt.i_sar_num = fmt.i_sar_den = 1;
 276     fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
 277     fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
 278     fmt.i_bits_per_pixel = 32;
 279     fmt.i_x_offset = fmt.i_y_offset = 0;
 280
 281     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
 282     if( p_spu->p_region == NULL )
 283     {
 284         msg_Err( p_dec, "cannot allocate SPU region" );
 285         goto error;
 286     }
 287
 288     p_spu->p_region->i_x = 0;
 289     p_spu->p_region->i_y = 0;
 290     p_spu->p_region->i_align = SUBPICTURE_ALIGN_TOP;
 291
 292     /* Normal text subs, easy markup */
 293     p_spu->i_flags = SUBPICTURE_ALIGN_TOP;
 294
 295     p_spu->i_start = p_block->i_pts;
 296     p_spu->i_stop = (mtime_t) 0;
 297     p_spu->b_ephemer = VLC_TRUE;
 298     p_spu->b_absolute = VLC_FALSE;
 299     p_spu->b_pausable = VLC_TRUE;
 300     p_spu->i_original_picture_width = p_page.columns * 12;
 301     p_spu->i_original_picture_height = p_page.rows * 10;
 302
 303     vbi_draw_vt_page( &p_page, VBI_PIXFMT_RGBA32_LE,
 304                       p_spu->p_region->picture.p->p_pixels, 1, 1 );
 305     p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
 306     p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
 307
 308     /* Kludge since zvbi doesn't provide an option to specify opacity. */
 309     p_begin = (uint32_t *)p_spu->p_region->picture.p->p_pixels;
 310     p_end   = (uint32_t *)p_spu->p_region->picture.p->p_pixels+(fmt.i_width * fmt.i_height);
 311
 312     for( ; p_begin < p_end; p_begin++ )
 313     {
 314         opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
 315         switch( opacity )
 316         {
 317             /* Show video instead of this character */
 318             case VBI_TRANSPARENT_SPACE:
 319                 *p_begin = 0;
 320                 break;
 321             /* To make the boxed text "closed captioning" transparent
 322              * change VLC_TRUE to VLC_FALSE.
 323              */
 324             case VBI_OPAQUE:
 325                 if( p_sys->b_opaque )
 326                     break;
 327             /* Full text transparency. only foreground color is show */
 328             case VBI_TRANSPARENT_FULL:
 329             /* Transparency for boxed text */
 330             case VBI_SEMI_TRANSPARENT:
 331                 if( (*p_begin & 0xffffff00) == 0xff  )
 332                     *p_begin = 0;
 333                 break;
 334             default:
 335                 break;
 336         }
 337         x++;
 338         if( x >= fmt.i_width )
 339         {
 340             x = 0;
 341             y++;
 342         }
 343     }
 344     /* end of kludge */
 345
 346 #if 0
 347     unsigned int i_total, i_textsize = 7000;
 348     char p_text[7000];
 349
 350     i_total =  vbi_print_page_region( &p_page, p_text, i_textsize,
 351                         "ISO-8859-1", 0, 0, 0, 0, p_page.columns,
 352                         p_page.rows );
 353     p_text[i_total] = '\0';
 354
 355     msg_Dbg( p_dec, "page %x-%x\n%s", p_page.pgno, p_page.subno, p_text );
 356 #endif
 357
 358     vbi_unref_page( &p_page );
 359     block_Release( p_block );
 360     return p_spu;
 361
 362 error:
 363     vbi_unref_page( &p_page );
 364     if( p_spu != NULL )
 365     {
 366         p_dec->pf_spu_buffer_del( p_dec, p_spu );
 367         p_spu = NULL;
 368     }
 369
 370     block_Release( p_block );
 371     return NULL;
 372 }
 373
 374 static void event_handler( vbi_event *ev, void *user_data )
 375 {
 376     decoder_t *p_dec        = (decoder_t *)user_data;
 377     decoder_sys_t *p_sys    = p_dec->p_sys;
 378
 379     if( ev->type == VBI_EVENT_TTX_PAGE )
 380     {
 381         /* msg_Dbg( p_dec, "Page %03x.%02x ",
 382                     ev->ev.ttx_page.pgno,
 383                     ev->ev.ttx_page.subno & 0xFF);
 384         */
 385         if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
 386             p_sys->b_update = VLC_TRUE;
 387
 388         if( ev->ev.ttx_page.clock_update )
 389             msg_Dbg( p_dec, "clock" );
 390         if( ev->ev.ttx_page.header_update )
 391             msg_Dbg( p_dec, "header" );
 392     }
 393     else if( ev->type == VBI_EVENT_CAPTION )
 394         msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
 395     else if( ev->type == VBI_EVENT_NETWORK )
 396         msg_Dbg( p_dec, "Network change" );
 397     else if( ev->type == VBI_EVENT_ASPECT )
 398         msg_Dbg( p_dec, "Aspect update" );
 399     else if( ev->type == VBI_EVENT_NETWORK )
 400         msg_Dbg( p_dec, "Program info received" );
 401 }
 402
 403 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 404                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 405 {
 406     decoder_sys_t   *p_sys = p_data;
 407
 408     if( (newval.i_int > 0) && (newval.i_int < 999) )
 409         p_sys->i_wanted_page = newval.i_int;
 410
 411     return VLC_SUCCESS;
 412 }
 413
 414 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
 415                    vlc_value_t oldval, vlc_value_t newval, void *p_data )
 416 {
 417     decoder_sys_t *p_sys = p_data;
 418
 419     if( p_sys )
 420         p_sys->b_opaque = newval.b_bool;
 421     return VLC_SUCCESS;
 422 }
 423
 424 static int Position( vlc_object_t *p_this, char const *psz_cmd,
 425                      vlc_value_t oldval, vlc_value_t newval, void *p_data )
 426 {
 427     decoder_sys_t *p_sys = p_data;
 428
 429     if( p_sys )
 430         p_sys->i_align = newval.i_int;
 431     return VLC_SUCCESS;
 432 }