include/vlc_input_item.h

   1 /*****************************************************************************
   2  * vlc_input_item.h: Core input item
   3  *****************************************************************************
   4  * Copyright (C) 1999-2009 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef VLC_INPUT_ITEM_H
  26 #define VLC_INPUT_ITEM_H 1
  27
  28 /**
  29  * \file
  30  * This file defines functions, structures and enums for input items in vlc
  31  */
  32
  33 #include <vlc_meta.h>
  34 #include <vlc_epg.h>
  35 #include <vlc_events.h>
  36
  37 #include <string.h>
  38
  39 typedef struct input_item_opaque input_item_opaque_t;
  40 typedef struct input_item_slave input_item_slave_t;
  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 /**
  56  * Describes an input and is used to spawn input_thread_t objects.
  57  */
  58 struct input_item_t
  59 {
  60     char       *psz_name;            /**< text describing this item */
  61     char       *psz_uri;             /**< mrl of this item */
  62
  63     int        i_options;            /**< Number of input options */
  64     char       **ppsz_options;       /**< Array of input options */
  65     uint8_t    *optflagv;            /**< Some flags of input options */
  66     unsigned   optflagc;
  67     input_item_opaque_t *opaques;    /**< List of opaque pointer values */
  68
  69     mtime_t    i_duration;           /**< Duration in microseconds */
  70
  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
  80     vlc_meta_t *p_meta;
  81
  82     int         i_epg;               /**< Number of EPG entries */
  83     vlc_epg_t   **pp_epg;            /**< EPG entries */
  84     int64_t     i_epg_time;          /** EPG timedate as epoch time */
  85     const vlc_epg_t *p_epg_table;    /** running/selected program cur/next EPG table */
  86
  87     int         i_slaves;            /**< Number of slaves */
  88     input_item_slave_t **pp_slaves;  /**< Slave entries that will be loaded by
  89                                           the input_thread */
  90
  91     vlc_event_manager_t event_manager;
  92
  93     vlc_mutex_t lock;                 /**< Lock for the item */
  94
  95     uint8_t     i_type;              /**< Type (file, disc, ... see input_item_type_e) */
  96     bool        b_net;               /**< Net: always true for TYPE_STREAM, it
  97                                           depends for others types */
  98     bool        b_error_when_reading;/**< Error When Reading */
  99
 100     int         i_preparse_depth;    /**< How many level of sub items can be preparsed:
 101                                           -1: recursive, 0: none, >0: n levels */
 102
 103     bool        b_preparse_interact; /**< Force interaction with the user when
 104                                           preparsing.*/
 105 };
 106
 107 enum input_item_type_e
 108 {
 109     ITEM_TYPE_UNKNOWN,
 110     ITEM_TYPE_FILE,
 111     ITEM_TYPE_DIRECTORY,
 112     ITEM_TYPE_DISC,
 113     ITEM_TYPE_CARD,
 114     ITEM_TYPE_STREAM,
 115     ITEM_TYPE_PLAYLIST,
 116     ITEM_TYPE_NODE,
 117
 118     /* This one is not a real type but the number of input_item types. */
 119     ITEM_TYPE_NUMBER
 120 };
 121
 122 enum input_item_net_type
 123 {
 124     ITEM_NET_UNKNOWN,
 125     ITEM_NET,
 126     ITEM_LOCAL
 127 };
 128
 129 enum slave_type
 130 {
 131     SLAVE_TYPE_SPU,
 132     SLAVE_TYPE_AUDIO,
 133 };
 134
 135 enum slave_priority
 136 {
 137     SLAVE_PRIORITY_MATCH_NONE = 1,
 138     SLAVE_PRIORITY_MATCH_RIGHT,
 139     SLAVE_PRIORITY_MATCH_LEFT,
 140     SLAVE_PRIORITY_MATCH_ALL,
 141     SLAVE_PRIORITY_USER
 142 };
 143
 144 #define SLAVE_SPU_EXTENSIONS \
 145     "idx", "sub",  "srt", \
 146     "ssa", "ass",  "smi", \
 147     "utf", "utf8", "utf-8", \
 148     "rt",   "aqt", "txt", \
 149     "usf", "jss",  "cdg", \
 150     "psb", "mpsub","mpl2", \
 151     "pjs", "dks", "stl", \
 152     "vtt", "sbv", "ttml"
 153 #define SLAVE_AUDIO_EXTENSIONS \
 154     "ac3", "m4a", "aac", \
 155     "eac3",  "dtshd", "flac", \
 156     "pcm", "dts"
 157
 158 struct input_item_slave
 159 {
 160     enum slave_type     i_type;     /**< Slave type (spu, audio) */
 161     enum slave_priority i_priority; /**< Slave priority */
 162     bool                b_forced;   /**< Slave should be selected */
 163     char                psz_uri[];  /**< Slave mrl */
 164 };
 165
 166 struct input_item_node_t
 167 {
 168     input_item_t *         p_item;
 169     int                    i_children;
 170     input_item_node_t      **pp_children;
 171     input_item_node_t      *p_parent;
 172 };
 173
 174 VLC_API void input_item_CopyOptions( input_item_t *p_child, input_item_t *p_parent );
 175 VLC_API void input_item_SetName( input_item_t *p_item, const char *psz_name );
 176
 177 /**
 178  * Add one subitem to this item
 179  *
 180  * This won't hold the item, but can tell to interested third parties
 181  * Like the playlist, that there is a new sub item. With this design
 182  * It is not the input item's responsibility to keep all the ref of
 183  * the input item children.
 184  *
 185  * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
 186  */
 187 VLC_API void input_item_PostSubItem( input_item_t *p_parent, input_item_t *p_child );
 188
 189 /**
 190  * Start adding multiple subitems.
 191  *
 192  * Create a root node to hold a tree of subitems for given item
 193  */
 194 VLC_API input_item_node_t * input_item_node_Create( input_item_t *p_input ) VLC_USED;
 195
 196 /**
 197  * Add a new child node to this parent node that will point to this subitem.
 198  */
 199 VLC_API input_item_node_t * input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item );
 200
 201 /**
 202  * Add an already created node to children of this parent node.
 203  */
 204 VLC_API void input_item_node_AppendNode( input_item_node_t *p_parent, input_item_node_t *p_child );
 205
 206 /**
 207  * Delete a node created with input_item_node_Create() and all its children.
 208  */
 209 VLC_API void input_item_node_Delete( input_item_node_t *p_node );
 210
 211 /**
 212  * End adding multiple subitems.
 213  *
 214  * Sends a vlc_InputItemSubItemTreeAdded event to notify that the item pointed to
 215  * by the given root node has created new subitems that are pointed to by all the
 216  * children of the node.
 217  *
 218  * Also sends vlc_InputItemSubItemAdded event for every child under the given root node;
 219  *
 220  * In the end deletes the node and all its children nodes.
 221  */
 222 VLC_API void input_item_node_PostAndDelete( input_item_node_t *p_node );
 223
 224
 225 /**
 226  * Option flags
 227  */
 228 enum input_item_option_e
 229 {
 230     /* Allow VLC to trust the given option.
 231      * By default options are untrusted */
 232     VLC_INPUT_OPTION_TRUSTED = 0x2,
 233
 234     /* Add the option, unless the same option
 235      * is already present. */
 236     VLC_INPUT_OPTION_UNIQUE  = 0x100,
 237 };
 238
 239 /**
 240  * This function allows to add an option to an existing input_item_t.
 241  */
 242 VLC_API int input_item_AddOption(input_item_t *, const char *, unsigned i_flags );
 243 /**
 244  * This function add several options to an existing input_item_t.
 245  */
 246 VLC_API int input_item_AddOptions(input_item_t *, int i_options,
 247                                   const char *const *ppsz_options,
 248                                   unsigned i_flags );
 249 VLC_API int input_item_AddOpaque(input_item_t *, const char *, void *);
 250
 251 void input_item_ApplyOptions(vlc_object_t *, input_item_t *);
 252
 253 VLC_API bool input_item_slave_GetType(const char *, enum slave_type *);
 254
 255 VLC_API input_item_slave_t *input_item_slave_New(const char *, enum slave_type,
 256                                                enum slave_priority);
 257 #define input_item_slave_Delete(p_slave) free(p_slave)
 258
 259 /**
 260  * This function allows adding a slave to an existing input item.
 261  * The slave is owned by the input item after this call.
 262  */
 263 VLC_API int input_item_AddSlave(input_item_t *, input_item_slave_t *);
 264
 265 /* */
 266 VLC_API bool input_item_HasErrorWhenReading( input_item_t * );
 267 VLC_API void input_item_SetMeta( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val );
 268 VLC_API bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz );
 269 VLC_API char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type ) VLC_USED;
 270 VLC_API char * input_item_GetName( input_item_t * p_i ) VLC_USED;
 271 VLC_API char * input_item_GetTitleFbName( input_item_t * p_i ) VLC_USED;
 272 VLC_API char * input_item_GetURI( input_item_t * p_i ) VLC_USED;
 273 VLC_API char * input_item_GetNowPlayingFb( input_item_t *p_item ) VLC_USED;
 274 VLC_API void input_item_SetURI( input_item_t * p_i, const char *psz_uri );
 275 VLC_API mtime_t input_item_GetDuration( input_item_t * p_i );
 276 VLC_API void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration );
 277 VLC_API bool input_item_IsPreparsed( input_item_t *p_i );
 278 VLC_API bool input_item_IsArtFetched( input_item_t *p_i );
 279
 280 #define INPUT_META( name ) \
 281 static inline \
 282 void input_item_Set ## name (input_item_t *p_input, const char *val) \
 283 { \
 284     input_item_SetMeta (p_input, vlc_meta_ ## name, val); \
 285 } \
 286 static inline \
 287 char *input_item_Get ## name (input_item_t *p_input) \
 288 { \
 289     return input_item_GetMeta (p_input, vlc_meta_ ## name); \
 290 }
 291
 292 INPUT_META(Title)
 293 INPUT_META(Artist)
 294 INPUT_META(AlbumArtist)
 295 INPUT_META(Genre)
 296 INPUT_META(Copyright)
 297 INPUT_META(Album)
 298 INPUT_META(TrackNumber)
 299 INPUT_META(Description)
 300 INPUT_META(Rating)
 301 INPUT_META(Date)
 302 INPUT_META(Setting)
 303 INPUT_META(URL)
 304 INPUT_META(Language)
 305 INPUT_META(NowPlaying)
 306 INPUT_META(ESNowPlaying)
 307 INPUT_META(Publisher)
 308 INPUT_META(EncodedBy)
 309 INPUT_META(ArtworkURL)
 310 INPUT_META(TrackID)
 311 INPUT_META(TrackTotal)
 312 INPUT_META(Director)
 313 INPUT_META(Season)
 314 INPUT_META(Episode)
 315 INPUT_META(ShowName)
 316 INPUT_META(Actors)
 317 INPUT_META(DiscNumber)
 318
 319 #define input_item_SetTrackNum input_item_SetTrackNumber
 320 #define input_item_GetTrackNum input_item_GetTrackNumber
 321 #define input_item_SetArtURL   input_item_SetArtworkURL
 322 #define input_item_GetArtURL   input_item_GetArtworkURL
 323
 324 VLC_API char * input_item_GetInfo( input_item_t *p_i, const char *psz_cat,const char *psz_name ) VLC_USED;
 325 VLC_API int input_item_AddInfo( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) VLC_FORMAT( 4, 5 );
 326 VLC_API int input_item_DelInfo( input_item_t *p_i, const char *psz_cat, const char *psz_name );
 327 VLC_API void input_item_ReplaceInfos( input_item_t *, info_category_t * );
 328 VLC_API void input_item_MergeInfos( input_item_t *, info_category_t * );
 329
 330 /**
 331  * This function creates a new input_item_t with the provided information.
 332  *
 333  * XXX You may also use input_item_New, as they need less arguments.
 334  */
 335 VLC_API input_item_t * input_item_NewExt( const char *psz_uri,
 336                                           const char *psz_name,
 337                                           mtime_t i_duration, int i_type,
 338                                           enum input_item_net_type i_net ) VLC_USED;
 339
 340 #define input_item_New( psz_uri, psz_name ) \
 341     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_UNKNOWN, ITEM_NET_UNKNOWN )
 342
 343 #define input_item_NewCard( psz_uri, psz_name ) \
 344     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_CARD, ITEM_LOCAL )
 345
 346 #define input_item_NewDisc( psz_uri, psz_name, i_duration ) \
 347     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_DISC, ITEM_LOCAL )
 348
 349 #define input_item_NewStream( psz_uri, psz_name, i_duration ) \
 350     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_STREAM, ITEM_NET )
 351
 352 #define input_item_NewDirectory( psz_uri, psz_name, i_net ) \
 353     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_DIRECTORY, i_net )
 354
 355 #define input_item_NewFile( psz_uri, psz_name, i_duration, i_net ) \
 356     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_FILE, i_net )
 357
 358 /**
 359  * This function creates a new input_item_t as a copy of another.
 360  */
 361 VLC_API input_item_t * input_item_Copy(input_item_t * ) VLC_USED;
 362
 363 /** Holds an input item, i.e. creates a new reference. */
 364 VLC_API input_item_t *input_item_Hold(input_item_t *);
 365
 366 /** Releases an input item, i.e. decrements its reference counter. */
 367 VLC_API void input_item_Release(input_item_t *);
 368
 369 /* Historical hack... */
 370 #define vlc_gc_incref(i) input_item_Hold(i)
 371 #define vlc_gc_decref(i) input_item_Release(i)
 372
 373 typedef enum input_item_meta_request_option_t
 374 {
 375     META_REQUEST_OPTION_NONE          = 0x00,
 376     META_REQUEST_OPTION_SCOPE_LOCAL   = 0x01,
 377     META_REQUEST_OPTION_SCOPE_NETWORK = 0x02,
 378     META_REQUEST_OPTION_SCOPE_ANY     = 0x03,
 379     META_REQUEST_OPTION_DO_INTERACT   = 0x04
 380 } input_item_meta_request_option_t;
 381
 382 /* status of the vlc_InputItemPreparseEnded event */
 383 enum input_item_preparse_status
 384 {
 385     ITEM_PREPARSE_SKIPPED,
 386     ITEM_PREPARSE_FAILED,
 387     ITEM_PREPARSE_TIMEOUT,
 388     ITEM_PREPARSE_DONE
 389 };
 390
 391 VLC_API int libvlc_MetadataRequest( libvlc_int_t *, input_item_t *,
 392                                     input_item_meta_request_option_t,
 393                                     int, void * );
 394 VLC_API int libvlc_ArtRequest(libvlc_int_t *, input_item_t *,
 395                               input_item_meta_request_option_t );
 396 VLC_API void libvlc_MetadataCancel( libvlc_int_t *, void * );
 397
 398 /******************
 399  * Input stats
 400  ******************/
 401 struct input_stats_t
 402 {
 403     vlc_mutex_t         lock;
 404
 405     /* Input */
 406     int64_t i_read_packets;
 407     int64_t i_read_bytes;
 408     float f_input_bitrate;
 409     float f_average_input_bitrate;
 410
 411     /* Demux */
 412     int64_t i_demux_read_packets;
 413     int64_t i_demux_read_bytes;
 414     float f_demux_bitrate;
 415     float f_average_demux_bitrate;
 416     int64_t i_demux_corrupted;
 417     int64_t i_demux_discontinuity;
 418
 419     /* Decoders */
 420     int64_t i_decoded_audio;
 421     int64_t i_decoded_video;
 422
 423     /* Vout */
 424     int64_t i_displayed_pictures;
 425     int64_t i_lost_pictures;
 426
 427     /* Sout */
 428     int64_t i_sent_packets;
 429     int64_t i_sent_bytes;
 430     float f_send_bitrate;
 431
 432     /* Aout */
 433     int64_t i_played_abuffers;
 434     int64_t i_lost_abuffers;
 435 };
 436
 437 #endif