code.delx.au - pulseaudio/blob - polyp/polyplib-introspect.h

   1 #ifndef foopolyplibintrospecthfoo
   2 #define foopolyplibintrospecthfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of polypaudio.
   8
   9   polypaudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   polypaudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU General Public License
  20   along with polypaudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #include <inttypes.h>
  26
  27 #include "polyplib-operation.h"
  28 #include "polyplib-context.h"
  29 #include "cdecl.h"
  30
  31 /** \file
  32  *
  33  * Routines for daemon introspection. When enumerating all entitites
  34  * of a certain kind, use the pa_context_xxx_list() functions. The
  35  * specified callback function is called once for each entry. The
  36  * enumeration is finished by a call to the callback function with
  37  * is_last=1 and i=NULL. Strings referenced in pa_xxx_info structures
  38  * and the structures themselves point to internal memory that may not
  39  * be modified. That memory is only valid during the call to the
  40  * callback function. A deep copy is required if you need this data
  41  * outside the callback functions. An error is signalled by a call to
  42  * the callback function with i=NULL and is_last=0.
  43  *
  44  * When using the routines that ask fo a single entry only, a callback
  45  * with the same signature is used. However, no finishing call to the
  46  * routine is issued. */
  47
  48 PA_C_DECL_BEGIN
  49
  50 /** Stores information about sinks */
  51 struct pa_sink_info {
  52     const char *name;                  /**< Name of the sink */
  53     uint32_t index;                    /**< Index of the sink */
  54     const char *description;           /**< Description of this sink */
  55     struct pa_sample_spec sample_spec; /**< Sample spec of this sink */
  56     uint32_t owner_module;             /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
  57     pa_volume_t volume;                /**< Volume of the sink */
  58     uint32_t monitor_source;           /**< Index of the monitor source connected to this sink */
  59     const char *monitor_source_name;   /**< The name of the monitor source */
  60     pa_usec_t latency;                 /**< Length of the playback buffer of this sink */
  61 };
  62
  63 /** Get information about a sink by its name */
  64 struct pa_operation* pa_context_get_sink_info_by_name(struct pa_context *c, const char *name, void (*cb)(struct pa_context *c, const struct pa_sink_info *i, int is_last, void *userdata), void *userdata);
  65
  66 /** Get information about a sink by its index */
  67 struct pa_operation* pa_context_get_sink_info_by_index(struct pa_context *c, uint32_t id, void (*cb)(struct pa_context *c, const struct pa_sink_info *i, int is_last, void *userdata), void *userdata);
  68
  69 /** Get the complete sink list */
  70 struct pa_operation* pa_context_get_sink_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_sink_info *i, int is_last, void *userdata), void *userdata);
  71
  72 /** Stores information about sources */
  73 struct pa_source_info {
  74     const char *name ;                  /**< Name of the source */
  75     uint32_t index;                     /**< Index of the source */
  76     const char *description;            /**< Description of this source */
  77     struct pa_sample_spec sample_spec;  /**< Sample spec of this source */
  78     uint32_t owner_module;              /**< Owning module index, or PA_INVALID_INDEX */
  79     uint32_t monitor_of_sink;           /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
  80     const char *monitor_of_sink_name;   /**< Name of the owning sink, or PA_INVALID_INDEX */
  81 };
  82
  83 /** Get information about a source by its name */
  84 struct pa_operation* pa_context_get_source_info_by_name(struct pa_context *c, const char *name, void (*cb)(struct pa_context *c, const struct pa_source_info *i, int is_last, void *userdata), void *userdata);
  85
  86 /** Get information about a source by its index */
  87 struct pa_operation* pa_context_get_source_info_by_index(struct pa_context *c, uint32_t id, void (*cb)(struct pa_context *c, const struct pa_source_info *i, int is_last, void *userdata), void *userdata);
  88
  89 /** Get the complete source list */
  90 struct pa_operation* pa_context_get_source_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_source_info *i, int is_last, void *userdata), void *userdata);
  91
  92 /** Server information */
  93 struct pa_server_info {
  94     const char *user_name;              /**< User name of the daemon process */
  95     const char *host_name;              /**< Host name the daemon is running on */
  96     const char *server_version;         /**< Version string of the daemon */
  97     const char *server_name;            /**< Server package name (usually "polypaudio") */
  98     struct pa_sample_spec sample_spec;  /**< Default sample specification */
  99 };
 100
 101 /** Get some information about the server */
 102 struct pa_operation* pa_context_get_server_info(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_server_info*i, void *userdata), void *userdata);
 103
 104 /** Stores information about modules */
 105 struct pa_module_info {
 106     uint32_t index;                     /**< Index of the module */
 107     const char*name,                    /**< Name of the module */
 108         *argument;                      /**< Argument string of the module */
 109     uint32_t n_used,                    /**< Usage counter or PA_INVALID_INDEX */
 110         auto_unload;                    /**< Non-zero if this is an autoloaded module */
 111 };
 112
 113 /** Get some information about a module by its index */
 114 struct pa_operation* pa_context_get_module_info(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, const struct pa_module_info*i, int is_last, void *userdata), void *userdata);
 115
 116 /** Get the complete list of currently loaded modules */
 117 struct pa_operation* pa_context_get_module_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_module_info*i, int is_last, void *userdata), void *userdata);
 118
 119 /** Stores information about clients */
 120 struct pa_client_info {
 121     uint32_t index;                      /**< Index of this client */
 122     const char *name;                    /**< Name of this client */
 123     uint32_t owner_module;               /**< Index of the owning module, or PA_INVALID_INDEX */
 124     const char *protocol_name;           /**< A string describing the protocol name this client is connected over (i.e. "ESOUND", "NATIVE", "SIMPLE") */
 125 };
 126
 127 /** Get information about a client by its index */
 128 struct pa_operation* pa_context_get_client_info(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, const struct pa_client_info*i, int is_last, void *userdata), void *userdata);
 129
 130 /** Get the complete client list */
 131 struct pa_operation* pa_context_get_client_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_client_info*i, int is_last, void *userdata), void *userdata);
 132
 133 /** Stores information about sink inputs */
 134 struct pa_sink_input_info {
 135     uint32_t index;                      /**< Index of the sink input */
 136     const char *name;                    /**< Name of the sink input */
 137     uint32_t owner_module;               /**< Index of the module this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any module */
 138     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 139     uint32_t sink;                       /**< Index of the connected sink */
 140     struct pa_sample_spec sample_spec;   /**< The sample specification of the sink input */
 141     pa_volume_t volume;                  /**< The volume of this sink input */
 142     pa_usec_t buffer_usec;               /**< Latency due to buffering in sink input, see pa_latency_info for details */
 143     pa_usec_t sink_usec;                 /**< Latency of the sink device, see pa_latency_info for details */
 144 };
 145
 146 /** Get some information about a sink input by its index */
 147 struct pa_operation* pa_context_get_sink_input_info(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, const struct pa_sink_input_info*i, int is_last, void *userdata), void *userdata);
 148
 149 /** Get the complete sink input list */
 150 struct pa_operation* pa_context_get_sink_input_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_sink_input_info*i, int is_last, void *userdata), void *userdata);
 151
 152 /** Stores information about source outputs */
 153 struct pa_source_output_info {
 154     uint32_t index;                      /**< Index of the sink input */
 155     const char *name;                    /**< Name of the sink input */
 156     uint32_t owner_module;               /**< Index of the module this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any module */
 157     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 158     uint32_t source;                     /**< Index of the connected source */
 159     struct pa_sample_spec sample_spec;   /**< The sample specification of the source output */
 160 };
 161
 162 /** Get information about a source output by its index */
 163 struct pa_operation* pa_context_get_source_output_info(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, const struct pa_source_output_info*i, int is_last, void *userdata), void *userdata);
 164
 165 /** Get the complete list of source outputs */
 166 struct pa_operation* pa_context_get_source_output_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_source_output_info*i, int is_last, void *userdata), void *userdata);
 167
 168 /** Set the volume of a sink device specified by its index */
 169 struct pa_operation* pa_context_set_sink_volume_by_index(struct pa_context *c, uint32_t index, pa_volume_t volume, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
 170
 171 /** Set the volume of a sink device specified by its name */
 172 struct pa_operation* pa_context_set_sink_volume_by_name(struct pa_context *c, const char *name, pa_volume_t volume, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
 173
 174 /** Set the volume of a sink input stream */
 175 struct pa_operation* pa_context_set_sink_input_volume(struct pa_context *c, uint32_t index, pa_volume_t volume, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
 176
 177 /** Memory block statistics */
 178 struct pa_stat_info {
 179     uint32_t memblock_total;           /**< Currently allocated memory blocks */
 180     uint32_t memblock_total_size;      /**< Currentl total size of allocated memory blocks */
 181     uint32_t memblock_allocated;       /**< Allocated memory blocks during the whole lifetime of the daemon */
 182     uint32_t memblock_allocated_size;  /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
 183     uint32_t scache_size;              /**< Total size of all sample cache entries. \since 0.4 */
 184 };
 185
 186 /** Get daemon memory block statistics */
 187 struct pa_operation* pa_context_stat(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_stat_info *i, void *userdata), void *userdata);
 188
 189 /** Stores information about sample cache entries */
 190 struct pa_sample_info {
 191     uint32_t index;                       /**< Index of this entry */
 192     const char *name;                     /**< Name of this entry */
 193     pa_volume_t volume;                   /**< Default volume of this entry */
 194     struct pa_sample_spec sample_spec;    /**< Sample specification of the sampel */
 195     pa_usec_t duration;                   /**< Duration of this entry */
 196     uint32_t bytes;                       /**< Length of this sample in bytes. \since 0.4 */
 197 };
 198
 199 /** Get information about a sample by its name */
 200 struct pa_operation* pa_context_get_sample_info_by_name(struct pa_context *c, const char *name, void (*cb)(struct pa_context *c, const struct pa_sample_info *i, int is_last, void *userdata), void *userdata);
 201
 202 /** Get information about a sample by its index */
 203 struct pa_operation* pa_context_get_sample_info_by_index(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, const struct pa_sample_info *i, int is_last, void *userdata), void *userdata);
 204
 205 /** Get the complete list of samples stored in the daemon. */
 206 struct pa_operation* pa_context_get_sample_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_sample_info *i, int is_last, void *userdata), void *userdata);
 207
 208 PA_C_DECL_END
 209
 210 #endif