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 #ifndef __USE_GNU
  30 #define __USE_GNU
  31 #endif
  32 #include <string.h>                                     /* strcasestr() */
  33
  34 /* __ is need because conflict with <vlc/input.h> */
  35 #ifndef _VLC__INPUT_H
  36 #define _VLC__INPUT_H 1
  37
  38 #include <vlc_es.h>
  39 #include <vlc_meta.h>
  40 #include <vlc_epg.h>
  41 #include <vlc_events.h>
  42
  43 struct vlc_meta_t;
  44
  45 /*****************************************************************************
  46  * input_item_t: Describes an input and is used to spawn input_thread_t objects
  47  *****************************************************************************/
  48 struct info_t
  49 {
  50     char *psz_name;            /**< Name of this info */
  51     char *psz_value;           /**< Value of the info */
  52 };
  53
  54 struct info_category_t
  55 {
  56     char   *psz_name;      /**< Name of this category */
  57     int    i_infos;        /**< Number of infos in the category */
  58     struct info_t **pp_infos;     /**< Pointer to an array of infos */
  59 };
  60
  61 struct input_item_t
  62 {
  63     VLC_GC_MEMBERS
  64     int        i_id;                 /**< Identifier of the item */
  65
  66     char       *psz_name;            /**< text describing this item */
  67     char       *psz_uri;             /**< mrl of this item */
  68     vlc_bool_t  b_fixed_name;        /**< Can the interface change the name ?*/
  69
  70     int        i_options;            /**< Number of input options */
  71     char       **ppsz_options;       /**< Array of input options */
  72
  73     mtime_t    i_duration;           /**< Duration in milliseconds*/
  74
  75     uint8_t    i_type;               /**< Type (file, disc, ...) */
  76     vlc_bool_t b_prefers_tree;      /**< Do we prefer being displayed as tree*/
  77
  78     int        i_categories;         /**< Number of info categories */
  79     info_category_t **pp_categories; /**< Pointer to the first info category */
  80
  81     int         i_es;                /**< Number of es format descriptions */
  82     es_format_t **es;                /**< Es formats */
  83
  84     input_stats_t *p_stats;          /**< Statistics */
  85     int           i_nb_played;       /**< Number of times played */
  86
  87     vlc_meta_t *p_meta;
  88
  89     vlc_event_manager_t event_manager;
  90
  91     vlc_mutex_t lock;                 /**< Lock for the item */
  92 };
  93
  94 #define ITEM_TYPE_UNKNOWN       0
  95 #define ITEM_TYPE_AFILE         1
  96 #define ITEM_TYPE_VFILE         2
  97 #define ITEM_TYPE_DIRECTORY     3
  98 #define ITEM_TYPE_DISC          4
  99 #define ITEM_TYPE_CDDA          5
 100 #define ITEM_TYPE_CARD          6
 101 #define ITEM_TYPE_NET           7
 102 #define ITEM_TYPE_PLAYLIST      8
 103 #define ITEM_TYPE_NODE          9
 104 #define ITEM_TYPE_NUMBER        10
 105
 106 static inline void input_ItemInit( vlc_object_t *p_o, input_item_t *p_i )
 107 {
 108     memset( p_i, 0, sizeof(input_item_t) );
 109     p_i->psz_name = NULL;
 110     p_i->psz_uri = NULL;
 111     TAB_INIT( p_i->i_es, p_i->es );
 112     TAB_INIT( p_i->i_options, p_i->ppsz_options );
 113     TAB_INIT( p_i->i_categories, p_i->pp_categories );
 114
 115     p_i->i_type = ITEM_TYPE_UNKNOWN;
 116     p_i->b_fixed_name = VLC_TRUE;
 117
 118     p_i->p_stats = NULL;
 119     p_i->p_meta = NULL;
 120
 121     vlc_mutex_init( p_o, &p_i->lock );
 122     vlc_event_manager_init( &p_i->event_manager, p_i, p_o );
 123     vlc_event_manager_register_event_type( &p_i->event_manager,
 124         vlc_InputItemMetaChanged );
 125     vlc_event_manager_register_event_type( &p_i->event_manager,
 126         vlc_InputItemSubItemAdded );
 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_ItemSetName( 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     const char * meta = vlc_meta_Get( p_i->p_meta, meta_type );
 246     vlc_bool_t ret = meta && strcasestr( meta, psz );
 247     vlc_mutex_unlock( &p_i->lock );
 248
 249     return ret;
 250 }
 251
 252 static inline char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
 253 {
 254     char * psz = NULL;
 255     vlc_mutex_lock( &p_i->lock );
 256
 257     if( !p_i->p_meta )
 258     {
 259         vlc_mutex_unlock( &p_i->lock );
 260         return NULL;
 261     }
 262
 263     if( vlc_meta_Get( p_i->p_meta, meta_type ) )
 264         psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
 265
 266     vlc_mutex_unlock( &p_i->lock );
 267     return psz;
 268 }
 269
 270 static inline char * input_item_GetName( input_item_t * p_i )
 271 {
 272     vlc_mutex_lock( &p_i->lock );
 273     char *psz_s = p_i->psz_name ? strdup( p_i->psz_name ) : NULL;
 274     vlc_mutex_unlock( &p_i->lock );
 275     return psz_s;
 276 }
 277
 278 static inline void input_item_SetPreparsed( input_item_t *p_i, vlc_bool_t preparsed )
 279 {
 280     if( !p_i->p_meta )
 281         p_i->p_meta = vlc_meta_New();
 282
 283     if( preparsed )
 284         p_i->p_meta->i_status |= ITEM_PREPARSED;
 285     else
 286         p_i->p_meta->i_status &= ~ITEM_PREPARSED;
 287 }
 288
 289 static inline vlc_bool_t input_item_IsPreparsed( input_item_t *p_i )
 290 {
 291     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : VLC_FALSE ;
 292 }
 293
 294 static inline void input_item_SetMetaFetched( input_item_t *p_i, vlc_bool_t metafetched )
 295 {
 296     if( !p_i->p_meta )
 297         p_i->p_meta = vlc_meta_New();
 298
 299     if( metafetched )
 300         p_i->p_meta->i_status |= ITEM_META_FETCHED;
 301     else
 302         p_i->p_meta->i_status &= ~ITEM_META_FETCHED;
 303 }
 304
 305 static inline vlc_bool_t input_item_IsMetaFetched( input_item_t *p_i )
 306 {
 307     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_META_FETCHED : VLC_FALSE ;
 308 }
 309
 310
 311 static inline void input_item_SetArtNotFound( input_item_t *p_i, vlc_bool_t notfound )
 312 {
 313     if( !p_i->p_meta )
 314         p_i->p_meta = vlc_meta_New();
 315
 316     if( notfound )
 317         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
 318     else
 319         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
 320 }
 321
 322 static inline void input_item_SetArtFetched( input_item_t *p_i, vlc_bool_t artfetched )
 323 {
 324     if( !p_i->p_meta )
 325         p_i->p_meta = vlc_meta_New();
 326
 327     if( artfetched )
 328         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
 329     else
 330         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
 331 }
 332
 333 static inline vlc_bool_t input_item_IsArtFetched( input_item_t *p_i )
 334 {
 335     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : VLC_FALSE ;
 336 }
 337
 338 static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i )
 339 {
 340     if( !p_i->p_meta )
 341         p_i->p_meta = vlc_meta_New();
 342
 343     return p_i->p_meta;
 344 }
 345
 346 static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta )
 347 {
 348     if( !p_i->p_meta )
 349         p_i->p_meta = vlc_meta_New();
 350
 351     vlc_meta_Merge( p_i->p_meta, p_new_meta );
 352 }
 353
 354 #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
 355 #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
 356 #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
 357 #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
 358 #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
 359 #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
 360 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
 361 #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
 362 #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
 363 #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
 364 #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
 365 #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
 366 #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
 367 #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
 368 #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
 369 #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
 370 #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
 371
 372 #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
 373 #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
 374 #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
 375 #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
 376 #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
 377 #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
 378 #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
 379 #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
 380 #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
 381 #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
 382 #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
 383 #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
 384 #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
 385 #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
 386 #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
 387 #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
 388 #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
 389 #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
 390
 391 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 392 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
 393
 394 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
 395 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
 396 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
 397 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
 398
 399 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
 400
 401 /*****************************************************************************
 402  * Meta data helpers
 403  *****************************************************************************/
 404 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
 405                                                         const vlc_meta_t *p_meta )
 406 {
 407     char * psz_value;
 408
 409     if( !p_meta )
 410         return;
 411
 412     if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
 413         (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
 414     {
 415         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 416         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 417     }
 418     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
 419              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
 420     {
 421         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 422         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 423     }
 424     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
 425              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
 426     {
 427         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 428         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 429     }
 430     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
 431     {
 432         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 433         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 434     }
 435 }
 436
 437 /*****************************************************************************
 438  * Seek point: (generalisation of chapters)
 439  *****************************************************************************/
 440 struct seekpoint_t
 441 {
 442     int64_t i_byte_offset;
 443     int64_t i_time_offset;
 444     char    *psz_name;
 445     int     i_level;
 446 };
 447
 448 static inline seekpoint_t *vlc_seekpoint_New( void )
 449 {
 450     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 451     point->i_byte_offset =
 452     point->i_time_offset = -1;
 453     point->i_level = 0;
 454     point->psz_name = NULL;
 455     return point;
 456 }
 457
 458 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 459 {
 460     if( !point ) return;
 461     if( point->psz_name ) free( point->psz_name );
 462     free( point );
 463 }
 464
 465 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 466 {
 467     seekpoint_t *point = vlc_seekpoint_New();
 468     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 469     point->i_time_offset = src->i_time_offset;
 470     point->i_byte_offset = src->i_byte_offset;
 471     return point;
 472 }
 473
 474 /*****************************************************************************
 475  * Title:
 476  *****************************************************************************/
 477 typedef struct
 478 {
 479     char        *psz_name;
 480
 481     vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
 482
 483     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 484     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 485
 486     /* Title seekpoint */
 487     int         i_seekpoint;
 488     seekpoint_t **seekpoint;
 489
 490 } input_title_t;
 491
 492 static inline input_title_t *vlc_input_title_New(void)
 493 {
 494     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 495
 496     t->psz_name = NULL;
 497     t->b_menu = VLC_FALSE;
 498     t->i_length = 0;
 499     t->i_size   = 0;
 500     t->i_seekpoint = 0;
 501     t->seekpoint = NULL;
 502
 503     return t;
 504 }
 505
 506 static inline void vlc_input_title_Delete( input_title_t *t )
 507 {
 508     int i;
 509     if( t == NULL )
 510         return;
 511
 512     if( t->psz_name ) free( t->psz_name );
 513     for( i = 0; i < t->i_seekpoint; i++ )
 514     {
 515         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 516         free( t->seekpoint[i] );
 517     }
 518     if( t->seekpoint ) free( t->seekpoint );
 519     free( t );
 520 }
 521
 522 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 523 {
 524     input_title_t *dup = vlc_input_title_New( );
 525     int i;
 526
 527     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 528     dup->b_menu      = t->b_menu;
 529     dup->i_length    = t->i_length;
 530     dup->i_size      = t->i_size;
 531     dup->i_seekpoint = t->i_seekpoint;
 532     if( t->i_seekpoint > 0 )
 533     {
 534         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 535                                                 sizeof(seekpoint_t*) );
 536
 537         for( i = 0; i < t->i_seekpoint; i++ )
 538         {
 539             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 540         }
 541     }
 542
 543     return dup;
 544 }
 545 /*****************************************************************************
 546  * Attachments
 547  *****************************************************************************/
 548 struct input_attachment_t
 549 {
 550     char *psz_name;
 551     char *psz_mime;
 552     char *psz_description;
 553
 554     int  i_data;
 555     void *p_data;
 556 };
 557 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 558                                                             const char *psz_mime,
 559                                                             const char *psz_description,
 560                                                             const void *p_data,
 561                                                             int i_data )
 562 {
 563     input_attachment_t *a =
 564         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
 565     if( !a )
 566         return NULL;
 567     a->psz_name = strdup( psz_name ? psz_name : "" );
 568     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 569     a->psz_description = strdup( psz_description ? psz_description : "" );
 570     a->i_data = i_data;
 571     a->p_data = NULL;
 572     if( i_data > 0 )
 573     {
 574         a->p_data = malloc( i_data );
 575         if( a->p_data && p_data )
 576             memcpy( a->p_data, p_data, i_data );
 577     }
 578     return a;
 579 }
 580 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 581 {
 582     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 583                                      a->p_data, a->i_data );
 584 }
 585 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 586 {
 587     if( !a )
 588         return;
 589     free( a->psz_name );
 590     free( a->psz_mime );
 591     free( a->psz_description );
 592     if( a->p_data )
 593         free( a->p_data );
 594     free( a );
 595 }
 596 /*****************************************************************************
 597  * input defines/constants.
 598  *****************************************************************************/
 599
 600 /* "state" value */
 601 enum input_state_e
 602 {
 603     INIT_S,
 604     OPENING_S,
 605     BUFFERING_S,
 606     PLAYING_S,
 607     PAUSE_S,
 608     END_S,
 609     ERROR_S
 610 };
 611
 612 /* "rate" default, min/max
 613  * A rate below 1000 plays the movie faster,
 614  * A rate above 1000 plays the movie slower.
 615  */
 616 #define INPUT_RATE_DEFAULT  1000
 617 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 618 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 619
 620 /* i_update field of access_t/demux_t */
 621 #define INPUT_UPDATE_NONE       0x0000
 622 #define INPUT_UPDATE_SIZE       0x0001
 623 #define INPUT_UPDATE_TITLE      0x0010
 624 #define INPUT_UPDATE_SEEKPOINT  0x0020
 625 #define INPUT_UPDATE_META       0x0040
 626
 627 /* Input control XXX: internal */
 628 #define INPUT_CONTROL_FIFO_SIZE    100
 629
 630 /** Get the input item for an input thread */
 631 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 632
 633 typedef struct input_thread_private_t input_thread_private_t;
 634
 635 /**
 636  * Main structure representing an input thread. This structure is mostly
 637  * private. The only public fields are READ-ONLY. You must use the helpers
 638  * to modify them
 639  */
 640 struct input_thread_t
 641 {
 642     VLC_COMMON_MEMBERS;
 643
 644     vlc_bool_t  b_eof;
 645     vlc_bool_t b_preparsing;
 646
 647     int i_state;
 648     vlc_bool_t b_can_pace_control;
 649     int64_t     i_time;     /* Current time */
 650
 651     /* Internal caching common to all inputs */
 652     int i_pts_delay;
 653
 654     /* All other data is input_thread is PRIVATE. You can't access it
 655      * outside of src/input */
 656     input_thread_private_t *p;
 657 };
 658
 659 /*****************************************************************************
 660  * Prototypes
 661  *****************************************************************************/
 662 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 663 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 664 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 665 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 666
 667 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 668 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 669 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 670 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 671
 672 enum input_query_e
 673 {
 674     /* input variable "position" */
 675     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 676     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 677
 678     /* input variable "length" */
 679     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 680
 681     /* input variable "time" */
 682     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 683     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 684
 685     /* input variable "rate" (1 is DEFAULT_RATE) */
 686     INPUT_GET_RATE,             /* arg1= int *          res=    */
 687     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 688
 689     /* input variable "state" */
 690     INPUT_GET_STATE,            /* arg1= int *          res=    */
 691     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 692
 693     /* input variable "audio-delay" and "sub-delay" */
 694     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 695     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 696     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 697     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 698
 699     /* Meta datas */
 700     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 701     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 702     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 703     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 704
 705     /* Input config options */
 706     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 707
 708     /* Input properties */
 709     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 710     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 711
 712     /* bookmarks */
 713     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 714     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 715     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 716     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 717     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 718     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 719
 720     /* Attachments */
 721     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 722     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 723
 724     /* On the fly input slave */
 725     INPUT_ADD_SLAVE        /* arg1= char * */
 726 };
 727
 728 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 729 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 730
 731 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 732 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 733 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 734
 735 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );
 736
 737 #endif