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     int        i_id;                 /**< Identifier of the item */
  61
  62     char       *psz_name;            /**< text describing this item */
  63     char       *psz_uri;             /**< mrl of this item */
  64
  65     int        i_options;            /**< Number of input options */
  66     char       **ppsz_options;       /**< Array of input options */
  67     uint8_t    *optflagv;            /**< Some flags of input options */
  68     unsigned   optflagc;
  69     input_item_opaque_t *opaques;    /**< List of opaque pointer values */
  70
  71     mtime_t    i_duration;           /**< Duration in microseconds */
  72
  73
  74     int        i_categories;         /**< Number of info categories */
  75     info_category_t **pp_categories; /**< Pointer to the first info category */
  76
  77     int         i_es;                /**< Number of es format descriptions */
  78     es_format_t **es;                /**< Es formats */
  79
  80     input_stats_t *p_stats;          /**< Statistics */
  81
  82     vlc_meta_t *p_meta;
  83
  84     int         i_epg;               /**< Number of EPG entries */
  85     vlc_epg_t   **pp_epg;            /**< EPG entries */
  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 TYPEDEF_ARRAY(input_item_t*, input_item_array_t)
 108
 109 enum input_item_type_e
 110 {
 111     ITEM_TYPE_UNKNOWN,
 112     ITEM_TYPE_FILE,
 113     ITEM_TYPE_DIRECTORY,
 114     ITEM_TYPE_DISC,
 115     ITEM_TYPE_CARD,
 116     ITEM_TYPE_STREAM,
 117     ITEM_TYPE_PLAYLIST,
 118     ITEM_TYPE_NODE,
 119
 120     /* This one is not a real type but the number of input_item types. */
 121     ITEM_TYPE_NUMBER
 122 };
 123
 124 enum input_item_net_type
 125 {
 126     ITEM_NET_UNKNOWN,
 127     ITEM_NET,
 128     ITEM_LOCAL
 129 };
 130
 131 enum slave_type
 132 {
 133     SLAVE_TYPE_SPU,
 134     SLAVE_TYPE_AUDIO,
 135 };
 136
 137 enum slave_priority
 138 {
 139     SLAVE_PRIORITY_MATCH_NONE = 1,
 140     SLAVE_PRIORITY_MATCH_RIGHT,
 141     SLAVE_PRIORITY_MATCH_LEFT,
 142     SLAVE_PRIORITY_MATCH_ALL,
 143     SLAVE_PRIORITY_USER
 144 };
 145
 146 #define SLAVE_SPU_EXTENSIONS \
 147     "idx", "sub",  "srt", \
 148     "ssa", "ass",  "smi", \
 149     "utf", "utf8", "utf-8", \
 150     "rt",   "aqt", "txt", \
 151     "usf", "jss",  "cdg", \
 152     "psb", "mpsub","mpl2", \
 153     "pjs", "dks", "stl", \
 154     "vtt", "sbv"
 155 #define SLAVE_AUDIO_EXTENSIONS \
 156     "ac3", "m4a", "aac", \
 157     "eac3",  "dtshd", "flac", \
 158     "pcm", "dts"
 159
 160 struct input_item_slave
 161 {
 162     enum slave_type     i_type;     /**< Slave type (spu, audio) */
 163     enum slave_priority i_priority; /**< Slave priority */
 164     bool                b_forced;   /**< Slave should be selected */
 165     char                psz_uri[];  /**< Slave mrl */
 166 };
 167
 168 typedef int (*input_item_compar_cb)( input_item_t *, input_item_t * );
 169
 170 struct input_item_node_t
 171 {
 172     input_item_t *         p_item;
 173     int                    i_children;
 174     input_item_node_t      **pp_children;
 175     input_item_node_t      *p_parent;
 176     input_item_compar_cb   compar_cb;
 177     bool                   b_can_loop;
 178 };
 179
 180 VLC_API void input_item_CopyOptions( input_item_t *p_child, input_item_t *p_parent );
 181 VLC_API void input_item_SetName( input_item_t *p_item, const char *psz_name );
 182
 183 /**
 184  * Add one subitem to this item
 185  *
 186  * This won't hold the item, but can tell to interested third parties
 187  * Like the playlist, that there is a new sub item. With this design
 188  * It is not the input item's responsibility to keep all the ref of
 189  * the input item children.
 190  *
 191  * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
 192  */
 193 VLC_API void input_item_PostSubItem( input_item_t *p_parent, input_item_t *p_child );
 194
 195 /**
 196  * Start adding multiple subitems.
 197  *
 198  * Create a root node to hold a tree of subitems for given item
 199  */
 200 VLC_API input_item_node_t * input_item_node_Create( input_item_t *p_input ) VLC_USED;
 201
 202 /**
 203  * Add a new child node to this parent node that will point to this subitem.
 204  */
 205 VLC_API input_item_node_t * input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item );
 206
 207 /**
 208  * Add an already created node to children of this parent node.
 209  */
 210 VLC_API void input_item_node_AppendNode( input_item_node_t *p_parent, input_item_node_t *p_child );
 211
 212 /**
 213  * Sort all p_item children of the node recursively.
 214  */
 215 VLC_API void input_item_node_Sort( input_item_node_t *p_node,
 216                                    input_item_compar_cb compar_cb );
 217
 218 /**
 219  * Delete a node created with input_item_node_Create() and all its children.
 220  */
 221 VLC_API void input_item_node_Delete( input_item_node_t *p_node );
 222
 223 /**
 224  * End adding multiple subitems.
 225  *
 226  * Sends a vlc_InputItemSubItemTreeAdded event to notify that the item pointed to
 227  * by the given root node has created new subitems that are pointed to by all the
 228  * children of the node.
 229  *
 230  * Also sends vlc_InputItemSubItemAdded event for every child under the given root node;
 231  *
 232  * In the end deletes the node and all its children nodes.
 233  */
 234 VLC_API void input_item_node_PostAndDelete( input_item_node_t *p_node );
 235
 236
 237 /**
 238  * Option flags
 239  */
 240 enum input_item_option_e
 241 {
 242     /* Allow VLC to trust the given option.
 243      * By default options are untrusted */
 244     VLC_INPUT_OPTION_TRUSTED = 0x2,
 245
 246     /* Add the option, unless the same option
 247      * is already present. */
 248     VLC_INPUT_OPTION_UNIQUE  = 0x100,
 249 };
 250
 251 /**
 252  * This function allows to add an option to an existing input_item_t.
 253  */
 254 VLC_API int input_item_AddOption(input_item_t *, const char *, unsigned i_flags );
 255 /**
 256  * This function add several options to an existing input_item_t.
 257  */
 258 VLC_API int input_item_AddOptions(input_item_t *, int i_options,
 259                                   const char *const *ppsz_options,
 260                                   unsigned i_flags );
 261 VLC_API int input_item_AddOpaque(input_item_t *, const char *, void *);
 262
 263 void input_item_ApplyOptions(vlc_object_t *, input_item_t *);
 264
 265 VLC_API bool input_item_slave_GetType(const char *, enum slave_type *);
 266
 267 VLC_API input_item_slave_t *input_item_slave_New(const char *, enum slave_type,
 268                                                enum slave_priority);
 269 #define input_item_slave_Delete(p_slave) free(p_slave)
 270
 271 /**
 272  * This function allows adding a slave to an existing input item.
 273  * The slave is owned by the input item after this call.
 274  */
 275 VLC_API int input_item_AddSlave(input_item_t *, input_item_slave_t *);
 276
 277 /* */
 278 VLC_API bool input_item_HasErrorWhenReading( input_item_t * );
 279 VLC_API void input_item_SetMeta( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val );
 280 VLC_API bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz );
 281 VLC_API char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type ) VLC_USED;
 282 VLC_API char * input_item_GetName( input_item_t * p_i ) VLC_USED;
 283 VLC_API char * input_item_GetTitleFbName( input_item_t * p_i ) VLC_USED;
 284 VLC_API char * input_item_GetURI( input_item_t * p_i ) VLC_USED;
 285 VLC_API char * input_item_GetNowPlayingFb( input_item_t *p_item ) VLC_USED;
 286 VLC_API void input_item_SetURI( input_item_t * p_i, const char *psz_uri );
 287 VLC_API mtime_t input_item_GetDuration( input_item_t * p_i );
 288 VLC_API void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration );
 289 VLC_API bool input_item_IsPreparsed( input_item_t *p_i );
 290 VLC_API bool input_item_IsArtFetched( input_item_t *p_i );
 291
 292 #define INPUT_META( name ) \
 293 static inline \
 294 void input_item_Set ## name (input_item_t *p_input, const char *val) \
 295 { \
 296     input_item_SetMeta (p_input, vlc_meta_ ## name, val); \
 297 } \
 298 static inline \
 299 char *input_item_Get ## name (input_item_t *p_input) \
 300 { \
 301     return input_item_GetMeta (p_input, vlc_meta_ ## name); \
 302 }
 303
 304 INPUT_META(Title)
 305 INPUT_META(Artist)
 306 INPUT_META(AlbumArtist)
 307 INPUT_META(Genre)
 308 INPUT_META(Copyright)
 309 INPUT_META(Album)
 310 INPUT_META(TrackNumber)
 311 INPUT_META(Description)
 312 INPUT_META(Rating)
 313 INPUT_META(Date)
 314 INPUT_META(Setting)
 315 INPUT_META(URL)
 316 INPUT_META(Language)
 317 INPUT_META(NowPlaying)
 318 INPUT_META(ESNowPlaying)
 319 INPUT_META(Publisher)
 320 INPUT_META(EncodedBy)
 321 INPUT_META(ArtworkURL)
 322 INPUT_META(TrackID)
 323 INPUT_META(TrackTotal)
 324 INPUT_META(Director)
 325 INPUT_META(Season)
 326 INPUT_META(Episode)
 327 INPUT_META(ShowName)
 328 INPUT_META(Actors)
 329 INPUT_META(DiscNumber)
 330
 331 #define input_item_SetTrackNum input_item_SetTrackNumber
 332 #define input_item_GetTrackNum input_item_GetTrackNumber
 333 #define input_item_SetArtURL   input_item_SetArtworkURL
 334 #define input_item_GetArtURL   input_item_GetArtworkURL
 335
 336 VLC_API char * input_item_GetInfo( input_item_t *p_i, const char *psz_cat,const char *psz_name ) VLC_USED;
 337 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 );
 338 VLC_API int input_item_DelInfo( input_item_t *p_i, const char *psz_cat, const char *psz_name );
 339 VLC_API void input_item_ReplaceInfos( input_item_t *, info_category_t * );
 340 VLC_API void input_item_MergeInfos( input_item_t *, info_category_t * );
 341
 342 /**
 343  * This function creates a new input_item_t with the provided information.
 344  *
 345  * XXX You may also use input_item_New, as they need less arguments.
 346  */
 347 VLC_API input_item_t * input_item_NewExt( const char *psz_uri,
 348                                           const char *psz_name,
 349                                           mtime_t i_duration, int i_type,
 350                                           enum input_item_net_type i_net ) VLC_USED;
 351
 352 #define input_item_New( psz_uri, psz_name ) \
 353     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_UNKNOWN, ITEM_NET_UNKNOWN )
 354
 355 #define input_item_NewCard( psz_uri, psz_name ) \
 356     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_CARD, ITEM_LOCAL )
 357
 358 #define input_item_NewDisc( psz_uri, psz_name, i_duration ) \
 359     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_DISC, ITEM_LOCAL )
 360
 361 #define input_item_NewStream( psz_uri, psz_name, i_duration ) \
 362     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_STREAM, ITEM_NET )
 363
 364 #define input_item_NewDirectory( psz_uri, psz_name, i_net ) \
 365     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_DIRECTORY, i_net )
 366
 367 #define input_item_NewFile( psz_uri, psz_name, i_duration, i_net ) \
 368     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_FILE, i_net )
 369
 370 /**
 371  * This function creates a new input_item_t as a copy of another.
 372  */
 373 VLC_API input_item_t * input_item_Copy(input_item_t * ) VLC_USED;
 374
 375 /** Holds an input item, i.e. creates a new reference. */
 376 VLC_API input_item_t *input_item_Hold(input_item_t *);
 377
 378 /** Releases an input item, i.e. decrements its reference counter. */
 379 VLC_API void input_item_Release(input_item_t *);
 380
 381 /* Historical hack... */
 382 #define vlc_gc_incref(i) input_item_Hold(i)
 383 #define vlc_gc_decref(i) input_item_Release(i)
 384
 385 typedef enum input_item_meta_request_option_t
 386 {
 387     META_REQUEST_OPTION_NONE          = 0x00,
 388     META_REQUEST_OPTION_SCOPE_LOCAL   = 0x01,
 389     META_REQUEST_OPTION_SCOPE_NETWORK = 0x02,
 390     META_REQUEST_OPTION_SCOPE_ANY     = 0x03,
 391     META_REQUEST_OPTION_DO_INTERACT   = 0x04
 392 } input_item_meta_request_option_t;
 393
 394 /* status of the vlc_InputItemPreparseEnded event */
 395 enum input_item_preparse_status
 396 {
 397     ITEM_PREPARSE_SKIPPED,
 398     ITEM_PREPARSE_FAILED,
 399     ITEM_PREPARSE_TIMEOUT,
 400     ITEM_PREPARSE_DONE
 401 };
 402
 403 VLC_API int libvlc_MetadataRequest( libvlc_int_t *, input_item_t *,
 404                                     input_item_meta_request_option_t,
 405                                     int, void * );
 406 VLC_API int libvlc_ArtRequest(libvlc_int_t *, input_item_t *,
 407                               input_item_meta_request_option_t );
 408 VLC_API void libvlc_MetadataCancel( libvlc_int_t *, void * );
 409
 410 /******************
 411  * Input stats
 412  ******************/
 413 struct input_stats_t
 414 {
 415     vlc_mutex_t         lock;
 416
 417     /* Input */
 418     int64_t i_read_packets;
 419     int64_t i_read_bytes;
 420     float f_input_bitrate;
 421     float f_average_input_bitrate;
 422
 423     /* Demux */
 424     int64_t i_demux_read_packets;
 425     int64_t i_demux_read_bytes;
 426     float f_demux_bitrate;
 427     float f_average_demux_bitrate;
 428     int64_t i_demux_corrupted;
 429     int64_t i_demux_discontinuity;
 430
 431     /* Decoders */
 432     int64_t i_decoded_audio;
 433     int64_t i_decoded_video;
 434
 435     /* Vout */
 436     int64_t i_displayed_pictures;
 437     int64_t i_lost_pictures;
 438
 439     /* Sout */
 440     int64_t i_sent_packets;
 441     int64_t i_sent_bytes;
 442     float f_send_bitrate;
 443
 444     /* Aout */
 445     int64_t i_played_abuffers;
 446     int64_t i_lost_abuffers;
 447 };
 448
 449 #endif