X-Git-Url: https://code.delx.au/pulseaudio/blobdiff_plain/24e582808c18d6866d8c10f8f0320b1af0ab758b..fb70fa22c36f9220e8f4424948d0af476fb3d7a9:/src/pulsecore/source.h diff --git a/src/pulsecore/source.h b/src/pulsecore/source.h index 7b3e4953..63185950 100644 --- a/src/pulsecore/source.h +++ b/src/pulsecore/source.h @@ -24,34 +24,40 @@ ***/ typedef struct pa_source pa_source; +typedef struct pa_source_volume_change pa_source_volume_change; #include +#include +#include #include #include #include #include #include -#include #include #include #include #include #include #include -#include #include +#include #include #include +#include -#define PA_MAX_OUTPUTS_PER_SOURCE 32 +#define PA_MAX_OUTPUTS_PER_SOURCE 256 /* Returns true if source is linked: registered and accessible from client side. */ -static inline pa_bool_t PA_SOURCE_IS_LINKED(pa_source_state_t x) { +static inline bool PA_SOURCE_IS_LINKED(pa_source_state_t x) { return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE || x == PA_SOURCE_SUSPENDED; } +/* A generic definition for void callback functions */ +typedef void(*pa_source_cb_t)(pa_source *s); + struct pa_source { pa_msgobject parent; @@ -71,23 +77,33 @@ struct pa_source { pa_sample_spec sample_spec; pa_channel_map channel_map; + uint32_t default_sample_rate; + uint32_t alternate_sample_rate; pa_idxset *outputs; unsigned n_corked; pa_sink *monitor_of; /* may be NULL */ + pa_source_output *output_from_master; /* non-NULL only for filter sources */ pa_volume_t base_volume; /* shall be constant */ unsigned n_volume_steps; /* shall be constant */ - pa_cvolume volume, soft_volume; - pa_bool_t muted:1; + /* Also see http://pulseaudio.org/wiki/InternalVolumes */ + pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative source output volumes */ + pa_cvolume real_volume; /* The volume that the hardware is configured to */ + pa_cvolume soft_volume; /* The internal software volume we apply to all PCM data while it passes through */ - pa_bool_t refresh_volume:1; - pa_bool_t refresh_muted:1; + bool muted:1; - pa_bool_t save_port:1; - pa_bool_t save_volume:1; - pa_bool_t save_muted:1; + bool refresh_volume:1; + bool refresh_muted:1; + bool save_port:1; + bool save_volume:1; + bool save_muted:1; + + /* Saved volume state while we're in passthrough mode */ + pa_cvolume saved_volume; + bool saved_save_volume:1; pa_asyncmsgq *asyncmsgq; @@ -95,41 +111,83 @@ struct pa_source { pa_hashmap *ports; pa_device_port *active_port; + pa_atomic_t mixer_dirty; + + /* The latency offset is inherited from the currently active port */ + int64_t latency_offset; + + unsigned priority; /* Called when the main loop requests a state change. Called from * main loop context. If returns -1 the state change will be * inhibited */ int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */ - /* Callled when the volume is queried. Called from main loop + /* Called when the volume is queried. Called from main loop * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message * will be sent to the IO thread instead. If refresh_volume is - * FALSE neither this function is called nor a message is sent. */ - void (*get_volume)(pa_source *s); /* dito */ + * false neither this function is called nor a message is sent. + * + * You must use the function pa_source_set_get_volume_callback() to + * set this callback. */ + pa_source_cb_t get_volume; /* may be NULL */ /* Called when the volume shall be changed. Called from main loop * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message - * will be sent to the IO thread instead. */ - void (*set_volume)(pa_source *s); /* dito */ + * will be sent to the IO thread instead. + * + * You must use the function pa_source_set_set_volume_callback() to + * set this callback. */ + pa_source_cb_t set_volume; /* may be NULL */ + + /* Source drivers that set PA_SOURCE_DEFERRED_VOLUME must provide this + * callback. This callback is not used with source that do not set + * PA_SOURCE_DEFERRED_VOLUME. This is called from the IO thread when a + * pending hardware volume change has to be written to the + * hardware. The requested volume is passed to the callback + * implementation in s->thread_info.current_hw_volume. + * + * The call is done inside pa_source_volume_change_apply(), which is + * not called automatically - it is the driver's responsibility to + * schedule that function to be called at the right times in the + * IO thread. + * + * You must use the function pa_source_set_write_volume_callback() to + * set this callback. */ + pa_source_cb_t write_volume; /* may be NULL */ /* Called when the mute setting is queried. Called from main loop * context. If this is NULL a PA_SOURCE_MESSAGE_GET_MUTE message * will be sent to the IO thread instead. If refresh_mute is - * FALSE neither this function is called nor a message is sent.*/ - void (*get_mute)(pa_source *s); /* dito */ + * false neither this function is called nor a message is sent. + * + * You must use the function pa_source_set_get_mute_callback() to + * set this callback. */ + pa_source_cb_t get_mute; /* may be NULL */ /* Called when the mute setting shall be changed. Called from main * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE - * message will be sent to the IO thread instead. */ - void (*set_mute)(pa_source *s); /* dito */ + * message will be sent to the IO thread instead. + * + * You must use the function pa_source_set_set_mute_callback() to + * set this callback. */ + pa_source_cb_t set_mute; /* may be NULL */ /* Called when a the requested latency is changed. Called from IO * thread context. */ - void (*update_requested_latency)(pa_source *s); /* dito */ + pa_source_cb_t update_requested_latency; /* may be NULL */ - /* Called whenever the port shall be changed. Called from main - * thread. */ - int (*set_port)(pa_source *s, pa_device_port *port); /*dito */ + /* Called whenever the port shall be changed. Called from IO + * thread if deferred volumes are enabled, and main thread otherwise. */ + int (*set_port)(pa_source *s, pa_device_port *port); /*ditto */ + + /* Called to get the list of formats supported by the source, sorted + * in descending order of preference. */ + pa_idxset* (*get_formats)(pa_source *s); /* ditto */ + + /* Called whenever the sampling frequency shall be changed. Called from + * main thread. */ + int (*update_rate)(pa_source *s, uint32_t rate); /* Contains copies of the above data so that the real-time worker * thread can work without access locking */ @@ -140,9 +198,9 @@ struct pa_source { pa_rtpoll *rtpoll; pa_cvolume soft_volume; - pa_bool_t soft_muted:1; + bool soft_muted:1; - pa_bool_t requested_latency_valid:1; + bool requested_latency_valid:1; pa_usec_t requested_latency; /* Then number of bytes this source will be rewound for at @@ -153,36 +211,60 @@ struct pa_source { pa_usec_t max_latency; /* An upper limit for the latencies */ pa_usec_t fixed_latency; /* for sources with PA_SOURCE_DYNAMIC_LATENCY this is 0 */ - } thread_info; + + /* This latency offset is a direct copy from s->latency_offset */ + int64_t latency_offset; + + /* Delayed volume change events are queued here. The events + * are stored in expiration order. The one expiring next is in + * the head of the list. */ + PA_LLIST_HEAD(pa_source_volume_change, volume_changes); + pa_source_volume_change *volume_changes_tail; + /* This value is updated in pa_source_volume_change_apply() and + * used only by sources with PA_SOURCE_DEFERRED_VOLUME. */ + pa_cvolume current_hw_volume; + + /* The amount of usec volume up events are delayed and volume + * down events are made earlier. */ + uint32_t volume_change_safety_margin; + /* Usec delay added to all volume change events, may be negative. */ + int32_t volume_change_extra_delay; + } thread_info; void *userdata; }; -PA_DECLARE_CLASS(pa_source); +PA_DECLARE_PUBLIC_CLASS(pa_source); #define PA_SOURCE(s) pa_source_cast(s) typedef enum pa_source_message { PA_SOURCE_MESSAGE_ADD_OUTPUT, PA_SOURCE_MESSAGE_REMOVE_OUTPUT, PA_SOURCE_MESSAGE_GET_VOLUME, + PA_SOURCE_MESSAGE_SET_SHARED_VOLUME, + PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED, PA_SOURCE_MESSAGE_SET_VOLUME, + PA_SOURCE_MESSAGE_SYNC_VOLUMES, PA_SOURCE_MESSAGE_GET_MUTE, PA_SOURCE_MESSAGE_SET_MUTE, PA_SOURCE_MESSAGE_GET_LATENCY, PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY, PA_SOURCE_MESSAGE_SET_STATE, - PA_SOURCE_MESSAGE_ATTACH, - PA_SOURCE_MESSAGE_DETACH, PA_SOURCE_MESSAGE_SET_LATENCY_RANGE, PA_SOURCE_MESSAGE_GET_LATENCY_RANGE, PA_SOURCE_MESSAGE_SET_FIXED_LATENCY, PA_SOURCE_MESSAGE_GET_FIXED_LATENCY, PA_SOURCE_MESSAGE_GET_MAX_REWIND, PA_SOURCE_MESSAGE_SET_MAX_REWIND, + PA_SOURCE_MESSAGE_SET_PORT, + PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE, + PA_SOURCE_MESSAGE_SET_LATENCY_OFFSET, PA_SOURCE_MESSAGE_MAX } pa_source_message_t; typedef struct pa_source_new_data { + pa_suspend_cause_t suspend_cause; + char *name; pa_proplist *proplist; @@ -195,27 +277,30 @@ typedef struct pa_source_new_data { pa_sample_spec sample_spec; pa_channel_map channel_map; + uint32_t alternate_sample_rate; pa_cvolume volume; - pa_bool_t muted:1; + bool muted:1; - pa_bool_t volume_is_set:1; - pa_bool_t muted_is_set:1; - pa_bool_t sample_spec_is_set:1; - pa_bool_t channel_map_is_set:1; + bool volume_is_set:1; + bool muted_is_set:1; + bool sample_spec_is_set:1; + bool channel_map_is_set:1; + bool alternate_sample_rate_is_set:1; - pa_bool_t namereg_fail:1; + bool namereg_fail:1; - pa_bool_t save_port:1; - pa_bool_t save_volume:1; - pa_bool_t save_muted:1; + bool save_port:1; + bool save_volume:1; + bool save_muted:1; } pa_source_new_data; pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data); void pa_source_new_data_set_name(pa_source_new_data *data, const char *name); void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec); void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map); +void pa_source_new_data_set_alternate_sample_rate(pa_source_new_data *data, const uint32_t alternate_sample_rate); void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume); -void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute); +void pa_source_new_data_set_muted(pa_source_new_data *data, bool mute); void pa_source_new_data_set_port(pa_source_new_data *data, const char *port); void pa_source_new_data_done(pa_source_new_data *data); @@ -226,6 +311,13 @@ pa_source* pa_source_new( pa_source_new_data *data, pa_source_flags_t flags); +void pa_source_set_get_volume_callback(pa_source *s, pa_source_cb_t cb); +void pa_source_set_set_volume_callback(pa_source *s, pa_source_cb_t cb); +void pa_source_set_write_volume_callback(pa_source *s, pa_source_cb_t cb); +void pa_source_set_get_mute_callback(pa_source *s, pa_source_cb_t cb); +void pa_source_set_set_mute_callback(pa_source *s, pa_source_cb_t cb); +void pa_source_enable_decibel_volume(pa_source *s, bool enable); + void pa_source_put(pa_source *s); void pa_source_unlink(pa_source *s); @@ -237,12 +329,9 @@ void pa_source_set_max_rewind(pa_source *s, size_t max_rewind); void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency); void pa_source_set_fixed_latency(pa_source *s, pa_usec_t latency); -void pa_source_detach(pa_source *s); -void pa_source_attach(pa_source *s); - void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume); void pa_source_volume_changed(pa_source *s, const pa_cvolume *new_volume); -void pa_source_mute_changed(pa_source *s, pa_bool_t new_muted); +void pa_source_mute_changed(pa_source *s, bool new_muted); int pa_source_sync_suspend(pa_source *s); @@ -250,6 +339,8 @@ void pa_source_update_flags(pa_source *s, pa_source_flags_t mask, pa_source_flag /*** May be called by everyone, from main context */ +void pa_source_set_latency_offset(pa_source *s, int64_t offset); + /* The returned value is supposed to be in the time domain of the sound card! */ pa_usec_t pa_source_get_latency(pa_source *s); pa_usec_t pa_source_get_requested_latency(pa_source *s); @@ -259,18 +350,34 @@ pa_usec_t pa_source_get_fixed_latency(pa_source *s); size_t pa_source_get_max_rewind(pa_source *s); int pa_source_update_status(pa_source*s); -int pa_source_suspend(pa_source *s, pa_bool_t suspend, pa_suspend_cause_t cause); -int pa_source_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause); +int pa_source_suspend(pa_source *s, bool suspend, pa_suspend_cause_t cause); +int pa_source_suspend_all(pa_core *c, bool suspend, pa_suspend_cause_t cause); + +/* Use this instead of checking s->flags & PA_SOURCE_FLAT_VOLUME directly. */ +bool pa_source_flat_volume_enabled(pa_source *s); + +/* Get the master source when sharing volumes */ +pa_source *pa_source_get_master(pa_source *s); + +/* Is the source in passthrough mode? (that is, is this a monitor source for a sink + * that has a passthrough sink input connected to it. */ +bool pa_source_is_passthrough(pa_source *s); +/* These should be called when a source enters/leaves passthrough mode */ +void pa_source_enter_passthrough(pa_source *s); +void pa_source_leave_passthrough(pa_source *s); + +void pa_source_set_volume(pa_source *source, const pa_cvolume *volume, bool sendmsg, bool save); +const pa_cvolume *pa_source_get_volume(pa_source *source, bool force_refresh); -void pa_source_set_volume(pa_source *source, const pa_cvolume *volume, pa_bool_t save); -const pa_cvolume *pa_source_get_volume(pa_source *source, pa_bool_t force_refresh); +void pa_source_set_mute(pa_source *source, bool mute, bool save); +bool pa_source_get_mute(pa_source *source, bool force_refresh); -void pa_source_set_mute(pa_source *source, pa_bool_t mute, pa_bool_t save); -pa_bool_t pa_source_get_mute(pa_source *source, pa_bool_t force_refresh); +bool pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p); -pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p); +int pa_source_set_port(pa_source *s, const char *name, bool save); +void pa_source_set_mixer_dirty(pa_source *s, bool is_dirty); -int pa_source_set_port(pa_source *s, const char *name, pa_bool_t save); +int pa_source_update_rate(pa_source *s, uint32_t rate, bool passthrough); unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */ unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */ @@ -279,9 +386,19 @@ unsigned pa_source_check_suspend(pa_source *s); /* Returns how many streams are /* Moves all inputs away, and stores them in pa_queue */ pa_queue *pa_source_move_all_start(pa_source *s, pa_queue *q); -void pa_source_move_all_finish(pa_source *s, pa_queue *q, pa_bool_t save); +void pa_source_move_all_finish(pa_source *s, pa_queue *q, bool save); void pa_source_move_all_fail(pa_queue *q); +/* Returns a copy of the source formats. TODO: Get rid of this function (or at + * least get rid of the copying). There's no good reason to copy the formats + * every time someone wants to know what formats the source supports. The + * formats idxset could be stored directly in the pa_source struct. + * https://bugs.freedesktop.org/show_bug.cgi?id=71924 */ +pa_idxset* pa_source_get_formats(pa_source *s); + +bool pa_source_check_format(pa_source *s, pa_format_info *f); +pa_idxset* pa_source_check_formats(pa_source *s, pa_idxset *in_formats); + /*** To be called exclusively by the source driver, from IO context */ void pa_source_post(pa_source*s, const pa_memchunk *chunk); @@ -300,11 +417,22 @@ void pa_source_set_max_rewind_within_thread(pa_source *s, size_t max_rewind); void pa_source_set_latency_range_within_thread(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency); void pa_source_set_fixed_latency_within_thread(pa_source *s, pa_usec_t latency); +void pa_source_update_volume_and_mute(pa_source *s); + +bool pa_source_volume_change_apply(pa_source *s, pa_usec_t *usec_to_next); + /*** To be called exclusively by source output drivers, from IO context */ -void pa_source_invalidate_requested_latency(pa_source *s, pa_bool_t dynamic); +void pa_source_invalidate_requested_latency(pa_source *s, bool dynamic); pa_usec_t pa_source_get_latency_within_thread(pa_source *s); +/* Called from the main thread, from source-output.c only. The normal way to + * set the source reference volume is to call pa_source_set_volume(), but the + * flat volume logic in source-output.c needs also a function that doesn't do + * all the extra stuff that pa_source_set_volume() does. This function simply + * sets s->reference_volume and fires change notifications. */ +void pa_source_set_reference_volume_direct(pa_source *s, const pa_cvolume *volume); + #define pa_source_assert_io_context(s) \ pa_assert(pa_thread_mq_get() || !PA_SOURCE_IS_LINKED((s)->state))