include/vlc_input_item.h

   1 /*****************************************************************************
   2  * vlc_input_item.h: Core input item
   3  *****************************************************************************
   4  * Copyright (C) 1999-2009 the VideoLAN team
   5  * $Id$
   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
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 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 General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, 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
  36 #include <string.h>
  37
  38 /*****************************************************************************
  39  * input_item_t: Describes an input and is used to spawn input_thread_t objects
  40  *****************************************************************************/
  41 struct info_t
  42 {
  43     char *psz_name;            /**< Name of this info */
  44     char *psz_value;           /**< Value of the info */
  45 };
  46
  47 struct info_category_t
  48 {
  49     char   *psz_name;      /**< Name of this category */
  50     int    i_infos;        /**< Number of infos in the category */
  51     struct info_t **pp_infos;     /**< Pointer to an array of infos */
  52 };
  53
  54 struct input_item_t
  55 {
  56     VLC_GC_MEMBERS
  57     int        i_id;                 /**< Identifier of the item */
  58
  59     char       *psz_name;            /**< text describing this item */
  60     char       *psz_uri;             /**< mrl of this item */
  61
  62     int        i_options;            /**< Number of input options */
  63     char       **ppsz_options;       /**< Array of input options */
  64     uint8_t    *optflagv;            /**< Some flags of input options */
  65     unsigned   optflagc;
  66
  67     mtime_t    i_duration;           /**< Duration in microseconds */
  68
  69
  70     int        i_categories;         /**< Number of info categories */
  71     info_category_t **pp_categories; /**< Pointer to the first info category */
  72
  73     int         i_es;                /**< Number of es format descriptions */
  74     es_format_t **es;                /**< Es formats */
  75
  76     input_stats_t *p_stats;          /**< Statistics */
  77     int           i_nb_played;       /**< Number of times played */
  78
  79     vlc_meta_t *p_meta;
  80
  81     int         i_epg;               /**< Number of EPG entries */
  82     vlc_epg_t   **pp_epg;            /**< EPG entries */
  83
  84     vlc_event_manager_t event_manager;
  85
  86     vlc_mutex_t lock;                 /**< Lock for the item */
  87
  88     uint8_t     i_type;              /**< Type (file, disc, ... see input_item_type_e) */
  89     bool        b_fixed_name;        /**< Can the interface change the name ?*/
  90     bool        b_error_when_reading;/**< Error When Reading */
  91 };
  92
  93 enum input_item_type_e
  94 {
  95     ITEM_TYPE_UNKNOWN,
  96     ITEM_TYPE_FILE,
  97     ITEM_TYPE_DIRECTORY,
  98     ITEM_TYPE_DISC,
  99     ITEM_TYPE_CDDA,
 100     ITEM_TYPE_CARD,
 101     ITEM_TYPE_NET,
 102     ITEM_TYPE_PLAYLIST,
 103     ITEM_TYPE_NODE,
 104
 105     /* This one is not a real type but the number of input_item types. */
 106     ITEM_TYPE_NUMBER
 107 };
 108
 109 struct input_item_node_t
 110 {
 111     input_item_t *         p_item;
 112     int                    i_children;
 113     input_item_node_t      **pp_children;
 114     input_item_node_t      *p_parent;
 115 };
 116
 117 VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) );
 118 VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) );
 119
 120 /**
 121  * Add one subitem to this item
 122  *
 123  * This won't hold the item, but can tell to interested third parties
 124  * Like the playlist, that there is a new sub item. With this design
 125  * It is not the input item's responsability to keep all the ref of
 126  * the input item children.
 127  *
 128  * Sends a vlc_InputItemSubItemTreeAdded and a vlc_InputItemSubItemAdded event
 129  */
 130 VLC_EXPORT( 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_EXPORT( input_item_node_t *, input_item_node_Create, ( input_item_t *p_input ) );
 138
 139 /**
 140  * Add a new child node to this parent node that will point to this subitem.
 141  */
 142 VLC_EXPORT( 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_EXPORT( 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_EXPORT( void, input_item_node_Delete, ( input_item_node_t *p_node ) );
 153
 154 /**
 155  * End adding multiple subitems.
 156  *
 157  * Sends a vlc_InputItemSubItemTreeAdded event to notify that the item pointed to
 158  * by the given root node has created new subitems that are pointed to by all the
 159  * children of the node.
 160  *
 161  * 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_EXPORT( void, input_item_node_PostAndDelete, ( input_item_node_t *p_node ) );
 166
 167
 168 /**
 169  * Option flags
 170  */
 171 enum input_item_option_e
 172 {
 173     /* Allow VLC to trust the given option.
 174      * By default options are untrusted */
 175     VLC_INPUT_OPTION_TRUSTED = 0x2,
 176
 177     /* Change the value associated to an option if already present, otherwise
 178      * add the option */
 179     VLC_INPUT_OPTION_UNIQUE  = 0x100,
 180 };
 181
 182 /**
 183  * This function allows to add an option to an existing input_item_t.
 184  */
 185 VLC_EXPORT( int,  input_item_AddOption, (input_item_t *, const char *, unsigned i_flags ) );
 186
 187 /* */
 188 VLC_EXPORT( bool, input_item_HasErrorWhenReading, ( input_item_t * ) );
 189 VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val ));
 190 VLC_EXPORT( bool, input_item_MetaMatch, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) );
 191 VLC_EXPORT( char *, input_item_GetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type ) );
 192 VLC_EXPORT( char *, input_item_GetName, ( input_item_t * p_i ) );
 193 VLC_EXPORT( char *, input_item_GetTitleFbName, ( input_item_t * p_i ) );
 194 VLC_EXPORT( char *, input_item_GetURI, ( input_item_t * p_i ) );
 195 VLC_EXPORT( void,   input_item_SetURI, ( input_item_t * p_i, const char *psz_uri ));
 196 VLC_EXPORT(mtime_t, input_item_GetDuration, ( input_item_t * p_i ) );
 197 VLC_EXPORT( void,   input_item_SetDuration, ( input_item_t * p_i, mtime_t i_duration ));
 198 VLC_EXPORT( bool,   input_item_IsPreparsed, ( input_item_t *p_i ));
 199 VLC_EXPORT( bool,   input_item_IsArtFetched, ( input_item_t *p_i ));
 200
 201 #define INPUT_META( name ) \
 202 static inline \
 203 void input_item_Set ## name (input_item_t *p_input, const char *val) \
 204 { \
 205     input_item_SetMeta (p_input, vlc_meta_ ## name, val); \
 206 } \
 207 static inline \
 208 char *input_item_Get ## name (input_item_t *p_input) \
 209 { \
 210     return input_item_GetMeta (p_input, vlc_meta_ ## name); \
 211 }
 212
 213 INPUT_META(Title)
 214 INPUT_META(Artist)
 215 INPUT_META(Genre)
 216 INPUT_META(Copyright)
 217 INPUT_META(Album)
 218 INPUT_META(TrackNumber)
 219 INPUT_META(Description)
 220 INPUT_META(Rating)
 221 INPUT_META(Date)
 222 INPUT_META(Setting)
 223 INPUT_META(URL)
 224 INPUT_META(Language)
 225 INPUT_META(NowPlaying)
 226 INPUT_META(Publisher)
 227 INPUT_META(EncodedBy)
 228 INPUT_META(ArtworkURL)
 229 INPUT_META(TrackID)
 230
 231 #define input_item_SetTrackNum input_item_SetTrackNumber
 232 #define input_item_GetTrackNum input_item_GetTrackNumber
 233 #define input_item_SetArtURL   input_item_SetArtworkURL
 234 #define input_item_GetArtURL   input_item_GetArtworkURL
 235
 236 VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 237 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 ) );
 238 VLC_EXPORT( int, input_item_DelInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name ) );
 239 VLC_EXPORT( void, input_item_ReplaceInfos, ( input_item_t *, info_category_t * ) );
 240 VLC_EXPORT( void, input_item_MergeInfos, ( input_item_t *, info_category_t * ) );
 241
 242 /**
 243  * This function creates a new input_item_t with the provided informations.
 244  *
 245  * XXX You may also use input_item_New or input_item_NewExt as they need
 246  * less arguments.
 247  */
 248 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 ) );
 249
 250 /**
 251  * This function creates a new input_item_t with the provided informations.
 252  *
 253  * Provided for convenience.
 254  */
 255 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 ) );
 256 #define input_item_NewExt(a,b,c,d,e,f,g) input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f,g)
 257
 258 /**
 259  * This function creates a new input_item_t with the provided informations.
 260  *
 261  * Provided for convenience.
 262  */
 263 #define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, 0, -1 )
 264
 265 /**
 266  * This function creates a new input_item_t as a copy of another.
 267  */
 268 VLC_EXPORT( input_item_t *, input_item_Copy, (vlc_object_t *, input_item_t * ) );
 269
 270
 271 /******************
 272  * Input stats
 273  ******************/
 274 struct input_stats_t
 275 {
 276     vlc_mutex_t         lock;
 277
 278     /* Input */
 279     int i_read_packets;
 280     int i_read_bytes;
 281     float f_input_bitrate;
 282     float f_average_input_bitrate;
 283
 284     /* Demux */
 285     int i_demux_read_packets;
 286     int i_demux_read_bytes;
 287     float f_demux_bitrate;
 288     float f_average_demux_bitrate;
 289     int i_demux_corrupted;
 290     int i_demux_discontinuity;
 291
 292     /* Decoders */
 293     int i_decoded_audio;
 294     int i_decoded_video;
 295
 296     /* Vout */
 297     int i_displayed_pictures;
 298     int i_lost_pictures;
 299
 300     /* Sout */
 301     int i_sent_packets;
 302     int i_sent_bytes;
 303     float f_send_bitrate;
 304
 305     /* Aout */
 306     int i_played_abuffers;
 307     int i_lost_abuffers;
 308 };
 309
 310 #endif