mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-10-29 05:40:23 -04:00
f5d47a293a
native protocol: add "local" field to pa_context add volume paramter to pa_stream_connect_playback add support for renaming streams/clients support lazy samples add functions to kill clients/source inputs/sink outputs add functions for loading/unloading modules add autoload management API git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@204 fefdeb5f-60dc-0310-8127-8f9354f1896f
181 lines
9.4 KiB
C
181 lines
9.4 KiB
C
#ifndef foopolyplibdefhfoo
|
|
#define foopolyplibdefhfoo
|
|
|
|
/* $Id$ */
|
|
|
|
/***
|
|
This file is part of polypaudio.
|
|
|
|
polypaudio is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published
|
|
by the Free Software Foundation; either version 2 of the License,
|
|
or (at your option) any later version.
|
|
|
|
polypaudio is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with polypaudio; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
USA.
|
|
***/
|
|
|
|
#include <inttypes.h>
|
|
#include "cdecl.h"
|
|
#include "sample.h"
|
|
|
|
/** \file
|
|
* Global definitions */
|
|
|
|
PA_C_DECL_BEGIN
|
|
|
|
/** The state of a connection context */
|
|
enum pa_context_state {
|
|
PA_CONTEXT_UNCONNECTED, /**< The context hasn't been connected yet */
|
|
PA_CONTEXT_CONNECTING, /**< A connection is being established */
|
|
PA_CONTEXT_AUTHORIZING, /**< The client is authorizing itself to the daemon */
|
|
PA_CONTEXT_SETTING_NAME, /**< The client is passing its application name to the daemon */
|
|
PA_CONTEXT_READY, /**< The connection is established, the context is ready to execute operations */
|
|
PA_CONTEXT_FAILED, /**< The connection failed or was disconnected */
|
|
PA_CONTEXT_TERMINATED /**< The connection was terminated cleanly */
|
|
};
|
|
|
|
/** The state of a stream */
|
|
enum pa_stream_state {
|
|
PA_STREAM_DISCONNECTED, /**< The stream is not yet connected to any sink or source */
|
|
PA_STREAM_CREATING, /**< The stream is being created */
|
|
PA_STREAM_READY, /**< The stream is established, you may pass audio data to it now */
|
|
PA_STREAM_FAILED, /**< An error occured that made the stream invalid */
|
|
PA_STREAM_TERMINATED /**< The stream has been terminated cleanly */
|
|
};
|
|
|
|
/** The state of an operation */
|
|
enum pa_operation_state {
|
|
PA_OPERATION_RUNNING, /**< The operation is still running */
|
|
PA_OPERATION_DONE, /**< The operation has been completed */
|
|
PA_OPERATION_CANCELED /**< The operation has been canceled */
|
|
};
|
|
|
|
/** An invalid index */
|
|
#define PA_INVALID_INDEX ((uint32_t) -1)
|
|
|
|
/** The direction of a pa_stream object */
|
|
enum pa_stream_direction {
|
|
PA_STREAM_NODIRECTION, /**< Invalid direction */
|
|
PA_STREAM_PLAYBACK, /**< Playback stream */
|
|
PA_STREAM_RECORD, /**< Record stream */
|
|
PA_STREAM_UPLOAD /**< Sample upload stream */
|
|
};
|
|
|
|
/** Playback and record buffer metrics */
|
|
struct pa_buffer_attr{
|
|
uint32_t maxlength; /**< Maximum length of the buffer */
|
|
uint32_t tlength; /**< Playback only: target length of the buffer. The server tries to assure that at least tlength bytes are always available in the buffer */
|
|
uint32_t prebuf; /**< Playback only: pre-buffering. The server does not start with playback before at least prebug bytes are available in the buffer */
|
|
uint32_t minreq; /**< Playback only: minimum request. The server does not request less than minreq bytes from the client, instead waints until the buffer is free enough to request more bytes at once */
|
|
uint32_t fragsize; /**< Recording only: fragment size. The server sends data in blocks of fragsize bytes size. Large values deminish interactivity with other operations on the connection context but decrease control overhead. */
|
|
};
|
|
|
|
/** Error values as used by pa_context_errno(). Use pa_strerror() to convert these values to human readable strings */
|
|
enum {
|
|
PA_ERROR_OK, /**< No error */
|
|
PA_ERROR_ACCESS, /**< Access failure */
|
|
PA_ERROR_COMMAND, /**< Unknown command */
|
|
PA_ERROR_INVALID, /**< Invalid argument */
|
|
PA_ERROR_EXIST, /**< Entity exists */
|
|
PA_ERROR_NOENTITY, /**< No such entity */
|
|
PA_ERROR_CONNECTIONREFUSED, /**< Connection refused */
|
|
PA_ERROR_PROTOCOL, /**< Protocol error */
|
|
PA_ERROR_TIMEOUT, /**< Timeout */
|
|
PA_ERROR_AUTHKEY, /**< No authorization key */
|
|
PA_ERROR_INTERNAL, /**< Internal error */
|
|
PA_ERROR_CONNECTIONTERMINATED, /**< Connection terminated */
|
|
PA_ERROR_KILLED, /**< Entity killed */
|
|
PA_ERROR_INVALIDSERVER, /**< Invalid server */
|
|
PA_ERROR_INITFAILED, /**< Module initialization failed */
|
|
PA_ERROR_MAX /**< Not really an error but the first invalid error code */
|
|
};
|
|
|
|
/** Subscription event mask, as used by pa_context_subscribe() */
|
|
enum pa_subscription_mask {
|
|
PA_SUBSCRIPTION_MASK_NULL = 0, /**< No events */
|
|
PA_SUBSCRIPTION_MASK_SINK = 1, /**< Sink events */
|
|
PA_SUBSCRIPTION_MASK_SOURCE = 2, /**< Source events */
|
|
PA_SUBSCRIPTION_MASK_SINK_INPUT = 4, /**< Sink input events */
|
|
PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT = 8, /**< Source output events */
|
|
PA_SUBSCRIPTION_MASK_MODULE = 16, /**< Module events */
|
|
PA_SUBSCRIPTION_MASK_CLIENT = 32, /**< Client events */
|
|
PA_SUBSCRIPTION_MASK_SAMPLE_CACHE = 64, /**< Sample cache events */
|
|
PA_SUBSCRIPTION_MASK_SERVER = 128 /**< Other global server changes. \since 0.4 */
|
|
};
|
|
|
|
/** Subscription event types, as used by pa_context_subscribe() */
|
|
enum pa_subscription_event_type {
|
|
PA_SUBSCRIPTION_EVENT_SINK = 0, /**< Event type: Sink */
|
|
PA_SUBSCRIPTION_EVENT_SOURCE = 1, /**< Event type: Source */
|
|
PA_SUBSCRIPTION_EVENT_SINK_INPUT = 2, /**< Event type: Sink input */
|
|
PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT = 3, /**< Event type: Source output */
|
|
PA_SUBSCRIPTION_EVENT_MODULE = 4, /**< Event type: Module */
|
|
PA_SUBSCRIPTION_EVENT_CLIENT = 5, /**< Event type: Client */
|
|
PA_SUBSCRIPTION_EVENT_SAMPLE_CACHE = 6, /**< Event type: Sample cache item */
|
|
PA_SUBSCRIPTION_EVENT_SERVER = 7, /**< Event type: Global server change, only occuring with PA_SUBSCRIPTION_EVENT_CHANGE. \since 0.4 */
|
|
PA_SUBSCRIPTION_EVENT_FACILITY_MASK = 7, /**< A mask to extract the event type from an event value */
|
|
|
|
PA_SUBSCRIPTION_EVENT_NEW = 0, /**< A new object was created */
|
|
PA_SUBSCRIPTION_EVENT_CHANGE = 16, /**< A property of the object was modified */
|
|
PA_SUBSCRIPTION_EVENT_REMOVE = 32, /**< An object was removed */
|
|
PA_SUBSCRIPTION_EVENT_TYPE_MASK = 16+32 /**< A mask to extract the event operation from an event value */
|
|
};
|
|
|
|
/** Return one if an event type t matches an event mask bitfield */
|
|
#define pa_subscription_match_flags(m, t) (!!((m) & (1 << ((t) & PA_SUBSCRIPTION_EVENT_FACILITY_MASK))))
|
|
|
|
/** A structure for latency info. See pa_stream_get_latency(). The
|
|
* total latency a sample that is written with pa_stream_write() takes
|
|
* to be played may be estimated by
|
|
* buffer_usec+sink_usec+transport_usec. The buffer to which
|
|
* buffer_usec relates may be manipulated freely (with
|
|
* pa_stream_write()'s delta argument, pa_stream_flush() and friends),
|
|
* the playback buffer sink_usec relates to is a FIFO which cannot be
|
|
* flushed or manipulated in any way. */
|
|
struct pa_latency_info {
|
|
pa_usec_t buffer_usec; /**< Time in usecs the current buffer takes to play */
|
|
pa_usec_t sink_usec; /**< Time in usecs a sample takes to be played on the sink. */
|
|
pa_usec_t transport_usec; /**< Estimated time in usecs a sample takes to be transferred to the daemon. \since 0.5 */
|
|
int playing; /**< Non-zero when the stream is currently playing */
|
|
uint32_t queue_length; /**< Queue size in bytes. */
|
|
int synchronized_clocks; /**< Non-zero if the local and the
|
|
* remote machine have synchronized
|
|
* clocks. If synchronized clocks are
|
|
* detected transport_usec becomes much
|
|
* more reliable. However, the code that
|
|
* detects synchronized clocks is very
|
|
* limited und unreliable itself. \since
|
|
* 0.5 */
|
|
struct timeval timestamp; /**< The time when this latency info was current */
|
|
};
|
|
|
|
/** A structure for the spawn api. This may be used to integrate auto
|
|
* spawned daemons into your application. For more information see
|
|
* pa_context_connect(). When spawning a new child process the
|
|
* waitpid() is used on the child's PID. The spawn routine will not
|
|
* block or ignore SIGCHLD signals, since this cannot be done in a
|
|
* thread compatible way. You might have to do this in
|
|
* prefork/postfork. \since 0.4 */
|
|
struct pa_spawn_api {
|
|
void (*prefork)(void); /**< Is called just before the fork in the parent process. May be NULL. */
|
|
void (*postfork)(void); /**< Is called immediately after the fork in the parent process. May be NULL.*/
|
|
void (*atfork)(void); /**< Is called immediately after the
|
|
* fork in the child process. May be
|
|
* NULL. It is not safe to close all
|
|
* file descriptors in this function
|
|
* unconditionally, since a UNIX socket
|
|
* (created using socketpair()) is
|
|
* passed to the new process. */
|
|
};
|
|
|
|
PA_C_DECL_END
|
|
|
|
#endif
|