]> git.sesse.net Git - vlc/blobdiff - modules/codec/cc.c
Use var_InheritString for --decklink-video-connection.
[vlc] / modules / codec / cc.c
index 5b3371cbaed852cf355f517d9c69dd5acd26ac5b..ee20e50d5e28faa6cd46b0a3d026b450f67e9ae2 100644 (file)
 # include "config.h"
 #endif
 
-#include <vlc/vlc.h>
-#include <vlc_vout.h>
+#include <vlc_common.h>
+#include <vlc_plugin.h>
 #include <vlc_codec.h>
 #include <vlc_input.h>
 
-#include <vlc_osd.h>
 #include <vlc_filter.h>
 #include <vlc_image.h>
 #include <vlc_charset.h>
 #include <vlc_stream.h>
 #include <vlc_xml.h>
-#include <errno.h>
 #include <string.h>
 
-#if !defined( strnlen )
-#define strnlen vlc_strnlen
-#endif
+#include <assert.h>
 
 /*****************************************************************************
  * Module descriptor.
 static int  Open ( vlc_object_t * );
 static void Close( vlc_object_t * );
 
-vlc_module_begin();
-    set_shortname( _("CC 608/708"));
-    set_description( _("Closed Captions decoder") );
-    set_capability( "decoder", 50 );
-    set_callbacks( Open, Close );
-vlc_module_end();
+vlc_module_begin ()
+    set_shortname( N_("CC 608/708"))
+    set_description( N_("Closed Captions decoder") )
+    set_capability( "decoder", 50 )
+    set_callbacks( Open, Close )
+vlc_module_end ()
 
 /*****************************************************************************
  * Local prototypes
@@ -143,8 +139,8 @@ typedef struct
 } eia608_t;
 
 static void         Eia608Init( eia608_t * );
-static vlc_bool_t   Eia608Parse( eia608_t *h, int i_channel_selected, const uint8_t data[2] );
-static char        *Eia608Text( eia608_t *h, vlc_bool_t b_html );
+static bool   Eia608Parse( eia608_t *h, int i_channel_selected, const uint8_t data[2] );
+static char        *Eia608Text( eia608_t *h, bool b_html );
 static void         Eia608Exit( eia608_t * );
 
 /* It will be enough up to 63 B frames, which is far too high for
@@ -200,22 +196,19 @@ static int Open( vlc_object_t *p_this )
     p_dec->pf_decode_sub = Decode;
 
     /* Allocate the memory needed to store the decoder's structure */
-    p_dec->p_sys = p_sys = malloc( sizeof( *p_sys ) );
+    p_dec->p_sys = p_sys = calloc( 1, sizeof( *p_sys ) );
     if( p_sys == NULL )
-    {
-        msg_Err( p_dec, "out of memory" );
         return VLC_ENOMEM;
-    }
 
     /* init of p_sys */
-    memset( p_sys, 0, sizeof( *p_sys ) );
-    p_sys->i_block = 0;
-
     p_sys->i_field = i_field;
     p_sys->i_channel = i_channel;
 
     Eia608Init( &p_sys->eia608 );
 
+    p_dec->fmt_out.i_cat = SPU_ES;
+    p_dec->fmt_out.i_codec = VLC_CODEC_TEXT;
+
     return VLC_SUCCESS;
 }
 
@@ -230,8 +223,6 @@ static subpicture_t *Convert( decoder_t *, block_t * );
 
 static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
 {
-    decoder_sys_t *p_sys = p_dec->p_sys;
-
     if( pp_block && *pp_block )
     {
         Push( p_dec, *pp_block );
@@ -301,11 +292,11 @@ static block_t *Pop( decoder_t *p_dec )
         return NULL;
 
     p_block = p_sys->pp_block[i_index = 0];
-    if( p_block->i_pts > 0 )
+    if( p_block->i_pts > VLC_TS_INVALID )
     {
         for( i = 1; i < p_sys->i_block-1; i++ )
         {
-            if( p_sys->pp_block[i]->i_pts > 0 && p_block->i_pts > 0 &&
+            if( p_sys->pp_block[i]->i_pts > VLC_TS_INVALID && p_block->i_pts > VLC_TS_INVALID &&
                 p_sys->pp_block[i]->i_pts < p_block->i_pts )
                 p_block = p_sys->pp_block[i_index = i];
         }
@@ -324,7 +315,7 @@ static subpicture_t *Subtitle( decoder_t *p_dec, char *psz_subtitle, char *psz_h
     video_format_t fmt;
 
     /* We cannot display a subpicture with no date */
-    if( i_pts == 0 )
+    if( i_pts <= VLC_TS_INVALID )
     {
         msg_Warn( p_dec, "subtitle without a date" );
         return NULL;
@@ -335,57 +326,54 @@ static subpicture_t *Subtitle( decoder_t *p_dec, char *psz_subtitle, char *psz_h
         EnsureUTF8( psz_html );
 
     /* Create the subpicture unit */
-    p_spu = p_dec->pf_spu_buffer_new( p_dec );
+    p_spu = decoder_NewSubpicture( p_dec, NULL );
     if( !p_spu )
     {
         msg_Warn( p_dec, "can't get spu buffer" );
         free( psz_subtitle );
-        if( psz_html )
-            free( psz_html );
+        free( psz_html );
         return NULL;
     }
 
-    p_spu->b_pausable = VLC_TRUE;
-
     /* Create a new subpicture region */
     memset( &fmt, 0, sizeof(video_format_t) );
-    fmt.i_chroma = VLC_FOURCC('T','E','X','T');
-    fmt.i_aspect = 0;
+    fmt.i_chroma = VLC_CODEC_TEXT;
     fmt.i_width = fmt.i_height = 0;
     fmt.i_x_offset = fmt.i_y_offset = 0;
-    p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
+    p_spu->p_region = subpicture_region_New( &fmt );
     if( !p_spu->p_region )
     {
         msg_Err( p_dec, "cannot allocate SPU region" );
         free( psz_subtitle );
-        if( psz_html )
-            free( psz_html );
-        p_dec->pf_spu_buffer_del( p_dec, p_spu );
+        free( psz_html );
+        decoder_DeleteSubpicture( p_dec, p_spu );
         return NULL;
     }
 
     /* Decode and format the subpicture unit */
     /* Normal text subs, easy markup */
     p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM;// | SUBPICTURE_ALIGN_LEFT;// | p_sys->i_align;
-    p_spu->i_x = 0; //p_sys->i_align ? 20 : 0;
-    p_spu->i_y = 10;
+    p_spu->p_region->i_x = 0; //p_sys->i_align ? 20 : 0;
+    p_spu->p_region->i_y = 10;
 
     p_spu->p_region->psz_text = psz_subtitle;
     p_spu->p_region->psz_html = psz_html;
 
     p_spu->i_start = i_pts;
     p_spu->i_stop = i_pts + 10000000;   /* 10s max */
-    p_spu->b_ephemer = VLC_TRUE;
-    p_spu->b_absolute = VLC_FALSE;
+    p_spu->b_ephemer = true;
+    p_spu->b_absolute = false;
 
     return p_spu;
 }
 
 static subpicture_t *Convert( decoder_t *p_dec, block_t *p_block )
 {
+    assert( p_block );
+
     decoder_sys_t *p_sys = p_dec->p_sys;
     const int64_t i_pts = p_block->i_pts;
-    vlc_bool_t b_changed = VLC_FALSE;
+    bool b_changed = false;
 
     /* TODO do the real decoding here */
     while( p_block->i_buffer >= 3 )
@@ -399,12 +387,10 @@ static subpicture_t *Convert( decoder_t *p_dec, block_t *p_block )
     if( p_block )
         block_Release( p_block );
 
-    static int64_t i_last = 0;
-    if( b_changed )//&& i_pts - i_last > 100*1000 )
+    if( b_changed )
     {
-        char *psz_subtitle = Eia608Text( &p_sys->eia608, VLC_FALSE );
-        char *psz_html     = NULL;//Eia608Text( &p_sys->eia608, VLC_TRUE );
-        i_last = i_pts;
+        char *psz_subtitle = Eia608Text( &p_sys->eia608, false );
+        char *psz_html     = NULL;//Eia608Text( &p_sys->eia608, true );
         return Subtitle( p_dec, psz_subtitle, psz_html, i_pts );
     }
     return NULL;
@@ -471,18 +457,18 @@ static void Eia608ClearScreenRowX( eia608_t *h, int i_screen, int i_row, int x )
 
     if( x == 0 )
     {
-        screen->row_used[i_row] = VLC_FALSE;
+        screen->row_used[i_row] = false;
     }
     else
     {
-        screen->row_used[i_row] = VLC_FALSE;
+        screen->row_used[i_row] = false;
         for( i = 0; i < x; i++ )
         {
             if( screen->characters[i_row][i] != ' ' ||
                 screen->colors[i_row][i] != EIA608_COLOR_DEFAULT ||
                 screen->fonts[i_row][i] != EIA608_FONT_REGULAR )
             {
-                screen->row_used[i_row] = VLC_TRUE;
+                screen->row_used[i_row] = true;
                 break;
             }
         }
@@ -527,7 +513,7 @@ static int Eia608GetWritingScreenIndex( eia608_t *h )
     }
 }
 
-static void Eia608EraseScreen( eia608_t *h, vlc_bool_t b_displayed )
+static void Eia608EraseScreen( eia608_t *h, bool b_displayed )
 {
     Eia608ClearScreen( h, b_displayed ? h->i_screen : (1-h->i_screen) );
 }
@@ -546,7 +532,7 @@ static void Eia608Write( eia608_t *h, const uint8_t c )
     screen->characters[i_row][i_column] = c;
     screen->colors[i_row][i_column] = h->color;
     screen->fonts[i_row][i_column] = h->font;
-    screen->row_used[i_row] = VLC_TRUE;
+    screen->row_used[i_row] = true;
     Eia608Cursor( h, 1 );
 }
 static void Eia608Erase( eia608_t *h )
@@ -576,6 +562,9 @@ static void Eia608EraseToEndOfRow( eia608_t *h )
 
 static void Eia608RollUp( eia608_t *h )
 {
+    if( h->mode == EIA608_MODE_TEXT )
+        return;
+
     const int i_screen = Eia608GetWritingScreenIndex( h );
     eia608_screen *screen = &h->screen[i_screen];
 
@@ -614,18 +603,27 @@ static void Eia608RollUp( eia608_t *h )
     /* Reset current row */
     Eia608ClearScreenRow( h, i_screen, h->cursor.i_row );
 }
-static void Eia608ParseChannel( eia608_t *h, uint8_t d1 )
+static void Eia608ParseChannel( eia608_t *h, const uint8_t d[2] )
 {
-    if( d1 == 0x14 )
-        h->i_channel = 1;
-    else if( d1 == 0x1c )
-        h->i_channel = 2;
-    else if( ( d1 >= 0x01 && d1 <= 0x0f ) || d1 == 0x15 )
+    /* Check odd parity */
+    static const int p4[16] = {
+        0, 1, 1, 0, 1, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0
+    };
+    if( p4[d[0] & 0xf] == p4[d[0] >> 4] ||
+        p4[d[1] & 0xf] == p4[ d[1] >> 4] )
+    {
+        h->i_channel = -1;
+        return;
+    }
+
+    /* */
+    const int d1 = d[0] & 0x7f;
+    if( d1 >= 0x10 && d1 <= 0x1f )
+        h->i_channel = 1 + ((d1 & 0x08) != 0);
+    else if( d1 < 0x10 )
         h->i_channel = 3;
-    else if( d1 == 0x1d )
-        h->i_channel = 4;
 }
-static vlc_bool_t Eia608ParseTextAttribute( eia608_t *h, uint8_t d2 )
+static bool Eia608ParseTextAttribute( eia608_t *h, uint8_t d2 )
 {
     const int i_index = d2 - 0x20;
     assert( d2 >= 0x20 && d2 <= 0x2f );
@@ -634,21 +632,21 @@ static vlc_bool_t Eia608ParseTextAttribute( eia608_t *h, uint8_t d2 )
     h->font  = pac2_attribs[i_index].i_font;
     Eia608Cursor( h, 1 );
 
-    return VLC_FALSE;
+    return false;
 }
-static vlc_bool_t Eia608ParseSingle( eia608_t *h, const uint8_t dx )
+static bool Eia608ParseSingle( eia608_t *h, const uint8_t dx )
 {
     assert( dx >= 0x20 );
     Eia608Write( h, dx );
-    return VLC_TRUE;
+    return true;
 }
-static vlc_bool_t Eia608ParseDouble( eia608_t *h, uint8_t d2 )
+static bool Eia608ParseDouble( eia608_t *h, uint8_t d2 )
 {
     assert( d2 >= 0x30 && d2 <= 0x3f );
     Eia608Write( h, d2 + 0x50 ); /* We use charaters 0x80...0x8f */
-    return VLC_TRUE;
+    return true;
 }
-static vlc_bool_t Eia608ParseExtended( eia608_t *h, uint8_t d1, uint8_t d2 )
+static bool Eia608ParseExtended( eia608_t *h, uint8_t d1, uint8_t d2 )
 {
     assert( d2 >= 0x20 && d2 <= 0x3f );
     assert( d1 == 0x12 || d1 == 0x13 );
@@ -661,11 +659,11 @@ static vlc_bool_t Eia608ParseExtended( eia608_t *h, uint8_t d1, uint8_t d2 )
      * advanced one */
     Eia608Cursor( h, -1 );
     Eia608Write( h, d2 );
-    return VLC_TRUE;
+    return true;
 }
-static vlc_bool_t Eia608ParseCommand0x14( eia608_t *h, uint8_t d2 )
+static bool Eia608ParseCommand0x14( eia608_t *h, uint8_t d2 )
 {
-    vlc_bool_t b_changed = VLC_FALSE;
+    bool b_changed = false;
 
     switch( d2 )
     {
@@ -674,7 +672,7 @@ static vlc_bool_t Eia608ParseCommand0x14( eia608_t *h, uint8_t d2 )
         break;
     case 0x21:  /* Backspace */
         Eia608Erase( h );
-        b_changed = VLC_TRUE;
+        b_changed = true;
         break;
     case 0x22:  /* Reserved */
     case 0x23:
@@ -687,9 +685,9 @@ static vlc_bool_t Eia608ParseCommand0x14( eia608_t *h, uint8_t d2 )
     case 0x27:  /* Rollup 4 */
         if( h->mode == EIA608_MODE_POPUP || h->mode == EIA608_MODE_PAINTON )
         {
-            Eia608EraseScreen( h, VLC_TRUE );
-            Eia608EraseScreen( h, VLC_FALSE );
-            b_changed = VLC_TRUE;
+            Eia608EraseScreen( h, true );
+            Eia608EraseScreen( h, false );
+            b_changed = true;
         }
 
         if( d2 == 0x25 )
@@ -717,15 +715,15 @@ static vlc_bool_t Eia608ParseCommand0x14( eia608_t *h, uint8_t d2 )
         break;
 
     case 0x2c: /* Erase displayed memory */
-        Eia608EraseScreen( h, VLC_TRUE );
-        b_changed = VLC_TRUE;
+        Eia608EraseScreen( h, true );
+        b_changed = true;
         break;
     case 0x2d: /* Carriage return */
         Eia608RollUp(h);
-        b_changed = VLC_TRUE;
+        b_changed = true;
         break;
     case 0x2e: /* Erase non displayed memory */
-        Eia608EraseScreen( h, VLC_FALSE );
+        Eia608EraseScreen( h, false );
         break;
     case 0x2f: /* End of caption (flip screen if not paint on) */
         if( h->mode != EIA608_MODE_PAINTON )
@@ -735,12 +733,12 @@ static vlc_bool_t Eia608ParseCommand0x14( eia608_t *h, uint8_t d2 )
         h->cursor.i_row = 0;
         h->color = EIA608_COLOR_DEFAULT;
         h->font = EIA608_FONT_REGULAR;
-        b_changed = VLC_TRUE;
+        b_changed = true;
         break;
     }
     return b_changed;
 }
-static vlc_bool_t Eia608ParseCommand0x17( eia608_t *h, uint8_t d2 )
+static bool Eia608ParseCommand0x17( eia608_t *h, uint8_t d2 )
 {
     switch( d2 )
     {
@@ -754,9 +752,9 @@ static vlc_bool_t Eia608ParseCommand0x17( eia608_t *h, uint8_t d2 )
         Eia608Cursor( h, 3 );
         break;
     }
-    return VLC_FALSE;
+    return false;
 }
-static vlc_bool_t Eia608ParsePac( eia608_t *h, uint8_t d1, uint8_t d2 )
+static bool Eia608ParsePac( eia608_t *h, uint8_t d1, uint8_t d2 )
 {
     static const int pi_row[] = {
         11, -1, 1, 2, 3, 4, 12, 13, 14, 15, 5, 6, 7, 8, 9, 10
@@ -766,7 +764,7 @@ static vlc_bool_t Eia608ParsePac( eia608_t *h, uint8_t d1, uint8_t d2 )
     assert( d2 >= 0x40 && d2 <= 0x7f );
 
     if( pi_row[i_row_index] <= 0 )
-        return VLC_FALSE;
+        return false;
 
     /* Row */
     if( h->mode != EIA608_MODE_TEXT )
@@ -778,12 +776,12 @@ static vlc_bool_t Eia608ParsePac( eia608_t *h, uint8_t d1, uint8_t d2 )
     else if( d2 >= 0x40 )
         d2 -= 0x40;
     h->cursor.i_column = pac2_attribs[d2].i_column;
-    return VLC_FALSE;
+    return false;
 }
 
-static vlc_bool_t Eia608ParseData( eia608_t *h, uint8_t d1, uint8_t d2 )
+static bool Eia608ParseData( eia608_t *h, uint8_t d1, uint8_t d2 )
 {
-    vlc_bool_t b_changed = VLC_FALSE;
+    bool b_changed = false;
 
     if( d1 >= 0x18 && d1 <= 0x1f )
         d1 -= 8;
@@ -959,7 +957,7 @@ static void Eia608Strlcat( char *d, const char *s, int i_max )
         d[i_max-1] = '\0';
 }
 
-static void Eia608TextLine( struct eia608_screen *screen, char *psz_text, int i_text_max, int i_row, vlc_bool_t b_html )
+static void Eia608TextLine( struct eia608_screen *screen, char *psz_text, int i_text_max, int i_row, bool b_html )
 {
     const uint8_t *p_char = screen->characters[i_row];
     const eia608_color_t *p_color = screen->colors[i_row];
@@ -968,8 +966,8 @@ static void Eia608TextLine( struct eia608_screen *screen, char *psz_text, int i_
     int i_end;
     int x;
     eia608_color_t last_color = EIA608_COLOR_DEFAULT;
-    vlc_bool_t     b_last_italics = VLC_FALSE;
-    vlc_bool_t     b_last_underline = VLC_FALSE;
+    bool     b_last_italics = false;
+    bool     b_last_underline = false;
 
     /* Search the start */
     i_start = 0;
@@ -986,14 +984,14 @@ static void Eia608TextLine( struct eia608_screen *screen, char *psz_text, int i_
     for( x = i_start; x <= i_end; x++ )
     {
         eia608_color_t color = p_color[x];
-        vlc_bool_t b_italics = p_font[x] & EIA608_FONT_ITALICS;
-        vlc_bool_t b_underline = p_font[x] & EIA608_FONT_UNDERLINE;
+        bool b_italics = p_font[x] & EIA608_FONT_ITALICS;
+        bool b_underline = p_font[x] & EIA608_FONT_UNDERLINE;
         char utf8[4];
 
         /* */
         if( b_html )
         {
-            vlc_bool_t b_close_color, b_close_italics, b_close_underline;
+            bool b_close_color, b_close_italics, b_close_underline;
 
             /* We create the tags font / i / u in that orders */
             b_close_color = color != last_color && last_color != EIA608_COLOR_DEFAULT;
@@ -1077,18 +1075,18 @@ static void Eia608Init( eia608_t *h )
     h->font = EIA608_FONT_REGULAR;
     h->i_row_rollup = EIA608_SCREEN_ROWS-1;
 }
-static vlc_bool_t Eia608Parse( eia608_t *h, int i_channel_selected, const uint8_t data[2] )
+static bool Eia608Parse( eia608_t *h, int i_channel_selected, const uint8_t data[2] )
 {
-    const uint8_t d1 = data[0] & 0x7f; /* Removed parity bit TODO we might want to check them */
+    const uint8_t d1 = data[0] & 0x7f; /* Removed parity bit */
     const uint8_t d2 = data[1] & 0x7f;
-    vlc_bool_t b_screen_changed = VLC_FALSE;
+    bool b_screen_changed = false;
 
     if( d1 == 0 && d2 == 0 )
-        return VLC_FALSE;   /* Ignore padding */
+        return false;   /* Ignore padding (parity check are sometimes invalid on them) */
 
-    Eia608ParseChannel( h, d1 );
+    Eia608ParseChannel( h, data );
     if( h->i_channel != i_channel_selected )
-        return VLC_FALSE;
+        return false;
     //fprintf( stderr, "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC %x %x\n", data[0], data[1] );
 
     if( d1 >= 0x10 )
@@ -1107,16 +1105,18 @@ static vlc_bool_t Eia608Parse( eia608_t *h, int i_channel_selected, const uint8_
     return b_screen_changed;
 }
 
-static char *Eia608Text( eia608_t *h, vlc_bool_t b_html )
+static char *Eia608Text( eia608_t *h, bool b_html )
 {
     const int i_size = EIA608_SCREEN_ROWS * 3 * EIA608_SCREEN_COLUMNS+1;
     struct eia608_screen *screen = &h->screen[h->i_screen];
-    vlc_bool_t b_first = VLC_TRUE;
+    bool b_first = true;
     char *psz;
     int i;
 
     /* We allocate a buffer big enough for normal case */
     psz = malloc( i_size );
+    if( !psz )
+        return NULL;
     *psz = '\0';
     if( b_html )
         Eia608Strlcat( psz, "<text>", i_size );
@@ -1127,7 +1127,7 @@ static char *Eia608Text( eia608_t *h, vlc_bool_t b_html )
 
         if( !b_first )
             Eia608Strlcat( psz, b_html ? "<br />" : "\n", i_size );
-        b_first = VLC_FALSE;
+        b_first = false;
 
         Eia608TextLine( screen, psz, i_size, i, b_html );
     }
@@ -1138,5 +1138,6 @@ static char *Eia608Text( eia608_t *h, vlc_bool_t b_html )
 
 static void Eia608Exit( eia608_t *h )
 {
+    VLC_UNUSED( h );
 }