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
  48 typedef enum {
  49     DATA_UNIT_EBU_TELETEXT_NON_SUBTITLE     = 0x02,
  50     DATA_UNIT_EBU_TELETEXT_SUBTITLE         = 0x03,
  51     DATA_UNIT_EBU_TELETEXT_INVERTED         = 0x0C,
  52
  53     DATA_UNIT_ZVBI_WSS_CPR1204              = 0xB4,
  54     DATA_UNIT_ZVBI_CLOSED_CAPTION_525       = 0xB5,
  55     DATA_UNIT_ZVBI_MONOCHROME_SAMPLES_525   = 0xB6,
  56
  57     DATA_UNIT_VPS                           = 0xC3,
  58     DATA_UNIT_WSS                           = 0xC4,
  59     DATA_UNIT_CLOSED_CAPTION                = 0xC5,
  60     DATA_UNIT_MONOCHROME_SAMPLES            = 0xC6,
  61
  62     DATA_UNIT_STUFFING                      = 0xFF,
  63 } data_unit_id;
  64
  65 /*****************************************************************************
  66  * Module descriptor.
  67  *****************************************************************************/
  68 static int  Open ( vlc_object_t * );
  69 static void Close( vlc_object_t * );
  70 static subpicture_t *Decode( decoder_t *, block_t ** );
  71
  72 #define PAGE_TEXT N_("Teletext page")
  73 #define PAGE_LONGTEXT N_("Open the indicated Teletext page." \
  74         "Default page is index 100")
  75
  76 #define OPAQUE_TEXT N_("Text is always opaque")
  77 #define OPAQUE_LONGTEXT N_("Setting vbi-opaque to false " \
  78         "makes the boxed text transparent." )
  79
  80 vlc_module_begin();
  81     set_description( _("VBI and Teletext decoder") );
  82     set_shortname( "VBI & Teletext" );
  83     set_capability( "decoder", 51 );
  84     set_category( CAT_INPUT );
  85     set_subcategory( SUBCAT_INPUT_SCODEC );
  86     set_callbacks( Open, Close );
  87
  88     add_integer( "vbi-page", 100, NULL,
  89                  PAGE_TEXT, PAGE_LONGTEXT, VLC_FALSE );
  90     add_bool( "vbi-opaque", VLC_TRUE, NULL,
  91                  OPAQUE_TEXT, OPAQUE_LONGTEXT, VLC_FALSE );
  92 vlc_module_end();
  93
  94 /****************************************************************************
  95  * Local structures
  96  ****************************************************************************/
  97
  98 struct decoder_sys_t
  99 {
 100    vbi_decoder *           p_vbi_dec;
 101    vbi_dvb_demux *         p_dvb_demux;
 102    unsigned int            i_wanted_page;
 103    unsigned int            i_last_page;
 104    vlc_bool_t              b_update;
 105    vlc_bool_t              b_opaque;
 106 };
 107
 108 static void event_handler( vbi_event *ev, void *user_data );
 109 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 110                         vlc_value_t oldval, vlc_value_t newval, void *p_data );
 111 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
 112                    vlc_value_t oldval, vlc_value_t newval, void *p_data );
 113
 114 /*****************************************************************************
 115  * Open: probe the decoder and return score
 116  *****************************************************************************
 117  * Tries to launch a decoder and return score so that the interface is able
 118  * to chose.
 119  *****************************************************************************/
 120 static int Open( vlc_object_t *p_this )
 121 {
 122     decoder_t     *p_dec = (decoder_t *) p_this;
 123     decoder_sys_t *p_sys = NULL;
 124
 125     if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
 126     {
 127         return VLC_EGENERIC;
 128     }
 129
 130     p_dec->pf_decode_sub = Decode;
 131     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
 132     if( p_sys == NULL )
 133     {
 134         msg_Err( p_dec, "out of memory" );
 135         return VLC_ENOMEM;
 136
 137     }
 138     memset( p_sys, 0, sizeof(decoder_sys_t) );
 139
 140     p_sys->p_vbi_dec = vbi_decoder_new();
 141     p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
 142
 143     if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
 144     {
 145         msg_Err( p_dec, "VBI decoder/demux could not be created." );
 146         Close( p_this );
 147         return VLC_ENOMEM;
 148     }
 149
 150     vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
 151                                 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
 152                                 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
 153                                 event_handler, p_dec );
 154
 155     /* Create the var on vlc_global. */
 156     p_sys->i_wanted_page = var_CreateGetInteger( p_dec->p_libvlc, "vbi-page" );
 157     var_AddCallback( p_dec->p_libvlc, "vbi-page",
 158                      RequestPage, p_sys );
 159
 160     p_sys->b_opaque = var_CreateGetBool( p_dec, "vbi-opaque" );
 161     var_AddCallback( p_dec, "vbi-opaque", Opaque, p_sys );
 162     return VLC_SUCCESS;
 163 }
 164
 165 /*****************************************************************************
 166  * Close:
 167  *****************************************************************************/
 168 static void Close( vlc_object_t *p_this )
 169 {
 170     decoder_t     *p_dec = (decoder_t*) p_this;
 171     decoder_sys_t *p_sys = p_dec->p_sys;
 172
 173     if( p_sys->p_vbi_dec )
 174         vbi_decoder_delete( p_sys->p_vbi_dec );
 175     if( p_sys->p_dvb_demux )
 176         vbi_dvb_demux_delete( p_sys->p_dvb_demux );
 177     free( p_sys );
 178 }
 179
 180 #define MAX_SLICES 32
 181
 182 /*****************************************************************************
 183  * Decode:
 184  *****************************************************************************/
 185 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 186 {
 187     decoder_sys_t   *p_sys = p_dec->p_sys;
 188     block_t         *p_block;
 189     subpicture_t    *p_spu = NULL;
 190     video_format_t  fmt;
 191     vlc_bool_t      b_cached = VLC_FALSE;
 192     vbi_page        p_page;
 193     uint8_t         *p_pos;
 194     unsigned int    i_left;
 195
 196     /* part of kludge */
 197     uint32_t        *p_begin, *p_end;
 198     unsigned        int x = 0, y = 0;
 199     vbi_opacity opacity;
 200     /* end part of kludge */
 201
 202     if( (pp_block == NULL) || (*pp_block == NULL) )
 203         return NULL;
 204     p_block = *pp_block;
 205     *pp_block = NULL;
 206
 207     p_pos = p_block->p_buffer;
 208     i_left = p_block->i_buffer;
 209
 210     while( i_left > 0 )
 211     {
 212         vbi_sliced      p_sliced[MAX_SLICES];
 213         unsigned int    i_lines = 0;
 214         int64_t         i_pts;
 215
 216         i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
 217                                      MAX_SLICES, &i_pts, &p_pos, &i_left );
 218
 219         if( i_lines > 0 )
 220             vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
 221     }
 222
 223     /* Try to see if the page we want is in the cache yet */
 224     b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
 225                                   vbi_dec2bcd( p_sys->i_wanted_page ),
 226                                   VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
 227                                   25, FALSE );
 228
 229     if( !b_cached )
 230         goto error;
 231
 232     if( (p_sys->i_wanted_page == p_sys->i_last_page) &&
 233          (p_sys->b_update != VLC_TRUE) )
 234         goto error;
 235
 236     p_sys->i_last_page = p_sys->i_wanted_page;
 237     p_sys->b_update = VLC_FALSE;
 238     msg_Dbg( p_dec, "we now have page: %d ready for display",
 239              p_sys->i_wanted_page );
 240
 241     /* If there is a page or sub to render, then we do that here */
 242     /* Create the subpicture unit */
 243     p_spu = p_dec->pf_spu_buffer_new( p_dec );
 244     if( !p_spu )
 245     {
 246         msg_Warn( p_dec, "can't get spu buffer" );
 247         goto error;
 248     }
 249
 250     /* Create a new subpicture region */
 251     memset( &fmt, 0, sizeof(video_format_t) );
 252     fmt.i_chroma = VLC_FOURCC('R','G','B','A');
 253     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 254     fmt.i_sar_num = fmt.i_sar_den = 1;
 255     fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
 256     fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
 257     fmt.i_bits_per_pixel = 32;
 258     fmt.i_x_offset = fmt.i_y_offset = 0;
 259
 260     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
 261     if( p_spu->p_region == NULL )
 262     {
 263         msg_Err( p_dec, "cannot allocate SPU region" );
 264         goto error;
 265     }
 266
 267     p_spu->p_region->i_x = 0;
 268     p_spu->p_region->i_y = 0;
 269
 270     /* Normal text subs, easy markup */
 271     p_spu->i_flags = SUBPICTURE_ALIGN_TOP;
 272
 273     p_spu->i_start = p_block->i_pts;
 274     p_spu->i_stop = 0;
 275     p_spu->b_ephemer = VLC_TRUE;
 276     p_spu->b_absolute = VLC_FALSE;
 277     p_spu->b_pausable = VLC_TRUE;
 278     p_spu->i_original_picture_width = p_page.columns * 12;
 279     p_spu->i_original_picture_height = p_page.rows * 10;
 280
 281     vbi_draw_vt_page( &p_page, VBI_PIXFMT_RGBA32_LE,
 282                       p_spu->p_region->picture.p->p_pixels, 1, 1 );
 283     p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
 284     p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
 285
 286     /* Kludge since zvbi doesn't provide an option to specify opacity. */
 287     p_begin = (uint32_t *)p_spu->p_region->picture.p->p_pixels;
 288     p_end   = (uint32_t *)p_spu->p_region->picture.p->p_pixels+(fmt.i_width * fmt.i_height);
 289
 290     for( ; p_begin < p_end; p_begin++ )
 291     {
 292         opacity = p_page.text[ y / 10 * p_page.columns + x / 12 ].opacity;
 293         switch( opacity )
 294         {
 295             /* Show video instead of this character */
 296             case VBI_TRANSPARENT_SPACE:
 297                 *p_begin = 0;
 298                 break;
 299             /* To make the boxed text "closed captioning" transparent
 300              * change VLC_TRUE to VLC_FALSE.
 301              */
 302             case VBI_OPAQUE:
 303                 if( p_sys->b_opaque )
 304                     break;
 305             /* Full text transparency. only foreground color is show */
 306             case VBI_TRANSPARENT_FULL:
 307             /* Transparency for boxed text */
 308             case VBI_SEMI_TRANSPARENT:
 309                 if( (*p_begin & 0xffffff00) == 0xff  )
 310                     *p_begin = 0;
 311                 break;
 312             default:
 313                 break;
 314         }
 315         x++;
 316         if( x >= fmt.i_width )
 317         {
 318             x = 0;
 319             y++;
 320         }
 321     }
 322     /* end of kludge */
 323
 324 #if 0
 325     unsigned int i_total, i_textsize = 7000;
 326     char p_text[7000];
 327
 328     i_total =  vbi_print_page_region( &p_page, p_text, i_textsize,
 329                         "ISO-8859-1", 0, 0, 0, 0, p_page.columns,
 330                         p_page.rows );
 331     p_text[i_total] = '\0';
 332
 333     msg_Dbg( p_dec, "page %x-%x\n%s", p_page.pgno, p_page.subno, p_text );
 334 #endif
 335
 336     vbi_unref_page( &p_page );
 337     block_Release( p_block );
 338     return p_spu;
 339
 340 error:
 341     vbi_unref_page( &p_page );
 342     if( p_spu != NULL )
 343     {
 344         p_dec->pf_spu_buffer_del( p_dec, p_spu );
 345         p_spu = NULL;
 346     }
 347
 348     block_Release( p_block );
 349     return NULL;
 350 }
 351
 352 static void event_handler( vbi_event *ev, void *user_data)
 353 {
 354     decoder_t *p_dec        = (decoder_t *)user_data;
 355     decoder_sys_t *p_sys    = p_dec->p_sys;
 356
 357     if( ev->type == VBI_EVENT_TTX_PAGE )
 358     {
 359         /* msg_Dbg( p_dec, "Page %03x.%02x ",
 360                     ev->ev.ttx_page.pgno,
 361                     ev->ev.ttx_page.subno & 0xFF);
 362         */
 363         if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
 364             p_sys->b_update = VLC_TRUE;
 365
 366         if( ev->ev.ttx_page.clock_update )
 367             msg_Dbg( p_dec, "clock" );
 368         if( ev->ev.ttx_page.header_update )
 369             msg_Dbg( p_dec, "header" );
 370     }
 371     else if( ev->type == VBI_EVENT_CAPTION )
 372         msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
 373     else if( ev->type == VBI_EVENT_NETWORK )
 374         msg_Dbg( p_dec, "Network change" );
 375     else if( ev->type == VBI_EVENT_ASPECT )
 376         msg_Dbg( p_dec, "Aspect update" );
 377     else if( ev->type == VBI_EVENT_NETWORK )
 378         msg_Dbg( p_dec, "Program info received" );
 379 }
 380
 381 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 382                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 383 {
 384     decoder_sys_t   *p_sys = p_data;
 385
 386     if( (newval.i_int > 0) && (newval.i_int < 999) )
 387         p_sys->i_wanted_page = newval.i_int;
 388
 389     return VLC_SUCCESS;
 390 }
 391
 392 static int Opaque( vlc_object_t *p_this, char const *psz_cmd,
 393                    vlc_value_t oldval, vlc_value_t newval, void *p_data )
 394 {
 395     decoder_sys_t *p_sys = p_data;
 396
 397     if( p_sys )
 398         p_sys->b_opaque = newval.b_bool;
 399     return VLC_SUCCESS;
 400 }