vlc_input_item.h 10.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*****************************************************************************
 * vlc_input_item.h: Core input item
 *****************************************************************************
 * Copyright (C) 1999-2009 the VideoLAN team
 * $Id$
 *
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
 *          Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU 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.
 *****************************************************************************/

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 67

#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
{
    VLC_GC_MEMBERS
    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
    mtime_t    i_duration;           /**< Duration in microseconds */
69 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 */
    int           i_nb_played;       /**< Number of times played */

    vlc_meta_t *p_meta;

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

85 86 87
    vlc_event_manager_t event_manager;

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

    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 */
92 93
};

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
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
};
109

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

118 119 120
VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) );
VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) );

121 122 123 124
/**
 * Add one subitem to this item
 *
 * This won't hold the item, but can tell to interested third parties
125 126
 * 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
127 128 129 130
 * the input item children.
 *
 * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
 */
131
VLC_EXPORT( void, input_item_PostSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
132

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

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

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

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

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

168 169 170 171 172 173

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

    /* Change the value associated to an option if already present, otherwise
     * add the option */
180 181 182 183 184 185 186 187 188 189 190 191
    VLC_INPUT_OPTION_UNIQUE  = 0x100,
};

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

/* */
VLC_EXPORT( bool, input_item_HasErrorWhenReading, ( input_item_t * ) );
VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val ));
VLC_EXPORT( bool, input_item_MetaMatch, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) );
192 193 194 195 196
VLC_EXPORT( char *, input_item_GetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type ) LIBVLC_USED );
VLC_EXPORT( char *, input_item_GetName, ( input_item_t * p_i ) LIBVLC_USED );
VLC_EXPORT( char *, input_item_GetTitleFbName, ( input_item_t * p_i ) LIBVLC_USED );
VLC_EXPORT( char *, input_item_GetURI, ( input_item_t * p_i ) LIBVLC_USED );
VLC_EXPORT( void,   input_item_SetURI, ( input_item_t * p_i, const char *psz_uri ) );
197 198 199 200 201
VLC_EXPORT(mtime_t, input_item_GetDuration, ( input_item_t * p_i ) );
VLC_EXPORT( void,   input_item_SetDuration, ( input_item_t * p_i, mtime_t i_duration ));
VLC_EXPORT( bool,   input_item_IsPreparsed, ( input_item_t *p_i ));
VLC_EXPORT( bool,   input_item_IsArtFetched, ( input_item_t *p_i ));

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

237
VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) LIBVLC_USED );
238 239
VLC_EXPORT( int, input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) );
VLC_EXPORT( int, input_item_DelInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name ) );
240 241
VLC_EXPORT( void, input_item_ReplaceInfos, ( input_item_t *, info_category_t * ) );
VLC_EXPORT( void, input_item_MergeInfos, ( input_item_t *, info_category_t * ) );
242

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

/**
252
 * This function creates a new input_item_t with the provided information.
253 254 255
 *
 * Provided for convenience.
 */
256
VLC_EXPORT( input_item_t *, input_item_NewExt, (vlc_object_t *, const char *psz_uri, const char *psz_name, int i_options, const char *const *ppsz_options, unsigned i_option_flags, mtime_t i_duration ) LIBVLC_USED );
257
#define input_item_NewExt(a,b,c,d,e,f,g) input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f,g)
258 259

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

266 267 268
/**
 * This function creates a new input_item_t as a copy of another.
 */
269
VLC_EXPORT( input_item_t *, input_item_Copy, (vlc_object_t *, input_item_t * ) LIBVLC_USED );
270 271


272 273 274 275 276 277 278 279
/******************
 * Input stats
 ******************/
struct input_stats_t
{
    vlc_mutex_t         lock;

    /* Input */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
280 281
    int64_t i_read_packets;
    int64_t i_read_bytes;
282 283 284 285
    float f_input_bitrate;
    float f_average_input_bitrate;

    /* Demux */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
286 287
    int64_t i_demux_read_packets;
    int64_t i_demux_read_bytes;
288 289
    float f_demux_bitrate;
    float f_average_demux_bitrate;
Ilkka Ollakka's avatar
Ilkka Ollakka committed
290 291
    int64_t i_demux_corrupted;
    int64_t i_demux_discontinuity;
292 293

    /* Decoders */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
294 295
    int64_t i_decoded_audio;
    int64_t i_decoded_video;
296 297

    /* Vout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
298 299
    int64_t i_displayed_pictures;
    int64_t i_lost_pictures;
300 301

    /* Sout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
302 303
    int64_t i_sent_packets;
    int64_t i_sent_bytes;
304 305 306
    float f_send_bitrate;

    /* Aout */
Ilkka Ollakka's avatar
Ilkka Ollakka committed
307 308
    int64_t i_played_abuffers;
    int64_t i_lost_abuffers;
309 310
};

311
#endif