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

   1 /*****************************************************************************
   2  * vlc_input.h: Core input structures
   3  *****************************************************************************
   4  * Copyright (C) 1999-2006 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 #if !defined( __LIBVLC__ )
  26   #error You are not libvlc or one of its plugins. You cannot include this file
  27 #endif
  28
  29 /* __ is need because conflict with <vlc/input.h> */
  30 #ifndef _VLC__INPUT_H
  31 #define _VLC__INPUT_H 1
  32
  33 #include <vlc_es.h>
  34 #include <vlc_meta.h>
  35
  36 struct vlc_meta_t;
  37
  38 /*****************************************************************************
  39  * input_item_t: Describes an input and is used to spawn input_thread_t objects
  40  *****************************************************************************/
  41 struct info_t
  42 {
  43     char *psz_name;            /**< Name of this info */
  44     char *psz_value;           /**< Value of the info */
  45 };
  46
  47 struct info_category_t
  48 {
  49     char   *psz_name;      /**< Name of this category */
  50     int    i_infos;        /**< Number of infos in the category */
  51     struct info_t **pp_infos;     /**< Pointer to an array of infos */
  52 };
  53
  54 struct input_item_t
  55 {
  56     VLC_GC_MEMBERS
  57     int        i_id;                 /**< Identifier of the item */
  58
  59     char       *psz_name;            /**< text describing this item */
  60     char       *psz_uri;             /**< mrl of this item */
  61     vlc_bool_t  b_fixed_name;        /**< Can the interface change the name ?*/
  62
  63     int        i_options;            /**< Number of input options */
  64     char       **ppsz_options;       /**< Array of input options */
  65
  66     mtime_t    i_duration;           /**< Duration in milliseconds*/
  67
  68     uint8_t    i_type;               /**< Type (file, disc, ...) */
  69     vlc_bool_t b_prefers_tree;      /**< Do we prefer being displayed as tree*/
  70
  71     int        i_categories;         /**< Number of info categories */
  72     info_category_t **pp_categories; /**< Pointer to the first info category */
  73
  74     int         i_es;                /**< Number of es format descriptions */
  75     es_format_t **es;                /**< Es formats */
  76
  77     input_stats_t *p_stats;          /**< Statistics */
  78     int           i_nb_played;       /**< Number of times played */
  79
  80     vlc_meta_t *p_meta;
  81
  82     vlc_mutex_t lock;                /**< Lock for the item */
  83 };
  84
  85 #define ITEM_TYPE_UNKNOWN       0
  86 #define ITEM_TYPE_AFILE         1
  87 #define ITEM_TYPE_VFILE         2
  88 #define ITEM_TYPE_DIRECTORY     3
  89 #define ITEM_TYPE_DISC          4
  90 #define ITEM_TYPE_CDDA          5
  91 #define ITEM_TYPE_CARD          6
  92 #define ITEM_TYPE_NET           7
  93 #define ITEM_TYPE_PLAYLIST      8
  94 #define ITEM_TYPE_NODE          9
  95 #define ITEM_TYPE_NUMBER        10
  96
  97 static inline void input_ItemInit( vlc_object_t *p_o, input_item_t *p_i )
  98 {
  99     memset( p_i, 0, sizeof(input_item_t) );
 100     p_i->psz_name = NULL;
 101     p_i->psz_uri = NULL;
 102     TAB_INIT( p_i->i_es, p_i->es );
 103     TAB_INIT( p_i->i_options, p_i->ppsz_options );
 104     TAB_INIT( p_i->i_categories, p_i->pp_categories );
 105
 106     p_i->i_type = ITEM_TYPE_UNKNOWN;
 107     p_i->b_fixed_name = VLC_TRUE;
 108
 109     p_i->p_stats = NULL;
 110     p_i->p_meta = NULL;
 111
 112     vlc_mutex_init( p_o, &p_i->lock );
 113 }
 114
 115 static inline void input_ItemCopyOptions( input_item_t *p_parent,
 116                                           input_item_t *p_child )
 117 {
 118     int i;
 119     for( i = 0 ; i< p_parent->i_options; i++ )
 120     {
 121         char *psz_option= strdup( p_parent->ppsz_options[i] );
 122         p_child->i_options++;
 123         p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
 124                                                   p_child->i_options *
 125                                                   sizeof( char * ) );
 126         p_child->ppsz_options[p_child->i_options-1] = psz_option;
 127     }
 128 }
 129
 130 VLC_EXPORT( void, input_ItemAddOption,( input_item_t *, const char * ) );
 131 VLC_EXPORT( void, input_ItemAddOptionNoDup,( input_item_t *, const char * ) );
 132
 133 static inline void input_ItemClean( input_item_t *p_i )
 134 {
 135     int i;
 136
 137     free( p_i->psz_name );
 138     free( p_i->psz_uri );
 139     if( p_i->p_stats )
 140     {
 141         vlc_mutex_destroy( &p_i->p_stats->lock );
 142         free( p_i->p_stats );
 143     }
 144
 145     if( p_i->p_meta )
 146         vlc_meta_Delete( p_i->p_meta );
 147
 148     for( i = 0; i < p_i->i_options; i++ )
 149     {
 150         if( p_i->ppsz_options[i] )
 151             free( p_i->ppsz_options[i] );
 152     }
 153     TAB_CLEAN( p_i->i_options, p_i->ppsz_options );
 154
 155     for( i = 0; i < p_i->i_es; i++ )
 156     {
 157         es_format_Clean( p_i->es[i] );
 158         free( p_i->es[i] );
 159     }
 160     TAB_CLEAN( p_i->i_es, p_i->es );
 161
 162     for( i = 0; i < p_i->i_categories; i++ )
 163     {
 164         info_category_t *p_category = p_i->pp_categories[i];
 165         int j;
 166
 167         for( j = 0; j < p_category->i_infos; j++ )
 168         {
 169             struct info_t *p_info = p_category->pp_infos[j];
 170
 171             if( p_info->psz_name )
 172                 free( p_info->psz_name);
 173             if( p_info->psz_value )
 174                 free( p_info->psz_value );
 175             free( p_info );
 176         }
 177         TAB_CLEAN( p_category->i_infos, p_category->pp_infos );
 178
 179         if( p_category->psz_name ) free( p_category->psz_name );
 180         free( p_category );
 181     }
 182     TAB_CLEAN( p_i->i_categories, p_i->pp_categories );
 183
 184     vlc_mutex_destroy( &p_i->lock );
 185 }
 186
 187 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 188 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
 189
 190 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
 191 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
 192 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, int)  );
 193 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, int, int ) );
 194
 195 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
 196
 197 /*****************************************************************************
 198  * Seek point: (generalisation of chapters)
 199  *****************************************************************************/
 200 struct seekpoint_t
 201 {
 202     int64_t i_byte_offset;
 203     int64_t i_time_offset;
 204     char    *psz_name;
 205     int     i_level;
 206 };
 207
 208 static inline seekpoint_t *vlc_seekpoint_New( void )
 209 {
 210     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 211     point->i_byte_offset =
 212     point->i_time_offset = -1;
 213     point->i_level = 0;
 214     point->psz_name = NULL;
 215     return point;
 216 }
 217
 218 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 219 {
 220     if( !point ) return;
 221     if( point->psz_name ) free( point->psz_name );
 222     free( point );
 223 }
 224
 225 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 226 {
 227     seekpoint_t *point = vlc_seekpoint_New();
 228     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 229     point->i_time_offset = src->i_time_offset;
 230     point->i_byte_offset = src->i_byte_offset;
 231     return point;
 232 }
 233
 234 /*****************************************************************************
 235  * Title:
 236  *****************************************************************************/
 237 typedef struct
 238 {
 239     char        *psz_name;
 240
 241     vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
 242
 243     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 244     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 245
 246     /* Title seekpoint */
 247     int         i_seekpoint;
 248     seekpoint_t **seekpoint;
 249
 250 } input_title_t;
 251
 252 static inline input_title_t *vlc_input_title_New(void)
 253 {
 254     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 255
 256     t->psz_name = NULL;
 257     t->b_menu = VLC_FALSE;
 258     t->i_length = 0;
 259     t->i_size   = 0;
 260     t->i_seekpoint = 0;
 261     t->seekpoint = NULL;
 262
 263     return t;
 264 }
 265
 266 static inline void vlc_input_title_Delete( input_title_t *t )
 267 {
 268     int i;
 269     if( t == NULL )
 270         return;
 271
 272     if( t->psz_name ) free( t->psz_name );
 273     for( i = 0; i < t->i_seekpoint; i++ )
 274     {
 275         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 276         free( t->seekpoint[i] );
 277     }
 278     if( t->seekpoint ) free( t->seekpoint );
 279     free( t );
 280 }
 281
 282 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 283 {
 284     input_title_t *dup = vlc_input_title_New( );
 285     int i;
 286
 287     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 288     dup->b_menu      = t->b_menu;
 289     dup->i_length    = t->i_length;
 290     dup->i_size      = t->i_size;
 291     dup->i_seekpoint = t->i_seekpoint;
 292     if( t->i_seekpoint > 0 )
 293     {
 294         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 295                                                 sizeof(seekpoint_t*) );
 296
 297         for( i = 0; i < t->i_seekpoint; i++ )
 298         {
 299             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 300         }
 301     }
 302
 303     return dup;
 304 }
 305
 306 /*****************************************************************************
 307  * input defines/constants.
 308  *****************************************************************************/
 309
 310 /* "state" value */
 311 enum input_state_e
 312 {
 313     INIT_S,
 314     OPENING_S,
 315     BUFFERING_S,
 316     PLAYING_S,
 317     PAUSE_S,
 318     END_S,
 319     ERROR_S
 320 };
 321
 322 /* "rate" default, min/max
 323  * A rate below 1000 plays the movie faster,
 324  * A rate above 1000 plays the movie slower.
 325  */
 326 #define INPUT_RATE_DEFAULT  1000
 327 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 328 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 329
 330 /* i_update field of access_t/demux_t */
 331 #define INPUT_UPDATE_NONE       0x0000
 332 #define INPUT_UPDATE_SIZE       0x0001
 333 #define INPUT_UPDATE_TITLE      0x0010
 334 #define INPUT_UPDATE_SEEKPOINT  0x0020
 335 #define INPUT_UPDATE_META       0x0040
 336
 337 /* Input control XXX: internal */
 338 #define INPUT_CONTROL_FIFO_SIZE    100
 339
 340 /** Get the input item for an input thread */
 341 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 342
 343 typedef struct input_thread_private_t input_thread_private_t;
 344
 345 /**
 346  * Main structure representing an input thread. This structure is mostly
 347  * private. The only public fields are READ-ONLY. You must use the helpers
 348  * to modify them
 349  */
 350 struct input_thread_t
 351 {
 352     VLC_COMMON_MEMBERS;
 353
 354     vlc_bool_t  b_eof;
 355     vlc_bool_t b_preparsing;
 356
 357     int i_state;
 358     vlc_bool_t b_can_pace_control;
 359     int64_t     i_time;     /* Current time */
 360
 361     /* Internal caching common to all inputs */
 362     int i_pts_delay;
 363
 364     /* All other data is input_thread is PRIVATE. You can't access it
 365      * outside of src/input */
 366     input_thread_private_t *p;
 367 };
 368
 369 /*****************************************************************************
 370  * Prototypes
 371  *****************************************************************************/
 372 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 373 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 374 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 375 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 376
 377 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 378 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 379 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 380 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 381
 382 enum input_query_e
 383 {
 384     /* input variable "position" */
 385     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 386     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 387
 388     /* input variable "length" */
 389     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 390
 391     /* input variable "time" */
 392     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 393     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 394
 395     /* input variable "rate" (1 is DEFAULT_RATE) */
 396     INPUT_GET_RATE,             /* arg1= int *          res=    */
 397     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 398
 399     /* input variable "state" */
 400     INPUT_GET_STATE,            /* arg1= int *          res=    */
 401     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 402
 403     /* input variable "audio-delay" and "sub-delay" */
 404     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 405     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 406     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 407     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 408
 409     /* Meta datas */
 410     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 411     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 412     INPUT_DEL_INFO,   /* arg1= char* arg2= 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     /* On the fly input slave */
 431     INPUT_ADD_SLAVE        /* arg1= char * */
 432 };
 433
 434 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 435 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 436
 437 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 438 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 439 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 440
 441 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );
 442
 443 #endif