code.delx.au - pulseaudio/blob - 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 32
  52
  53 /* Returns true if source is linked: registered and accessible from client side. */
  54 static inline pa_bool_t 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 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://pulseaudio.org/wiki/InternalVolumes */
  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     pa_bool_t muted:1;
  97
  98     pa_bool_t refresh_volume:1;
  99     pa_bool_t refresh_muted:1;
 100     pa_bool_t save_port:1;
 101     pa_bool_t save_volume:1;
 102     pa_bool_t save_muted:1;
 103
 104     /* Saved volume state while we're in passthrough mode */
 105     pa_cvolume saved_volume;
 106     pa_bool_t 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
 115     unsigned priority;
 116
 117     /* Called when the main loop requests a state change. Called from
 118      * main loop context. If returns -1 the state change will be
 119      * inhibited */
 120     int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */
 121
 122     /* Called when the volume is queried. Called from main loop
 123      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message
 124      * will be sent to the IO thread instead. If refresh_volume is
 125      * FALSE neither this function is called nor a message is sent.
 126      *
 127      * You must use the function pa_source_set_get_volume_callback() to
 128      * set this callback. */
 129     pa_source_cb_t get_volume; /* may be NULL */
 130
 131     /* Called when the volume shall be changed. Called from main loop
 132      * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message
 133      * will be sent to the IO thread instead.
 134      *
 135      * You must use the function pa_source_set_set_volume_callback() to
 136      * set this callback. */
 137     pa_source_cb_t set_volume; /* may be NULL */
 138
 139     /* Source drivers that set PA_SOURCE_DEFERRED_VOLUME must provide this
 140      * callback. This callback is not used with source that do not set
 141      * PA_SOURCE_DEFERRED_VOLUME. This is called from the IO thread when a
 142      * pending hardware volume change has to be written to the
 143      * hardware. The requested volume is passed to the callback
 144      * implementation in s->thread_info.current_hw_volume.
 145      *
 146      * The call is done inside pa_source_volume_change_apply(), which is
 147      * not called automatically - it is the driver's responsibility to
 148      * schedule that function to be called at the right times in the
 149      * IO thread.
 150      *
 151      * You must use the function pa_source_set_write_volume_callback() to
 152      * set this callback. */
 153     pa_source_cb_t write_volume; /* may be NULL */
 154
 155     /* Called when the mute setting is queried. Called from main loop
 156      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_MUTE message
 157      * will be sent to the IO thread instead. If refresh_mute is
 158      * FALSE neither this function is called nor a message is sent.
 159      *
 160      * You must use the function pa_source_set_get_mute_callback() to
 161      * set this callback. */
 162     pa_source_cb_t get_mute; /* may be NULL */
 163
 164     /* Called when the mute setting shall be changed. Called from main
 165      * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE
 166      * message will be sent to the IO thread instead.
 167      *
 168      * You must use the function pa_source_set_set_mute_callback() to
 169      * set this callback. */
 170     pa_source_cb_t set_mute; /* may be NULL */
 171
 172     /* Called when a the requested latency is changed. Called from IO
 173      * thread context. */
 174     pa_source_cb_t update_requested_latency; /* may be NULL */
 175
 176     /* Called whenever the port shall be changed. Called from main
 177      * thread. */
 178     int (*set_port)(pa_source *s, pa_device_port *port); /*ditto */
 179
 180     /* Called to get the list of formats supported by the source, sorted
 181      * in descending order of preference. */
 182     pa_idxset* (*get_formats)(pa_source *s); /* ditto */
 183
 184     /* Called whenever the sampling frequency shall be changed. Called from
 185      * main thread. */
 186     pa_bool_t (*update_rate)(pa_source *s, uint32_t rate);
 187
 188     /* Contains copies of the above data so that the real-time worker
 189      * thread can work without access locking */
 190     struct {
 191         pa_source_state_t state;
 192         pa_hashmap *outputs;
 193
 194         pa_rtpoll *rtpoll;
 195
 196         pa_cvolume soft_volume;
 197         pa_bool_t soft_muted:1;
 198
 199         pa_bool_t requested_latency_valid:1;
 200         pa_usec_t requested_latency;
 201
 202         /* Then number of bytes this source will be rewound for at
 203          * max. (Only used on monitor sources) */
 204         size_t max_rewind;
 205
 206         pa_usec_t min_latency; /* we won't go below this latency */
 207         pa_usec_t max_latency; /* An upper limit for the latencies */
 208
 209         pa_usec_t fixed_latency; /* for sources with PA_SOURCE_DYNAMIC_LATENCY this is 0 */
 210
 211         /* Delayed volume change events are queued here. The events
 212          * are stored in expiration order. The one expiring next is in
 213          * the head of the list. */
 214         PA_LLIST_HEAD(pa_source_volume_change, volume_changes);
 215         pa_source_volume_change *volume_changes_tail;
 216         /* This value is updated in pa_source_volume_change_apply() and
 217          * used only by sources with PA_SOURCE_DEFERRED_VOLUME. */
 218         pa_cvolume current_hw_volume;
 219
 220         /* The amount of usec volume up events are delayed and volume
 221          * down events are made earlier. */
 222         uint32_t volume_change_safety_margin;
 223         /* Usec delay added to all volume change events, may be negative. */
 224         int32_t volume_change_extra_delay;
 225 } thread_info;
 226
 227     void *userdata;
 228 };
 229
 230 PA_DECLARE_PUBLIC_CLASS(pa_source);
 231 #define PA_SOURCE(s) pa_source_cast(s)
 232
 233 typedef enum pa_source_message {
 234     PA_SOURCE_MESSAGE_ADD_OUTPUT,
 235     PA_SOURCE_MESSAGE_REMOVE_OUTPUT,
 236     PA_SOURCE_MESSAGE_GET_VOLUME,
 237     PA_SOURCE_MESSAGE_SET_SHARED_VOLUME,
 238     PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED,
 239     PA_SOURCE_MESSAGE_SET_VOLUME,
 240     PA_SOURCE_MESSAGE_SYNC_VOLUMES,
 241     PA_SOURCE_MESSAGE_GET_MUTE,
 242     PA_SOURCE_MESSAGE_SET_MUTE,
 243     PA_SOURCE_MESSAGE_GET_LATENCY,
 244     PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY,
 245     PA_SOURCE_MESSAGE_SET_STATE,
 246     PA_SOURCE_MESSAGE_ATTACH,
 247     PA_SOURCE_MESSAGE_DETACH,
 248     PA_SOURCE_MESSAGE_SET_LATENCY_RANGE,
 249     PA_SOURCE_MESSAGE_GET_LATENCY_RANGE,
 250     PA_SOURCE_MESSAGE_SET_FIXED_LATENCY,
 251     PA_SOURCE_MESSAGE_GET_FIXED_LATENCY,
 252     PA_SOURCE_MESSAGE_GET_MAX_REWIND,
 253     PA_SOURCE_MESSAGE_SET_MAX_REWIND,
 254     PA_SOURCE_MESSAGE_SET_PORT,
 255     PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE,
 256     PA_SOURCE_MESSAGE_MAX
 257 } pa_source_message_t;
 258
 259 typedef struct pa_source_new_data {
 260     char *name;
 261     pa_proplist *proplist;
 262
 263     const char *driver;
 264     pa_module *module;
 265     pa_card *card;
 266
 267     pa_hashmap *ports;
 268     char *active_port;
 269
 270     pa_sample_spec sample_spec;
 271     pa_channel_map channel_map;
 272     uint32_t alternate_sample_rate;
 273     pa_cvolume volume;
 274     pa_bool_t muted:1;
 275
 276     pa_bool_t volume_is_set:1;
 277     pa_bool_t muted_is_set:1;
 278     pa_bool_t sample_spec_is_set:1;
 279     pa_bool_t channel_map_is_set:1;
 280     pa_bool_t alternate_sample_rate_is_set:1;
 281
 282     pa_bool_t namereg_fail:1;
 283
 284     pa_bool_t save_port:1;
 285     pa_bool_t save_volume:1;
 286     pa_bool_t save_muted:1;
 287 } pa_source_new_data;
 288
 289 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);
 290 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name);
 291 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec);
 292 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
 293 void pa_source_new_data_set_alternate_sample_rate(pa_source_new_data *data, const uint32_t alternate_sample_rate);
 294 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
 295 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute);
 296 void pa_source_new_data_set_port(pa_source_new_data *data, const char *port);
 297 void pa_source_new_data_done(pa_source_new_data *data);
 298
 299 /*** To be called exclusively by the source driver, from main context */
 300
 301 pa_source* pa_source_new(
 302         pa_core *core,
 303         pa_source_new_data *data,
 304         pa_source_flags_t flags);
 305
 306 void pa_source_set_get_volume_callback(pa_source *s, pa_source_cb_t cb);
 307 void pa_source_set_set_volume_callback(pa_source *s, pa_source_cb_t cb);
 308 void pa_source_set_write_volume_callback(pa_source *s, pa_source_cb_t cb);
 309 void pa_source_set_get_mute_callback(pa_source *s, pa_source_cb_t cb);
 310 void pa_source_set_set_mute_callback(pa_source *s, pa_source_cb_t cb);
 311 void pa_source_enable_decibel_volume(pa_source *s, pa_bool_t enable);
 312
 313 void pa_source_put(pa_source *s);
 314 void pa_source_unlink(pa_source *s);
 315
 316 void pa_source_set_description(pa_source *s, const char *description);
 317 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
 318 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
 319
 320 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind);
 321 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 322 void pa_source_set_fixed_latency(pa_source *s, pa_usec_t latency);
 323
 324 void pa_source_detach(pa_source *s);
 325 void pa_source_attach(pa_source *s);
 326
 327 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume);
 328 void pa_source_volume_changed(pa_source *s, const pa_cvolume *new_volume);
 329 void pa_source_mute_changed(pa_source *s, pa_bool_t new_muted);
 330
 331 int pa_source_sync_suspend(pa_source *s);
 332
 333 void pa_source_update_flags(pa_source *s, pa_source_flags_t mask, pa_source_flags_t value);
 334
 335 /*** May be called by everyone, from main context */
 336
 337 /* The returned value is supposed to be in the time domain of the sound card! */
 338 pa_usec_t pa_source_get_latency(pa_source *s);
 339 pa_usec_t pa_source_get_requested_latency(pa_source *s);
 340 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 341 pa_usec_t pa_source_get_fixed_latency(pa_source *s);
 342
 343 size_t pa_source_get_max_rewind(pa_source *s);
 344
 345 int pa_source_update_status(pa_source*s);
 346 int pa_source_suspend(pa_source *s, pa_bool_t suspend, pa_suspend_cause_t cause);
 347 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
 348
 349 /* Use this instead of checking s->flags & PA_SOURCE_FLAT_VOLUME directly. */
 350 pa_bool_t pa_source_flat_volume_enabled(pa_source *s);
 351
 352 /* Get the master source when sharing volumes */
 353 pa_source *pa_source_get_master(pa_source *s);
 354
 355 /* Is the source in passthrough mode? (that is, is this a monitor source for a sink
 356  * that has a passthrough sink input connected to it. */
 357 pa_bool_t pa_source_is_passthrough(pa_source *s);
 358 /* These should be called when a source enters/leaves passthrough mode */
 359 void pa_source_enter_passthrough(pa_source *s);
 360 void pa_source_leave_passthrough(pa_source *s);
 361
 362 void pa_source_set_volume(pa_source *source, const pa_cvolume *volume, pa_bool_t sendmsg, pa_bool_t save);
 363 const pa_cvolume *pa_source_get_volume(pa_source *source, pa_bool_t force_refresh);
 364
 365 void pa_source_set_mute(pa_source *source, pa_bool_t mute, pa_bool_t save);
 366 pa_bool_t pa_source_get_mute(pa_source *source, pa_bool_t force_refresh);
 367
 368 pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p);
 369
 370 int pa_source_set_port(pa_source *s, const char *name, pa_bool_t save);
 371 pa_bool_t pa_source_update_rate(pa_source *s, uint32_t rate, pa_bool_t passthrough);
 372
 373 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
 374 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */
 375 unsigned pa_source_check_suspend(pa_source *s); /* Returns how many streams are active that don't allow suspensions */
 376 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
 377
 378 /* Moves all inputs away, and stores them in pa_queue */
 379 pa_queue *pa_source_move_all_start(pa_source *s, pa_queue *q);
 380 void pa_source_move_all_finish(pa_source *s, pa_queue *q, pa_bool_t save);
 381 void pa_source_move_all_fail(pa_queue *q);
 382
 383 pa_idxset* pa_source_get_formats(pa_source *s);
 384 pa_bool_t pa_source_check_format(pa_source *s, pa_format_info *f);
 385 pa_idxset* pa_source_check_formats(pa_source *s, pa_idxset *in_formats);
 386
 387 /*** To be called exclusively by the source driver, from IO context */
 388
 389 void pa_source_post(pa_source*s, const pa_memchunk *chunk);
 390 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk);
 391 void pa_source_process_rewind(pa_source *s, size_t nbytes);
 392
 393 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
 394
 395 void pa_source_attach_within_thread(pa_source *s);
 396 void pa_source_detach_within_thread(pa_source *s);
 397
 398 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s);
 399
 400 void pa_source_set_max_rewind_within_thread(pa_source *s, size_t max_rewind);
 401
 402 void pa_source_set_latency_range_within_thread(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 403 void pa_source_set_fixed_latency_within_thread(pa_source *s, pa_usec_t latency);
 404
 405 void pa_source_update_volume_and_mute(pa_source *s);
 406
 407 pa_bool_t pa_source_volume_change_apply(pa_source *s, pa_usec_t *usec_to_next);
 408
 409 /*** To be called exclusively by source output drivers, from IO context */
 410
 411 void pa_source_invalidate_requested_latency(pa_source *s, pa_bool_t dynamic);
 412 pa_usec_t pa_source_get_latency_within_thread(pa_source *s);
 413
 414 #define pa_source_assert_io_context(s) \
 415     pa_assert(pa_thread_mq_get() || !PA_SOURCE_IS_LINKED((s)->state))
 416
 417 #endif