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