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 #include <vlc_epg.h>
  36 #include <vlc_events.h>
  37
  38 struct vlc_meta_t;
  39
  40 /*****************************************************************************
  41  * input_item_t: Describes an input and is used to spawn input_thread_t objects
  42  *****************************************************************************/
  43 struct info_t
  44 {
  45     char *psz_name;            /**< Name of this info */
  46     char *psz_value;           /**< Value of the info */
  47 };
  48
  49 struct info_category_t
  50 {
  51     char   *psz_name;      /**< Name of this category */
  52     int    i_infos;        /**< Number of infos in the category */
  53     struct info_t **pp_infos;     /**< Pointer to an array of infos */
  54 };
  55
  56 struct input_item_t
  57 {
  58     VLC_GC_MEMBERS
  59     int        i_id;                 /**< Identifier of the item */
  60
  61     char       *psz_name;            /**< text describing this item */
  62     char       *psz_uri;             /**< mrl of this item */
  63     vlc_bool_t  b_fixed_name;        /**< Can the interface change the name ?*/
  64
  65     int        i_options;            /**< Number of input options */
  66     char       **ppsz_options;       /**< Array of input options */
  67
  68     mtime_t    i_duration;           /**< Duration in milliseconds*/
  69
  70     uint8_t    i_type;               /**< Type (file, disc, ...) */
  71     vlc_bool_t b_prefers_tree;      /**< Do we prefer being displayed as tree*/
  72
  73     int        i_categories;         /**< Number of info categories */
  74     info_category_t **pp_categories; /**< Pointer to the first info category */
  75
  76     int         i_es;                /**< Number of es format descriptions */
  77     es_format_t **es;                /**< Es formats */
  78
  79     input_stats_t *p_stats;          /**< Statistics */
  80     int           i_nb_played;       /**< Number of times played */
  81
  82     vlc_meta_t *p_meta;
  83
  84     vlc_event_manager_t event_manager;
  85
  86     vlc_mutex_t lock;                 /**< Lock for the item */
  87 };
  88
  89 #define ITEM_TYPE_UNKNOWN       0
  90 #define ITEM_TYPE_AFILE         1
  91 #define ITEM_TYPE_VFILE         2
  92 #define ITEM_TYPE_DIRECTORY     3
  93 #define ITEM_TYPE_DISC          4
  94 #define ITEM_TYPE_CDDA          5
  95 #define ITEM_TYPE_CARD          6
  96 #define ITEM_TYPE_NET           7
  97 #define ITEM_TYPE_PLAYLIST      8
  98 #define ITEM_TYPE_NODE          9
  99 #define ITEM_TYPE_NUMBER        10
 100
 101 static inline void input_ItemInit( vlc_object_t *p_o, input_item_t *p_i )
 102 {
 103     memset( p_i, 0, sizeof(input_item_t) );
 104     p_i->psz_name = NULL;
 105     p_i->psz_uri = NULL;
 106     TAB_INIT( p_i->i_es, p_i->es );
 107     TAB_INIT( p_i->i_options, p_i->ppsz_options );
 108     TAB_INIT( p_i->i_categories, p_i->pp_categories );
 109
 110     p_i->i_type = ITEM_TYPE_UNKNOWN;
 111     p_i->b_fixed_name = VLC_TRUE;
 112
 113     p_i->p_stats = NULL;
 114     p_i->p_meta = NULL;
 115
 116     vlc_mutex_init( p_o, &p_i->lock );
 117     vlc_event_manager_init( &p_i->event_manager, p_i );
 118     vlc_event_manager_register_event_type( &p_i->event_manager,
 119         vlc_InputItemMetaChanged );
 120 }
 121
 122 static inline void input_ItemCopyOptions( input_item_t *p_parent,
 123                                           input_item_t *p_child )
 124 {
 125     int i;
 126     for( i = 0 ; i< p_parent->i_options; i++ )
 127     {
 128         char *psz_option= strdup( p_parent->ppsz_options[i] );
 129         p_child->i_options++;
 130         p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
 131                                                   p_child->i_options *
 132                                                   sizeof( char * ) );
 133         p_child->ppsz_options[p_child->i_options-1] = psz_option;
 134     }
 135 }
 136
 137 VLC_EXPORT( void, input_ItemAddOption,( input_item_t *, const char * ) );
 138 VLC_EXPORT( void, input_ItemAddOptionNoDup,( input_item_t *, const char * ) );
 139
 140 static inline void input_ItemClean( input_item_t *p_i )
 141 {
 142     int i;
 143
 144     vlc_event_manager_fini( &p_i->event_manager );
 145
 146     free( p_i->psz_name );
 147     free( p_i->psz_uri );
 148     if( p_i->p_stats )
 149     {
 150         vlc_mutex_destroy( &p_i->p_stats->lock );
 151         free( p_i->p_stats );
 152     }
 153
 154     if( p_i->p_meta )
 155         vlc_meta_Delete( p_i->p_meta );
 156
 157     for( i = 0; i < p_i->i_options; i++ )
 158     {
 159         if( p_i->ppsz_options[i] )
 160             free( p_i->ppsz_options[i] );
 161     }
 162     TAB_CLEAN( p_i->i_options, p_i->ppsz_options );
 163
 164     for( i = 0; i < p_i->i_es; i++ )
 165     {
 166         es_format_Clean( p_i->es[i] );
 167         free( p_i->es[i] );
 168     }
 169     TAB_CLEAN( p_i->i_es, p_i->es );
 170
 171     for( i = 0; i < p_i->i_categories; i++ )
 172     {
 173         info_category_t *p_category = p_i->pp_categories[i];
 174         int j;
 175
 176         for( j = 0; j < p_category->i_infos; j++ )
 177         {
 178             struct info_t *p_info = p_category->pp_infos[j];
 179
 180             if( p_info->psz_name )
 181                 free( p_info->psz_name);
 182             if( p_info->psz_value )
 183                 free( p_info->psz_value );
 184             free( p_info );
 185         }
 186         TAB_CLEAN( p_category->i_infos, p_category->pp_infos );
 187
 188         if( p_category->psz_name ) free( p_category->psz_name );
 189         free( p_category );
 190     }
 191     TAB_CLEAN( p_i->i_categories, p_i->pp_categories );
 192
 193     vlc_mutex_destroy( &p_i->lock );
 194 }
 195
 196 static inline void input_item_SetMeta( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val )
 197 {
 198     vlc_event_t event;
 199     if( !p_i->p_meta )
 200         p_i->p_meta = vlc_meta_New();
 201     vlc_meta_Set( p_i->p_meta, meta_type, psz_val );
 202
 203     /* Notify interested third parties */
 204     event.type = vlc_InputItemMetaChanged;
 205     event.u.input_item_meta_changed.meta_type = meta_type;
 206     vlc_event_send( &p_i->event_manager, &event );
 207 }
 208
 209 static inline const char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
 210 {
 211     if( !p_i->p_meta )
 212         return NULL;
 213     return vlc_meta_Get( p_i->p_meta, meta_type );
 214 }
 215
 216 static inline void input_item_SetPreparsed( input_item_t *p_i, vlc_bool_t preparsed )
 217 {
 218     if( !p_i->p_meta )
 219         p_i->p_meta = vlc_meta_New();
 220
 221     if( preparsed )
 222         p_i->p_meta->i_status |= ITEM_PREPARSED;
 223     else
 224         p_i->p_meta->i_status &= ~ITEM_PREPARSED;
 225 }
 226
 227 static inline vlc_bool_t input_item_IsPreparsed( input_item_t *p_i )
 228 {
 229     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : VLC_FALSE ;
 230 }
 231
 232 static inline void input_item_SetMetaFetched( input_item_t *p_i, vlc_bool_t metafetched )
 233 {
 234     if( !p_i->p_meta )
 235         p_i->p_meta = vlc_meta_New();
 236
 237     if( metafetched )
 238         p_i->p_meta->i_status |= ITEM_META_FETCHED;
 239     else
 240         p_i->p_meta->i_status &= ~ITEM_META_FETCHED;
 241 }
 242
 243 static inline vlc_bool_t input_item_IsMetaFetched( input_item_t *p_i )
 244 {
 245     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_META_FETCHED : VLC_FALSE ;
 246 }
 247
 248
 249 static inline void input_item_SetArtNotFound( input_item_t *p_i, vlc_bool_t notfound )
 250 {
 251     if( !p_i->p_meta )
 252         p_i->p_meta = vlc_meta_New();
 253
 254     if( notfound )
 255         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
 256     else
 257         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
 258 }
 259
 260 static inline void input_item_SetArtFetched( input_item_t *p_i, vlc_bool_t artfetched )
 261 {
 262     if( !p_i->p_meta )
 263         p_i->p_meta = vlc_meta_New();
 264
 265     if( artfetched )
 266         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
 267     else
 268         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
 269 }
 270
 271 static inline vlc_bool_t input_item_IsArtFetched( input_item_t *p_i )
 272 {
 273     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : VLC_FALSE ;
 274 }
 275
 276 static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i )
 277 {
 278     if( !p_i->p_meta )
 279         p_i->p_meta = vlc_meta_New();
 280
 281     return p_i->p_meta;
 282 }
 283
 284 static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta )
 285 {
 286     if( !p_i->p_meta )
 287         p_i->p_meta = vlc_meta_New();
 288
 289     vlc_meta_Merge( p_i->p_meta, p_new_meta );
 290 }
 291
 292 #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
 293 #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
 294 #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
 295 #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
 296 #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
 297 #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
 298 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
 299 #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
 300 #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
 301 #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
 302 #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
 303 #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
 304 #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
 305 #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
 306 #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
 307 #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
 308 #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
 309
 310 #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
 311 #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
 312 #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
 313 #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
 314 #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
 315 #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
 316 #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
 317 #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
 318 #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
 319 #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
 320 #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
 321 #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
 322 #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
 323 #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
 324 #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
 325 #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
 326 #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
 327 #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
 328
 329 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 330 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
 331
 332 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
 333 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
 334 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
 335 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
 336
 337 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_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] = VLC_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] = VLC_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] = VLC_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] = VLC_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     if( point->psz_name ) 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     vlc_bool_t  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 = VLC_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     if( t->psz_name ) free( t->psz_name );
 451     for( i = 0; i < t->i_seekpoint; i++ )
 452     {
 453         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 454         free( t->seekpoint[i] );
 455     }
 456     if( t->seekpoint ) 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  * Attachments
 485  *****************************************************************************/
 486 struct input_attachment_t
 487 {
 488     char *psz_name;
 489     char *psz_mime;
 490     char *psz_description;
 491
 492     int  i_data;
 493     void *p_data;
 494 };
 495 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 496                                                             const char *psz_mime,
 497                                                             const char *psz_description,
 498                                                             const void *p_data,
 499                                                             int i_data )
 500 {
 501     input_attachment_t *a =
 502         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
 503     if( !a )
 504         return NULL;
 505     a->psz_name = strdup( psz_name ? psz_name : "" );
 506     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 507     a->psz_description = strdup( psz_description ? psz_description : "" );
 508     a->i_data = i_data;
 509     a->p_data = NULL;
 510     if( i_data > 0 )
 511     {
 512         a->p_data = malloc( i_data );
 513         if( a->p_data && p_data )
 514             memcpy( a->p_data, p_data, i_data );
 515     }
 516     return a;
 517 }
 518 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 519 {
 520     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 521                                      a->p_data, a->i_data );
 522 }
 523 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 524 {
 525     if( !a )
 526         return;
 527     free( a->psz_name );
 528     free( a->psz_mime );
 529     free( a->psz_description );
 530     if( a->p_data )
 531         free( a->p_data );
 532     free( a );
 533 }
 534 /*****************************************************************************
 535  * input defines/constants.
 536  *****************************************************************************/
 537
 538 /* "state" value */
 539 enum input_state_e
 540 {
 541     INIT_S,
 542     OPENING_S,
 543     BUFFERING_S,
 544     PLAYING_S,
 545     PAUSE_S,
 546     END_S,
 547     ERROR_S
 548 };
 549
 550 /* "rate" default, min/max
 551  * A rate below 1000 plays the movie faster,
 552  * A rate above 1000 plays the movie slower.
 553  */
 554 #define INPUT_RATE_DEFAULT  1000
 555 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 556 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 557
 558 /* i_update field of access_t/demux_t */
 559 #define INPUT_UPDATE_NONE       0x0000
 560 #define INPUT_UPDATE_SIZE       0x0001
 561 #define INPUT_UPDATE_TITLE      0x0010
 562 #define INPUT_UPDATE_SEEKPOINT  0x0020
 563 #define INPUT_UPDATE_META       0x0040
 564
 565 /* Input control XXX: internal */
 566 #define INPUT_CONTROL_FIFO_SIZE    100
 567
 568 /** Get the input item for an input thread */
 569 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 570
 571 typedef struct input_thread_private_t input_thread_private_t;
 572
 573 /**
 574  * Main structure representing an input thread. This structure is mostly
 575  * private. The only public fields are READ-ONLY. You must use the helpers
 576  * to modify them
 577  */
 578 struct input_thread_t
 579 {
 580     VLC_COMMON_MEMBERS;
 581
 582     vlc_bool_t  b_eof;
 583     vlc_bool_t b_preparsing;
 584
 585     int i_state;
 586     vlc_bool_t b_can_pace_control;
 587     int64_t     i_time;     /* Current time */
 588
 589     /* Internal caching common to all inputs */
 590     int i_pts_delay;
 591
 592     /* All other data is input_thread is PRIVATE. You can't access it
 593      * outside of src/input */
 594     input_thread_private_t *p;
 595 };
 596
 597 /*****************************************************************************
 598  * Prototypes
 599  *****************************************************************************/
 600 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 601 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 602 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 603 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 604
 605 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 606 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 607 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 608 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 609
 610 enum input_query_e
 611 {
 612     /* input variable "position" */
 613     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 614     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 615
 616     /* input variable "length" */
 617     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 618
 619     /* input variable "time" */
 620     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 621     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 622
 623     /* input variable "rate" (1 is DEFAULT_RATE) */
 624     INPUT_GET_RATE,             /* arg1= int *          res=    */
 625     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 626
 627     /* input variable "state" */
 628     INPUT_GET_STATE,            /* arg1= int *          res=    */
 629     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 630
 631     /* input variable "audio-delay" and "sub-delay" */
 632     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 633     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 634     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 635     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 636
 637     /* Meta datas */
 638     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 639     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 640     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 641     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 642
 643     /* Input config options */
 644     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 645
 646     /* Input properties */
 647     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 648     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 649
 650     /* bookmarks */
 651     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 652     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 653     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 654     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 655     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 656     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 657
 658     /* Attachments */
 659     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 660     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 661
 662     /* On the fly input slave */
 663     INPUT_ADD_SLAVE        /* arg1= char * */
 664 };
 665
 666 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 667 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 668
 669 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 670 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 671 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 672
 673 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );
 674
 675 #endif