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 static inline void input_item_SetMeta( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val )
 200 {
 201     vlc_event_t event;
 202
 203     vlc_mutex_lock( &p_i->lock );
 204     if( !p_i->p_meta )
 205         p_i->p_meta = vlc_meta_New();
 206     vlc_meta_Set( p_i->p_meta, meta_type, psz_val );
 207     vlc_mutex_unlock( &p_i->lock );
 208
 209     /* Notify interested third parties */
 210     event.type = vlc_InputItemMetaChanged;
 211     event.u.input_item_meta_changed.meta_type = meta_type;
 212     vlc_event_send( &p_i->event_manager, &event );
 213 }
 214
 215 static inline vlc_bool_t input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz )
 216 {
 217     vlc_mutex_lock( &p_i->lock );
 218     if( !p_i->p_meta )
 219     {
 220         vlc_mutex_unlock( &p_i->lock );
 221         return VLC_FALSE;
 222     }
 223     const char * meta = vlc_meta_Get( p_i->p_meta, meta_type );
 224     vlc_bool_t ret = meta && strcasestr( meta, psz );
 225     vlc_mutex_unlock( &p_i->lock );
 226
 227     return ret;
 228 }
 229
 230 static inline char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
 231 {
 232     char * psz = NULL;
 233     vlc_mutex_lock( &p_i->lock );
 234
 235     if( !p_i->p_meta )
 236     {
 237         vlc_mutex_unlock( &p_i->lock );
 238         return NULL;
 239     }
 240
 241     if( vlc_meta_Get( p_i->p_meta, meta_type ) )
 242         psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
 243
 244     vlc_mutex_unlock( &p_i->lock );
 245     return psz;
 246 }
 247
 248 static inline char * input_item_GetName( input_item_t * p_i )
 249 {
 250     vlc_mutex_lock( &p_i->lock );
 251     char *psz_s = p_i->psz_name ? strdup( p_i->psz_name ) : NULL;
 252     vlc_mutex_unlock( &p_i->lock );
 253     return psz_s;
 254 }
 255
 256 static inline char * input_item_GetURI( input_item_t * p_i )
 257 {
 258     vlc_mutex_lock( &p_i->lock );
 259     char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
 260     vlc_mutex_unlock( &p_i->lock );
 261     return psz_s;
 262 }
 263
 264 static inline void input_item_SetURI( input_item_t * p_i, char * psz_uri )
 265 {
 266     vlc_mutex_lock( &p_i->lock );
 267     if( p_i->psz_uri ) free( p_i->psz_uri );
 268         p_i->psz_uri = strdup( psz_uri );
 269     vlc_mutex_unlock( &p_i->lock );
 270 }
 271
 272 static inline mtime_t input_item_GetDuration( input_item_t * p_i )
 273 {
 274     vlc_mutex_lock( &p_i->lock );
 275     mtime_t i_duration = p_i->i_duration;
 276     vlc_mutex_unlock( &p_i->lock );
 277     return i_duration;
 278 }
 279
 280 static inline void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration )
 281 {
 282     vlc_bool_t send_event = VLC_FALSE;
 283
 284     vlc_mutex_lock( &p_i->lock );
 285     if( p_i->i_duration != i_duration )
 286     {
 287         p_i->i_duration = i_duration;
 288         send_event = VLC_TRUE;
 289     }
 290     vlc_mutex_unlock( &p_i->lock );
 291
 292     if ( send_event == VLC_TRUE )
 293     {
 294         vlc_event_t event;
 295         event.type = vlc_InputItemDurationChanged;
 296         event.u.input_item_duration_changed.new_duration = i_duration;
 297         vlc_event_send( &p_i->event_manager, &event );
 298     }
 299
 300     return;
 301 }
 302
 303
 304 static inline vlc_bool_t input_item_IsPreparsed( input_item_t *p_i )
 305 {
 306     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : VLC_FALSE ;
 307 }
 308
 309 static inline vlc_bool_t input_item_IsMetaFetched( input_item_t *p_i )
 310 {
 311     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_META_FETCHED : VLC_FALSE ;
 312 }
 313
 314
 315 static inline vlc_bool_t input_item_IsArtFetched( input_item_t *p_i )
 316 {
 317     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : VLC_FALSE ;
 318 }
 319
 320 static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i )
 321 {
 322     if( !p_i->p_meta )
 323         p_i->p_meta = vlc_meta_New();
 324
 325     return p_i->p_meta;
 326 }
 327
 328 static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta )
 329 {
 330     if( !p_i->p_meta )
 331         p_i->p_meta = vlc_meta_New();
 332
 333     vlc_meta_Merge( p_i->p_meta, p_new_meta );
 334 }
 335
 336 #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
 337 #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
 338 #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
 339 #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
 340 #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
 341 #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
 342 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
 343 #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
 344 #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
 345 #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
 346 #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
 347 #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
 348 #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
 349 #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
 350 #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
 351 #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
 352 #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
 353
 354 #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
 355 #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
 356 #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
 357 #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
 358 #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
 359 #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
 360 #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
 361 #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
 362 #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
 363 #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
 364 #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
 365 #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
 366 #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
 367 #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
 368 #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
 369 #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
 370 #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
 371 #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
 372
 373 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 374 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 ) );
 375
 376 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
 377 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
 378 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
 379 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
 380
 381 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
 382
 383 /*****************************************************************************
 384  * Meta data helpers
 385  *****************************************************************************/
 386 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
 387                                                         const vlc_meta_t *p_meta )
 388 {
 389     char * psz_value;
 390
 391     if( !p_meta )
 392         return;
 393
 394     if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
 395         (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
 396     {
 397         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 398         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 399     }
 400     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
 401              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
 402     {
 403         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 404         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 405     }
 406     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
 407              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
 408     {
 409         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 410         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 411     }
 412     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
 413     {
 414         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 415         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 416     }
 417 }
 418
 419 /*****************************************************************************
 420  * Seek point: (generalisation of chapters)
 421  *****************************************************************************/
 422 struct seekpoint_t
 423 {
 424     int64_t i_byte_offset;
 425     int64_t i_time_offset;
 426     char    *psz_name;
 427     int     i_level;
 428 };
 429
 430 static inline seekpoint_t *vlc_seekpoint_New( void )
 431 {
 432     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 433     point->i_byte_offset =
 434     point->i_time_offset = -1;
 435     point->i_level = 0;
 436     point->psz_name = NULL;
 437     return point;
 438 }
 439
 440 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 441 {
 442     if( !point ) return;
 443     if( point->psz_name ) free( point->psz_name );
 444     free( point );
 445 }
 446
 447 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 448 {
 449     seekpoint_t *point = vlc_seekpoint_New();
 450     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 451     point->i_time_offset = src->i_time_offset;
 452     point->i_byte_offset = src->i_byte_offset;
 453     return point;
 454 }
 455
 456 /*****************************************************************************
 457  * Title:
 458  *****************************************************************************/
 459 typedef struct
 460 {
 461     char        *psz_name;
 462
 463     vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
 464
 465     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 466     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 467
 468     /* Title seekpoint */
 469     int         i_seekpoint;
 470     seekpoint_t **seekpoint;
 471
 472 } input_title_t;
 473
 474 static inline input_title_t *vlc_input_title_New(void)
 475 {
 476     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 477
 478     t->psz_name = NULL;
 479     t->b_menu = VLC_FALSE;
 480     t->i_length = 0;
 481     t->i_size   = 0;
 482     t->i_seekpoint = 0;
 483     t->seekpoint = NULL;
 484
 485     return t;
 486 }
 487
 488 static inline void vlc_input_title_Delete( input_title_t *t )
 489 {
 490     int i;
 491     if( t == NULL )
 492         return;
 493
 494     if( t->psz_name ) free( t->psz_name );
 495     for( i = 0; i < t->i_seekpoint; i++ )
 496     {
 497         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 498         free( t->seekpoint[i] );
 499     }
 500     if( t->seekpoint ) free( t->seekpoint );
 501     free( t );
 502 }
 503
 504 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 505 {
 506     input_title_t *dup = vlc_input_title_New( );
 507     int i;
 508
 509     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 510     dup->b_menu      = t->b_menu;
 511     dup->i_length    = t->i_length;
 512     dup->i_size      = t->i_size;
 513     dup->i_seekpoint = t->i_seekpoint;
 514     if( t->i_seekpoint > 0 )
 515     {
 516         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 517                                                 sizeof(seekpoint_t*) );
 518
 519         for( i = 0; i < t->i_seekpoint; i++ )
 520         {
 521             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 522         }
 523     }
 524
 525     return dup;
 526 }
 527 /*****************************************************************************
 528  * Attachments
 529  *****************************************************************************/
 530 struct input_attachment_t
 531 {
 532     char *psz_name;
 533     char *psz_mime;
 534     char *psz_description;
 535
 536     int  i_data;
 537     void *p_data;
 538 };
 539 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 540                                                             const char *psz_mime,
 541                                                             const char *psz_description,
 542                                                             const void *p_data,
 543                                                             int i_data )
 544 {
 545     input_attachment_t *a =
 546         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
 547     if( !a )
 548         return NULL;
 549     a->psz_name = strdup( psz_name ? psz_name : "" );
 550     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 551     a->psz_description = strdup( psz_description ? psz_description : "" );
 552     a->i_data = i_data;
 553     a->p_data = NULL;
 554     if( i_data > 0 )
 555     {
 556         a->p_data = malloc( i_data );
 557         if( a->p_data && p_data )
 558             memcpy( a->p_data, p_data, i_data );
 559     }
 560     return a;
 561 }
 562 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 563 {
 564     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 565                                      a->p_data, a->i_data );
 566 }
 567 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 568 {
 569     if( !a )
 570         return;
 571     free( a->psz_name );
 572     free( a->psz_mime );
 573     free( a->psz_description );
 574     if( a->p_data )
 575         free( a->p_data );
 576     free( a );
 577 }
 578 /*****************************************************************************
 579  * input defines/constants.
 580  *****************************************************************************/
 581
 582 /* "state" value */
 583 enum input_state_e
 584 {
 585     INIT_S,
 586     OPENING_S,
 587     BUFFERING_S,
 588     PLAYING_S,
 589     PAUSE_S,
 590     END_S,
 591     ERROR_S
 592 };
 593
 594 /* "rate" default, min/max
 595  * A rate below 1000 plays the movie faster,
 596  * A rate above 1000 plays the movie slower.
 597  */
 598 #define INPUT_RATE_DEFAULT  1000
 599 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 600 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 601
 602 /* i_update field of access_t/demux_t */
 603 #define INPUT_UPDATE_NONE       0x0000
 604 #define INPUT_UPDATE_SIZE       0x0001
 605 #define INPUT_UPDATE_TITLE      0x0010
 606 #define INPUT_UPDATE_SEEKPOINT  0x0020
 607 #define INPUT_UPDATE_META       0x0040
 608
 609 /* Input control XXX: internal */
 610 #define INPUT_CONTROL_FIFO_SIZE    100
 611
 612 /** Get the input item for an input thread */
 613 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 614
 615 typedef struct input_thread_private_t input_thread_private_t;
 616
 617 /**
 618  * Main structure representing an input thread. This structure is mostly
 619  * private. The only public fields are READ-ONLY. You must use the helpers
 620  * to modify them
 621  */
 622 struct input_thread_t
 623 {
 624     VLC_COMMON_MEMBERS;
 625
 626     vlc_bool_t  b_eof;
 627     vlc_bool_t b_preparsing;
 628
 629     int i_state;
 630     vlc_bool_t b_can_pace_control;
 631     int64_t     i_time;     /* Current time */
 632
 633     /* Internal caching common to all inputs */
 634     int i_pts_delay;
 635
 636     /* All other data is input_thread is PRIVATE. You can't access it
 637      * outside of src/input */
 638     input_thread_private_t *p;
 639 };
 640
 641 /*****************************************************************************
 642  * Prototypes
 643  *****************************************************************************/
 644 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 645 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 646 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 647 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 648
 649 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 650 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 651 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 652 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 653
 654 enum input_query_e
 655 {
 656     /* input variable "position" */
 657     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 658     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 659
 660     /* input variable "length" */
 661     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 662
 663     /* input variable "time" */
 664     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 665     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 666
 667     /* input variable "rate" (1 is DEFAULT_RATE) */
 668     INPUT_GET_RATE,             /* arg1= int *          res=    */
 669     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 670
 671     /* input variable "state" */
 672     INPUT_GET_STATE,            /* arg1= int *          res=    */
 673     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 674
 675     /* input variable "audio-delay" and "sub-delay" */
 676     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 677     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 678     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 679     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 680
 681     /* Meta datas */
 682     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 683     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 684     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 685     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 686
 687     /* Input config options */
 688     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 689
 690     /* Input properties */
 691     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 692     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 693     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
 694
 695     /* bookmarks */
 696     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 697     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 698     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 699     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 700     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 701     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 702
 703     /* Attachments */
 704     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 705     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 706
 707     /* On the fly input slave */
 708     INPUT_ADD_SLAVE        /* arg1= char * */
 709 };
 710
 711 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 712 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 713
 714 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 715 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 716 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 717
 718 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );
 719
 720 #endif