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 * the callback function with i=NULL and is_last=0.
  42  *
  43  * When using the routines that ask fo a single entry only, a callback
  44  * with the same signature is used. However, no finishing call to the
  45  * routine is issued. */
  46
  47 PA_C_DECL_BEGIN
  48
  49 /** Stores information about sinks */
  50 struct pa_sink_info {
  51     const char *name;                  /**< Name of the sink */
  52     uint32_t index;                    /**< Index of the sink */
  53     const char *description;           /**< Description of this sink */
  54     struct pa_sample_spec sample_spec; /**< Sample spec of this sink */
  55     uint32_t owner_module;             /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
  56     pa_volume_t volume;                /**< Volume of the sink */
  57     uint32_t monitor_source;           /**< Index of the monitor source connected to this sink */
  58     const char *monitor_source_name;   /**< The name of the monitor source */
  59     pa_usec_t latency;                 /**< Length of filled playback buffer of this sink */
  60 };
  61
  62 /** Get information about a sink by its name */
  63 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);
  64
  65 /** Get information about a sink by its index */
  66 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);
  67
  68 /** Get the complete sink list */
  69 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);
  70
  71 /** Stores information about sources */
  72 struct pa_source_info {
  73     const char *name ;                  /**< Name of the source */
  74     uint32_t index;                     /**< Index of the source */
  75     const char *description;            /**< Description of this source */
  76     struct pa_sample_spec sample_spec;  /**< Sample spec of this source */
  77     uint32_t owner_module;              /**< Owning module index, or PA_INVALID_INDEX */
  78     uint32_t monitor_of_sink;           /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
  79     const char *monitor_of_sink_name;   /**< Name of the owning sink, or PA_INVALID_INDEX */
  80     pa_usec_t latency;                  /**< Length of filled record buffer of this source. \since 0.5 */
  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     const char *default_sink_name;      /**< Name of default sink. \since 0.4 */
 100     const char *default_source_name;      /**< Name of default sink. \since 0.4*/
 101 };
 102
 103 /** Get some information about the server */
 104 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);
 105
 106 /** Stores information about modules */
 107 struct pa_module_info {
 108     uint32_t index;                     /**< Index of the module */
 109     const char*name,                    /**< Name of the module */
 110         *argument;                      /**< Argument string of the module */
 111     uint32_t n_used;                    /**< Usage counter or PA_INVALID_INDEX */
 112     int auto_unload;                    /**< Non-zero if this is an autoloaded module */
 113 };
 114
 115 /** Get some information about a module by its index */
 116 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);
 117
 118 /** Get the complete list of currently loaded modules */
 119 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);
 120
 121 /** Stores information about clients */
 122 struct pa_client_info {
 123     uint32_t index;                      /**< Index of this client */
 124     const char *name;                    /**< Name of this client */
 125     uint32_t owner_module;               /**< Index of the owning module, or PA_INVALID_INDEX */
 126     const char *protocol_name;           /**< A string describing the protocol name this client is connected over (i.e. "ESOUND", "NATIVE", "SIMPLE") */
 127 };
 128
 129 /** Get information about a client by its index */
 130 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);
 131
 132 /** Get the complete client list */
 133 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);
 134
 135 /** Stores information about sink inputs */
 136 struct pa_sink_input_info {
 137     uint32_t index;                      /**< Index of the sink input */
 138     const char *name;                    /**< Name of the sink input */
 139     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 */
 140     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 141     uint32_t sink;                       /**< Index of the connected sink */
 142     struct pa_sample_spec sample_spec;   /**< The sample specification of the sink input */
 143     pa_volume_t volume;                  /**< The volume of this sink input */
 144     pa_usec_t buffer_usec;               /**< Latency due to buffering in sink input, see pa_latency_info for details */
 145     pa_usec_t sink_usec;                 /**< Latency of the sink device, see pa_latency_info for details */
 146 };
 147
 148 /** Get some information about a sink input by its index */
 149 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);
 150
 151 /** Get the complete sink input list */
 152 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);
 153
 154 /** Stores information about source outputs */
 155 struct pa_source_output_info {
 156     uint32_t index;                      /**< Index of the sink input */
 157     const char *name;                    /**< Name of the sink input */
 158     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 */
 159     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 160     uint32_t source;                     /**< Index of the connected source */
 161     struct pa_sample_spec sample_spec;   /**< The sample specification of the source output */
 162     pa_usec_t buffer_usec;               /**< Latency due to buffering in the source output, see pa_latency_info for details. \since 0.5 */
 163     pa_usec_t source_usec;               /**< Latency of the source device, see pa_latency_info for details. \since 0.5 */
 164 };
 165
 166 /** Get information about a source output by its index */
 167 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);
 168
 169 /** Get the complete list of source outputs */
 170 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);
 171
 172 /** Set the volume of a sink device specified by its index */
 173 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);
 174
 175 /** Set the volume of a sink device specified by its name */
 176 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);
 177
 178 /** Set the volume of a sink input stream */
 179 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);
 180
 181 /** Memory block statistics */
 182 struct pa_stat_info {
 183     uint32_t memblock_total;           /**< Currently allocated memory blocks */
 184     uint32_t memblock_total_size;      /**< Currentl total size of allocated memory blocks */
 185     uint32_t memblock_allocated;       /**< Allocated memory blocks during the whole lifetime of the daemon */
 186     uint32_t memblock_allocated_size;  /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
 187     uint32_t scache_size;              /**< Total size of all sample cache entries. \since 0.4 */
 188 };
 189
 190 /** Get daemon memory block statistics */
 191 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);
 192
 193 /** Stores information about sample cache entries */
 194 struct pa_sample_info {
 195     uint32_t index;                       /**< Index of this entry */
 196     const char *name;                     /**< Name of this entry */
 197     pa_volume_t volume;                   /**< Default volume of this entry */
 198     struct pa_sample_spec sample_spec;    /**< Sample specification of the sampel */
 199     pa_usec_t duration;                   /**< Duration of this entry */
 200     uint32_t bytes;                       /**< Length of this sample in bytes. \since 0.4 */
 201     int lazy;                             /**< Non-zero when this is a lazy cache entry. \since 0.5 */
 202     const char *filename;                 /**< In case this is a lazy cache entry, the filename for the sound file to be loaded on demand. \since 0.5 */
 203 };
 204
 205 /** Get information about a sample by its name */
 206 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);
 207
 208 /** Get information about a sample by its index */
 209 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);
 210
 211 /** Get the complete list of samples stored in the daemon. */
 212 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);
 213
 214 /** Kill a client. \since 0.5 */
 215 struct pa_operation* pa_context_kill_client(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
 216
 217 /** Kill a sink input. \since 0.5 */
 218 struct pa_operation* pa_context_kill_sink_input(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
 219
 220 /** Kill a source output. \since 0.5 */
 221 struct pa_operation* pa_context_kill_source_output(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
 222
 223 /** Load a module. \since 0.5 */
 224 struct pa_operation* pa_context_load_module(struct pa_context *c, const char*name, const char *argument, void (*cb)(struct pa_context *c, uint32_t index, void *userdata), void *userdata);
 225
 226 /** Unload a module. \since 0.5 */
 227 struct pa_operation* pa_context_unload_module(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, int success, void *userdata), void *userdata);
 228
 229 /** Type of an autoload entry. \since 0.5 */
 230 enum pa_autoload_type {
 231     PA_AUTOLOAD_SINK = 0,
 232     PA_AUTOLOAD_SOURCE = 1
 233 };
 234
 235 /** Stores information about autoload entries. \since 0.5 */
 236 struct pa_autoload_info {
 237     uint32_t index;               /**< Index of this autoload entry */
 238     const char *name;             /**< Name of the sink or source */
 239     enum pa_autoload_type type;   /**< Type of the autoload entry */
 240     const char *module;           /**< Module name to load */
 241     const char *argument;         /**< Argument string for module */
 242 };
 243
 244 /** Get info about a specific autoload entry. \since 0.6 */
 245 struct pa_operation* pa_context_get_autoload_info_by_name(struct pa_context *c, const char *name, enum pa_autoload_type type, void (*cb)(struct pa_context *c, const struct pa_autoload_info *i, int is_last, void *userdata), void *userdata);
 246
 247 /** Get info about a specific autoload entry. \since 0.6 */
 248 struct pa_operation* pa_context_get_autoload_info_by_index(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, const struct pa_autoload_info *i, int is_last, void *userdata), void *userdata);
 249
 250 /** Get the complete list of autoload entries. \since 0.5 */
 251 struct pa_operation* pa_context_get_autoload_info_list(struct pa_context *c, void (*cb)(struct pa_context *c, const struct pa_autoload_info *i, int is_last, void *userdata), void *userdata);
 252
 253 /** Add a new autoload entry. \since 0.5 */
 254 struct pa_operation* pa_context_add_autoload(struct pa_context *c, const char *name, enum pa_autoload_type type, const char *module, const char*argument, void (*cb)(struct pa_context *c, int index, void *userdata), void* userdata);
 255
 256 /** Remove an autoload entry. \since 0.6 */
 257 struct pa_operation* pa_context_remove_autoload_by_name(struct pa_context *c, const char *name, enum pa_autoload_type type, void (*cb)(struct pa_context *c, int success, void *userdata), void* userdata);
 258
 259 /** Remove an autoload entry. \since 0.6 */
 260 struct pa_operation* pa_context_remove_autoload_by_index(struct pa_context *c, uint32_t index, void (*cb)(struct pa_context *c, int success, void *userdata), void* userdata);
 261
 262
 263 PA_C_DECL_END
 264
 265 #endif