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     /* Callbacks for doing things when the source state and/or suspend cause is
 129      * changed. It's fine to set either or both of the callbacks to NULL if the
 130      * implementation doesn't have anything to do on state or suspend cause
 131      * changes.
 132      *
 133      * set_state_in_main_thread() is called first. The callback is allowed to
 134      * report failure if and only if the source changes its state from
 135      * SUSPENDED to IDLE or RUNNING. (FIXME: It would make sense to allow
 136      * failure also when changing state from INIT to IDLE or RUNNING, but
 137      * currently that will crash pa_source_put().) If
 138      * set_state_in_main_thread() fails, set_state_in_io_thread() won't be
 139      * called.
 140      *
 141      * If set_state_in_main_thread() is successful (or not set), then
 142      * set_state_in_io_thread() is called. Again, failure is allowed if and
 143      * only if the source changes state from SUSPENDED to IDLE or RUNNING. If
 144      * set_state_in_io_thread() fails, then set_state_in_main_thread() is
 145      * called again, this time with the state parameter set to SUSPENDED and
 146      * the suspend_cause parameter set to 0.
 147      *
 148      * pa_source.state, pa_source.thread_info.state and pa_source.suspend_cause
 149      * are updated only after all the callback calls. In case of failure, the
 150      * state is set to SUSPENDED and the suspend cause is set to 0. */
 151     int (*set_state_in_main_thread)(pa_source *s, pa_source_state_t state, pa_suspend_cause_t suspend_cause); /* may be NULL */
 152     int (*set_state_in_io_thread)(pa_source *s, pa_source_state_t state, pa_suspend_cause_t suspend_cause); /* may be NULL */
 153
 154     /* Called when the volume is queried. Called from main loop
 155      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message
 156      * will be sent to the IO thread instead. If refresh_volume is
 157      * false neither this function is called nor a message is sent.
 158      *
 159      * You must use the function pa_source_set_get_volume_callback() to
 160      * set this callback. */
 161     pa_source_cb_t get_volume; /* may be NULL */
 162
 163     /* Called when the volume shall be changed. Called from main loop
 164      * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message
 165      * will be sent to the IO thread instead.
 166      *
 167      * You must use the function pa_source_set_set_volume_callback() to
 168      * set this callback. */
 169     pa_source_cb_t set_volume; /* may be NULL */
 170
 171     /* Source drivers that set PA_SOURCE_DEFERRED_VOLUME must provide this
 172      * callback. This callback is not used with source that do not set
 173      * PA_SOURCE_DEFERRED_VOLUME. This is called from the IO thread when a
 174      * pending hardware volume change has to be written to the
 175      * hardware. The requested volume is passed to the callback
 176      * implementation in s->thread_info.current_hw_volume.
 177      *
 178      * The call is done inside pa_source_volume_change_apply(), which is
 179      * not called automatically - it is the driver's responsibility to
 180      * schedule that function to be called at the right times in the
 181      * IO thread.
 182      *
 183      * You must use the function pa_source_set_write_volume_callback() to
 184      * set this callback. */
 185     pa_source_cb_t write_volume; /* may be NULL */
 186
 187     /* If the source mute can change "spontaneously" (i.e. initiated by the
 188      * source implementation, not by someone else calling
 189      * pa_source_set_mute()), then the source implementation can notify about
 190      * changed mute either by calling pa_source_mute_changed() or by calling
 191      * pa_source_get_mute() with force_refresh=true. If the implementation
 192      * chooses the latter approach, it should implement the get_mute callback.
 193      * Otherwise get_mute can be NULL.
 194      *
 195      * This is called when pa_source_get_mute() is called with
 196      * force_refresh=true. This is called from the IO thread if the
 197      * PA_SINK_DEFERRED_VOLUME flag is set, otherwise this is called from the
 198      * main thread. On success, the implementation is expected to return 0 and
 199      * set the mute parameter that is passed as a reference. On failure, the
 200      * implementation is expected to return -1.
 201      *
 202      * You must use the function pa_source_set_get_mute_callback() to
 203      * set this callback. */
 204     pa_source_get_mute_cb_t get_mute;
 205
 206     /* Called when the mute setting shall be changed. Called from main
 207      * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE
 208      * message will be sent to the IO thread instead.
 209      *
 210      * You must use the function pa_source_set_set_mute_callback() to
 211      * set this callback. */
 212     pa_source_cb_t set_mute; /* may be NULL */
 213
 214     /* Called when a the requested latency is changed. Called from IO
 215      * thread context. */
 216     pa_source_cb_t update_requested_latency; /* may be NULL */
 217
 218     /* Called whenever the port shall be changed. Called from IO
 219      * thread if deferred volumes are enabled, and main thread otherwise. */
 220     int (*set_port)(pa_source *s, pa_device_port *port); /*ditto */
 221
 222     /* Called to get the list of formats supported by the source, sorted
 223      * in descending order of preference. */
 224     pa_idxset* (*get_formats)(pa_source *s); /* ditto */
 225
 226     /* Called whenever device parameters need to be changed. Called from
 227      * main thread. */
 228     int (*reconfigure)(pa_source *s, pa_sample_spec *spec, bool passthrough);
 229
 230     /* Contains copies of the above data so that the real-time worker
 231      * thread can work without access locking */
 232     struct {
 233         pa_source_state_t state;
 234         pa_hashmap *outputs;
 235
 236         pa_rtpoll *rtpoll;
 237
 238         pa_cvolume soft_volume;
 239         bool soft_muted:1;
 240
 241         bool requested_latency_valid:1;
 242         pa_usec_t requested_latency;
 243
 244         /* Then number of bytes this source will be rewound for at
 245          * max. (Only used on monitor sources) */
 246         size_t max_rewind;
 247
 248         pa_usec_t min_latency; /* we won't go below this latency */
 249         pa_usec_t max_latency; /* An upper limit for the latencies */
 250
 251         pa_usec_t fixed_latency; /* for sources with PA_SOURCE_DYNAMIC_LATENCY this is 0 */
 252
 253         /* This latency offset is a direct copy from s->port_latency_offset */
 254         int64_t port_latency_offset;
 255
 256         /* Delayed volume change events are queued here. The events
 257          * are stored in expiration order. The one expiring next is in
 258          * the head of the list. */
 259         PA_LLIST_HEAD(pa_source_volume_change, volume_changes);
 260         pa_source_volume_change *volume_changes_tail;
 261         /* This value is updated in pa_source_volume_change_apply() and
 262          * used only by sources with PA_SOURCE_DEFERRED_VOLUME. */
 263         pa_cvolume current_hw_volume;
 264
 265         /* The amount of usec volume up events are delayed and volume
 266          * down events are made earlier. */
 267         uint32_t volume_change_safety_margin;
 268         /* Usec delay added to all volume change events, may be negative. */
 269         int32_t volume_change_extra_delay;
 270     } thread_info;
 271
 272     void *userdata;
 273 };
 274
 275 PA_DECLARE_PUBLIC_CLASS(pa_source);
 276 #define PA_SOURCE(s) pa_source_cast(s)
 277
 278 typedef enum pa_source_message {
 279     PA_SOURCE_MESSAGE_ADD_OUTPUT,
 280     PA_SOURCE_MESSAGE_REMOVE_OUTPUT,
 281     PA_SOURCE_MESSAGE_GET_VOLUME,
 282     PA_SOURCE_MESSAGE_SET_SHARED_VOLUME,
 283     PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED,
 284     PA_SOURCE_MESSAGE_SET_VOLUME,
 285     PA_SOURCE_MESSAGE_SYNC_VOLUMES,
 286     PA_SOURCE_MESSAGE_GET_MUTE,
 287     PA_SOURCE_MESSAGE_SET_MUTE,
 288     PA_SOURCE_MESSAGE_GET_LATENCY,
 289     PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY,
 290     PA_SOURCE_MESSAGE_SET_STATE,
 291     PA_SOURCE_MESSAGE_SET_LATENCY_RANGE,
 292     PA_SOURCE_MESSAGE_GET_LATENCY_RANGE,
 293     PA_SOURCE_MESSAGE_SET_FIXED_LATENCY,
 294     PA_SOURCE_MESSAGE_GET_FIXED_LATENCY,
 295     PA_SOURCE_MESSAGE_GET_MAX_REWIND,
 296     PA_SOURCE_MESSAGE_SET_MAX_REWIND,
 297     PA_SOURCE_MESSAGE_SET_PORT,
 298     PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE,
 299     PA_SOURCE_MESSAGE_SET_PORT_LATENCY_OFFSET,
 300     PA_SOURCE_MESSAGE_MAX
 301 } pa_source_message_t;
 302
 303 typedef struct pa_source_new_data {
 304     pa_suspend_cause_t suspend_cause;
 305
 306     char *name;
 307     pa_proplist *proplist;
 308
 309     const char *driver;
 310     pa_module *module;
 311     pa_card *card;
 312
 313     pa_hashmap *ports;
 314     char *active_port;
 315
 316     pa_sample_spec sample_spec;
 317     pa_channel_map channel_map;
 318     uint32_t alternate_sample_rate;
 319     pa_cvolume volume;
 320     bool muted:1;
 321
 322     bool volume_is_set:1;
 323     bool muted_is_set:1;
 324     bool sample_spec_is_set:1;
 325     bool channel_map_is_set:1;
 326     bool alternate_sample_rate_is_set:1;
 327
 328     bool namereg_fail:1;
 329
 330     bool save_port:1;
 331     bool save_volume:1;
 332     bool save_muted:1;
 333 } pa_source_new_data;
 334
 335 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);
 336 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name);
 337 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec);
 338 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
 339 void pa_source_new_data_set_alternate_sample_rate(pa_source_new_data *data, const uint32_t alternate_sample_rate);
 340 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
 341 void pa_source_new_data_set_muted(pa_source_new_data *data, bool mute);
 342 void pa_source_new_data_set_port(pa_source_new_data *data, const char *port);
 343 void pa_source_new_data_done(pa_source_new_data *data);
 344
 345 /*** To be called exclusively by the source driver, from main context */
 346
 347 pa_source* pa_source_new(
 348         pa_core *core,
 349         pa_source_new_data *data,
 350         pa_source_flags_t flags);
 351
 352 void pa_source_set_get_volume_callback(pa_source *s, pa_source_cb_t cb);
 353 void pa_source_set_set_volume_callback(pa_source *s, pa_source_cb_t cb);
 354 void pa_source_set_write_volume_callback(pa_source *s, pa_source_cb_t cb);
 355 void pa_source_set_get_mute_callback(pa_source *s, pa_source_get_mute_cb_t cb);
 356 void pa_source_set_set_mute_callback(pa_source *s, pa_source_cb_t cb);
 357 void pa_source_enable_decibel_volume(pa_source *s, bool enable);
 358
 359 void pa_source_put(pa_source *s);
 360 void pa_source_unlink(pa_source *s);
 361
 362 void pa_source_set_description(pa_source *s, const char *description);
 363 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
 364 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
 365
 366 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind);
 367 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 368 void pa_source_set_fixed_latency(pa_source *s, pa_usec_t latency);
 369
 370 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume);
 371 void pa_source_volume_changed(pa_source *s, const pa_cvolume *new_volume);
 372 void pa_source_mute_changed(pa_source *s, bool new_muted);
 373
 374 int pa_source_sync_suspend(pa_source *s);
 375
 376 void pa_source_update_flags(pa_source *s, pa_source_flags_t mask, pa_source_flags_t value);
 377
 378 /*** May be called by everyone, from main context */
 379
 380 void pa_source_set_port_latency_offset(pa_source *s, int64_t offset);
 381
 382 /* The returned value is supposed to be in the time domain of the sound card! */
 383 pa_usec_t pa_source_get_latency(pa_source *s);
 384 pa_usec_t pa_source_get_requested_latency(pa_source *s);
 385 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 386 pa_usec_t pa_source_get_fixed_latency(pa_source *s);
 387
 388 size_t pa_source_get_max_rewind(pa_source *s);
 389
 390 int pa_source_update_status(pa_source*s);
 391 int pa_source_suspend(pa_source *s, bool suspend, pa_suspend_cause_t cause);
 392 int pa_source_suspend_all(pa_core *c, bool suspend, pa_suspend_cause_t cause);
 393
 394 /* Use this instead of checking s->flags & PA_SOURCE_FLAT_VOLUME directly. */
 395 bool pa_source_flat_volume_enabled(pa_source *s);
 396
 397 /* Get the master source when sharing volumes */
 398 pa_source *pa_source_get_master(pa_source *s);
 399
 400 bool pa_source_is_filter(pa_source *s);
 401
 402 /* Is the source in passthrough mode? (that is, is this a monitor source for a sink
 403  * that has a passthrough sink input connected to it. */
 404 bool pa_source_is_passthrough(pa_source *s);
 405 /* These should be called when a source enters/leaves passthrough mode */
 406 void pa_source_enter_passthrough(pa_source *s);
 407 void pa_source_leave_passthrough(pa_source *s);
 408
 409 void pa_source_set_volume(pa_source *source, const pa_cvolume *volume, bool sendmsg, bool save);
 410 const pa_cvolume *pa_source_get_volume(pa_source *source, bool force_refresh);
 411
 412 void pa_source_set_mute(pa_source *source, bool mute, bool save);
 413 bool pa_source_get_mute(pa_source *source, bool force_refresh);
 414
 415 bool pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p);
 416
 417 int pa_source_set_port(pa_source *s, const char *name, bool save);
 418 void pa_source_set_mixer_dirty(pa_source *s, bool is_dirty);
 419
 420 int pa_source_reconfigure(pa_source *s, pa_sample_spec *spec, bool passthrough);
 421
 422 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
 423 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */
 424
 425 /* Returns how many streams are active that don't allow suspensions. If
 426  * "ignore" is non-NULL, that stream is not included in the count. */
 427 unsigned pa_source_check_suspend(pa_source *s, pa_source_output *ignore);
 428
 429 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
 430
 431 const char *pa_source_state_to_string(pa_source_state_t state);
 432
 433 /* Moves all inputs away, and stores them in pa_queue */
 434 pa_queue *pa_source_move_all_start(pa_source *s, pa_queue *q);
 435 void pa_source_move_all_finish(pa_source *s, pa_queue *q, bool save);
 436 void pa_source_move_all_fail(pa_queue *q);
 437
 438 /* Returns a copy of the source formats. TODO: Get rid of this function (or at
 439  * least get rid of the copying). There's no good reason to copy the formats
 440  * every time someone wants to know what formats the source supports. The
 441  * formats idxset could be stored directly in the pa_source struct.
 442  * https://bugs.freedesktop.org/show_bug.cgi?id=71924 */
 443 pa_idxset* pa_source_get_formats(pa_source *s);
 444
 445 bool pa_source_check_format(pa_source *s, pa_format_info *f);
 446 pa_idxset* pa_source_check_formats(pa_source *s, pa_idxset *in_formats);
 447
 448 /*** To be called exclusively by the source driver, from IO context */
 449
 450 void pa_source_post(pa_source*s, const pa_memchunk *chunk);
 451 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk);
 452 void pa_source_process_rewind(pa_source *s, size_t nbytes);
 453
 454 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
 455
 456 void pa_source_attach_within_thread(pa_source *s);
 457 void pa_source_detach_within_thread(pa_source *s);
 458
 459 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s);
 460
 461 void pa_source_set_max_rewind_within_thread(pa_source *s, size_t max_rewind);
 462
 463 void pa_source_set_latency_range_within_thread(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 464 void pa_source_set_fixed_latency_within_thread(pa_source *s, pa_usec_t latency);
 465
 466 void pa_source_update_volume_and_mute(pa_source *s);
 467
 468 bool pa_source_volume_change_apply(pa_source *s, pa_usec_t *usec_to_next);
 469
 470 /*** To be called exclusively by source output drivers, from IO context */
 471
 472 void pa_source_invalidate_requested_latency(pa_source *s, bool dynamic);
 473 int64_t pa_source_get_latency_within_thread(pa_source *s, bool allow_negative);
 474
 475 /* Called from the main thread, from source-output.c only. The normal way to
 476  * set the source reference volume is to call pa_source_set_volume(), but the
 477  * flat volume logic in source-output.c needs also a function that doesn't do
 478  * all the extra stuff that pa_source_set_volume() does. This function simply
 479  * sets s->reference_volume and fires change notifications. */
 480 void pa_source_set_reference_volume_direct(pa_source *s, const pa_cvolume *volume);
 481
 482 #define pa_source_assert_io_context(s) \
 483     pa_assert(pa_thread_mq_get() || !PA_SOURCE_IS_LINKED((s)->state))
 484
 485 #endif