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
  42 #define PA_MAX_INPUTS_PER_SINK 32
  43
  44 typedef enum pa_sink_state {
  45     PA_SINK_INIT,
  46     PA_SINK_RUNNING,
  47     PA_SINK_SUSPENDED,
  48     PA_SINK_IDLE,
  49     PA_SINK_UNLINKED
  50 } pa_sink_state_t;
  51
  52 static inline pa_bool_t PA_SINK_IS_OPENED(pa_sink_state_t x) {
  53     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE;
  54 }
  55
  56 static inline pa_bool_t PA_SINK_IS_LINKED(pa_sink_state_t x) {
  57     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  58 }
  59
  60 struct pa_sink {
  61     pa_msgobject parent;
  62
  63     uint32_t index;
  64     pa_core *core;
  65     pa_sink_state_t state;
  66     pa_sink_flags_t flags;
  67
  68     char *name;
  69     char *driver;                           /* may be NULL */
  70     pa_proplist *proplist;
  71
  72     pa_module *module;                      /* may be NULL */
  73
  74     pa_sample_spec sample_spec;
  75     pa_channel_map channel_map;
  76
  77     pa_idxset *inputs;
  78     unsigned n_corked;
  79     pa_source *monitor_source;
  80
  81     pa_cvolume volume;
  82     pa_bool_t muted;
  83
  84     pa_volume_t base_volume;  /* shall be constant */
  85
  86     pa_bool_t refresh_volume:1;
  87     pa_bool_t refresh_muted:1;
  88
  89     pa_asyncmsgq *asyncmsgq;
  90     pa_rtpoll *rtpoll;
  91
  92     pa_memchunk silence;
  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     int (*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     int (*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     int (*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     int (*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         pa_cvolume soft_volume;
 135         pa_bool_t soft_muted:1;
 136
 137         pa_bool_t requested_latency_valid:1;
 138         pa_usec_t requested_latency;
 139
 140         /* The number of bytes streams need to keep around as history to
 141          * be able to satisfy every DMA buffer rewrite */
 142         size_t max_rewind;
 143
 144         /* The number of bytes streams need to keep around to satisfy
 145          * every DMA write request */
 146         size_t max_request;
 147
 148         /* Maximum of what clients requested to rewind in this cycle */
 149         size_t rewind_nbytes;
 150         pa_bool_t rewind_requested;
 151
 152         pa_usec_t min_latency; /* we won't go below this latency */
 153         pa_usec_t max_latency; /* An upper limit for the latencies */
 154     } thread_info;
 155
 156     void *userdata;
 157 };
 158
 159 PA_DECLARE_CLASS(pa_sink);
 160 #define PA_SINK(s) (pa_sink_cast(s))
 161
 162 typedef enum pa_sink_message {
 163     PA_SINK_MESSAGE_ADD_INPUT,
 164     PA_SINK_MESSAGE_REMOVE_INPUT,
 165     PA_SINK_MESSAGE_GET_VOLUME,
 166     PA_SINK_MESSAGE_SET_VOLUME,
 167     PA_SINK_MESSAGE_GET_MUTE,
 168     PA_SINK_MESSAGE_SET_MUTE,
 169     PA_SINK_MESSAGE_GET_LATENCY,
 170     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
 171     PA_SINK_MESSAGE_SET_STATE,
 172     PA_SINK_MESSAGE_START_MOVE,
 173     PA_SINK_MESSAGE_FINISH_MOVE,
 174     PA_SINK_MESSAGE_ATTACH,
 175     PA_SINK_MESSAGE_DETACH,
 176     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
 177     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
 178     PA_SINK_MESSAGE_GET_MAX_REWIND,
 179     PA_SINK_MESSAGE_GET_MAX_REQUEST,
 180     PA_SINK_MESSAGE_MAX
 181 } pa_sink_message_t;
 182
 183 typedef struct pa_sink_new_data {
 184     char *name;
 185     pa_proplist *proplist;
 186
 187     const char *driver;
 188     pa_module *module;
 189
 190     pa_sample_spec sample_spec;
 191     pa_channel_map channel_map;
 192     pa_cvolume volume;
 193     pa_bool_t muted :1;
 194
 195     pa_bool_t sample_spec_is_set:1;
 196     pa_bool_t channel_map_is_set:1;
 197     pa_bool_t volume_is_set:1;
 198     pa_bool_t muted_is_set:1;
 199
 200     pa_bool_t namereg_fail:1;
 201 } pa_sink_new_data;
 202
 203 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 204 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 205 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 206 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 207 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
 208 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
 209 void pa_sink_new_data_done(pa_sink_new_data *data);
 210
 211 typedef struct pa_sink_set_volume_data {
 212   pa_sink *sink;
 213   pa_cvolume volume;
 214 } pa_sink_set_volume_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_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 231
 232 void pa_sink_detach(pa_sink *s);
 233 void pa_sink_attach(pa_sink *s);
 234
 235 /* May be called by everyone, from main context */
 236
 237 /* The returned value is supposed to be in the time domain of the sound card! */
 238 pa_usec_t pa_sink_get_latency(pa_sink *s);
 239 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
 240 void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 241
 242 size_t pa_sink_get_max_rewind(pa_sink *s);
 243 size_t pa_sink_get_max_request(pa_sink *s);
 244
 245 int pa_sink_update_status(pa_sink*s);
 246 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend);
 247 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend);
 248
 249 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume);
 250 void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
 251 const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_bool_t force_refresh);
 252 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute);
 253 pa_bool_t pa_sink_get_mute(pa_sink *sink, pa_bool_t force_refres);
 254
 255 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 256 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 257 unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
 258 #define pa_sink_get_state(s) ((s)->state)
 259
 260 /* To be called exclusively by the sink driver, from IO context */
 261
 262 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 263 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 264 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 265 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 266
 267 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
 268
 269 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 270
 271 void pa_sink_attach_within_thread(pa_sink *s);
 272 void pa_sink_detach_within_thread(pa_sink *s);
 273
 274 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
 275
 276 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
 277 void pa_sink_set_max_request(pa_sink *s, size_t max_request);
 278
 279 void pa_sink_update_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
 280
 281 /* To be called exclusively by sink input drivers, from IO context */
 282
 283 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 284
 285 void pa_sink_invalidate_requested_latency(pa_sink *s);
 286
 287 #endif