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
  46 #define PA_MAX_INPUTS_PER_SINK 32
  47
  48 /* Returns true if sink is linked: registered and accessible from client side. */
  49 static inline pa_bool_t PA_SINK_IS_LINKED(pa_sink_state_t x) {
  50     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  51 }
  52
  53 struct pa_device_port {
  54     char *name;
  55     char *description;
  56
  57     unsigned priority;
  58
  59     /* .. followed by some implementation specific data */
  60 };
  61
  62 #define PA_DEVICE_PORT_DATA(d) ((void*) ((uint8_t*) d + PA_ALIGN(sizeof(pa_device_port))))
  63
  64 struct pa_sink {
  65     pa_msgobject parent;
  66
  67     uint32_t index;
  68     pa_core *core;
  69
  70     pa_sink_state_t state;
  71     pa_sink_flags_t flags;
  72     pa_suspend_cause_t suspend_cause;
  73
  74     char *name;
  75     char *driver;                           /* may be NULL */
  76     pa_proplist *proplist;
  77
  78     pa_module *module;                      /* may be NULL */
  79     pa_card *card;                          /* may be NULL */
  80
  81     pa_sample_spec sample_spec;
  82     pa_channel_map channel_map;
  83
  84     pa_idxset *inputs;
  85     unsigned n_corked;
  86     pa_source *monitor_source;
  87
  88     pa_volume_t base_volume; /* shall be constant */
  89     unsigned n_volume_steps; /* shall be constant */
  90
  91     /* Also see http://pulseaudio.org/wiki/InternalVolumes */
  92     pa_cvolume virtual_volume;   /* The volume clients are informed about */
  93     pa_cvolume reference_volume; /* The volume taken as refernce base for relative sink input volumes */
  94     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
  95     pa_bool_t muted:1;
  96
  97     pa_bool_t refresh_volume:1;
  98     pa_bool_t refresh_muted:1;
  99     pa_bool_t save_port:1;
 100     pa_bool_t save_volume:1;
 101     pa_bool_t save_muted:1;
 102
 103     pa_asyncmsgq *asyncmsgq;
 104     pa_rtpoll *rtpoll;
 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_cvolume soft_volume;
 159         pa_bool_t soft_muted:1;
 160
 161         pa_bool_t requested_latency_valid:1;
 162         pa_usec_t requested_latency;
 163
 164         /* The number of bytes streams need to keep around as history to
 165          * be able to satisfy every DMA buffer rewrite */
 166         size_t max_rewind;
 167
 168         /* The number of bytes streams need to keep around to satisfy
 169          * every DMA write request */
 170         size_t max_request;
 171
 172         /* Maximum of what clients requested to rewind in this cycle */
 173         size_t rewind_nbytes;
 174         pa_bool_t rewind_requested;
 175
 176         pa_usec_t min_latency; /* we won't go below this latency */
 177         pa_usec_t max_latency; /* An upper limit for the latencies */
 178     } thread_info;
 179
 180     void *userdata;
 181 };
 182
 183 PA_DECLARE_CLASS(pa_sink);
 184 #define PA_SINK(s) (pa_sink_cast(s))
 185
 186 typedef enum pa_sink_message {
 187     PA_SINK_MESSAGE_ADD_INPUT,
 188     PA_SINK_MESSAGE_REMOVE_INPUT,
 189     PA_SINK_MESSAGE_GET_VOLUME,
 190     PA_SINK_MESSAGE_SET_VOLUME,
 191     PA_SINK_MESSAGE_SYNC_VOLUMES,
 192     PA_SINK_MESSAGE_GET_MUTE,
 193     PA_SINK_MESSAGE_SET_MUTE,
 194     PA_SINK_MESSAGE_GET_LATENCY,
 195     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
 196     PA_SINK_MESSAGE_SET_STATE,
 197     PA_SINK_MESSAGE_START_MOVE,
 198     PA_SINK_MESSAGE_FINISH_MOVE,
 199     PA_SINK_MESSAGE_ATTACH,
 200     PA_SINK_MESSAGE_DETACH,
 201     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
 202     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
 203     PA_SINK_MESSAGE_GET_MAX_REWIND,
 204     PA_SINK_MESSAGE_GET_MAX_REQUEST,
 205     PA_SINK_MESSAGE_SET_MAX_REWIND,
 206     PA_SINK_MESSAGE_SET_MAX_REQUEST,
 207     PA_SINK_MESSAGE_MAX
 208 } pa_sink_message_t;
 209
 210 typedef struct pa_sink_new_data {
 211     char *name;
 212     pa_proplist *proplist;
 213
 214     const char *driver;
 215     pa_module *module;
 216     pa_card *card;
 217
 218     pa_hashmap *ports;
 219     char *active_port;
 220
 221     pa_sample_spec sample_spec;
 222     pa_channel_map channel_map;
 223     pa_cvolume volume;
 224     pa_bool_t muted :1;
 225
 226     pa_bool_t sample_spec_is_set:1;
 227     pa_bool_t channel_map_is_set:1;
 228     pa_bool_t volume_is_set:1;
 229     pa_bool_t muted_is_set:1;
 230
 231     pa_bool_t namereg_fail:1;
 232
 233     pa_bool_t save_port:1;
 234     pa_bool_t save_volume:1;
 235     pa_bool_t save_muted:1;
 236 } pa_sink_new_data;
 237
 238 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 239 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 240 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 241 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 242 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
 243 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
 244 void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port);
 245 void pa_sink_new_data_done(pa_sink_new_data *data);
 246
 247 /*** To be called exclusively by the sink driver, from main context */
 248
 249 pa_sink* pa_sink_new(
 250         pa_core *core,
 251         pa_sink_new_data *data,
 252         pa_sink_flags_t flags);
 253
 254 void pa_sink_put(pa_sink *s);
 255 void pa_sink_unlink(pa_sink* s);
 256
 257 void pa_sink_set_description(pa_sink *s, const char *description);
 258 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
 259 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
 260
 261 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
 262 void pa_sink_set_max_request(pa_sink *s, size_t max_request);
 263 void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 264 void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency);
 265
 266 void pa_sink_detach(pa_sink *s);
 267 void pa_sink_attach(pa_sink *s);
 268
 269 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
 270 void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_volume, pa_bool_t save);
 271 void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted, pa_bool_t save);
 272
 273 pa_bool_t pa_device_init_description(pa_proplist *p);
 274 pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink);
 275 pa_bool_t pa_device_init_intended_roles(pa_proplist *p);
 276
 277 /**** May be called by everyone, from main context */
 278
 279 /* The returned value is supposed to be in the time domain of the sound card! */
 280 pa_usec_t pa_sink_get_latency(pa_sink *s);
 281 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
 282 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 283
 284 size_t pa_sink_get_max_rewind(pa_sink *s);
 285 size_t pa_sink_get_max_request(pa_sink *s);
 286
 287 int pa_sink_update_status(pa_sink*s);
 288 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause);
 289 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
 290
 291 void pa_sink_update_flat_volume(pa_sink *s, pa_cvolume *new_volume);
 292 void pa_sink_propagate_flat_volume(pa_sink *s);
 293
 294 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);
 295 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_bool_t force_refresh, pa_bool_t reference);
 296
 297 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute, pa_bool_t save);
 298 pa_bool_t pa_sink_get_mute(pa_sink *sink, pa_bool_t force_refresh);
 299
 300 pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p);
 301
 302 int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save);
 303
 304 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 305 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 306 unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
 307 #define pa_sink_get_state(s) ((s)->state)
 308
 309 /* Moves all inputs away, and stores them in pa_queue */
 310 pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
 311 void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save);
 312 void pa_sink_move_all_fail(pa_queue *q);
 313
 314 /*** To be called exclusively by the sink driver, from IO context */
 315
 316 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 317 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 318 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 319 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 320
 321 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
 322
 323 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 324
 325 void pa_sink_attach_within_thread(pa_sink *s);
 326 void pa_sink_detach_within_thread(pa_sink *s);
 327
 328 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
 329
 330 void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
 331 void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
 332
 333 void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 334
 335 /*** To be called exclusively by sink input drivers, from IO context */
 336
 337 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 338
 339 void pa_sink_invalidate_requested_latency(pa_sink *s);
 340
 341 pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s);
 342
 343 pa_device_port *pa_device_port_new(const char *name, const char *description, size_t extra);
 344 void pa_device_port_free(pa_device_port *p);
 345
 346 #endif