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