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 vlc_module_begin();
  77     set_description( _("VBI and Teletext decoder") );
  78     set_shortname( "VBI & Teletext" );
  79     set_capability( "decoder", 51 );
  80     set_category( CAT_INPUT );
  81     set_subcategory( SUBCAT_INPUT_SCODEC );
  82     set_callbacks( Open, Close );
  83
  84     add_integer( "vbi-page", 100, NULL,
  85                  PAGE_TEXT, PAGE_LONGTEXT, VLC_FALSE );
  86 vlc_module_end();
  87
  88 /****************************************************************************
  89  * Local structures
  90  ****************************************************************************/
  91
  92 struct decoder_sys_t
  93 {
  94    vbi_decoder *           p_vbi_dec;
  95    vbi_dvb_demux *         p_dvb_demux;
  96    unsigned int            i_wanted_page;
  97    unsigned int            i_last_page;
  98    vlc_bool_t              b_update;
  99 }
 100
 101 static void event_handler( vbi_event *ev, void *user_data );
 102 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 103                         vlc_value_t oldval, vlc_value_t newval, void *p_data );
 104
 105 /*****************************************************************************
 106  * Open: probe the decoder and return score
 107  *****************************************************************************
 108  * Tries to launch a decoder and return score so that the interface is able
 109  * to chose.
 110  *****************************************************************************/
 111 static int Open( vlc_object_t *p_this )
 112 {
 113     decoder_t     *p_dec = (decoder_t *) p_this;
 114     decoder_sys_t *p_sys = NULL;
 115     vlc_value_t    val;
 116     int            i;
 117
 118     if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x') )
 119     {
 120         return VLC_EGENERIC;
 121     }
 122
 123     p_dec->pf_decode_sub = Decode;
 124     p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
 125     if( p_sys == NULL )
 126     {
 127         msg_Err( p_dec, "out of memory" );
 128         return VLC_ENOMEM;
 129
 130     }
 131     memset( p_sys, 0, sizeof(decoder_sys_t) );
 132
 133     p_sys->p_vbi_dec = vbi_decoder_new();
 134     p_sys->p_dvb_demux = vbi_dvb_pes_demux_new( NULL, NULL );
 135
 136     if( (p_sys->p_vbi_dec == NULL) || (p_sys->p_dvb_demux == NULL) )
 137     {
 138         msg_Err( p_dec, "VBI decoder/demux could not be created." );
 139         free( p_sys );
 140         return VLC_ENOMEM;
 141     }
 142
 143     vbi_event_handler_register( p_sys->p_vbi_dec, VBI_EVENT_TTX_PAGE |
 144                                 VBI_EVENT_CAPTION | VBI_EVENT_NETWORK |
 145                                 VBI_EVENT_ASPECT | VBI_EVENT_PROG_INFO,
 146                                 event_handler, p_dec );
 147
 148     /* Create the var on vlc_global. */
 149     p_sys->i_wanted_page = var_CreateGetInteger( p_dec->p_libvlc_global,
 150                                                  "vbi-page" );
 151     var_AddCallback( p_dec->p_libvlc_global, "vbi-page",
 152                      RequestPage, p_sys );
 153     return VLC_SUCCESS;
 154 }
 155
 156 /*****************************************************************************
 157  * Close:
 158  *****************************************************************************/
 159 static void Close( vlc_object_t *p_this )
 160 {
 161     decoder_t     *p_dec = (decoder_t*) p_this;
 162     decoder_sys_t *p_sys = p_dec->p_sys;
 163
 164     if( p_sys->p_vbi_dec )
 165         vbi_decoder_delete( p_sys->p_vbi_dec );
 166     if( p_sys->p_dvb_demux )
 167         vbi_dvb_demux_delete( p_sys->p_dvb_demux );
 168     free( p_sys );
 169 }
 170
 171 #define MAX_SLICES 32
 172
 173 /*****************************************************************************
 174  * Decode:
 175  *****************************************************************************/
 176 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 177 {
 178     decoder_sys_t   *p_sys = p_dec->p_sys;
 179     block_t         *p_block;
 180     subpicture_t    *p_spu = NULL;
 181     video_format_t  fmt;
 182     vlc_bool_t      b_cached = VLC_FALSE;
 183     vbi_page        p_page;
 184     uint8_t         *p_pos;
 185     unsigned int    i_left;
 186
 187     if( (pp_block == NULL) || (*pp_block == NULL) )
 188         return NULL;
 189     p_block = *pp_block;
 190     *pp_block = NULL;
 191
 192     p_pos = p_block->p_buffer;
 193     i_left = p_block->i_buffer;
 194
 195     while( i_left > 0 )
 196     {
 197         vbi_sliced      p_sliced[MAX_SLICES];
 198         unsigned int    i_lines = 0;
 199         int64_t         i_pts;
 200
 201         i_lines = vbi_dvb_demux_cor( p_sys->p_dvb_demux, p_sliced,
 202                                      MAX_SLICES, &i_pts, &p_pos, &i_left );
 203
 204         if( i_lines > 0 )
 205             vbi_decode( p_sys->p_vbi_dec, p_sliced, i_lines, i_pts / 90000.0 );
 206     }
 207
 208     /* Try to see if the page we want is in the cache yet */
 209     b_cached = vbi_fetch_vt_page( p_sys->p_vbi_dec, &p_page,
 210                                   vbi_dec2bcd( p_sys->i_wanted_page ),
 211                                   VBI_ANY_SUBNO, VBI_WST_LEVEL_3p5,
 212                                   25, FALSE );
 213
 214     if( !b_cached )
 215         goto error;
 216
 217     if( (p_sys->i_wanted_page == p_sys->i_last_page) &&
 218          (p_sys->b_update != VLC_TRUE) )
 219         goto error;
 220
 221     p_sys->i_last_page = p_sys->i_wanted_page;
 222     p_sys->b_update = VLC_FALSE;
 223     msg_Dbg( p_dec, "we now have page: %d ready for display",
 224              p_sys->i_wanted_page );
 225
 226     /* If there is a page or sub to render, then we do that here */
 227     /* Create the subpicture unit */
 228     p_spu = p_dec->pf_spu_buffer_new( p_dec );
 229     if( !p_spu )
 230     {
 231         msg_Warn( p_dec, "can't get spu buffer" );
 232         goto error;
 233     }
 234
 235     /* Create a new subpicture region */
 236     memset( &fmt, 0, sizeof(video_format_t) );
 237     fmt.i_chroma = VLC_FOURCC('R','G','B','A');
 238     fmt.i_aspect = VOUT_ASPECT_FACTOR;
 239     fmt.i_sar_num = fmt.i_sar_den = 1;
 240     fmt.i_width = fmt.i_visible_width = p_page.columns * 12;
 241     fmt.i_height = fmt.i_visible_height = p_page.rows * 10;
 242     fmt.i_bits_per_pixel = 32;
 243     fmt.i_x_offset = fmt.i_y_offset = 0;
 244
 245     p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
 246     if( p_spu->p_region == NULL )
 247     {
 248         msg_Err( p_dec, "cannot allocate SPU region" );
 249         goto error;
 250     }
 251
 252     p_spu->p_region->i_x = 0;
 253     p_spu->p_region->i_y = 0;
 254
 255     /* Normal text subs, easy markup */
 256     p_spu->i_flags = SUBPICTURE_ALIGN_TOP;
 257
 258     p_spu->i_start = p_block->i_pts;
 259     p_spu->i_stop = 0;
 260     p_spu->b_ephemer = VLC_TRUE;
 261     p_spu->b_absolute = VLC_FALSE;
 262     p_spu->b_pausable = VLC_TRUE;
 263     p_spu->i_original_picture_width = p_page.columns * 12;
 264     p_spu->i_original_picture_height = p_page.rows * 10;
 265
 266     vbi_draw_vt_page( &p_page, VBI_PIXFMT_RGBA32_LE,
 267                       p_spu->p_region->picture.p->p_pixels, 1, 1 );
 268     p_spu->p_region->picture.p->i_lines = p_page.rows * 10;
 269     p_spu->p_region->picture.p->i_pitch = p_page.columns * 12 * 4;
 270
 271 #if 0
 272     unsigned int i_total, i_textsize = 7000;
 273     char p_text[7000];
 274
 275     i_total =  vbi_print_page_region( &p_page, p_text, i_textsize,
 276                         "ISO-8859-1", 0, 0, 0, 0, p_page.columns,
 277                         p_page.rows );
 278     p_text[i_total] = '\0';
 279
 280     msg_Dbg( p_dec, "page %x-%x\n%s", p_page.pgno, p_page.subno, p_text );
 281 #endif
 282
 283     vbi_unref_page( &p_page );
 284     block_Release( p_block );
 285     return p_spu;
 286
 287 error:
 288     vbi_unref_page( &p_page );
 289     if( p_spu != NULL )
 290     {
 291         p_dec->pf_spu_buffer_del( p_dec, p_spu );
 292         p_spu = NULL;
 293     }
 294
 295     block_Release( p_block );
 296     return NULL;
 297 }
 298
 299 static void event_handler( vbi_event *ev, void *user_data)
 300 {
 301     decoder_t *p_dec        = (decoder_t *)user_data;
 302     decoder_sys_t *p_sys    = p_dec->p_sys;
 303
 304     if( ev->type == VBI_EVENT_TTX_PAGE )
 305     {
 306         /* msg_Dbg( p_dec, "Page %03x.%02x ",
 307                     ev->ev.ttx_page.pgno,
 308                     ev->ev.ttx_page.subno & 0xFF);
 309         */
 310         if( p_sys->i_last_page == vbi_bcd2dec( ev->ev.ttx_page.pgno ) )
 311             p_sys->b_update = VLC_TRUE;
 312
 313         if( ev->ev.ttx_page.clock_update )
 314             msg_Dbg( p_dec, "clock" );
 315         if( ev->ev.ttx_page.header_update )
 316             msg_Dbg( p_dec, "header" );
 317     }
 318     else if( ev->type == VBI_EVENT_CAPTION )
 319         msg_Dbg( p_dec, "Caption line: %x", ev->ev.caption.pgno );
 320     else if( ev->type == VBI_EVENT_NETWORK )
 321         msg_Dbg( p_dec, "Network change" );
 322     else if( ev->type == VBI_EVENT_ASPECT )
 323         msg_Dbg( p_dec, "Aspect update" );
 324     else if( ev->type == VBI_EVENT_NETWORK )
 325         msg_Dbg( p_dec, "Program info received" );
 326 }
 327
 328 static int RequestPage( vlc_object_t *p_this, char const *psz_cmd,
 329                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 330 {
 331     decoder_sys_t   *p_sys = p_data;
 332
 333     if( (newval.i_int > 0) && (newval.i_int < 999) )
 334         p_sys->i_wanted_page = newval.i_int;
 335
 336     return VLC_SUCCESS;
 337 }