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 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", "ttml"
 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 struct input_item_node_t
 169 {
 170     input_item_t *         p_item;
 171     int                    i_children;
 172     input_item_node_t      **pp_children;
 173     input_item_node_t      *p_parent;
 174 };
 175
 176 VLC_API void input_item_CopyOptions( input_item_t *p_child, input_item_t *p_parent );
 177 VLC_API void input_item_SetName( input_item_t *p_item, const char *psz_name );
 178
 179 /**
 180  * Add one subitem to this item
 181  *
 182  * This won't hold the item, but can tell to interested third parties
 183  * Like the playlist, that there is a new sub item. With this design
 184  * It is not the input item's responsibility to keep all the ref of
 185  * the input item children.
 186  *
 187  * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
 188  */
 189 VLC_API void input_item_PostSubItem( input_item_t *p_parent, input_item_t *p_child );
 190
 191 /**
 192  * Start adding multiple subitems.
 193  *
 194  * Create a root node to hold a tree of subitems for given item
 195  */
 196 VLC_API input_item_node_t * input_item_node_Create( input_item_t *p_input ) VLC_USED;
 197
 198 /**
 199  * Add a new child node to this parent node that will point to this subitem.
 200  */
 201 VLC_API input_item_node_t * input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item );
 202
 203 /**
 204  * Add an already created node to children of this parent node.
 205  */
 206 VLC_API void input_item_node_AppendNode( input_item_node_t *p_parent, input_item_node_t *p_child );
 207
 208 /**
 209  * Delete a node created with input_item_node_Create() and all its children.
 210  */
 211 VLC_API void input_item_node_Delete( input_item_node_t *p_node );
 212
 213 /**
 214  * End adding multiple subitems.
 215  *
 216  * Sends a vlc_InputItemSubItemTreeAdded event to notify that the item pointed to
 217  * by the given root node has created new subitems that are pointed to by all the
 218  * children of the node.
 219  *
 220  * Also sends vlc_InputItemSubItemAdded event for every child under the given root node;
 221  *
 222  * In the end deletes the node and all its children nodes.
 223  */
 224 VLC_API void input_item_node_PostAndDelete( input_item_node_t *p_node );
 225
 226
 227 /**
 228  * Option flags
 229  */
 230 enum input_item_option_e
 231 {
 232     /* Allow VLC to trust the given option.
 233      * By default options are untrusted */
 234     VLC_INPUT_OPTION_TRUSTED = 0x2,
 235
 236     /* Add the option, unless the same option
 237      * is already present. */
 238     VLC_INPUT_OPTION_UNIQUE  = 0x100,
 239 };
 240
 241 /**
 242  * This function allows to add an option to an existing input_item_t.
 243  */
 244 VLC_API int input_item_AddOption(input_item_t *, const char *, unsigned i_flags );
 245 /**
 246  * This function add several options to an existing input_item_t.
 247  */
 248 VLC_API int input_item_AddOptions(input_item_t *, int i_options,
 249                                   const char *const *ppsz_options,
 250                                   unsigned i_flags );
 251 VLC_API int input_item_AddOpaque(input_item_t *, const char *, void *);
 252
 253 void input_item_ApplyOptions(vlc_object_t *, input_item_t *);
 254
 255 VLC_API bool input_item_slave_GetType(const char *, enum slave_type *);
 256
 257 VLC_API input_item_slave_t *input_item_slave_New(const char *, enum slave_type,
 258                                                enum slave_priority);
 259 #define input_item_slave_Delete(p_slave) free(p_slave)
 260
 261 /**
 262  * This function allows adding a slave to an existing input item.
 263  * The slave is owned by the input item after this call.
 264  */
 265 VLC_API int input_item_AddSlave(input_item_t *, input_item_slave_t *);
 266
 267 /* */
 268 VLC_API bool input_item_HasErrorWhenReading( input_item_t * );
 269 VLC_API void input_item_SetMeta( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val );
 270 VLC_API bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz );
 271 VLC_API char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type ) VLC_USED;
 272 VLC_API char * input_item_GetName( input_item_t * p_i ) VLC_USED;
 273 VLC_API char * input_item_GetTitleFbName( input_item_t * p_i ) VLC_USED;
 274 VLC_API char * input_item_GetURI( input_item_t * p_i ) VLC_USED;
 275 VLC_API char * input_item_GetNowPlayingFb( input_item_t *p_item ) VLC_USED;
 276 VLC_API void input_item_SetURI( input_item_t * p_i, const char *psz_uri );
 277 VLC_API mtime_t input_item_GetDuration( input_item_t * p_i );
 278 VLC_API void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration );
 279 VLC_API bool input_item_IsPreparsed( input_item_t *p_i );
 280 VLC_API bool input_item_IsArtFetched( input_item_t *p_i );
 281
 282 #define INPUT_META( name ) \
 283 static inline \
 284 void input_item_Set ## name (input_item_t *p_input, const char *val) \
 285 { \
 286     input_item_SetMeta (p_input, vlc_meta_ ## name, val); \
 287 } \
 288 static inline \
 289 char *input_item_Get ## name (input_item_t *p_input) \
 290 { \
 291     return input_item_GetMeta (p_input, vlc_meta_ ## name); \
 292 }
 293
 294 INPUT_META(Title)
 295 INPUT_META(Artist)
 296 INPUT_META(AlbumArtist)
 297 INPUT_META(Genre)
 298 INPUT_META(Copyright)
 299 INPUT_META(Album)
 300 INPUT_META(TrackNumber)
 301 INPUT_META(Description)
 302 INPUT_META(Rating)
 303 INPUT_META(Date)
 304 INPUT_META(Setting)
 305 INPUT_META(URL)
 306 INPUT_META(Language)
 307 INPUT_META(NowPlaying)
 308 INPUT_META(ESNowPlaying)
 309 INPUT_META(Publisher)
 310 INPUT_META(EncodedBy)
 311 INPUT_META(ArtworkURL)
 312 INPUT_META(TrackID)
 313 INPUT_META(TrackTotal)
 314 INPUT_META(Director)
 315 INPUT_META(Season)
 316 INPUT_META(Episode)
 317 INPUT_META(ShowName)
 318 INPUT_META(Actors)
 319 INPUT_META(DiscNumber)
 320
 321 #define input_item_SetTrackNum input_item_SetTrackNumber
 322 #define input_item_GetTrackNum input_item_GetTrackNumber
 323 #define input_item_SetArtURL   input_item_SetArtworkURL
 324 #define input_item_GetArtURL   input_item_GetArtworkURL
 325
 326 VLC_API char * input_item_GetInfo( input_item_t *p_i, const char *psz_cat,const char *psz_name ) VLC_USED;
 327 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 );
 328 VLC_API int input_item_DelInfo( input_item_t *p_i, const char *psz_cat, const char *psz_name );
 329 VLC_API void input_item_ReplaceInfos( input_item_t *, info_category_t * );
 330 VLC_API void input_item_MergeInfos( input_item_t *, info_category_t * );
 331
 332 /**
 333  * This function creates a new input_item_t with the provided information.
 334  *
 335  * XXX You may also use input_item_New, as they need less arguments.
 336  */
 337 VLC_API input_item_t * input_item_NewExt( const char *psz_uri,
 338                                           const char *psz_name,
 339                                           mtime_t i_duration, int i_type,
 340                                           enum input_item_net_type i_net ) VLC_USED;
 341
 342 #define input_item_New( psz_uri, psz_name ) \
 343     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_UNKNOWN, ITEM_NET_UNKNOWN )
 344
 345 #define input_item_NewCard( psz_uri, psz_name ) \
 346     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_CARD, ITEM_LOCAL )
 347
 348 #define input_item_NewDisc( psz_uri, psz_name, i_duration ) \
 349     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_DISC, ITEM_LOCAL )
 350
 351 #define input_item_NewStream( psz_uri, psz_name, i_duration ) \
 352     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_STREAM, ITEM_NET )
 353
 354 #define input_item_NewDirectory( psz_uri, psz_name, i_net ) \
 355     input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_DIRECTORY, i_net )
 356
 357 #define input_item_NewFile( psz_uri, psz_name, i_duration, i_net ) \
 358     input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_FILE, i_net )
 359
 360 /**
 361  * This function creates a new input_item_t as a copy of another.
 362  */
 363 VLC_API input_item_t * input_item_Copy(input_item_t * ) VLC_USED;
 364
 365 /** Holds an input item, i.e. creates a new reference. */
 366 VLC_API input_item_t *input_item_Hold(input_item_t *);
 367
 368 /** Releases an input item, i.e. decrements its reference counter. */
 369 VLC_API void input_item_Release(input_item_t *);
 370
 371 /* Historical hack... */
 372 #define vlc_gc_incref(i) input_item_Hold(i)
 373 #define vlc_gc_decref(i) input_item_Release(i)
 374
 375 typedef enum input_item_meta_request_option_t
 376 {
 377     META_REQUEST_OPTION_NONE          = 0x00,
 378     META_REQUEST_OPTION_SCOPE_LOCAL   = 0x01,
 379     META_REQUEST_OPTION_SCOPE_NETWORK = 0x02,
 380     META_REQUEST_OPTION_SCOPE_ANY     = 0x03,
 381     META_REQUEST_OPTION_DO_INTERACT   = 0x04
 382 } input_item_meta_request_option_t;
 383
 384 /* status of the vlc_InputItemPreparseEnded event */
 385 enum input_item_preparse_status
 386 {
 387     ITEM_PREPARSE_SKIPPED,
 388     ITEM_PREPARSE_FAILED,
 389     ITEM_PREPARSE_TIMEOUT,
 390     ITEM_PREPARSE_DONE
 391 };
 392
 393 VLC_API int libvlc_MetadataRequest( libvlc_int_t *, input_item_t *,
 394                                     input_item_meta_request_option_t,
 395                                     int, void * );
 396 VLC_API int libvlc_ArtRequest(libvlc_int_t *, input_item_t *,
 397                               input_item_meta_request_option_t );
 398 VLC_API void libvlc_MetadataCancel( libvlc_int_t *, void * );
 399
 400 /******************
 401  * Input stats
 402  ******************/
 403 struct input_stats_t
 404 {
 405     vlc_mutex_t         lock;
 406
 407     /* Input */
 408     int64_t i_read_packets;
 409     int64_t i_read_bytes;
 410     float f_input_bitrate;
 411     float f_average_input_bitrate;
 412
 413     /* Demux */
 414     int64_t i_demux_read_packets;
 415     int64_t i_demux_read_bytes;
 416     float f_demux_bitrate;
 417     float f_average_demux_bitrate;
 418     int64_t i_demux_corrupted;
 419     int64_t i_demux_discontinuity;
 420
 421     /* Decoders */
 422     int64_t i_decoded_audio;
 423     int64_t i_decoded_video;
 424
 425     /* Vout */
 426     int64_t i_displayed_pictures;
 427     int64_t i_lost_pictures;
 428
 429     /* Sout */
 430     int64_t i_sent_packets;
 431     int64_t i_sent_bytes;
 432     float f_send_bitrate;
 433
 434     /* Aout */
 435     int64_t i_played_abuffers;
 436     int64_t i_lost_abuffers;
 437 };
 438
 439 #endif