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     bool b_prefers_tree;             /**< Do we prefer being displayed as tree*/
  77
  78     int        i_categories;         /**< Number of info categories */
  79     info_category_t **pp_categories; /**< Pointer to the first info category */
  80
  81     int         i_es;                /**< Number of es format descriptions */
  82     es_format_t **es;                /**< Es formats */
  83
  84     input_stats_t *p_stats;          /**< Statistics */
  85     int           i_nb_played;       /**< Number of times played */
  86
  87     bool          b_error_when_reading;       /**< Error When Reading */
  88
  89     vlc_meta_t *p_meta;
  90
  91     vlc_event_manager_t event_manager;
  92
  93     vlc_mutex_t lock;                 /**< Lock for the item */
  94 };
  95
  96 #define ITEM_TYPE_UNKNOWN       0
  97 #define ITEM_TYPE_FILE          1
  98 #define ITEM_TYPE_DIRECTORY     2
  99 #define ITEM_TYPE_DISC          3
 100 #define ITEM_TYPE_CDDA          4
 101 #define ITEM_TYPE_CARD          5
 102 #define ITEM_TYPE_NET           6
 103 #define ITEM_TYPE_PLAYLIST      7
 104 #define ITEM_TYPE_NODE          8
 105 #define ITEM_TYPE_NUMBER        9
 106
 107 VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) );
 108 VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) );
 109
 110 /* This won't hold the item, but can tell to interested third parties
 111  * Like the playlist, that there is a new sub item. With this design
 112  * It is not the input item's responsability to keep all the ref of
 113  * the input item children. */
 114 VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
 115
 116
 117 /**
 118  * Option flags
 119  */
 120 enum input_item_option_e
 121 {
 122     VLC_INPUT_OPTION_TRUSTED = 0x2,
 123     VLC_INPUT_OPTION_UNIQUE  = 0x100,
 124 };
 125
 126 /**
 127  * This function allows to add an option to an existing input_item_t.
 128  */
 129 VLC_EXPORT( int,  input_item_AddOption, (input_item_t *, const char *, unsigned i_flags ) );
 130
 131 /* */
 132 VLC_EXPORT( bool, input_item_HasErrorWhenReading, ( input_item_t * ) );
 133 VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val ));
 134 VLC_EXPORT( bool, input_item_MetaMatch, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) );
 135 VLC_EXPORT( char *, input_item_GetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type ) );
 136 VLC_EXPORT( char *, input_item_GetName, ( input_item_t * p_i ) );
 137 VLC_EXPORT( char *, input_item_GetURI, ( input_item_t * p_i ) );
 138 VLC_EXPORT( void,   input_item_SetURI, ( input_item_t * p_i, const char *psz_uri ));
 139 VLC_EXPORT(mtime_t, input_item_GetDuration, ( input_item_t * p_i ) );
 140 VLC_EXPORT( void,   input_item_SetDuration, ( input_item_t * p_i, mtime_t i_duration ));
 141 VLC_EXPORT( bool,   input_item_IsPreparsed, ( input_item_t *p_i ));
 142 VLC_EXPORT( bool,   input_item_IsArtFetched, ( input_item_t *p_i ));
 143
 144
 145 #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
 146 #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
 147 #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
 148 #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
 149 #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
 150 #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
 151 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
 152 #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
 153 #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
 154 #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
 155 #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
 156 #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
 157 #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
 158 #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
 159 #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
 160 #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
 161 #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
 162
 163 #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
 164 #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
 165 #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
 166 #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
 167 #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
 168 #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
 169 #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
 170 #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
 171 #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
 172 #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
 173 #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
 174 #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
 175 #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
 176 #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
 177 #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
 178 #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
 179 #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
 180 #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
 181
 182 VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 183 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 ) );
 184 VLC_EXPORT( int, input_item_DelInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name ) );
 185
 186 #define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, -1 )
 187 #define input_item_NewExt(a,b,c,d,e,f) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f)
 188 VLC_EXPORT( input_item_t *, __input_item_NewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
 189 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 ) );
 190
 191 /*****************************************************************************
 192  * Meta data helpers
 193  *****************************************************************************/
 194 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
 195                                                         const vlc_meta_t *p_meta )
 196 {
 197     char * psz_value;
 198
 199     if( !p_meta )
 200         return;
 201
 202     if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
 203         (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
 204     {
 205         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
 206         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 207     }
 208     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
 209              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
 210     {
 211         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
 212         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 213     }
 214     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
 215              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
 216     {
 217         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
 218         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 219     }
 220     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
 221     {
 222         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
 223         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 224     }
 225 }
 226
 227 /*****************************************************************************
 228  * Seek point: (generalisation of chapters)
 229  *****************************************************************************/
 230 struct seekpoint_t
 231 {
 232     int64_t i_byte_offset;
 233     int64_t i_time_offset;
 234     char    *psz_name;
 235     int     i_level;
 236 };
 237
 238 static inline seekpoint_t *vlc_seekpoint_New( void )
 239 {
 240     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 241     point->i_byte_offset =
 242     point->i_time_offset = -1;
 243     point->i_level = 0;
 244     point->psz_name = NULL;
 245     return point;
 246 }
 247
 248 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 249 {
 250     if( !point ) return;
 251     free( point->psz_name );
 252     free( point );
 253 }
 254
 255 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 256 {
 257     seekpoint_t *point = vlc_seekpoint_New();
 258     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 259     point->i_time_offset = src->i_time_offset;
 260     point->i_byte_offset = src->i_byte_offset;
 261     return point;
 262 }
 263
 264 /*****************************************************************************
 265  * Title:
 266  *****************************************************************************/
 267 typedef struct
 268 {
 269     char        *psz_name;
 270
 271     bool        b_menu;      /* Is it a menu or a normal entry */
 272
 273     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 274     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 275
 276     /* Title seekpoint */
 277     int         i_seekpoint;
 278     seekpoint_t **seekpoint;
 279
 280 } input_title_t;
 281
 282 static inline input_title_t *vlc_input_title_New(void)
 283 {
 284     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 285
 286     t->psz_name = NULL;
 287     t->b_menu = false;
 288     t->i_length = 0;
 289     t->i_size   = 0;
 290     t->i_seekpoint = 0;
 291     t->seekpoint = NULL;
 292
 293     return t;
 294 }
 295
 296 static inline void vlc_input_title_Delete( input_title_t *t )
 297 {
 298     int i;
 299     if( t == NULL )
 300         return;
 301
 302     free( t->psz_name );
 303     for( i = 0; i < t->i_seekpoint; i++ )
 304     {
 305         free( t->seekpoint[i]->psz_name );
 306         free( t->seekpoint[i] );
 307     }
 308     free( t->seekpoint );
 309     free( t );
 310 }
 311
 312 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 313 {
 314     input_title_t *dup = vlc_input_title_New( );
 315     int i;
 316
 317     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 318     dup->b_menu      = t->b_menu;
 319     dup->i_length    = t->i_length;
 320     dup->i_size      = t->i_size;
 321     dup->i_seekpoint = t->i_seekpoint;
 322     if( t->i_seekpoint > 0 )
 323     {
 324         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 325                                                 sizeof(seekpoint_t*) );
 326
 327         for( i = 0; i < t->i_seekpoint; i++ )
 328         {
 329             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 330         }
 331     }
 332
 333     return dup;
 334 }
 335
 336 /*****************************************************************************
 337  * Attachments
 338  *****************************************************************************/
 339 struct input_attachment_t
 340 {
 341     char *psz_name;
 342     char *psz_mime;
 343     char *psz_description;
 344
 345     int  i_data;
 346     void *p_data;
 347 };
 348
 349 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 350                                                             const char *psz_mime,
 351                                                             const char *psz_description,
 352                                                             const void *p_data,
 353                                                             int i_data )
 354 {
 355     input_attachment_t *a =
 356         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
 357     if( !a )
 358         return NULL;
 359     a->psz_name = strdup( psz_name ? psz_name : "" );
 360     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 361     a->psz_description = strdup( psz_description ? psz_description : "" );
 362     a->i_data = i_data;
 363     a->p_data = NULL;
 364     if( i_data > 0 )
 365     {
 366         a->p_data = malloc( i_data );
 367         if( a->p_data && p_data )
 368             memcpy( a->p_data, p_data, i_data );
 369     }
 370     return a;
 371 }
 372 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 373 {
 374     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 375                                      a->p_data, a->i_data );
 376 }
 377 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 378 {
 379     if( !a )
 380         return;
 381     free( a->psz_name );
 382     free( a->psz_mime );
 383     free( a->psz_description );
 384     free( a->p_data );
 385     free( a );
 386 }
 387
 388 /*****************************************************************************
 389  * input defines/constants.
 390  *****************************************************************************/
 391
 392 /* i_update field of access_t/demux_t */
 393 #define INPUT_UPDATE_NONE       0x0000
 394 #define INPUT_UPDATE_SIZE       0x0001
 395 #define INPUT_UPDATE_TITLE      0x0010
 396 #define INPUT_UPDATE_SEEKPOINT  0x0020
 397 #define INPUT_UPDATE_META       0x0040
 398 #define INPUT_UPDATE_SIGNAL     0x0080
 399
 400 /** Get the input item for an input thread
 401  * FIXME see src/input/item.c but is is unsafe unless
 402  * you hold p_input
 403  */
 404 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 405
 406 typedef struct input_thread_private_t input_thread_private_t;
 407
 408 /**
 409  * Main structure representing an input thread. This structure is mostly
 410  * private. The only public fields are READ-ONLY. You must use the helpers
 411  * to modify them
 412  */
 413 struct input_thread_t
 414 {
 415     VLC_COMMON_MEMBERS;
 416
 417     bool b_eof;
 418     bool b_preparsing;
 419     bool b_dead;
 420
 421     /* All other data is input_thread is PRIVATE. You can't access it
 422      * outside of src/input */
 423     input_thread_private_t *p;
 424 };
 425
 426 /**
 427  * Record prefix string.
 428  * TODO make it configurable.
 429  */
 430 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%H:%M:%S-$ N-$ p"
 431
 432 /*****************************************************************************
 433  * Input events and variables
 434  *****************************************************************************/
 435
 436 /**
 437  * \defgroup inputvariable Input variables
 438  *
 439  * The input provides multiples variable you can write to and/or read from.
 440  *
 441  * TODO complete the documentation.
 442  * The read only variables are:
 443  *  - "length"
 444  *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
 445  *    or not, for that check position != 0.0)
 446  *  - "can-pause"
 447  *  - "can-rate"
 448  *  - "can-rewind"
 449  *  - "can-record" (if a stream can be recorded while playing)
 450  *  - "teletext-es" to get the index of spu track that is teletext -1 if no teletext)
 451  *  - "signal-quality"
 452  *  - "signal-strength"
 453  *  - "cache" (level of data cached [0 .. 1])
 454  *
 455  * The read-write variables are:
 456  *  - state (\see input_state_e)
 457  *  - rate, rate-slower, rate-faster
 458  *  - position, position-offset
 459  *  - time, time-offset
 460  *  - title, next-title, prev-title
 461  *  - chapter, next-chapter, next-chapter-prev
 462  *  - program, audio-es, video-es, spu-es
 463  *  - audio-delay, spu-delay
 464  *  - bookmark (bookmark list)
 465  *  - record
 466  *  - frame-next
 467  *  - navigation (list of "title %2i")
 468  *  - "title %2i"
 469  *
 470  * The variable used for event is
 471  *  - intf-event (\see input_event_type_e)
 472  */
 473
 474 /**
 475  * Input state
 476  *
 477  * This enum is used by the variable "state"
 478  */
 479 typedef enum input_state_e
 480 {
 481     INIT_S = 0,
 482     OPENING_S,
 483     PLAYING_S,
 484     PAUSE_S,
 485     END_S,
 486     ERROR_S,
 487 } input_state_e;
 488
 489 /**
 490  * Input rate.
 491  *
 492  * It is an integer used by the variable "rate" in the
 493  * range [INPUT_RATE_MIN, INPUT_RATE_MAX] the default value
 494  * being INPUT_RATE_DEFAULT.
 495  *
 496  * A value lower than INPUT_RATE_DEFAULT plays faster.
 497  * A value higher than INPUT_RATE_DEFAULT plays slower.
 498  */
 499
 500 /**
 501  * Default rate value
 502  */
 503 #define INPUT_RATE_DEFAULT  1000
 504 /**
 505  * Minimal rate value
 506  */
 507 #define INPUT_RATE_MIN        32            /* Up to 32/1 */
 508 /**
 509  * Maximal rate value
 510  */
 511 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 512
 513 /**
 514  * Input events
 515  *
 516  * You can catch input event by adding a callback on the variable "intf-event".
 517  * This variable is an integer that will hold a input_event_type_e value.
 518  */
 519 typedef enum input_event_type_e
 520 {
 521     /* "state" has changed */
 522     INPUT_EVENT_STATE,
 523     /* b_dead is true */
 524     INPUT_EVENT_DEAD,
 525
 526     /* "rate" has changed */
 527     INPUT_EVENT_RATE,
 528
 529     /* At least one of "position" or "time" or "length" has changed */
 530     INPUT_EVENT_TIMES,
 531
 532     /* A title has been added or removed or selected.
 533      * It imply that chapter has changed (not chapter event is sent) */
 534     INPUT_EVENT_TITLE,
 535     /* A chapter has been added or removed or selected. */
 536     INPUT_EVENT_CHAPTER,
 537
 538     /* A program has been added or removed or selected */
 539     INPUT_EVENT_PROGRAM,
 540     /* A ES has been added or removed or selected */
 541     INPUT_EVENT_ES,
 542     /* "teletext-es" has changed */
 543     INPUT_EVENT_TELETEXT,
 544
 545     /* "record" has changed */
 546     INPUT_EVENT_RECORD,
 547
 548     /* input_item_t media has changed */
 549     INPUT_EVENT_ITEM_META,
 550     /* input_item_t info has changed */
 551     INPUT_EVENT_ITEM_INFO,
 552     /* input_item_t name has changed */
 553     INPUT_EVENT_ITEM_NAME,
 554
 555     /* Input statistics have been updated */
 556     INPUT_EVENT_STATISTICS,
 557     /* At least one of "signal-quality" or "signal-strength" has changed */
 558     INPUT_EVENT_SIGNAL,
 559
 560     /* "audio-delay" has changed */
 561     INPUT_EVENT_AUDIO_DELAY,
 562     /* "spu-delay" has changed */
 563     INPUT_EVENT_SUBTITLE_DELAY,
 564
 565     /* "bookmark" has changed */
 566     INPUT_EVENT_BOOKMARK,
 567
 568     /* cache" has changed */
 569     INPUT_EVENT_CACHE,
 570
 571     /* A aout_instance_t object has been created/deleted by *the input* */
 572     INPUT_EVENT_AOUT,
 573     /* A vout_thread_t object has been created/deleted by *the input* */
 574     INPUT_EVENT_VOUT,
 575
 576 } input_event_type_e;
 577
 578 /** @}*/
 579
 580 /*****************************************************************************
 581  * Prototypes
 582  *****************************************************************************/
 583
 584 /* input_CreateThread
 585  * Release the returned input_thread_t using vlc_object_release() */
 586 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 587 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 588
 589 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 590
 591 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 592 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 593
 594 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 595 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
 596
 597 enum input_query_e
 598 {
 599     /* input variable "position" */
 600     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 601     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 602
 603     /* input variable "length" */
 604     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 605
 606     /* input variable "time" */
 607     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 608     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 609
 610     /* input variable "rate" (1 is DEFAULT_RATE) */
 611     INPUT_GET_RATE,             /* arg1= int *          res=    */
 612     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 613
 614     /* input variable "state" */
 615     INPUT_GET_STATE,            /* arg1= int *          res=    */
 616     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 617
 618     /* input variable "audio-delay" and "sub-delay" */
 619     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 620     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 621     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 622     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 623
 624     /* Meta datas */
 625     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 626     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 627     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 628     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 629
 630     /* Input config options */
 631     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 632
 633     /* Input properties */
 634     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
 635
 636     /* bookmarks */
 637     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
 638     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 639     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 640     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 641     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 642     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 643     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 644
 645     /* Attachments */
 646     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 647     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 648
 649     /* On the fly input slave */
 650     INPUT_ADD_SLAVE,       /* arg1= const char * */
 651     INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
 652
 653     /* On the fly record while playing */
 654     INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
 655     INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
 656
 657     /* ES */
 658     INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
 659
 660     /* Input ressources
 661      * XXX You must call vlc_object_release as soon as possible */
 662     INPUT_GET_AOUT,         /* arg1=aout_instance_t **              res=can fail */
 663     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, int *        res=can fail */
 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 /**
 670  * It will return the current state of the input.
 671  * Provided for convenience.
 672  */
 673 static inline input_state_e input_GetState( input_thread_t * p_input )
 674 {
 675     input_state_e state = INIT_S;
 676     input_Control( p_input, INPUT_GET_STATE, &state );
 677     return state;
 678 }
 679 /**
 680  * It will add a new subtitle source to the input.
 681  * Provided for convenience.
 682  */
 683 static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
 684 {
 685     return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
 686 }
 687
 688 /* */
 689 typedef struct input_clock_t input_clock_t;
 690 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, input_clock_t *, sout_instance_t * ) );
 691 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 692 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 693
 694 /**
 695  * This function allows to split a MRL into access, demux and path part.
 696  *
 697  *  You should not write into access and demux string as they may not point into
 698  * the provided buffer.
 699  *  The buffer provided by psz_dup will be modified.
 700  */
 701 VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) );
 702
 703 /**
 704  * This function creates a sane filename path.
 705  */
 706 VLC_EXPORT( char *, input_CreateFilename, ( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) );
 707
 708 #endif