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 /* __ is need because conflict with <vlc/input.h> */
  26 #ifndef VLC__INPUT_H
  27 #define VLC__INPUT_H 1
  28
  29 /**
  30  * \file
  31  * This file defines functions, structures and enums for input objects in vlc
  32  */
  33
  34 #include <vlc_es.h>
  35 #include <vlc_meta.h>
  36 #include <vlc_epg.h>
  37 #include <vlc_events.h>
  38
  39 #include <string.h>                                     /* strcasestr() */
  40
  41 struct vlc_meta_t;
  42
  43 /*****************************************************************************
  44  * input_item_t: Describes an input and is used to spawn input_thread_t objects
  45  *****************************************************************************/
  46 struct info_t
  47 {
  48     char *psz_name;            /**< Name of this info */
  49     char *psz_value;           /**< Value of the info */
  50 };
  51
  52 struct info_category_t
  53 {
  54     char   *psz_name;      /**< Name of this category */
  55     int    i_infos;        /**< Number of infos in the category */
  56     struct info_t **pp_infos;     /**< Pointer to an array of infos */
  57 };
  58
  59 struct input_item_t
  60 {
  61     VLC_GC_MEMBERS
  62     int        i_id;                 /**< Identifier of the item */
  63
  64     char       *psz_name;            /**< text describing this item */
  65     char       *psz_uri;             /**< mrl of this item */
  66     bool       b_fixed_name;        /**< Can the interface change the name ?*/
  67
  68     int        i_options;            /**< Number of input options */
  69     char       **ppsz_options;       /**< Array of input options */
  70     uint8_t    *optflagv;            /**< Some flags of input options */
  71     unsigned   optflagc;
  72
  73     mtime_t    i_duration;           /**< Duration in milliseconds*/
  74
  75     uint8_t    i_type;               /**< Type (file, disc, ...) */
  76
  77     int        i_categories;         /**< Number of info categories */
  78     info_category_t **pp_categories; /**< Pointer to the first info category */
  79
  80     int         i_es;                /**< Number of es format descriptions */
  81     es_format_t **es;                /**< Es formats */
  82
  83     input_stats_t *p_stats;          /**< Statistics */
  84     int           i_nb_played;       /**< Number of times played */
  85
  86     bool          b_error_when_reading;       /**< Error When Reading */
  87
  88     vlc_meta_t *p_meta;
  89
  90     vlc_event_manager_t event_manager;
  91
  92     vlc_mutex_t lock;                 /**< Lock for the item */
  93 };
  94
  95 #define ITEM_TYPE_UNKNOWN       0
  96 #define ITEM_TYPE_FILE          1
  97 #define ITEM_TYPE_DIRECTORY     2
  98 #define ITEM_TYPE_DISC          3
  99 #define ITEM_TYPE_CDDA          4
 100 #define ITEM_TYPE_CARD          5
 101 #define ITEM_TYPE_NET           6
 102 #define ITEM_TYPE_PLAYLIST      7
 103 #define ITEM_TYPE_NODE          8
 104 #define ITEM_TYPE_NUMBER        9
 105
 106 static inline void input_item_CopyOptions( input_item_t *p_parent,
 107                                           input_item_t *p_child )
 108 {
 109     int i;
 110     for( i = 0 ; i< p_parent->i_options; i++ )
 111     {
 112         char *psz_option= strdup( p_parent->ppsz_options[i] );
 113         if( !strcmp( psz_option, "meta-file" ) )
 114         {
 115             free( psz_option );
 116             continue;
 117         }
 118         p_child->i_options++;
 119         p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
 120                                                   p_child->i_options *
 121                                                   sizeof( char * ) );
 122         p_child->ppsz_options[p_child->i_options-1] = psz_option;
 123         p_child->optflagc++;
 124         p_child->optflagv = (uint8_t *)realloc( p_child->optflagv,
 125                                                 p_child->optflagc );
 126         p_child->optflagv[p_child->optflagc - 1] = p_parent->optflagv[i];
 127     }
 128 }
 129
 130 static inline void input_item_SetName( input_item_t *p_item, const char *psz_name )
 131 {
 132     free( p_item->psz_name );
 133     p_item->psz_name = strdup( psz_name );
 134 }
 135
 136 /* This won't hold the item, but can tell to interested third parties
 137  * Like the playlist, that there is a new sub item. With this design
 138  * It is not the input item's responsability to keep all the ref of
 139  * the input item children. */
 140 static inline void input_item_AddSubItem( input_item_t *p_parent,
 141                                          input_item_t *p_child )
 142 {
 143     vlc_event_t event;
 144
 145     p_parent->i_type = ITEM_TYPE_PLAYLIST;
 146
 147     /* Notify interested third parties */
 148     event.type = vlc_InputItemSubItemAdded;
 149     event.u.input_item_subitem_added.p_new_child = p_child;
 150     vlc_event_send( &p_parent->event_manager, &event );
 151 }
 152
 153 /* Flags handled past input_item_AddOpt() */
 154 #define VLC_INPUT_OPTION_TRUSTED 0x2
 155
 156 /* Flags handled within input_item_AddOpt() */
 157 #define VLC_INPUT_OPTION_UNIQUE  0x100
 158
 159 VLC_EXPORT( int, input_item_AddOpt, ( input_item_t *, const char *str, unsigned flags ) );
 160
 161 static inline
 162 int input_item_AddOption (input_item_t *item, const char *str)
 163 {
 164     return input_item_AddOpt (item, str, VLC_INPUT_OPTION_TRUSTED);
 165 }
 166
 167 static inline
 168 int input_item_HasErrorWhenReading (input_item_t *item)
 169 {
 170     return item->b_error_when_reading;
 171 }
 172
 173
 174 VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
 175
 176 static inline bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz )
 177 {
 178     vlc_mutex_lock( &p_i->lock );
 179     if( !p_i->p_meta )
 180     {
 181         vlc_mutex_unlock( &p_i->lock );
 182         return false;
 183     }
 184     const char * meta = vlc_meta_Get( p_i->p_meta, meta_type );
 185     bool ret = meta && strcasestr( meta, psz );
 186     vlc_mutex_unlock( &p_i->lock );
 187
 188     return ret;
 189 }
 190
 191 static inline char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
 192 {
 193     char * psz = NULL;
 194     vlc_mutex_lock( &p_i->lock );
 195
 196     if( !p_i->p_meta )
 197     {
 198         vlc_mutex_unlock( &p_i->lock );
 199         return NULL;
 200     }
 201
 202     if( vlc_meta_Get( p_i->p_meta, meta_type ) )
 203         psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
 204
 205     vlc_mutex_unlock( &p_i->lock );
 206     return psz;
 207 }
 208
 209 static inline char * input_item_GetName( input_item_t * p_i )
 210 {
 211     vlc_mutex_lock( &p_i->lock );
 212     char *psz_s = p_i->psz_name ? strdup( p_i->psz_name ) : NULL;
 213     vlc_mutex_unlock( &p_i->lock );
 214     return psz_s;
 215 }
 216
 217 static inline char * input_item_GetURI( input_item_t * p_i )
 218 {
 219     vlc_mutex_lock( &p_i->lock );
 220     char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
 221     vlc_mutex_unlock( &p_i->lock );
 222     return psz_s;
 223 }
 224
 225 static inline void input_item_SetURI( input_item_t * p_i, char * psz_uri )
 226 {
 227     vlc_mutex_lock( &p_i->lock );
 228     free( p_i->psz_uri );
 229     p_i->psz_uri = strdup( psz_uri );
 230     vlc_mutex_unlock( &p_i->lock );
 231 }
 232
 233 static inline mtime_t input_item_GetDuration( input_item_t * p_i )
 234 {
 235     vlc_mutex_lock( &p_i->lock );
 236     mtime_t i_duration = p_i->i_duration;
 237     vlc_mutex_unlock( &p_i->lock );
 238     return i_duration;
 239 }
 240
 241 static inline void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration )
 242 {
 243     bool send_event = false;
 244
 245     vlc_mutex_lock( &p_i->lock );
 246     if( p_i->i_duration != i_duration )
 247     {
 248         p_i->i_duration = i_duration;
 249         send_event = true;
 250     }
 251     vlc_mutex_unlock( &p_i->lock );
 252
 253     if ( send_event == true )
 254     {
 255         vlc_event_t event;
 256         event.type = vlc_InputItemDurationChanged;
 257         event.u.input_item_duration_changed.new_duration = i_duration;
 258         vlc_event_send( &p_i->event_manager, &event );
 259     }
 260
 261     return;
 262 }
 263
 264
 265 static inline bool input_item_IsPreparsed( input_item_t *p_i )
 266 {
 267     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : false ;
 268 }
 269
 270 static inline bool input_item_IsArtFetched( input_item_t *p_i )
 271 {
 272     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : false ;
 273 }
 274
 275 static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i )
 276 {
 277     if( !p_i->p_meta )
 278         p_i->p_meta = vlc_meta_New();
 279
 280     return p_i->p_meta;
 281 }
 282
 283 static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta )
 284 {
 285     if( !p_i->p_meta )
 286         p_i->p_meta = vlc_meta_New();
 287
 288     vlc_meta_Merge( p_i->p_meta, p_new_meta );
 289 }
 290
 291 #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
 292 #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
 293 #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
 294 #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
 295 #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
 296 #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
 297 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
 298 #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
 299 #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
 300 #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
 301 #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
 302 #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
 303 #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
 304 #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
 305 #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
 306 #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
 307 #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
 308
 309 #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
 310 #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
 311 #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
 312 #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
 313 #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
 314 #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
 315 #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
 316 #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
 317 #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
 318 #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
 319 #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
 320 #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
 321 #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
 322 #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
 323 #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
 324 #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
 325 #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
 326 #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
 327
 328 VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 329 VLC_EXPORT(int, input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) );
 330
 331 #define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, -1 )
 332 #define input_item_NewExt(a,b,c,d,e,f) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f)
 333 VLC_EXPORT( input_item_t *, __input_item_NewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
 334 VLC_EXPORT( input_item_t *, input_item_NewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
 335
 336 #define input_item_GetById(a,b) __input_item_GetById( VLC_OBJECT(a),b )
 337 VLC_EXPORT( input_item_t *, __input_item_GetById, (vlc_object_t *, int ) );
 338
 339 /*****************************************************************************
 340  * Meta data helpers
 341  *****************************************************************************/
 342 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
 343                                                         const vlc_meta_t *p_meta )
 344 {
 345     char * psz_value;
 346
 347     if( !p_meta )
 348         return;
 349
 350     if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
 351         (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
 352     {
 353         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
 354         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 355     }
 356     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
 357              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
 358     {
 359         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
 360         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 361     }
 362     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
 363              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
 364     {
 365         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
 366         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 367     }
 368     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
 369     {
 370         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
 371         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 372     }
 373 }
 374
 375 /*****************************************************************************
 376  * Seek point: (generalisation of chapters)
 377  *****************************************************************************/
 378 struct seekpoint_t
 379 {
 380     int64_t i_byte_offset;
 381     int64_t i_time_offset;
 382     char    *psz_name;
 383     int     i_level;
 384 };
 385
 386 static inline seekpoint_t *vlc_seekpoint_New( void )
 387 {
 388     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 389     point->i_byte_offset =
 390     point->i_time_offset = -1;
 391     point->i_level = 0;
 392     point->psz_name = NULL;
 393     return point;
 394 }
 395
 396 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 397 {
 398     if( !point ) return;
 399     free( point->psz_name );
 400     free( point );
 401 }
 402
 403 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 404 {
 405     seekpoint_t *point = vlc_seekpoint_New();
 406     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 407     point->i_time_offset = src->i_time_offset;
 408     point->i_byte_offset = src->i_byte_offset;
 409     return point;
 410 }
 411
 412 /*****************************************************************************
 413  * Title:
 414  *****************************************************************************/
 415 typedef struct
 416 {
 417     char        *psz_name;
 418
 419     bool        b_menu;      /* Is it a menu or a normal entry */
 420
 421     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 422     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 423
 424     /* Title seekpoint */
 425     int         i_seekpoint;
 426     seekpoint_t **seekpoint;
 427
 428 } input_title_t;
 429
 430 static inline input_title_t *vlc_input_title_New(void)
 431 {
 432     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 433
 434     t->psz_name = NULL;
 435     t->b_menu = false;
 436     t->i_length = 0;
 437     t->i_size   = 0;
 438     t->i_seekpoint = 0;
 439     t->seekpoint = NULL;
 440
 441     return t;
 442 }
 443
 444 static inline void vlc_input_title_Delete( input_title_t *t )
 445 {
 446     int i;
 447     if( t == NULL )
 448         return;
 449
 450     free( t->psz_name );
 451     for( i = 0; i < t->i_seekpoint; i++ )
 452     {
 453         free( t->seekpoint[i]->psz_name );
 454         free( t->seekpoint[i] );
 455     }
 456     free( t->seekpoint );
 457     free( t );
 458 }
 459
 460 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 461 {
 462     input_title_t *dup = vlc_input_title_New( );
 463     int i;
 464
 465     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 466     dup->b_menu      = t->b_menu;
 467     dup->i_length    = t->i_length;
 468     dup->i_size      = t->i_size;
 469     dup->i_seekpoint = t->i_seekpoint;
 470     if( t->i_seekpoint > 0 )
 471     {
 472         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 473                                                 sizeof(seekpoint_t*) );
 474
 475         for( i = 0; i < t->i_seekpoint; i++ )
 476         {
 477             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 478         }
 479     }
 480
 481     return dup;
 482 }
 483
 484 /*****************************************************************************
 485  * Attachments
 486  *****************************************************************************/
 487 struct input_attachment_t
 488 {
 489     char *psz_name;
 490     char *psz_mime;
 491     char *psz_description;
 492
 493     int  i_data;
 494     void *p_data;
 495 };
 496
 497 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 498                                                             const char *psz_mime,
 499                                                             const char *psz_description,
 500                                                             const void *p_data,
 501                                                             int i_data )
 502 {
 503     input_attachment_t *a =
 504         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
 505     if( !a )
 506         return NULL;
 507     a->psz_name = strdup( psz_name ? psz_name : "" );
 508     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 509     a->psz_description = strdup( psz_description ? psz_description : "" );
 510     a->i_data = i_data;
 511     a->p_data = NULL;
 512     if( i_data > 0 )
 513     {
 514         a->p_data = malloc( i_data );
 515         if( a->p_data && p_data )
 516             memcpy( a->p_data, p_data, i_data );
 517     }
 518     return a;
 519 }
 520 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 521 {
 522     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 523                                      a->p_data, a->i_data );
 524 }
 525 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 526 {
 527     if( !a )
 528         return;
 529     free( a->psz_name );
 530     free( a->psz_mime );
 531     free( a->psz_description );
 532     free( a->p_data );
 533     free( a );
 534 }
 535
 536 /*****************************************************************************
 537  * input defines/constants.
 538  *****************************************************************************/
 539
 540 /* "state" value */
 541 /* NOTE: you need to update ppsz_input_state in the RC interface
 542  * if you modify this list. */
 543 typedef enum input_state_e
 544 {
 545     INIT_S = 0,
 546     OPENING_S,
 547     BUFFERING_S,
 548     PLAYING_S,
 549     PAUSE_S,
 550     STOP_S,
 551     FORWARD_S,
 552     BACKWARD_S,
 553     END_S,
 554     ERROR_S,
 555 } input_state_e;
 556
 557 /* "rate" default, min/max
 558  * A rate below 1000 plays the movie faster,
 559  * A rate above 1000 plays the movie slower.
 560  */
 561 #define INPUT_RATE_DEFAULT  1000
 562 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 563 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 564
 565 /* i_update field of access_t/demux_t */
 566 #define INPUT_UPDATE_NONE       0x0000
 567 #define INPUT_UPDATE_SIZE       0x0001
 568 #define INPUT_UPDATE_TITLE      0x0010
 569 #define INPUT_UPDATE_SEEKPOINT  0x0020
 570 #define INPUT_UPDATE_META       0x0040
 571
 572 /* Input control XXX: internal */
 573 #define INPUT_CONTROL_FIFO_SIZE    100
 574
 575 /** Get the input item for an input thread */
 576 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 577
 578 typedef struct input_thread_private_t input_thread_private_t;
 579
 580 /**
 581  * Main structure representing an input thread. This structure is mostly
 582  * private. The only public fields are READ-ONLY. You must use the helpers
 583  * to modify them
 584  */
 585 struct input_thread_t
 586 {
 587     VLC_COMMON_MEMBERS;
 588
 589     bool  b_eof;
 590     bool b_preparsing;
 591
 592     int i_state;
 593     bool b_can_pace_control;
 594     int64_t     i_time;     /* Current time */
 595
 596     /* Internal caching common to all inputs */
 597     mtime_t i_pts_delay;
 598
 599     /* All other data is input_thread is PRIVATE. You can't access it
 600      * outside of src/input */
 601     input_thread_private_t *p;
 602 };
 603
 604 /*****************************************************************************
 605  * Prototypes
 606  *****************************************************************************/
 607
 608 /* input_CreateThread
 609  * Release the returned input_thread_t using vlc_object_release() */
 610 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 611 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 612
 613 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 614 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 615
 616 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 617 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
 618 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 619
 620 enum input_query_e
 621 {
 622     /* input variable "position" */
 623     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 624     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 625
 626     /* input variable "length" */
 627     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 628
 629     /* input variable "time" */
 630     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 631     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 632
 633     /* input variable "rate" (1 is DEFAULT_RATE) */
 634     INPUT_GET_RATE,             /* arg1= int *          res=    */
 635     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 636
 637     /* input variable "state" */
 638     INPUT_GET_STATE,            /* arg1= int *          res=    */
 639     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 640
 641     /* input variable "audio-delay" and "sub-delay" */
 642     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 643     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 644     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 645     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 646
 647     /* Meta datas */
 648     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 649     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 650     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 651     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 652
 653     /* Input config options */
 654     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 655
 656     /* Input properties */
 657     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 658     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 659     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
 660
 661     /* bookmarks */
 662     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 663     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 664     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 665     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 666     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 667     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 668
 669     /* Attachments */
 670     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 671     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 672
 673     /* On the fly input slave */
 674     INPUT_ADD_SLAVE        /* arg1= char * */
 675 };
 676
 677 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 678 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 679
 680 static inline input_state_e input_GetState( input_thread_t * p_input )
 681 {
 682     input_state_e state = INIT_S;
 683     input_Control( p_input, INPUT_GET_STATE, &state );
 684     return state;
 685 }
 686 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, bool b_force_decoder ) );
 687 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 688 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 689
 690 VLC_EXPORT( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) );
 691
 692 VLC_EXPORT( vlc_event_manager_t *, input_get_event_manager, ( input_thread_t * ) );
 693
 694 #endif