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