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