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
  29 #include <inttypes.h>
  30
  31 #include <pulse/def.h>
  32 #include <pulse/sample.h>
  33 #include <pulse/channelmap.h>
  34 #include <pulse/volume.h>
  35
  36 #include <pulsecore/core.h>
  37 #include <pulsecore/idxset.h>
  38 #include <pulsecore/source.h>
  39 #include <pulsecore/module.h>
  40 #include <pulsecore/refcnt.h>
  41 #include <pulsecore/msgobject.h>
  42 #include <pulsecore/rtpoll.h>
  43 #include <pulsecore/card.h>
  44 #include <pulsecore/queue.h>
  45 #include <pulsecore/thread-mq.h>
  46
  47 #define PA_MAX_INPUTS_PER_SINK 32
  48
  49 /* Returns true if sink is linked: registered and accessible from client side. */
  50 static inline pa_bool_t PA_SINK_IS_LINKED(pa_sink_state_t x) {
  51     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  52 }
  53
  54 struct pa_device_port {
  55     char *name;
  56     char *description;
  57
  58     unsigned priority;
  59
  60     /* .. followed by some implementation specific data */
  61 };
  62
  63 #define PA_DEVICE_PORT_DATA(d) ((void*) ((uint8_t*) d + PA_ALIGN(sizeof(pa_device_port))))
  64
  65 struct pa_sink {
  66     pa_msgobject parent;
  67
  68     uint32_t index;
  69     pa_core *core;
  70
  71     pa_sink_state_t state;
  72     pa_sink_flags_t flags;
  73     pa_suspend_cause_t suspend_cause;
  74
  75     char *name;
  76     char *driver;                           /* may be NULL */
  77     pa_proplist *proplist;
  78
  79     pa_module *module;                      /* may be NULL */
  80     pa_card *card;                          /* may be NULL */
  81
  82     pa_sample_spec sample_spec;
  83     pa_channel_map channel_map;
  84
  85     pa_idxset *inputs;
  86     unsigned n_corked;
  87     pa_source *monitor_source;
  88
  89     pa_volume_t base_volume; /* shall be constant */
  90     unsigned n_volume_steps; /* shall be constant */
  91
  92     /* Also see http://pulseaudio.org/wiki/InternalVolumes */
  93     pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative sink input volumes */
  94     pa_cvolume real_volume;      /* The volume that the hardware is configured to  */
  95     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
  96
  97     pa_bool_t muted:1;
  98
  99     pa_bool_t refresh_volume:1;
 100     pa_bool_t refresh_muted:1;
 101     pa_bool_t save_port:1;
 102     pa_bool_t save_volume:1;
 103     pa_bool_t save_muted:1;
 104
 105     pa_asyncmsgq *asyncmsgq;
 106
 107     pa_memchunk silence;
 108
 109     pa_hashmap *ports;
 110     pa_device_port *active_port;
 111
 112     unsigned priority;
 113
 114     /* Called when the main loop requests a state change. Called from
 115      * main loop context. If returns -1 the state change will be
 116      * inhibited */
 117     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
 118
 119     /* Callled when the volume is queried. Called from main loop
 120      * context. If this is NULL a PA_SINK_MESSAGE_GET_VOLUME message
 121      * will be sent to the IO thread instead. If refresh_volume is
 122      * FALSE neither this function is called nor a message is sent. */
 123     void (*get_volume)(pa_sink *s);             /* may be NULL */
 124
 125     /* Called when the volume shall be changed. Called from main loop
 126      * context. If this is NULL a PA_SINK_MESSAGE_SET_VOLUME message
 127      * will be sent to the IO thread instead. */
 128     void (*set_volume)(pa_sink *s);             /* dito */
 129
 130     /* Called when the mute setting is queried. Called from main loop
 131      * context. If this is NULL a PA_SINK_MESSAGE_GET_MUTE message
 132      * will be sent to the IO thread instead. If refresh_mute is
 133      * FALSE neither this function is called nor a message is sent.*/
 134     void (*get_mute)(pa_sink *s);               /* dito */
 135
 136     /* Called when the mute setting shall be changed. Called from main
 137      * loop context. If this is NULL a PA_SINK_MESSAGE_SET_MUTE
 138      * message will be sent to the IO thread instead. */
 139     void (*set_mute)(pa_sink *s);               /* dito */
 140
 141     /* Called when a rewind request is issued. Called from IO thread
 142      * context. */
 143     void (*request_rewind)(pa_sink *s);        /* dito */
 144
 145     /* Called when a the requested latency is changed. Called from IO
 146      * thread context. */
 147     void (*update_requested_latency)(pa_sink *s); /* dito */
 148
 149     /* Called whenever the port shall be changed. Called from main
 150      * thread. */
 151     int (*set_port)(pa_sink *s, pa_device_port *port); /* dito */
 152
 153     /* Contains copies of the above data so that the real-time worker
 154      * thread can work without access locking */
 155     struct {
 156         pa_sink_state_t state;
 157         pa_hashmap *inputs;
 158
 159         pa_rtpoll *rtpoll;
 160
 161         pa_cvolume soft_volume;
 162         pa_bool_t soft_muted:1;
 163
 164         /* The requested latency is used for dynamic latency
 165          * sinks. For fixed latency sinks it is always identical to
 166          * the fixed_latency. See below. */
 167         pa_bool_t requested_latency_valid:1;
 168         pa_usec_t requested_latency;
 169
 170         /* The number of bytes streams need to keep around as history to
 171          * be able to satisfy every DMA buffer rewrite */
 172         size_t max_rewind;
 173
 174         /* The number of bytes streams need to keep around to satisfy
 175          * every DMA write request */
 176         size_t max_request;
 177
 178         /* Maximum of what clients requested to rewind in this cycle */
 179         size_t rewind_nbytes;
 180         pa_bool_t rewind_requested;
 181
 182         /* Both dynamic and fixed latencies will be clamped to this
 183          * range. */
 184         pa_usec_t min_latency; /* we won't go below this latency */
 185         pa_usec_t max_latency; /* An upper limit for the latencies */
 186
 187         /* 'Fixed' simply means that the latency is exclusively
 188          * decided on by the sink, and the clients have no influence
 189          * in changing it */
 190         pa_usec_t fixed_latency; /* for sinks with PA_SINK_DYNAMIC_LATENCY this is 0 */
 191     } thread_info;
 192
 193     void *userdata;
 194 };
 195
 196 PA_DECLARE_PUBLIC_CLASS(pa_sink);
 197 #define PA_SINK(s) (pa_sink_cast(s))
 198
 199 typedef enum pa_sink_message {
 200     PA_SINK_MESSAGE_ADD_INPUT,
 201     PA_SINK_MESSAGE_REMOVE_INPUT,
 202     PA_SINK_MESSAGE_GET_VOLUME,
 203     PA_SINK_MESSAGE_SET_VOLUME,
 204     PA_SINK_MESSAGE_SYNC_VOLUMES,
 205     PA_SINK_MESSAGE_GET_MUTE,
 206     PA_SINK_MESSAGE_SET_MUTE,
 207     PA_SINK_MESSAGE_GET_LATENCY,
 208     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
 209     PA_SINK_MESSAGE_SET_STATE,
 210     PA_SINK_MESSAGE_START_MOVE,
 211     PA_SINK_MESSAGE_FINISH_MOVE,
 212     PA_SINK_MESSAGE_ATTACH,
 213     PA_SINK_MESSAGE_DETACH,
 214     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
 215     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
 216     PA_SINK_MESSAGE_SET_FIXED_LATENCY,
 217     PA_SINK_MESSAGE_GET_FIXED_LATENCY,
 218     PA_SINK_MESSAGE_GET_MAX_REWIND,
 219     PA_SINK_MESSAGE_GET_MAX_REQUEST,
 220     PA_SINK_MESSAGE_SET_MAX_REWIND,
 221     PA_SINK_MESSAGE_SET_MAX_REQUEST,
 222     PA_SINK_MESSAGE_MAX
 223 } pa_sink_message_t;
 224
 225 typedef struct pa_sink_new_data {
 226     char *name;
 227     pa_proplist *proplist;
 228
 229     const char *driver;
 230     pa_module *module;
 231     pa_card *card;
 232
 233     pa_hashmap *ports;
 234     char *active_port;
 235
 236     pa_sample_spec sample_spec;
 237     pa_channel_map channel_map;
 238     pa_cvolume volume;
 239     pa_bool_t muted :1;
 240
 241     pa_bool_t sample_spec_is_set:1;
 242     pa_bool_t channel_map_is_set:1;
 243     pa_bool_t volume_is_set:1;
 244     pa_bool_t muted_is_set:1;
 245
 246     pa_bool_t namereg_fail:1;
 247
 248     pa_bool_t save_port:1;
 249     pa_bool_t save_volume:1;
 250     pa_bool_t save_muted:1;
 251 } pa_sink_new_data;
 252
 253 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 254 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 255 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 256 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 257 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
 258 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
 259 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port);
 260 void pa_sink_new_data_done(pa_sink_new_data *data);
 261
 262 /*** To be called exclusively by the sink driver, from main context */
 263
 264 pa_sink* pa_sink_new(
 265         pa_core *core,
 266         pa_sink_new_data *data,
 267         pa_sink_flags_t flags);
 268
 269 void pa_sink_put(pa_sink *s);
 270 void pa_sink_unlink(pa_sink* s);
 271
 272 void pa_sink_set_description(pa_sink *s, const char *description);
 273 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
 274 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
 275
 276 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
 277 void pa_sink_set_max_request(pa_sink *s, size_t max_request);
 278 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 279 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency);
 280
 281 void pa_sink_detach(pa_sink *s);
 282 void pa_sink_attach(pa_sink *s);
 283
 284 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
 285 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_volume);
 286 void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted);
 287
 288 void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value);
 289
 290 pa_bool_t pa_device_init_description(pa_proplist *p);
 291 pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink);
 292 pa_bool_t pa_device_init_intended_roles(pa_proplist *p);
 293 unsigned pa_device_init_priority(pa_proplist *p);
 294
 295 /**** May be called by everyone, from main context */
 296
 297 /* The returned value is supposed to be in the time domain of the sound card! */
 298 pa_usec_t pa_sink_get_latency(pa_sink *s);
 299 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
 300 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 301 pa_usec_t pa_sink_get_fixed_latency(pa_sink *s);
 302
 303 size_t pa_sink_get_max_rewind(pa_sink *s);
 304 size_t pa_sink_get_max_request(pa_sink *s);
 305
 306 int pa_sink_update_status(pa_sink*s);
 307 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause);
 308 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
 309
 310 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume, pa_bool_t sendmsg, pa_bool_t save);
 311 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_bool_t force_refresh);
 312
 313 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute, pa_bool_t save);
 314 pa_bool_t pa_sink_get_mute(pa_sink *sink, pa_bool_t force_refresh);
 315
 316 pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p);
 317
 318 int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save);
 319
 320 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 321 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 322 unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
 323 #define pa_sink_get_state(s) ((s)->state)
 324
 325 /* Moves all inputs away, and stores them in pa_queue */
 326 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
 327 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save);
 328 void pa_sink_move_all_fail(pa_queue *q);
 329
 330 /*** To be called exclusively by the sink driver, from IO context */
 331
 332 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 333 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 334 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 335 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 336
 337 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
 338
 339 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 340
 341 void pa_sink_attach_within_thread(pa_sink *s);
 342 void pa_sink_detach_within_thread(pa_sink *s);
 343
 344 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
 345
 346 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
 347 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
 348
 349 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 350 void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency);
 351
 352 /*** To be called exclusively by sink input drivers, from IO context */
 353
 354 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 355
 356 void pa_sink_invalidate_requested_latency(pa_sink *s, pa_bool_t dynamic);
 357
 358 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s);
 359
 360 pa_device_port *pa_device_port_new(const char *name, const char *description, size_t extra);
 361 void pa_device_port_free(pa_device_port *p);
 362
 363 /* Verify that we called in IO context (aka 'thread context), or that
 364  * the sink is not yet set up, i.e. the thread not set up yet. See
 365  * pa_assert_io_context() in thread-mq.h for more information. */
 366 #define pa_sink_assert_io_context(s) \
 367     pa_assert(pa_thread_mq_get() || !PA_SINK_IS_LINKED((s)->state))
 368
 369 #endif