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 VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 189 VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
 190
 191 #define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
 192 #define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
 193 VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
 194 VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
 195
 196 VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
 197
 198 /*****************************************************************************
 199  * Meta data helpers
 200  *****************************************************************************/
 201 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
 202                                                         const vlc_meta_t *p_meta )
 203 {
 204     int i;
 205     if( !p_meta )
 206         return;
 207
 208     for( i = 0; i < p_meta->i_extra; i++ )
 209     {
 210         const char *psz_name = p_meta->ppsz_extra_name[i];
 211         const char *psz_value = p_meta->ppsz_extra_value[i];
 212
 213         if( !strcasecmp( psz_name, "REPLAYGAIN_TRACK_GAIN" ) ||
 214             !strcasecmp( psz_name, "RG_RADIO" ) )
 215         {
 216             p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 217             p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 218         }
 219         else if( !strcasecmp( psz_name, "REPLAYGAIN_TRACK_PEAK" ) ||
 220                  !strcasecmp( psz_name, "RG_PEAK" ) )
 221         {
 222             p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = VLC_TRUE;
 223             p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
 224         }
 225         else if( !strcasecmp( psz_name, "REPLAYGAIN_ALBUM_GAIN" ) ||
 226                  !strcasecmp( psz_name, "RG_AUDIOPHILE" ) )
 227         {
 228             p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 229             p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 230         }
 231         else if( !strcasecmp( psz_name, "REPLAYGAIN_ALBUM_PEAK" ) )
 232         {
 233             p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = VLC_TRUE;
 234             p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
 235         }
 236     }
 237 }
 238
 239 /*****************************************************************************
 240  * Seek point: (generalisation of chapters)
 241  *****************************************************************************/
 242 struct seekpoint_t
 243 {
 244     int64_t i_byte_offset;
 245     int64_t i_time_offset;
 246     char    *psz_name;
 247     int     i_level;
 248 };
 249
 250 static inline seekpoint_t *vlc_seekpoint_New( void )
 251 {
 252     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
 253     point->i_byte_offset =
 254     point->i_time_offset = -1;
 255     point->i_level = 0;
 256     point->psz_name = NULL;
 257     return point;
 258 }
 259
 260 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
 261 {
 262     if( !point ) return;
 263     if( point->psz_name ) free( point->psz_name );
 264     free( point );
 265 }
 266
 267 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
 268 {
 269     seekpoint_t *point = vlc_seekpoint_New();
 270     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
 271     point->i_time_offset = src->i_time_offset;
 272     point->i_byte_offset = src->i_byte_offset;
 273     return point;
 274 }
 275
 276 /*****************************************************************************
 277  * Title:
 278  *****************************************************************************/
 279 typedef struct
 280 {
 281     char        *psz_name;
 282
 283     vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
 284
 285     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
 286     int64_t     i_size;     /* Size (bytes) if known, else 0 */
 287
 288     /* Title seekpoint */
 289     int         i_seekpoint;
 290     seekpoint_t **seekpoint;
 291
 292 } input_title_t;
 293
 294 static inline input_title_t *vlc_input_title_New(void)
 295 {
 296     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 297
 298     t->psz_name = NULL;
 299     t->b_menu = VLC_FALSE;
 300     t->i_length = 0;
 301     t->i_size   = 0;
 302     t->i_seekpoint = 0;
 303     t->seekpoint = NULL;
 304
 305     return t;
 306 }
 307
 308 static inline void vlc_input_title_Delete( input_title_t *t )
 309 {
 310     int i;
 311     if( t == NULL )
 312         return;
 313
 314     if( t->psz_name ) free( t->psz_name );
 315     for( i = 0; i < t->i_seekpoint; i++ )
 316     {
 317         if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
 318         free( t->seekpoint[i] );
 319     }
 320     if( t->seekpoint ) free( t->seekpoint );
 321     free( t );
 322 }
 323
 324 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
 325 {
 326     input_title_t *dup = vlc_input_title_New( );
 327     int i;
 328
 329     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 330     dup->b_menu      = t->b_menu;
 331     dup->i_length    = t->i_length;
 332     dup->i_size      = t->i_size;
 333     dup->i_seekpoint = t->i_seekpoint;
 334     if( t->i_seekpoint > 0 )
 335     {
 336         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
 337                                                 sizeof(seekpoint_t*) );
 338
 339         for( i = 0; i < t->i_seekpoint; i++ )
 340         {
 341             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 342         }
 343     }
 344
 345     return dup;
 346 }
 347 /*****************************************************************************
 348  * Attachments
 349  *****************************************************************************/
 350 struct input_attachment_t
 351 {
 352     char *psz_name;
 353     char *psz_mime;
 354     char *psz_description;
 355
 356     int  i_data;
 357     void *p_data;
 358 };
 359 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 360                                                             const char *psz_mime,
 361                                                             const char *psz_description,
 362                                                             const void *p_data,
 363                                                             int i_data )
 364 {
 365     input_attachment_t *a =
 366         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
 367     if( !a )
 368         return NULL;
 369     a->psz_name = strdup( psz_name ? psz_name : "" );
 370     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 371     a->psz_description = strdup( psz_description ? psz_description : "" );
 372     a->i_data = i_data;
 373     a->p_data = NULL;
 374     if( i_data > 0 )
 375     {
 376         a->p_data = malloc( i_data );
 377         if( a->p_data && p_data )
 378             memcpy( a->p_data, p_data, i_data );
 379     }
 380     return a;
 381 }
 382 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 383 {
 384     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 385                                      a->p_data, a->i_data );
 386 }
 387 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 388 {
 389     if( !a )
 390         return;
 391     free( a->psz_name );
 392     free( a->psz_mime );
 393     free( a->psz_description );
 394     if( a->p_data )
 395         free( a->p_data );
 396     free( a );
 397 }
 398 /*****************************************************************************
 399  * input defines/constants.
 400  *****************************************************************************/
 401
 402 /* "state" value */
 403 enum input_state_e
 404 {
 405     INIT_S,
 406     OPENING_S,
 407     BUFFERING_S,
 408     PLAYING_S,
 409     PAUSE_S,
 410     END_S,
 411     ERROR_S
 412 };
 413
 414 /* "rate" default, min/max
 415  * A rate below 1000 plays the movie faster,
 416  * A rate above 1000 plays the movie slower.
 417  */
 418 #define INPUT_RATE_DEFAULT  1000
 419 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 420 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 421
 422 /* i_update field of access_t/demux_t */
 423 #define INPUT_UPDATE_NONE       0x0000
 424 #define INPUT_UPDATE_SIZE       0x0001
 425 #define INPUT_UPDATE_TITLE      0x0010
 426 #define INPUT_UPDATE_SEEKPOINT  0x0020
 427 #define INPUT_UPDATE_META       0x0040
 428
 429 /* Input control XXX: internal */
 430 #define INPUT_CONTROL_FIFO_SIZE    100
 431
 432 /** Get the input item for an input thread */
 433 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
 434
 435 typedef struct input_thread_private_t input_thread_private_t;
 436
 437 /**
 438  * Main structure representing an input thread. This structure is mostly
 439  * private. The only public fields are READ-ONLY. You must use the helpers
 440  * to modify them
 441  */
 442 struct input_thread_t
 443 {
 444     VLC_COMMON_MEMBERS;
 445
 446     vlc_bool_t  b_eof;
 447     vlc_bool_t b_preparsing;
 448
 449     int i_state;
 450     vlc_bool_t b_can_pace_control;
 451     int64_t     i_time;     /* Current time */
 452
 453     /* Internal caching common to all inputs */
 454     int i_pts_delay;
 455
 456     /* All other data is input_thread is PRIVATE. You can't access it
 457      * outside of src/input */
 458     input_thread_private_t *p;
 459 };
 460
 461 /*****************************************************************************
 462  * Prototypes
 463  *****************************************************************************/
 464 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 465 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
 466 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
 467 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
 468
 469 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
 470 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 471 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 472 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 473
 474 enum input_query_e
 475 {
 476     /* input variable "position" */
 477     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 478     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 479
 480     /* input variable "length" */
 481     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 482
 483     /* input variable "time" */
 484     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 485     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 486
 487     /* input variable "rate" (1 is DEFAULT_RATE) */
 488     INPUT_GET_RATE,             /* arg1= int *          res=    */
 489     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 490
 491     /* input variable "state" */
 492     INPUT_GET_STATE,            /* arg1= int *          res=    */
 493     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 494
 495     /* input variable "audio-delay" and "sub-delay" */
 496     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 497     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 498     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 499     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 500
 501     /* Meta datas */
 502     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 503     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 504     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 505     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 506
 507     /* Input config options */
 508     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
 509
 510     /* Input properties */
 511     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
 512     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
 513
 514     /* bookmarks */
 515     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 516     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 517     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 518     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 519     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 520     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 521
 522     /* Attachments */
 523     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 524     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 525
 526     /* On the fly input slave */
 527     INPUT_ADD_SLAVE        /* arg1= char * */
 528 };
 529
 530 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 531 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 532
 533 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 534 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 535 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 536
 537 VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );
 538
 539 #endif