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