modules/stream_filter/aribcam.c

   1 /*****************************************************************************
   2  * aribcam.c : ARIB STB-B25 software CAM stream filter
   3  *****************************************************************************
   4  * Copyright (C) 2014 VideoLAN and authors
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU Lesser General Public License as published by
   8  * the Free Software Foundation; either version 2.1 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  19  *****************************************************************************/
  20
  21 #ifdef HAVE_CONFIG_H
  22 # include "config.h"
  23 #endif
  24
  25 #include <vlc_common.h>
  26 #include <vlc_plugin.h>
  27 #include <vlc_stream.h>
  28
  29 #include <inttypes.h>
  30 #include <assert.h>
  31
  32 #include <aribb25/arib_std_b25.h>
  33 #include <aribb25/arib_std_b25_error_code.h>
  34 #include <aribb25/b_cas_card.h>
  35 #include <aribb25/b_cas_card_error_code.h>
  36
  37 static int  Open(vlc_object_t *);
  38 static void Close(vlc_object_t *);
  39
  40 vlc_module_begin ()
  41     set_category (CAT_INPUT)
  42     set_subcategory (SUBCAT_INPUT_STREAM_FILTER)
  43     set_capability ("stream_filter", 0)
  44     add_shortcut("aribcam")
  45     set_description (N_("ARIB STD-B25 Cam module"))
  46     set_callbacks (Open, Close)
  47 vlc_module_end ()
  48
  49 struct error_messages_s
  50 {
  51     const int8_t i_error;
  52     const char * const psz_error;
  53 };
  54
  55 static const struct error_messages_s const b25_errors[] =
  56 {
  57     { ARIB_STD_B25_ERROR_INVALID_PARAM, "Invalid parameter" },
  58     { ARIB_STD_B25_ERROR_NO_ENOUGH_MEMORY , "Not enough memory" },
  59     { ARIB_STD_B25_ERROR_NON_TS_INPUT_STREAM, "Non TS input stream" },
  60     { ARIB_STD_B25_ERROR_NO_PAT_IN_HEAD_16M, "No PAT in first 16MB" },
  61     { ARIB_STD_B25_ERROR_NO_PMT_IN_HEAD_32M, "No PMT in first 32MB" },
  62     { ARIB_STD_B25_ERROR_NO_ECM_IN_HEAD_32M, "No ECM in first 32MB" },
  63     { ARIB_STD_B25_ERROR_EMPTY_B_CAS_CARD, "Empty BCAS card" },
  64     { ARIB_STD_B25_ERROR_INVALID_B_CAS_STATUS, "Invalid BCAS status" },
  65     { ARIB_STD_B25_ERROR_ECM_PROC_FAILURE, "ECM Proc failure" },
  66     { ARIB_STD_B25_ERROR_DECRYPT_FAILURE, "Decryption failure" },
  67     { ARIB_STD_B25_ERROR_PAT_PARSE_FAILURE, "PAT Parsing failure" },
  68     { ARIB_STD_B25_ERROR_PMT_PARSE_FAILURE, "PMT Parsing failure" },
  69     { ARIB_STD_B25_ERROR_ECM_PARSE_FAILURE, "ECM Parsing failure" },
  70     { ARIB_STD_B25_ERROR_CAT_PARSE_FAILURE, "CAT Parsing failure" },
  71     { ARIB_STD_B25_ERROR_EMM_PARSE_FAILURE, "EMM Parsing failure" },
  72     { ARIB_STD_B25_ERROR_EMM_PROC_FAILURE, "EMM Proc failure" },
  73     { 0, NULL },
  74 };
  75
  76 static const struct error_messages_s const bcas_errors[] =
  77 {
  78     { B_CAS_CARD_ERROR_INVALID_PARAMETER, "Invalid parameter" },
  79     { B_CAS_CARD_ERROR_NOT_INITIALIZED, "Card not initialized" },
  80     { B_CAS_CARD_ERROR_NO_SMART_CARD_READER, "No smart card reader" },
  81     { B_CAS_CARD_ERROR_ALL_READERS_CONNECTION_FAILED, "Reader connection failed" },
  82     { B_CAS_CARD_ERROR_NO_ENOUGH_MEMORY, "Not enough memory" },
  83     { B_CAS_CARD_ERROR_TRANSMIT_FAILED, "Transmission failed" },
  84     { 0, NULL },
  85 };
  86
  87 struct stream_sys_t
  88 {
  89     ARIB_STD_B25 *p_b25;
  90     B_CAS_CARD   *p_bcas;
  91     struct
  92     {
  93         uint8_t *p_buf;
  94         size_t   i_size;
  95         block_t *p_list;
  96     } remain;
  97 };
  98
  99 static const char * GetErrorMessage( const int i_error,
 100                                const struct error_messages_s const *p_errors_messages )
 101 {
 102     int i = 0;
 103     while( p_errors_messages[i].psz_error )
 104     {
 105         if ( p_errors_messages[i].i_error == i_error )
 106             return p_errors_messages[i].psz_error;
 107         i++;
 108     }
 109     return "unknown error";
 110 }
 111
 112 static size_t RemainRead( stream_t *p_stream, uint8_t *p_data, size_t i_toread )
 113 {
 114     stream_sys_t *p_sys = p_stream->p_sys;
 115
 116     size_t i_total = 0;
 117
 118     while( p_sys->remain.p_list && i_toread )
 119     {
 120         size_t i_copy = __MIN( i_toread, p_sys->remain.p_list->i_buffer );
 121         memcpy( p_data, p_sys->remain.p_list->p_buffer, i_copy );
 122
 123         i_toread -= i_copy;
 124         i_total += i_copy;
 125         p_data += i_copy;
 126
 127         /* update block data pointer and release if no longer needed */
 128         p_sys->remain.p_list->i_buffer -= i_copy;
 129         p_sys->remain.p_list->p_buffer += i_copy;
 130         p_sys->remain.i_size -= i_copy;
 131
 132         if ( p_sys->remain.p_list->i_buffer == 0 )
 133         {
 134             block_t *p_prevhead = p_sys->remain.p_list;
 135             p_sys->remain.p_list = p_sys->remain.p_list->p_next;
 136             block_Release( p_prevhead );
 137         }
 138     }
 139     return i_total;
 140 }
 141
 142 static bool RemainAdd( stream_t *p_stream, const uint8_t *p_data, size_t i_size )
 143 {
 144     stream_sys_t *p_sys = p_stream->p_sys;
 145     if ( i_size == 0 )
 146         return true;
 147     block_t *p_block = block_Alloc( i_size );
 148     if ( !p_block )
 149         return false;
 150     memcpy( p_block->p_buffer, p_data, i_size );
 151     p_block->i_buffer = i_size;
 152     block_ChainAppend( & p_sys->remain.p_list, p_block );
 153     p_sys->remain.i_size += i_size;
 154     return true;
 155 }
 156
 157 static void RemainFlush( stream_sys_t *p_sys )
 158 {
 159     block_ChainRelease( p_sys->remain.p_list );
 160     p_sys->remain.p_list = NULL;
 161     p_sys->remain.i_size = 0;
 162 }
 163
 164 #define ALL_READY (UNIT_SIZE_READY|ECM_READY|PMT_READY)
 165
 166 static ssize_t Read( stream_t *p_stream, void *p_buf, size_t i_toread )
 167 {
 168     stream_sys_t *p_sys = p_stream->p_sys;
 169     uint8_t *p_dst = p_buf;
 170     int i_total_read = 0;
 171     int i_ret;
 172
 173     if ( !i_toread )
 174         return -1;
 175
 176     /* Use data from previous reads */
 177     size_t i_fromremain = RemainRead( p_stream, p_dst, i_toread );
 178     i_total_read += i_fromremain;
 179     p_dst += i_fromremain;
 180     i_toread -= i_fromremain;
 181
 182     while ( i_toread )
 183     {
 184         /* make use of the existing buffer, overwritten by decoder data later */
 185         int i_srcread = vlc_stream_Read( p_stream->p_source, p_dst, i_toread );
 186         if ( i_srcread > 0 )
 187         {
 188             ARIB_STD_B25_BUFFER putbuf = { p_dst, i_srcread };
 189             i_ret = p_sys->p_b25->put( p_sys->p_b25, &putbuf );
 190             if ( i_ret < 0 )
 191             {
 192                 msg_Err( p_stream, "decoder put failed: %s",
 193                          GetErrorMessage( i_ret, b25_errors ) );
 194                 return 0;
 195             }
 196         }
 197         else
 198         {
 199             if ( i_srcread < 0 )
 200                 msg_Err( p_stream, "Can't read %lu bytes from source stream: %d", i_toread, i_srcread );
 201             return 0;
 202         }
 203
 204         ARIB_STD_B25_BUFFER getbuf;
 205         i_ret = p_sys->p_b25->get( p_sys->p_b25, &getbuf );
 206         if ( i_ret < 0 )
 207         {
 208             msg_Err( p_stream, "decoder get failed: %s",
 209                      GetErrorMessage( i_ret, b25_errors ) );
 210             return 0;
 211         }
 212
 213         if ( (size_t)getbuf.size > i_toread )
 214         {
 215             /* Hold remaining data for next call */
 216             RemainAdd( p_stream, getbuf.data + i_toread, getbuf.size - i_toread );
 217         }
 218
 219         int consume = __MIN( (size_t)getbuf.size, i_toread );
 220         memcpy( p_dst, getbuf.data, consume );
 221
 222         i_total_read += consume;
 223         p_dst += consume;
 224         i_toread -= consume;
 225     }
 226
 227     return i_total_read;
 228 }
 229
 230 /**
 231  *
 232  */
 233
 234 static int Seek( stream_t *p_stream, uint64_t i_pos )
 235 {
 236     int i_ret = vlc_stream_Seek( p_stream->p_source, i_pos );
 237     if ( i_ret == VLC_SUCCESS )
 238         RemainFlush( p_stream->p_sys );
 239     return i_ret;
 240 }
 241
 242 /**
 243  *
 244  */
 245 static int Control( stream_t *p_stream, int i_query, va_list args )
 246 {
 247     return vlc_stream_vaControl( p_stream->p_source, i_query, args );
 248 }
 249
 250 static int Open( vlc_object_t *p_object )
 251 {
 252     stream_t *p_stream = (stream_t *) p_object;
 253
 254     int64_t i_stream_size = stream_Size( p_stream->p_source );
 255     if ( i_stream_size > 0 && i_stream_size < ARIB_STD_B25_TS_PROBING_MIN_DATA )
 256         return VLC_EGENERIC;
 257
 258     stream_sys_t *p_sys = p_stream->p_sys = calloc( 1, sizeof(*p_sys) );
 259     if (p_sys == NULL)
 260         return VLC_ENOMEM;
 261
 262     p_sys->p_b25 = create_arib_std_b25();
 263     if ( p_sys->p_b25 )
 264     {
 265         if ( p_sys->p_b25->set_multi2_round( p_sys->p_b25, 4 ) < 0 )
 266             msg_Warn( p_stream, "cannot set B25 round number" );
 267
 268         if ( p_sys->p_b25->set_strip( p_sys->p_b25, 0 ) < 0 )
 269             msg_Warn( p_stream, "cannot set B25 strip option" );
 270
 271         if ( p_sys->p_b25->set_emm_proc( p_sys->p_b25, 0 ) < 0 )
 272             msg_Warn( p_stream, "cannot set B25 emm_proc" );
 273
 274         /* ARIB STD-B25 scrambled TS's packet size is always 188 bytes */
 275         if ( p_sys->p_b25->set_unit_size( p_sys->p_b25, 188 ) < 0)
 276             msg_Warn( p_stream, "cannot set B25 TS packet size" );
 277
 278         p_sys->p_bcas = create_b_cas_card();
 279         if ( p_sys->p_bcas )
 280         {
 281             int i_code = p_sys->p_bcas->init( p_sys->p_bcas );
 282             if ( i_code < 0 )
 283             {
 284                 /* Card could be just missing */
 285                 msg_Warn( p_stream, "cannot initialize BCAS card (missing ?): %s",
 286                           GetErrorMessage( i_code, bcas_errors ) );
 287                 goto error;
 288             }
 289
 290             B_CAS_ID bcasid;
 291             if ( p_sys->p_bcas->get_id( p_sys->p_bcas, &bcasid ) == 0 )
 292             {
 293                 for ( int32_t i=0; i<bcasid.count; i++)
 294                 {
 295                     msg_Dbg( p_stream, "BCAS card id 0x%"PRId64" initialized",
 296                              bcasid.data[i] );
 297                 }
 298             }
 299
 300             B_CAS_INIT_STATUS bcas_status;
 301             if ( p_sys->p_bcas->get_init_status( p_sys->p_bcas, &bcas_status ) == 0 )
 302             {
 303                 msg_Dbg( p_stream, "BCAS card system id 0x%"PRIx32,
 304                          bcas_status.ca_system_id );
 305             }
 306
 307             i_code = p_sys->p_b25->set_b_cas_card( p_sys->p_b25, p_sys->p_bcas );
 308             if ( i_code < 0 )
 309             {
 310                 msg_Err( p_stream, "cannot attach BCAS card to decoder: %s",
 311                          GetErrorMessage( i_code, bcas_errors ) );
 312                 goto error;
 313             }
 314         }
 315         else
 316             msg_Err( p_stream, "cannot create BCAS card" );
 317     }
 318     else
 319     {
 320         msg_Err( p_stream, "cannot create B25 instance" );
 321         goto error;
 322     }
 323
 324     p_stream->pf_read = Read;
 325     p_stream->pf_seek = Seek;
 326     p_stream->pf_control = Control;
 327
 328     return VLC_SUCCESS;
 329
 330 error:
 331     Close( VLC_OBJECT(p_stream) );
 332     return VLC_EGENERIC;
 333 }
 334
 335 static void Close ( vlc_object_t *p_object )
 336 {
 337     stream_t *p_stream = (stream_t *)p_object;
 338     stream_sys_t *p_sys = p_stream->p_sys;
 339
 340     if ( p_sys->p_bcas )
 341         p_sys->p_bcas->release( p_sys->p_bcas );
 342
 343     if ( p_sys->p_b25 )
 344         p_sys->p_b25->release( p_sys->p_b25 );
 345
 346     free( p_sys );
 347 }