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