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