]> git.sesse.net Git - vlc/blob - modules/codec/cc.c
dtv: fix ISDB-S tuning
[vlc] / modules / codec / cc.c
1 /*****************************************************************************
2  * cc.c : CC 608/708 subtitles decoder
3  *****************************************************************************
4  * Copyright © 2007-2010 Laurent Aimar, 2011 VLC authors and VideoLAN
5  *
6  * Authors: Laurent Aimar < fenrir # via.ecp.fr>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or
11  * (at your option) any later version.
12  *
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 Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21  *****************************************************************************/
22
23 /*****************************************************************************
24  * Preamble
25  *****************************************************************************/
26 /* The EIA 608 decoder part has been initialy based on ccextractor (GPL)
27  * and rewritten */
28
29 /* TODO:
30  *  On discontinuity reset the decoder state
31  *  Check parity
32  *  708 decoding
33  */
34
35 #ifdef HAVE_CONFIG_H
36 # include "config.h"
37 #endif
38
39 #include <assert.h>
40
41 #include <vlc_common.h>
42 #include <vlc_plugin.h>
43 #include <vlc_codec.h>
44 #include <vlc_charset.h>
45
46 #include "substext.h"
47
48 /*****************************************************************************
49  * Module descriptor.
50  *****************************************************************************/
51 static int  Open ( vlc_object_t * );
52 static void Close( vlc_object_t * );
53
54 vlc_module_begin ()
55     set_shortname( N_("CC 608/708"))
56     set_description( N_("Closed Captions decoder") )
57     set_capability( "decoder", 50 )
58     set_callbacks( Open, Close )
59 vlc_module_end ()
60
61 /*****************************************************************************
62  * Local prototypes
63  *****************************************************************************/
64 typedef enum
65 {
66     EIA608_MODE_POPUP = 0,
67     EIA608_MODE_ROLLUP_2 = 1,
68     EIA608_MODE_ROLLUP_3 = 2,
69     EIA608_MODE_ROLLUP_4 = 3,
70     EIA608_MODE_PAINTON = 4,
71     EIA608_MODE_TEXT = 5
72 } eia608_mode_t;
73
74 typedef enum
75 {
76     EIA608_COLOR_WHITE = 0,
77     EIA608_COLOR_GREEN = 1,
78     EIA608_COLOR_BLUE = 2,
79     EIA608_COLOR_CYAN = 3,
80     EIA608_COLOR_RED = 4,
81     EIA608_COLOR_YELLOW = 5,
82     EIA608_COLOR_MAGENTA = 6,
83     EIA608_COLOR_USERDEFINED = 7
84 } eia608_color_t;
85
86 typedef enum
87 {
88     EIA608_FONT_REGULAR    = 0x00,
89     EIA608_FONT_ITALICS    = 0x01,
90     EIA608_FONT_UNDERLINE  = 0x02,
91     EIA608_FONT_UNDERLINE_ITALICS = EIA608_FONT_UNDERLINE | EIA608_FONT_ITALICS
92 } eia608_font_t;
93
94 #define EIA608_SCREEN_ROWS 15
95 #define EIA608_SCREEN_COLUMNS 32
96
97 struct eia608_screen // A CC buffer
98 {
99     uint8_t characters[EIA608_SCREEN_ROWS][EIA608_SCREEN_COLUMNS+1];
100     eia608_color_t colors[EIA608_SCREEN_ROWS][EIA608_SCREEN_COLUMNS+1];
101     eia608_font_t fonts[EIA608_SCREEN_ROWS][EIA608_SCREEN_COLUMNS+1]; // Extra char at the end for a 0
102     int row_used[EIA608_SCREEN_ROWS]; // Any data in row?
103 };
104 typedef struct eia608_screen eia608_screen;
105
106 typedef struct
107 {
108     /* Current channel (used to reject packet without channel information) */
109     int i_channel;
110
111     /* */
112     int           i_screen; /* Displayed screen */
113     eia608_screen screen[2];
114
115     struct
116     {
117         int i_row;
118         int i_column;
119     } cursor;
120
121     /* */
122     eia608_mode_t mode;
123     eia608_color_t color;
124     eia608_font_t font;
125     int i_row_rollup;
126
127     /* Last command pair (used to reject duplicated command) */
128     struct
129     {
130         uint8_t d1;
131         uint8_t d2;
132     } last;
133 } eia608_t;
134
135 static void         Eia608Init( eia608_t * );
136 static bool   Eia608Parse( eia608_t *h, int i_channel_selected, const uint8_t data[2] );
137 static char        *Eia608Text( eia608_t *h, bool b_html );
138
139 /* It will be enough up to 63 B frames, which is far too high for
140  * broadcast environment */
141 #define CC_MAX_REORDER_SIZE (64)
142 struct decoder_sys_t
143 {
144     int     i_block;
145     block_t *pp_block[CC_MAX_REORDER_SIZE];
146
147     int i_field;
148     int i_channel;
149
150     eia608_t eia608;
151 };
152
153 static subpicture_t *Decode( decoder_t *, block_t ** );
154
155 /*****************************************************************************
156  * Open: probe the decoder and return score
157  *****************************************************************************
158  * Tries to launch a decoder and return score so that the interface is able
159  * to chose.
160  *****************************************************************************/
161 static int Open( vlc_object_t *p_this )
162 {
163     decoder_t     *p_dec = (decoder_t*)p_this;
164     decoder_sys_t *p_sys;
165     int i_field;
166     int i_channel;
167
168     switch( p_dec->fmt_in.i_codec )
169     {
170         case VLC_FOURCC('c','c','1',' '):
171             i_field = 0; i_channel = 1;
172             break;
173         case VLC_FOURCC('c','c','2',' '):
174             i_field = 0; i_channel = 2;
175             break;
176         case VLC_FOURCC('c','c','3',' '):
177             i_field = 1; i_channel = 1;
178             break;
179         case VLC_FOURCC('c','c','4',' '):
180             i_field = 1; i_channel = 2;
181             break;
182
183         default:
184             return VLC_EGENERIC;
185     }
186
187     p_dec->pf_decode_sub = Decode;
188
189     /* Allocate the memory needed to store the decoder's structure */
190     p_dec->p_sys = p_sys = calloc( 1, sizeof( *p_sys ) );
191     if( p_sys == NULL )
192         return VLC_ENOMEM;
193
194     /* init of p_sys */
195     p_sys->i_field = i_field;
196     p_sys->i_channel = i_channel;
197
198     Eia608Init( &p_sys->eia608 );
199
200     p_dec->fmt_out.i_cat = SPU_ES;
201     p_dec->fmt_out.i_codec = VLC_CODEC_TEXT;
202
203     return VLC_SUCCESS;
204 }
205
206 /****************************************************************************
207  * Decode: the whole thing
208  ****************************************************************************
209  *
210  ****************************************************************************/
211 static void     Push( decoder_t *, block_t * );
212 static block_t *Pop( decoder_t * );
213 static subpicture_t *Convert( decoder_t *, block_t * );
214
215 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
216 {
217     if( pp_block && *pp_block )
218     {
219         Push( p_dec, *pp_block );
220         *pp_block = NULL;
221     }
222
223     for( ;; )
224     {
225         block_t *p_block = Pop( p_dec );
226         if( !p_block )
227             break;
228
229         subpicture_t *p_spu = Convert( p_dec, p_block );
230         if( p_spu )
231             return p_spu;
232     }
233     return NULL;
234 }
235
236 /*****************************************************************************
237  * CloseDecoder: clean up the decoder
238  *****************************************************************************/
239 static void Close( vlc_object_t *p_this )
240 {
241     decoder_t *p_dec = (decoder_t *)p_this;
242     decoder_sys_t *p_sys = p_dec->p_sys;
243
244     for( int i = 0; i < p_sys->i_block; i++ )
245         block_Release( p_sys->pp_block[i] );
246     free( p_sys );
247 }
248
249 /*****************************************************************************
250  *
251  *****************************************************************************/
252 static void Push( decoder_t *p_dec, block_t *p_block )
253 {
254     decoder_sys_t *p_sys = p_dec->p_sys;
255
256     if( p_sys->i_block >= CC_MAX_REORDER_SIZE )
257     {
258         msg_Warn( p_dec, "Trashing a CC entry" );
259         memmove( &p_sys->pp_block[0], &p_sys->pp_block[1], sizeof(*p_sys->pp_block) * (CC_MAX_REORDER_SIZE-1) );
260         p_sys->i_block--;
261     }
262     p_sys->pp_block[p_sys->i_block++] = p_block;
263 }
264 static block_t *Pop( decoder_t *p_dec )
265 {
266     decoder_sys_t *p_sys = p_dec->p_sys;
267     block_t *p_block;
268     int i_index;
269     /* XXX Cc captions data are OUT OF ORDER (because we receive them in the bitstream
270      * order (ie ordered by video picture dts) instead of the display order.
271      *  We will simulate a simple IPB buffer scheme
272      * and reorder with pts.
273      * XXX it won't work with H264 which use non out of order B picture or MMCO
274      */
275
276     /* Wait for a P and output all *previous* picture by pts order (for
277      * hierarchical B frames) */
278     if( p_sys->i_block <= 1 ||
279         ( p_sys->pp_block[p_sys->i_block-1]->i_flags & BLOCK_FLAG_TYPE_B ) )
280         return NULL;
281
282     p_block = p_sys->pp_block[i_index = 0];
283     if( p_block->i_pts > VLC_TS_INVALID )
284     {
285         for( int i = 1; i < p_sys->i_block-1; i++ )
286         {
287             if( p_sys->pp_block[i]->i_pts > VLC_TS_INVALID && p_block->i_pts > VLC_TS_INVALID &&
288                 p_sys->pp_block[i]->i_pts < p_block->i_pts )
289                 p_block = p_sys->pp_block[i_index = i];
290         }
291     }
292     assert( i_index+1 < p_sys->i_block );
293     memmove( &p_sys->pp_block[i_index], &p_sys->pp_block[i_index+1], sizeof(*p_sys->pp_block) * ( p_sys->i_block - i_index - 1 ) );
294     p_sys->i_block--;
295
296     return p_block;
297 }
298
299 static subpicture_t *Subtitle( decoder_t *p_dec, char *psz_subtitle, char *psz_html, mtime_t i_pts )
300 {
301     //decoder_sys_t *p_sys = p_dec->p_sys;
302     subpicture_t *p_spu = NULL;
303
304     /* We cannot display a subpicture with no date */
305     if( i_pts <= VLC_TS_INVALID )
306     {
307         msg_Warn( p_dec, "subtitle without a date" );
308         return NULL;
309     }
310
311     EnsureUTF8( psz_subtitle );
312     if( psz_html )
313         EnsureUTF8( psz_html );
314
315     /* Create the subpicture unit */
316     p_spu = decoder_NewSubpictureText( p_dec );
317     if( !p_spu )
318     {
319         free( psz_subtitle );
320         free( psz_html );
321         return NULL;
322     }
323     p_spu->i_start    = i_pts;
324     p_spu->i_stop     = i_pts + 10000000;   /* 10s max */
325     p_spu->b_ephemer  = true;
326     p_spu->b_absolute = false;
327
328     subpicture_updater_sys_t *p_spu_sys = p_spu->updater.p_sys;
329
330     /* The "leavetext" alignment is a special mode where the subpicture
331        region itself gets aligned, but the text inside it does not */
332     p_spu_sys->align = SUBPICTURE_ALIGN_LEAVETEXT;
333     p_spu_sys->text  = psz_subtitle;
334     p_spu_sys->html  = psz_html;
335     p_spu_sys->i_font_height_percent = 5;
336     p_spu_sys->renderbg = true;
337
338     return p_spu;
339 }
340
341 static subpicture_t *Convert( decoder_t *p_dec, block_t *p_block )
342 {
343     assert( p_block );
344
345     decoder_sys_t *p_sys = p_dec->p_sys;
346     const int64_t i_pts = p_block->i_pts;
347     bool b_changed = false;
348
349     /* TODO do the real decoding here */
350     while( p_block->i_buffer >= 3 )
351     {
352         if( p_block->p_buffer[0] == p_sys->i_field )
353             b_changed |= Eia608Parse( &p_sys->eia608, p_sys->i_channel, &p_block->p_buffer[1] );
354
355         p_block->i_buffer -= 3;
356         p_block->p_buffer += 3;
357     }
358     if( p_block )
359         block_Release( p_block );
360
361     if( b_changed )
362     {
363         char *psz_subtitle = Eia608Text( &p_sys->eia608, false );
364         char *psz_html = Eia608Text( &p_sys->eia608, true );
365         return Subtitle( p_dec, psz_subtitle, psz_html, i_pts );
366     }
367     return NULL;
368 }
369
370
371 /*****************************************************************************
372  *
373  *****************************************************************************/
374 static const struct {
375     eia608_color_t  i_color;
376     eia608_font_t   i_font;
377     int             i_column;
378 } pac2_attribs[]= {
379     { EIA608_COLOR_WHITE,   EIA608_FONT_REGULAR,           0 },
380     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE,         0 },
381     { EIA608_COLOR_GREEN,   EIA608_FONT_REGULAR,           0 },
382     { EIA608_COLOR_GREEN,   EIA608_FONT_UNDERLINE,         0 },
383     { EIA608_COLOR_BLUE,    EIA608_FONT_REGULAR,           0 },
384     { EIA608_COLOR_BLUE,    EIA608_FONT_UNDERLINE,         0 },
385     { EIA608_COLOR_CYAN,    EIA608_FONT_REGULAR,           0 },
386     { EIA608_COLOR_CYAN,    EIA608_FONT_UNDERLINE,         0 },
387     { EIA608_COLOR_RED,     EIA608_FONT_REGULAR,           0 },
388     { EIA608_COLOR_RED,     EIA608_FONT_UNDERLINE,         0 },
389     { EIA608_COLOR_YELLOW,  EIA608_FONT_REGULAR,           0 },
390     { EIA608_COLOR_YELLOW,  EIA608_FONT_UNDERLINE,         0 },
391     { EIA608_COLOR_MAGENTA, EIA608_FONT_REGULAR,           0 },
392     { EIA608_COLOR_MAGENTA, EIA608_FONT_UNDERLINE,         0 },
393     { EIA608_COLOR_WHITE,   EIA608_FONT_ITALICS,           0 },
394     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE_ITALICS, 0 },
395
396     { EIA608_COLOR_WHITE,   EIA608_FONT_REGULAR,           0 },
397     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE,         0 },
398     { EIA608_COLOR_WHITE,   EIA608_FONT_REGULAR,           4 },
399     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE,         4 },
400     { EIA608_COLOR_WHITE,   EIA608_FONT_REGULAR,           8 },
401     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE,         8 },
402     { EIA608_COLOR_WHITE,   EIA608_FONT_REGULAR,          12 },
403     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE,        12 },
404     { EIA608_COLOR_WHITE,   EIA608_FONT_REGULAR,          16 },
405     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE,        16 },
406     { EIA608_COLOR_WHITE,   EIA608_FONT_REGULAR,          20 },
407     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE,        20 },
408     { EIA608_COLOR_WHITE,   EIA608_FONT_REGULAR,          24 },
409     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE,        24 },
410     { EIA608_COLOR_WHITE,   EIA608_FONT_REGULAR,          28 },
411     { EIA608_COLOR_WHITE,   EIA608_FONT_UNDERLINE,        28 } ,
412 };
413
414 #define EIA608_COLOR_DEFAULT EIA608_COLOR_WHITE
415
416 static void Eia608Cursor( eia608_t *h, int dx )
417 {
418     h->cursor.i_column += dx;
419     if( h->cursor.i_column < 0 )
420         h->cursor.i_column = 0;
421     else if( h->cursor.i_column > EIA608_SCREEN_COLUMNS-1 )
422         h->cursor.i_column = EIA608_SCREEN_COLUMNS-1;
423 }
424 static void Eia608ClearScreenRowX( eia608_t *h, int i_screen, int i_row, int x )
425 {
426     eia608_screen *screen = &h->screen[i_screen];
427
428     if( x == 0 )
429     {
430         screen->row_used[i_row] = false;
431     }
432     else
433     {
434         screen->row_used[i_row] = false;
435         for( int i = 0; i < x; i++ )
436         {
437             if( screen->characters[i_row][i] != ' ' ||
438                 screen->colors[i_row][i] != EIA608_COLOR_DEFAULT ||
439                 screen->fonts[i_row][i] != EIA608_FONT_REGULAR )
440             {
441                 screen->row_used[i_row] = true;
442                 break;
443             }
444         }
445     }
446
447     for( ; x < EIA608_SCREEN_COLUMNS+1; x++ )
448     {
449         screen->characters[i_row][x] = x < EIA608_SCREEN_COLUMNS ? ' ' : '\0';
450         screen->colors[i_row][x] = EIA608_COLOR_DEFAULT;
451         screen->fonts[i_row][x] = EIA608_FONT_REGULAR;
452     }
453 }
454
455 static void Eia608ClearScreenRow( eia608_t *h, int i_screen, int i_row )
456 {
457     Eia608ClearScreenRowX( h, i_screen, i_row, 0 );
458 }
459
460 static void Eia608ClearScreen( eia608_t *h, int i_screen )
461 {
462     for( int i = 0; i < EIA608_SCREEN_ROWS; i++ )
463         Eia608ClearScreenRow( h, i_screen, i );
464 }
465
466 static int Eia608GetWritingScreenIndex( eia608_t *h )
467 {
468     switch( h->mode )
469     {
470     case EIA608_MODE_POPUP:    // Non displayed screen
471         return 1 - h->i_screen;
472
473     case EIA608_MODE_ROLLUP_2: // Displayed screen
474     case EIA608_MODE_ROLLUP_3:
475     case EIA608_MODE_ROLLUP_4:
476     case EIA608_MODE_PAINTON:
477         return h->i_screen;
478     default:
479         /* It cannot happen, else it is a bug */
480         assert( 0 );
481         return 0;
482     }
483 }
484
485 static void Eia608EraseScreen( eia608_t *h, bool b_displayed )
486 {
487     Eia608ClearScreen( h, b_displayed ? h->i_screen : (1-h->i_screen) );
488 }
489
490 static void Eia608Write( eia608_t *h, const uint8_t c )
491 {
492     const int i_row = h->cursor.i_row;
493     const int i_column = h->cursor.i_column;
494     eia608_screen *screen;
495
496     if( h->mode == EIA608_MODE_TEXT )
497         return;
498
499     screen = &h->screen[Eia608GetWritingScreenIndex( h )];
500
501     screen->characters[i_row][i_column] = c;
502     screen->colors[i_row][i_column] = h->color;
503     screen->fonts[i_row][i_column] = h->font;
504     screen->row_used[i_row] = true;
505     Eia608Cursor( h, 1 );
506 }
507 static void Eia608Erase( eia608_t *h )
508 {
509     const int i_row = h->cursor.i_row;
510     const int i_column = h->cursor.i_column - 1;
511     eia608_screen *screen;
512
513     if( h->mode == EIA608_MODE_TEXT )
514         return;
515     if( i_column < 0 )
516         return;
517
518     screen = &h->screen[Eia608GetWritingScreenIndex( h )];
519
520     /* FIXME do we need to reset row_used/colors/font ? */
521     screen->characters[i_row][i_column] = ' ';
522     Eia608Cursor( h, -1 );
523 }
524 static void Eia608EraseToEndOfRow( eia608_t *h )
525 {
526     if( h->mode == EIA608_MODE_TEXT )
527         return;
528
529     Eia608ClearScreenRowX( h, Eia608GetWritingScreenIndex( h ), h->cursor.i_row, h->cursor.i_column );
530 }
531
532 static void Eia608RollUp( eia608_t *h )
533 {
534     if( h->mode == EIA608_MODE_TEXT )
535         return;
536
537     const int i_screen = Eia608GetWritingScreenIndex( h );
538     eia608_screen *screen = &h->screen[i_screen];
539
540     int keep_lines;
541
542     /* Window size */
543     if( h->mode == EIA608_MODE_ROLLUP_2 )
544         keep_lines = 2;
545     else if( h->mode == EIA608_MODE_ROLLUP_3 )
546         keep_lines = 3;
547     else if( h->mode == EIA608_MODE_ROLLUP_4 )
548         keep_lines = 4;
549     else
550         return;
551
552     /* Reset the cursor */
553     h->cursor.i_column = 0;
554
555     /* Erase lines above our window */
556     for( int i = 0; i < h->cursor.i_row - keep_lines; i++ )
557         Eia608ClearScreenRow( h, i_screen, i );
558
559     /* Move up */
560     for( int i = 0; i < keep_lines-1; i++ )
561     {
562         const int i_row = h->cursor.i_row - keep_lines + i + 1;
563         if( i_row < 0 )
564             continue;
565         assert( i_row+1 < EIA608_SCREEN_ROWS );
566         memcpy( screen->characters[i_row], screen->characters[i_row+1], sizeof(*screen->characters) );
567         memcpy( screen->colors[i_row], screen->colors[i_row+1], sizeof(*screen->colors) );
568         memcpy( screen->fonts[i_row], screen->fonts[i_row+1], sizeof(*screen->fonts) );
569         screen->row_used[i_row] = screen->row_used[i_row+1];
570     }
571     /* Reset current row */
572     Eia608ClearScreenRow( h, i_screen, h->cursor.i_row );
573 }
574 static void Eia608ParseChannel( eia608_t *h, const uint8_t d[2] )
575 {
576     /* Check odd parity */
577     static const int p4[16] = {
578         0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0
579     };
580     if( p4[d[0] & 0xf] == p4[d[0] >> 4] ||
581         p4[d[1] & 0xf] == p4[ d[1] >> 4] )
582     {
583         h->i_channel = -1;
584         return;
585     }
586
587     /* */
588     const int d1 = d[0] & 0x7f;
589     if( d1 >= 0x10 && d1 <= 0x1f )
590         h->i_channel = 1 + ((d1 & 0x08) != 0);
591     else if( d1 < 0x10 )
592         h->i_channel = 3;
593 }
594 static bool Eia608ParseTextAttribute( eia608_t *h, uint8_t d2 )
595 {
596     const int i_index = d2 - 0x20;
597     assert( d2 >= 0x20 && d2 <= 0x2f );
598
599     h->color = pac2_attribs[i_index].i_color;
600     h->font  = pac2_attribs[i_index].i_font;
601     Eia608Cursor( h, 1 );
602
603     return false;
604 }
605 static bool Eia608ParseSingle( eia608_t *h, const uint8_t dx )
606 {
607     assert( dx >= 0x20 );
608     Eia608Write( h, dx );
609     return true;
610 }
611 static bool Eia608ParseDouble( eia608_t *h, uint8_t d2 )
612 {
613     assert( d2 >= 0x30 && d2 <= 0x3f );
614     Eia608Write( h, d2 + 0x50 ); /* We use charaters 0x80...0x8f */
615     return true;
616 }
617 static bool Eia608ParseExtended( eia608_t *h, uint8_t d1, uint8_t d2 )
618 {
619     assert( d2 >= 0x20 && d2 <= 0x3f );
620     assert( d1 == 0x12 || d1 == 0x13 );
621     if( d1 == 0x12 )
622         d2 += 0x70; /* We use charaters 0x90-0xaf */
623     else
624         d2 += 0x90; /* We use charaters 0xb0-0xcf */
625
626     /* The extended characters replace the previous one with a more
627      * advanced one */
628     Eia608Cursor( h, -1 );
629     Eia608Write( h, d2 );
630     return true;
631 }
632 static bool Eia608ParseCommand0x14( eia608_t *h, uint8_t d2 )
633 {
634     bool b_changed = false;
635
636     switch( d2 )
637     {
638     case 0x20:  /* Resume caption loading */
639         h->mode = EIA608_MODE_POPUP;
640         break;
641     case 0x21:  /* Backspace */
642         Eia608Erase( h );
643         b_changed = true;
644         break;
645     case 0x22:  /* Reserved */
646     case 0x23:
647         break;
648     case 0x24:  /* Delete to end of row */
649         Eia608EraseToEndOfRow( h );
650         break;
651     case 0x25:  /* Rollup 2 */
652     case 0x26:  /* Rollup 3 */
653     case 0x27:  /* Rollup 4 */
654         if( h->mode == EIA608_MODE_POPUP || h->mode == EIA608_MODE_PAINTON )
655         {
656             Eia608EraseScreen( h, true );
657             Eia608EraseScreen( h, false );
658             b_changed = true;
659         }
660
661         if( d2 == 0x25 )
662             h->mode = EIA608_MODE_ROLLUP_2;
663         else if( d2 == 0x26 )
664             h->mode = EIA608_MODE_ROLLUP_3;
665         else
666             h->mode = EIA608_MODE_ROLLUP_4;
667
668         h->cursor.i_column = 0;
669         h->cursor.i_row = h->i_row_rollup;
670         break;
671     case 0x28:  /* Flash on */
672         /* TODO */
673         break;
674     case 0x29:  /* Resume direct captionning */
675         h->mode = EIA608_MODE_PAINTON;
676         break;
677     case 0x2a:  /* Text restart */
678         /* TODO */
679         break;
680
681     case 0x2b: /* Resume text display */
682         h->mode = EIA608_MODE_TEXT;
683         break;
684
685     case 0x2c: /* Erase displayed memory */
686         Eia608EraseScreen( h, true );
687         b_changed = true;
688         break;
689     case 0x2d: /* Carriage return */
690         Eia608RollUp(h);
691         b_changed = true;
692         break;
693     case 0x2e: /* Erase non displayed memory */
694         Eia608EraseScreen( h, false );
695         break;
696     case 0x2f: /* End of caption (flip screen if not paint on) */
697         if( h->mode != EIA608_MODE_PAINTON )
698             h->i_screen = 1 - h->i_screen;
699         h->mode = EIA608_MODE_POPUP;
700         h->cursor.i_column = 0;
701         h->cursor.i_row = 0;
702         h->color = EIA608_COLOR_DEFAULT;
703         h->font = EIA608_FONT_REGULAR;
704         b_changed = true;
705         break;
706     }
707     return b_changed;
708 }
709 static bool Eia608ParseCommand0x17( eia608_t *h, uint8_t d2 )
710 {
711     switch( d2 )
712     {
713     case 0x21:  /* Tab offset 1 */
714         Eia608Cursor( h, 1 );
715         break;
716     case 0x22:  /* Tab offset 2 */
717         Eia608Cursor( h, 2 );
718         break;
719     case 0x23:  /* Tab offset 3 */
720         Eia608Cursor( h, 3 );
721         break;
722     }
723     return false;
724 }
725 static bool Eia608ParsePac( eia608_t *h, uint8_t d1, uint8_t d2 )
726 {
727     static const int pi_row[] = {
728         11, -1, 1, 2, 3, 4, 12, 13, 14, 15, 5, 6, 7, 8, 9, 10
729     };
730     const int i_row_index = ( (d1<<1) & 0x0e) | ( (d2>>5) & 0x01 );
731
732     assert( d2 >= 0x40 && d2 <= 0x7f );
733
734     if( pi_row[i_row_index] <= 0 )
735         return false;
736
737     /* Row */
738     if( h->mode != EIA608_MODE_TEXT )
739         h->cursor.i_row = pi_row[i_row_index] - 1;
740     h->i_row_rollup = pi_row[i_row_index] - 1;
741     /* Column */
742     if( d2 >= 0x60 )
743         d2 -= 0x60;
744     else if( d2 >= 0x40 )
745         d2 -= 0x40;
746     h->cursor.i_column = pac2_attribs[d2].i_column;
747     h->color = pac2_attribs[d2].i_color;
748     h->font  = pac2_attribs[d2].i_font;
749
750     return false;
751 }
752
753 static bool Eia608ParseData( eia608_t *h, uint8_t d1, uint8_t d2 )
754 {
755     bool b_changed = false;
756
757     if( d1 >= 0x18 && d1 <= 0x1f )
758         d1 -= 8;
759
760 #define ON( d2min, d2max, cmd ) do { if( d2 >= d2min && d2 <= d2max ) b_changed = cmd; } while(0)
761     switch( d1 )
762     {
763     case 0x11:
764         ON( 0x20, 0x2f, Eia608ParseTextAttribute( h, d2 ) );
765         ON( 0x30, 0x3f, Eia608ParseDouble( h, d2 ) );
766         break;
767     case 0x12: case 0x13:
768         ON( 0x20, 0x3f, Eia608ParseExtended( h, d1, d2 ) );
769         break;
770     case 0x14: case 0x15:
771         ON( 0x20, 0x2f, Eia608ParseCommand0x14( h, d2 ) );
772         break;
773     case 0x17:
774         ON( 0x21, 0x22, Eia608ParseCommand0x17( h, d2 ) );
775         ON( 0x2e, 0x2f, Eia608ParseTextAttribute( h, d2 ) );
776         break;
777     }
778     if( d1 == 0x10 )
779         ON( 0x40, 0x5f, Eia608ParsePac( h, d1, d2 ) );
780     else if( d1 >= 0x11 && d1 <= 0x17 )
781         ON( 0x40, 0x7f, Eia608ParsePac( h, d1, d2 ) );
782 #undef ON
783     if( d1 >= 0x20 )
784     {
785         b_changed = Eia608ParseSingle( h, d1 );
786         if( d2 >= 0x20 )
787             b_changed |= Eia608ParseSingle( h, d2 );
788     }
789     return b_changed;
790 }
791
792 static void Eia608TextUtf8( char *psz_utf8, uint8_t c ) // Returns number of bytes used
793 {
794 #define E1(c,u) { c, { u, '\0' } }
795 #define E2(c,u1,u2) { c, { u1, u2, '\0' } }
796 #define E3(c,u1,u2,u3) { c, { u1, u2, u3, '\0' } }
797     static const struct {
798         uint8_t c;
799         char utf8[3+1];
800     } c2utf8[] = {
801         // Regular line-21 character set, mostly ASCII except these exceptions
802         E2( 0x2a, 0xc3,0xa1), // lowercase a, acute accent
803         E2( 0x5c, 0xc3,0xa9), // lowercase e, acute accent
804         E2( 0x5e, 0xc3,0xad), // lowercase i, acute accent
805         E2( 0x5f, 0xc3,0xb3), // lowercase o, acute accent
806         E2( 0x60, 0xc3,0xba), // lowercase u, acute accent
807         E2( 0x7b, 0xc3,0xa7), // lowercase c with cedilla
808         E2( 0x7c, 0xc3,0xb7), // division symbol
809         E2( 0x7d, 0xc3,0x91), // uppercase N tilde
810         E2( 0x7e, 0xc3,0xb1), // lowercase n tilde
811         // THIS BLOCK INCLUDES THE 16 EXTENDED (TWO-BYTE) LINE 21 CHARACTERS
812         // THAT COME FROM HI BYTE=0x11 AND LOW BETWEEN 0x30 AND 0x3F
813         E2( 0x80, 0xc2,0xae), // Registered symbol (R)
814         E2( 0x81, 0xc2,0xb0), // degree sign
815         E2( 0x82, 0xc2,0xbd), // 1/2 symbol
816         E2( 0x83, 0xc2,0xbf), // Inverted (open) question mark
817         E3( 0x84, 0xe2,0x84,0xa2), // Trademark symbol (TM)
818         E2( 0x85, 0xc2,0xa2), // Cents symbol
819         E2( 0x86, 0xc2,0xa3), // Pounds sterling
820         E3( 0x87, 0xe2,0x99,0xaa), // Music note
821         E2( 0x88, 0xc3,0xa0), // lowercase a, grave accent
822         E2( 0x89, 0xc2,0xa0), // transparent space
823         E2( 0x8a, 0xc3,0xa8), // lowercase e, grave accent
824         E2( 0x8b, 0xc3,0xa2), // lowercase a, circumflex accent
825         E2( 0x8c, 0xc3,0xaa), // lowercase e, circumflex accent
826         E2( 0x8d, 0xc3,0xae), // lowercase i, circumflex accent
827         E2( 0x8e, 0xc3,0xb4), // lowercase o, circumflex accent
828         E2( 0x8f, 0xc3,0xbb), // lowercase u, circumflex accent
829         // THIS BLOCK INCLUDES THE 32 EXTENDED (TWO-BYTE) LINE 21 CHARACTERS
830         // THAT COME FROM HI BYTE=0x12 AND LOW BETWEEN 0x20 AND 0x3F
831         E2( 0x90, 0xc3,0x81), // capital letter A with acute
832         E2( 0x91, 0xc3,0x89), // capital letter E with acute
833         E2( 0x92, 0xc3,0x93), // capital letter O with acute
834         E2( 0x93, 0xc3,0x9a), // capital letter U with acute
835         E2( 0x94, 0xc3,0x9c), // capital letter U with diaresis
836         E2( 0x95, 0xc3,0xbc), // lowercase letter U with diaeresis
837         E1( 0x96, 0x27), // apostrophe
838         E2( 0x97, 0xc2,0xa1), // inverted exclamation mark
839         E1( 0x98, 0x2a), // asterisk
840         E1( 0x99, 0x27), // apostrophe (yes, duped). See CCADI source code.
841         E1( 0x9a, 0x2d), // hyphen-minus
842         E2( 0x9b, 0xc2,0xa9), // copyright sign
843         E3( 0x9c, 0xe2,0x84,0xa0), // Service mark
844         E1( 0x9d, 0x2e), // Full stop (.)
845         E3( 0x9e, 0xe2,0x80,0x9c), // Quotation mark
846         E3( 0x9f, 0xe2,0x80,0x9d), // Quotation mark
847         E2( 0xa0, 0xc3,0x80), // uppercase A, grave accent
848         E2( 0xa1, 0xc3,0x82), // uppercase A, circumflex
849         E2( 0xa2, 0xc3,0x87), // uppercase C with cedilla
850         E2( 0xa3, 0xc3,0x88), // uppercase E, grave accent
851         E2( 0xa4, 0xc3,0x8a), // uppercase E, circumflex
852         E2( 0xa5, 0xc3,0x8b), // capital letter E with diaresis
853         E2( 0xa6, 0xc3,0xab), // lowercase letter e with diaresis
854         E2( 0xa7, 0xc3,0x8e), // uppercase I, circumflex
855         E2( 0xa8, 0xc3,0x8f), // uppercase I, with diaresis
856         E2( 0xa9, 0xc3,0xaf), // lowercase i, with diaresis
857         E2( 0xaa, 0xc3,0x94), // uppercase O, circumflex
858         E2( 0xab, 0xc3,0x99), // uppercase U, grave accent
859         E2( 0xac, 0xc3,0xb9), // lowercase u, grave accent
860         E2( 0xad, 0xc3,0x9b), // uppercase U, circumflex
861         E2( 0xae, 0xc2,0xab), // LEFT-POINTING DOUBLE ANGLE QUOTATION MARK
862         E2( 0xaf, 0xc2,0xbb), // RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK
863         // THIS BLOCK INCLUDES THE 32 EXTENDED (TWO-BYTE) LINE 21 CHARACTERS
864         // THAT COME FROM HI BYTE=0x13 AND LOW BETWEEN 0x20 AND 0x3F
865         E2( 0xb0, 0xc3,0x83), // Uppercase A, tilde
866         E2( 0xb1, 0xc3,0xa3), // Lowercase a, tilde
867         E2( 0xb2, 0xc3,0x8d), // Uppercase I, acute accent
868         E2( 0xb3, 0xc3,0x8c), // Uppercase I, grave accent
869         E2( 0xb4, 0xc3,0xac), // Lowercase i, grave accent
870         E2( 0xb5, 0xc3,0x92), // Uppercase O, grave accent
871         E2( 0xb6, 0xc3,0xb2), // Lowercase o, grave accent
872         E2( 0xb7, 0xc3,0x95), // Uppercase O, tilde
873         E2( 0xb8, 0xc3,0xb5), // Lowercase o, tilde
874         E1( 0xb9, 0x7b), // Open curly brace
875         E1( 0xba, 0x7d), // Closing curly brace
876         E1( 0xbb, 0x5c), // Backslash
877         E1( 0xbc, 0x5e), // Caret
878         E1( 0xbd, 0x5f), // Underscore
879         E2( 0xbe, 0xc2,0xa6), // Pipe (broken bar)
880         E1( 0xbf, 0x7e), // Tilde (utf8 code unsure)
881         E2( 0xc0, 0xc3,0x84), // Uppercase A, umlaut
882         E2( 0xc1, 0xc3,0xa4), // Lowercase A, umlaut
883         E2( 0xc2, 0xc3,0x96), // Uppercase O, umlaut
884         E2( 0xc3, 0xc3,0xb6), // Lowercase o, umlaut
885         E2( 0xc4, 0xc3,0x9f), // Esszett (sharp S)
886         E2( 0xc5, 0xc2,0xa5), // Yen symbol
887         E2( 0xc6, 0xc2,0xa4), // Currency symbol
888         E1( 0xc7, 0x7c), // Vertical bar
889         E2( 0xc8, 0xc3,0x85), // Uppercase A, ring
890         E2( 0xc9, 0xc3,0xa5), // Lowercase A, ring
891         E2( 0xca, 0xc3,0x98), // Uppercase O, slash
892         E2( 0xcb, 0xc3,0xb8), // Lowercase o, slash
893         E3( 0xcc, 0xe2,0x8c,0x9c), // Upper left corner
894         E3( 0xcd, 0xe2,0x8c,0x9d), // Upper right corner
895         E3( 0xce, 0xe2,0x8c,0x9e), // Lower left corner
896         E3( 0xcf, 0xe2,0x8c,0x9f), // Lower right corner
897
898         E1(0,0)
899     };
900 #undef E3
901 #undef E2
902 #undef E1
903
904     for( size_t i = 0; i < ARRAY_SIZE(c2utf8) ; i++ )
905         if( c2utf8[i].c == c ) {
906             strcpy( psz_utf8, c2utf8[i].utf8 );
907             return;
908         }
909
910     psz_utf8[0] = c < 0x80 ? c : '?';   /* Normal : Unsupported */
911     psz_utf8[1] = '\0';
912 }
913
914 static void Eia608Strlcat( char *d, const char *s, int i_max )
915 {
916     if( i_max > 1 )
917         strncat( d, s, i_max-1 - strnlen(d, i_max-1));
918     if( i_max > 0 )
919         d[i_max-1] = '\0';
920 }
921
922 #define CAT(t) Eia608Strlcat( psz_text, t, i_text_max )
923
924 static void Eia608TextLine( struct eia608_screen *screen, char *psz_text, int i_text_max, int i_row, bool b_html )
925 {
926     const uint8_t *p_char = screen->characters[i_row];
927     const eia608_color_t *p_color = screen->colors[i_row];
928     const eia608_font_t *p_font = screen->fonts[i_row];
929     int i_start;
930     int i_end;
931     int x;
932     eia608_color_t last_color = EIA608_COLOR_DEFAULT;
933     bool     b_last_italics = false;
934     bool     b_last_underline = false;
935     char utf8[4];
936
937     /* Search the start */
938     i_start = 0;
939
940     /* Ensure we get a monospaced font (required for accurate positioning */
941     if( b_html )
942         CAT( "<tt>" );
943
944     /* Convert leading spaces to non-breaking so that they don't get
945        stripped by the RenderHtml routine as regular whitespace */
946     while( i_start < EIA608_SCREEN_COLUMNS && p_char[i_start] == ' ' ) {
947         Eia608TextUtf8( utf8, 0x89 );
948         CAT( utf8 );
949         i_start++;
950     }
951
952     /* Search the end */
953     i_end = EIA608_SCREEN_COLUMNS-1;
954     while( i_end > i_start && p_char[i_end] == ' ' )
955         i_end--;
956
957     /* */
958     for( x = i_start; x <= i_end; x++ )
959     {
960         eia608_color_t color = p_color[x];
961         bool b_italics = p_font[x] & EIA608_FONT_ITALICS;
962         bool b_underline = p_font[x] & EIA608_FONT_UNDERLINE;
963
964         /* */
965         if( b_html )
966         {
967             bool b_close_color, b_close_italics, b_close_underline;
968
969             /* We create the tags font / i / u in that orders */
970             b_close_color = color != last_color && last_color != EIA608_COLOR_DEFAULT;
971             b_close_italics = !b_italics && b_last_italics;
972             b_close_underline = !b_underline && b_last_underline;
973
974             /* Be sure to create valid html */
975             b_close_italics |= b_last_italics && b_close_color;
976             b_close_underline |= b_last_underline && ( b_close_italics || b_close_color );
977
978             if( b_close_underline )
979                 CAT( "</u>" );
980             if( b_close_italics )
981                 CAT( "</i>" );
982             if( b_close_color )
983                 CAT( "</font>" );
984
985             if( color != EIA608_COLOR_DEFAULT && color != last_color)
986             {
987                 static const char *ppsz_color[] = {
988                     "#ffffff",  // white
989                     "#00ff00",  // green
990                     "#0000ff",  // blue
991                     "#00ffff",  // cyan
992                     "#ff0000",  // red
993                     "#ffff00",  // yellow
994                     "#ff00ff",  // magenta
995                     "#ffffff",  // user defined XXX we use white
996                 };
997                 CAT( "<font color=\"" );
998                 CAT( ppsz_color[color] );
999                 CAT( "\">" );
1000             }
1001             if( ( b_close_italics && b_italics ) || ( b_italics && !b_last_italics ) )
1002                 CAT( "<i>" );
1003             if( ( b_close_underline && b_underline ) || ( b_underline && !b_last_underline ) )
1004                 CAT( "<u>" );
1005         }
1006
1007         if( b_html ) {
1008             /* Escape XML reserved characters
1009                http://www.w3.org/TR/xml/#syntax */
1010             switch (p_char[x]) {
1011             case '>':
1012                 CAT( "&gt;" );
1013                 break;
1014             case '<':
1015                 CAT( "&lt;" );
1016                 break;
1017             case '"':
1018                 CAT( "&quot;" );
1019                 break;
1020             case '\'':
1021                 CAT( "&apos;" );
1022                 break;
1023             case '&':
1024                 CAT( "&amp;" );
1025                 break;
1026             default:
1027                 Eia608TextUtf8( utf8, p_char[x] );
1028                 CAT( utf8 );
1029                 break;
1030             }
1031         } else {
1032             Eia608TextUtf8( utf8, p_char[x] );
1033             CAT( utf8 );
1034         }
1035
1036         /* */
1037         b_last_underline = b_underline;
1038         b_last_italics = b_italics;
1039         last_color = color;
1040     }
1041     if( b_html )
1042     {
1043         if( b_last_underline )
1044             CAT( "</u>" );
1045         if( b_last_italics )
1046             CAT( "</i>" );
1047         if( last_color != EIA608_COLOR_DEFAULT )
1048             CAT( "</font>" );
1049         CAT( "</tt>" );
1050     }
1051 #undef CAT
1052 }
1053
1054 /* */
1055 static void Eia608Init( eia608_t *h )
1056 {
1057     memset( h, 0, sizeof(*h) );
1058
1059     /* */
1060     h->i_channel = -1;
1061
1062     h->i_screen = 0;
1063     Eia608ClearScreen( h, 0 );
1064     Eia608ClearScreen( h, 1 );
1065
1066     /* Cursor for writing text */
1067     h->cursor.i_column = 0;
1068     h->cursor.i_row = 0;
1069
1070     h->last.d1 = 0x00;
1071     h->last.d2 = 0x00;
1072     h->mode = EIA608_MODE_POPUP;
1073     h->color = EIA608_COLOR_DEFAULT;
1074     h->font = EIA608_FONT_REGULAR;
1075     h->i_row_rollup = EIA608_SCREEN_ROWS-1;
1076 }
1077 static bool Eia608Parse( eia608_t *h, int i_channel_selected, const uint8_t data[2] )
1078 {
1079     const uint8_t d1 = data[0] & 0x7f; /* Removed parity bit */
1080     const uint8_t d2 = data[1] & 0x7f;
1081     bool b_screen_changed = false;
1082
1083     if( d1 == 0 && d2 == 0 )
1084         return false;   /* Ignore padding (parity check are sometimes invalid on them) */
1085
1086     Eia608ParseChannel( h, data );
1087     if( h->i_channel != i_channel_selected )
1088         return false;
1089     //fprintf( stderr, "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC %x %x\n", data[0], data[1] );
1090
1091     if( d1 >= 0x10 )
1092     {
1093         if( d1 >= 0x20 ||
1094             d1 != h->last.d1 || d2 != h->last.d2 ) /* Command codes can be repeated */
1095             b_screen_changed = Eia608ParseData( h, d1,d2 );
1096
1097         h->last.d1 = d1;
1098         h->last.d2 = d2;
1099     }
1100     else if( ( d1 >= 0x01 && d1 <= 0x0E ) || d1 == 0x0F )
1101     {
1102         /* XDS block / End of XDS block */
1103     }
1104     return b_screen_changed;
1105 }
1106
1107 static char *Eia608Text( eia608_t *h, bool b_html )
1108 {
1109     const int i_size = EIA608_SCREEN_ROWS * 10 * EIA608_SCREEN_COLUMNS+1;
1110     struct eia608_screen *screen = &h->screen[h->i_screen];
1111     bool b_first = true;
1112     char *psz;
1113
1114     /* We allocate a buffer big enough for normal case */
1115     psz = malloc( i_size );
1116     if( !psz )
1117         return NULL;
1118     *psz = '\0';
1119     if( b_html )
1120         Eia608Strlcat( psz, "<text>", i_size );
1121     for( int i = 0; i < EIA608_SCREEN_ROWS; i++ )
1122     {
1123         if( !b_first )
1124             Eia608Strlcat( psz, b_html ? "<br />" : "\n", i_size );
1125         b_first = false;
1126
1127         Eia608TextLine( screen, psz, i_size, i, b_html );
1128     }
1129     if( b_html )
1130         Eia608Strlcat( psz, "</text>", i_size );
1131     return psz;
1132 }