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 = 0;
 101     p_i->psz_uri = 0;
 102     p_i->i_es = 0;
 103     p_i->es = 0;
 104     p_i->i_options  = 0;
 105     p_i->ppsz_options = 0;
 106     p_i->i_categories = 0 ;
 107     p_i->pp_categories = 0;
 108     p_i->i_type = ITEM_TYPE_UNKNOWN;
 109     p_i->b_fixed_name = VLC_TRUE;
 110
 111     p_i->p_stats = NULL;
 112     p_i->p_meta = NULL;
 113
 114     vlc_mutex_init( p_o, &p_i->lock );
 115 }
 116
 117 static inline void input_ItemCopyOptions( input_item_t *p_parent,
 118                                           input_item_t *p_child )
 119 {
 120     int i;
 121     for( i = 0 ; i< p_parent->i_options; i++ )
 122     {
 123         char *psz_option= strdup( p_parent->ppsz_options[i] );
 124         p_child->i_options++;
 125         p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
 126                                                   p_child->i_options *
 127                                                   sizeof( char * ) );
 128         p_child->ppsz_options[p_child->i_options-1] = psz_option;
 129     }
 130 }
 131
 132 VLC_EXPORT( void, input_ItemAddOption,( input_item_t *, const char * ) );
 133 VLC_EXPORT( void, input_ItemAddOptionNoDup,( input_item_t *, const char * ) );
 134
 135 static inline void input_ItemClean( input_item_t *p_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 ) vlc_meta_Delete( p_i->p_meta );
 146
 147     while( p_i->i_options )
 148     {
 149         p_i->i_options--;
 150         if( p_i->ppsz_options[p_i->i_options] )
 151             free( p_i->ppsz_options[p_i->i_options] );
 152         if( !p_i->i_options ) free( p_i->ppsz_options );
 153     }
 154
 155     while( p_i->i_es )
 156     {
 157         p_i->i_es--;
 158         es_format_Clean( p_i->es[p_i->i_es] );
 159         if( !p_i->i_es ) free( p_i->es );
 160     }
 161
 162     while( p_i->i_categories )
 163     {
 164         info_category_t *p_category =
 165             p_i->pp_categories[--(p_i->i_categories)];
 166
 167         while( p_category->i_infos )
 168         {
 169             p_category->i_infos--;
 170
 171             if( p_category->pp_infos[p_category->i_infos]->psz_name )
 172                 free( p_category->pp_infos[p_category->i_infos]->psz_name);
 173             if( p_category->pp_infos[p_category->i_infos]->psz_value )
 174                 free( p_category->pp_infos[p_category->i_infos]->psz_value );
 175             free( p_category->pp_infos[p_category->i_infos] );
 176
 177             if( !p_category->i_infos ) free( p_category->pp_infos );
 178         }
 179
 180         if( p_category->psz_name ) free( p_category->psz_name );
 181         free( p_category );
 182
 183         if( !p_i->i_categories ) free( p_i->pp_categories );
 184     }
 185
 186     vlc_mutex_destroy( &p_i->lock );
 187 }
 188
 189 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 190 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
 191
 192 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
 193 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
 194 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, int)  );
 195 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, int, int ) );
 196
 197 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
 198
 199 /*****************************************************************************
 200  * Seek point: (generalisation of chapters)
 201  *****************************************************************************/
 202 struct seekpoint_t
 203 {
 204     int64_t i_byte_offset;
 205     int64_t i_time_offset;
 206     char    *psz_name;
 207     int     i_level;
 208 };
 209
 210 static inline seekpoint_t *vlc_seekpoint_New( void )
 211 {
 212     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 213     point->i_byte_offset =
 214     point->i_time_offset = -1;
 215     point->i_level = 0;
 216     point->psz_name = NULL;
 217     return point;
 218 }
 219
 220 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 221 {
 222     if( !point ) return;
 223     if( point->psz_name ) free( point->psz_name );
 224     free( point );
 225 }
 226
 227 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 228 {
 229     seekpoint_t *point = vlc_seekpoint_New();
 230     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 231     point->i_time_offset = src->i_time_offset;
 232     point->i_byte_offset = src->i_byte_offset;
 233     return point;
 234 }
 235
 236 /*****************************************************************************
 237  * Title:
 238  *****************************************************************************/
 239 typedef struct
 240 {
 241     char        *psz_name;
 242
 243     vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
 244
 245     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 246     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 247
 248     /* Title seekpoint */
 249     int         i_seekpoint;
 250     seekpoint_t **seekpoint;
 251
 252 } input_title_t;
 253
 254 static inline input_title_t *vlc_input_title_New(void)
 255 {
 256     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 257
 258     t->psz_name = NULL;
 259     t->b_menu = VLC_FALSE;
 260     t->i_length = 0;
 261     t->i_size   = 0;
 262     t->i_seekpoint = 0;
 263     t->seekpoint = NULL;
 264
 265     return t;
 266 }
 267
 268 static inline void vlc_input_title_Delete( input_title_t *t )
 269 {
 270     int i;
 271     if( t == NULL )
 272         return;
 273
 274     if( t->psz_name ) free( t->psz_name );
 275     for( i = 0; i < t->i_seekpoint; i++ )
 276     {
 277         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 278         free( t->seekpoint[i] );
 279     }
 280     if( t->seekpoint ) free( t->seekpoint );
 281     free( t );
 282 }
 283
 284 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 285 {
 286     input_title_t *dup = vlc_input_title_New( );
 287     int i;
 288
 289     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 290     dup->b_menu      = t->b_menu;
 291     dup->i_length    = t->i_length;
 292     dup->i_size      = t->i_size;
 293     dup->i_seekpoint = t->i_seekpoint;
 294     if( t->i_seekpoint > 0 )
 295     {
 296         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 297                                                 sizeof(seekpoint_t*) );
 298
 299         for( i = 0; i < t->i_seekpoint; i++ )
 300         {
 301             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 302         }
 303     }
 304
 305     return dup;
 306 }
 307
 308 /*****************************************************************************
 309  * input defines/constants.
 310  *****************************************************************************/
 311
 312 /* "state" value */
 313 enum input_state_e
 314 {
 315     INIT_S,
 316     OPENING_S,
 317     BUFFERING_S,
 318     PLAYING_S,
 319     PAUSE_S,
 320     END_S,
 321     ERROR_S
 322 };
 323
 324 /* "rate" default, min/max
 325  * A rate below 1000 plays the movie faster,
 326  * A rate above 1000 plays the movie slower.
 327  */
 328 #define INPUT_RATE_DEFAULT  1000
 329 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 330 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 331
 332 /* i_update field of access_t/demux_t */
 333 #define INPUT_UPDATE_NONE       0x0000
 334 #define INPUT_UPDATE_SIZE       0x0001
 335 #define INPUT_UPDATE_TITLE      0x0010
 336 #define INPUT_UPDATE_SEEKPOINT  0x0020
 337 #define INPUT_UPDATE_META       0x0040
 338
 339 /* Input control XXX: internal */
 340 #define INPUT_CONTROL_FIFO_SIZE    100
 341
 342 /** Get the input item for an input thread */
 343 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 344
 345 typedef struct input_thread_private_t input_thread_private_t;
 346
 347 /**
 348  * Main structure representing an input thread. This structure is mostly
 349  * private. The only public fields are READ-ONLY. You must use the helpers
 350  * to modify them
 351  */
 352 struct input_thread_t
 353 {
 354     VLC_COMMON_MEMBERS;
 355
 356     vlc_bool_t  b_eof;
 357     vlc_bool_t b_preparsing;
 358
 359     int i_state;
 360     vlc_bool_t b_can_pace_control;
 361     int64_t     i_time;     /* Current time */
 362
 363     /* Internal caching common to all inputs */
 364     int i_pts_delay;
 365
 366     /* All other data is input_thread is PRIVATE. You can't access it
 367      * outside of src/input */
 368     input_thread_private_t *p;
 369 };
 370
 371 /*****************************************************************************
 372  * Prototypes
 373  *****************************************************************************/
 374 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 375 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 376 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 377 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 378
 379 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 380 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 381 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 382 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 383
 384 enum input_query_e
 385 {
 386     /* input variable "position" */
 387     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 388     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 389
 390     /* input variable "length" */
 391     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 392
 393     /* input variable "time" */
 394     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 395     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 396
 397     /* input variable "rate" (1 is DEFAULT_RATE) */
 398     INPUT_GET_RATE,             /* arg1= int *          res=    */
 399     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 400
 401     /* input variable "state" */
 402     INPUT_GET_STATE,            /* arg1= int *          res=    */
 403     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 404
 405     /* input variable "audio-delay" and "sub-delay" */
 406     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 407     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 408     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 409     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 410
 411     /* Meta datas */
 412     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 413     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 414     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 415     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 416
 417     /* Input config options */
 418     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 419
 420     /* Input properties */
 421     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 422     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 423
 424     /* bookmarks */
 425     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 426     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 427     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 428     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 429     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 430     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 431
 432     /* On the fly input slave */
 433     INPUT_ADD_SLAVE        /* arg1= char * */
 434 };
 435
 436 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 437 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 438
 439 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 440 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 441 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 442
 443 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );
 444
 445 #endif