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