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