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