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