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