1 /*****************************************************************************
2 * cc.c : CC 608/708 subtitles decoder
3 *****************************************************************************
4 * Copyright © 2007-2010 Laurent Aimar, 2011 VLC authors and VideoLAN
6 * Authors: Laurent Aimar < fenrir # via.ecp.fr>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License as published by
10 * the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
23 /*****************************************************************************
25 *****************************************************************************/
26 /* The EIA 608 decoder part has been initialy based on ccextractor (GPL)
40 #include <vlc_common.h>
41 #include <vlc_plugin.h>
42 #include <vlc_codec.h>
43 #include <vlc_charset.h>
47 /*****************************************************************************
49 *****************************************************************************/
50 static int Open ( vlc_object_t
* );
51 static void Close( vlc_object_t
* );
53 #define OPAQUE_TEXT N_("Opacity")
54 #define OPAQUE_LONGTEXT N_("Setting to true " \
55 "makes the text to be boxed and maybe easier to read." )
58 set_shortname( N_("CC 608/708"))
59 set_description( N_("Closed Captions decoder") )
60 set_capability( "spu decoder", 50 )
61 set_category( CAT_INPUT
)
62 set_subcategory( SUBCAT_INPUT_SCODEC
)
63 set_callbacks( Open
, Close
)
65 add_bool( "cc-opaque", true,
66 OPAQUE_TEXT
, OPAQUE_LONGTEXT
, false )
69 /*****************************************************************************
71 *****************************************************************************/
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,
84 EIA608_COLOR_WHITE
= 0,
85 EIA608_COLOR_GREEN
= 1,
86 EIA608_COLOR_BLUE
= 2,
87 EIA608_COLOR_CYAN
= 3,
89 EIA608_COLOR_YELLOW
= 5,
90 EIA608_COLOR_MAGENTA
= 6,
91 EIA608_COLOR_USERDEFINED
= 7
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
102 #define EIA608_SCREEN_ROWS 15
103 #define EIA608_SCREEN_COLUMNS 32
105 struct eia608_screen
// A CC buffer
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?
112 typedef struct eia608_screen eia608_screen
;
116 EIA608_STATUS_DEFAULT
= 0x00,
117 EIA608_STATUS_CHANGED
= 0x01, /* current screen has been altered */
118 EIA608_STATUS_CAPTION_ENDED
= 0x02, /* screen flip */
119 EIA608_STATUS_CAPTION_CLEARED
= 0x04, /* active screen erased */
120 EIA608_STATUS_DISPLAY
= EIA608_STATUS_CAPTION_CLEARED
| EIA608_STATUS_CAPTION_ENDED
,
123 static const struct {
124 eia608_color_t i_color
;
125 eia608_font_t i_font
;
128 { EIA608_COLOR_WHITE
, EIA608_FONT_REGULAR
, 0 },
129 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE
, 0 },
130 { EIA608_COLOR_GREEN
, EIA608_FONT_REGULAR
, 0 },
131 { EIA608_COLOR_GREEN
, EIA608_FONT_UNDERLINE
, 0 },
132 { EIA608_COLOR_BLUE
, EIA608_FONT_REGULAR
, 0 },
133 { EIA608_COLOR_BLUE
, EIA608_FONT_UNDERLINE
, 0 },
134 { EIA608_COLOR_CYAN
, EIA608_FONT_REGULAR
, 0 },
135 { EIA608_COLOR_CYAN
, EIA608_FONT_UNDERLINE
, 0 },
136 { EIA608_COLOR_RED
, EIA608_FONT_REGULAR
, 0 },
137 { EIA608_COLOR_RED
, EIA608_FONT_UNDERLINE
, 0 },
138 { EIA608_COLOR_YELLOW
, EIA608_FONT_REGULAR
, 0 },
139 { EIA608_COLOR_YELLOW
, EIA608_FONT_UNDERLINE
, 0 },
140 { EIA608_COLOR_MAGENTA
, EIA608_FONT_REGULAR
, 0 },
141 { EIA608_COLOR_MAGENTA
, EIA608_FONT_UNDERLINE
, 0 },
142 { EIA608_COLOR_WHITE
, EIA608_FONT_ITALICS
, 0 },
143 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE_ITALICS
, 0 },
145 { EIA608_COLOR_WHITE
, EIA608_FONT_REGULAR
, 0 },
146 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE
, 0 },
147 { EIA608_COLOR_WHITE
, EIA608_FONT_REGULAR
, 4 },
148 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE
, 4 },
149 { EIA608_COLOR_WHITE
, EIA608_FONT_REGULAR
, 8 },
150 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE
, 8 },
151 { EIA608_COLOR_WHITE
, EIA608_FONT_REGULAR
, 12 },
152 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE
, 12 },
153 { EIA608_COLOR_WHITE
, EIA608_FONT_REGULAR
, 16 },
154 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE
, 16 },
155 { EIA608_COLOR_WHITE
, EIA608_FONT_REGULAR
, 20 },
156 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE
, 20 },
157 { EIA608_COLOR_WHITE
, EIA608_FONT_REGULAR
, 24 },
158 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE
, 24 },
159 { EIA608_COLOR_WHITE
, EIA608_FONT_REGULAR
, 28 },
160 { EIA608_COLOR_WHITE
, EIA608_FONT_UNDERLINE
, 28 } ,
163 #define EIA608_COLOR_DEFAULT EIA608_COLOR_WHITE
165 static const int rgi_eia608_colors
[] = {
173 0xffffff, // user defined XXX we use white
178 /* Current channel (used to reject packet without channel information) */
182 int i_screen
; /* Displayed screen */
183 eia608_screen screen
[2];
193 eia608_color_t color
;
197 /* Last command pair (used to reject duplicated command) */
205 static void Eia608Init( eia608_t
* );
206 static eia608_status_t
Eia608Parse( eia608_t
*h
, int i_channel_selected
, const uint8_t data
[2] );
207 static void Eia608FillUpdaterRegions( subpicture_updater_sys_t
*p_updater
, eia608_t
*h
);
209 /* It will be enough up to 63 B frames, which is far too high for
210 * broadcast environment */
211 #define CC_MAX_REORDER_SIZE (64)
226 static int Decode( decoder_t
*, block_t
* );
227 static void Flush( decoder_t
* );
229 /*****************************************************************************
230 * Open: probe the decoder and return score
231 *****************************************************************************
232 * Tries to launch a decoder and return score so that the interface is able
234 *****************************************************************************/
235 static int Open( vlc_object_t
*p_this
)
237 decoder_t
*p_dec
= (decoder_t
*)p_this
;
238 decoder_sys_t
*p_sys
;
240 if( p_dec
->fmt_in
.i_codec
!= VLC_CODEC_CEA608
||
241 p_dec
->fmt_in
.subs
.cc
.i_channel
> 3 )
244 /* 0 -> i_field = 0; i_channel = 1;
245 1 -> i_field = 0; i_channel = 2;
246 2 -> i_field = 1; i_channel = 1;
247 3 -> i_field = 1; i_channel = 2; */
249 const int i_field
= p_dec
->fmt_in
.subs
.cc
.i_channel
>> 1;
250 const int i_channel
= 1 + (p_dec
->fmt_in
.subs
.cc
.i_channel
& 1);
252 p_dec
->pf_decode
= Decode
;
253 p_dec
->pf_flush
= Flush
;
255 /* Allocate the memory needed to store the decoder's structure */
256 p_dec
->p_sys
= p_sys
= calloc( 1, sizeof( *p_sys
) );
261 p_sys
->i_field
= i_field
;
262 p_sys
->i_channel
= i_channel
;
264 Eia608Init( &p_sys
->eia608
);
265 p_sys
->b_opaque
= var_InheritBool( p_dec
, "cc-opaque" );
266 p_sys
->i_reorder_depth
= p_dec
->fmt_in
.subs
.cc
.i_reorder_depth
;
268 p_dec
->fmt_out
.i_codec
= VLC_CODEC_TEXT
;
273 /*****************************************************************************
275 *****************************************************************************/
276 static void Flush( decoder_t
*p_dec
)
278 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
280 Eia608Init( &p_sys
->eia608
);
282 block_ChainRelease( p_sys
->p_queue
);
283 p_sys
->p_queue
= NULL
;
287 /****************************************************************************
288 * Decode: the whole thing
289 ****************************************************************************
291 ****************************************************************************/
292 static void Push( decoder_t
*, block_t
* );
293 static block_t
*Pop( decoder_t
*, bool );
294 static void Convert( decoder_t
*, mtime_t
, const uint8_t *, size_t );
296 static bool DoDecode( decoder_t
*p_dec
, bool b_drain
)
298 block_t
*p_block
= Pop( p_dec
, b_drain
);
302 Convert( p_dec
, p_block
->i_pts
, p_block
->p_buffer
, p_block
->i_buffer
);
303 block_Release( p_block
);
308 static int Decode( decoder_t
*p_dec
, block_t
*p_block
)
310 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
314 /* Reset decoder if needed */
315 if( p_block
->i_flags
& (BLOCK_FLAG_DISCONTINUITY
| BLOCK_FLAG_CORRUPTED
) )
318 for( ; DoDecode( p_dec
, true ) ; );
319 Eia608Init( &p_sys
->eia608
);
321 if( (p_block
->i_flags
& BLOCK_FLAG_CORRUPTED
) || p_block
->i_buffer
< 1 )
323 block_Release( p_block
);
324 return VLCDEC_SUCCESS
;
328 /* XXX Cc captions data are OUT OF ORDER (because we receive them in the bitstream
329 * order (ie ordered by video picture dts) instead of the display order.
330 * We will simulate a simple IPB buffer scheme
331 * and reorder with pts.
332 * XXX it won't work with H264 which use non out of order B picture or MMCO */
333 if( p_sys
->i_reorder_depth
== 0 )
335 /* Wait for a P and output all *previous* picture by pts order (for
336 * hierarchical B frames) */
337 if( (p_block
->i_flags
& BLOCK_FLAG_TYPE_B
) == 0 )
338 for( ; DoDecode( p_dec
, true ); );
341 Push( p_dec
, p_block
);
344 const bool b_no_reorder
= (p_dec
->fmt_in
.subs
.cc
.i_reorder_depth
< 0);
345 for( ; DoDecode( p_dec
, (p_block
== NULL
) || b_no_reorder
); );
347 return VLCDEC_SUCCESS
;
350 /*****************************************************************************
351 * CloseDecoder: clean up the decoder
352 *****************************************************************************/
353 static void Close( vlc_object_t
*p_this
)
355 decoder_t
*p_dec
= (decoder_t
*)p_this
;
356 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
358 block_ChainRelease( p_sys
->p_queue
);
362 /*****************************************************************************
364 *****************************************************************************/
365 static void Push( decoder_t
*p_dec
, block_t
*p_block
)
367 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
369 if( p_sys
->i_queue
>= CC_MAX_REORDER_SIZE
)
371 block_Release( Pop( p_dec
, true ) );
372 msg_Warn( p_dec
, "Trashing a CC entry" );
376 /* find insertion point */
377 for( pp_block
= &p_sys
->p_queue
; *pp_block
; pp_block
= &((*pp_block
)->p_next
) )
379 if( p_block
->i_pts
== VLC_TS_INVALID
|| (*pp_block
)->i_pts
== VLC_TS_INVALID
)
381 if( p_block
->i_pts
< (*pp_block
)->i_pts
)
383 if( p_sys
->i_reorder_depth
> 0 &&
384 p_sys
->i_queue
< p_sys
->i_reorder_depth
&&
385 pp_block
== &p_sys
->p_queue
)
387 msg_Info( p_dec
, "Increasing reorder depth to %d", ++p_sys
->i_reorder_depth
);
392 /* Insert, keeping a pts and/or fifo ordered list */
393 p_block
->p_next
= *pp_block
? *pp_block
: NULL
;
398 static block_t
*Pop( decoder_t
*p_dec
, bool b_forced
)
400 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
403 if( p_sys
->i_queue
== 0 )
406 if( !b_forced
&& p_sys
->i_queue
< CC_MAX_REORDER_SIZE
)
408 if( p_sys
->i_queue
< p_sys
->i_reorder_depth
|| p_sys
->i_reorder_depth
== 0 )
413 p_block
= p_sys
->p_queue
;
414 p_sys
->p_queue
= p_block
->p_next
;
415 p_block
->p_next
= NULL
;
421 static subpicture_t
*Subtitle( decoder_t
*p_dec
, eia608_t
*h
, mtime_t i_pts
)
423 //decoder_sys_t *p_sys = p_dec->p_sys;
424 subpicture_t
*p_spu
= NULL
;
426 /* We cannot display a subpicture with no date */
427 if( i_pts
<= VLC_TS_INVALID
)
430 /* Create the subpicture unit */
431 p_spu
= decoder_NewSubpictureText( p_dec
);
435 p_spu
->i_start
= i_pts
;
436 p_spu
->i_stop
= i_pts
+ 10000000; /* 10s max */
437 p_spu
->b_ephemer
= true;
438 p_spu
->b_absolute
= false;
440 subpicture_updater_sys_t
*p_spu_sys
= p_spu
->updater
.p_sys
;
442 /* The "leavetext" alignment is a special mode where the subpicture
443 region itself gets aligned, but the text inside it does not */
444 p_spu_sys
->region
.align
= SUBPICTURE_ALIGN_TOP
;
445 p_spu_sys
->region
.inner_align
= SUBPICTURE_ALIGN_LEAVETEXT
;
446 p_spu_sys
->region
.flags
= UPDT_REGION_IGNORE_BACKGROUND
| UPDT_REGION_USES_GRID_COORDINATES
;
447 /* Set style defaults (will be added to segments if none set) */
448 p_spu_sys
->p_default_style
->i_style_flags
|= STYLE_MONOSPACED
;
449 if( p_dec
->p_sys
->b_opaque
)
451 p_spu_sys
->p_default_style
->i_background_alpha
= STYLE_ALPHA_OPAQUE
;
452 p_spu_sys
->p_default_style
->i_features
|= STYLE_HAS_BACKGROUND_ALPHA
;
453 p_spu_sys
->p_default_style
->i_style_flags
|= STYLE_BACKGROUND
;
455 p_spu_sys
->p_default_style
->i_font_color
= rgi_eia608_colors
[EIA608_COLOR_DEFAULT
];
456 /* FCC defined "safe area" for EIA-608 captions is 80% of the height of the display */
457 p_spu_sys
->p_default_style
->f_font_relsize
= 100 * 8 / 10 / EIA608_SCREEN_ROWS
;
458 p_spu_sys
->p_default_style
->i_features
|= (STYLE_HAS_FONT_COLOR
| STYLE_HAS_FLAGS
);
460 Eia608FillUpdaterRegions( p_spu_sys
, h
);
465 static void Convert( decoder_t
*p_dec
, mtime_t i_pts
,
466 const uint8_t *p_buffer
, size_t i_buffer
)
468 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
471 while( i_buffer
>= 3 )
473 /* Mask off the specific i_field bit, else some sequences can be lost. */
474 if ( (p_buffer
[0] & 0x03) == p_sys
->i_field
&&
475 (p_buffer
[0] & 0x04) /* Valid bit */ )
477 eia608_status_t i_status
=
478 Eia608Parse( &p_sys
->eia608
, p_sys
->i_channel
, &p_buffer
[1] );
480 /* a caption is ready or removed, process its screen */
482 * In case of rollup/painton with 1 packet/frame, we need to update on Changed status.
483 * Batch decoding might be incorrect if those in large number of commands (mp4, ...) then.
484 * see CEAv1.2zero.trp tests
486 if( i_status
& (EIA608_STATUS_DISPLAY
| EIA608_STATUS_CHANGED
) )
488 subpicture_t
*p_spu
= Subtitle( p_dec
, &p_sys
->eia608
, i_pts
+ i_ticks
* CLOCK_FREQ
/ 30 );
490 decoder_QueueSub( p_dec
, p_spu
);
501 /*****************************************************************************
503 *****************************************************************************/
504 static void Eia608Cursor( eia608_t
*h
, int dx
)
506 h
->cursor
.i_column
+= dx
;
507 if( h
->cursor
.i_column
< 0 )
508 h
->cursor
.i_column
= 0;
509 else if( h
->cursor
.i_column
> EIA608_SCREEN_COLUMNS
-1 )
510 h
->cursor
.i_column
= EIA608_SCREEN_COLUMNS
-1;
512 static void Eia608ClearScreenRowX( eia608_t
*h
, int i_screen
, int i_row
, int x
)
514 eia608_screen
*screen
= &h
->screen
[i_screen
];
518 screen
->row_used
[i_row
] = false;
522 screen
->row_used
[i_row
] = false;
523 for( int i
= 0; i
< x
; i
++ )
525 if( screen
->characters
[i_row
][i
] != ' ' ||
526 screen
->colors
[i_row
][i
] != EIA608_COLOR_DEFAULT
||
527 screen
->fonts
[i_row
][i
] != EIA608_FONT_REGULAR
)
529 screen
->row_used
[i_row
] = true;
535 for( ; x
< EIA608_SCREEN_COLUMNS
+1; x
++ )
537 screen
->characters
[i_row
][x
] = x
< EIA608_SCREEN_COLUMNS
? ' ' : '\0';
538 screen
->colors
[i_row
][x
] = EIA608_COLOR_DEFAULT
;
539 screen
->fonts
[i_row
][x
] = EIA608_FONT_REGULAR
;
543 static void Eia608ClearScreenRow( eia608_t
*h
, int i_screen
, int i_row
)
545 Eia608ClearScreenRowX( h
, i_screen
, i_row
, 0 );
548 static void Eia608ClearScreen( eia608_t
*h
, int i_screen
)
550 for( int i
= 0; i
< EIA608_SCREEN_ROWS
; i
++ )
551 Eia608ClearScreenRow( h
, i_screen
, i
);
554 static int Eia608GetWritingScreenIndex( eia608_t
*h
)
558 case EIA608_MODE_POPUP
: // Non displayed screen
559 return 1 - h
->i_screen
;
561 case EIA608_MODE_ROLLUP_2
: // Displayed screen
562 case EIA608_MODE_ROLLUP_3
:
563 case EIA608_MODE_ROLLUP_4
:
564 case EIA608_MODE_PAINTON
:
567 /* It cannot happen, else it is a bug */
568 vlc_assert_unreachable();
573 static void Eia608EraseScreen( eia608_t
*h
, bool b_displayed
)
575 Eia608ClearScreen( h
, b_displayed
? h
->i_screen
: (1-h
->i_screen
) );
578 static void Eia608Write( eia608_t
*h
, const uint8_t c
)
580 const int i_row
= h
->cursor
.i_row
;
581 const int i_column
= h
->cursor
.i_column
;
582 eia608_screen
*screen
;
584 if( h
->mode
== EIA608_MODE_TEXT
)
587 screen
= &h
->screen
[Eia608GetWritingScreenIndex( h
)];
589 screen
->characters
[i_row
][i_column
] = c
;
590 screen
->colors
[i_row
][i_column
] = h
->color
;
591 screen
->fonts
[i_row
][i_column
] = h
->font
;
592 screen
->row_used
[i_row
] = true;
593 Eia608Cursor( h
, 1 );
595 static void Eia608Erase( eia608_t
*h
)
597 const int i_row
= h
->cursor
.i_row
;
598 const int i_column
= h
->cursor
.i_column
- 1;
599 eia608_screen
*screen
;
601 if( h
->mode
== EIA608_MODE_TEXT
)
606 screen
= &h
->screen
[Eia608GetWritingScreenIndex( h
)];
608 /* FIXME do we need to reset row_used/colors/font ? */
609 screen
->characters
[i_row
][i_column
] = ' ';
610 Eia608Cursor( h
, -1 );
612 static void Eia608EraseToEndOfRow( eia608_t
*h
)
614 if( h
->mode
== EIA608_MODE_TEXT
)
617 Eia608ClearScreenRowX( h
, Eia608GetWritingScreenIndex( h
), h
->cursor
.i_row
, h
->cursor
.i_column
);
620 static void Eia608RollUp( eia608_t
*h
)
622 if( h
->mode
== EIA608_MODE_TEXT
)
625 const int i_screen
= Eia608GetWritingScreenIndex( h
);
626 eia608_screen
*screen
= &h
->screen
[i_screen
];
631 if( h
->mode
== EIA608_MODE_ROLLUP_2
)
633 else if( h
->mode
== EIA608_MODE_ROLLUP_3
)
635 else if( h
->mode
== EIA608_MODE_ROLLUP_4
)
640 /* Reset the cursor */
641 h
->cursor
.i_column
= 0;
643 /* Erase lines above our window */
644 for( int i
= 0; i
< h
->cursor
.i_row
- keep_lines
; i
++ )
645 Eia608ClearScreenRow( h
, i_screen
, i
);
648 for( int i
= 0; i
< keep_lines
-1; i
++ )
650 const int i_row
= h
->cursor
.i_row
- keep_lines
+ i
+ 1;
653 assert( i_row
+1 < EIA608_SCREEN_ROWS
);
654 memcpy( screen
->characters
[i_row
], screen
->characters
[i_row
+1], sizeof(*screen
->characters
) );
655 memcpy( screen
->colors
[i_row
], screen
->colors
[i_row
+1], sizeof(*screen
->colors
) );
656 memcpy( screen
->fonts
[i_row
], screen
->fonts
[i_row
+1], sizeof(*screen
->fonts
) );
657 screen
->row_used
[i_row
] = screen
->row_used
[i_row
+1];
659 /* Reset current row */
660 Eia608ClearScreenRow( h
, i_screen
, h
->cursor
.i_row
);
662 static void Eia608ParseChannel( eia608_t
*h
, const uint8_t d
[2] )
664 /* Check odd parity */
665 static const int p4
[16] = {
666 0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0
668 if( p4
[d
[0] & 0xf] == p4
[d
[0] >> 4] ||
669 p4
[d
[1] & 0xf] == p4
[ d
[1] >> 4] )
676 const int d1
= d
[0] & 0x7f;
677 if( d1
>= 0x10 && d1
<= 0x1f )
678 h
->i_channel
= 1 + ((d1
& 0x08) != 0);
682 static eia608_status_t
Eia608ParseTextAttribute( eia608_t
*h
, uint8_t d2
)
684 const int i_index
= d2
- 0x20;
685 assert( d2
>= 0x20 && d2
<= 0x2f );
687 h
->color
= pac2_attribs
[i_index
].i_color
;
688 h
->font
= pac2_attribs
[i_index
].i_font
;
689 Eia608Cursor( h
, 1 );
691 return EIA608_STATUS_DEFAULT
;
693 static eia608_status_t
Eia608ParseSingle( eia608_t
*h
, const uint8_t dx
)
695 assert( dx
>= 0x20 );
696 Eia608Write( h
, dx
);
697 return EIA608_STATUS_CHANGED
;
699 static eia608_status_t
Eia608ParseDouble( eia608_t
*h
, uint8_t d2
)
701 assert( d2
>= 0x30 && d2
<= 0x3f );
702 Eia608Write( h
, d2
+ 0x50 ); /* We use charaters 0x80...0x8f */
703 return EIA608_STATUS_CHANGED
;
705 static eia608_status_t
Eia608ParseExtended( eia608_t
*h
, uint8_t d1
, uint8_t d2
)
707 assert( d2
>= 0x20 && d2
<= 0x3f );
708 assert( d1
== 0x12 || d1
== 0x13 );
710 d2
+= 0x70; /* We use charaters 0x90-0xaf */
712 d2
+= 0x90; /* We use charaters 0xb0-0xcf */
714 /* The extended characters replace the previous one with a more
716 Eia608Cursor( h
, -1 );
717 Eia608Write( h
, d2
);
718 return EIA608_STATUS_CHANGED
;
720 static eia608_status_t
Eia608ParseCommand0x14( eia608_t
*h
, uint8_t d2
)
722 eia608_status_t i_status
= EIA608_STATUS_DEFAULT
;
726 case 0x20: /* Resume caption loading */
727 h
->mode
= EIA608_MODE_POPUP
;
729 case 0x21: /* Backspace */
731 i_status
= EIA608_STATUS_CHANGED
;
733 case 0x22: /* Reserved */
736 case 0x24: /* Delete to end of row */
737 Eia608EraseToEndOfRow( h
);
739 case 0x25: /* Rollup 2 */
740 case 0x26: /* Rollup 3 */
741 case 0x27: /* Rollup 4 */
742 if( h
->mode
== EIA608_MODE_POPUP
|| h
->mode
== EIA608_MODE_PAINTON
)
744 Eia608EraseScreen( h
, true );
745 Eia608EraseScreen( h
, false );
746 i_status
= EIA608_STATUS_CHANGED
| EIA608_STATUS_CAPTION_CLEARED
;
750 h
->mode
= EIA608_MODE_ROLLUP_2
;
751 else if( d2
== 0x26 )
752 h
->mode
= EIA608_MODE_ROLLUP_3
;
754 h
->mode
= EIA608_MODE_ROLLUP_4
;
756 h
->cursor
.i_column
= 0;
757 h
->cursor
.i_row
= h
->i_row_rollup
;
759 case 0x28: /* Flash on */
762 case 0x29: /* Resume direct captionning */
763 h
->mode
= EIA608_MODE_PAINTON
;
765 case 0x2a: /* Text restart */
769 case 0x2b: /* Resume text display */
770 h
->mode
= EIA608_MODE_TEXT
;
773 case 0x2c: /* Erase displayed memory */
774 Eia608EraseScreen( h
, true );
775 i_status
= EIA608_STATUS_CHANGED
| EIA608_STATUS_CAPTION_CLEARED
;
777 case 0x2d: /* Carriage return */
779 i_status
= EIA608_STATUS_CHANGED
;
781 case 0x2e: /* Erase non displayed memory */
782 Eia608EraseScreen( h
, false );
784 case 0x2f: /* End of caption (flip screen if not paint on) */
785 if( h
->mode
!= EIA608_MODE_PAINTON
)
786 h
->i_screen
= 1 - h
->i_screen
;
787 h
->mode
= EIA608_MODE_POPUP
;
788 h
->cursor
.i_column
= 0;
790 h
->color
= EIA608_COLOR_DEFAULT
;
791 h
->font
= EIA608_FONT_REGULAR
;
792 i_status
= EIA608_STATUS_CHANGED
| EIA608_STATUS_CAPTION_ENDED
;
797 static bool Eia608ParseCommand0x17( eia608_t
*h
, uint8_t d2
)
801 case 0x21: /* Tab offset 1 */
802 Eia608Cursor( h
, 1 );
804 case 0x22: /* Tab offset 2 */
805 Eia608Cursor( h
, 2 );
807 case 0x23: /* Tab offset 3 */
808 Eia608Cursor( h
, 3 );
813 static bool Eia608ParsePac( eia608_t
*h
, uint8_t d1
, uint8_t d2
)
815 static const int pi_row
[] = {
816 11, -1, 1, 2, 3, 4, 12, 13, 14, 15, 5, 6, 7, 8, 9, 10
818 const int i_row_index
= ( (d1
<<1) & 0x0e) | ( (d2
>>5) & 0x01 );
820 assert( d2
>= 0x40 && d2
<= 0x7f );
822 if( pi_row
[i_row_index
] <= 0 )
826 if( h
->mode
!= EIA608_MODE_TEXT
)
827 h
->cursor
.i_row
= pi_row
[i_row_index
] - 1;
828 h
->i_row_rollup
= pi_row
[i_row_index
] - 1;
832 else if( d2
>= 0x40 )
834 h
->cursor
.i_column
= pac2_attribs
[d2
].i_column
;
835 h
->color
= pac2_attribs
[d2
].i_color
;
836 h
->font
= pac2_attribs
[d2
].i_font
;
841 static eia608_status_t
Eia608ParseData( eia608_t
*h
, uint8_t d1
, uint8_t d2
)
843 eia608_status_t i_status
= EIA608_STATUS_DEFAULT
;
845 if( d1
>= 0x18 && d1
<= 0x1f )
848 #define ON( d2min, d2max, cmd ) do { if( d2 >= d2min && d2 <= d2max ) i_status = cmd; } while(0)
852 ON( 0x20, 0x2f, Eia608ParseTextAttribute( h
, d2
) );
853 ON( 0x30, 0x3f, Eia608ParseDouble( h
, d2
) );
855 case 0x12: case 0x13:
856 ON( 0x20, 0x3f, Eia608ParseExtended( h
, d1
, d2
) );
858 case 0x14: case 0x15:
859 ON( 0x20, 0x2f, Eia608ParseCommand0x14( h
, d2
) );
862 ON( 0x21, 0x23, Eia608ParseCommand0x17( h
, d2
) );
863 ON( 0x2e, 0x2f, Eia608ParseTextAttribute( h
, d2
) );
867 ON( 0x40, 0x5f, Eia608ParsePac( h
, d1
, d2
) );
868 else if( d1
>= 0x11 && d1
<= 0x17 )
869 ON( 0x40, 0x7f, Eia608ParsePac( h
, d1
, d2
) );
873 i_status
= Eia608ParseSingle( h
, d1
);
875 i_status
|= Eia608ParseSingle( h
, d2
);
878 /* Ignore changes occuring to doublebuffer */
879 if( h
->mode
== EIA608_MODE_POPUP
&& i_status
== EIA608_STATUS_CHANGED
)
880 i_status
= EIA608_STATUS_DEFAULT
;
885 static void Eia608TextUtf8( char *psz_utf8
, uint8_t c
) // Returns number of bytes used
887 #define E1(c,u) { c, { u, '\0' } }
888 #define E2(c,u1,u2) { c, { u1, u2, '\0' } }
889 #define E3(c,u1,u2,u3) { c, { u1, u2, u3, '\0' } }
890 static const struct {
894 // Regular line-21 character set, mostly ASCII except these exceptions
895 E2( 0x2a, 0xc3,0xa1), // lowercase a, acute accent
896 E2( 0x5c, 0xc3,0xa9), // lowercase e, acute accent
897 E2( 0x5e, 0xc3,0xad), // lowercase i, acute accent
898 E2( 0x5f, 0xc3,0xb3), // lowercase o, acute accent
899 E2( 0x60, 0xc3,0xba), // lowercase u, acute accent
900 E2( 0x7b, 0xc3,0xa7), // lowercase c with cedilla
901 E2( 0x7c, 0xc3,0xb7), // division symbol
902 E2( 0x7d, 0xc3,0x91), // uppercase N tilde
903 E2( 0x7e, 0xc3,0xb1), // lowercase n tilde
904 // THIS BLOCK INCLUDES THE 16 EXTENDED (TWO-BYTE) LINE 21 CHARACTERS
905 // THAT COME FROM HI BYTE=0x11 AND LOW BETWEEN 0x30 AND 0x3F
906 E2( 0x80, 0xc2,0xae), // Registered symbol (R)
907 E2( 0x81, 0xc2,0xb0), // degree sign
908 E2( 0x82, 0xc2,0xbd), // 1/2 symbol
909 E2( 0x83, 0xc2,0xbf), // Inverted (open) question mark
910 E3( 0x84, 0xe2,0x84,0xa2), // Trademark symbol (TM)
911 E2( 0x85, 0xc2,0xa2), // Cents symbol
912 E2( 0x86, 0xc2,0xa3), // Pounds sterling
913 E3( 0x87, 0xe2,0x99,0xaa), // Music note
914 E2( 0x88, 0xc3,0xa0), // lowercase a, grave accent
915 E2( 0x89, 0xc2,0xa0), // transparent space
916 E2( 0x8a, 0xc3,0xa8), // lowercase e, grave accent
917 E2( 0x8b, 0xc3,0xa2), // lowercase a, circumflex accent
918 E2( 0x8c, 0xc3,0xaa), // lowercase e, circumflex accent
919 E2( 0x8d, 0xc3,0xae), // lowercase i, circumflex accent
920 E2( 0x8e, 0xc3,0xb4), // lowercase o, circumflex accent
921 E2( 0x8f, 0xc3,0xbb), // lowercase u, circumflex accent
922 // THIS BLOCK INCLUDES THE 32 EXTENDED (TWO-BYTE) LINE 21 CHARACTERS
923 // THAT COME FROM HI BYTE=0x12 AND LOW BETWEEN 0x20 AND 0x3F
924 E2( 0x90, 0xc3,0x81), // capital letter A with acute
925 E2( 0x91, 0xc3,0x89), // capital letter E with acute
926 E2( 0x92, 0xc3,0x93), // capital letter O with acute
927 E2( 0x93, 0xc3,0x9a), // capital letter U with acute
928 E2( 0x94, 0xc3,0x9c), // capital letter U with diaresis
929 E2( 0x95, 0xc3,0xbc), // lowercase letter U with diaeresis
930 E1( 0x96, 0x27), // apostrophe
931 E2( 0x97, 0xc2,0xa1), // inverted exclamation mark
932 E1( 0x98, 0x2a), // asterisk
933 E1( 0x99, 0x27), // apostrophe (yes, duped). See CCADI source code.
934 E1( 0x9a, 0x2d), // hyphen-minus
935 E2( 0x9b, 0xc2,0xa9), // copyright sign
936 E3( 0x9c, 0xe2,0x84,0xa0), // Service mark
937 E1( 0x9d, 0x2e), // Full stop (.)
938 E3( 0x9e, 0xe2,0x80,0x9c), // Quotation mark
939 E3( 0x9f, 0xe2,0x80,0x9d), // Quotation mark
940 E2( 0xa0, 0xc3,0x80), // uppercase A, grave accent
941 E2( 0xa1, 0xc3,0x82), // uppercase A, circumflex
942 E2( 0xa2, 0xc3,0x87), // uppercase C with cedilla
943 E2( 0xa3, 0xc3,0x88), // uppercase E, grave accent
944 E2( 0xa4, 0xc3,0x8a), // uppercase E, circumflex
945 E2( 0xa5, 0xc3,0x8b), // capital letter E with diaresis
946 E2( 0xa6, 0xc3,0xab), // lowercase letter e with diaresis
947 E2( 0xa7, 0xc3,0x8e), // uppercase I, circumflex
948 E2( 0xa8, 0xc3,0x8f), // uppercase I, with diaresis
949 E2( 0xa9, 0xc3,0xaf), // lowercase i, with diaresis
950 E2( 0xaa, 0xc3,0x94), // uppercase O, circumflex
951 E2( 0xab, 0xc3,0x99), // uppercase U, grave accent
952 E2( 0xac, 0xc3,0xb9), // lowercase u, grave accent
953 E2( 0xad, 0xc3,0x9b), // uppercase U, circumflex
954 E2( 0xae, 0xc2,0xab), // LEFT-POINTING DOUBLE ANGLE QUOTATION MARK
955 E2( 0xaf, 0xc2,0xbb), // RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK
956 // THIS BLOCK INCLUDES THE 32 EXTENDED (TWO-BYTE) LINE 21 CHARACTERS
957 // THAT COME FROM HI BYTE=0x13 AND LOW BETWEEN 0x20 AND 0x3F
958 E2( 0xb0, 0xc3,0x83), // Uppercase A, tilde
959 E2( 0xb1, 0xc3,0xa3), // Lowercase a, tilde
960 E2( 0xb2, 0xc3,0x8d), // Uppercase I, acute accent
961 E2( 0xb3, 0xc3,0x8c), // Uppercase I, grave accent
962 E2( 0xb4, 0xc3,0xac), // Lowercase i, grave accent
963 E2( 0xb5, 0xc3,0x92), // Uppercase O, grave accent
964 E2( 0xb6, 0xc3,0xb2), // Lowercase o, grave accent
965 E2( 0xb7, 0xc3,0x95), // Uppercase O, tilde
966 E2( 0xb8, 0xc3,0xb5), // Lowercase o, tilde
967 E1( 0xb9, 0x7b), // Open curly brace
968 E1( 0xba, 0x7d), // Closing curly brace
969 E1( 0xbb, 0x5c), // Backslash
970 E1( 0xbc, 0x5e), // Caret
971 E1( 0xbd, 0x5f), // Underscore
972 E2( 0xbe, 0xc2,0xa6), // Pipe (broken bar)
973 E1( 0xbf, 0x7e), // Tilde (utf8 code unsure)
974 E2( 0xc0, 0xc3,0x84), // Uppercase A, umlaut
975 E2( 0xc1, 0xc3,0xa4), // Lowercase A, umlaut
976 E2( 0xc2, 0xc3,0x96), // Uppercase O, umlaut
977 E2( 0xc3, 0xc3,0xb6), // Lowercase o, umlaut
978 E2( 0xc4, 0xc3,0x9f), // Esszett (sharp S)
979 E2( 0xc5, 0xc2,0xa5), // Yen symbol
980 E2( 0xc6, 0xc2,0xa4), // Currency symbol
981 E1( 0xc7, 0x7c), // Vertical bar
982 E2( 0xc8, 0xc3,0x85), // Uppercase A, ring
983 E2( 0xc9, 0xc3,0xa5), // Lowercase A, ring
984 E2( 0xca, 0xc3,0x98), // Uppercase O, slash
985 E2( 0xcb, 0xc3,0xb8), // Lowercase o, slash
986 E3( 0xcc, 0xe2,0x8c,0x9c), // Upper left corner
987 E3( 0xcd, 0xe2,0x8c,0x9d), // Upper right corner
988 E3( 0xce, 0xe2,0x8c,0x9e), // Lower left corner
989 E3( 0xcf, 0xe2,0x8c,0x9f), // Lower right corner
997 for( size_t i
= 0; i
< ARRAY_SIZE(c2utf8
) ; i
++ )
998 if( c2utf8
[i
].c
== c
) {
999 strcpy( psz_utf8
, c2utf8
[i
].utf8
);
1003 psz_utf8
[0] = c
< 0x80 ? c
: '?'; /* Normal : Unsupported */
1007 static void Eia608Strlcat( char *d
, const char *s
, int i_max
)
1010 strncat( d
, s
, i_max
-1 - strnlen(d
, i_max
-1));
1015 #define CAT(t) Eia608Strlcat( psz_text, t, i_text_max )
1017 static text_segment_t
* Eia608TextLine( struct eia608_screen
*screen
, int i_row
)
1019 const uint8_t *p_char
= screen
->characters
[i_row
];
1020 const eia608_color_t
*p_color
= screen
->colors
[i_row
];
1021 const eia608_font_t
*p_font
= screen
->fonts
[i_row
];
1025 eia608_color_t prev_color
= EIA608_COLOR_DEFAULT
;
1026 eia608_font_t prev_font
= EIA608_FONT_REGULAR
;
1029 const unsigned i_text_max
= 4 * EIA608_SCREEN_COLUMNS
+ 1;
1030 char psz_text
[i_text_max
+ 1];
1033 /* Search the start */
1036 /* Convert leading spaces to non-breaking so that they don't get
1037 stripped by the RenderHtml routine as regular whitespace */
1038 while( i_start
< EIA608_SCREEN_COLUMNS
&& p_char
[i_start
] == ' ' ) {
1039 Eia608TextUtf8( utf8
, 0x89 );
1044 /* Search the end */
1045 i_end
= EIA608_SCREEN_COLUMNS
-1;
1046 while( i_end
> i_start
&& p_char
[i_end
] == ' ' )
1050 if( i_start
> i_end
) /* Nothing to render */
1053 text_segment_t
*p_segment
, *p_segments_head
= p_segment
= text_segment_New( NULL
);
1057 p_segment
->style
= text_style_Create( STYLE_NO_DEFAULTS
);
1058 if(!p_segment
->style
)
1060 text_segment_Delete(p_segment
);
1063 /* Ensure we get a monospaced font (required for accurate positioning */
1064 p_segment
->style
->i_style_flags
|= STYLE_MONOSPACED
;
1066 for( x
= i_start
; x
<= i_end
; x
++ )
1068 eia608_color_t color
= p_color
[x
];
1069 eia608_font_t font
= p_font
[x
];
1071 if(font
!= prev_font
|| color
!= prev_color
)
1073 EnsureUTF8(psz_text
);
1074 p_segment
->psz_text
= strdup(psz_text
);
1076 p_segment
->p_next
= text_segment_New( NULL
);
1077 p_segment
= p_segment
->p_next
;
1079 return p_segments_head
;
1081 p_segment
->style
= text_style_Create( STYLE_NO_DEFAULTS
);
1082 if(!p_segment
->style
)
1084 text_segment_Delete(p_segment
);
1085 return p_segments_head
;
1087 p_segment
->style
->i_style_flags
|= STYLE_MONOSPACED
;
1089 /* start segment with new style */
1090 if(font
& EIA608_FONT_ITALICS
)
1092 p_segment
->style
->i_style_flags
|= STYLE_ITALIC
;
1093 p_segment
->style
->i_features
|= STYLE_HAS_FLAGS
;
1095 if(font
& EIA608_FONT_UNDERLINE
)
1097 p_segment
->style
->i_style_flags
|= STYLE_UNDERLINE
;
1098 p_segment
->style
->i_features
|= STYLE_HAS_FLAGS
;
1101 if(color
!= EIA608_COLOR_DEFAULT
)
1103 p_segment
->style
->i_font_color
= rgi_eia608_colors
[color
];
1104 p_segment
->style
->i_features
|= STYLE_HAS_FONT_COLOR
;
1108 Eia608TextUtf8( utf8
, p_char
[x
] );
1120 assert(!p_segment
->psz_text
); // shouldn't happen
1121 EnsureUTF8(psz_text
);
1122 p_segment
->psz_text
= strdup(psz_text
);
1125 return p_segments_head
;
1128 static void Eia608FillUpdaterRegions( subpicture_updater_sys_t
*p_updater
, eia608_t
*h
)
1130 struct eia608_screen
*screen
= &h
->screen
[h
->i_screen
];
1131 subpicture_updater_sys_region_t
*p_region
= &p_updater
->region
;
1132 text_segment_t
**pp_last
= &p_region
->p_segments
;
1133 bool b_newregion
= false;
1135 for( int i
= 0; i
< EIA608_SCREEN_ROWS
; i
++ )
1137 if( !screen
->row_used
[i
] )
1140 text_segment_t
*p_segments
= Eia608TextLine( screen
, i
);
1145 subpicture_updater_sys_region_t
*p_newregion
;
1146 p_newregion
= SubpictureUpdaterSysRegionNew();
1149 text_segment_ChainDelete( p_segments
);
1152 SubpictureUpdaterSysRegionAdd( p_region
, p_newregion
);
1153 p_region
= p_newregion
;
1154 pp_last
= &p_region
->p_segments
;
1155 b_newregion
= false;
1158 if( p_region
->p_segments
== NULL
) /* First segment in the [new] region */
1160 p_region
->origin
.y
= i
; /* set start line number */
1162 else /* Insert line break between region lines */
1164 *pp_last
= text_segment_New( "\n" );
1166 pp_last
= &((*pp_last
)->p_next
);
1169 *pp_last
= p_segments
;
1170 do { pp_last
= &((*pp_last
)->p_next
); } while ( *pp_last
!= NULL
);
1174 b_newregion
= !!p_region
->p_segments
;
1180 static void Eia608Init( eia608_t
*h
)
1182 memset( h
, 0, sizeof(*h
) );
1188 Eia608ClearScreen( h
, 0 );
1189 Eia608ClearScreen( h
, 1 );
1191 /* Cursor for writing text */
1192 h
->cursor
.i_column
= 0;
1193 h
->cursor
.i_row
= 0;
1197 h
->mode
= EIA608_MODE_POPUP
;
1198 h
->color
= EIA608_COLOR_DEFAULT
;
1199 h
->font
= EIA608_FONT_REGULAR
;
1200 h
->i_row_rollup
= EIA608_SCREEN_ROWS
-1;
1202 static eia608_status_t
Eia608Parse( eia608_t
*h
, int i_channel_selected
, const uint8_t data
[2] )
1204 const uint8_t d1
= data
[0] & 0x7f; /* Removed parity bit */
1205 const uint8_t d2
= data
[1] & 0x7f;
1206 eia608_status_t i_screen_status
= EIA608_STATUS_DEFAULT
;
1208 if( d1
== 0 && d2
== 0 )
1209 return EIA608_STATUS_DEFAULT
; /* Ignore padding (parity check are sometimes invalid on them) */
1211 Eia608ParseChannel( h
, data
);
1212 if( h
->i_channel
!= i_channel_selected
)
1214 //fprintf( stderr, "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC %x %x\n", data[0], data[1] );
1219 d1
!= h
->last
.d1
|| d2
!= h
->last
.d2
) /* Command codes can be repeated */
1220 i_screen_status
= Eia608ParseData( h
, d1
,d2
);
1225 else if( ( d1
>= 0x01 && d1
<= 0x0E ) || d1
== 0x0F )
1227 /* XDS block / End of XDS block */
1229 return i_screen_status
;