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

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