src/pulsecore/source.h

   1 #ifndef foopulsesourcehfoo
   2 #define foopulsesourcehfoo
   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 published
  12   by the Free Software Foundation; either version 2.1 of the License,
  13   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   General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24
  25 #include <inttypes.h>
  26
  27 #include <pulsecore/typedefs.h>
  28 #include <pulse/def.h>
  29 #include <pulse/format.h>
  30 #include <pulse/sample.h>
  31 #include <pulse/channelmap.h>
  32 #include <pulse/volume.h>
  33
  34 #include <pulsecore/core.h>
  35 #include <pulsecore/idxset.h>
  36 #include <pulsecore/memchunk.h>
  37 #include <pulsecore/sink.h>
  38 #include <pulsecore/module.h>
  39 #include <pulsecore/asyncmsgq.h>
  40 #include <pulsecore/msgobject.h>
  41 #include <pulsecore/rtpoll.h>
  42 #include <pulsecore/card.h>
  43 #include <pulsecore/device-port.h>
  44 #include <pulsecore/queue.h>
  45 #include <pulsecore/thread-mq.h>
  46 #include <pulsecore/source-output.h>
  47
  48 #define PA_MAX_OUTPUTS_PER_SOURCE 256
  49
  50 /* Returns true if source is linked: registered and accessible from client side. */
  51 static inline bool PA_SOURCE_IS_LINKED(pa_source_state_t x) {
  52     return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE || x == PA_SOURCE_SUSPENDED;
  53 }
  54
  55 /* A generic definition for void callback functions */
  56 typedef void(*pa_source_cb_t)(pa_source *s);
  57
  58 typedef int (*pa_source_get_mute_cb_t)(pa_source *s, bool *mute);
  59
  60 struct pa_source {
  61     pa_msgobject parent;
  62
  63     uint32_t index;
  64     pa_core *core;
  65
  66     pa_source_state_t state;
  67
  68     /* Set in the beginning of pa_source_unlink() before setting the source
  69      * state to UNLINKED. The purpose is to prevent moving streams to a source
  70      * that is about to be removed. */
  71     bool unlink_requested;
  72
  73     pa_source_flags_t flags;
  74     pa_suspend_cause_t suspend_cause;
  75
  76     char *name;
  77     char *driver;                             /* may be NULL */
  78     pa_proplist *proplist;
  79
  80     pa_module *module;                        /* may be NULL */
  81     pa_card *card;                            /* may be NULL */
  82
  83     pa_sample_spec sample_spec;
  84     pa_channel_map channel_map;
  85     uint32_t default_sample_rate;
  86     uint32_t alternate_sample_rate;
  87
  88     pa_idxset *outputs;
  89     unsigned n_corked;
  90     pa_sink *monitor_of;                     /* may be NULL */
  91     pa_source_output *output_from_master;    /* non-NULL only for filter sources */
  92
  93     pa_volume_t base_volume; /* shall be constant */
  94     unsigned n_volume_steps; /* shall be constant */
  95
  96     /* Also see http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/Developer/Volumes/ */
  97     pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative source output volumes */
  98     pa_cvolume real_volume;      /* The volume that the hardware is configured to  */
  99     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
 100
 101     bool muted:1;
 102
 103     bool refresh_volume:1;
 104     bool refresh_muted:1;
 105     bool save_port:1;
 106     bool save_volume:1;
 107     bool save_muted:1;
 108
 109     /* Saved volume state while we're in passthrough mode */
 110     pa_cvolume saved_volume;
 111     bool saved_save_volume:1;
 112
 113     pa_asyncmsgq *asyncmsgq;
 114
 115     pa_memchunk silence;
 116
 117     pa_hashmap *ports;
 118     pa_device_port *active_port;
 119     pa_atomic_t mixer_dirty;
 120
 121     /* The latency offset is inherited from the currently active port */
 122     int64_t port_latency_offset;
 123
 124     unsigned priority;
 125
 126     bool set_mute_in_progress;
 127
 128     /* Called when the main loop requests a state change. Called from
 129      * main loop context. If returns -1 the state change will be
 130      * inhibited */
 131     int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */
 132
 133     /* Called when the volume is queried. Called from main loop
 134      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message
 135      * will be sent to the IO thread instead. If refresh_volume is
 136      * false neither this function is called nor a message is sent.
 137      *
 138      * You must use the function pa_source_set_get_volume_callback() to
 139      * set this callback. */
 140     pa_source_cb_t get_volume; /* may be NULL */
 141
 142     /* Called when the volume shall be changed. Called from main loop
 143      * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message
 144      * will be sent to the IO thread instead.
 145      *
 146      * You must use the function pa_source_set_set_volume_callback() to
 147      * set this callback. */
 148     pa_source_cb_t set_volume; /* may be NULL */
 149
 150     /* Source drivers that set PA_SOURCE_DEFERRED_VOLUME must provide this
 151      * callback. This callback is not used with source that do not set
 152      * PA_SOURCE_DEFERRED_VOLUME. This is called from the IO thread when a
 153      * pending hardware volume change has to be written to the
 154      * hardware. The requested volume is passed to the callback
 155      * implementation in s->thread_info.current_hw_volume.
 156      *
 157      * The call is done inside pa_source_volume_change_apply(), which is
 158      * not called automatically - it is the driver's responsibility to
 159      * schedule that function to be called at the right times in the
 160      * IO thread.
 161      *
 162      * You must use the function pa_source_set_write_volume_callback() to
 163      * set this callback. */
 164     pa_source_cb_t write_volume; /* may be NULL */
 165
 166     /* If the source mute can change "spontaneously" (i.e. initiated by the
 167      * source implementation, not by someone else calling
 168      * pa_source_set_mute()), then the source implementation can notify about
 169      * changed mute either by calling pa_source_mute_changed() or by calling
 170      * pa_source_get_mute() with force_refresh=true. If the implementation
 171      * chooses the latter approach, it should implement the get_mute callback.
 172      * Otherwise get_mute can be NULL.
 173      *
 174      * This is called when pa_source_get_mute() is called with
 175      * force_refresh=true. This is called from the IO thread if the
 176      * PA_SINK_DEFERRED_VOLUME flag is set, otherwise this is called from the
 177      * main thread. On success, the implementation is expected to return 0 and
 178      * set the mute parameter that is passed as a reference. On failure, the
 179      * implementation is expected to return -1.
 180      *
 181      * You must use the function pa_source_set_get_mute_callback() to
 182      * set this callback. */
 183     pa_source_get_mute_cb_t get_mute;
 184
 185     /* Called when the mute setting shall be changed. Called from main
 186      * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE
 187      * message will be sent to the IO thread instead.
 188      *
 189      * You must use the function pa_source_set_set_mute_callback() to
 190      * set this callback. */
 191     pa_source_cb_t set_mute; /* may be NULL */
 192
 193     /* Called when a the requested latency is changed. Called from IO
 194      * thread context. */
 195     pa_source_cb_t update_requested_latency; /* may be NULL */
 196
 197     /* Called whenever the port shall be changed. Called from IO
 198      * thread if deferred volumes are enabled, and main thread otherwise. */
 199     int (*set_port)(pa_source *s, pa_device_port *port); /*ditto */
 200
 201     /* Called to get the list of formats supported by the source, sorted
 202      * in descending order of preference. */
 203     pa_idxset* (*get_formats)(pa_source *s); /* ditto */
 204
 205     /* Called whenever the sampling frequency shall be changed. Called from
 206      * main thread. */
 207     int (*update_rate)(pa_source *s, uint32_t rate);
 208
 209     /* Contains copies of the above data so that the real-time worker
 210      * thread can work without access locking */
 211     struct {
 212         pa_source_state_t state;
 213         pa_hashmap *outputs;
 214
 215         pa_rtpoll *rtpoll;
 216
 217         pa_cvolume soft_volume;
 218         bool soft_muted:1;
 219
 220         bool requested_latency_valid:1;
 221         pa_usec_t requested_latency;
 222
 223         /* Then number of bytes this source will be rewound for at
 224          * max. (Only used on monitor sources) */
 225         size_t max_rewind;
 226
 227         pa_usec_t min_latency; /* we won't go below this latency */
 228         pa_usec_t max_latency; /* An upper limit for the latencies */
 229
 230         pa_usec_t fixed_latency; /* for sources with PA_SOURCE_DYNAMIC_LATENCY this is 0 */
 231
 232         /* This latency offset is a direct copy from s->port_latency_offset */
 233         int64_t port_latency_offset;
 234
 235         /* Delayed volume change events are queued here. The events
 236          * are stored in expiration order. The one expiring next is in
 237          * the head of the list. */
 238         PA_LLIST_HEAD(pa_source_volume_change, volume_changes);
 239         pa_source_volume_change *volume_changes_tail;
 240         /* This value is updated in pa_source_volume_change_apply() and
 241          * used only by sources with PA_SOURCE_DEFERRED_VOLUME. */
 242         pa_cvolume current_hw_volume;
 243
 244         /* The amount of usec volume up events are delayed and volume
 245          * down events are made earlier. */
 246         uint32_t volume_change_safety_margin;
 247         /* Usec delay added to all volume change events, may be negative. */
 248         int32_t volume_change_extra_delay;
 249     } thread_info;
 250
 251     void *userdata;
 252 };
 253
 254 PA_DECLARE_PUBLIC_CLASS(pa_source);
 255 #define PA_SOURCE(s) pa_source_cast(s)
 256
 257 typedef enum pa_source_message {
 258     PA_SOURCE_MESSAGE_ADD_OUTPUT,
 259     PA_SOURCE_MESSAGE_REMOVE_OUTPUT,
 260     PA_SOURCE_MESSAGE_GET_VOLUME,
 261     PA_SOURCE_MESSAGE_SET_SHARED_VOLUME,
 262     PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED,
 263     PA_SOURCE_MESSAGE_SET_VOLUME,
 264     PA_SOURCE_MESSAGE_SYNC_VOLUMES,
 265     PA_SOURCE_MESSAGE_GET_MUTE,
 266     PA_SOURCE_MESSAGE_SET_MUTE,
 267     PA_SOURCE_MESSAGE_GET_LATENCY,
 268     PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY,
 269     PA_SOURCE_MESSAGE_SET_STATE,
 270     PA_SOURCE_MESSAGE_SET_LATENCY_RANGE,
 271     PA_SOURCE_MESSAGE_GET_LATENCY_RANGE,
 272     PA_SOURCE_MESSAGE_SET_FIXED_LATENCY,
 273     PA_SOURCE_MESSAGE_GET_FIXED_LATENCY,
 274     PA_SOURCE_MESSAGE_GET_MAX_REWIND,
 275     PA_SOURCE_MESSAGE_SET_MAX_REWIND,
 276     PA_SOURCE_MESSAGE_SET_PORT,
 277     PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE,
 278     PA_SOURCE_MESSAGE_SET_PORT_LATENCY_OFFSET,
 279     PA_SOURCE_MESSAGE_MAX
 280 } pa_source_message_t;
 281
 282 typedef struct pa_source_new_data {
 283     pa_suspend_cause_t suspend_cause;
 284
 285     char *name;
 286     pa_proplist *proplist;
 287
 288     const char *driver;
 289     pa_module *module;
 290     pa_card *card;
 291
 292     pa_hashmap *ports;
 293     char *active_port;
 294
 295     pa_sample_spec sample_spec;
 296     pa_channel_map channel_map;
 297     uint32_t alternate_sample_rate;
 298     pa_cvolume volume;
 299     bool muted:1;
 300
 301     bool volume_is_set:1;
 302     bool muted_is_set:1;
 303     bool sample_spec_is_set:1;
 304     bool channel_map_is_set:1;
 305     bool alternate_sample_rate_is_set:1;
 306
 307     bool namereg_fail:1;
 308
 309     bool save_port:1;
 310     bool save_volume:1;
 311     bool save_muted:1;
 312 } pa_source_new_data;
 313
 314 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);
 315 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name);
 316 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec);
 317 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
 318 void pa_source_new_data_set_alternate_sample_rate(pa_source_new_data *data, const uint32_t alternate_sample_rate);
 319 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
 320 void pa_source_new_data_set_muted(pa_source_new_data *data, bool mute);
 321 void pa_source_new_data_set_port(pa_source_new_data *data, const char *port);
 322 void pa_source_new_data_done(pa_source_new_data *data);
 323
 324 /*** To be called exclusively by the source driver, from main context */
 325
 326 pa_source* pa_source_new(
 327         pa_core *core,
 328         pa_source_new_data *data,
 329         pa_source_flags_t flags);
 330
 331 void pa_source_set_get_volume_callback(pa_source *s, pa_source_cb_t cb);
 332 void pa_source_set_set_volume_callback(pa_source *s, pa_source_cb_t cb);
 333 void pa_source_set_write_volume_callback(pa_source *s, pa_source_cb_t cb);
 334 void pa_source_set_get_mute_callback(pa_source *s, pa_source_get_mute_cb_t cb);
 335 void pa_source_set_set_mute_callback(pa_source *s, pa_source_cb_t cb);
 336 void pa_source_enable_decibel_volume(pa_source *s, bool enable);
 337
 338 void pa_source_put(pa_source *s);
 339 void pa_source_unlink(pa_source *s);
 340
 341 void pa_source_set_description(pa_source *s, const char *description);
 342 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
 343 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
 344
 345 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind);
 346 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 347 void pa_source_set_fixed_latency(pa_source *s, pa_usec_t latency);
 348
 349 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume);
 350 void pa_source_volume_changed(pa_source *s, const pa_cvolume *new_volume);
 351 void pa_source_mute_changed(pa_source *s, bool new_muted);
 352
 353 int pa_source_sync_suspend(pa_source *s);
 354
 355 void pa_source_update_flags(pa_source *s, pa_source_flags_t mask, pa_source_flags_t value);
 356
 357 /*** May be called by everyone, from main context */
 358
 359 void pa_source_set_port_latency_offset(pa_source *s, int64_t offset);
 360
 361 /* The returned value is supposed to be in the time domain of the sound card! */
 362 pa_usec_t pa_source_get_latency(pa_source *s);
 363 pa_usec_t pa_source_get_requested_latency(pa_source *s);
 364 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 365 pa_usec_t pa_source_get_fixed_latency(pa_source *s);
 366
 367 size_t pa_source_get_max_rewind(pa_source *s);
 368
 369 int pa_source_update_status(pa_source*s);
 370 int pa_source_suspend(pa_source *s, bool suspend, pa_suspend_cause_t cause);
 371 int pa_source_suspend_all(pa_core *c, bool suspend, pa_suspend_cause_t cause);
 372
 373 /* Use this instead of checking s->flags & PA_SOURCE_FLAT_VOLUME directly. */
 374 bool pa_source_flat_volume_enabled(pa_source *s);
 375
 376 /* Get the master source when sharing volumes */
 377 pa_source *pa_source_get_master(pa_source *s);
 378
 379 bool pa_source_is_filter(pa_source *s);
 380
 381 /* Is the source in passthrough mode? (that is, is this a monitor source for a sink
 382  * that has a passthrough sink input connected to it. */
 383 bool pa_source_is_passthrough(pa_source *s);
 384 /* These should be called when a source enters/leaves passthrough mode */
 385 void pa_source_enter_passthrough(pa_source *s);
 386 void pa_source_leave_passthrough(pa_source *s);
 387
 388 void pa_source_set_volume(pa_source *source, const pa_cvolume *volume, bool sendmsg, bool save);
 389 const pa_cvolume *pa_source_get_volume(pa_source *source, bool force_refresh);
 390
 391 void pa_source_set_mute(pa_source *source, bool mute, bool save);
 392 bool pa_source_get_mute(pa_source *source, bool force_refresh);
 393
 394 bool pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p);
 395
 396 int pa_source_set_port(pa_source *s, const char *name, bool save);
 397 void pa_source_set_mixer_dirty(pa_source *s, bool is_dirty);
 398
 399 int pa_source_update_rate(pa_source *s, uint32_t rate, bool passthrough);
 400
 401 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
 402 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */
 403
 404 /* Returns how many streams are active that don't allow suspensions. If
 405  * "ignore" is non-NULL, that stream is not included in the count. */
 406 unsigned pa_source_check_suspend(pa_source *s, pa_source_output *ignore);
 407
 408 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
 409
 410 /* Moves all inputs away, and stores them in pa_queue */
 411 pa_queue *pa_source_move_all_start(pa_source *s, pa_queue *q);
 412 void pa_source_move_all_finish(pa_source *s, pa_queue *q, bool save);
 413 void pa_source_move_all_fail(pa_queue *q);
 414
 415 /* Returns a copy of the source formats. TODO: Get rid of this function (or at
 416  * least get rid of the copying). There's no good reason to copy the formats
 417  * every time someone wants to know what formats the source supports. The
 418  * formats idxset could be stored directly in the pa_source struct.
 419  * https://bugs.freedesktop.org/show_bug.cgi?id=71924 */
 420 pa_idxset* pa_source_get_formats(pa_source *s);
 421
 422 bool pa_source_check_format(pa_source *s, pa_format_info *f);
 423 pa_idxset* pa_source_check_formats(pa_source *s, pa_idxset *in_formats);
 424
 425 /*** To be called exclusively by the source driver, from IO context */
 426
 427 void pa_source_post(pa_source*s, const pa_memchunk *chunk);
 428 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk);
 429 void pa_source_process_rewind(pa_source *s, size_t nbytes);
 430
 431 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
 432
 433 void pa_source_attach_within_thread(pa_source *s);
 434 void pa_source_detach_within_thread(pa_source *s);
 435
 436 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s);
 437
 438 void pa_source_set_max_rewind_within_thread(pa_source *s, size_t max_rewind);
 439
 440 void pa_source_set_latency_range_within_thread(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 441 void pa_source_set_fixed_latency_within_thread(pa_source *s, pa_usec_t latency);
 442
 443 void pa_source_update_volume_and_mute(pa_source *s);
 444
 445 bool pa_source_volume_change_apply(pa_source *s, pa_usec_t *usec_to_next);
 446
 447 /*** To be called exclusively by source output drivers, from IO context */
 448
 449 void pa_source_invalidate_requested_latency(pa_source *s, bool dynamic);
 450 int64_t pa_source_get_latency_within_thread(pa_source *s, bool allow_negative);
 451
 452 /* Called from the main thread, from source-output.c only. The normal way to
 453  * set the source reference volume is to call pa_source_set_volume(), but the
 454  * flat volume logic in source-output.c needs also a function that doesn't do
 455  * all the extra stuff that pa_source_set_volume() does. This function simply
 456  * sets s->reference_volume and fires change notifications. */
 457 void pa_source_set_reference_volume_direct(pa_source *s, const pa_cvolume *volume);
 458
 459 #define pa_source_assert_io_context(s) \
 460     pa_assert(pa_thread_mq_get() || !PA_SOURCE_IS_LINKED((s)->state))
 461
 462 #endif