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 #include <pulse/version.h>
  33
  34 /** \file
  35  * Global definitions */
  36
  37 PA_C_DECL_BEGIN
  38
  39 /** The state of a connection context */
  40 typedef enum pa_context_state {
  41     PA_CONTEXT_UNCONNECTED,    /**< The context hasn't been connected yet */
  42     PA_CONTEXT_CONNECTING,     /**< A connection is being established */
  43     PA_CONTEXT_AUTHORIZING,    /**< The client is authorizing itself to the daemon */
  44     PA_CONTEXT_SETTING_NAME,   /**< The client is passing its application name to the daemon */
  45     PA_CONTEXT_READY,          /**< The connection is established, the context is ready to execute operations */
  46     PA_CONTEXT_FAILED,         /**< The connection failed or was disconnected */
  47     PA_CONTEXT_TERMINATED      /**< The connection was terminated cleanly */
  48 } pa_context_state_t;
  49
  50 /** Return non-zero if the passed state is one of the connected states. \since 0.9.11 */
  51 static inline int PA_CONTEXT_IS_GOOD(pa_context_state_t x) {
  52     return
  53         x == PA_CONTEXT_CONNECTING ||
  54         x == PA_CONTEXT_AUTHORIZING ||
  55         x == PA_CONTEXT_SETTING_NAME ||
  56         x == PA_CONTEXT_READY;
  57 }
  58
  59 /** \cond fulldocs */
  60 #define PA_CONTEXT_UNCONNECTED PA_CONTEXT_UNCONNECTED
  61 #define PA_CONTEXT_CONNECTING PA_CONTEXT_CONNECTING
  62 #define PA_CONTEXT_AUTHORIZING PA_CONTEXT_AUTHORIZING
  63 #define PA_CONTEXT_SETTING_NAME PA_CONTEXT_SETTING_NAME
  64 #define PA_CONTEXT_READY PA_CONTEXT_READY
  65 #define PA_CONTEXT_FAILED PA_CONTEXT_FAILED
  66 #define PA_CONTEXT_IS_GOOD PA_CONTEXT_IS_GOOD
  67 /** \endcond */
  68
  69 /** The state of a stream */
  70 typedef enum pa_stream_state {
  71     PA_STREAM_UNCONNECTED,  /**< The stream is not yet connected to any sink or source */
  72     PA_STREAM_CREATING,     /**< The stream is being created */
  73     PA_STREAM_READY,        /**< The stream is established, you may pass audio data to it now */
  74     PA_STREAM_FAILED,       /**< An error occured that made the stream invalid */
  75     PA_STREAM_TERMINATED    /**< The stream has been terminated cleanly */
  76 } pa_stream_state_t;
  77
  78 /** Return non-zero if the passed state is one of the connected states. \since 0.9.11 */
  79 static inline int PA_STREAM_IS_GOOD(pa_stream_state_t x) {
  80     return
  81         x == PA_STREAM_CREATING ||
  82         x == PA_STREAM_READY;
  83 }
  84
  85 /** \cond fulldocs */
  86 #define PA_STREAM_UNCONNECTED PA_STREAM_UNCONNECTED
  87 #define PA_STREAM_CREATING PA_STREAM_CREATING
  88 #define PA_STREAM_READY PA_STREAM_READY
  89 #define PA_STREAM_FAILED PA_STREAM_FAILED
  90 #define PA_STREAM_TERMINATED PA_STREAM_TERMINATED
  91 #define PA_STREAM_IS_GOOD PA_STREAM_IS_GOOD
  92 /** \endcond */
  93
  94 /** The state of an operation */
  95 typedef enum pa_operation_state {
  96     PA_OPERATION_RUNNING,      /**< The operation is still running */
  97     PA_OPERATION_DONE,         /**< The operation has been completed */
  98     PA_OPERATION_CANCELED      /**< The operation has been canceled */
  99 } pa_operation_state_t;
 100
 101 /** \cond fulldocs */
 102 #define PA_OPERATION_RUNNING PA_OPERATION_RUNNING
 103 #define PA_OPERATION_DONE PA_OPERATION_DONE
 104 #define PA_OPERATION_CANCELED PA_OPERATION_CANCELED
 105 /** \endcond */
 106
 107 /** An invalid index */
 108 #define PA_INVALID_INDEX ((uint32_t) -1)
 109
 110 /** Some special flags for contexts. */
 111 typedef enum pa_context_flags {
 112     PA_CONTEXT_NOAUTOSPAWN = 1
 113     /**< Disabled autospawning of the PulseAudio daemon if required */
 114 } pa_context_flags_t;
 115
 116 /** \cond fulldocs */
 117 /* Allow clients to check with #ifdef for those flags */
 118 #define PA_CONTEXT_NOAUTOSPAWN PA_CONTEXT_NOAUTOSPAWN
 119 /** \endcond */
 120
 121 /** The direction of a pa_stream object */
 122 typedef enum pa_stream_direction {
 123     PA_STREAM_NODIRECTION,   /**< Invalid direction */
 124     PA_STREAM_PLAYBACK,      /**< Playback stream */
 125     PA_STREAM_RECORD,        /**< Record stream */
 126     PA_STREAM_UPLOAD         /**< Sample upload stream */
 127 } pa_stream_direction_t;
 128
 129 /** \cond fulldocs */
 130 #define PA_STREAM_NODIRECTION PA_STREAM_NODIRECTION
 131 #define PA_STREAM_PLAYBACK PA_STREAM_PLAYBACK
 132 #define PA_STREAM_RECORD PA_STREAM_RECORD
 133 #define PA_STREAM_UPLOAD PA_STREAM_UPLOAD
 134 /** \endcond */
 135
 136 /** Some special flags for stream connections. */
 137 typedef enum pa_stream_flags {
 138
 139     PA_STREAM_START_CORKED = 0x0001U,
 140     /**< Create the stream corked, requiring an explicit
 141      * pa_stream_cork() call to uncork it. */
 142
 143     PA_STREAM_INTERPOLATE_TIMING = 0x0002U,
 144     /**< Interpolate the latency for this stream. When enabled,
 145      * pa_stream_get_latency() and pa_stream_get_time() will try to
 146      * estimate the current record/playback time based on the local
 147      * time that passed since the last timing info update.  Using this
 148      * option has the advantage of not requiring a whole roundtrip
 149      * when the current playback/recording time is needed. Consider
 150      * using this option when requesting latency information
 151      * frequently. This is especially useful on long latency network
 152      * connections. It makes a lot of sense to combine this option
 153      * with PA_STREAM_AUTO_TIMING_UPDATE. */
 154
 155     PA_STREAM_NOT_MONOTONIC = 0x0004U,
 156     /**< Don't force the time to increase monotonically. If this
 157      * option is enabled, pa_stream_get_time() will not necessarily
 158      * return always monotonically increasing time values on each
 159      * call. This may confuse applications which cannot deal with time
 160      * going 'backwards', but has the advantage that bad transport
 161      * latency estimations that caused the time to to jump ahead can
 162      * be corrected quickly, without the need to wait. (Please note
 163      * that this flag was named PA_STREAM_NOT_MONOTONOUS in releases
 164      * prior to 0.9.11. The old name is still defined too, for
 165      * compatibility reasons. */
 166
 167     PA_STREAM_AUTO_TIMING_UPDATE = 0x0008U,
 168     /**< If set timing update requests are issued periodically
 169      * automatically. Combined with PA_STREAM_INTERPOLATE_TIMING you
 170      * will be able to query the current time and latency with
 171      * pa_stream_get_time() and pa_stream_get_latency() at all times
 172      * without a packet round trip.*/
 173
 174     PA_STREAM_NO_REMAP_CHANNELS = 0x0010U,
 175     /**< Don't remap channels by their name, instead map them simply
 176      * by their index. Implies PA_STREAM_NO_REMIX_CHANNELS. Only
 177      * supported when the server is at least PA 0.9.8. It is ignored
 178      * on older servers.\since 0.9.8 */
 179
 180     PA_STREAM_NO_REMIX_CHANNELS = 0x0020U,
 181     /**< When remapping channels by name, don't upmix or downmix them
 182      * to related channels. Copy them into matching channels of the
 183      * device 1:1. Only supported when the server is at least PA
 184      * 0.9.8. It is ignored on older servers. \since 0.9.8 */
 185
 186     PA_STREAM_FIX_FORMAT = 0x0040U,
 187     /**< Use the sample format of the sink/device this stream is being
 188      * connected to, and possibly ignore the format the sample spec
 189      * contains -- but you still have to pass a valid value in it as a
 190      * hint to PulseAudio what would suit your stream best. If this is
 191      * used you should query the used sample format after creating the
 192      * stream by using pa_stream_get_sample_spec(). Also, if you
 193      * specified manual buffer metrics it is recommended to update
 194      * them with pa_stream_set_buffer_attr() to compensate for the
 195      * changed frame sizes. Only supported when the server is at least
 196      * PA 0.9.8. It is ignored on older servers. \since 0.9.8 */
 197
 198     PA_STREAM_FIX_RATE = 0x0080U,
 199     /**< Use the sample rate of the sink, and possibly ignore the rate
 200      * the sample spec contains. Usage similar to
 201      * PA_STREAM_FIX_FORMAT.Only supported when the server is at least
 202      * PA 0.9.8. It is ignored on older servers. \since 0.9.8 */
 203
 204     PA_STREAM_FIX_CHANNELS = 0x0100,
 205     /**< Use the number of channels and the channel map of the sink,
 206      * and possibly ignore the number of channels and the map the
 207      * sample spec and the passed channel map contains. Usage similar
 208      * to PA_STREAM_FIX_FORMAT. Only supported when the server is at
 209      * least PA 0.9.8. It is ignored on older servers. \since 0.9.8 */
 210
 211     PA_STREAM_DONT_MOVE = 0x0200U,
 212     /**< Don't allow moving of this stream to another
 213      * sink/device. Useful if you use any of the PA_STREAM_FIX_ flags
 214      * and want to make sure that resampling never takes place --
 215      * which might happen if the stream is moved to another
 216      * sink/source whith a different sample spec/channel map. Only
 217      * supported when the server is at least PA 0.9.8. It is ignored
 218      * on older servers. \since 0.9.8 */
 219
 220     PA_STREAM_VARIABLE_RATE = 0x0400U,
 221     /**< Allow dynamic changing of the sampling rate during playback
 222      * with pa_stream_update_sample_rate(). Only supported when the
 223      * server is at least PA 0.9.8. It is ignored on older
 224      * servers. \since 0.9.8 */
 225
 226     PA_STREAM_PEAK_DETECT = 0x0800U,
 227     /**< Find peaks instead of resampling. \since 0.9.11 */
 228
 229     PA_STREAM_START_MUTED = 0x1000U,
 230     /**< Create in muted state. If neither PA_STREAM_START_UNMUTED nor
 231      * PA_STREAM_START_MUTED it is left to the server to decide
 232      * whether to create the stream in muted or in unmuted
 233      * state. \since 0.9.11 */
 234
 235     PA_STREAM_ADJUST_LATENCY = 0x2000U,
 236     /**< Try to adjust the latency of the sink/source based on the
 237      * requested buffer metrics and adjust buffer metrics
 238      * accordingly. Also see pa_buffer_attr. This option may not be
 239      * specified at the same time as PA_STREAM_EARLY_REQUESTS. \since
 240      * 0.9.11 */
 241
 242     PA_STREAM_EARLY_REQUESTS = 0x4000U,
 243     /**< Enable compatibility mode for legacy clients that rely on a
 244      * "classic" hardware device fragment-style playback model. If
 245      * this option is set, the minreq value of the buffer metrics gets
 246      * a new meaning: instead of just specifying that no requests
 247      * asking for less new data than this value will be made to the
 248      * client it will also guarantee that requests are generated as
 249      * early as this limit is reached. This flag should only be set in
 250      * very few situations where compatiblity with a fragment-based
 251      * playback model needs to be kept and the client applications
 252      * cannot deal with data requests that are delayed to the latest
 253      * moment possible. (Usually these are programs that use usleep()
 254      * or a similar call in their playback loops instead of sleeping
 255      * on the device itself.) Also see pa_buffer_attr. This option may
 256      * not be specified at the same time as
 257      * PA_STREAM_ADJUST_LATENCY. \since 0.9.12 */
 258
 259     PA_STREAM_DONT_INHIBIT_AUTO_SUSPEND = 0x8000U,
 260     /**< If set this stream won't be taken into account when we it is
 261      * checked whether the device this stream is connected to should
 262      * auto-suspend. \since 0.9.15 */
 263
 264     PA_STREAM_START_UNMUTED = 0x10000U,
 265     /**< Create in unmuted state. If neither PA_STREAM_START_UNMUTED
 266      * nor PA_STREAM_START_MUTED it is left to the server to decide
 267      * whether to create the stream in muted or in unmuted
 268      * state. \since 0.9.15 */
 269
 270     PA_STREAM_FAIL_ON_SUSPEND = 0x20000U
 271     /**< If the sink/source this stream is connected to is suspended
 272      * during the creation of this stream, cause it to fail. If the
 273      * sink/source is being suspended during creation of this stream,
 274      * make sure this stream is terminated. \since 0.9.15 */
 275 } pa_stream_flags_t;
 276
 277 /** \cond fulldocs */
 278
 279 /* English is an evil language */
 280 #define PA_STREAM_NOT_MONOTONOUS PA_STREAM_NOT_MONOTONIC
 281
 282 /* Allow clients to check with #ifdef for those flags */
 283 #define PA_STREAM_START_CORKED PA_STREAM_START_CORKED
 284 #define PA_STREAM_INTERPOLATE_TIMING PA_STREAM_INTERPOLATE_TIMING
 285 #define PA_STREAM_NOT_MONOTONIC PA_STREAM_NOT_MONOTONIC
 286 #define PA_STREAM_AUTO_TIMING_UPDATE PA_STREAM_AUTO_TIMING_UPDATE
 287 #define PA_STREAM_NO_REMAP_CHANNELS PA_STREAM_NO_REMAP_CHANNELS
 288 #define PA_STREAM_NO_REMIX_CHANNELS PA_STREAM_NO_REMIX_CHANNELS
 289 #define PA_STREAM_FIX_FORMAT PA_STREAM_FIX_FORMAT
 290 #define PA_STREAM_FIX_RATE PA_STREAM_FIX_RATE
 291 #define PA_STREAM_FIX_CHANNELS PA_STREAM_FIX_CHANNELS
 292 #define PA_STREAM_DONT_MOVE PA_STREAM_DONT_MOVE
 293 #define PA_STREAM_VARIABLE_RATE PA_STREAM_VARIABLE_RATE
 294 #define PA_STREAM_PEAK_DETECT PA_STREAM_PEAK_DETECT
 295 #define PA_STREAM_START_MUTED PA_STREAM_START_MUTED
 296 #define PA_STREAM_ADJUST_LATENCY PA_STREAM_ADJUST_LATENCY
 297 #define PA_STREAM_EARLY_REQUESTS PA_STREAM_EARLY_REQUESTS
 298 #define PA_STREAM_DONT_INHIBIT_AUTO_SUSPEND PA_STREAM_DONT_INHIBIT_AUTO_SUSPEND
 299 #define PA_STREAM_START_UNMUTED PA_STREAM_START_UNMUTED
 300 #define PA_STREAM_FAIL_ON_SUSPEND PA_STREAM_FAIL_ON_SUSPEND
 301
 302 /** \endcond */
 303
 304 /** Playback and record buffer metrics */
 305 typedef struct pa_buffer_attr {
 306     uint32_t maxlength;
 307     /**< Maximum length of the buffer. Setting this to (uint32_t) -1
 308      * will initialize this to the maximum value supported by server,
 309      * which is recommended. */
 310
 311     uint32_t tlength;
 312     /**< Playback only: target length of the buffer. The server tries
 313      * to assure that at least tlength bytes are always available in
 314      * the per-stream server-side playback buffer. It is recommended
 315      * to set this to (uint32_t) -1, which will initialize this to a
 316      * value that is deemed sensible by the server. However, this
 317      * value will default to something like 2s, i.e. for applications
 318      * that have specific latency requirements this value should be
 319      * set to the maximum latency that the application can deal
 320      * with. When PA_STREAM_ADJUST_LATENCY is not set this value will
 321      * influence only the per-stream playback buffer size. When
 322      * PA_STREAM_ADJUST_LATENCY is set the overall latency of the sink
 323      * plus the playback buffer size is configured to this value. Set
 324      * PA_STREAM_ADJUST_LATENCY if you are interested in adjusting the
 325      * overall latency. Don't set it if you are interested in
 326      * configuring the server-sider per-stream playback buffer
 327      * size. */
 328
 329     uint32_t prebuf;
 330     /**< Playback only: pre-buffering. The server does not start with
 331      * playback before at least prebug bytes are available in the
 332      * buffer. It is recommended to set this to (uint32_t) -1, which
 333      * will initialize this to the same value as tlength, whatever
 334      * that may be. Initialize to 0 to enable manual start/stop
 335      * control of the stream. This means that playback will not stop
 336      * on underrun and playback will not start automatically. Instead
 337      * pa_stream_corked() needs to be called explicitly. If you set
 338      * this value to 0 you should also set PA_STREAM_START_CORKED. */
 339
 340     uint32_t minreq;
 341     /**< Playback only: minimum request. The server does not request
 342      * less than minreq bytes from the client, instead waits until the
 343      * buffer is free enough to request more bytes at once. It is
 344      * recommended to set this to (uint32_t) -1, which will initialize
 345      * this to a value that is deemed sensible by the server. This
 346      * should be set to a value that gives PulseAudio enough time to
 347      * move the data from the per-stream playback buffer into the
 348      * hardware playback buffer. */
 349
 350     uint32_t fragsize;
 351     /**< Recording only: fragment size. The server sends data in
 352      * blocks of fragsize bytes size. Large values deminish
 353      * interactivity with other operations on the connection context
 354      * but decrease control overhead. It is recommended to set this to
 355      * (uint32_t) -1, which will initialize this to a value that is
 356      * deemed sensible by the server. However, this value will default
 357      * to something like 2s, i.e. for applications that have specific
 358      * latency requirements this value should be set to the maximum
 359      * latency that the application can deal with. If
 360      * PA_STREAM_ADJUST_LATENCY is set the overall source latency will
 361      * be adjusted according to this value. If it is not set the
 362      * source latency is left unmodified. */
 363
 364 } pa_buffer_attr;
 365
 366 /** Error values as used by pa_context_errno(). Use pa_strerror() to convert these values to human readable strings */
 367 enum {
 368     PA_OK = 0,                     /**< No error */
 369     PA_ERR_ACCESS,                 /**< Access failure */
 370     PA_ERR_COMMAND,                /**< Unknown command */
 371     PA_ERR_INVALID,                /**< Invalid argument */
 372     PA_ERR_EXIST,                  /**< Entity exists */
 373     PA_ERR_NOENTITY,               /**< No such entity */
 374     PA_ERR_CONNECTIONREFUSED,      /**< Connection refused */
 375     PA_ERR_PROTOCOL,               /**< Protocol error */
 376     PA_ERR_TIMEOUT,                /**< Timeout */
 377     PA_ERR_AUTHKEY,                /**< No authorization key */
 378     PA_ERR_INTERNAL,               /**< Internal error */
 379     PA_ERR_CONNECTIONTERMINATED,   /**< Connection terminated */
 380     PA_ERR_KILLED,                 /**< Entity killed */
 381     PA_ERR_INVALIDSERVER,          /**< Invalid server */
 382     PA_ERR_MODINITFAILED,          /**< Module initialization failed */
 383     PA_ERR_BADSTATE,               /**< Bad state */
 384     PA_ERR_NODATA,                 /**< No data */
 385     PA_ERR_VERSION,                /**< Incompatible protocol version */
 386     PA_ERR_TOOLARGE,               /**< Data too large */
 387     PA_ERR_NOTSUPPORTED,           /**< Operation not supported \since 0.9.5 */
 388     PA_ERR_UNKNOWN,                /**< The error code was unknown to the client */
 389     PA_ERR_NOEXTENSION,            /**< Extension does not exist. \since 0.9.12 */
 390     PA_ERR_OBSOLETE,               /**< Obsolete functionality. \since 0.9.15 */
 391     PA_ERR_NOTIMPLEMENTED,         /**< Missing implementation. \since 0.9.15 */
 392     PA_ERR_MAX                     /**< Not really an error but the first invalid error code */
 393 };
 394
 395 /** \cond fulldocs */
 396 #define PA_OK PA_OK
 397 #define PA_ERR_ACCESS PA_ERR_ACCESS
 398 #define PA_ERR_COMMAND PA_ERR_COMMAND
 399 #define PA_ERR_INVALID PA_ERR_INVALID
 400 #define PA_ERR_EXIST PA_ERR_EXIST
 401 #define PA_ERR_NOENTITY PA_ERR_NOENTITY
 402 #define PA_ERR_CONNECTIONREFUSED PA_ERR_CONNECTIONREFUSED
 403 #define PA_ERR_PROTOCOL PA_ERR_PROTOCOL
 404 #define PA_ERR_TIMEOUT PA_ERR_TIMEOUT
 405 #define PA_ERR_AUTHKEY PA_ERR_AUTHKEY
 406 #define PA_ERR_INTERNAL PA_ERR_INTERNAL
 407 #define PA_ERR_CONNECTIONTERMINATED PA_ERR_CONNECTIONTERMINATED
 408 #define PA_ERR_KILLED PA_ERR_KILLED
 409 #define PA_ERR_INVALIDSERVER PA_ERR_INVALIDSERVER
 410 #define PA_ERR_MODINITFAILED PA_ERR_MODINITFAILED
 411 #define PA_ERR_BADSTATE PA_ERR_BADSTATE
 412 #define PA_ERR_NODATA PA_ERR_NODATA
 413 #define PA_ERR_VERSION PA_ERR_VERSION
 414 #define PA_ERR_TOOLARGE PA_ERR_TOOLARGE
 415 #define PA_ERR_NOTSUPPORTED PA_ERR_NOTSUPPORTED
 416 #define PA_ERR_UNKNOWN PA_ERR_UNKNOWN
 417 #define PA_ERR_NOEXTENSION PA_ERR_NOEXTENSION
 418 #define PA_ERR_OBSOLETE PA_ERR_OBSOLETE
 419 #define PA_ERR_NOTIMPLEMENTED PA_ERR_NOTIMPLEMENTED
 420 #define PA_ERR_MAX PA_ERR_MAX
 421 /** \endcond */
 422
 423 /** Subscription event mask, as used by pa_context_subscribe() */
 424 typedef enum pa_subscription_mask {
 425     PA_SUBSCRIPTION_MASK_NULL = 0x0000U,
 426     /**< No events */
 427
 428     PA_SUBSCRIPTION_MASK_SINK = 0x0001U,
 429     /**< Sink events */
 430
 431     PA_SUBSCRIPTION_MASK_SOURCE = 0x0002U,
 432     /**< Source events */
 433
 434     PA_SUBSCRIPTION_MASK_SINK_INPUT = 0x0004U,
 435     /**< Sink input events */
 436
 437     PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT = 0x0008U,
 438     /**< Source output events */
 439
 440     PA_SUBSCRIPTION_MASK_MODULE = 0x0010U,
 441     /**< Module events */
 442
 443     PA_SUBSCRIPTION_MASK_CLIENT = 0x0020U,
 444     /**< Client events */
 445
 446     PA_SUBSCRIPTION_MASK_SAMPLE_CACHE = 0x0040U,
 447     /**< Sample cache events */
 448
 449     PA_SUBSCRIPTION_MASK_SERVER = 0x0080U,
 450     /**< Other global server changes. */
 451
 452 /** \cond fulldocs */
 453     PA_SUBSCRIPTION_MASK_AUTOLOAD = 0x0100U,
 454     /**< \deprecated Autoload table events. */
 455 /** \endcond */
 456
 457     PA_SUBSCRIPTION_MASK_CARD = 0x0200U,
 458     /**< Card events. \since 0.9.15 */
 459
 460     PA_SUBSCRIPTION_MASK_ALL = 0x02ffU
 461     /**< Catch all events */
 462 } pa_subscription_mask_t;
 463
 464 /** Subscription event types, as used by pa_context_subscribe() */
 465 typedef enum pa_subscription_event_type {
 466     PA_SUBSCRIPTION_EVENT_SINK = 0x0000U,
 467     /**< Event type: Sink */
 468
 469     PA_SUBSCRIPTION_EVENT_SOURCE = 0x0001U,
 470     /**< Event type: Source */
 471
 472     PA_SUBSCRIPTION_EVENT_SINK_INPUT = 0x0002U,
 473     /**< Event type: Sink input */
 474
 475     PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT = 0x0003U,
 476     /**< Event type: Source output */
 477
 478     PA_SUBSCRIPTION_EVENT_MODULE = 0x0004U,
 479     /**< Event type: Module */
 480
 481     PA_SUBSCRIPTION_EVENT_CLIENT = 0x0005U,
 482     /**< Event type: Client */
 483
 484     PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE = 0x0006U,
 485     /**< Event type: Sample cache item */
 486
 487     PA_SUBSCRIPTION_EVENT_SERVER = 0x0007U,
 488     /**< Event type: Global server change, only occuring with PA_SUBSCRIPTION_EVENT_CHANGE. */
 489
 490 /** \cond fulldocs */
 491     PA_SUBSCRIPTION_EVENT_AUTOLOAD = 0x0008U,
 492     /**< \deprecated Event type: Autoload table changes. */
 493 /** \endcond */
 494
 495     PA_SUBSCRIPTION_EVENT_CARD = 0x0009U,
 496     /**< Event type: Card \since 0.9.15 */
 497
 498     PA_SUBSCRIPTION_EVENT_FACILITY_MASK = 0x000FU,
 499     /**< A mask to extract the event type from an event value */
 500
 501     PA_SUBSCRIPTION_EVENT_NEW = 0x0000U,
 502     /**< A new object was created */
 503
 504     PA_SUBSCRIPTION_EVENT_CHANGE = 0x0010U,
 505     /**< A property of the object was modified */
 506
 507     PA_SUBSCRIPTION_EVENT_REMOVE = 0x0020U,
 508     /**< An object was removed */
 509
 510     PA_SUBSCRIPTION_EVENT_TYPE_MASK = 0x0030U
 511     /**< A mask to extract the event operation from an event value */
 512
 513 } pa_subscription_event_type_t;
 514
 515 /** Return one if an event type t matches an event mask bitfield */
 516 #define pa_subscription_match_flags(m, t) (!!((m) & (1 << ((t) & PA_SUBSCRIPTION_EVENT_FACILITY_MASK))))
 517
 518 /** \cond fulldocs */
 519 #define PA_SUBSCRIPTION_MASK_NULL PA_SUBSCRIPTION_MASK_NULL
 520 #define PA_SUBSCRIPTION_MASK_SINK PA_SUBSCRIPTION_MASK_SINK
 521 #define PA_SUBSCRIPTION_MASK_SOURCE PA_SUBSCRIPTION_MASK_SOURCE
 522 #define PA_SUBSCRIPTION_MASK_SINK_INPUT PA_SUBSCRIPTION_MASK_SINK_INPUT
 523 #define PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT
 524 #define PA_SUBSCRIPTION_MASK_MODULE PA_SUBSCRIPTION_MASK_MODULE
 525 #define PA_SUBSCRIPTION_MASK_CLIENT PA_SUBSCRIPTION_MASK_CLIENT
 526 #define PA_SUBSCRIPTION_MASK_SAMPLE_CACHE PA_SUBSCRIPTION_MASK_SAMPLE_CACHE
 527 #define PA_SUBSCRIPTION_MASK_SERVER PA_SUBSCRIPTION_MASK_SERVER
 528 #define PA_SUBSCRIPTION_MASK_AUTOLOAD PA_SUBSCRIPTION_MASK_AUTOLOAD
 529 #define PA_SUBSCRIPTION_MASK_CARD PA_SUBSCRIPTION_MASK_CARD
 530 #define PA_SUBSCRIPTION_MASK_ALL PA_SUBSCRIPTION_MASK_ALL
 531 #define PA_SUBSCRIPTION_EVENT_SINK PA_SUBSCRIPTION_EVENT_SINK
 532 #define PA_SUBSCRIPTION_EVENT_SOURCE PA_SUBSCRIPTION_EVENT_SOURCE
 533 #define PA_SUBSCRIPTION_EVENT_SINK_INPUT PA_SUBSCRIPTION_EVENT_SINK_INPUT
 534 #define PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
 535 #define PA_SUBSCRIPTION_EVENT_MODULE PA_SUBSCRIPTION_EVENT_MODULE
 536 #define PA_SUBSCRIPTION_EVENT_CLIENT PA_SUBSCRIPTION_EVENT_CLIENT
 537 #define PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE
 538 #define PA_SUBSCRIPTION_EVENT_SERVER PA_SUBSCRIPTION_EVENT_SERVER
 539 #define PA_SUBSCRIPTION_EVENT_AUTOLOAD PA_SUBSCRIPTION_EVENT_AUTOLOAD
 540 #define PA_SUBSCRIPTION_EVENT_CARD PA_SUBSCRIPTION_EVENT_CARD
 541 #define PA_SUBSCRIPTION_EVENT_FACILITY_MASK PA_SUBSCRIPTION_EVENT_FACILITY_MASK
 542 #define PA_SUBSCRIPTION_EVENT_NEW PA_SUBSCRIPTION_EVENT_NEW
 543 #define PA_SUBSCRIPTION_EVENT_CHANGE PA_SUBSCRIPTION_EVENT_CHANGE
 544 #define PA_SUBSCRIPTION_EVENT_REMOVE PA_SUBSCRIPTION_EVENT_REMOVE
 545 #define PA_SUBSCRIPTION_EVENT_TYPE_MASK PA_SUBSCRIPTION_EVENT_TYPE_MASK
 546 /** \endcond */
 547
 548 /** A structure for all kinds of timing information of a stream. See
 549  * pa_stream_update_timing_info() and pa_stream_get_timing_info(). The
 550  * total output latency a sample that is written with
 551  * pa_stream_write() takes to be played may be estimated by
 552  * sink_usec+buffer_usec+transport_usec. (where buffer_usec is defined
 553  * as pa_bytes_to_usec(write_index-read_index)) The output buffer
 554  * which buffer_usec relates to may be manipulated freely (with
 555  * pa_stream_write()'s seek argument, pa_stream_flush() and friends),
 556  * the buffers sink_usec and source_usec relate to are first-in
 557  * first-out (FIFO) buffers which cannot be flushed or manipulated in
 558  * any way. The total input latency a sample that is recorded takes to
 559  * be delivered to the application is:
 560  * source_usec+buffer_usec+transport_usec-sink_usec. (Take care of
 561  * sign issues!) When connected to a monitor source sink_usec contains
 562  * the latency of the owning sink. The two latency estimations
 563  * described here are implemented in pa_stream_get_latency(). Please
 564  * note that this structure can be extended as part of evolutionary
 565  * API updates at any time in any new release.*/
 566 typedef struct pa_timing_info {
 567     struct timeval timestamp;
 568     /**< The time when this timing info structure was current */
 569
 570     int synchronized_clocks;
 571     /**< Non-zero if the local and the remote machine have
 572      * synchronized clocks. If synchronized clocks are detected
 573      * transport_usec becomes much more reliable. However, the code
 574      * that detects synchronized clocks is very limited und unreliable
 575      * itself. */
 576
 577     pa_usec_t sink_usec;
 578     /**< Time in usecs a sample takes to be played on the sink. For
 579      * playback streams and record streams connected to a monitor
 580      * source. */
 581
 582     pa_usec_t source_usec;
 583     /**< Time in usecs a sample takes from being recorded to being
 584      * delivered to the application. Only for record streams. */
 585
 586     pa_usec_t transport_usec;
 587     /**< Estimated time in usecs a sample takes to be transferred
 588      * to/from the daemon. For both playback and record streams. */
 589
 590     int playing;
 591     /**< Non-zero when the stream is currently not underrun and data
 592      * is being passed on to the device. Only for playback
 593      * streams. This field does not say whether the data is actually
 594      * already being played. To determine this check whether
 595      * since_underrun (converted to usec) is larger than sink_usec.*/
 596
 597     int write_index_corrupt;
 598     /**< Non-zero if write_index is not up-to-date because a local
 599      * write command that corrupted it has been issued in the time
 600      * since this latency info was current . Only write commands with
 601      * SEEK_RELATIVE_ON_READ and SEEK_RELATIVE_END can corrupt
 602      * write_index. */
 603
 604     int64_t write_index;
 605     /**< Current write index into the playback buffer in bytes. Think
 606      * twice before using this for seeking purposes: it might be out
 607      * of date a the time you want to use it. Consider using
 608      * PA_SEEK_RELATIVE instead. */
 609
 610     int read_index_corrupt;
 611     /**< Non-zero if read_index is not up-to-date because a local
 612      * pause or flush request that corrupted it has been issued in the
 613      * time since this latency info was current. */
 614
 615     int64_t read_index;
 616     /**< Current read index into the playback buffer in bytes. Think
 617      * twice before using this for seeking purposes: it might be out
 618      * of date a the time you want to use it. Consider using
 619      * PA_SEEK_RELATIVE_ON_READ instead. */
 620
 621     pa_usec_t configured_sink_usec;
 622     /**< The configured latency for the sink. \since 0.9.11 */
 623
 624     pa_usec_t configured_source_usec;
 625     /**< The configured latency for * the source. \since 0.9.11 */
 626
 627     int64_t since_underrun;
 628     /**< Bytes that were handed to the sink since the last underrun
 629      * happened, or since playback started again after the last
 630      * underrun. playing will tell you which case it is. \since
 631      * 0.9.11 */
 632
 633 } pa_timing_info;
 634
 635 /** A structure for the spawn api. This may be used to integrate auto
 636  * spawned daemons into your application. For more information see
 637  * pa_context_connect(). When spawning a new child process the
 638  * waitpid() is used on the child's PID. The spawn routine will not
 639  * block or ignore SIGCHLD signals, since this cannot be done in a
 640  * thread compatible way. You might have to do this in
 641  * prefork/postfork. */
 642 typedef struct pa_spawn_api {
 643     void (*prefork)(void);
 644     /**< Is called just before the fork in the parent process. May be
 645      * NULL. */
 646
 647     void (*postfork)(void);
 648     /**< Is called immediately after the fork in the parent
 649      * process. May be NULL.*/
 650
 651     void (*atfork)(void);
 652     /**< Is called immediately after the fork in the child
 653      * process. May be NULL. It is not safe to close all file
 654      * descriptors in this function unconditionally, since a UNIX
 655      * socket (created using socketpair()) is passed to the new
 656      * process. */
 657 } pa_spawn_api;
 658
 659 /** Seek type for pa_stream_write(). */
 660 typedef enum pa_seek_mode {
 661     PA_SEEK_RELATIVE = 0,
 662     /**< Seek relatively to the write index */
 663
 664     PA_SEEK_ABSOLUTE = 1,
 665     /**< Seek relatively to the start of the buffer queue */
 666
 667     PA_SEEK_RELATIVE_ON_READ = 2,
 668     /**< Seek relatively to the read index.  */
 669
 670     PA_SEEK_RELATIVE_END = 3
 671     /**< Seek relatively to the current end of the buffer queue. */
 672 } pa_seek_mode_t;
 673
 674 /** \cond fulldocs */
 675 #define PA_SEEK_RELATIVE PA_SEEK_RELATIVE
 676 #define PA_SEEK_ABSOLUTE PA_SEEK_ABSOLUTE
 677 #define PA_SEEK_RELATIVE_ON_READ PA_SEEK_RELATIVE_ON_READ
 678 #define PA_SEEK_RELATIVE_END PA_SEEK_RELATIVE_END
 679 /** \endcond */
 680
 681 /** Special sink flags. */
 682 typedef enum pa_sink_flags {
 683     PA_SINK_HW_VOLUME_CTRL = 0x0001U,
 684     /**< Supports hardware volume control */
 685
 686     PA_SINK_LATENCY = 0x0002U,
 687     /**< Supports latency querying */
 688
 689     PA_SINK_HARDWARE = 0x0004U,
 690     /**< Is a hardware sink of some kind, in contrast to
 691      * "virtual"/software sinks \since 0.9.3 */
 692
 693     PA_SINK_NETWORK = 0x0008U,
 694     /**< Is a networked sink of some kind. \since 0.9.7 */
 695
 696     PA_SINK_HW_MUTE_CTRL = 0x0010U,
 697     /**< Supports hardware mute control \since 0.9.11 */
 698
 699     PA_SINK_DECIBEL_VOLUME = 0x0020U,
 700     /**< Volume can be translated to dB with pa_sw_volume_to_dB()
 701      * \since 0.9.11 */
 702
 703     PA_SINK_FLAT_VOLUME = 0x0040U
 704     /**< This sink is in flat volume mode, i.e. always the maximum of
 705      * the volume of all connected inputs. \since 0.9.15 */
 706 } pa_sink_flags_t;
 707
 708 /** \cond fulldocs */
 709 #define PA_SINK_HW_VOLUME_CTRL PA_SINK_HW_VOLUME_CTRL
 710 #define PA_SINK_LATENCY PA_SINK_LATENCY
 711 #define PA_SINK_HARDWARE PA_SINK_HARDWARE
 712 #define PA_SINK_NETWORK PA_SINK_NETWORK
 713 #define PA_SINK_HW_MUTE_CTRL PA_SINK_HW_MUTE_CTRL
 714 #define PA_SINK_DECIBEL_VOLUME PA_SINK_DECIBEL_VOLUME
 715 #define PA_SINK_FLAT_VOLUME PA_SINK_FLAT_VOLUME
 716 /** \endcond */
 717
 718 /** Sink state. \since 0.9.15 */
 719 typedef enum pa_sink_state { /* enum serialized in u8 */
 720     PA_SINK_INVALID_STATE = -1,
 721     /**< This state is used when the server does not support sink state introspection \since 0.9.15 */
 722
 723     PA_SINK_RUNNING = 0,
 724     /**< Running, sink is playing and used by at least one non-corked sink-input \since 0.9.15 */
 725
 726     PA_SINK_IDLE = 1,
 727     /**< When idle, the sink is playing but there is no non-corked sink-input attached to it \since 0.9.15 */
 728
 729     PA_SINK_SUSPENDED = 2,
 730     /**< When suspended, actual sink access can be closed, for instance \since 0.9.15 */
 731
 732 /** \cond fulldocs */
 733     /* PRIVATE: Server-side values -- DO NOT USE THIS ON THE CLIENT
 734      * SIDE! These values are *not* considered part of the official PA
 735      * API/ABI. If you use them your application might break when PA
 736      * is upgraded. Also, please note that these values are not useful
 737      * on the client side anyway. */
 738
 739     PA_SINK_INIT = -2,
 740     /**< Initialization state */
 741
 742     PA_SINK_UNLINKED = -3
 743     /**< The state when the sink is getting unregistered and removed from client access */
 744 /** \endcond */
 745
 746 } pa_sink_state_t;
 747
 748 /** Returns non-zero if sink is playing: running or idle. \since 0.9.15 */
 749 static inline int PA_SINK_IS_OPENED(pa_sink_state_t x) {
 750     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE;
 751 }
 752
 753 /** \cond fulldocs */
 754 #define PA_SINK_INVALID_STATE PA_SINK_INVALID_STATE
 755 #define PA_SINK_RUNNING PA_SINK_RUNNING
 756 #define PA_SINK_IDLE PA_SINK_IDLE
 757 #define PA_SINK_SUSPENDED PA_SINK_SUSPENDED
 758 #define PA_SINK_INIT PA_SINK_INIT
 759 #define PA_SINK_UNLINKED PA_SINK_UNLINKED
 760 #define PA_SINK_IS_OPENED PA_SINK_IS_OPENED
 761 /** \endcond */
 762
 763 /** Special source flags.  */
 764 typedef enum pa_source_flags {
 765     PA_SOURCE_HW_VOLUME_CTRL = 0x0001U,
 766     /**< Supports hardware volume control */
 767
 768     PA_SOURCE_LATENCY = 0x0002U,
 769     /**< Supports latency querying */
 770
 771     PA_SOURCE_HARDWARE = 0x0004U,
 772     /**< Is a hardware source of some kind, in contrast to
 773      * "virtual"/software source \since 0.9.3 */
 774
 775     PA_SOURCE_NETWORK = 0x0008U,
 776     /**< Is a networked source of some kind. \since 0.9.7 */
 777
 778     PA_SOURCE_HW_MUTE_CTRL = 0x0010U,
 779     /**< Supports hardware mute control \since 0.9.11 */
 780
 781     PA_SOURCE_DECIBEL_VOLUME = 0x0020U
 782     /**< Volume can be translated to dB with pa_sw_volume_to_dB()
 783      * \since 0.9.11 */
 784 } pa_source_flags_t;
 785
 786 /** \cond fulldocs */
 787 #define PA_SOURCE_HW_VOLUME_CTRL PA_SOURCE_HW_VOLUME_CTRL
 788 #define PA_SOURCE_LATENCY PA_SOURCE_LATENCY
 789 #define PA_SOURCE_HARDWARE PA_SOURCE_HARDWARE
 790 #define PA_SOURCE_NETWORK PA_SOURCE_NETWORK
 791 #define PA_SOURCE_HW_MUTE_CTRL PA_SOURCE_HW_MUTE_CTRL
 792 #define PA_SOURCE_DECIBEL_VOLUME PA_SOURCE_DECIBEL_VOLUME
 793 /** \endcond */
 794
 795 /** Source state. \since 0.9.15 */
 796 typedef enum pa_source_state {
 797     PA_SOURCE_INVALID_STATE = -1,
 798     /**< This state is used when the server does not support source state introspection \since 0.9.15 */
 799
 800     PA_SOURCE_RUNNING = 0,
 801     /**< Running, source is recording and used by at least one non-corked source-output \since 0.9.15 */
 802
 803     PA_SOURCE_IDLE = 1,
 804     /**< When idle, the source is still recording but there is no non-corked source-output \since 0.9.15 */
 805
 806     PA_SOURCE_SUSPENDED = 2,
 807     /**< When suspended, actual source access can be closed, for instance \since 0.9.15 */
 808
 809 /** \cond fulldocs */
 810     /* PRIVATE: Server-side values -- DO NOT USE THIS ON THE CLIENT
 811      * SIDE! These values are *not* considered part of the official PA
 812      * API/ABI. If you use them your application might break when PA
 813      * is upgraded. Also, please note that these values are not useful
 814      * on the client side anyway. */
 815
 816     PA_SOURCE_INIT = -2,
 817     /**< Initialization state */
 818
 819     PA_SOURCE_UNLINKED = -3
 820     /**< The state when the source is getting unregistered and removed from client access */
 821 /** \endcond */
 822
 823 } pa_source_state_t;
 824
 825 /** Returns non-zero if source is recording: running or idle. \since 0.9.15 */
 826 static inline int PA_SOURCE_IS_OPENED(pa_source_state_t x) {
 827     return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE;
 828 }
 829
 830 /** \cond fulldocs */
 831 #define PA_SOURCE_INVALID_STATE PA_SOURCE_INVALID_STATE
 832 #define PA_SOURCE_RUNNING PA_SOURCE_RUNNING
 833 #define PA_SOURCE_IDLE PA_SOURCE_IDLE
 834 #define PA_SOURCE_SUSPENDED PA_SOURCE_SUSPENDED
 835 #define PA_SOURCE_INIT PA_SOURCE_INIT
 836 #define PA_SOURCE_UNLINKED PA_SOURCE_UNLINKED
 837 #define PA_SOURCE_IS_OPENED PA_SOURCE_IS_OPENED
 838 /** \endcond */
 839
 840 /** A generic free() like callback prototype */
 841 typedef void (*pa_free_cb_t)(void *p);
 842
 843 /** A stream policy/meta event requesting that an application should
 844  * cork a specific stream. See pa_stream_event_cb_t for more
 845  * information, \since 0.9.15 */
 846 #define PA_STREAM_EVENT_REQUEST_CORK "request-cork"
 847
 848 /** A stream policy/meta event requesting that an application should
 849  * cork a specific stream. See pa_stream_event_cb_t for more
 850  * information, \since 0.9.15 */
 851 #define PA_STREAM_EVENT_REQUEST_UNCORK "request-uncork"
 852
 853 PA_C_DECL_END
 854
 855 #endif