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