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