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