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_prefers_tree;      /**< Do we prefer being displayed as tree*/
  90     bool        b_fixed_name;        /**< Can the interface change the name ?*/
  91     bool        b_error_when_reading;/**< Error When Reading */
  92 };
  93
  94 enum input_item_type_e
  95 {
  96     ITEM_TYPE_UNKNOWN,
  97     ITEM_TYPE_FILE,
  98     ITEM_TYPE_DIRECTORY,
  99     ITEM_TYPE_DISC,
 100     ITEM_TYPE_CDDA,
 101     ITEM_TYPE_CARD,
 102     ITEM_TYPE_NET,
 103     ITEM_TYPE_PLAYLIST,
 104     ITEM_TYPE_NODE,
 105
 106     /* This one is not a real type but the number of input_item types. */
 107     ITEM_TYPE_NUMBER
 108 };
 109
 110 VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) );
 111 VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) );
 112
 113 /* This won't hold the item, but can tell to interested third parties
 114  * Like the playlist, that there is a new sub item. With this design
 115  * It is not the input item's responsability to keep all the ref of
 116  * the input item children. */
 117 VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
 118
 119
 120 /**
 121  * Option flags
 122  */
 123 enum input_item_option_e
 124 {
 125     /* Allow VLC to trust the given option.
 126      * By default options are untrusted */
 127     VLC_INPUT_OPTION_TRUSTED = 0x2,
 128
 129     /* Change the value associated to an option if already present, otherwise
 130      * add the option */
 131     VLC_INPUT_OPTION_UNIQUE  = 0x100,
 132 };
 133
 134 /**
 135  * This function allows to add an option to an existing input_item_t.
 136  */
 137 VLC_EXPORT( int,  input_item_AddOption, (input_item_t *, const char *, unsigned i_flags ) );
 138
 139 /* */
 140 VLC_EXPORT( bool, input_item_HasErrorWhenReading, ( input_item_t * ) );
 141 VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val ));
 142 VLC_EXPORT( bool, input_item_MetaMatch, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) );
 143 VLC_EXPORT( char *, input_item_GetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type ) );
 144 VLC_EXPORT( char *, input_item_GetName, ( input_item_t * p_i ) );
 145 VLC_EXPORT( char *, input_item_GetTitleFbName, ( input_item_t * p_i ) );
 146 VLC_EXPORT( char *, input_item_GetURI, ( input_item_t * p_i ) );
 147 VLC_EXPORT( void,   input_item_SetURI, ( input_item_t * p_i, const char *psz_uri ));
 148 VLC_EXPORT(mtime_t, input_item_GetDuration, ( input_item_t * p_i ) );
 149 VLC_EXPORT( void,   input_item_SetDuration, ( input_item_t * p_i, mtime_t i_duration ));
 150 VLC_EXPORT( bool,   input_item_IsPreparsed, ( input_item_t *p_i ));
 151 VLC_EXPORT( bool,   input_item_IsArtFetched, ( input_item_t *p_i ));
 152
 153
 154 #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
 155 #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
 156 #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
 157 #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
 158 #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
 159 #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
 160 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
 161 #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
 162 #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
 163 #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
 164 #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
 165 #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
 166 #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
 167 #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
 168 #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
 169 #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
 170 #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
 171
 172 #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
 173 #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
 174 #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
 175 #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
 176 #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
 177 #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
 178 #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
 179 #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
 180 #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
 181 #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
 182 #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
 183 #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
 184 #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
 185 #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
 186 #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
 187 #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
 188 #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
 189 #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
 190
 191 VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
 192 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 ) );
 193 VLC_EXPORT( int, input_item_DelInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name ) );
 194
 195 /**
 196  * This function creates a new input_item_t with the provided informations.
 197  *
 198  * XXX You may also use input_item_New or input_item_NewExt as they need
 199  * less arguments.
 200  */
 201 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 ) );
 202
 203 /**
 204  * This function creates a new input_item_t with the provided informations.
 205  *
 206  * Provided for convenience.
 207  */
 208 #define input_item_NewExt(a,b,c,d,e,f,g) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f,g)
 209 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 ) );
 210
 211 /**
 212  * This function creates a new input_item_t with the provided informations.
 213  *
 214  * Provided for convenience.
 215  */
 216 #define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, 0, -1 )
 217
 218 /******************
 219  * Input stats
 220  ******************/
 221 struct input_stats_t
 222 {
 223     vlc_mutex_t         lock;
 224
 225     /* Input */
 226     int i_read_packets;
 227     int i_read_bytes;
 228     float f_input_bitrate;
 229     float f_average_input_bitrate;
 230
 231     /* Demux */
 232     int i_demux_read_packets;
 233     int i_demux_read_bytes;
 234     float f_demux_bitrate;
 235     float f_average_demux_bitrate;
 236     int i_demux_corrupted;
 237     int i_demux_discontinuity;
 238
 239     /* Decoders */
 240     int i_decoded_audio;
 241     int i_decoded_video;
 242
 243     /* Vout */
 244     int i_displayed_pictures;
 245     int i_lost_pictures;
 246
 247     /* Sout */
 248     int i_sent_packets;
 249     int i_sent_bytes;
 250     float f_send_bitrate;
 251
 252     /* Aout */
 253     int i_played_abuffers;
 254     int i_lost_abuffers;
 255 };
 256
 257 #endif