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