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