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-def.h>
  37 #include <pulsecore/core.h>
  38 #include <pulsecore/idxset.h>
  39 #include <pulsecore/source.h>
  40 #include <pulsecore/module.h>
  41 #include <pulsecore/refcnt.h>
  42 #include <pulsecore/msgobject.h>
  43 #include <pulsecore/rtpoll.h>
  44
  45 #define PA_MAX_INPUTS_PER_SINK 32
  46
  47 typedef enum pa_sink_state {
  48     PA_SINK_INIT,
  49     PA_SINK_RUNNING,
  50     PA_SINK_SUSPENDED,
  51     PA_SINK_IDLE,
  52     PA_SINK_UNLINKED
  53 } pa_sink_state_t;
  54
  55 static inline pa_bool_t PA_SINK_OPENED(pa_sink_state_t x) {
  56     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE;
  57 }
  58
  59 static inline pa_bool_t PA_SINK_LINKED(pa_sink_state_t x) {
  60     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
  61 }
  62
  63 struct pa_sink {
  64     pa_msgobject parent;
  65
  66     uint32_t index;
  67     pa_core *core;
  68     pa_sink_state_t state;
  69     pa_sink_flags_t flags;
  70
  71     char *name;
  72     char *driver;                           /* may be NULL */
  73     pa_proplist *proplist;
  74
  75     pa_module *module;                      /* may be NULL */
  76
  77     pa_sample_spec sample_spec;
  78     pa_channel_map channel_map;
  79
  80     pa_idxset *inputs;
  81     unsigned n_corked;
  82     pa_source *monitor_source;
  83
  84     pa_cvolume volume;
  85     pa_bool_t muted;
  86     pa_bool_t refresh_volume;
  87     pa_bool_t refresh_mute;
  88
  89     pa_asyncmsgq *asyncmsgq;
  90     pa_rtpoll *rtpoll;
  91
  92     pa_memblock *silence;
  93
  94     pa_usec_t min_latency; /* we won't go below this latency setting */
  95
  96     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
  97     int (*set_volume)(pa_sink *s);             /* dito */
  98     int (*get_volume)(pa_sink *s);             /* dito */
  99     int (*get_mute)(pa_sink *s);               /* dito */
 100     int (*set_mute)(pa_sink *s);               /* dito */
 101     pa_usec_t (*get_latency)(pa_sink *s);      /* dito */
 102     void (*request_rewind)(pa_sink *s);        /* dito */
 103     void (*update_requested_latency)(pa_sink *s); /* dito */
 104
 105     /* Contains copies of the above data so that the real-time worker
 106      * thread can work without access locking */
 107     struct {
 108         pa_sink_state_t state;
 109         pa_hashmap *inputs;
 110         pa_cvolume soft_volume;
 111         pa_bool_t soft_muted;
 112
 113         pa_bool_t requested_latency_valid;
 114         size_t requested_latency;
 115
 116         /* The number of bytes we need keep around to be able to satisfy
 117          * every DMA buffer rewrite */
 118         size_t max_rewind;
 119
 120         /* Maximum of what clients requested to rewind in this cycle */
 121         size_t rewind_nbytes;
 122     } thread_info;
 123
 124     void *userdata;
 125 };
 126
 127 PA_DECLARE_CLASS(pa_sink);
 128 #define PA_SINK(s) (pa_sink_cast(s))
 129
 130 typedef enum pa_sink_message {
 131     PA_SINK_MESSAGE_ADD_INPUT,
 132     PA_SINK_MESSAGE_REMOVE_INPUT,
 133     PA_SINK_MESSAGE_GET_VOLUME,
 134     PA_SINK_MESSAGE_SET_VOLUME,
 135     PA_SINK_MESSAGE_GET_MUTE,
 136     PA_SINK_MESSAGE_SET_MUTE,
 137     PA_SINK_MESSAGE_GET_LATENCY,
 138     PA_SINK_MESSAGE_SET_STATE,
 139     PA_SINK_MESSAGE_PING,
 140     PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER,
 141     PA_SINK_MESSAGE_ATTACH,
 142     PA_SINK_MESSAGE_DETACH,
 143     PA_SINK_MESSAGE_MAX
 144 } pa_sink_message_t;
 145
 146 typedef struct pa_sink_new_data {
 147     char *name;
 148     pa_bool_t namereg_fail;
 149     pa_proplist *proplist;
 150
 151     const char *driver;
 152     pa_module *module;
 153
 154     pa_sample_spec sample_spec;
 155     pa_bool_t sample_spec_is_set;
 156     pa_channel_map channel_map;
 157     pa_bool_t channel_map_is_set;
 158
 159     pa_cvolume volume;
 160     pa_bool_t volume_is_set;
 161     pa_bool_t muted;
 162     pa_bool_t muted_is_set;
 163 } pa_sink_new_data;
 164
 165 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
 166 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
 167 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
 168 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
 169 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
 170 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
 171 void pa_sink_new_data_done(pa_sink_new_data *data);
 172
 173 /* To be called exclusively by the sink driver, from main context */
 174
 175 pa_sink* pa_sink_new(
 176         pa_core *core,
 177         pa_sink_new_data *data,
 178         pa_sink_flags_t flags);
 179
 180 void pa_sink_put(pa_sink *s);
 181 void pa_sink_unlink(pa_sink* s);
 182
 183 void pa_sink_set_description(pa_sink *s, const char *description);
 184 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
 185 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
 186
 187 void pa_sink_detach(pa_sink *s);
 188 void pa_sink_attach(pa_sink *s);
 189
 190 /* May be called by everyone, from main context */
 191
 192 /* The returned value is supposed to be in the time domain of the sound card! */
 193 pa_usec_t pa_sink_get_latency(pa_sink *s);
 194
 195 int pa_sink_update_status(pa_sink*s);
 196 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend);
 197 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend);
 198
 199 void pa_sink_rewind(pa_sink *s, size_t length);
 200
 201 /* Sends a ping message to the sink thread, to make it wake up and
 202  * check for data to process even if there is no real message is
 203  * sent */
 204 void pa_sink_ping(pa_sink *s);
 205
 206 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume);
 207 const pa_cvolume *pa_sink_get_volume(pa_sink *sink);
 208 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute);
 209 pa_bool_t pa_sink_get_mute(pa_sink *sink);
 210
 211 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
 212 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
 213 #define pa_sink_get_state(s) ((s)->state)
 214
 215 /* To be called exclusively by the sink driver, from IO context */
 216
 217 void pa_sink_process_rewind(pa_sink *s);
 218
 219 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
 220 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
 221 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
 222 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
 223 void pa_sink_skip(pa_sink *s, size_t length);
 224
 225 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
 226
 227 void pa_sink_attach_within_thread(pa_sink *s);
 228 void pa_sink_detach_within_thread(pa_sink *s);
 229
 230 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
 231
 232 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
 233
 234 /* To be called exclusively by sink input drivers, from IO context */
 235
 236 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
 237
 238 void pa_sink_invalidate_requested_latency(pa_sink *s);
 239
 240 #endif