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