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