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