]> code.delx.au - pulseaudio/blob - src/pulse/def.h
call the enum PA_STREAM_NOT_MONOTONIC and make PA_STREAM_NOT_MONOTONOUS an alias...
[pulseaudio] / src / pulse / def.h
1 #ifndef foodefhfoo
2 #define foodefhfoo
3
4 /***
5 This file is part of PulseAudio.
6
7 Copyright 2004-2006 Lennart Poettering
8 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9
10 PulseAudio is free software; you can redistribute it and/or modify
11 it under the terms of the GNU Lesser General Public License as
12 published by the Free Software Foundation; either version 2.1 of the
13 License, or (at your option) any later version.
14
15 PulseAudio is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public
21 License along with PulseAudio; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23 USA.
24 ***/
25
26 #include <inttypes.h>
27 #include <sys/time.h>
28 #include <time.h>
29
30 #include <pulse/cdecl.h>
31 #include <pulse/sample.h>
32
33 /** \file
34 * Global definitions */
35
36 PA_C_DECL_BEGIN
37
38 /** The state of a connection context */
39 typedef enum pa_context_state {
40 PA_CONTEXT_UNCONNECTED, /**< The context hasn't been connected yet */
41 PA_CONTEXT_CONNECTING, /**< A connection is being established */
42 PA_CONTEXT_AUTHORIZING, /**< The client is authorizing itself to the daemon */
43 PA_CONTEXT_SETTING_NAME, /**< The client is passing its application name to the daemon */
44 PA_CONTEXT_READY, /**< The connection is established, the context is ready to execute operations */
45 PA_CONTEXT_FAILED, /**< The connection failed or was disconnected */
46 PA_CONTEXT_TERMINATED /**< The connection was terminated cleanly */
47 } pa_context_state_t;
48
49 /** Return non-zero if the passed state is one of the connected states */
50 static inline int PA_CONTEXT_IS_GOOD(pa_context_state_t x) {
51 return
52 x == PA_CONTEXT_CONNECTING ||
53 x == PA_CONTEXT_AUTHORIZING ||
54 x == PA_CONTEXT_SETTING_NAME ||
55 x == PA_CONTEXT_READY;
56 }
57
58 /** The state of a stream */
59 typedef enum pa_stream_state {
60 PA_STREAM_UNCONNECTED, /**< The stream is not yet connected to any sink or source */
61 PA_STREAM_CREATING, /**< The stream is being created */
62 PA_STREAM_READY, /**< The stream is established, you may pass audio data to it now */
63 PA_STREAM_FAILED, /**< An error occured that made the stream invalid */
64 PA_STREAM_TERMINATED /**< The stream has been terminated cleanly */
65 } pa_stream_state_t;
66
67 /** Return non-zero if the passed state is one of the connected states */
68 static inline int PA_STREAM_IS_GOOD(pa_stream_state_t x) {
69 return
70 x == PA_STREAM_CREATING ||
71 x == PA_STREAM_READY;
72 }
73
74 /** The state of an operation */
75 typedef enum pa_operation_state {
76 PA_OPERATION_RUNNING, /**< The operation is still running */
77 PA_OPERATION_DONE, /**< The operation has been completed */
78 PA_OPERATION_CANCELED /**< The operation has been canceled */
79 } pa_operation_state_t;
80
81 /** An invalid index */
82 #define PA_INVALID_INDEX ((uint32_t) -1)
83
84 /** Some special flags for contexts. */
85 typedef enum pa_context_flags {
86 PA_CONTEXT_NOAUTOSPAWN = 1 /**< Disabled autospawning of the PulseAudio daemon if required */
87 } pa_context_flags_t;
88
89 /** The direction of a pa_stream object */
90 typedef enum pa_stream_direction {
91 PA_STREAM_NODIRECTION, /**< Invalid direction */
92 PA_STREAM_PLAYBACK, /**< Playback stream */
93 PA_STREAM_RECORD, /**< Record stream */
94 PA_STREAM_UPLOAD /**< Sample upload stream */
95 } pa_stream_direction_t;
96
97 /** Some special flags for stream connections. */
98 typedef enum pa_stream_flags {
99 PA_STREAM_START_CORKED = 1, /**< Create the stream corked, requiring an explicit pa_stream_cork() call to uncork it. */
100 PA_STREAM_INTERPOLATE_TIMING = 2, /**< Interpolate the latency for
101 * this stream. When enabled,
102 * pa_stream_get_latency() and
103 * pa_stream_get_time() will try
104 * to estimate the current
105 * record/playback time based on
106 * the local time that passed
107 * since the last timing info
108 * update. Using this option
109 * has the advantage of not
110 * requiring a whole roundtrip
111 * when the current
112 * playback/recording time is
113 * needed. Consider using this
114 * option when requesting
115 * latency information
116 * frequently. This is
117 * especially useful on long
118 * latency network
119 * connections. It makes a lot
120 * of sense to combine this
121 * option with
122 * PA_STREAM_AUTO_TIMING_UPDATE. */
123 PA_STREAM_NOT_MONOTONIC = 4, /**< Don't force the time to
124 * increase monotonically. If
125 * this option is enabled,
126 * pa_stream_get_time() will not
127 * necessarily return always
128 * monotonically increasing time
129 * values on each call. This may
130 * confuse applications which
131 * cannot deal with time going
132 * 'backwards', but has the
133 * advantage that bad transport
134 * latency estimations that
135 * caused the time to to jump
136 * ahead can be corrected
137 * quickly, without the need to
138 * wait. (Please note that this
139 * flag was named
140 * PA_STREAM_NOT_MONOTONOUS in
141 * releases prior to 0.9.11. The
142 * old name is still defined too,
143 * for compatibility reasons. */
144 PA_STREAM_AUTO_TIMING_UPDATE = 8, /**< If set timing update requests
145 * are issued periodically
146 * automatically. Combined with
147 * PA_STREAM_INTERPOLATE_TIMING
148 * you will be able to query the
149 * current time and latency with
150 * pa_stream_get_time() and
151 * pa_stream_get_latency() at
152 * all times without a packet
153 * round trip.*/
154 PA_STREAM_NO_REMAP_CHANNELS = 16, /**< Don't remap channels by
155 * their name, instead map them
156 * simply by their
157 * index. Implies
158 * PA_STREAM_NO_REMIX_CHANNELS. Only
159 * supported when the server is
160 * at least PA 0.9.8. It is
161 * ignored on older
162 * servers.\since 0.9.8 */
163 PA_STREAM_NO_REMIX_CHANNELS = 32, /**< When remapping channels by
164 * name, don't upmix or downmix
165 * them to related
166 * channels. Copy them into
167 * matching channels of the
168 * device 1:1. Only supported
169 * when the server is at least
170 * PA 0.9.8. It is ignored on
171 * older servers. \since
172 * 0.9.8 */
173 PA_STREAM_FIX_FORMAT = 64, /**< Use the sample format of the
174 * sink/device this stream is being
175 * connected to, and possibly ignore
176 * the format the sample spec contains
177 * -- but you still have to pass a
178 * valid value in it as a hint to
179 * PulseAudio what would suit your
180 * stream best. If this is used you
181 * should query the used sample format
182 * after creating the stream by using
183 * pa_stream_get_sample_spec(). Also,
184 * if you specified manual buffer
185 * metrics it is recommended to update
186 * them with
187 * pa_stream_set_buffer_attr() to
188 * compensate for the changed frame
189 * sizes. Only supported when the
190 * server is at least PA 0.9.8. It is
191 * ignored on older servers. \since
192 * 0.9.8 */
193
194 PA_STREAM_FIX_RATE = 128, /**< Use the sample rate of the sink,
195 * and possibly ignore the rate the
196 * sample spec contains. Usage similar
197 * to PA_STREAM_FIX_FORMAT.Only
198 * supported when the server is at least
199 * PA 0.9.8. It is ignored on older
200 * servers. \since 0.9.8 */
201
202 PA_STREAM_FIX_CHANNELS = 256, /**< Use the number of channels and
203 * the channel map of the sink, and
204 * possibly ignore the number of
205 * channels and the map the sample spec
206 * and the passed channel map
207 * contains. Usage similar to
208 * PA_STREAM_FIX_FORMAT. Only supported
209 * when the server is at least PA
210 * 0.9.8. It is ignored on older
211 * servers. \since 0.9.8 */
212 PA_STREAM_DONT_MOVE = 512, /**< Don't allow moving of this stream to
213 * another sink/device. Useful if you use
214 * any of the PA_STREAM_FIX_ flags and
215 * want to make sure that resampling
216 * never takes place -- which might
217 * happen if the stream is moved to
218 * another sink/source whith a different
219 * sample spec/channel map. Only
220 * supported when the server is at least
221 * PA 0.9.8. It is ignored on older
222 * servers. \since 0.9.8 */
223 PA_STREAM_VARIABLE_RATE = 1024, /**< Allow dynamic changing of the
224 * sampling rate during playback
225 * with
226 * pa_stream_update_sample_rate(). Only
227 * supported when the server is at
228 * least PA 0.9.8. It is ignored
229 * on older servers. \since
230 * 0.9.8 */
231 PA_STREAM_PEAK_DETECT = 2048, /**< Find peaks instead of
232 * resampling. \since 0.9.11 */
233
234 PA_STREAM_START_MUTED = 4096, /**< Create in muted state. \since 0.9.11 */
235
236
237 PA_STREAM_ADJUST_LATENCY = 8192, /**< Try to adjust the latency of
238 * the sink/source based on the
239 * requested buffer metrics and
240 * adjust buffer metrics
241 * accordingly. \since 0.9.11 */
242 } pa_stream_flags_t;
243
244
245 /** English is an evil language */
246 #define PA_STREAM_NOT_MONOTONOUS PA_STREAM_NOT_MONOTONIC
247
248 /** Playback and record buffer metrics */
249 typedef struct pa_buffer_attr {
250 uint32_t maxlength; /**< Maximum length of the
251 * buffer. Setting this to 0 will
252 * initialize this to the maximum value
253 * supported by server, which is
254 * recommended. */
255 uint32_t tlength; /**< Playback only: target length of the
256 * buffer. The server tries to assure
257 * that at least tlength bytes are always
258 * available in the buffer. It is
259 * recommended to set this to 0, which
260 * will initialize this to a value that
261 * is deemed sensible by the
262 * server. However, this value will
263 * default to something like 2s, i.e. for
264 * applications that have specific
265 * latency requirements this value should
266 * be set to the maximum latency that the
267 * application can deal with. */
268 uint32_t prebuf; /**< Playback only: pre-buffering. The
269 * server does not start with playback
270 * before at least prebug bytes are
271 * available in the buffer. It is
272 * recommended to set this to 0, which
273 * will initialize this to the same value
274 * as tlength, whatever that may be. */
275 uint32_t minreq; /**< Playback only: minimum request. The
276 * server does not request less than
277 * minreq bytes from the client, instead
278 * waits until the buffer is free enough
279 * to request more bytes at once. It is
280 * recommended to set this to 0, which
281 * will initialize this to a value that
282 * is deemed sensible by the server. */
283 uint32_t fragsize; /**< Recording only: fragment size. The
284 * server sends data in blocks of
285 * fragsize bytes size. Large values
286 * deminish interactivity with other
287 * operations on the connection context
288 * but decrease control overhead. It is
289 * recommended to set this to 0, which
290 * will initialize this to a value that
291 * is deemed sensible by the
292 * server. However, this value will
293 * default to something like 2s, i.e. for
294 * applications that have specific
295 * latency requirements this value should
296 * be set to the maximum latency that the
297 * application can deal with. */
298 } pa_buffer_attr;
299
300 /** Error values as used by pa_context_errno(). Use pa_strerror() to convert these values to human readable strings */
301 enum {
302 PA_OK = 0, /**< No error */
303 PA_ERR_ACCESS, /**< Access failure */
304 PA_ERR_COMMAND, /**< Unknown command */
305 PA_ERR_INVALID, /**< Invalid argument */
306 PA_ERR_EXIST, /**< Entity exists */
307 PA_ERR_NOENTITY, /**< No such entity */
308 PA_ERR_CONNECTIONREFUSED, /**< Connection refused */
309 PA_ERR_PROTOCOL, /**< Protocol error */
310 PA_ERR_TIMEOUT, /**< Timeout */
311 PA_ERR_AUTHKEY, /**< No authorization key */
312 PA_ERR_INTERNAL, /**< Internal error */
313 PA_ERR_CONNECTIONTERMINATED, /**< Connection terminated */
314 PA_ERR_KILLED, /**< Entity killed */
315 PA_ERR_INVALIDSERVER, /**< Invalid server */
316 PA_ERR_MODINITFAILED, /**< Module initialization failed */
317 PA_ERR_BADSTATE, /**< Bad state */
318 PA_ERR_NODATA, /**< No data */
319 PA_ERR_VERSION, /**< Incompatible protocol version */
320 PA_ERR_TOOLARGE, /**< Data too large */
321 PA_ERR_NOTSUPPORTED, /**< Operation not supported \since 0.9.5 */
322 PA_ERR_UNKNOWN, /**< The error code was unknown to the client */
323 PA_ERR_MAX /**< Not really an error but the first invalid error code */
324 };
325
326 /** Subscription event mask, as used by pa_context_subscribe() */
327 typedef enum pa_subscription_mask {
328 PA_SUBSCRIPTION_MASK_NULL = 0, /**< No events */
329 PA_SUBSCRIPTION_MASK_SINK = 1, /**< Sink events */
330 PA_SUBSCRIPTION_MASK_SOURCE = 2, /**< Source events */
331 PA_SUBSCRIPTION_MASK_SINK_INPUT = 4, /**< Sink input events */
332 PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT = 8, /**< Source output events */
333 PA_SUBSCRIPTION_MASK_MODULE = 16, /**< Module events */
334 PA_SUBSCRIPTION_MASK_CLIENT = 32, /**< Client events */
335 PA_SUBSCRIPTION_MASK_SAMPLE_CACHE = 64, /**< Sample cache events */
336 PA_SUBSCRIPTION_MASK_SERVER = 128, /**< Other global server changes. */
337 PA_SUBSCRIPTION_MASK_AUTOLOAD = 256, /**< Autoload table events. */
338 PA_SUBSCRIPTION_MASK_ALL = 511 /**< Catch all events */
339 } pa_subscription_mask_t;
340
341 /** Subscription event types, as used by pa_context_subscribe() */
342 typedef enum pa_subscription_event_type {
343 PA_SUBSCRIPTION_EVENT_SINK = 0, /**< Event type: Sink */
344 PA_SUBSCRIPTION_EVENT_SOURCE = 1, /**< Event type: Source */
345 PA_SUBSCRIPTION_EVENT_SINK_INPUT = 2, /**< Event type: Sink input */
346 PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT = 3, /**< Event type: Source output */
347 PA_SUBSCRIPTION_EVENT_MODULE = 4, /**< Event type: Module */
348 PA_SUBSCRIPTION_EVENT_CLIENT = 5, /**< Event type: Client */
349 PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE = 6, /**< Event type: Sample cache item */
350 PA_SUBSCRIPTION_EVENT_SERVER = 7, /**< Event type: Global server change, only occuring with PA_SUBSCRIPTION_EVENT_CHANGE. */
351 PA_SUBSCRIPTION_EVENT_AUTOLOAD = 8, /**< Event type: Autoload table changes. */
352 PA_SUBSCRIPTION_EVENT_FACILITY_MASK = 15, /**< A mask to extract the event type from an event value */
353
354 PA_SUBSCRIPTION_EVENT_NEW = 0, /**< A new object was created */
355 PA_SUBSCRIPTION_EVENT_CHANGE = 16, /**< A property of the object was modified */
356 PA_SUBSCRIPTION_EVENT_REMOVE = 32, /**< An object was removed */
357 PA_SUBSCRIPTION_EVENT_TYPE_MASK = 16+32 /**< A mask to extract the event operation from an event value */
358 } pa_subscription_event_type_t;
359
360 /** Return one if an event type t matches an event mask bitfield */
361 #define pa_subscription_match_flags(m, t) (!!((m) & (1 << ((t) & PA_SUBSCRIPTION_EVENT_FACILITY_MASK))))
362
363 /** A structure for all kinds of timing information of a stream. See
364 * pa_stream_update_timing_info() and pa_stream_get_timing_info(). The
365 * total output latency a sample that is written with
366 * pa_stream_write() takes to be played may be estimated by
367 * sink_usec+buffer_usec+transport_usec. (where buffer_usec is defined
368 * as pa_bytes_to_usec(write_index-read_index)) The output buffer
369 * which buffer_usec relates to may be manipulated freely (with
370 * pa_stream_write()'s seek argument, pa_stream_flush() and friends),
371 * the buffers sink_usec and source_usec relate to are first-in
372 * first-out (FIFO) buffers which cannot be flushed or manipulated in
373 * any way. The total input latency a sample that is recorded takes to
374 * be delivered to the application is:
375 * source_usec+buffer_usec+transport_usec-sink_usec. (Take care of
376 * sign issues!) When connected to a monitor source sink_usec contains
377 * the latency of the owning sink. The two latency estimations
378 * described here are implemented in pa_stream_get_latency(). Please
379 * note that this structure can be extended as part of evolutionary
380 * API updates at any time in any new release.*/
381 typedef struct pa_timing_info {
382 struct timeval timestamp; /**< The time when this timing info structure was current */
383 int synchronized_clocks; /**< Non-zero if the local and the
384 * remote machine have synchronized
385 * clocks. If synchronized clocks are
386 * detected transport_usec becomes much
387 * more reliable. However, the code that
388 * detects synchronized clocks is very
389 * limited und unreliable itself. */
390
391 pa_usec_t sink_usec; /**< Time in usecs a sample takes to be played on the sink. For playback streams and record streams connected to a monitor source. */
392 pa_usec_t source_usec; /**< Time in usecs a sample takes from being recorded to being delivered to the application. Only for record streams. */
393 pa_usec_t transport_usec; /**< Estimated time in usecs a sample takes to be transferred to/from the daemon. For both playback and record streams. */
394
395 int playing; /**< Non-zero when the stream is
396 * currently not underrun and data is
397 * being passed on to the device. Only
398 * for playback streams. This field does
399 * not say whether the data is actually
400 * already being played. To determine
401 * this check whether since_underrun
402 * (converted to usec) is larger than
403 * sink_usec.*/
404
405 int write_index_corrupt; /**< Non-zero if write_index is not
406 * up-to-date because a local write
407 * command that corrupted it has been
408 * issued in the time since this latency
409 * info was current . Only write
410 * commands with SEEK_RELATIVE_ON_READ
411 * and SEEK_RELATIVE_END can corrupt
412 * write_index. */
413 int64_t write_index; /**< Current write index into the
414 * playback buffer in bytes. Think twice before
415 * using this for seeking purposes: it
416 * might be out of date a the time you
417 * want to use it. Consider using
418 * PA_SEEK_RELATIVE instead. */
419
420 int read_index_corrupt; /**< Non-zero if read_index is not
421 * up-to-date because a local pause or
422 * flush request that corrupted it has
423 * been issued in the time since this
424 * latency info was current. */
425
426 int64_t read_index; /**< Current read index into the
427 * playback buffer in bytes. Think twice before
428 * using this for seeking purposes: it
429 * might be out of date a the time you
430 * want to use it. Consider using
431 * PA_SEEK_RELATIVE_ON_READ
432 * instead. */
433
434 pa_usec_t configured_sink_usec; /**< The static configured latency for
435 * the sink. \since 0.9.11 */
436 pa_usec_t configured_source_usec; /**< The static configured latency for
437 * the source. \since 0.9.11 */
438
439 int64_t since_underrun; /**< Bytes that were handed to the sink
440 since the last underrun happened, or
441 since playback started again after
442 the last underrun. playing will tell
443 you which case it is. \since
444 0.9.11 */
445
446 } pa_timing_info;
447
448 /** A structure for the spawn api. This may be used to integrate auto
449 * spawned daemons into your application. For more information see
450 * pa_context_connect(). When spawning a new child process the
451 * waitpid() is used on the child's PID. The spawn routine will not
452 * block or ignore SIGCHLD signals, since this cannot be done in a
453 * thread compatible way. You might have to do this in
454 * prefork/postfork. */
455 typedef struct pa_spawn_api {
456 void (*prefork)(void); /**< Is called just before the fork in the parent process. May be NULL. */
457 void (*postfork)(void); /**< Is called immediately after the fork in the parent process. May be NULL.*/
458 void (*atfork)(void); /**< Is called immediately after the
459 * fork in the child process. May be
460 * NULL. It is not safe to close all
461 * file descriptors in this function
462 * unconditionally, since a UNIX socket
463 * (created using socketpair()) is
464 * passed to the new process. */
465 } pa_spawn_api;
466
467 /** Seek type for pa_stream_write(). */
468 typedef enum pa_seek_mode {
469 PA_SEEK_RELATIVE = 0, /**< Seek relatively to the write index */
470 PA_SEEK_ABSOLUTE = 1, /**< Seek relatively to the start of the buffer queue */
471 PA_SEEK_RELATIVE_ON_READ = 2, /**< Seek relatively to the read index. */
472 PA_SEEK_RELATIVE_END = 3 /**< Seek relatively to the current end of the buffer queue. */
473 } pa_seek_mode_t;
474
475 /** Special sink flags. */
476 typedef enum pa_sink_flags {
477 PA_SINK_HW_VOLUME_CTRL = 1, /**< Supports hardware volume control */
478 PA_SINK_LATENCY = 2, /**< Supports latency querying */
479 PA_SINK_HARDWARE = 4, /**< Is a hardware sink of some kind, in contrast to "virtual"/software sinks \since 0.9.3 */
480 PA_SINK_NETWORK = 8, /**< Is a networked sink of some kind. \since 0.9.7 */
481 PA_SINK_HW_MUTE_CTRL = 16, /**< Supports hardware mute control \since 0.9.11 */
482 PA_SINK_DECIBEL_VOLUME = 32 /**< Volume can be translated to dB with pa_sw_volume_to_dB() \since 0.9.11 */
483 } pa_sink_flags_t;
484
485 /** Special source flags. */
486 typedef enum pa_source_flags {
487 PA_SOURCE_HW_VOLUME_CTRL = 1, /**< Supports hardware volume control */
488 PA_SOURCE_LATENCY = 2, /**< Supports latency querying */
489 PA_SOURCE_HARDWARE = 4, /**< Is a hardware source of some kind, in contrast to "virtual"/software source \since 0.9.3 */
490 PA_SOURCE_NETWORK = 8, /**< Is a networked sink of some kind. \since 0.9.7 */
491 PA_SOURCE_HW_MUTE_CTRL = 16, /**< Supports hardware mute control \since 0.9.11 */
492 PA_SOURCE_DECIBEL_VOLUME = 32 /**< Volume can be translated to dB with pa_sw_volume_to_dB() \since 0.9.11 */
493 } pa_source_flags_t;
494
495 /** A generic free() like callback prototype */
496 typedef void (*pa_free_cb_t)(void *p);
497
498 PA_C_DECL_END
499
500 #endif