git.sesse.net Git - vlc/blob - include/vlc_input.h

   1 /*****************************************************************************
   2  * vlc_input.h:
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 VideoLAN
   5  * $Id: input_ext-intf.h 7954 2004-06-07 22:19:12Z fenrir $
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 /* __ is need because conflict with <vlc/input.h> */
  26 #ifndef _VLC__INPUT_H
  27 #define _VLC__INPUT_H 1
  28
  29 /*****************************************************************************
  30  * input_item_t: Describes an input and is used to spawn input_thread_t objects
  31  *****************************************************************************/
  32 struct info_t
  33 {
  34     char *psz_name;            /**< Name of this info */
  35     char *psz_value;           /**< Value of the info */
  36 };
  37
  38 struct info_category_t
  39 {
  40     char   *psz_name;      /**< Name of this category */
  41     int    i_infos;        /**< Number of infos in the category */
  42     struct info_t **pp_infos;     /**< Pointer to an array of infos */
  43 };
  44
  45 struct input_item_t
  46 {
  47     char       *psz_name;            /**< text describing this item */
  48     char       *psz_uri;             /**< mrl of this item */
  49
  50     int        i_options;            /**< Number of input options */
  51     char       **ppsz_options;       /**< Array of input options */
  52
  53     mtime_t    i_duration;           /**< A hint about the duration of this
  54                                       * item, in milliseconds*/
  55
  56     int        i_id;                 /**< Identifier of the item */
  57     uint8_t    i_type;               /**< Type (file, disc, ...) */
  58
  59     int        i_categories;         /**< Number of info categories */
  60     info_category_t **pp_categories; /**< Pointer to the first info category */
  61
  62     int         i_es;                /**< Number of es format descriptions */
  63     es_format_t **es;                /**< Pointer to an array of es formats */
  64
  65     vlc_mutex_t lock;                /**< Item cannot be changed without this lock */
  66 };
  67
  68 #define ITEM_TYPE_UNKNOWN       0
  69 #define ITEM_TYPE_FILE          1
  70 #define ITEM_TYPE_DIRECTORY     2
  71 #define ITEM_TYPE_DISC          3
  72 #define ITEM_TYPE_CARD          4
  73 #define ITEM_TYPE_NET           5
  74 #define ITEM_TYPE_PLAYLIST      6
  75
  76 static inline void vlc_input_item_Init( vlc_object_t *p_o, input_item_t *p_i )
  77 {
  78     memset( p_i, 0, sizeof(input_item_t) );
  79     p_i->i_options  = 0;
  80     p_i->i_es = 0;
  81     p_i->i_categories = 0 ;
  82     p_i->psz_name = 0;
  83     p_i->psz_uri = 0;
  84     p_i->ppsz_options = 0;
  85     p_i->pp_categories = 0;
  86     p_i->es = 0;
  87     p_i->i_type = ITEM_TYPE_UNKNOWN;
  88     vlc_mutex_init( p_o, &p_i->lock );
  89 }
  90
  91 static inline void vlc_input_item_CopyOptions( input_item_t *p_parent,
  92                                                input_item_t *p_child )
  93 {
  94     int i;
  95     for( i = 0 ; i< p_parent->i_options; i++ )
  96     {
  97         char *psz_option= strdup( p_parent->ppsz_options[i] );
  98         INSERT_ELEM( p_child->ppsz_options,
  99                      p_child->i_options, p_child->i_options,
 100                      psz_option );
 101     }
 102 }
 103
 104 static inline void vlc_input_item_Clean( input_item_t *p_i )
 105 {
 106     if( p_i->psz_name ) free( p_i->psz_name );
 107     if( p_i->psz_uri ) free( p_i->psz_uri );
 108     p_i->psz_name = 0;
 109     p_i->psz_uri = 0;
 110
 111     while( p_i->i_options )
 112     {
 113         p_i->i_options--;
 114         if( p_i->ppsz_options[p_i->i_options] )
 115             free( p_i->ppsz_options[p_i->i_options] );
 116         if( !p_i->i_options ) free( p_i->ppsz_options );
 117     }
 118
 119     while( p_i->i_es )
 120     {
 121         p_i->i_es--;
 122         es_format_Clean( p_i->es[p_i->i_es] );
 123         if( !p_i->i_es ) free( p_i->es );
 124     }
 125
 126     while( p_i->i_categories )
 127     {
 128         info_category_t *p_category =
 129             p_i->pp_categories[--(p_i->i_categories)];
 130
 131         while( p_category->i_infos )
 132         {
 133             p_category->i_infos--;
 134
 135             if( p_category->pp_infos[p_category->i_infos]->psz_name )
 136                 free( p_category->pp_infos[p_category->i_infos]->psz_name);
 137             if( p_category->pp_infos[p_category->i_infos]->psz_value )
 138                 free( p_category->pp_infos[p_category->i_infos]->psz_value );
 139             free( p_category->pp_infos[p_category->i_infos] );
 140
 141             if( !p_category->i_infos ) free( p_category->pp_infos );
 142         }
 143
 144         if( p_category->psz_name ) free( p_category->psz_name );
 145         free( p_category );
 146
 147         if( !p_i->i_categories ) free( p_i->pp_categories );
 148     }
 149
 150     vlc_mutex_destroy( &p_i->lock );
 151 }
 152
 153 /*****************************************************************************
 154  * Seek point: (generalisation of chapters)
 155  *****************************************************************************/
 156 struct seekpoint_t
 157 {
 158     int64_t i_byte_offset;
 159     int64_t i_time_offset;
 160     char    *psz_name;
 161 };
 162
 163 static inline seekpoint_t *vlc_seekpoint_New( void )
 164 {
 165     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 166     point->i_byte_offset =
 167     point->i_time_offset = 0;
 168     point->psz_name = NULL;
 169     return point;
 170 }
 171
 172 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 173 {
 174     if( !point ) return;
 175     if( point->psz_name ) free( point->psz_name );
 176     free( point );
 177 }
 178
 179 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 180 {
 181     seekpoint_t *point = vlc_seekpoint_New();
 182     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 183     point->i_time_offset = src->i_time_offset;
 184     point->i_byte_offset = src->i_byte_offset;
 185     return point;
 186 }
 187
 188 /*****************************************************************************
 189  * Title:
 190  *****************************************************************************/
 191 typedef struct
 192 {
 193     char        *psz_name;
 194
 195     vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
 196
 197     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 198     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 199
 200     /* Title seekpoint */
 201     int         i_seekpoint;
 202     seekpoint_t **seekpoint;
 203
 204 } input_title_t;
 205
 206 static inline input_title_t *vlc_input_title_New( )
 207 {
 208     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 209
 210     t->psz_name = NULL;
 211     t->b_menu = VLC_FALSE;
 212     t->i_length = 0;
 213     t->i_size   = 0;
 214     t->i_seekpoint = 0;
 215     t->seekpoint = NULL;
 216
 217     return t;
 218 }
 219
 220 static inline void vlc_input_title_Delete( input_title_t *t )
 221 {
 222     int i;
 223     if( t == NULL )
 224         return;
 225
 226     if( t->psz_name ) free( t->psz_name );
 227     for( i = 0; i < t->i_seekpoint; i++ )
 228     {
 229         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 230         free( t->seekpoint[i] );
 231     }
 232     if( t->seekpoint ) free( t->seekpoint );
 233     free( t );
 234 }
 235
 236 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 237 {
 238     input_title_t *dup = vlc_input_title_New( );
 239     int i;
 240
 241     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 242     dup->b_menu      = t->b_menu;
 243     dup->i_length    = t->i_length;
 244     dup->i_size      = t->i_size;
 245     dup->i_seekpoint = t->i_seekpoint;
 246     if( t->i_seekpoint > 0 )
 247     {
 248         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 249                                                 sizeof(seekpoint_t*) );
 250
 251         for( i = 0; i < t->i_seekpoint; i++ )
 252         {
 253             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 254         }
 255     }
 256
 257     return dup;
 258 }
 259
 260 /*****************************************************************************
 261  * input defines/constants.
 262  *****************************************************************************/
 263
 264 /* "state" value */
 265 enum input_state_e
 266 {
 267     INIT_S,
 268     PLAYING_S,
 269     PAUSE_S,
 270     END_S,
 271 };
 272
 273 /* "rate" default, min/max */
 274 #define INPUT_RATE_DEFAULT  1000
 275 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 276 #define INPUT_RATE_MAX      8000            /* Up to 1/8 */
 277
 278 /* input_source_t: gathers all information per input source */
 279 typedef struct
 280 {
 281     /* Input item description */
 282     input_item_t *p_item;
 283
 284     /* Access/Stream/Demux plugins */
 285     access_t *p_access;
 286     stream_t *p_stream;
 287     demux_t  *p_demux;
 288
 289     /* Title infos for that input */
 290     vlc_bool_t   b_title_demux; /* Titles/Seekpoints provided by demux */
 291     int          i_title;
 292     input_title_t **title;
 293
 294     int i_title_offset;
 295     int i_seekpoint_offset;
 296
 297     int i_title_start;
 298     int i_title_end;
 299     int i_seekpoint_start;
 300     int i_seekpoint_end;
 301
 302     /* Properties */
 303     vlc_bool_t b_can_pace_control;
 304     vlc_bool_t b_can_pause;
 305     vlc_bool_t b_eof;   /* eof of demuxer */
 306
 307     /* Clock average variation */
 308     int     i_cr_average;
 309
 310 } input_source_t;
 311
 312 /* i_update field of access_t/demux_t */
 313 #define INPUT_UPDATE_NONE       0x0000
 314 #define INPUT_UPDATE_SIZE       0x0001
 315 #define INPUT_UPDATE_TITLE      0x0010
 316 #define INPUT_UPDATE_SEEKPOINT  0x0020
 317 #define INPUT_UPDATE_META       0x0040
 318
 319 /* Input control XXX: internal */
 320 #define INPUT_CONTROL_FIFO_SIZE    100
 321
 322 /*****************************************************************************
 323  * input_thread_t
 324  *****************************************************************************
 325  * XXX: this strucrures is *PRIVATE* so nobody can touch it out of src/input.
 326  * I plan to move it to src/input/input_internal.h anyway
 327  *
 328  * XXX: look at src/input/input.c:input_CreateThread for accessible variables
 329  *      YOU CANNOT HAVE ACCESS TO THE CONTENT OF input_thread_t except
 330  *      p_input->input.p_item (and it's only temporary).
 331  * XXX: move the docs somewhere (better than src/input )
 332  *****************************************************************************/
 333 struct input_thread_t
 334 {
 335     VLC_COMMON_MEMBERS
 336
 337      /* Global properties */
 338     vlc_bool_t  b_eof;
 339     vlc_bool_t  b_can_pace_control;
 340     vlc_bool_t  b_can_pause;
 341
 342     /* Global state */
 343     int         i_state;
 344     int         i_rate;
 345
 346     /* */
 347     int64_t     i_start;    /* :start-time,0 by default */
 348     int64_t     i_time;     /* Current time */
 349     int64_t     i_stop;     /* :stop-time, 0 if none */
 350
 351     /* Title infos FIXME multi-input (not easy) ? */
 352     int          i_title;
 353     input_title_t **title;
 354
 355     int i_title_offset;
 356     int i_seekpoint_offset;
 357
 358     /* User bookmarks FIXME won't be easy with multiples input */
 359     int         i_bookmark;
 360     seekpoint_t **bookmark;
 361
 362     /* Global meta datas FIXME move to input_item_t ? */
 363     vlc_meta_t  *p_meta;
 364
 365     /* Output */
 366     es_out_t    *p_es_out;
 367     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
 368     vlc_bool_t      b_out_pace_control; /*     idem ? */
 369
 370     /* Internal caching common for all inputs */
 371     int64_t i_pts_delay;
 372
 373     /* Main input properties */
 374     input_source_t input;
 375
 376     /* Slave demuxers (subs, and others) */
 377     int            i_slave;
 378     input_source_t **slave;
 379
 380     /* Buffer of pending actions */
 381     vlc_mutex_t lock_control;
 382     int i_control;
 383     struct
 384     {
 385         /* XXX: val isn't duplicated so it won't works with string */
 386         int         i_type;
 387         vlc_value_t val;
 388     } control[INPUT_CONTROL_FIFO_SIZE];
 389 };
 390
 391 /*****************************************************************************
 392  * Prototypes
 393  *****************************************************************************/
 394 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 395 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 396 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 397 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 398
 399 enum input_query_e
 400 {
 401     /* input variable "position" */
 402     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 403     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 404
 405     /* input variable "length" */
 406     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 407
 408     /* input variable "time" */
 409     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 410     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 411
 412     /* input variable "rate" (1 is DEFAULT_RATE) */
 413     INPUT_GET_RATE,             /* arg1= int *          res=    */
 414     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 415
 416     /* input variable "state" */
 417     INPUT_GET_STATE,            /* arg1= int *          res=    */
 418     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 419
 420     /* input variable "audio-delay" and "spu-delay" */
 421     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 422     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 423     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 424     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 425
 426     /* Meta datas */
 427     INPUT_ADD_INFO,   /* arg1= char * arg2= char * arg3=...  res=can fail    */
 428     INPUT_GET_INFO,   /* arg1= char * arg2= char * arg3= char ** res=can fail*/
 429     INPUT_SET_NAME,   /* arg1= char * res=can fail    */
 430
 431     /* Input config options */
 432     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 433
 434     /* Input properties */
 435     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 436     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 437
 438     /* bookmarks */
 439     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 440     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 441     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 442     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 443     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 444     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 445 };
 446
 447 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 448 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 449
 450 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 451 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 452 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 453
 454 #endif