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