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