1 #ifndef foointrospecthfoo
2 #define foointrospecthfoo
7 This file is part of PulseAudio.
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser 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.
14 PulseAudio 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.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
27 #include <pulse/operation.h>
28 #include <pulse/context.h>
29 #include <pulse/cdecl.h>
30 #include <pulse/channelmap.h>
31 #include <pulse/volume.h>
33 /** \page introspect Server Query and Control
35 * \section overv_sec Overview
37 * Sometimes it is necessary to query and modify global settings in the
38 * server. For this, PulseAudio has the introspection API. It can list sinks,
39 * sources, samples and other aspects of the server. It can also modify the
40 * attributes of the server that will affect operations on a global level,
41 * and not just the application's context.
43 * \section query_sec Querying
45 * All querying is done through callbacks. This design is necessary to
46 * maintain an asynchronous design. The client will request the information
47 * and some time later, the server will respond with the desired data.
49 * Some objects can have multiple entries at the server. When requesting all
50 * of these at once, the callback will be called multiple times, once for
51 * each object. When the list has been exhausted, the callback will be called
52 * without an information structure and the eol parameter set to a non-zero
55 * Note that even if a single object is requested, and not the entire list,
56 * the terminating call will still be made.
58 * If an error occurs, the callback will be called without and information
59 * structure and eol set to zero.
61 * Data members in the information structures are only valid during the
62 * duration of the callback. If they are required after the callback is
63 * finished, a deep copy must be performed.
65 * \subsection server_subsec Server Information
67 * The server can be queried about its name, the environment it's running on
68 * and the currently active global defaults. Calling
69 * pa_context_get_server_info() will get access to a pa_server_info structure
70 * containing all of these.
72 * \subsection memstat_subsec Memory Usage
74 * Statistics about memory usage can be fetched using pa_context_stat(),
75 * giving a pa_stat_info structure.
77 * \subsection sinksrc_subsec Sinks and Sources
79 * The server can have an arbitrary number of sinks and sources. Each sink
80 * and source have both an index and a name associated with it. As such
81 * there are three ways to get access to them:
83 * \li By index - pa_context_get_sink_info_by_index() /
84 * pa_context_get_source_info_by_index()
85 * \li By name - pa_context_get_sink_info_by_name() /
86 * pa_context_get_source_info_by_name()
87 * \li All - pa_context_get_sink_info_list() /
88 * pa_context_get_source_info_list()
90 * All three method use the same callback and will provide a pa_sink_info or
91 * pa_source_info structure.
93 * \subsection siso_subsec Sink Inputs and Source Outputs
95 * Sink inputs and source outputs are the representations of the client ends
96 * of streams inside the server. I.e. they connect a client stream to one of
97 * the global sinks or sources.
99 * Sink inputs and source outputs only have an index to identify them. As
100 * such, there are only two ways to get information about them:
102 * \li By index - pa_context_get_sink_input_info() /
103 * pa_context_get_source_output_info()
104 * \li All - pa_context_get_sink_input_info_list() /
105 * pa_context_get_source_output_info_list()
107 * The structure returned is the pa_sink_input_info or pa_source_output_info
110 * \subsection samples_subsec Samples
112 * The list of cached samples can be retrieved from the server. Three methods
113 * exist for querying the sample cache list:
115 * \li By index - pa_context_get_sample_info_by_index()
116 * \li By name - pa_context_get_sample_info_by_name()
117 * \li All - pa_context_get_sample_info_list()
119 * Note that this only retrieves information about the sample, not the sample
122 * \subsection module_subsec Driver Modules
124 * PulseAudio driver modules are identified by index and are retrieved using either
125 * pa_context_get_module_info() or pa_context_get_module_info_list(). The
126 * information structure is called pa_module_info.
128 * \subsection autoload_subsec Autoload Entries
130 * Modules can be autoloaded as a result of a client requesting a certain
131 * sink or source. This mapping between sink/source names and modules can be
132 * queried from the server:
134 * \li By index - pa_context_get_autoload_info_by_index()
135 * \li By sink/source name - pa_context_get_autoload_info_by_name()
136 * \li All - pa_context_get_autoload_info_list()
138 * \subsection client_subsec Clients
140 * PulseAudio clients are also identified by index and are retrieved using
141 * either pa_context_get_client_info() or pa_context_get_client_info_list().
142 * The information structure is called pa_client_info.
144 * \section ctrl_sec Control
146 * Some parts of the server are only possible to read, but most can also be
147 * modified in different ways. Note that these changes will affect all
148 * connected clients and not just the one issuing the request.
150 * \subsection sinksrc_subsec Sinks and Sources
152 * The most common change one would want to do to sinks and sources is to
153 * modify the volume of the audio. Identical to how sinks and sources can
154 * be queried, there are two ways of identifying them:
156 * \li By index - pa_context_set_sink_volume_by_index() /
157 * pa_context_set_source_volume_by_index()
158 * \li By name - pa_context_set_sink_volume_by_name() /
159 * pa_context_set_source_volume_by_name()
161 * It is also possible to mute a sink or source:
163 * \li By index - pa_context_set_sink_mute_by_index() /
164 * pa_context_set_source_mute_by_index()
165 * \li By name - pa_context_set_sink_mute_by_name() /
166 * pa_context_set_source_mute_by_name()
168 * \subsection siso_subsec Sink Inputs and Source Outputs
170 * If an application desires to modify the volume of just a single stream
171 * (commonly one of its own streams), this can be done by setting the volume
172 * of its associated sink input, using pa_context_set_sink_input_volume().
174 * There is no support for modifying the volume of source outputs.
176 * It is also possible to remove sink inputs and source outputs, terminating
177 * the streams associated with them:
179 * \li Sink input - pa_context_kill_sink_input()
180 * \li Source output - pa_context_kill_source_output()
182 * \subsection module_subsec Modules
184 * Server modules can be remotely loaded and unloaded using
185 * pa_context_load_module() and pa_context_unload_module().
187 * \subsection autoload_subsec Autoload Entries
189 * New module autoloading rules can be added, and existing can be removed
190 * using pa_context_add_autoload() and pa_context_remove_autoload_by_index()
191 * / pa_context_remove_autoload_by_name().
193 * \subsection client_subsec Clients
195 * The only operation supported on clients, is the possibility of kicking
196 * them off the server using pa_context_kill_client().
201 * Routines for daemon introspection.
206 /** Stores information about sinks */
207 typedef struct pa_sink_info
{
208 const char *name
; /**< Name of the sink */
209 uint32_t index
; /**< Index of the sink */
210 const char *description
; /**< Description of this sink */
211 pa_sample_spec sample_spec
; /**< Sample spec of this sink */
212 pa_channel_map channel_map
; /**< Channel map \since 0.8 */
213 uint32_t owner_module
; /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
214 pa_cvolume volume
; /**< Volume of the sink */
215 int mute
; /**< Mute switch of the sink \since 0.8 */
216 uint32_t monitor_source
; /**< Index of the monitor source connected to this sink */
217 const char *monitor_source_name
; /**< The name of the monitor source */
218 pa_usec_t latency
; /**< Length of filled playback buffer of this sink */
219 const char *driver
; /**< Driver name. \since 0.8 */
220 pa_sink_flags_t flags
; /**< Flags \since 0.8 */
223 /** Callback prototype for pa_context_get_sink_info_by_name() and friends */
224 typedef void (*pa_sink_info_cb_t
)(pa_context
*c
, const pa_sink_info
*i
, int eol
, void *userdata
);
226 /** Get information about a sink by its name */
227 pa_operation
* pa_context_get_sink_info_by_name(pa_context
*c
, const char *name
, pa_sink_info_cb_t cb
, void *userdata
);
229 /** Get information about a sink by its index */
230 pa_operation
* pa_context_get_sink_info_by_index(pa_context
*c
, uint32_t id
, pa_sink_info_cb_t cb
, void *userdata
);
232 /** Get the complete sink list */
233 pa_operation
* pa_context_get_sink_info_list(pa_context
*c
, pa_sink_info_cb_t cb
, void *userdata
);
235 /** Stores information about sources */
236 typedef struct pa_source_info
{
237 const char *name
; /**< Name of the source */
238 uint32_t index
; /**< Index of the source */
239 const char *description
; /**< Description of this source */
240 pa_sample_spec sample_spec
; /**< Sample spec of this source */
241 pa_channel_map channel_map
; /**< Channel map \since 0.8 */
242 uint32_t owner_module
; /**< Owning module index, or PA_INVALID_INDEX */
243 pa_cvolume volume
; /**< Volume of the source \since 0.8 */
244 int mute
; /**< Mute switch of the sink \since 0.8 */
245 uint32_t monitor_of_sink
; /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
246 const char *monitor_of_sink_name
; /**< Name of the owning sink, or PA_INVALID_INDEX */
247 pa_usec_t latency
; /**< Length of filled record buffer of this source. \since 0.5 */
248 const char *driver
; /**< Driver name \since 0.8 */
249 pa_source_flags_t flags
; /**< Flags \since 0.8 */
252 /** Callback prototype for pa_context_get_source_info_by_name() and friends */
253 typedef void (*pa_source_info_cb_t
)(pa_context
*c
, const pa_source_info
*i
, int eol
, void *userdata
);
255 /** Get information about a source by its name */
256 pa_operation
* pa_context_get_source_info_by_name(pa_context
*c
, const char *name
, pa_source_info_cb_t cb
, void *userdata
);
258 /** Get information about a source by its index */
259 pa_operation
* pa_context_get_source_info_by_index(pa_context
*c
, uint32_t id
, pa_source_info_cb_t cb
, void *userdata
);
261 /** Get the complete source list */
262 pa_operation
* pa_context_get_source_info_list(pa_context
*c
, pa_source_info_cb_t cb
, void *userdata
);
264 /** Server information */
265 typedef struct pa_server_info
{
266 const char *user_name
; /**< User name of the daemon process */
267 const char *host_name
; /**< Host name the daemon is running on */
268 const char *server_version
; /**< Version string of the daemon */
269 const char *server_name
; /**< Server package name (usually "pulseaudio") */
270 pa_sample_spec sample_spec
; /**< Default sample specification */
271 const char *default_sink_name
; /**< Name of default sink. \since 0.4 */
272 const char *default_source_name
; /**< Name of default sink. \since 0.4*/
273 uint32_t cookie
; /**< A random cookie for identifying this instance of PulseAudio. \since 0.8 */
276 /** Callback prototype for pa_context_get_server_info() */
277 typedef void (*pa_server_info_cb_t
) (pa_context
*c
, const pa_server_info
*i
, void *userdata
);
279 /** Get some information about the server */
280 pa_operation
* pa_context_get_server_info(pa_context
*c
, pa_server_info_cb_t cb
, void *userdata
);
282 /** Stores information about modules */
283 typedef struct pa_module_info
{
284 uint32_t index
; /**< Index of the module */
285 const char*name
, /**< Name of the module */
286 *argument
; /**< Argument string of the module */
287 uint32_t n_used
; /**< Usage counter or PA_INVALID_INDEX */
288 int auto_unload
; /**< Non-zero if this is an autoloaded module */
291 /** Callback prototype for pa_context_get_module_info() and firends*/
292 typedef void (*pa_module_info_cb_t
) (pa_context
*c
, const pa_module_info
*i
, int eol
, void *userdata
);
294 /** Get some information about a module by its index */
295 pa_operation
* pa_context_get_module_info(pa_context
*c
, uint32_t idx
, pa_module_info_cb_t cb
, void *userdata
);
297 /** Get the complete list of currently loaded modules */
298 pa_operation
* pa_context_get_module_info_list(pa_context
*c
, pa_module_info_cb_t cb
, void *userdata
);
300 /** Stores information about clients */
301 typedef struct pa_client_info
{
302 uint32_t index
; /**< Index of this client */
303 const char *name
; /**< Name of this client */
304 uint32_t owner_module
; /**< Index of the owning module, or PA_INVALID_INDEX */
305 const char *driver
; /**< Driver name \since 0.8 */
308 /** Callback prototype for pa_context_get_client_info() and firends*/
309 typedef void (*pa_client_info_cb_t
) (pa_context
*c
, const pa_client_info
*i
, int eol
, void *userdata
);
311 /** Get information about a client by its index */
312 pa_operation
* pa_context_get_client_info(pa_context
*c
, uint32_t idx
, pa_client_info_cb_t cb
, void *userdata
);
314 /** Get the complete client list */
315 pa_operation
* pa_context_get_client_info_list(pa_context
*c
, pa_client_info_cb_t cb
, void *userdata
);
317 /** Stores information about sink inputs */
318 typedef struct pa_sink_input_info
{
319 uint32_t index
; /**< Index of the sink input */
320 const char *name
; /**< Name of the sink input */
321 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 */
322 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
323 uint32_t sink
; /**< Index of the connected sink */
324 pa_sample_spec sample_spec
; /**< The sample specification of the sink input */
325 pa_channel_map channel_map
; /**< Channel map */
326 pa_cvolume volume
; /**< The volume of this sink input */
327 pa_usec_t buffer_usec
; /**< Latency due to buffering in sink input, see pa_latency_info for details */
328 pa_usec_t sink_usec
; /**< Latency of the sink device, see pa_latency_info for details */
329 const char *resample_method
; /**< Thre resampling method used by this sink input. \since 0.7 */
330 const char *driver
; /**< Driver name \since 0.8 */
331 } pa_sink_input_info
;
333 /** Callback prototype for pa_context_get_sink_input_info() and firends*/
334 typedef void (*pa_sink_input_info_cb_t
) (pa_context
*c
, const pa_sink_input_info
*i
, int eol
, void *userdata
);
336 /** Get some information about a sink input by its index */
337 pa_operation
* pa_context_get_sink_input_info(pa_context
*c
, uint32_t idx
, pa_sink_input_info_cb_t cb
, void *userdata
);
339 /** Get the complete sink input list */
340 pa_operation
* pa_context_get_sink_input_info_list(pa_context
*c
, pa_sink_input_info_cb_t cb
, void *userdata
);
342 /** Stores information about source outputs */
343 typedef struct pa_source_output_info
{
344 uint32_t index
; /**< Index of the sink input */
345 const char *name
; /**< Name of the sink input */
346 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 */
347 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
348 uint32_t source
; /**< Index of the connected source */
349 pa_sample_spec sample_spec
; /**< The sample specification of the source output */
350 pa_channel_map channel_map
; /**< Channel map */
351 pa_usec_t buffer_usec
; /**< Latency due to buffering in the source output, see pa_latency_info for details. \since 0.5 */
352 pa_usec_t source_usec
; /**< Latency of the source device, see pa_latency_info for details. \since 0.5 */
353 const char *resample_method
; /**< Thre resampling method used by this source output. \since 0.7 */
354 const char *driver
; /**< Driver name \since 0.8 */
355 } pa_source_output_info
;
357 /** Callback prototype for pa_context_get_source_output_info() and firends*/
358 typedef void (*pa_source_output_info_cb_t
) (pa_context
*c
, const pa_source_output_info
*i
, int eol
, void *userdata
);
360 /** Get information about a source output by its index */
361 pa_operation
* pa_context_get_source_output_info(pa_context
*c
, uint32_t idx
, pa_source_output_info_cb_t cb
, void *userdata
);
363 /** Get the complete list of source outputs */
364 pa_operation
* pa_context_get_source_output_info_list(pa_context
*c
, pa_source_output_info_cb_t cb
, void *userdata
);
366 /** Set the volume of a sink device specified by its index */
367 pa_operation
* pa_context_set_sink_volume_by_index(pa_context
*c
, uint32_t idx
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
369 /** Set the volume of a sink device specified by its name */
370 pa_operation
* pa_context_set_sink_volume_by_name(pa_context
*c
, const char *name
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
372 /** Set the mute switch of a sink device specified by its index \since 0.8 */
373 pa_operation
* pa_context_set_sink_mute_by_index(pa_context
*c
, uint32_t idx
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
375 /** Set the mute switch of a sink device specified by its name \since 0.8 */
376 pa_operation
* pa_context_set_sink_mute_by_name(pa_context
*c
, const char *name
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
378 /** Set the volume of a sink input stream */
379 pa_operation
* pa_context_set_sink_input_volume(pa_context
*c
, uint32_t idx
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
381 /** Set the volume of a source device specified by its index \since 0.8 */
382 pa_operation
* pa_context_set_source_volume_by_index(pa_context
*c
, uint32_t idx
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
384 /** Set the volume of a source device specified by its name \since 0.8 */
385 pa_operation
* pa_context_set_source_volume_by_name(pa_context
*c
, const char *name
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
387 /** Set the mute switch of a source device specified by its index \since 0.8 */
388 pa_operation
* pa_context_set_source_mute_by_index(pa_context
*c
, uint32_t idx
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
390 /** Set the mute switch of a source device specified by its name \since 0.8 */
391 pa_operation
* pa_context_set_source_mute_by_name(pa_context
*c
, const char *name
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
393 /** Memory block statistics */
394 typedef struct pa_stat_info
{
395 uint32_t memblock_total
; /**< Currently allocated memory blocks */
396 uint32_t memblock_total_size
; /**< Currentl total size of allocated memory blocks */
397 uint32_t memblock_allocated
; /**< Allocated memory blocks during the whole lifetime of the daemon */
398 uint32_t memblock_allocated_size
; /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
399 uint32_t scache_size
; /**< Total size of all sample cache entries. \since 0.4 */
402 /** Callback prototype for pa_context_stat() */
403 typedef void (*pa_stat_info_cb_t
) (pa_context
*c
, const pa_stat_info
*i
, void *userdata
);
405 /** Get daemon memory block statistics */
406 pa_operation
* pa_context_stat(pa_context
*c
, pa_stat_info_cb_t cb
, void *userdata
);
408 /** Stores information about sample cache entries */
409 typedef struct pa_sample_info
{
410 uint32_t index
; /**< Index of this entry */
411 const char *name
; /**< Name of this entry */
412 pa_cvolume volume
; /**< Default volume of this entry */
413 pa_sample_spec sample_spec
; /**< Sample specification of the sample */
414 pa_channel_map channel_map
; /**< The channel map */
415 pa_usec_t duration
; /**< Duration of this entry */
416 uint32_t bytes
; /**< Length of this sample in bytes. \since 0.4 */
417 int lazy
; /**< Non-zero when this is a lazy cache entry. \since 0.5 */
418 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 */
421 /** Callback prototype for pa_context_get_sample_info_by_name() and firends */
422 typedef void (*pa_sample_info_cb_t
)(pa_context
*c
, const pa_sample_info
*i
, int eol
, void *userdata
);
424 /** Get information about a sample by its name */
425 pa_operation
* pa_context_get_sample_info_by_name(pa_context
*c
, const char *name
, pa_sample_info_cb_t cb
, void *userdata
);
427 /** Get information about a sample by its index */
428 pa_operation
* pa_context_get_sample_info_by_index(pa_context
*c
, uint32_t idx
, pa_sample_info_cb_t cb
, void *userdata
);
430 /** Get the complete list of samples stored in the daemon. */
431 pa_operation
* pa_context_get_sample_info_list(pa_context
*c
, pa_sample_info_cb_t cb
, void *userdata
);
433 /** Kill a client. \since 0.5 */
434 pa_operation
* pa_context_kill_client(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
436 /** Kill a sink input. \since 0.5 */
437 pa_operation
* pa_context_kill_sink_input(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
439 /** Kill a source output. \since 0.5 */
440 pa_operation
* pa_context_kill_source_output(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
442 /** Callback prototype for pa_context_load_module() and pa_context_add_autoload() */
443 typedef void (*pa_context_index_cb_t
)(pa_context
*c
, uint32_t idx
, void *userdata
);
445 /** Load a module. \since 0.5 */
446 pa_operation
* pa_context_load_module(pa_context
*c
, const char*name
, const char *argument
, pa_context_index_cb_t cb
, void *userdata
);
448 /** Unload a module. \since 0.5 */
449 pa_operation
* pa_context_unload_module(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
451 /** Type of an autoload entry. \since 0.5 */
452 typedef enum pa_autoload_type
{
453 PA_AUTOLOAD_SINK
= 0,
454 PA_AUTOLOAD_SOURCE
= 1
455 } pa_autoload_type_t
;
457 /** Stores information about autoload entries. \since 0.5 */
458 typedef struct pa_autoload_info
{
459 uint32_t index
; /**< Index of this autoload entry */
460 const char *name
; /**< Name of the sink or source */
461 pa_autoload_type_t type
; /**< Type of the autoload entry */
462 const char *module
; /**< Module name to load */
463 const char *argument
; /**< Argument string for module */
466 /** Callback prototype for pa_context_get_autoload_info_by_name() and firends */
467 typedef void (*pa_autoload_info_cb_t
)(pa_context
*c
, const pa_autoload_info
*i
, int eol
, void *userdata
);
469 /** Get info about a specific autoload entry. \since 0.6 */
470 pa_operation
* pa_context_get_autoload_info_by_name(pa_context
*c
, const char *name
, pa_autoload_type_t type
, pa_autoload_info_cb_t cb
, void *userdata
);
472 /** Get info about a specific autoload entry. \since 0.6 */
473 pa_operation
* pa_context_get_autoload_info_by_index(pa_context
*c
, uint32_t idx
, pa_autoload_info_cb_t cb
, void *userdata
);
475 /** Get the complete list of autoload entries. \since 0.5 */
476 pa_operation
* pa_context_get_autoload_info_list(pa_context
*c
, pa_autoload_info_cb_t cb
, void *userdata
);
478 /** Add a new autoload entry. \since 0.5 */
479 pa_operation
* pa_context_add_autoload(pa_context
*c
, const char *name
, pa_autoload_type_t type
, const char *module
, const char*argument
, pa_context_index_cb_t
, void* userdata
);
481 /** Remove an autoload entry. \since 0.6 */
482 pa_operation
* pa_context_remove_autoload_by_name(pa_context
*c
, const char *name
, pa_autoload_type_t type
, pa_context_success_cb_t cb
, void* userdata
);
484 /** Remove an autoload entry. \since 0.6 */
485 pa_operation
* pa_context_remove_autoload_by_index(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void* userdata
);