vlc_input_item.h 12.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 40
typedef struct input_item_opaque input_item_opaque_t;

41 42 43 44 45 46 47 48 49 50 51 52 53
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 */
};

54 55 56
/**
 * Describes an input and is used to spawn input_thread_t objects.
 */
57 58 59 60 61 62 63 64 65 66 67
struct input_item_t
{
    int        i_id;                 /**< Identifier of the item */

    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;
68
    input_item_opaque_t *opaques;    /**< List of opaque pointer values */
69

70
    mtime_t    i_duration;           /**< Duration in microseconds */
71 72 73 74 75 76 77 78 79 80 81 82


    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;

83 84 85
    int         i_epg;               /**< Number of EPG entries */
    vlc_epg_t   **pp_epg;            /**< EPG entries */

86 87 88
    vlc_event_manager_t event_manager;

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

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

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

    bool        b_preparse_interact; /**< Force interaction with the user when
                                          preparsing.*/
100 101
};

102 103
TYPEDEF_ARRAY(input_item_t*, input_item_array_t)

104 105 106 107 108 109 110
enum input_item_type_e
{
    ITEM_TYPE_UNKNOWN,
    ITEM_TYPE_FILE,
    ITEM_TYPE_DIRECTORY,
    ITEM_TYPE_DISC,
    ITEM_TYPE_CARD,
111
    ITEM_TYPE_STREAM,
112 113 114 115 116 117
    ITEM_TYPE_PLAYLIST,
    ITEM_TYPE_NODE,

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

119 120
typedef int (*input_item_compar_cb)( input_item_t *, input_item_t * );

121 122 123 124 125 126
struct input_item_node_t
{
    input_item_t *         p_item;
    int                    i_children;
    input_item_node_t      **pp_children;
    input_item_node_t      *p_parent;
127
    input_item_compar_cb   compar_cb;
128
    bool                   b_can_loop;
129 130
};

131 132
VLC_API void input_item_CopyOptions( input_item_t *p_parent, input_item_t *p_child );
VLC_API void input_item_SetName( input_item_t *p_item, const char *psz_name );
133

134 135 136 137
/**
 * Add one subitem to this item
 *
 * This won't hold the item, but can tell to interested third parties
138
 * Like the playlist, that there is a new sub item. With this design
139
 * It is not the input item's responsibility to keep all the ref of
140 141 142 143
 * the input item children.
 *
 * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
 */
144
VLC_API void input_item_PostSubItem( input_item_t *p_parent, input_item_t *p_child );
145

146
/**
147
 * Start adding multiple subitems.
148
 *
149
 * Create a root node to hold a tree of subitems for given item
150
 */
151
VLC_API input_item_node_t * input_item_node_Create( input_item_t *p_input ) VLC_USED;
152 153

/**
154
 * Add a new child node to this parent node that will point to this subitem.
155
 */
156
VLC_API input_item_node_t * input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item );
157 158

/**
159
 * Add an already created node to children of this parent node.
160
 */
161
VLC_API void input_item_node_AppendNode( input_item_node_t *p_parent, input_item_node_t *p_child );
162

163 164 165 166 167 168
/**
 * Sort all p_item children of the node recursively.
 */
VLC_API void input_item_node_Sort( input_item_node_t *p_node,
                                   input_item_compar_cb compar_cb );

169
/**
170
 * Delete a node created with input_item_node_Create() and all its children.
171
 */
172
VLC_API void input_item_node_Delete( input_item_node_t *p_node );
173

174 175 176
/**
 * End adding multiple subitems.
 *
177 178 179 180 181
 * Sends a vlc_InputItemSubItemTreeAdded event to notify that the item pointed to
 * by the given root node has created new subitems that are pointed to by all the
 * children of the node.
 *
 * Also sends vlc_InputItemSubItemAdded event for every child under the given root node;
182
 *
183
 * In the end deletes the node and all its children nodes.
184
 */
185
VLC_API void input_item_node_PostAndDelete( input_item_node_t *p_node );
186

187 188 189 190 191 192

/**
 * Option flags
 */
enum input_item_option_e
{
Laurent Aimar's avatar
Laurent Aimar committed
193 194
    /* Allow VLC to trust the given option.
     * By default options are untrusted */
195
    VLC_INPUT_OPTION_TRUSTED = 0x2,
Laurent Aimar's avatar
Laurent Aimar committed
196

197 198
    /* Add the option, unless the same option
     * is already present. */
199 200 201 202 203 204
    VLC_INPUT_OPTION_UNIQUE  = 0x100,
};

/**
 * This function allows to add an option to an existing input_item_t.
 */
205
VLC_API int input_item_AddOption(input_item_t *, const char *, unsigned i_flags );
206
VLC_API int input_item_AddOpaque(input_item_t *, const char *, void *);
207

208 209
void input_item_ApplyOptions(vlc_object_t *, input_item_t *);

210
/* */
211 212 213
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 );
214 215 216 217
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;
218
VLC_API char * input_item_GetNowPlayingFb( input_item_t *p_item ) VLC_USED;
219 220 221 222 223
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 );
224

225 226 227 228 229 230 231 232 233 234 235 236 237 238
#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)
239
INPUT_META(AlbumArtist)
240 241 242 243 244 245 246 247 248 249 250
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)
251
INPUT_META(ESNowPlaying)
252 253 254 255
INPUT_META(Publisher)
INPUT_META(EncodedBy)
INPUT_META(ArtworkURL)
INPUT_META(TrackID)
256
INPUT_META(TrackTotal)
257 258 259 260 261
INPUT_META(Director)
INPUT_META(Season)
INPUT_META(Episode)
INPUT_META(ShowName)
INPUT_META(Actors)
262
INPUT_META(DiscNumber)
263 264 265 266 267

#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
268

269 270
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 );
271 272 273
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 * );
274

275
/**
Rémi Duraffort's avatar
Rémi Duraffort committed
276
 * This function creates a new input_item_t with the provided information.
277 278 279 280
 *
 * XXX You may also use input_item_New or input_item_NewExt as they need
 * less arguments.
 */
281
VLC_API input_item_t * input_item_NewWithType( const char *psz_uri, const char *psz_name, int i_options, const char *const *ppsz_options, unsigned i_option_flags, mtime_t i_duration, int i_type ) VLC_USED;
282

283 284 285 286 287 288 289 290 291 292
/**
 * This function creates a new input_item_t with the provided information.
 *
 * \param i_net 1/0: force b_net to true/false, -1: default (guess it)
 *
 * XXX You may also use input_item_New, input_item_NewExt, or
 * input_item_NewWithType as they need less arguments.
 */
VLC_API input_item_t * input_item_NewWithTypeExt( const char *psz_uri, const char *psz_name, int i_options, const char *const *ppsz_options, unsigned i_option_flags, mtime_t i_duration, int i_type, int i_net ) VLC_USED;

293
/**
Rémi Duraffort's avatar
Rémi Duraffort committed
294
 * This function creates a new input_item_t with the provided information.
295 296 297
 *
 * Provided for convenience.
 */
298
VLC_API input_item_t * input_item_NewExt( const char *psz_uri, const char *psz_name, int i_options, const char *const *ppsz_options, unsigned i_option_flags, mtime_t i_duration ) VLC_USED;
299 300

/**
Rémi Duraffort's avatar
Rémi Duraffort committed
301
 * This function creates a new input_item_t with the provided information.
302 303
 *
 * Provided for convenience.
304
 */
305
#define input_item_New( a,b ) input_item_NewExt( a, b, 0, NULL, 0, -1 )
306

307 308 309
/**
 * This function creates a new input_item_t as a copy of another.
 */
310
VLC_API input_item_t * input_item_Copy(input_item_t * ) VLC_USED;
311

312 313 314 315 316 317 318 319 320
/** 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 *);

/* Historical hack... */
#define vlc_gc_incref(i) input_item_Hold(i)
#define vlc_gc_decref(i) input_item_Release(i)
321

322 323
typedef enum input_item_meta_request_option_t
{
324 325 326
    META_REQUEST_OPTION_NONE          = 0x00,
    META_REQUEST_OPTION_SCOPE_LOCAL   = 0x01,
    META_REQUEST_OPTION_SCOPE_NETWORK = 0x02,
327 328
    META_REQUEST_OPTION_SCOPE_ANY     = 0x03,
    META_REQUEST_OPTION_DO_INTERACT   = 0x04
329 330 331 332 333 334
} input_item_meta_request_option_t;

VLC_API int libvlc_MetaRequest(libvlc_int_t *, input_item_t *,
                               input_item_meta_request_option_t );
VLC_API int libvlc_ArtRequest(libvlc_int_t *, input_item_t *,
                              input_item_meta_request_option_t );
335

336 337 338 339 340 341 342 343
/******************
 * Input stats
 ******************/
struct input_stats_t
{
    vlc_mutex_t         lock;

    /* Input */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
344 345
    int64_t i_read_packets;
    int64_t i_read_bytes;
346 347 348 349
    float f_input_bitrate;
    float f_average_input_bitrate;

    /* Demux */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
350 351
    int64_t i_demux_read_packets;
    int64_t i_demux_read_bytes;
352 353
    float f_demux_bitrate;
    float f_average_demux_bitrate;
Ilkka Ollakka's avatar
Ilkka Ollakka committed
354 355
    int64_t i_demux_corrupted;
    int64_t i_demux_discontinuity;
356 357

    /* Decoders */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
358 359
    int64_t i_decoded_audio;
    int64_t i_decoded_video;
360 361

    /* Vout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
362 363
    int64_t i_displayed_pictures;
    int64_t i_lost_pictures;
364 365

    /* Sout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
366 367
    int64_t i_sent_packets;
    int64_t i_sent_bytes;
368 369 370
    float f_send_bitrate;

    /* Aout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
371 372
    int64_t i_played_abuffers;
    int64_t i_lost_abuffers;
373 374
};

375
#endif