src/pulsecore/sink.h

   1 #ifndef foopulsesinkhfoo
   2 #define foopulsesinkhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
  11
  12   PulseAudio is free software; you can redistribute it and/or modify
  13   it under the terms of the GNU Lesser General Public License as published
  14   by the Free Software Foundation; either version 2 of the License,
  15   or (at your option) any later version.
  16
  17   PulseAudio is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with PulseAudio; if not, write to the Free Software
  24   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  25   USA.
  26 ***/
  27
  28 typedef struct pa_sink pa_sink;
  29
  30 #include <inttypes.h>
  31
  32 #include <pulse/sample.h>
  33 #include <pulse/channelmap.h>
  34 #include <pulse/volume.h>
  35
  36 #include <pulsecore/core.h>
  37 #include <pulsecore/idxset.h>
  38 #include <pulsecore/source.h>
  39 #include <pulsecore/module.h>
  40 #include <pulsecore/refcnt.h>
  41 #include <pulsecore/msgobject.h>
  42 #include <pulsecore/rtpoll.h>
  43
  44 #define PA_MAX_INPUTS_PER_SINK 32
  45
  46 typedef enum pa_sink_state {
  47     PA_SINK_INIT,
  48     PA_SINK_RUNNING,
  49     PA_SINK_SUSPENDED,
  50     PA_SINK_IDLE,
  51     PA_SINK_UNLINKED
  52 } pa_sink_state_t;
  53
  54 static inline pa_bool_t PA_SINK_IS_OPENED(pa_sink_state_t x) {
  55     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE;
  56 }
  57
  58 static inline pa_bool_t PA_SINK_IS_LINKED(pa_sink_state_t x) {
  59     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  60 }
  61
  62 struct pa_sink {
  63     pa_msgobject parent;
  64
  65     uint32_t index;
  66     pa_core *core;
  67     pa_sink_state_t state;
  68     pa_sink_flags_t flags;
  69
  70     char *name;
  71     char *driver;                           /* may be NULL */
  72     pa_proplist *proplist;
  73
  74     pa_module *module;                      /* 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_bool_t muted;
  85     pa_bool_t refresh_volume;
  86     pa_bool_t refresh_mute;
  87
  88     pa_asyncmsgq *asyncmsgq;
  89     pa_rtpoll *rtpoll;
  90
  91     pa_memchunk silence;
  92
  93     pa_usec_t min_latency; /* we won't go below this latency */
  94     pa_usec_t max_latency; /* An upper limit for the latencies */
  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. */
 104     int (*get_volume)(pa_sink *s);             /* may be null */
 105
 106     /* Called when the volume shall be changed. Called from main loop
 107      * context. If this is NULL a PA_SINK_MESSAGE_SET_VOLUME message
 108      * will be sent to the IO thread instead. */
 109     int (*set_volume)(pa_sink *s);             /* dito */
 110
 111     /* Called when the mute setting is queried. Called from main loop
 112      * context. If this is NULL a PA_SINK_MESSAGE_GET_MUTE message
 113      * will be sent to the IO thread instead. */
 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 the latency is queried. Called from main loop
 122     context. If this is NULL a PA_SINK_MESSAGE_GET_LATENCY message
 123     will be sent to the IO thread instead. */
 124     pa_usec_t (*get_latency)(pa_sink *s); /* dito */
 125
 126     /* Called when a rewind request is issued. Called from IO thread
 127      * context. */
 128     void (*request_rewind)(pa_sink *s);        /* dito */
 129
 130     /* Called when a the requested latency is changed. Called from IO
 131      * thread context. */
 132     void (*update_requested_latency)(pa_sink *s); /* dito */
 133
 134     /* Contains copies of the above data so that the real-time worker
 135      * thread can work without access locking */
 136     struct {
 137         pa_sink_state_t state;
 138         pa_hashmap *inputs;
 139         pa_cvolume soft_volume;
 140         pa_bool_t soft_muted;
 141
 142         pa_bool_t requested_latency_valid;
 143         pa_usec_t requested_latency;
 144
 145         /* The number of bytes we need keep around to be able to satisfy
 146          * every DMA buffer rewrite */
 147         size_t max_rewind;
 148
 149         /* Maximum of what clients requested to rewind in this cycle */
 150         size_t rewind_nbytes;
 151     } thread_info;
 152
 153     void *userdata;
 154 };
 155
 156 PA_DECLARE_CLASS(pa_sink);
 157 #define PA_SINK(s) (pa_sink_cast(s))
 158
 159 typedef enum pa_sink_message {
 160     PA_SINK_MESSAGE_ADD_INPUT,
 161     PA_SINK_MESSAGE_REMOVE_INPUT,
 162     PA_SINK_MESSAGE_GET_VOLUME,
 163     PA_SINK_MESSAGE_SET_VOLUME,
 164     PA_SINK_MESSAGE_GET_MUTE,
 165     PA_SINK_MESSAGE_SET_MUTE,
 166     PA_SINK_MESSAGE_GET_LATENCY,
 167     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
 168     PA_SINK_MESSAGE_SET_STATE,
 169     PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER,
 170     PA_SINK_MESSAGE_ATTACH,
 171     PA_SINK_MESSAGE_DETACH,
 172     PA_SINK_MESSAGE_MAX
 173 } pa_sink_message_t;
 174
 175 typedef struct pa_sink_new_data {
 176     char *name;
 177     pa_bool_t namereg_fail;
 178     pa_proplist *proplist;
 179
 180     const char *driver;
 181     pa_module *module;
 182
 183     pa_sample_spec sample_spec;
 184     pa_bool_t sample_spec_is_set;
 185     pa_channel_map channel_map;
 186     pa_bool_t channel_map_is_set;
 187
 188     pa_cvolume volume;
 189     pa_bool_t volume_is_set;
 190     pa_bool_t muted;
 191     pa_bool_t muted_is_set;
 192 } pa_sink_new_data;
 193
 194 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 195 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 196 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 197 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 198 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
 199 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
 200 void pa_sink_new_data_done(pa_sink_new_data *data);
 201
 202 /* To be called exclusively by the sink driver, from main context */
 203
 204 pa_sink* pa_sink_new(
 205         pa_core *core,
 206         pa_sink_new_data *data,
 207         pa_sink_flags_t flags);
 208
 209 void pa_sink_put(pa_sink *s);
 210 void pa_sink_unlink(pa_sink* s);
 211
 212 void pa_sink_set_description(pa_sink *s, const char *description);
 213 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
 214 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
 215
 216 void pa_sink_detach(pa_sink *s);
 217 void pa_sink_attach(pa_sink *s);
 218
 219 /* May be called by everyone, from main context */
 220
 221 /* The returned value is supposed to be in the time domain of the sound card! */
 222 pa_usec_t pa_sink_get_latency(pa_sink *s);
 223 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
 224
 225 int pa_sink_update_status(pa_sink*s);
 226 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend);
 227 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend);
 228
 229 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume);
 230 const pa_cvolume *pa_sink_get_volume(pa_sink *sink);
 231 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute);
 232 pa_bool_t pa_sink_get_mute(pa_sink *sink);
 233
 234 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 235 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 236 #define pa_sink_get_state(s) ((s)->state)
 237
 238 /* To be called exclusively by the sink driver, from IO context */
 239
 240 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 241 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 242 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 243 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 244
 245 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
 246
 247 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 248
 249 void pa_sink_attach_within_thread(pa_sink *s);
 250 void pa_sink_detach_within_thread(pa_sink *s);
 251
 252 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
 253
 254 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
 255
 256 /* To be called exclusively by sink input drivers, from IO context */
 257
 258 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 259
 260 void pa_sink_invalidate_requested_latency(pa_sink *s);
 261
 262 #endif