1 /*****************************************************************************
2 * telx.c : Minimalistic Teletext subtitles decoder
3 *****************************************************************************
4 * Copyright (C) 2007 Vincent Penne
5 * Some code converted from ProjectX java dvb decoder (c) 2001-2005 by dvb.matt
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
22 /*****************************************************************************
24 * information on teletext format can be found here :
25 * http://pdc.ro.nu/teletext.html
27 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_input.h>
40 #include "vlc_codec.h"
42 /* #define TELX_DEBUG */
44 # define dbg( a ) msg_Dbg a
49 /*****************************************************************************
51 *****************************************************************************/
52 static int Open ( vlc_object_t * );
53 static void Close( vlc_object_t * );
54 static subpicture_t *Decode( decoder_t *, block_t ** );
56 #define OVERRIDE_PAGE_TEXT N_("Override page")
57 #define OVERRIDE_PAGE_LONGTEXT N_("Override the indicated page, try this if " \
58 "your subtitles don't appear (-1 = autodetect from TS, " \
59 "0 = autodetect from teletext, " \
60 ">0 = actual page number, usually 888 or 889).")
62 #define IGNORE_SUB_FLAG_TEXT N_("Ignore subtitle flag")
63 #define IGNORE_SUB_FLAG_LONGTEXT N_("Ignore the subtitle flag, try this if " \
64 "your subtitles don't appear.")
66 #define FRENCH_WORKAROUND_TEXT N_("Workaround for France")
67 #define FRENCH_WORKAROUND_LONGTEXT N_("Some French channels do not flag " \
68 "their subtitling pages correctly due to a historical " \
69 "interpretation mistake. Try using this wrong interpretation if " \
70 "your subtitles don't appear.")
73 set_description( N_("Teletext subtitles decoder") );
74 set_shortname( "Teletext" );
75 set_capability( "decoder", 50 );
76 set_category( CAT_INPUT );
77 set_subcategory( SUBCAT_INPUT_SCODEC );
78 set_callbacks( Open, Close );
80 add_integer( "telx-override-page", -1, NULL,
81 OVERRIDE_PAGE_TEXT, OVERRIDE_PAGE_LONGTEXT, true );
82 add_bool( "telx-ignore-subtitle-flag", 0, NULL,
83 IGNORE_SUB_FLAG_TEXT, IGNORE_SUB_FLAG_LONGTEXT, true );
84 add_bool( "telx-french-workaround", 0, NULL,
85 FRENCH_WORKAROUND_TEXT, FRENCH_WORKAROUND_LONGTEXT, true );
89 /****************************************************************************
91 ****************************************************************************/
96 bool b_is_subtitle[9];
97 char ppsz_lines[32][128];
98 char psz_prev_text[512];
102 uint16_t * pi_active_national_set[9];
103 int i_wanted_page, i_wanted_magazine;
104 bool b_ignore_sub_flag;
107 /****************************************************************************
109 ****************************************************************************/
112 * My doc only mentions 13 national characters, but experiments show there
113 * are more, in france for example I already found two more (0x9 and 0xb).
115 * Conversion is in this order :
117 * 0x23 0x24 0x40 0x5b 0x5c 0x5d 0x5e 0x5f 0x60 0x7b 0x7c 0x7d 0x7e
118 * (these are the standard ones)
119 * 0x08 0x09 0x0a 0x0b 0x0c 0x0d (apparently a control character) 0x0e 0x0f
122 static uint16_t ppi_national_subsets[][20] =
124 { 0x00a3, 0x0024, 0x0040, 0x00ab, 0x00bd, 0x00bb, 0x005e, 0x0023,
125 0x002d, 0x00bc, 0x00a6, 0x00be, 0x00f7 }, /* english ,000 */
127 { 0x00e9, 0x00ef, 0x00e0, 0x00eb, 0x00ea, 0x00f9, 0x00ee, 0x0023,
128 0x00e8, 0x00e2, 0x00f4, 0x00fb, 0x00e7, 0, 0x00eb, 0, 0x00ef }, /* french ,001 */
130 { 0x0023, 0x00a4, 0x00c9, 0x00c4, 0x00d6, 0x00c5, 0x00dc, 0x005f,
131 0x00e9, 0x00e4, 0x00f6, 0x00e5, 0x00fc }, /* swedish,finnish,hungarian ,010 */
133 { 0x0023, 0x016f, 0x010d, 0x0165, 0x017e, 0x00fd, 0x00ed, 0x0159,
134 0x00e9, 0x00e1, 0x0115, 0x00fa, 0x0161 }, /* czech,slovak ,011 */
136 { 0x0023, 0x0024, 0x00a7, 0x00c4, 0x00d6, 0x00dc, 0x005e, 0x005f,
137 0x00b0, 0x00e4, 0x00f6, 0x00fc, 0x00df }, /* german ,100 */
139 { 0x00e7, 0x0024, 0x00a1, 0x00e1, 0x00e9, 0x00ed, 0x00f3, 0x00fa,
140 0x00bf, 0x00fc, 0x00f1, 0x00e8, 0x00e0 }, /* portuguese,spanish ,101 */
142 { 0x00a3, 0x0024, 0x00e9, 0x00b0, 0x00e7, 0x00bb, 0x005e, 0x0023,
143 0x00f9, 0x00e0, 0x00f2, 0x00e8, 0x00ec }, /* italian ,110 */
145 { 0x0023, 0x00a4, 0x0162, 0x00c2, 0x015e, 0x0102, 0x00ce, 0x0131,
146 0x0163, 0x00e2, 0x015f, 0x0103, 0x00ee }, /* rumanian ,111 */
148 /* I have these tables too, but I don't know how they can be triggered */
149 { 0x0023, 0x0024, 0x0160, 0x0117, 0x0119, 0x017d, 0x010d, 0x016b,
150 0x0161, 0x0105, 0x0173, 0x017e, 0x012f }, /* lettish,lithuanian ,1000 */
152 { 0x0023, 0x0144, 0x0105, 0x005a, 0x015a, 0x0141, 0x0107, 0x00f3,
153 0x0119, 0x017c, 0x015b, 0x0142, 0x017a }, /* polish, 1001 */
155 { 0x0023, 0x00cb, 0x010c, 0x0106, 0x017d, 0x0110, 0x0160, 0x00eb,
156 0x010d, 0x0107, 0x017e, 0x0111, 0x0161 }, /* serbian,croatian,slovenian, 1010 */
158 { 0x0023, 0x00f5, 0x0160, 0x00c4, 0x00d6, 0x017e, 0x00dc, 0x00d5,
159 0x0161, 0x00e4, 0x00f6, 0x017e, 0x00fc }, /* estonian ,1011 */
161 { 0x0054, 0x011f, 0x0130, 0x015e, 0x00d6, 0x00c7, 0x00dc, 0x011e,
162 0x0131, 0x015f, 0x00f6, 0x00e7, 0x00fc }, /* turkish ,1100 */
166 /*****************************************************************************
167 * Open: probe the decoder and return score
168 *****************************************************************************
169 * Tries to launch a decoder and return score so that the interface is able
171 *****************************************************************************/
172 static int Open( vlc_object_t *p_this )
174 decoder_t *p_dec = (decoder_t *) p_this;
175 decoder_sys_t *p_sys = NULL;
179 if( p_dec->fmt_in.i_codec != VLC_FOURCC('t','e','l','x'))
184 p_dec->pf_decode_sub = Decode;
185 p_sys = p_dec->p_sys = malloc( sizeof(decoder_sys_t) );
189 memset( p_sys, 0, sizeof(decoder_sys_t) );
192 for ( i = 0; i < 9; i++ )
193 p_sys->pi_active_national_set[i] = ppi_national_subsets[1];
195 var_Create( p_dec, "telx-override-page",
196 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
197 var_Get( p_dec, "telx-override-page", &val );
198 if( val.i_int == -1 && p_dec->fmt_in.subs.dvb.i_id != -1 )
200 p_sys->i_wanted_magazine = p_dec->fmt_in.subs.dvb.i_id >> 16;
201 if( p_sys->i_wanted_magazine == 0 )
202 p_sys->i_wanted_magazine = 8;
203 p_sys->i_wanted_page = p_dec->fmt_in.subs.dvb.i_id & 0xff;
205 var_Create( p_dec, "telx-french-workaround",
206 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
207 var_Get( p_dec, "telx-french-workaround", &val );
208 if( p_sys->i_wanted_page < 100 &&
209 (val.b_bool || (p_sys->i_wanted_page % 16) >= 10))
211 /* See http://www.nada.kth.se/~ragge/vdr/ttxtsubs/TROUBLESHOOTING.txt
212 * paragraph about French channels - they mix up decimal and
214 p_sys->i_wanted_page = (p_sys->i_wanted_page / 10) * 16 +
215 (p_sys->i_wanted_page % 10);
218 else if( val.i_int <= 0 )
220 p_sys->i_wanted_magazine = -1;
221 p_sys->i_wanted_page = -1;
225 p_sys->i_wanted_magazine = val.i_int / 100;
226 p_sys->i_wanted_page = (((val.i_int % 100) / 10) << 4)
227 | ((val.i_int % 100) % 10);
229 var_Create( p_dec, "telx-ignore-subtitle-flag",
230 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
231 var_Get( p_dec, "telx-ignore-subtitle-flag", &val );
232 p_sys->b_ignore_sub_flag = val.b_bool;
234 msg_Dbg( p_dec, "starting telx on magazine %d page %x flag %d",
235 p_sys->i_wanted_magazine, p_sys->i_wanted_page,
236 p_sys->b_ignore_sub_flag );
245 /* return VLC_EGENERIC; */
248 /*****************************************************************************
250 *****************************************************************************/
251 static void Close( vlc_object_t *p_this )
253 decoder_t *p_dec = (decoder_t*) p_this;
254 decoder_sys_t *p_sys = p_dec->p_sys;
259 /**************************
260 * change bits endianness *
261 **************************/
262 static uint8_t bytereverse( int n )
264 n = (((n >> 1) & 0x55) | ((n << 1) & 0xaa));
265 n = (((n >> 2) & 0x33) | ((n << 2) & 0xcc));
266 n = (((n >> 4) & 0x0f) | ((n << 4) & 0xf0));
270 static int hamming_8_4( int a )
306 return -1; // decoding error , not yet corrected
311 // this is not a general function, but it's enough for what we do here
312 // the result buffer need to be at least 4 bytes long
313 static void to_utf8( char * res, uint16_t ch )
319 res[0] = (ch >> 12) | 0xE0;
320 res[1] = ((ch >> 6) & 0x3F) | 0x80;
321 res[2] = (ch & 0x3F) | 0x80;
326 res[0] = (ch >> 6) | 0xC0;
327 res[1] = (ch & 0x3F) | 0x80;
338 static void decode_string( char * res, int res_len,
339 decoder_sys_t *p_sys, int magazine,
340 uint8_t * packet, int len )
346 for ( i = 0; i < len; i++ )
348 int in = bytereverse( packet[i] ) & 0x7f;
354 /* special national characters */
356 out = p_sys->pi_active_national_set[magazine][0];
359 out = p_sys->pi_active_national_set[magazine][1];
362 out = p_sys->pi_active_national_set[magazine][2];
365 out = p_sys->pi_active_national_set[magazine][3];
368 out = p_sys->pi_active_national_set[magazine][4];
371 out = p_sys->pi_active_national_set[magazine][5];
374 out = p_sys->pi_active_national_set[magazine][6];
377 out = p_sys->pi_active_national_set[magazine][7];
380 out = p_sys->pi_active_national_set[magazine][8];
383 out = p_sys->pi_active_national_set[magazine][9];
386 out = p_sys->pi_active_national_set[magazine][10];
389 out = p_sys->pi_active_national_set[magazine][11];
392 out = p_sys->pi_active_national_set[magazine][12];
395 /* some special control characters (empirical) */
397 /* apparently this starts a sequence that ends with 0xb 0xb */
398 while ( i + 1 < len && (bytereverse( packet[i+1] ) & 0x7f) != 0x0b )
405 /* non documented national range 0x08 - 0x0f */
406 if ( in >= 0x08 && in <= 0x0f )
408 out = p_sys->pi_active_national_set[magazine][13 + in - 8];
413 if ( in > 32 && in < 0x7f )
417 /* handle undefined national characters */
421 /* convert to utf-8 */
422 to_utf8( utf8, out );
424 if ( pt + l < res + res_len - 1 )
436 /*****************************************************************************
438 *****************************************************************************/
439 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
441 decoder_sys_t *p_sys = p_dec->p_sys;
443 subpicture_t *p_spu = NULL;
448 int i_wanted_magazine = i_conf_wanted_page / 100;
449 int i_wanted_page = 0x10 * ((i_conf_wanted_page % 100) / 10)
450 | (i_conf_wanted_page % 10);
452 bool b_update = false;
453 char psz_text[512], *pt = psz_text;
457 if( pp_block == NULL || *pp_block == NULL )
460 if( p_block->i_rate != 0 )
461 p_block->i_length = p_block->i_length * p_block->i_rate / INPUT_RATE_DEFAULT;
464 dbg((p_dec, "start of telx packet with header %2x\n",
465 * (uint8_t *) p_block->p_buffer));
466 len = p_block->i_buffer;
467 for ( offset = 1; offset + 46 <= len; offset += 46 )
469 uint8_t * packet = (uint8_t *) p_block->p_buffer+offset;
470 // int vbi = ((0x20 & packet[2]) != 0 ? 0 : 313) + (0x1F & packet[2]);
472 // dbg((p_dec, "vbi %d header %02x %02x %02x\n", vbi, packet[0], packet[1], packet[2]));
473 if ( packet[0] == 0xFF ) continue;
475 /* if (packet[1] != 0x2C) { */
476 /* printf("wrong header\n"); */
481 int mpag = (hamming_8_4( packet[4] ) << 4) | hamming_8_4( packet[5] );
486 dbg((p_dec, "mpag hamming error\n"));
490 row = 0xFF & bytereverse(mpag);
491 magazine = (7 & row) == 0 ? 8 : (7 & row);
494 if ( p_sys->i_wanted_page != -1
495 && magazine != p_sys->i_wanted_magazine )
500 /* row 0 : flags and header line */
504 for ( a = 0; a < 6; a++ )
506 flag |= (0xF & (bytereverse( hamming_8_4(packet[8 + a]) ) >> 4))
510 /* if (!p_sys->b_ignore_sub_flag && !(1 & flag>>15)) */
513 p_sys->i_page[magazine] = (0xF0 & bytereverse( hamming_8_4(packet[7]) )) |
514 (0xF & (bytereverse( hamming_8_4(packet[6]) ) >> 4) );
516 decode_string( psz_line, sizeof(psz_line), p_sys, magazine,
517 packet + 14, 40 - 14 );
519 dbg((p_dec, "mag %d flags %x page %x character set %d subtitles %d", magazine, flag,
520 p_sys->i_page[magazine],
521 7 & flag>>21, 1 & flag>>15, psz_line));
523 p_sys->pi_active_national_set[magazine] =
524 ppi_national_subsets[7 & (flag >> 21)];
526 p_sys->b_is_subtitle[magazine] = p_sys->b_ignore_sub_flag
527 || ( (1 & (flag >> 15))
528 && (1 & (flag>>16)) );
530 dbg(( p_dec, "FLAGS%s%s%s%s%s%s%s mag_ser %d",
531 (1 & (flag>>14))? " news" : "",
532 (1 & (flag>>15))? " subtitle" : "",
533 (1 & (flag>>7))? " erase" : "",
534 (1 & (flag>>16))? " suppressed_head" : "",
535 (1 & (flag>>17))? " update" : "",
536 (1 & (flag>>18))? " interrupt" : "",
537 (1 & (flag>>19))? " inhibit" : "",
540 if ( (p_sys->i_wanted_page != -1
541 && p_sys->i_page[magazine] != p_sys->i_wanted_page)
542 || !p_sys->b_is_subtitle[magazine] )
545 p_sys->b_erase[magazine] = (1 & (flag >> 7));
547 dbg((p_dec, "%ld --> %ld\n", (long int) p_block->i_pts, (long int)(p_sys->prev_pts+1500000)));
549 * we ignore the erase flag if it happens less than 1.5 seconds
550 * before last caption
551 * TODO make this time configurable
552 * UPDATE the kludge seems to be no more necessary
553 * so it's commented out*/
554 if ( /*p_block->i_pts > p_sys->prev_pts + 1500000 && */
555 p_sys->b_erase[magazine] )
559 dbg((p_dec, "ERASE !\n"));
561 p_sys->b_erase[magazine] = 0;
562 for ( i = 1; i < 32; i++ )
564 if ( !p_sys->ppsz_lines[i][0] ) continue;
565 /* b_update = true; */
566 p_sys->ppsz_lines[i][0] = 0;
570 /* replace the row if it's different */
571 if ( strcmp(psz_line, p_sys->ppsz_lines[row]) )
573 strncpy( p_sys->ppsz_lines[row], psz_line,
574 sizeof(p_sys->ppsz_lines[row]) - 1);
583 /* row 1-23 : normal lines */
585 if ( (p_sys->i_wanted_page != -1
586 && p_sys->i_page[magazine] != p_sys->i_wanted_page)
587 || !p_sys->b_is_subtitle[magazine]
588 || (p_sys->i_wanted_page == -1
589 && p_sys->i_page[magazine] > 0x99) )
592 decode_string( psz_line, sizeof(psz_line), p_sys, magazine,
596 /* remove starting spaces */
597 while ( *t == 32 ) t++;
599 /* remove trailing spaces */
600 for ( i = strlen(t) - 1; i >= 0 && t[i] == 32; i-- );
603 /* replace the row if it's different */
604 if ( strcmp( t, p_sys->ppsz_lines[row] ) )
606 strncpy( p_sys->ppsz_lines[row], t,
607 sizeof(p_sys->ppsz_lines[row]) - 1 );
612 p_sys->prev_pts = p_block->i_pts;
614 dbg((p_dec, "%d %d : ", magazine, row));
615 dbg((p_dec, "%s\n", t));
621 for ( i = 0; i < 40; i++ )
623 int in = bytereverse(packet[6 + i]) & 0x7f;
624 sprintf(dbg + strlen(dbg), "%02x ", in);
626 dbg((p_dec, "%s\n", dbg));
628 for ( i = 0; i < 40; i++ )
630 decode_string( psz_line, sizeof(psz_line), p_sys, magazine,
632 sprintf( dbg + strlen(dbg), "%s ", psz_line );
634 dbg((p_dec, "%s\n", dbg));
638 else if ( row == 25 )
640 /* row 25 : alternate header line */
641 if ( (p_sys->i_wanted_page != -1
642 && p_sys->i_page[magazine] != p_sys->i_wanted_page)
643 || !p_sys->b_is_subtitle[magazine] )
646 decode_string( psz_line, sizeof(psz_line), p_sys, magazine,
649 /* replace the row if it's different */
650 if ( strcmp( psz_line, p_sys->ppsz_lines[0] ) )
652 strncpy( p_sys->ppsz_lines[0], psz_line,
653 sizeof(p_sys->ppsz_lines[0]) - 1 );
654 /* b_update = true; */
657 /* else if (row == 26) { */
658 /* // row 26 : TV listings */
660 /* dbg((p_dec, "%d %d : %s\n", magazine, row, decode_string(p_sys, magazine, packet+6, 40))); */
667 for ( i = 1; i < 24; i++ )
669 size_t l = strlen( p_sys->ppsz_lines[i] );
671 if ( l > sizeof(psz_text) - total - 1 )
672 l = sizeof(psz_text) - total - 1;
676 memcpy( pt, p_sys->ppsz_lines[i], l );
679 if ( sizeof(psz_text) - total - 1 > 0 )
688 if ( !strcmp(psz_text, p_sys->psz_prev_text) )
691 dbg((p_dec, "UPDATE TELETEXT PICTURE\n"));
693 assert( sizeof(p_sys->psz_prev_text) >= sizeof(psz_text) );
694 strcpy( p_sys->psz_prev_text, psz_text );
696 /* Create the subpicture unit */
697 p_spu = p_dec->pf_spu_buffer_new( p_dec );
700 msg_Warn( p_dec, "can't get spu buffer" );
704 /* Create a new subpicture region */
705 memset( &fmt, 0, sizeof(video_format_t) );
706 fmt.i_chroma = VLC_FOURCC('T','E','X','T');
708 fmt.i_width = fmt.i_height = 0;
709 fmt.i_x_offset = fmt.i_y_offset = 0;
710 p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
711 if( p_spu->p_region == NULL )
713 msg_Err( p_dec, "cannot allocate SPU region" );
717 /* Normal text subs, easy markup */
718 p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM | p_sys->i_align;
719 p_spu->i_x = p_sys->i_align ? 20 : 0;
722 p_spu->p_region->psz_text = strdup(psz_text);
723 p_spu->i_start = p_block->i_pts;
724 p_spu->i_stop = p_block->i_pts + p_block->i_length;
725 p_spu->b_ephemer = (p_block->i_length == 0);
726 p_spu->b_absolute = false;
727 p_spu->b_pausable = true;
728 dbg((p_dec, "%ld --> %ld\n", (long int) p_block->i_pts/100000, (long int)p_block->i_length/100000));
730 block_Release( p_block );
736 p_dec->pf_spu_buffer_del( p_dec, p_spu );
740 block_Release( p_block );