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