1 /***************************************************************************** 2 * vlc_input_item.h: Core input item 3 ***************************************************************************** 4 * Copyright (C) 1999-2009 VLC authors and VideoLAN 5 * $Id: f22c3d9330af98a15992ef08e362424313774d6f $ 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 /* Extensions must be in alphabetical order */ 145 #define MASTER_EXTENSIONS \ 146 "asf", "avi", "divx", \ 147 "f4v", "flv", "m1v", \ 148 "m2v", "m4v", "mkv", \ 149 "mov", "mp2", "mp2v", \ 150 "mp4", "mp4v", "mpe", \ 151 "mpeg", "mpeg1", "mpeg2", \ 152 "mpeg4", "mpg", "mpv2", \ 153 "mxf", "ogv", "ogx", \ 154 "ps", "vro","webm", \ 155 "wmv", "wtv" 156 157 #define SLAVE_SPU_EXTENSIONS \ 158 "aqt", "ass", "cdg", \ 159 "dks", "idx", "jss", \ 160 "mpl2", "mpsub", "pjs", \ 161 "psb", "rt", "sami", "sbv", \ 162 "scc", "smi", "srt", \ 163 "ssa", "stl", "sub", \ 164 "ttml", "tt", "usf", \ 165 "vtt", "webvtt" 166 167 #define SLAVE_AUDIO_EXTENSIONS \ 168 "aac", "ac3", "dts", \ 169 "dtshd", "eac3", "flac", \ 170 "m4a", "mp3", "pcm" \ 171 172 struct input_item_slave 173 { 174 enum slave_type i_type; /**< Slave type (spu, audio) */ 175 enum slave_priority i_priority; /**< Slave priority */ 176 bool b_forced; /**< Slave should be selected */ 177 char psz_uri[]; /**< Slave mrl */ 178 }; 179 180 struct input_item_node_t 181 { 182 input_item_t * p_item; 183 int i_children; 184 input_item_node_t **pp_children; 185 }; 186 187 VLC_API void input_item_CopyOptions( input_item_t *p_child, input_item_t *p_parent ); 188 VLC_API void input_item_SetName( input_item_t *p_item, const char *psz_name ); 189 190 /** 191 * Start adding multiple subitems. 192 * 193 * Create a root node to hold a tree of subitems for given item 194 */ 195 VLC_API input_item_node_t * input_item_node_Create( input_item_t *p_input ) VLC_USED; 196 197 /** 198 * Add a new child node to this parent node that will point to this subitem. 199 */ 200 VLC_API input_item_node_t * input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item ); 201 202 /** 203 * Add an already created node to children of this parent node. 204 */ 205 VLC_API void input_item_node_AppendNode( input_item_node_t *p_parent, input_item_node_t *p_child ); 206 207 /** 208 * Remove a node from its parent. 209 */ 210 void input_item_node_RemoveNode( input_item_node_t *parent, 211 input_item_node_t *child ); 212 213 /** 214 * Delete a node created with input_item_node_Create() and all its children. 215 */ 216 VLC_API void input_item_node_Delete( input_item_node_t *p_node ); 217 218 /** 219 * Option flags 220 */ 221 enum input_item_option_e 222 { 223 /* Allow VLC to trust the given option. 224 * By default options are untrusted */ 225 VLC_INPUT_OPTION_TRUSTED = 0x2, 226 227 /* Add the option, unless the same option 228 * is already present. */ 229 VLC_INPUT_OPTION_UNIQUE = 0x100, 230 }; 231 232 /** 233 * This function allows to add an option to an existing input_item_t. 234 */ 235 VLC_API int input_item_AddOption(input_item_t *, const char *, unsigned i_flags ); 236 /** 237 * This function add several options to an existing input_item_t. 238 */ 239 VLC_API int input_item_AddOptions(input_item_t *, int i_options, 240 const char *const *ppsz_options, 241 unsigned i_flags ); 242 VLC_API int input_item_AddOpaque(input_item_t *, const char *, void *); 243 244 void input_item_ApplyOptions(vlc_object_t *, input_item_t *); 245 246 VLC_API bool input_item_slave_GetType(const char *, enum slave_type *); 247 248 VLC_API input_item_slave_t *input_item_slave_New(const char *, enum slave_type, 249 enum slave_priority); 250 #define input_item_slave_Delete(p_slave) free(p_slave) 251 252 /** 253 * This function allows adding a slave to an existing input item. 254 * The slave is owned by the input item after this call. 255 */ 256 VLC_API int input_item_AddSlave(input_item_t *, input_item_slave_t *); 257 258 /* */ 259 VLC_API bool input_item_HasErrorWhenReading( input_item_t * ); 260 VLC_API void input_item_SetMeta( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val ); 261 VLC_API bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ); 262 VLC_API char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type ) VLC_USED; 263 VLC_API char * input_item_GetName( input_item_t * p_i ) VLC_USED; 264 VLC_API char * input_item_GetTitleFbName( input_item_t * p_i ) VLC_USED; 265 VLC_API char * input_item_GetURI( input_item_t * p_i ) VLC_USED; 266 VLC_API char * input_item_GetNowPlayingFb( input_item_t *p_item ) VLC_USED; 267 VLC_API void input_item_SetURI( input_item_t * p_i, const char *psz_uri ); 268 VLC_API mtime_t input_item_GetDuration( input_item_t * p_i ); 269 VLC_API void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration ); 270 VLC_API bool input_item_IsPreparsed( input_item_t *p_i ); 271 VLC_API bool input_item_IsArtFetched( input_item_t *p_i ); 272 273 #define INPUT_META( name ) \ 274 static inline \ 275 void input_item_Set ## name (input_item_t *p_input, const char *val) \ 276 { \ 277 input_item_SetMeta (p_input, vlc_meta_ ## name, val); \ 278 } \ 279 static inline \ 280 char *input_item_Get ## name (input_item_t *p_input) \ 281 { \ 282 return input_item_GetMeta (p_input, vlc_meta_ ## name); \ 283 } 284 285 INPUT_META(Title) 286 INPUT_META(Artist) 287 INPUT_META(AlbumArtist) 288 INPUT_META(Genre) 289 INPUT_META(Copyright) 290 INPUT_META(Album) 291 INPUT_META(TrackNumber) 292 INPUT_META(Description) 293 INPUT_META(Rating) 294 INPUT_META(Date) 295 INPUT_META(Setting) 296 INPUT_META(URL) 297 INPUT_META(Language) 298 INPUT_META(NowPlaying) 299 INPUT_META(ESNowPlaying) 300 INPUT_META(Publisher) 301 INPUT_META(EncodedBy) 302 INPUT_META(ArtworkURL) 303 INPUT_META(TrackID) 304 INPUT_META(TrackTotal) 305 INPUT_META(Director) 306 INPUT_META(Season) 307 INPUT_META(Episode) 308 INPUT_META(ShowName) 309 INPUT_META(Actors) 310 INPUT_META(DiscNumber) 311 312 #define input_item_SetTrackNum input_item_SetTrackNumber 313 #define input_item_GetTrackNum input_item_GetTrackNumber 314 #define input_item_SetArtURL input_item_SetArtworkURL 315 #define input_item_GetArtURL input_item_GetArtworkURL 316 317 VLC_API char * input_item_GetInfo( input_item_t *p_i, const char *psz_cat,const char *psz_name ) VLC_USED; 318 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 ); 319 VLC_API int input_item_DelInfo( input_item_t *p_i, const char *psz_cat, const char *psz_name ); 320 VLC_API void input_item_ReplaceInfos( input_item_t *, info_category_t * ); 321 VLC_API void input_item_MergeInfos( input_item_t *, info_category_t * ); 322 323 /** 324 * This function creates a new input_item_t with the provided information. 325 * 326 * XXX You may also use input_item_New, as they need less arguments. 327 */ 328 VLC_API input_item_t * input_item_NewExt( const char *psz_uri, 329 const char *psz_name, 330 mtime_t i_duration, int i_type, 331 enum input_item_net_type i_net ) VLC_USED; 332 333 #define input_item_New( psz_uri, psz_name ) \ 334 input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_UNKNOWN, ITEM_NET_UNKNOWN ) 335 336 #define input_item_NewCard( psz_uri, psz_name ) \ 337 input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_CARD, ITEM_LOCAL ) 338 339 #define input_item_NewDisc( psz_uri, psz_name, i_duration ) \ 340 input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_DISC, ITEM_LOCAL ) 341 342 #define input_item_NewStream( psz_uri, psz_name, i_duration ) \ 343 input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_STREAM, ITEM_NET ) 344 345 #define input_item_NewDirectory( psz_uri, psz_name, i_net ) \ 346 input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_DIRECTORY, i_net ) 347 348 #define input_item_NewFile( psz_uri, psz_name, i_duration, i_net ) \ 349 input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_FILE, i_net ) 350 351 /** 352 * This function creates a new input_item_t as a copy of another. 353 */ 354 VLC_API input_item_t * input_item_Copy(input_item_t * ) VLC_USED; 355 356 /** Holds an input item, i.e. creates a new reference. */ 357 VLC_API input_item_t *input_item_Hold(input_item_t *); 358 359 /** Releases an input item, i.e. decrements its reference counter. */ 360 VLC_API void input_item_Release(input_item_t *); 361 362 typedef enum input_item_meta_request_option_t 363 { 364 META_REQUEST_OPTION_NONE = 0x00, 365 META_REQUEST_OPTION_SCOPE_LOCAL = 0x01, 366 META_REQUEST_OPTION_SCOPE_NETWORK = 0x02, 367 META_REQUEST_OPTION_SCOPE_ANY = 0x03, 368 META_REQUEST_OPTION_DO_INTERACT = 0x04 369 } input_item_meta_request_option_t; 370 371 /* status of the vlc_InputItemPreparseEnded event */ 372 enum input_item_preparse_status 373 { 374 ITEM_PREPARSE_SKIPPED, 375 ITEM_PREPARSE_FAILED, 376 ITEM_PREPARSE_TIMEOUT, 377 ITEM_PREPARSE_DONE 378 }; 379 380 VLC_API int libvlc_MetadataRequest( libvlc_int_t *, input_item_t *, 381 input_item_meta_request_option_t, 382 int, void * ); 383 VLC_API int libvlc_ArtRequest(libvlc_int_t *, input_item_t *, 384 input_item_meta_request_option_t ); 385 VLC_API void libvlc_MetadataCancel( libvlc_int_t *, void * ); 386 387 /****************** 388 * Input stats 389 ******************/ 390 struct input_stats_t 391 { 392 vlc_mutex_t lock; 393 394 /* Input */ 395 int64_t i_read_packets; 396 int64_t i_read_bytes; 397 float f_input_bitrate; 398 float f_average_input_bitrate; 399 400 /* Demux */ 401 int64_t i_demux_read_packets; 402 int64_t i_demux_read_bytes; 403 float f_demux_bitrate; 404 float f_average_demux_bitrate; 405 int64_t i_demux_corrupted; 406 int64_t i_demux_discontinuity; 407 408 /* Decoders */ 409 int64_t i_decoded_audio; 410 int64_t i_decoded_video; 411 412 /* Vout */ 413 int64_t i_displayed_pictures; 414 int64_t i_lost_pictures; 415 416 /* Sout */ 417 int64_t i_sent_packets; 418 int64_t i_sent_bytes; 419 float f_send_bitrate; 420 421 /* Aout */ 422 int64_t i_played_abuffers; 423 int64_t i_lost_abuffers; 424 }; 425 426 /** 427 * Access pf_readdir helper struct 428 * \see vlc_readdir_helper_init() 429 * \see vlc_readdir_helper_additem() 430 * \see vlc_readdir_helper_finish() 431 */ 432 struct vlc_readdir_helper 433 { 434 input_item_node_t *p_node; 435 void **pp_slaves; 436 size_t i_slaves; 437 void **pp_dirs; 438 size_t i_dirs; 439 int i_sub_autodetect_fuzzy; 440 bool b_show_hiddenfiles; 441 bool b_flatten; 442 char *psz_ignored_exts; 443 }; 444 445 /** 446 * Init a vlc_readdir_helper struct 447 * 448 * \param p_rdh need to be cleaned with vlc_readdir_helper_finish() 449 * \param p_node node that will be used to add items 450 */ 451 VLC_API void vlc_readdir_helper_init(struct vlc_readdir_helper *p_rdh, 452 vlc_object_t *p_obj, input_item_node_t *p_node); 453 #define vlc_readdir_helper_init(p_rdh, p_obj, p_node) \ 454 vlc_readdir_helper_init(p_rdh, VLC_OBJECT(p_obj), p_node) 455 456 /** 457 * Finish adding items to the node 458 * 459 * \param b_success if true, items of the node will be sorted. 460 */ 461 VLC_API void vlc_readdir_helper_finish(struct vlc_readdir_helper *p_rdh, bool b_success); 462 463 /** 464 * Add a new input_item_t entry to the node of the vlc_readdir_helper struct. 465 * 466 * \param p_rdh previously inited vlc_readdir_helper struct 467 * \param psz_uri uri of the new item 468 * \param psz_flatpath flattened path of the new item. If not NULL, this 469 * function will create an input item for each sub folders (separated 470 * by '/') of psz_flatpath (so, this will un-flatten the folder 471 * hierarchy). Either psz_flatpath or psz_filename must be valid. 472 * \param psz_filename file name of the new item. If NULL, the file part of path 473 * will be used as a filename. Either psz_flatpath or psz_filename must 474 * be valid. 475 * \param i_type see \ref input_item_type_e 476 * \param i_net see \ref input_item_net_type 477 */ 478 VLC_API int vlc_readdir_helper_additem(struct vlc_readdir_helper *p_rdh, 479 const char *psz_uri, const char *psz_flatpath, 480 const char *psz_filename, 481 int i_type, int i_net); 482 483 #endif 484