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