X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2Fpulse%2Fdef.h;h=d3481474020cd63282714f484cdf5faaa33ac718;hb=7c03c5f6ff5aa1ef3185c6fec544ab14847e2ee1;hp=82106ef8d9c74e1de3ab8efde96abf737097c445;hpb=6dfb1ee27e031528891696c83230d4513c55b554;p=profile%2Fivi%2Fpulseaudio.git diff --git a/src/pulse/def.h b/src/pulse/def.h index 82106ef..d348147 100644 --- a/src/pulse/def.h +++ b/src/pulse/def.h @@ -25,7 +25,6 @@ #include #include -#include #include #include @@ -125,6 +124,31 @@ typedef enum pa_context_flags { #define PA_CONTEXT_NOFAIL PA_CONTEXT_NOFAIL /** \endcond */ +/** Direction bitfield - while we currently do not expose anything bidirectional, + one should test against the bit instead of the value (e g if (d & PA_DIRECTION_OUTPUT)), + because we might add bidirectional stuff in the future. \since 2.0 +*/ +typedef enum pa_direction { + PA_DIRECTION_OUTPUT = 0x0001U, /**< Output direction */ + PA_DIRECTION_INPUT = 0x0002U /**< Input direction */ +} pa_direction_t; + +/** \cond fulldocs */ +#define PA_DIRECTION_OUTPUT PA_DIRECTION_OUTPUT +#define PA_DIRECTION_INPUT PA_DIRECTION_INPUT +/** \endcond */ + +/** The type of device we are dealing with */ +typedef enum pa_device_type { + PA_DEVICE_TYPE_SINK, /**< Playback device */ + PA_DEVICE_TYPE_SOURCE /**< Recording device */ +} pa_device_type_t; + +/** \cond fulldocs */ +#define PA_DEVICE_TYPE_SINK PA_DEVICE_TYPE_SINK +#define PA_DEVICE_TYPE_SOURCE PA_DEVICE_TYPE_SOURCE +/** \endcond */ + /** The direction of a pa_stream object */ typedef enum pa_stream_direction { PA_STREAM_NODIRECTION, /**< Invalid direction */ @@ -289,6 +313,16 @@ typedef enum pa_stream_flags { * device volume. If this is not specified the volume will be * consider absolute when the sink is in flat volume mode, * relative otherwise. \since 0.9.20 */ + + PA_STREAM_PASSTHROUGH = 0x80000U, + /**< Used to tag content that will be rendered by passthrough sinks. + * The data will be left as is and not reformatted, resampled. + * \since 1.0 */ + + PA_STREAM_START_RAMP_MUTED = 0x100000U + /**< Used to tag content that the stream will be started ramp volume + * muted so that you can nicely fade it in */ + } pa_stream_flags_t; /** \cond fulldocs */ @@ -316,13 +350,15 @@ typedef enum pa_stream_flags { #define PA_STREAM_START_UNMUTED PA_STREAM_START_UNMUTED #define PA_STREAM_FAIL_ON_SUSPEND PA_STREAM_FAIL_ON_SUSPEND #define PA_STREAM_RELATIVE_VOLUME PA_STREAM_RELATIVE_VOLUME +#define PA_STREAM_PASSTHROUGH PA_STREAM_PASSTHROUGH +#define PA_STREAM_START_RAMP_MUTED PA_STREAM_START_RAMP_MUTED /** \endcond */ /** Playback and record buffer metrics */ typedef struct pa_buffer_attr { uint32_t maxlength; - /**< Maximum length of the buffer. Setting this to (uint32_t) -1 + /**< Maximum length of the buffer in bytes. Setting this to (uint32_t) -1 * will initialize this to the maximum value supported by server, * which is recommended. */ @@ -382,7 +418,7 @@ typedef struct pa_buffer_attr { } pa_buffer_attr; /** Error values as used by pa_context_errno(). Use pa_strerror() to convert these values to human readable strings */ -enum { +typedef enum pa_error_code { PA_OK = 0, /**< No error */ PA_ERR_ACCESS, /**< Access failure */ PA_ERR_COMMAND, /**< Unknown command */ @@ -411,7 +447,7 @@ enum { PA_ERR_IO, /**< An IO error happened. \since 0.9.16 */ PA_ERR_BUSY, /**< Device or resource busy. \since 0.9.17 */ PA_ERR_MAX /**< Not really an error but the first invalid error code */ -}; +} pa_error_code_t; /** \cond fulldocs */ #define PA_OK PA_OK @@ -706,7 +742,8 @@ typedef enum pa_sink_flags { /**< Flag to pass when no specific options are needed (used to avoid casting) \since 0.9.19 */ PA_SINK_HW_VOLUME_CTRL = 0x0001U, - /**< Supports hardware volume control */ + /**< Supports hardware volume control. This is a dynamic flag and may + * change at runtime after the sink has initialized */ PA_SINK_LATENCY = 0x0002U, /**< Supports latency querying */ @@ -719,19 +756,42 @@ typedef enum pa_sink_flags { /**< Is a networked sink of some kind. \since 0.9.7 */ PA_SINK_HW_MUTE_CTRL = 0x0010U, - /**< Supports hardware mute control \since 0.9.11 */ + /**< Supports hardware mute control. This is a dynamic flag and may + * change at runtime after the sink has initialized \since 0.9.11 */ PA_SINK_DECIBEL_VOLUME = 0x0020U, - /**< Volume can be translated to dB with pa_sw_volume_to_dB() + /**< Volume can be translated to dB with pa_sw_volume_to_dB(). This is a + * dynamic flag and may change at runtime after the sink has initialized * \since 0.9.11 */ PA_SINK_FLAT_VOLUME = 0x0040U, /**< This sink is in flat volume mode, i.e. always the maximum of * the volume of all connected inputs. \since 0.9.15 */ - PA_SINK_DYNAMIC_LATENCY = 0x0080U + PA_SINK_DYNAMIC_LATENCY = 0x0080U, /**< The latency can be adjusted dynamically depending on the * needs of the connected streams. \since 0.9.15 */ + + PA_SINK_SET_FORMATS = 0x0100U, + /**< The sink allows setting what formats are supported by the connected + * hardware. The actual functionality to do this might be provided by an + * extension. \since 1.0 */ + +#ifdef __INCLUDED_FROM_PULSE_AUDIO +/** \cond fulldocs */ + /* PRIVATE: Server-side values -- do not try to use these at client-side. + * The server will filter out these flags anyway, so you should never see + * these flags in sinks. */ + + PA_SINK_SHARE_VOLUME_WITH_MASTER = 0x1000000U, + /**< This sink shares the volume with the master sink (used by some filter + * sinks). */ + + PA_SINK_DEFERRED_VOLUME = 0x2000000U, + /**< The HW volume changes are syncronized with SW volume. */ +/** \endcond */ +#endif + } pa_sink_flags_t; /** \cond fulldocs */ @@ -743,6 +803,11 @@ typedef enum pa_sink_flags { #define PA_SINK_DECIBEL_VOLUME PA_SINK_DECIBEL_VOLUME #define PA_SINK_FLAT_VOLUME PA_SINK_FLAT_VOLUME #define PA_SINK_DYNAMIC_LATENCY PA_SINK_DYNAMIC_LATENCY +#define PA_SINK_SET_FORMATS PA_SINK_SET_FORMATS +#ifdef __INCLUDED_FROM_PULSE_AUDIO +#define PA_SINK_CLIENT_FLAGS_MASK 0xFFFFFF +#endif + /** \endcond */ /** Sink state. \since 0.9.15 */ @@ -780,6 +845,11 @@ static inline int PA_SINK_IS_OPENED(pa_sink_state_t x) { return x == PA_SINK_RUNNING || x == PA_SINK_IDLE; } +/** Returns non-zero if sink is running. \since 1.0 */ +static inline int PA_SINK_IS_RUNNING(pa_sink_state_t x) { + return x == PA_SINK_RUNNING; +} + /** \cond fulldocs */ #define PA_SINK_INVALID_STATE PA_SINK_INVALID_STATE #define PA_SINK_RUNNING PA_SINK_RUNNING @@ -796,7 +866,8 @@ typedef enum pa_source_flags { /**< Flag to pass when no specific options are needed (used to avoid casting) \since 0.9.19 */ PA_SOURCE_HW_VOLUME_CTRL = 0x0001U, - /**< Supports hardware volume control */ + /**< Supports hardware volume control. This is a dynamic flag and may + * change at runtime after the source has initialized */ PA_SOURCE_LATENCY = 0x0002U, /**< Supports latency querying */ @@ -809,15 +880,35 @@ typedef enum pa_source_flags { /**< Is a networked source of some kind. \since 0.9.7 */ PA_SOURCE_HW_MUTE_CTRL = 0x0010U, - /**< Supports hardware mute control \since 0.9.11 */ + /**< Supports hardware mute control. This is a dynamic flag and may + * change at runtime after the source has initialized \since 0.9.11 */ PA_SOURCE_DECIBEL_VOLUME = 0x0020U, - /**< Volume can be translated to dB with pa_sw_volume_to_dB() + /**< Volume can be translated to dB with pa_sw_volume_to_dB(). This is a + * dynamic flag and may change at runtime after the source has initialized * \since 0.9.11 */ - PA_SOURCE_DYNAMIC_LATENCY = 0x0040U + PA_SOURCE_DYNAMIC_LATENCY = 0x0040U, /**< The latency can be adjusted dynamically depending on the * needs of the connected streams. \since 0.9.15 */ + + PA_SOURCE_FLAT_VOLUME = 0x0080U, + /**< This source is in flat volume mode, i.e. always the maximum of + * the volume of all connected outputs. \since 1.0 */ + +#ifdef __INCLUDED_FROM_PULSE_AUDIO +/** \cond fulldocs */ + /* PRIVATE: Server-side values -- do not try to use these at client-side. + * The server will filter out these flags anyway, so you should never see + * these flags in sources. */ + + PA_SOURCE_SHARE_VOLUME_WITH_MASTER = 0x1000000U, + /**< This source shares the volume with the master source (used by some filter + * sources). */ + + PA_SOURCE_DEFERRED_VOLUME = 0x2000000U, + /**< The HW volume changes are syncronized with SW volume. */ +#endif } pa_source_flags_t; /** \cond fulldocs */ @@ -828,6 +919,11 @@ typedef enum pa_source_flags { #define PA_SOURCE_HW_MUTE_CTRL PA_SOURCE_HW_MUTE_CTRL #define PA_SOURCE_DECIBEL_VOLUME PA_SOURCE_DECIBEL_VOLUME #define PA_SOURCE_DYNAMIC_LATENCY PA_SOURCE_DYNAMIC_LATENCY +#define PA_SOURCE_FLAT_VOLUME PA_SOURCE_FLAT_VOLUME +#ifdef __INCLUDED_FROM_PULSE_AUDIO +#define PA_SOURCE_CLIENT_FLAGS_MASK 0xFFFFFF +#endif + /** \endcond */ /** Source state. \since 0.9.15 */ @@ -865,6 +961,11 @@ static inline int PA_SOURCE_IS_OPENED(pa_source_state_t x) { return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE; } +/** Returns non-zero if source is running \since 1.0 */ +static inline int PA_SOURCE_IS_RUNNING(pa_source_state_t x) { + return x == PA_SOURCE_RUNNING; +} + /** \cond fulldocs */ #define PA_SOURCE_INVALID_STATE PA_SOURCE_INVALID_STATE #define PA_SOURCE_RUNNING PA_SOURCE_RUNNING @@ -888,6 +989,34 @@ typedef void (*pa_free_cb_t)(void *p); * information, \since 0.9.15 */ #define PA_STREAM_EVENT_REQUEST_UNCORK "request-uncork" +/** A stream event notifying that the stream is going to be + * disconnected because the underlying sink changed and no longer + * supports the format that was originally negotiated. Clients need + * to connect a new stream to renegotiate a format and continue + * playback, \since 1.0 */ +#define PA_STREAM_EVENT_FORMAT_LOST "format-lost" + +/** Port availability / jack detection status + * \since 2.0 */ +typedef enum pa_port_available { + PA_PORT_AVAILABLE_UNKNOWN = 0, /**< This port does not support jack detection \since 2.0 */ + PA_PORT_AVAILABLE_NO = 1, /**< This port is not available, likely because the jack is not plugged in. \since 2.0 */ + PA_PORT_AVAILABLE_YES = 2, /**< This port is available, likely because the jack is plugged in. \since 2.0 */ +} pa_port_available_t; + +/** \cond fulldocs */ +#define PA_PORT_AVAILABLE_UNKNOWN PA_PORT_AVAILABLE_UNKNOWN +#define PA_PORT_AVAILABLE_NO PA_PORT_AVAILABLE_NO +#define PA_PORT_AVAILABLE_YES PA_PORT_AVAILABLE_YES + +/** \endcond */ + +/** \cond fulldocs */ +#define PA_VOLUMER_RAMP_TYPE_LINEAR PA_VOLUMER_RAMP_TYPE_LINEAR +#define PA_VOLUMER_RAMP_TYPE_LOGARITHMIC PA_VOLUMER_RAMP_TYPE_LOGARITHMIC +#define PA_VOLUMER_RAMP_TYPE_CUBIC PA_VOLUMER_RAMP_TYPE_CUBIC +/** \endcond */ + PA_C_DECL_END #endif