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         p_child->i_options++;
  99         p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
 100                                                   p_child->i_options *
 101                                                   sizeof( char * ) );
 102         p_child->ppsz_options[p_child->i_options-1] = psz_option;
 103     }
 104 }
 105
 106 static inline void vlc_input_item_Clean( input_item_t *p_i )
 107 {
 108     if( p_i->psz_name ) free( p_i->psz_name );
 109     if( p_i->psz_uri ) free( p_i->psz_uri );
 110     p_i->psz_name = 0;
 111     p_i->psz_uri = 0;
 112
 113     while( p_i->i_options )
 114     {
 115         p_i->i_options--;
 116         if( p_i->ppsz_options[p_i->i_options] )
 117             free( p_i->ppsz_options[p_i->i_options] );
 118         if( !p_i->i_options ) free( p_i->ppsz_options );
 119     }
 120
 121     while( p_i->i_es )
 122     {
 123         p_i->i_es--;
 124         es_format_Clean( p_i->es[p_i->i_es] );
 125         if( !p_i->i_es ) free( p_i->es );
 126     }
 127
 128     while( p_i->i_categories )
 129     {
 130         info_category_t *p_category =
 131             p_i->pp_categories[--(p_i->i_categories)];
 132
 133         while( p_category->i_infos )
 134         {
 135             p_category->i_infos--;
 136
 137             if( p_category->pp_infos[p_category->i_infos]->psz_name )
 138                 free( p_category->pp_infos[p_category->i_infos]->psz_name);
 139             if( p_category->pp_infos[p_category->i_infos]->psz_value )
 140                 free( p_category->pp_infos[p_category->i_infos]->psz_value );
 141             free( p_category->pp_infos[p_category->i_infos] );
 142
 143             if( !p_category->i_infos ) free( p_category->pp_infos );
 144         }
 145
 146         if( p_category->psz_name ) free( p_category->psz_name );
 147         free( p_category );
 148
 149         if( !p_i->i_categories ) free( p_i->pp_categories );
 150     }
 151
 152     vlc_mutex_destroy( &p_i->lock );
 153 }
 154
 155 /*****************************************************************************
 156  * Seek point: (generalisation of chapters)
 157  *****************************************************************************/
 158 struct seekpoint_t
 159 {
 160     int64_t i_byte_offset;
 161     int64_t i_time_offset;
 162     char    *psz_name;
 163 };
 164
 165 static inline seekpoint_t *vlc_seekpoint_New( void )
 166 {
 167     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 168     point->i_byte_offset =
 169     point->i_time_offset = 0;
 170     point->psz_name = NULL;
 171     return point;
 172 }
 173
 174 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 175 {
 176     if( !point ) return;
 177     if( point->psz_name ) free( point->psz_name );
 178     free( point );
 179 }
 180
 181 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 182 {
 183     seekpoint_t *point = vlc_seekpoint_New();
 184     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 185     point->i_time_offset = src->i_time_offset;
 186     point->i_byte_offset = src->i_byte_offset;
 187     return point;
 188 }
 189
 190 /*****************************************************************************
 191  * Title:
 192  *****************************************************************************/
 193 typedef struct
 194 {
 195     char        *psz_name;
 196
 197     vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
 198
 199     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 200     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 201
 202     /* Title seekpoint */
 203     int         i_seekpoint;
 204     seekpoint_t **seekpoint;
 205
 206 } input_title_t;
 207
 208 static inline input_title_t *vlc_input_title_New( )
 209 {
 210     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 211
 212     t->psz_name = NULL;
 213     t->b_menu = VLC_FALSE;
 214     t->i_length = 0;
 215     t->i_size   = 0;
 216     t->i_seekpoint = 0;
 217     t->seekpoint = NULL;
 218
 219     return t;
 220 }
 221
 222 static inline void vlc_input_title_Delete( input_title_t *t )
 223 {
 224     int i;
 225     if( t == NULL )
 226         return;
 227
 228     if( t->psz_name ) free( t->psz_name );
 229     for( i = 0; i < t->i_seekpoint; i++ )
 230     {
 231         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 232         free( t->seekpoint[i] );
 233     }
 234     if( t->seekpoint ) free( t->seekpoint );
 235     free( t );
 236 }
 237
 238 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 239 {
 240     input_title_t *dup = vlc_input_title_New( );
 241     int i;
 242
 243     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 244     dup->b_menu      = t->b_menu;
 245     dup->i_length    = t->i_length;
 246     dup->i_size      = t->i_size;
 247     dup->i_seekpoint = t->i_seekpoint;
 248     if( t->i_seekpoint > 0 )
 249     {
 250         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 251                                                 sizeof(seekpoint_t*) );
 252
 253         for( i = 0; i < t->i_seekpoint; i++ )
 254         {
 255             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 256         }
 257     }
 258
 259     return dup;
 260 }
 261
 262 /*****************************************************************************
 263  * input defines/constants.
 264  *****************************************************************************/
 265
 266 /* "state" value */
 267 enum input_state_e
 268 {
 269     INIT_S,
 270     PLAYING_S,
 271     PAUSE_S,
 272     END_S,
 273 };
 274
 275 /* "rate" default, min/max */
 276 #define INPUT_RATE_DEFAULT  1000
 277 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 278 #define INPUT_RATE_MAX      8000            /* Up to 1/8 */
 279
 280 /* input_source_t: gathers all information per input source */
 281 typedef struct
 282 {
 283     /* Input item description */
 284     input_item_t *p_item;
 285
 286     /* Access/Stream/Demux plugins */
 287     access_t *p_access;
 288     stream_t *p_stream;
 289     demux_t  *p_demux;
 290
 291     /* Title infos for that input */
 292     vlc_bool_t   b_title_demux; /* Titles/Seekpoints provided by demux */
 293     int          i_title;
 294     input_title_t **title;
 295
 296     int i_title_offset;
 297     int i_seekpoint_offset;
 298
 299     int i_title_start;
 300     int i_title_end;
 301     int i_seekpoint_start;
 302     int i_seekpoint_end;
 303
 304     /* Properties */
 305     vlc_bool_t b_can_pace_control;
 306     vlc_bool_t b_can_pause;
 307     vlc_bool_t b_eof;   /* eof of demuxer */
 308
 309     /* Clock average variation */
 310     int     i_cr_average;
 311
 312 } input_source_t;
 313
 314 /* i_update field of access_t/demux_t */
 315 #define INPUT_UPDATE_NONE       0x0000
 316 #define INPUT_UPDATE_SIZE       0x0001
 317 #define INPUT_UPDATE_TITLE      0x0010
 318 #define INPUT_UPDATE_SEEKPOINT  0x0020
 319 #define INPUT_UPDATE_META       0x0040
 320
 321 /* Input control XXX: internal */
 322 #define INPUT_CONTROL_FIFO_SIZE    100
 323
 324 /*****************************************************************************
 325  * input_thread_t
 326  *****************************************************************************
 327  * XXX: this strucrures is *PRIVATE* so nobody can touch it out of src/input.
 328  * I plan to move it to src/input/input_internal.h anyway
 329  *
 330  * XXX: look at src/input/input.c:input_CreateThread for accessible variables
 331  *      YOU CANNOT HAVE ACCESS TO THE CONTENT OF input_thread_t except
 332  *      p_input->input.p_item (and it's only temporary).
 333  * XXX: move the docs somewhere (better than src/input )
 334  *****************************************************************************/
 335 struct input_thread_t
 336 {
 337     VLC_COMMON_MEMBERS
 338
 339      /* Global properties */
 340     vlc_bool_t  b_eof;
 341     vlc_bool_t  b_can_pace_control;
 342     vlc_bool_t  b_can_pause;
 343
 344     /* Global state */
 345     int         i_state;
 346     int         i_rate;
 347
 348     /* */
 349     int64_t     i_start;    /* :start-time,0 by default */
 350     int64_t     i_time;     /* Current time */
 351     int64_t     i_stop;     /* :stop-time, 0 if none */
 352
 353     /* Title infos FIXME multi-input (not easy) ? */
 354     int          i_title;
 355     input_title_t **title;
 356
 357     int i_title_offset;
 358     int i_seekpoint_offset;
 359
 360     /* User bookmarks FIXME won't be easy with multiples input */
 361     int         i_bookmark;
 362     seekpoint_t **bookmark;
 363
 364     /* Global meta datas FIXME move to input_item_t ? */
 365     vlc_meta_t  *p_meta;
 366
 367     /* Output */
 368     es_out_t    *p_es_out;
 369     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
 370     vlc_bool_t      b_out_pace_control; /*     idem ? */
 371
 372     /* Internal caching common for all inputs */
 373     int64_t i_pts_delay;
 374
 375     /* Main input properties */
 376     input_source_t input;
 377
 378     /* Slave demuxers (subs, and others) */
 379     int            i_slave;
 380     input_source_t **slave;
 381
 382     /* Buffer of pending actions */
 383     vlc_mutex_t lock_control;
 384     int i_control;
 385     struct
 386     {
 387         /* XXX: val isn't duplicated so it won't works with string */
 388         int         i_type;
 389         vlc_value_t val;
 390     } control[INPUT_CONTROL_FIFO_SIZE];
 391 };
 392
 393 /*****************************************************************************
 394  * Prototypes
 395  *****************************************************************************/
 396 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 397 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 398 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 399 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 400
 401 enum input_query_e
 402 {
 403     /* input variable "position" */
 404     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 405     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 406
 407     /* input variable "length" */
 408     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 409
 410     /* input variable "time" */
 411     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 412     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 413
 414     /* input variable "rate" (1 is DEFAULT_RATE) */
 415     INPUT_GET_RATE,             /* arg1= int *          res=    */
 416     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 417
 418     /* input variable "state" */
 419     INPUT_GET_STATE,            /* arg1= int *          res=    */
 420     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 421
 422     /* input variable "audio-delay" and "spu-delay" */
 423     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 424     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 425     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 426     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 427
 428     /* Meta datas */
 429     INPUT_ADD_INFO,   /* arg1= char * arg2= char * arg3=...  res=can fail    */
 430     INPUT_GET_INFO,   /* arg1= char * arg2= char * arg3= char ** res=can fail*/
 431     INPUT_SET_NAME,   /* arg1= char * res=can fail    */
 432
 433     /* Input config options */
 434     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 435
 436     /* Input properties */
 437     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 438     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 439
 440     /* bookmarks */
 441     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 442     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 443     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 444     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 445     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 446     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 447 };
 448
 449 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 450 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 451
 452 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 453 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 454 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 455
 456 #endif