src/pulsecore/sink.h

   1 #ifndef foopulsesinkhfoo
   2 #define foopulsesinkhfoo
   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_sink pa_sink;
  27 typedef struct pa_device_port pa_device_port;
  28 typedef struct pa_sink_volume_change pa_sink_volume_change;
  29
  30 #include <inttypes.h>
  31
  32 #include <pulse/def.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/source.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/queue.h>
  47 #include <pulsecore/thread-mq.h>
  48 #include <pulsecore/sink-input.h>
  49
  50 #define PA_MAX_INPUTS_PER_SINK 32
  51
  52 /* Returns true if sink is linked: registered and accessible from client side. */
  53 static inline pa_bool_t PA_SINK_IS_LINKED(pa_sink_state_t x) {
  54     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  55 }
  56
  57 struct pa_device_port {
  58     char *name;
  59     char *description;
  60
  61     unsigned priority;
  62
  63     /* .. followed by some implementation specific data */
  64 };
  65
  66 #define PA_DEVICE_PORT_DATA(d) ((void*) ((uint8_t*) d + PA_ALIGN(sizeof(pa_device_port))))
  67
  68 struct pa_sink {
  69     pa_msgobject parent;
  70
  71     uint32_t index;
  72     pa_core *core;
  73
  74     pa_sink_state_t state;
  75     pa_sink_flags_t flags;
  76     pa_suspend_cause_t suspend_cause;
  77
  78     char *name;
  79     char *driver;                           /* may be NULL */
  80     pa_proplist *proplist;
  81
  82     pa_module *module;                      /* may be NULL */
  83     pa_card *card;                          /* may be NULL */
  84
  85     pa_sample_spec sample_spec;
  86     pa_channel_map channel_map;
  87
  88     pa_idxset *inputs;
  89     unsigned n_corked;
  90     pa_source *monitor_source;
  91     pa_sink_input *input_to_master;         /* non-NULL only for filter sinks */
  92
  93     pa_volume_t base_volume; /* shall be constant */
  94     unsigned n_volume_steps; /* shall be constant */
  95
  96     /* Also see http://pulseaudio.org/wiki/InternalVolumes */
  97     pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative sink input 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     pa_bool_t muted:1;
 102
 103     pa_bool_t refresh_volume:1;
 104     pa_bool_t refresh_muted:1;
 105     pa_bool_t save_port:1;
 106     pa_bool_t save_volume:1;
 107     pa_bool_t save_muted:1;
 108
 109     pa_asyncmsgq *asyncmsgq;
 110
 111     pa_memchunk silence;
 112
 113     pa_hashmap *ports;
 114     pa_device_port *active_port;
 115
 116     unsigned priority;
 117
 118     /* Called when the main loop requests a state change. Called from
 119      * main loop context. If returns -1 the state change will be
 120      * inhibited */
 121     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
 122
 123     /* Sink drivers that support hardware volume may set this
 124      * callback. This is called when the current volume needs to be
 125      * re-read from the hardware.
 126      *
 127      * There are two ways for drivers to implement hardware volume
 128      * query: either set this callback or handle
 129      * PA_SINK_MESSAGE_GET_VOLUME. The callback implementation or the
 130      * message handler must update s->real_volume and s->soft_volume
 131      * (using pa_sink_set_soft_volume()) to match the current hardware
 132      * volume.
 133      *
 134      * If PA_SINK_SYNC_VOLUME is not set, then this is called from the
 135      * main thread before sending PA_SINK_MESSAGE_GET_VOLUME, so in
 136      * this case the driver can choose whether to read the volume from
 137      * the hardware in the main thread or in the IO thread.
 138      *
 139      * If PA_SINK_SYNC_VOLUME is set, then this is called from the IO
 140      * thread within the default handler for
 141      * PA_SINK_MESSAGE_GET_VOLUME (the main thread is waiting while
 142      * the message is being processed), so there's no choice of where
 143      * to do the volume reading - it has to be done in the IO thread
 144      * always. */
 145     void (*get_volume)(pa_sink *s);             /* may be NULL */
 146
 147     /* Sink drivers that support hardware volume must set this
 148      * callback. This is called when the hardware volume needs to be
 149      * updated.
 150      *
 151      * If PA_SINK_SYNC_VOLUME is not set, then this is called from the
 152      * main thread. The callback implementation must set the hardware
 153      * volume according to s->real_volume. If the driver can't set the
 154      * hardware volume to the exact requested value, it has to update
 155      * s->real_volume and/or s->soft_volume so that they together
 156      * match the actual hardware volume that was set.
 157      *
 158      * If PA_SINK_SYNC_VOLUME is set, then this is called from the IO
 159      * thread. The callback implementation must not actually set the
 160      * hardware volume yet, but it must check how close to the
 161      * requested volume the hardware volume can be set, and update
 162      * s->real_volume and/or s->soft_volume so that they together
 163      * match the actual hardware volume that will be set later in the
 164      * write_volume callback. */
 165     void (*set_volume)(pa_sink *s);             /* ditto */
 166
 167     /* Sink drivers that set PA_SINK_SYNC_VOLUME must provide this
 168      * callback. This callback is not used with sinks that do not set
 169      * PA_SINK_SYNC_VOLUME. This is called from the IO thread when a
 170      * pending hardware volume change has to be written to the
 171      * hardware. The requested volume is passed to the callback
 172      * implementation in s->thread_info.current_hw_volume.
 173      *
 174      * The call is done inside pa_sink_volume_change_apply(), which is
 175      * not called automatically - it is the driver's responsibility to
 176      * schedule that function to be called at the right times in the
 177      * IO thread. */
 178     void (*write_volume)(pa_sink *s);           /* ditto */
 179
 180     /* Called when the mute setting is queried. A PA_SINK_MESSAGE_GET_MUTE
 181      * message will also be sent. Called from IO thread if PA_SINK_SYNC_VOLUME
 182      * flag is set otherwise from main loop context. If refresh_mute is FALSE
 183      * neither this function is called nor a message is sent.*/
 184     void (*get_mute)(pa_sink *s);               /* ditto */
 185
 186     /* Called when the mute setting shall be changed. A PA_SINK_MESSAGE_SET_MUTE
 187      * message will also be sent. Called from IO thread if PA_SINK_SYNC_VOLUME
 188      * flag is set otherwise from main loop context. */
 189     void (*set_mute)(pa_sink *s);               /* ditto */
 190
 191     /* Called when a rewind request is issued. Called from IO thread
 192      * context. */
 193     void (*request_rewind)(pa_sink *s);        /* ditto */
 194
 195     /* Called when a the requested latency is changed. Called from IO
 196      * thread context. */
 197     void (*update_requested_latency)(pa_sink *s); /* ditto */
 198
 199     /* Called whenever the port shall be changed. Called from main
 200      * thread. */
 201     int (*set_port)(pa_sink *s, pa_device_port *port); /* ditto */
 202
 203     /* Called to get the list of formats supported by the sink, sorted
 204      * in descending order of preference. */
 205     pa_idxset* (*get_formats)(pa_sink *s); /* ditto */
 206
 207     /* Contains copies of the above data so that the real-time worker
 208      * thread can work without access locking */
 209     struct {
 210         pa_sink_state_t state;
 211         pa_hashmap *inputs;
 212
 213         pa_rtpoll *rtpoll;
 214
 215         pa_cvolume soft_volume;
 216         pa_bool_t soft_muted:1;
 217
 218         /* The requested latency is used for dynamic latency
 219          * sinks. For fixed latency sinks it is always identical to
 220          * the fixed_latency. See below. */
 221         pa_bool_t requested_latency_valid:1;
 222         pa_usec_t requested_latency;
 223
 224         /* The number of bytes streams need to keep around as history to
 225          * be able to satisfy every DMA buffer rewrite */
 226         size_t max_rewind;
 227
 228         /* The number of bytes streams need to keep around to satisfy
 229          * every DMA write request */
 230         size_t max_request;
 231
 232         /* Maximum of what clients requested to rewind in this cycle */
 233         size_t rewind_nbytes;
 234         pa_bool_t rewind_requested;
 235
 236         /* Both dynamic and fixed latencies will be clamped to this
 237          * range. */
 238         pa_usec_t min_latency; /* we won't go below this latency */
 239         pa_usec_t max_latency; /* An upper limit for the latencies */
 240
 241         /* 'Fixed' simply means that the latency is exclusively
 242          * decided on by the sink, and the clients have no influence
 243          * in changing it */
 244         pa_usec_t fixed_latency; /* for sinks with PA_SINK_DYNAMIC_LATENCY this is 0 */
 245
 246         /* Delayed volume change events are queued here. The events
 247          * are stored in expiration order. The one expiring next is in
 248          * the head of the list. */
 249         PA_LLIST_HEAD(pa_sink_volume_change, volume_changes);
 250         pa_sink_volume_change *volume_changes_tail;
 251         /* This value is updated in pa_sink_volume_change_apply() and
 252          * used only by sinks with PA_SINK_SYNC_VOLUME. */
 253         pa_cvolume current_hw_volume;
 254
 255         /* The amount of usec volume up events are delayed and volume
 256          * down events are made earlier. */
 257         uint32_t volume_change_safety_margin;
 258         /* Usec delay added to all volume change events, may be negative. */
 259         int32_t volume_change_extra_delay;
 260     } thread_info;
 261
 262     void *userdata;
 263 };
 264
 265 PA_DECLARE_PUBLIC_CLASS(pa_sink);
 266 #define PA_SINK(s) (pa_sink_cast(s))
 267
 268 typedef enum pa_sink_message {
 269     PA_SINK_MESSAGE_ADD_INPUT,
 270     PA_SINK_MESSAGE_REMOVE_INPUT,
 271     PA_SINK_MESSAGE_GET_VOLUME,
 272     PA_SINK_MESSAGE_SET_SHARED_VOLUME,
 273     PA_SINK_MESSAGE_SET_VOLUME_SYNCED,
 274     PA_SINK_MESSAGE_SET_VOLUME,
 275     PA_SINK_MESSAGE_SYNC_VOLUMES,
 276     PA_SINK_MESSAGE_GET_MUTE,
 277     PA_SINK_MESSAGE_SET_MUTE,
 278     PA_SINK_MESSAGE_GET_LATENCY,
 279     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
 280     PA_SINK_MESSAGE_SET_STATE,
 281     PA_SINK_MESSAGE_START_MOVE,
 282     PA_SINK_MESSAGE_FINISH_MOVE,
 283     PA_SINK_MESSAGE_ATTACH,
 284     PA_SINK_MESSAGE_DETACH,
 285     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
 286     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
 287     PA_SINK_MESSAGE_SET_FIXED_LATENCY,
 288     PA_SINK_MESSAGE_GET_FIXED_LATENCY,
 289     PA_SINK_MESSAGE_GET_MAX_REWIND,
 290     PA_SINK_MESSAGE_GET_MAX_REQUEST,
 291     PA_SINK_MESSAGE_SET_MAX_REWIND,
 292     PA_SINK_MESSAGE_SET_MAX_REQUEST,
 293     PA_SINK_MESSAGE_SET_PORT,
 294     PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE,
 295     PA_SINK_MESSAGE_MAX
 296 } pa_sink_message_t;
 297
 298 typedef struct pa_sink_new_data {
 299     char *name;
 300     pa_proplist *proplist;
 301
 302     const char *driver;
 303     pa_module *module;
 304     pa_card *card;
 305
 306     pa_hashmap *ports;
 307     char *active_port;
 308
 309     pa_sample_spec sample_spec;
 310     pa_channel_map channel_map;
 311     pa_cvolume volume;
 312     pa_bool_t muted :1;
 313
 314     pa_bool_t sample_spec_is_set:1;
 315     pa_bool_t channel_map_is_set:1;
 316     pa_bool_t volume_is_set:1;
 317     pa_bool_t muted_is_set:1;
 318
 319     pa_bool_t namereg_fail:1;
 320
 321     pa_bool_t save_port:1;
 322     pa_bool_t save_volume:1;
 323     pa_bool_t save_muted:1;
 324 } pa_sink_new_data;
 325
 326 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 327 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 328 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 329 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 330 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
 331 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
 332 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port);
 333 void pa_sink_new_data_done(pa_sink_new_data *data);
 334
 335 /*** To be called exclusively by the sink driver, from main context */
 336
 337 pa_sink* pa_sink_new(
 338         pa_core *core,
 339         pa_sink_new_data *data,
 340         pa_sink_flags_t flags);
 341
 342 void pa_sink_put(pa_sink *s);
 343 void pa_sink_unlink(pa_sink* s);
 344
 345 void pa_sink_set_description(pa_sink *s, const char *description);
 346 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
 347 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
 348
 349 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
 350 void pa_sink_set_max_request(pa_sink *s, size_t max_request);
 351 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 352 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency);
 353
 354 void pa_sink_detach(pa_sink *s);
 355 void pa_sink_attach(pa_sink *s);
 356
 357 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
 358 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_volume);
 359 void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted);
 360
 361 void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value);
 362
 363 pa_bool_t pa_device_init_description(pa_proplist *p);
 364 pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink);
 365 pa_bool_t pa_device_init_intended_roles(pa_proplist *p);
 366 unsigned pa_device_init_priority(pa_proplist *p);
 367
 368 /**** May be called by everyone, from main context */
 369
 370 /* The returned value is supposed to be in the time domain of the sound card! */
 371 pa_usec_t pa_sink_get_latency(pa_sink *s);
 372 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
 373 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 374 pa_usec_t pa_sink_get_fixed_latency(pa_sink *s);
 375
 376 size_t pa_sink_get_max_rewind(pa_sink *s);
 377 size_t pa_sink_get_max_request(pa_sink *s);
 378
 379 int pa_sink_update_status(pa_sink*s);
 380 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause);
 381 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
 382
 383 /* Use this instead of checking s->flags & PA_SINK_FLAT_VOLUME directly. */
 384 pa_bool_t pa_sink_flat_volume_enabled(pa_sink *s);
 385
 386 /* Is the sink in passthrough mode? (that is, is there a passthrough sink input
 387  * connected to this sink? */
 388 pa_bool_t pa_sink_is_passthrough(pa_sink *s);
 389
 390 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume, pa_bool_t sendmsg, pa_bool_t save);
 391 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_bool_t force_refresh);
 392
 393 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute, pa_bool_t save);
 394 pa_bool_t pa_sink_get_mute(pa_sink *sink, pa_bool_t force_refresh);
 395
 396 pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p);
 397
 398 int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save);
 399
 400 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 401 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 402 unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
 403 #define pa_sink_get_state(s) ((s)->state)
 404
 405 /* Moves all inputs away, and stores them in pa_queue */
 406 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
 407 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save);
 408 void pa_sink_move_all_fail(pa_queue *q);
 409
 410 pa_idxset* pa_sink_get_formats(pa_sink *s);
 411 pa_bool_t pa_sink_check_format(pa_sink *s, pa_format_info *f);
 412 pa_idxset* pa_sink_check_formats(pa_sink *s, pa_idxset *in_formats);
 413
 414 /*** To be called exclusively by the sink driver, from IO context */
 415
 416 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 417 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 418 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 419 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 420
 421 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
 422
 423 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 424
 425 void pa_sink_attach_within_thread(pa_sink *s);
 426 void pa_sink_detach_within_thread(pa_sink *s);
 427
 428 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
 429
 430 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
 431 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
 432
 433 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 434 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency);
 435
 436 void pa_sink_update_volume_and_mute(pa_sink *s);
 437
 438 pa_bool_t pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next);
 439
 440 /*** To be called exclusively by sink input drivers, from IO context */
 441
 442 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 443
 444 void pa_sink_invalidate_requested_latency(pa_sink *s, pa_bool_t dynamic);
 445
 446 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s);
 447
 448 pa_device_port *pa_device_port_new(const char *name, const char *description, size_t extra);
 449 void pa_device_port_free(pa_device_port *p);
 450
 451 /* Verify that we called in IO context (aka 'thread context), or that
 452  * the sink is not yet set up, i.e. the thread not set up yet. See
 453  * pa_assert_io_context() in thread-mq.h for more information. */
 454 #define pa_sink_assert_io_context(s) \
 455     pa_assert(pa_thread_mq_get() || !PA_SINK_IS_LINKED((s)->state))
 456
 457 #endif