vlc_input_item.h
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:11k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * vlc_input_item.h: Core input item
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2009 the VideoLAN team
  5.  * $Id: 4d6a83cd3f79ab921853db712cb0b9bed4af3a19 $
  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. #ifndef VLC__INPUT_ITEM_H
  25. #define VLC__INPUT_ITEM_H 1
  26. /**
  27.  * file
  28.  * This file defines functions, structures and enums for input items in vlc
  29.  */
  30. #include <vlc_meta.h>
  31. #include <string.h>
  32. /*****************************************************************************
  33.  * input_item_t: Describes an input and is used to spawn input_thread_t objects
  34.  *****************************************************************************/
  35. struct info_t
  36. {
  37.     char *psz_name;            /**< Name of this info */
  38.     char *psz_value;           /**< Value of the info */
  39. };
  40. struct info_category_t
  41. {
  42.     char   *psz_name;      /**< Name of this category */
  43.     int    i_infos;        /**< Number of infos in the category */
  44.     struct info_t **pp_infos;     /**< Pointer to an array of infos */
  45. };
  46. struct input_item_t
  47. {
  48.     VLC_GC_MEMBERS
  49.     int        i_id;                 /**< Identifier of the item */
  50.     char       *psz_name;            /**< text describing this item */
  51.     char       *psz_uri;             /**< mrl of this item */
  52.     bool       b_fixed_name;        /**< Can the interface change the name ?*/
  53.     int        i_options;            /**< Number of input options */
  54.     char       **ppsz_options;       /**< Array of input options */
  55.     uint8_t    *optflagv;            /**< Some flags of input options */
  56.     unsigned   optflagc;
  57.     mtime_t    i_duration;           /**< Duration in milliseconds*/
  58.     uint8_t    i_type;               /**< Type (file, disc, ... see input_item_type_e) */
  59.     bool b_prefers_tree;             /**< Do we prefer being displayed as tree*/
  60.     int        i_categories;         /**< Number of info categories */
  61.     info_category_t **pp_categories; /**< Pointer to the first info category */
  62.     int         i_es;                /**< Number of es format descriptions */
  63.     es_format_t **es;                /**< Es formats */
  64.     input_stats_t *p_stats;          /**< Statistics */
  65.     int           i_nb_played;       /**< Number of times played */
  66.     bool          b_error_when_reading;       /**< Error When Reading */
  67.     vlc_meta_t *p_meta;
  68.     vlc_event_manager_t event_manager;
  69.     vlc_mutex_t lock;                 /**< Lock for the item */
  70. };
  71. enum input_item_type_e
  72. {
  73.     ITEM_TYPE_UNKNOWN,
  74.     ITEM_TYPE_FILE,
  75.     ITEM_TYPE_DIRECTORY,
  76.     ITEM_TYPE_DISC,
  77.     ITEM_TYPE_CDDA,
  78.     ITEM_TYPE_CARD,
  79.     ITEM_TYPE_NET,
  80.     ITEM_TYPE_PLAYLIST,
  81.     ITEM_TYPE_NODE,
  82.     /* This one is not a real type but the number of input_item types. */
  83.     ITEM_TYPE_NUMBER
  84. };
  85. VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) );
  86. VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) );
  87. /* This won't hold the item, but can tell to interested third parties
  88.  * Like the playlist, that there is a new sub item. With this design
  89.  * It is not the input item's responsability to keep all the ref of
  90.  * the input item children. */
  91. VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
  92. /**
  93.  * Option flags
  94.  */
  95. enum input_item_option_e
  96. {
  97.     /* Allow VLC to trust the given option.
  98.      * By default options are untrusted */
  99.     VLC_INPUT_OPTION_TRUSTED = 0x2,
  100.     /* Change the value associated to an option if already present, otherwise
  101.      * add the option */
  102.     VLC_INPUT_OPTION_UNIQUE  = 0x100,
  103. };
  104. /**
  105.  * This function allows to add an option to an existing input_item_t.
  106.  */
  107. VLC_EXPORT( int,  input_item_AddOption, (input_item_t *, const char *, unsigned i_flags ) );
  108. /* */
  109. VLC_EXPORT( bool, input_item_HasErrorWhenReading, ( input_item_t * ) );
  110. VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *, vlc_meta_type_t meta_type, const char *psz_val ));
  111. VLC_EXPORT( bool, input_item_MetaMatch, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) );
  112. VLC_EXPORT( char *, input_item_GetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type ) );
  113. VLC_EXPORT( char *, input_item_GetName, ( input_item_t * p_i ) );
  114. VLC_EXPORT( char *, input_item_GetTitleFbName, ( input_item_t * p_i ) );
  115. VLC_EXPORT( char *, input_item_GetURI, ( input_item_t * p_i ) );
  116. VLC_EXPORT( void,   input_item_SetURI, ( input_item_t * p_i, const char *psz_uri ));
  117. VLC_EXPORT(mtime_t, input_item_GetDuration, ( input_item_t * p_i ) );
  118. VLC_EXPORT( void,   input_item_SetDuration, ( input_item_t * p_i, mtime_t i_duration ));
  119. VLC_EXPORT( bool,   input_item_IsPreparsed, ( input_item_t *p_i ));
  120. VLC_EXPORT( bool,   input_item_IsArtFetched, ( input_item_t *p_i ));
  121. #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
  122. #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
  123. #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
  124. #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
  125. #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
  126. #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
  127. #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
  128. #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
  129. #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
  130. #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
  131. #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
  132. #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
  133. #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
  134. #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
  135. #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
  136. #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
  137. #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
  138. #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
  139. #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
  140. #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
  141. #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
  142. #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
  143. #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
  144. #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
  145. #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
  146. #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
  147. #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
  148. #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
  149. #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
  150. #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
  151. #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
  152. #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
  153. #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
  154. #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
  155. #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
  156. VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
  157. 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 ) );
  158. VLC_EXPORT( int, input_item_DelInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name ) );
  159. /**
  160.  * This function creates a new input_item_t with the provided informations.
  161.  *
  162.  * XXX You may also use input_item_New or input_item_NewExt as they need
  163.  * less arguments.
  164.  */
  165. 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 ) );
  166. /**
  167.  * This function creates a new input_item_t with the provided informations.
  168.  *
  169.  * Provided for convenience.
  170.  */
  171. #define input_item_NewExt(a,b,c,d,e,f,g) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f,g)
  172. 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 ) );
  173. /**
  174.  * This function creates a new input_item_t with the provided informations.
  175.  *
  176.  * Provided for convenience.
  177.  */
  178. #define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, 0, -1 )
  179. /******************
  180.  * Input stats
  181.  ******************/
  182. struct input_stats_t
  183. {
  184.     vlc_mutex_t         lock;
  185.     /* Input */
  186.     int i_read_packets;
  187.     int i_read_bytes;
  188.     float f_input_bitrate;
  189.     float f_average_input_bitrate;
  190.     /* Demux */
  191.     int i_demux_read_packets;
  192.     int i_demux_read_bytes;
  193.     float f_demux_bitrate;
  194.     float f_average_demux_bitrate;
  195.     int i_demux_corrupted;
  196.     int i_demux_discontinuity;
  197.     /* Decoders */
  198.     int i_decoded_audio;
  199.     int i_decoded_video;
  200.     /* Vout */
  201.     int i_displayed_pictures;
  202.     int i_lost_pictures;
  203.     /* Sout */
  204.     int i_sent_packets;
  205.     int i_sent_bytes;
  206.     float f_send_bitrate;
  207.     /* Aout */
  208.     int i_played_abuffers;
  209.     int i_lost_abuffers;
  210. };
  211. #endif