vlc_input_item.h 15.5 KB
Newer Older
1 2 3
/*****************************************************************************
 * vlc_input_item.h: Core input item
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2009 VLC authors and VideoLAN
5 6 7 8 9
 * $Id$
 *
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
 *          Laurent Aimar <fenrir@via.ecp.fr>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13 14 15 16
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24
 *****************************************************************************/

25 26
#ifndef VLC_INPUT_ITEM_H
#define VLC_INPUT_ITEM_H 1
27 28 29 30 31 32 33

/**
 * \file
 * This file defines functions, structures and enums for input items in vlc
 */

#include <vlc_meta.h>
34
#include <vlc_epg.h>
35
#include <vlc_events.h>
36 37 38

#include <string.h>

39
typedef struct input_item_opaque input_item_opaque_t;
40
typedef struct input_item_slave input_item_slave_t;
41

42 43 44 45 46 47 48 49 50 51 52 53 54
struct info_t
{
    char *psz_name;            /**< Name of this info */
    char *psz_value;           /**< Value of the info */
};

struct info_category_t
{
    char   *psz_name;      /**< Name of this category */
    int    i_infos;        /**< Number of infos in the category */
    struct info_t **pp_infos;     /**< Pointer to an array of infos */
};

55 56 57
/**
 * Describes an input and is used to spawn input_thread_t objects.
 */
58 59 60 61 62 63 64 65 66
struct input_item_t
{
    char       *psz_name;            /**< text describing this item */
    char       *psz_uri;             /**< mrl of this item */

    int        i_options;            /**< Number of input options */
    char       **ppsz_options;       /**< Array of input options */
    uint8_t    *optflagv;            /**< Some flags of input options */
    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 73 74 75 76 77 78 79 80 81


    int        i_categories;         /**< Number of info categories */
    info_category_t **pp_categories; /**< Pointer to the first info category */

    int         i_es;                /**< Number of es format descriptions */
    es_format_t **es;                /**< Es formats */

    input_stats_t *p_stats;          /**< Statistics */

    vlc_meta_t *p_meta;

82 83
    int         i_epg;               /**< Number of EPG entries */
    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 88 89 90
    int         i_slaves;            /**< Number of slaves */
    input_item_slave_t **pp_slaves;  /**< Slave entries that will be loaded by
                                          the input_thread */

91 92 93
    vlc_event_manager_t event_manager;

    vlc_mutex_t lock;                 /**< Lock for the item */
Rémi Duraffort's avatar
Rémi Duraffort committed
94 95

    uint8_t     i_type;              /**< Type (file, disc, ... see input_item_type_e) */
96 97
    bool        b_net;               /**< Net: always true for TYPE_STREAM, it
                                          depends for others types */
Rémi Duraffort's avatar
Rémi Duraffort committed
98
    bool        b_error_when_reading;/**< Error When Reading */
99 100 101

    int         i_preparse_depth;    /**< How many level of sub items can be preparsed:
                                          -1: recursive, 0: none, >0: n levels */
102 103 104

    bool        b_preparse_interact; /**< Force interaction with the user when
                                          preparsing.*/
105 106
};

107 108 109 110 111 112 113
enum input_item_type_e
{
    ITEM_TYPE_UNKNOWN,
    ITEM_TYPE_FILE,
    ITEM_TYPE_DIRECTORY,
    ITEM_TYPE_DISC,
    ITEM_TYPE_CARD,
114
    ITEM_TYPE_STREAM,
115 116 117 118 119 120
    ITEM_TYPE_PLAYLIST,
    ITEM_TYPE_NODE,

    /* This one is not a real type but the number of input_item types. */
    ITEM_TYPE_NUMBER
};
121

122 123 124 125 126 127 128
enum input_item_net_type
{
    ITEM_NET_UNKNOWN,
    ITEM_NET,
    ITEM_LOCAL
};

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
enum slave_type
{
    SLAVE_TYPE_SPU,
    SLAVE_TYPE_AUDIO,
};

enum slave_priority
{
    SLAVE_PRIORITY_MATCH_NONE = 1,
    SLAVE_PRIORITY_MATCH_RIGHT,
    SLAVE_PRIORITY_MATCH_LEFT,
    SLAVE_PRIORITY_MATCH_ALL,
    SLAVE_PRIORITY_USER
};

#define SLAVE_SPU_EXTENSIONS \
    "idx", "sub",  "srt", \
    "ssa", "ass",  "smi", \
    "utf", "utf8", "utf-8", \
    "rt",   "aqt", "txt", \
    "usf", "jss",  "cdg", \
    "psb", "mpsub","mpl2", \
    "pjs", "dks", "stl", \
152 153
    "vtt", "sbv", "ttml" \
    "scc"
154
#define SLAVE_AUDIO_EXTENSIONS \
155 156
    "ac3", "m4a", "aac", \
    "eac3",  "dtshd", "flac", \
157
    "pcm", "dts", "mp3"
158 159 160 161 162

struct input_item_slave
{
    enum slave_type     i_type;     /**< Slave type (spu, audio) */
    enum slave_priority i_priority; /**< Slave priority */
163
    bool                b_forced;   /**< Slave should be selected */
164 165 166
    char                psz_uri[];  /**< Slave mrl */
};

167 168 169 170 171 172 173
struct input_item_node_t
{
    input_item_t *         p_item;
    int                    i_children;
    input_item_node_t      **pp_children;
};

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
 * Start adding multiple subitems.
179
 *
180
 * Create a root node to hold a tree of subitems for given item
181
 */
182
VLC_API input_item_node_t * input_item_node_Create( input_item_t *p_input ) VLC_USED;
183 184

/**
185
 * Add a new child node to this parent node that will point to this subitem.
186
 */
187
VLC_API input_item_node_t * input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item );
188 189

/**
190
 * Add an already created node to children of this parent node.
191
 */
192
VLC_API void input_item_node_AppendNode( input_item_node_t *p_parent, input_item_node_t *p_child );
193

194 195 196 197 198 199
/**
 * Remove a node from its parent.
 */
void input_item_node_RemoveNode( input_item_node_t *parent,
                                 input_item_node_t *child );

200
/**
201
 * Delete a node created with input_item_node_Create() and all its children.
202
 */
203
VLC_API void input_item_node_Delete( input_item_node_t *p_node );
204

205 206 207 208 209
/**
 * Option flags
 */
enum input_item_option_e
{
Laurent Aimar's avatar
Laurent Aimar committed
210 211
    /* Allow VLC to trust the given option.
     * By default options are untrusted */
212
    VLC_INPUT_OPTION_TRUSTED = 0x2,
Laurent Aimar's avatar
Laurent Aimar committed
213

214 215
    /* Add the option, unless the same option
     * is already present. */
216 217 218 219 220 221
    VLC_INPUT_OPTION_UNIQUE  = 0x100,
};

/**
 * This function allows to add an option to an existing input_item_t.
 */
222
VLC_API int input_item_AddOption(input_item_t *, const char *, unsigned i_flags );
223 224 225 226 227 228
/**
 * This function add several options to an existing input_item_t.
 */
VLC_API int input_item_AddOptions(input_item_t *, int i_options,
                                  const char *const *ppsz_options,
                                  unsigned i_flags );
229
VLC_API int input_item_AddOpaque(input_item_t *, const char *, void *);
230

231 232
void input_item_ApplyOptions(vlc_object_t *, input_item_t *);

233 234 235 236 237 238 239 240 241 242 243 244
VLC_API bool input_item_slave_GetType(const char *, enum slave_type *);

VLC_API input_item_slave_t *input_item_slave_New(const char *, enum slave_type,
                                               enum slave_priority);
#define input_item_slave_Delete(p_slave) free(p_slave)

/**
 * This function allows adding a slave to an existing input item.
 * The slave is owned by the input item after this call.
 */
VLC_API int input_item_AddSlave(input_item_t *, input_item_slave_t *);

245
/* */
246 247 248
VLC_API bool input_item_HasErrorWhenReading( input_item_t * );
VLC_API void input_item_SetMeta( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val );
VLC_API bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz );
249 250 251 252
VLC_API char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type ) VLC_USED;
VLC_API char * input_item_GetName( input_item_t * p_i ) VLC_USED;
VLC_API char * input_item_GetTitleFbName( input_item_t * p_i ) VLC_USED;
VLC_API char * input_item_GetURI( input_item_t * p_i ) VLC_USED;
253
VLC_API char * input_item_GetNowPlayingFb( input_item_t *p_item ) VLC_USED;
254 255 256 257 258
VLC_API void input_item_SetURI( input_item_t * p_i, const char *psz_uri );
VLC_API mtime_t input_item_GetDuration( input_item_t * p_i );
VLC_API void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration );
VLC_API bool input_item_IsPreparsed( input_item_t *p_i );
VLC_API bool input_item_IsArtFetched( input_item_t *p_i );
259

260 261 262 263 264 265 266 267 268 269 270 271 272 273
#define INPUT_META( name ) \
static inline \
void input_item_Set ## name (input_item_t *p_input, const char *val) \
{ \
    input_item_SetMeta (p_input, vlc_meta_ ## name, val); \
} \
static inline \
char *input_item_Get ## name (input_item_t *p_input) \
{ \
    return input_item_GetMeta (p_input, vlc_meta_ ## name); \
}

INPUT_META(Title)
INPUT_META(Artist)
274
INPUT_META(AlbumArtist)
275 276 277 278 279 280 281 282 283 284 285
INPUT_META(Genre)
INPUT_META(Copyright)
INPUT_META(Album)
INPUT_META(TrackNumber)
INPUT_META(Description)
INPUT_META(Rating)
INPUT_META(Date)
INPUT_META(Setting)
INPUT_META(URL)
INPUT_META(Language)
INPUT_META(NowPlaying)
286
INPUT_META(ESNowPlaying)
287 288 289 290
INPUT_META(Publisher)
INPUT_META(EncodedBy)
INPUT_META(ArtworkURL)
INPUT_META(TrackID)
291
INPUT_META(TrackTotal)
292 293 294 295 296
INPUT_META(Director)
INPUT_META(Season)
INPUT_META(Episode)
INPUT_META(ShowName)
INPUT_META(Actors)
297
INPUT_META(DiscNumber)
298 299 300 301 302

#define input_item_SetTrackNum input_item_SetTrackNumber
#define input_item_GetTrackNum input_item_GetTrackNumber
#define input_item_SetArtURL   input_item_SetArtworkURL
#define input_item_GetArtURL   input_item_GetArtworkURL
303

304 305
VLC_API char * input_item_GetInfo( input_item_t *p_i, const char *psz_cat,const char *psz_name ) VLC_USED;
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 );
306 307 308
VLC_API int input_item_DelInfo( input_item_t *p_i, const char *psz_cat, const char *psz_name );
VLC_API void input_item_ReplaceInfos( input_item_t *, info_category_t * );
VLC_API void input_item_MergeInfos( input_item_t *, info_category_t * );
309

310
/**
Rémi Duraffort's avatar
Rémi Duraffort committed
311
 * This function creates a new input_item_t with the provided information.
312
 *
313
 * XXX You may also use input_item_New, as they need less arguments.
314
 */
315 316 317 318
VLC_API input_item_t * input_item_NewExt( const char *psz_uri,
                                          const char *psz_name,
                                          mtime_t i_duration, int i_type,
                                          enum input_item_net_type i_net ) VLC_USED;
319

320 321
#define input_item_New( psz_uri, psz_name ) \
    input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_UNKNOWN, ITEM_NET_UNKNOWN )
322

323 324
#define input_item_NewCard( psz_uri, psz_name ) \
    input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_CARD, ITEM_LOCAL )
325

326 327 328 329 330 331 332 333 334 335 336
#define input_item_NewDisc( psz_uri, psz_name, i_duration ) \
    input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_DISC, ITEM_LOCAL )

#define input_item_NewStream( psz_uri, psz_name, i_duration ) \
    input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_STREAM, ITEM_NET )

#define input_item_NewDirectory( psz_uri, psz_name, i_net ) \
    input_item_NewExt( psz_uri, psz_name, -1, ITEM_TYPE_DIRECTORY, i_net )

#define input_item_NewFile( psz_uri, psz_name, i_duration, i_net ) \
    input_item_NewExt( psz_uri, psz_name, i_duration, ITEM_TYPE_FILE, i_net )
337

338 339 340
/**
 * This function creates a new input_item_t as a copy of another.
 */
341
VLC_API input_item_t * input_item_Copy(input_item_t * ) VLC_USED;
342

343 344 345 346 347 348
/** Holds an input item, i.e. creates a new reference. */
VLC_API input_item_t *input_item_Hold(input_item_t *);

/** Releases an input item, i.e. decrements its reference counter. */
VLC_API void input_item_Release(input_item_t *);

349 350
typedef enum input_item_meta_request_option_t
{
351 352 353
    META_REQUEST_OPTION_NONE          = 0x00,
    META_REQUEST_OPTION_SCOPE_LOCAL   = 0x01,
    META_REQUEST_OPTION_SCOPE_NETWORK = 0x02,
354 355
    META_REQUEST_OPTION_SCOPE_ANY     = 0x03,
    META_REQUEST_OPTION_DO_INTERACT   = 0x04
356 357
} input_item_meta_request_option_t;

358 359 360 361 362
/* status of the vlc_InputItemPreparseEnded event */
enum input_item_preparse_status
{
    ITEM_PREPARSE_SKIPPED,
    ITEM_PREPARSE_FAILED,
363
    ITEM_PREPARSE_TIMEOUT,
364 365 366
    ITEM_PREPARSE_DONE
};

367 368 369
VLC_API int libvlc_MetadataRequest( libvlc_int_t *, input_item_t *,
                                    input_item_meta_request_option_t,
                                    int, void * );
370 371
VLC_API int libvlc_ArtRequest(libvlc_int_t *, input_item_t *,
                              input_item_meta_request_option_t );
372
VLC_API void libvlc_MetadataCancel( libvlc_int_t *, void * );
373

374 375 376 377 378 379 380 381
/******************
 * Input stats
 ******************/
struct input_stats_t
{
    vlc_mutex_t         lock;

    /* Input */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
382 383
    int64_t i_read_packets;
    int64_t i_read_bytes;
384 385 386 387
    float f_input_bitrate;
    float f_average_input_bitrate;

    /* Demux */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
388 389
    int64_t i_demux_read_packets;
    int64_t i_demux_read_bytes;
390 391
    float f_demux_bitrate;
    float f_average_demux_bitrate;
Ilkka Ollakka's avatar
Ilkka Ollakka committed
392 393
    int64_t i_demux_corrupted;
    int64_t i_demux_discontinuity;
394 395

    /* Decoders */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
396 397
    int64_t i_decoded_audio;
    int64_t i_decoded_video;
398 399

    /* Vout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
400 401
    int64_t i_displayed_pictures;
    int64_t i_lost_pictures;
402 403

    /* Sout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
404 405
    int64_t i_sent_packets;
    int64_t i_sent_bytes;
406 407 408
    float f_send_bitrate;

    /* Aout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
409 410
    int64_t i_played_abuffers;
    int64_t i_lost_abuffers;
411 412
};

413 414
/**
 * Access pf_readdir helper struct
415 416 417
 * \see vlc_readdir_helper_init()
 * \see vlc_readdir_helper_additem()
 * \see vlc_readdir_helper_finish()
418
 */
419
struct vlc_readdir_helper
420 421 422
{
    input_item_node_t *p_node;
    void **pp_slaves;
Thomas Guillem's avatar
Thomas Guillem committed
423
    size_t i_slaves;
424 425
    void **pp_dirs;
    size_t i_dirs;
426 427
    int i_sub_autodetect_fuzzy;
    bool b_show_hiddenfiles;
428
    bool b_flatten;
429 430 431 432
    char *psz_ignored_exts;
};

/**
433
 * Init a vlc_readdir_helper struct
434
 *
435
 * \param p_rdh need to be cleaned with vlc_readdir_helper_finish()
436 437
 * \param p_node node that will be used to add items
 */
438 439 440 441
VLC_API void vlc_readdir_helper_init(struct vlc_readdir_helper *p_rdh,
                                     vlc_object_t *p_obj, input_item_node_t *p_node);
#define vlc_readdir_helper_init(p_rdh, p_obj, p_node) \
    vlc_readdir_helper_init(p_rdh, VLC_OBJECT(p_obj), p_node)
442 443 444 445 446 447

/**
 * Finish adding items to the node
 *
 * \param b_success if true, items of the node will be sorted.
 */
448
VLC_API void vlc_readdir_helper_finish(struct vlc_readdir_helper *p_rdh, bool b_success);
449 450

/**
451
 * Add a new input_item_t entry to the node of the vlc_readdir_helper struct.
452
 *
453
 * \param p_rdh previously inited vlc_readdir_helper struct
454
 * \param psz_uri uri of the new item
455 456 457 458 459 460 461
 * \param psz_flatpath flattened path of the new item. If not NULL, this
 *        function will create an input item for each sub folders (separated
 *        by '/') of psz_flatpath (so, this will un-flatten the folder
 *        hierarchy). Either psz_flatpath or psz_filename must be valid.
 * \param psz_filename file name of the new item. If NULL, the file part of path
 *        will be used as a filename. Either psz_flatpath or psz_filename must
 *        be valid.
462 463 464
 * \param i_type see \ref input_item_type_e
 * \param i_net see \ref input_item_net_type
 */
465
VLC_API int vlc_readdir_helper_additem(struct vlc_readdir_helper *p_rdh,
466 467
                                       const char *psz_uri, const char *psz_flatpath,
                                       const char *psz_filename,
468
                                       int i_type, int i_net);
469

470
#endif