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