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