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