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