vlc_input_item.h 10.4 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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66

#include <string.h>

/*****************************************************************************
 * input_item_t: Describes an input and is used to spawn input_thread_t objects
 *****************************************************************************/
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 */
};

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;

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


    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 */
    int           i_nb_played;       /**< Number of times played */

    vlc_meta_t *p_meta;

81 82 83
    int         i_epg;               /**< Number of EPG entries */
    vlc_epg_t   **pp_epg;            /**< EPG entries */

84 85 86
    vlc_event_manager_t event_manager;

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

    uint8_t     i_type;              /**< Type (file, disc, ... see input_item_type_e) */
    bool        b_fixed_name;        /**< Can the interface change the name ?*/
    bool        b_error_when_reading;/**< Error When Reading */
91 92
};

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
enum input_item_type_e
{
    ITEM_TYPE_UNKNOWN,
    ITEM_TYPE_FILE,
    ITEM_TYPE_DIRECTORY,
    ITEM_TYPE_DISC,
    ITEM_TYPE_CDDA,
    ITEM_TYPE_CARD,
    ITEM_TYPE_NET,
    ITEM_TYPE_PLAYLIST,
    ITEM_TYPE_NODE,

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

109 110 111 112 113 114 115 116
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;
};

117 118
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 );
119

120 121 122 123
/**
 * Add one subitem to this item
 *
 * This won't hold the item, but can tell to interested third parties
124 125
 * Like the playlist, that there is a new sub item. With this design
 * It is not the input item's responsability to keep all the ref of
126 127 128 129
 * the input item children.
 *
 * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
 */
130
VLC_API void input_item_PostSubItem( input_item_t *p_parent, input_item_t *p_child );
131

132
/**
133
 * Start adding multiple subitems.
134
 *
135
 * Create a root node to hold a tree of subitems for given item
136
 */
137
VLC_API input_item_node_t * input_item_node_Create( input_item_t *p_input ) VLC_USED;
138 139

/**
140
 * Add a new child node to this parent node that will point to this subitem.
141
 */
142
VLC_API input_item_node_t * input_item_node_AppendItem( input_item_node_t *p_node, input_item_t *p_item );
143 144

/**
145
 * Add an already created node to children of this parent node.
146
 */
147
VLC_API void input_item_node_AppendNode( input_item_node_t *p_parent, input_item_node_t *p_child );
148 149

/**
150
 * Delete a node created with input_item_node_Create() and all its children.
151
 */
152
VLC_API void input_item_node_Delete( input_item_node_t *p_node );
153

154 155 156
/**
 * End adding multiple subitems.
 *
157 158 159 160 161
 * 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;
162
 *
163
 * In the end deletes the node and all its children nodes.
164
 */
165
VLC_API void input_item_node_PostAndDelete( input_item_node_t *p_node );
166

167 168 169 170 171 172

/**
 * Option flags
 */
enum input_item_option_e
{
Laurent Aimar's avatar
Laurent Aimar committed
173 174
    /* Allow VLC to trust the given option.
     * By default options are untrusted */
175
    VLC_INPUT_OPTION_TRUSTED = 0x2,
Laurent Aimar's avatar
Laurent Aimar committed
176 177 178

    /* Change the value associated to an option if already present, otherwise
     * add the option */
179 180 181 182 183 184
    VLC_INPUT_OPTION_UNIQUE  = 0x100,
};

/**
 * This function allows to add an option to an existing input_item_t.
 */
185
VLC_API int input_item_AddOption(input_item_t *, const char *, unsigned i_flags );
186 187

/* */
188 189 190
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 );
191 192 193 194
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;
195 196 197 198 199
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 );
200

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
#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)
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)
INPUT_META(Publisher)
INPUT_META(EncodedBy)
INPUT_META(ArtworkURL)
INPUT_META(TrackID)

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

236 237
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 );
238 239 240
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 * );
241

242
/**
243
 * This function creates a new input_item_t with the provided information.
244 245 246 247
 *
 * XXX You may also use input_item_New or input_item_NewExt as they need
 * less arguments.
 */
248
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;
249 250

/**
251
 * This function creates a new input_item_t with the provided information.
252 253 254
 *
 * Provided for convenience.
 */
255
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;
256 257

/**
258
 * This function creates a new input_item_t with the provided information.
259 260
 *
 * Provided for convenience.
261
 */
262
#define input_item_New( a,b ) input_item_NewExt( a, b, 0, NULL, 0, -1 )
263

264 265 266
/**
 * This function creates a new input_item_t as a copy of another.
 */
267
VLC_API input_item_t * input_item_Copy(input_item_t * ) VLC_USED;
268

269 270 271 272 273 274 275 276 277
/** 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)
278

279 280 281 282 283 284 285 286
/******************
 * Input stats
 ******************/
struct input_stats_t
{
    vlc_mutex_t         lock;

    /* Input */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
287 288
    int64_t i_read_packets;
    int64_t i_read_bytes;
289 290 291 292
    float f_input_bitrate;
    float f_average_input_bitrate;

    /* Demux */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
293 294
    int64_t i_demux_read_packets;
    int64_t i_demux_read_bytes;
295 296
    float f_demux_bitrate;
    float f_average_demux_bitrate;
Ilkka Ollakka's avatar
Ilkka Ollakka committed
297 298
    int64_t i_demux_corrupted;
    int64_t i_demux_discontinuity;
299 300

    /* Decoders */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
301 302
    int64_t i_decoded_audio;
    int64_t i_decoded_video;
303 304

    /* Vout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
305 306
    int64_t i_displayed_pictures;
    int64_t i_lost_pictures;
307 308

    /* Sout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
309 310
    int64_t i_sent_packets;
    int64_t i_sent_bytes;
311 312 313
    float f_send_bitrate;

    /* Aout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
314 315
    int64_t i_played_abuffers;
    int64_t i_lost_abuffers;
316 317
};

318
#endif