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