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, p_o );
 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
 225     vlc_mutex_lock( &p_i->lock );
 226     if( !p_i->p_meta )
 227         p_i->p_meta = vlc_meta_New();
 228     vlc_meta_Set( p_i->p_meta, meta_type, psz_val );
 229     vlc_mutex_unlock( &p_i->lock );
 230
 231     /* Notify interested third parties */
 232     event.type = vlc_InputItemMetaChanged;
 233     event.u.input_item_meta_changed.meta_type = meta_type;
 234     vlc_event_send( &p_i->event_manager, &event );
 235 }
 236
 237 static inline char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
 238 {
 239     char * psz = NULL;
 240     vlc_mutex_lock( &p_i->lock );
 241
 242     if( !p_i->p_meta )
 243     {
 244         vlc_mutex_unlock( &p_i->lock );
 245         return NULL;
 246     }
 247
 248     if( vlc_meta_Get( p_i->p_meta, meta_type ) )
 249         psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );
 250
 251     vlc_mutex_unlock( &p_i->lock );
 252     return psz;
 253 }
 254
 255 static inline char * input_item_GetName( input_item_t *p_i )
 256 {
 257     vlc_mutex_lock( &p_i->lock );
 258     char *psz_s = p_i->psz_name ? strdup( p_i->psz_name ) : NULL;
 259     vlc_mutex_unlock( &p_i->lock );
 260     return psz_s;
 261 }
 262
 263 static inline void input_item_SetPreparsed( input_item_t *p_i, vlc_bool_t preparsed )
 264 {
 265     if( !p_i->p_meta )
 266         p_i->p_meta = vlc_meta_New();
 267
 268     if( preparsed )
 269         p_i->p_meta->i_status |= ITEM_PREPARSED;
 270     else
 271         p_i->p_meta->i_status &= ~ITEM_PREPARSED;
 272 }
 273
 274 static inline vlc_bool_t input_item_IsPreparsed( input_item_t *p_i )
 275 {
 276     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : VLC_FALSE ;
 277 }
 278
 279 static inline void input_item_SetMetaFetched( input_item_t *p_i, vlc_bool_t metafetched )
 280 {
 281     if( !p_i->p_meta )
 282         p_i->p_meta = vlc_meta_New();
 283
 284     if( metafetched )
 285         p_i->p_meta->i_status |= ITEM_META_FETCHED;
 286     else
 287         p_i->p_meta->i_status &= ~ITEM_META_FETCHED;
 288 }
 289
 290 static inline vlc_bool_t input_item_IsMetaFetched( input_item_t *p_i )
 291 {
 292     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_META_FETCHED : VLC_FALSE ;
 293 }
 294
 295
 296 static inline void input_item_SetArtNotFound( input_item_t *p_i, vlc_bool_t notfound )
 297 {
 298     if( !p_i->p_meta )
 299         p_i->p_meta = vlc_meta_New();
 300
 301     if( notfound )
 302         p_i->p_meta->i_status |= ITEM_ART_NOTFOUND;
 303     else
 304         p_i->p_meta->i_status &= ~ITEM_ART_NOTFOUND;
 305 }
 306
 307 static inline void input_item_SetArtFetched( input_item_t *p_i, vlc_bool_t artfetched )
 308 {
 309     if( !p_i->p_meta )
 310         p_i->p_meta = vlc_meta_New();
 311
 312     if( artfetched )
 313         p_i->p_meta->i_status |= ITEM_ART_FETCHED;
 314     else
 315         p_i->p_meta->i_status &= ~ITEM_ART_FETCHED;
 316 }
 317
 318 static inline vlc_bool_t input_item_IsArtFetched( input_item_t *p_i )
 319 {
 320     return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : VLC_FALSE ;
 321 }
 322
 323 static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i )
 324 {
 325     if( !p_i->p_meta )
 326         p_i->p_meta = vlc_meta_New();
 327
 328     return p_i->p_meta;
 329 }
 330
 331 static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta )
 332 {
 333     if( !p_i->p_meta )
 334         p_i->p_meta = vlc_meta_New();
 335
 336     vlc_meta_Merge( p_i->p_meta, p_new_meta );
 337 }
 338
 339 #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
 340 #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
 341 #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
 342 #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
 343 #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
 344 #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
 345 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
 346 #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
 347 #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
 348 #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
 349 #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
 350 #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
 351 #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
 352 #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
 353 #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
 354 #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
 355 #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
 356
 357 #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
 358 #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
 359 #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
 360 #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
 361 #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
 362 #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
 363 #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
 364 #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
 365 #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
 366 #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
 367 #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
 368 #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
 369 #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
 370 #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
 371 #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
 372 #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
 373 #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
 374 #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
 375
 376 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 377 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
 378
 379 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
 380 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
 381 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
 382 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
 383
 384 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
 385
 386 /*****************************************************************************
 387  * Meta data helpers
 388  *****************************************************************************/
 389 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
 390                                                         const vlc_meta_t *p_meta )
 391 {
 392     char * psz_value;
 393
 394     if( !p_meta )
 395         return;
 396
 397     if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
 398         (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
 399     {
 400         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 401         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 402     }
 403     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
 404              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
 405     {
 406         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 407         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 408     }
 409     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
 410              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
 411     {
 412         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 413         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 414     }
 415     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
 416     {
 417         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 418         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 419     }
 420 }
 421
 422 /*****************************************************************************
 423  * Seek point: (generalisation of chapters)
 424  *****************************************************************************/
 425 struct seekpoint_t
 426 {
 427     int64_t i_byte_offset;
 428     int64_t i_time_offset;
 429     char    *psz_name;
 430     int     i_level;
 431 };
 432
 433 static inline seekpoint_t *vlc_seekpoint_New( void )
 434 {
 435     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 436     point->i_byte_offset =
 437     point->i_time_offset = -1;
 438     point->i_level = 0;
 439     point->psz_name = NULL;
 440     return point;
 441 }
 442
 443 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 444 {
 445     if( !point ) return;
 446     if( point->psz_name ) free( point->psz_name );
 447     free( point );
 448 }
 449
 450 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 451 {
 452     seekpoint_t *point = vlc_seekpoint_New();
 453     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 454     point->i_time_offset = src->i_time_offset;
 455     point->i_byte_offset = src->i_byte_offset;
 456     return point;
 457 }
 458
 459 /*****************************************************************************
 460  * Title:
 461  *****************************************************************************/
 462 typedef struct
 463 {
 464     char        *psz_name;
 465
 466     vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
 467
 468     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 469     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 470
 471     /* Title seekpoint */
 472     int         i_seekpoint;
 473     seekpoint_t **seekpoint;
 474
 475 } input_title_t;
 476
 477 static inline input_title_t *vlc_input_title_New(void)
 478 {
 479     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 480
 481     t->psz_name = NULL;
 482     t->b_menu = VLC_FALSE;
 483     t->i_length = 0;
 484     t->i_size   = 0;
 485     t->i_seekpoint = 0;
 486     t->seekpoint = NULL;
 487
 488     return t;
 489 }
 490
 491 static inline void vlc_input_title_Delete( input_title_t *t )
 492 {
 493     int i;
 494     if( t == NULL )
 495         return;
 496
 497     if( t->psz_name ) free( t->psz_name );
 498     for( i = 0; i < t->i_seekpoint; i++ )
 499     {
 500         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 501         free( t->seekpoint[i] );
 502     }
 503     if( t->seekpoint ) free( t->seekpoint );
 504     free( t );
 505 }
 506
 507 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 508 {
 509     input_title_t *dup = vlc_input_title_New( );
 510     int i;
 511
 512     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 513     dup->b_menu      = t->b_menu;
 514     dup->i_length    = t->i_length;
 515     dup->i_size      = t->i_size;
 516     dup->i_seekpoint = t->i_seekpoint;
 517     if( t->i_seekpoint > 0 )
 518     {
 519         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 520                                                 sizeof(seekpoint_t*) );
 521
 522         for( i = 0; i < t->i_seekpoint; i++ )
 523         {
 524             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 525         }
 526     }
 527
 528     return dup;
 529 }
 530 /*****************************************************************************
 531  * Attachments
 532  *****************************************************************************/
 533 struct input_attachment_t
 534 {
 535     char *psz_name;
 536     char *psz_mime;
 537     char *psz_description;
 538
 539     int  i_data;
 540     void *p_data;
 541 };
 542 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 543                                                             const char *psz_mime,
 544                                                             const char *psz_description,
 545                                                             const void *p_data,
 546                                                             int i_data )
 547 {
 548     input_attachment_t *a =
 549         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
 550     if( !a )
 551         return NULL;
 552     a->psz_name = strdup( psz_name ? psz_name : "" );
 553     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 554     a->psz_description = strdup( psz_description ? psz_description : "" );
 555     a->i_data = i_data;
 556     a->p_data = NULL;
 557     if( i_data > 0 )
 558     {
 559         a->p_data = malloc( i_data );
 560         if( a->p_data && p_data )
 561             memcpy( a->p_data, p_data, i_data );
 562     }
 563     return a;
 564 }
 565 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 566 {
 567     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 568                                      a->p_data, a->i_data );
 569 }
 570 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 571 {
 572     if( !a )
 573         return;
 574     free( a->psz_name );
 575     free( a->psz_mime );
 576     free( a->psz_description );
 577     if( a->p_data )
 578         free( a->p_data );
 579     free( a );
 580 }
 581 /*****************************************************************************
 582  * input defines/constants.
 583  *****************************************************************************/
 584
 585 /* "state" value */
 586 enum input_state_e
 587 {
 588     INIT_S,
 589     OPENING_S,
 590     BUFFERING_S,
 591     PLAYING_S,
 592     PAUSE_S,
 593     END_S,
 594     ERROR_S
 595 };
 596
 597 /* "rate" default, min/max
 598  * A rate below 1000 plays the movie faster,
 599  * A rate above 1000 plays the movie slower.
 600  */
 601 #define INPUT_RATE_DEFAULT  1000
 602 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 603 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 604
 605 /* i_update field of access_t/demux_t */
 606 #define INPUT_UPDATE_NONE       0x0000
 607 #define INPUT_UPDATE_SIZE       0x0001
 608 #define INPUT_UPDATE_TITLE      0x0010
 609 #define INPUT_UPDATE_SEEKPOINT  0x0020
 610 #define INPUT_UPDATE_META       0x0040
 611
 612 /* Input control XXX: internal */
 613 #define INPUT_CONTROL_FIFO_SIZE    100
 614
 615 /** Get the input item for an input thread */
 616 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 617
 618 typedef struct input_thread_private_t input_thread_private_t;
 619
 620 /**
 621  * Main structure representing an input thread. This structure is mostly
 622  * private. The only public fields are READ-ONLY. You must use the helpers
 623  * to modify them
 624  */
 625 struct input_thread_t
 626 {
 627     VLC_COMMON_MEMBERS;
 628
 629     vlc_bool_t  b_eof;
 630     vlc_bool_t b_preparsing;
 631
 632     int i_state;
 633     vlc_bool_t b_can_pace_control;
 634     int64_t     i_time;     /* Current time */
 635
 636     /* Internal caching common to all inputs */
 637     int i_pts_delay;
 638
 639     /* All other data is input_thread is PRIVATE. You can't access it
 640      * outside of src/input */
 641     input_thread_private_t *p;
 642 };
 643
 644 /*****************************************************************************
 645  * Prototypes
 646  *****************************************************************************/
 647 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 648 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 649 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 650 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 651
 652 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 653 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 654 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 655 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 656
 657 enum input_query_e
 658 {
 659     /* input variable "position" */
 660     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 661     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 662
 663     /* input variable "length" */
 664     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 665
 666     /* input variable "time" */
 667     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 668     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 669
 670     /* input variable "rate" (1 is DEFAULT_RATE) */
 671     INPUT_GET_RATE,             /* arg1= int *          res=    */
 672     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 673
 674     /* input variable "state" */
 675     INPUT_GET_STATE,            /* arg1= int *          res=    */
 676     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 677
 678     /* input variable "audio-delay" and "sub-delay" */
 679     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 680     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 681     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 682     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 683
 684     /* Meta datas */
 685     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 686     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 687     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 688     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 689
 690     /* Input config options */
 691     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 692
 693     /* Input properties */
 694     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 695     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 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