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
  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 virtual_volume;   /* The volume clients are informed about */
  94     pa_cvolume reference_volume; /* The volume taken as refernce base for relative sink input volumes */
  95     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
  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     pa_asyncmsgq *asyncmsgq;
 105
 106     pa_memchunk silence;
 107
 108     pa_usec_t fixed_latency; /* for sinks with PA_SINK_DYNAMIC_LATENCY this is 0 */
 109
 110     pa_hashmap *ports;
 111     pa_device_port *active_port;
 112
 113     /* Called when the main loop requests a state change. Called from
 114      * main loop context. If returns -1 the state change will be
 115      * inhibited */
 116     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
 117
 118     /* Callled when the volume is queried. Called from main loop
 119      * context. If this is NULL a PA_SINK_MESSAGE_GET_VOLUME message
 120      * will be sent to the IO thread instead. If refresh_volume is
 121      * FALSE neither this function is called nor a message is sent. */
 122     void (*get_volume)(pa_sink *s);             /* may be NULL */
 123
 124     /* Called when the volume shall be changed. Called from main loop
 125      * context. If this is NULL a PA_SINK_MESSAGE_SET_VOLUME message
 126      * will be sent to the IO thread instead. */
 127     void (*set_volume)(pa_sink *s);             /* dito */
 128
 129     /* Called when the mute setting is queried. Called from main loop
 130      * context. If this is NULL a PA_SINK_MESSAGE_GET_MUTE message
 131      * will be sent to the IO thread instead. If refresh_mute is
 132      * FALSE neither this function is called nor a message is sent.*/
 133     void (*get_mute)(pa_sink *s);               /* dito */
 134
 135     /* Called when the mute setting shall be changed. Called from main
 136      * loop context. If this is NULL a PA_SINK_MESSAGE_SET_MUTE
 137      * message will be sent to the IO thread instead. */
 138     void (*set_mute)(pa_sink *s);               /* dito */
 139
 140     /* Called when a rewind request is issued. Called from IO thread
 141      * context. */
 142     void (*request_rewind)(pa_sink *s);        /* dito */
 143
 144     /* Called when a the requested latency is changed. Called from IO
 145      * thread context. */
 146     void (*update_requested_latency)(pa_sink *s); /* dito */
 147
 148     /* Called whenever the port shall be changed. Called from main
 149      * thread. */
 150     int (*set_port)(pa_sink *s, pa_device_port *port); /* dito */
 151
 152     /* Contains copies of the above data so that the real-time worker
 153      * thread can work without access locking */
 154     struct {
 155         pa_sink_state_t state;
 156         pa_hashmap *inputs;
 157
 158         pa_rtpoll *rtpoll;
 159
 160         pa_cvolume soft_volume;
 161         pa_bool_t soft_muted:1;
 162
 163         pa_bool_t requested_latency_valid:1;
 164         pa_usec_t requested_latency;
 165
 166         /* The number of bytes streams need to keep around as history to
 167          * be able to satisfy every DMA buffer rewrite */
 168         size_t max_rewind;
 169
 170         /* The number of bytes streams need to keep around to satisfy
 171          * every DMA write request */
 172         size_t max_request;
 173
 174         /* Maximum of what clients requested to rewind in this cycle */
 175         size_t rewind_nbytes;
 176         pa_bool_t rewind_requested;
 177
 178         pa_usec_t min_latency; /* we won't go below this latency */
 179         pa_usec_t max_latency; /* An upper limit for the latencies */
 180     } thread_info;
 181
 182     void *userdata;
 183 };
 184
 185 PA_DECLARE_CLASS(pa_sink);
 186 #define PA_SINK(s) (pa_sink_cast(s))
 187
 188 typedef enum pa_sink_message {
 189     PA_SINK_MESSAGE_ADD_INPUT,
 190     PA_SINK_MESSAGE_REMOVE_INPUT,
 191     PA_SINK_MESSAGE_GET_VOLUME,
 192     PA_SINK_MESSAGE_SET_VOLUME,
 193     PA_SINK_MESSAGE_SYNC_VOLUMES,
 194     PA_SINK_MESSAGE_GET_MUTE,
 195     PA_SINK_MESSAGE_SET_MUTE,
 196     PA_SINK_MESSAGE_GET_LATENCY,
 197     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
 198     PA_SINK_MESSAGE_SET_STATE,
 199     PA_SINK_MESSAGE_START_MOVE,
 200     PA_SINK_MESSAGE_FINISH_MOVE,
 201     PA_SINK_MESSAGE_ATTACH,
 202     PA_SINK_MESSAGE_DETACH,
 203     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
 204     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
 205     PA_SINK_MESSAGE_GET_MAX_REWIND,
 206     PA_SINK_MESSAGE_GET_MAX_REQUEST,
 207     PA_SINK_MESSAGE_SET_MAX_REWIND,
 208     PA_SINK_MESSAGE_SET_MAX_REQUEST,
 209     PA_SINK_MESSAGE_MAX
 210 } pa_sink_message_t;
 211
 212 typedef struct pa_sink_new_data {
 213     char *name;
 214     pa_proplist *proplist;
 215
 216     const char *driver;
 217     pa_module *module;
 218     pa_card *card;
 219
 220     pa_hashmap *ports;
 221     char *active_port;
 222
 223     pa_sample_spec sample_spec;
 224     pa_channel_map channel_map;
 225     pa_cvolume volume;
 226     pa_bool_t muted :1;
 227
 228     pa_bool_t sample_spec_is_set:1;
 229     pa_bool_t channel_map_is_set:1;
 230     pa_bool_t volume_is_set:1;
 231     pa_bool_t muted_is_set:1;
 232
 233     pa_bool_t namereg_fail:1;
 234
 235     pa_bool_t save_port:1;
 236     pa_bool_t save_volume:1;
 237     pa_bool_t save_muted:1;
 238 } pa_sink_new_data;
 239
 240 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 241 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 242 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 243 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 244 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
 245 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
 246 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port);
 247 void pa_sink_new_data_done(pa_sink_new_data *data);
 248
 249 /*** To be called exclusively by the sink driver, from main context */
 250
 251 pa_sink* pa_sink_new(
 252         pa_core *core,
 253         pa_sink_new_data *data,
 254         pa_sink_flags_t flags);
 255
 256 void pa_sink_put(pa_sink *s);
 257 void pa_sink_unlink(pa_sink* s);
 258
 259 void pa_sink_set_description(pa_sink *s, const char *description);
 260 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
 261 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
 262
 263 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
 264 void pa_sink_set_max_request(pa_sink *s, size_t max_request);
 265 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 266 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency);
 267
 268 void pa_sink_detach(pa_sink *s);
 269 void pa_sink_attach(pa_sink *s);
 270
 271 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
 272 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_volume);
 273 void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted);
 274
 275 pa_bool_t pa_device_init_description(pa_proplist *p);
 276 pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink);
 277 pa_bool_t pa_device_init_intended_roles(pa_proplist *p);
 278
 279 /**** May be called by everyone, from main context */
 280
 281 /* The returned value is supposed to be in the time domain of the sound card! */
 282 pa_usec_t pa_sink_get_latency(pa_sink *s);
 283 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
 284 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 285
 286 size_t pa_sink_get_max_rewind(pa_sink *s);
 287 size_t pa_sink_get_max_request(pa_sink *s);
 288
 289 int pa_sink_update_status(pa_sink*s);
 290 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause);
 291 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
 292
 293 void pa_sink_update_flat_volume(pa_sink *s, pa_cvolume *new_volume);
 294 void pa_sink_propagate_flat_volume(pa_sink *s);
 295
 296 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume, pa_bool_t propagate, pa_bool_t sendmsg, pa_bool_t become_reference, pa_bool_t save);
 297 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_bool_t force_refresh, pa_bool_t reference);
 298
 299 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute, pa_bool_t save);
 300 pa_bool_t pa_sink_get_mute(pa_sink *sink, pa_bool_t force_refresh);
 301
 302 pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p);
 303
 304 int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save);
 305
 306 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 307 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 308 unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
 309 #define pa_sink_get_state(s) ((s)->state)
 310
 311 /* Moves all inputs away, and stores them in pa_queue */
 312 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
 313 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save);
 314 void pa_sink_move_all_fail(pa_queue *q);
 315
 316 /*** To be called exclusively by the sink driver, from IO context */
 317
 318 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 319 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 320 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 321 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 322
 323 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
 324
 325 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 326
 327 void pa_sink_attach_within_thread(pa_sink *s);
 328 void pa_sink_detach_within_thread(pa_sink *s);
 329
 330 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
 331
 332 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
 333 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
 334
 335 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 336
 337 /*** To be called exclusively by sink input drivers, from IO context */
 338
 339 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 340
 341 void pa_sink_invalidate_requested_latency(pa_sink *s);
 342
 343 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s);
 344
 345 pa_device_port *pa_device_port_new(const char *name, const char *description, size_t extra);
 346 void pa_device_port_free(pa_device_port *p);
 347
 348 /* Verify that we called in IO context (aka 'thread context), or that
 349  * the sink is not yet set up, i.e. the thread not set up yet. See
 350  * pa_assert_io_context() in thread-mq.h for more information. */
 351 #define pa_sink_assert_io_context(s) \
 352     pa_assert(pa_thread_mq_get() || !PA_SINK_IS_LINKED((s)->state))
 353
 354 #endif