code.delx.au - pulseaudio/blob - src/pulsecore/source.h

   1 #ifndef foopulsesourcehfoo
   2 #define foopulsesourcehfoo
   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.1 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_source pa_source;
  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/memblock.h>
  37 #include <pulsecore/memchunk.h>
  38 #include <pulsecore/sink.h>
  39 #include <pulsecore/module.h>
  40 #include <pulsecore/asyncmsgq.h>
  41 #include <pulsecore/msgobject.h>
  42 #include <pulsecore/rtpoll.h>
  43 #include <pulsecore/source-output.h>
  44 #include <pulsecore/card.h>
  45 #include <pulsecore/queue.h>
  46
  47 #define PA_MAX_OUTPUTS_PER_SOURCE 32
  48
  49 /* Returns true if source is linked: registered and accessible from client side. */
  50 static inline pa_bool_t PA_SOURCE_IS_LINKED(pa_source_state_t x) {
  51     return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE || x == PA_SOURCE_SUSPENDED;
  52 }
  53
  54 struct pa_source {
  55     pa_msgobject parent;
  56
  57     uint32_t index;
  58     pa_core *core;
  59     pa_source_state_t state;
  60     pa_source_flags_t flags;
  61     pa_suspend_cause_t suspend_cause;
  62
  63     char *name;
  64     char *driver;                             /* may be NULL */
  65     pa_proplist *proplist;
  66
  67     pa_module *module;                        /* may be NULL */
  68     pa_card *card;                            /* may be NULL */
  69
  70     pa_sample_spec sample_spec;
  71     pa_channel_map channel_map;
  72
  73     pa_idxset *outputs;
  74     unsigned n_corked;
  75     pa_sink *monitor_of;                     /* may be NULL */
  76
  77     pa_volume_t base_volume; /* shall be constant */
  78     unsigned n_volume_steps; /* shall be constant */
  79
  80     pa_cvolume virtual_volume, soft_volume;
  81     pa_bool_t muted:1;
  82
  83     pa_bool_t refresh_volume:1;
  84     pa_bool_t refresh_muted:1;
  85
  86     pa_asyncmsgq *asyncmsgq;
  87     pa_rtpoll *rtpoll;
  88
  89     pa_memchunk silence;
  90
  91     pa_usec_t fixed_latency; /* for sources with PA_SOURCE_DYNAMIC_LATENCY this is 0 */
  92
  93     /* Called when the main loop requests a state change. Called from
  94      * main loop context. If returns -1 the state change will be
  95      * inhibited */
  96     int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */
  97
  98     /* Callled when the volume is queried. Called from main loop
  99      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message
 100      * will be sent to the IO thread instead. If refresh_volume is
 101      * FALSE neither this function is called nor a message is sent. */
 102     void (*get_volume)(pa_source *s);         /* dito */
 103
 104     /* Called when the volume shall be changed. Called from main loop
 105      * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message
 106      * will be sent to the IO thread instead. */
 107     void (*set_volume)(pa_source *s);         /* dito */
 108
 109     /* Called when the mute setting is queried. Called from main loop
 110      * context. If this is NULL a PA_SOURCE_MESSAGE_GET_MUTE message
 111      * will be sent to the IO thread instead. If refresh_mute is
 112      * FALSE neither this function is called nor a message is sent.*/
 113     void (*get_mute)(pa_source *s);           /* dito */
 114
 115     /* Called when the mute setting shall be changed. Called from main
 116      * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE
 117      * message will be sent to the IO thread instead. */
 118     void (*set_mute)(pa_source *s);           /* dito */
 119
 120     /* Called when a the requested latency is changed. Called from IO
 121      * thread context. */
 122     void (*update_requested_latency)(pa_source *s); /* dito */
 123
 124     /* Contains copies of the above data so that the real-time worker
 125      * thread can work without access locking */
 126     struct {
 127         pa_source_state_t state;
 128         pa_hashmap *outputs;
 129
 130         pa_cvolume soft_volume;
 131         pa_bool_t soft_muted:1;
 132
 133         pa_bool_t requested_latency_valid:1;
 134         pa_usec_t requested_latency;
 135
 136         /* Then number of bytes this source will be rewound for at
 137          * max. (Only used on monitor sources) */
 138         size_t max_rewind;
 139
 140         pa_usec_t min_latency; /* we won't go below this latency */
 141         pa_usec_t max_latency; /* An upper limit for the latencies */
 142     } thread_info;
 143
 144     void *userdata;
 145 };
 146
 147 PA_DECLARE_CLASS(pa_source);
 148 #define PA_SOURCE(s) pa_source_cast(s)
 149
 150 typedef enum pa_source_message {
 151     PA_SOURCE_MESSAGE_ADD_OUTPUT,
 152     PA_SOURCE_MESSAGE_REMOVE_OUTPUT,
 153     PA_SOURCE_MESSAGE_GET_VOLUME,
 154     PA_SOURCE_MESSAGE_SET_VOLUME,
 155     PA_SOURCE_MESSAGE_GET_MUTE,
 156     PA_SOURCE_MESSAGE_SET_MUTE,
 157     PA_SOURCE_MESSAGE_GET_LATENCY,
 158     PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY,
 159     PA_SOURCE_MESSAGE_SET_STATE,
 160     PA_SOURCE_MESSAGE_ATTACH,
 161     PA_SOURCE_MESSAGE_DETACH,
 162     PA_SOURCE_MESSAGE_SET_LATENCY_RANGE,
 163     PA_SOURCE_MESSAGE_GET_LATENCY_RANGE,
 164     PA_SOURCE_MESSAGE_GET_MAX_REWIND,
 165     PA_SOURCE_MESSAGE_SET_MAX_REWIND,
 166     PA_SOURCE_MESSAGE_MAX
 167 } pa_source_message_t;
 168
 169 typedef struct pa_source_new_data {
 170     char *name;
 171     pa_proplist *proplist;
 172
 173     const char *driver;
 174     pa_module *module;
 175     pa_card *card;
 176
 177     pa_sample_spec sample_spec;
 178     pa_channel_map channel_map;
 179     pa_cvolume volume;
 180     pa_bool_t muted:1;
 181
 182     pa_bool_t volume_is_set:1;
 183     pa_bool_t muted_is_set:1;
 184     pa_bool_t sample_spec_is_set:1;
 185     pa_bool_t channel_map_is_set:1;
 186
 187     pa_bool_t namereg_fail:1;
 188 } pa_source_new_data;
 189
 190 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);
 191 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name);
 192 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec);
 193 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
 194 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
 195 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute);
 196 void pa_source_new_data_done(pa_source_new_data *data);
 197
 198 /*** To be called exclusively by the source driver, from main context */
 199
 200 pa_source* pa_source_new(
 201         pa_core *core,
 202         pa_source_new_data *data,
 203         pa_source_flags_t flags);
 204
 205 void pa_source_put(pa_source *s);
 206 void pa_source_unlink(pa_source *s);
 207
 208 void pa_source_set_description(pa_source *s, const char *description);
 209 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
 210 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
 211
 212 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind);
 213 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 214 void pa_source_set_fixed_latency(pa_source *s, pa_usec_t latency);
 215
 216 void pa_source_detach(pa_source *s);
 217 void pa_source_attach(pa_source *s);
 218
 219 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume);
 220 void pa_source_volume_changed(pa_source *s, const pa_cvolume *new_volume);
 221 void pa_source_mute_changed(pa_source *s, pa_bool_t new_muted);
 222
 223 int pa_source_sync_suspend(pa_source *s);
 224
 225 /*** May be called by everyone, from main context */
 226
 227 /* The returned value is supposed to be in the time domain of the sound card! */
 228 pa_usec_t pa_source_get_latency(pa_source *s);
 229 pa_usec_t pa_source_get_requested_latency(pa_source *s);
 230 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
 231
 232 size_t pa_source_get_max_rewind(pa_source *s);
 233
 234 int pa_source_update_status(pa_source*s);
 235 int pa_source_suspend(pa_source *s, pa_bool_t suspend, pa_suspend_cause_t cause);
 236 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
 237
 238 void pa_source_set_volume(pa_source *source, const pa_cvolume *volume);
 239 const pa_cvolume *pa_source_get_volume(pa_source *source, pa_bool_t force_refresh);
 240 void pa_source_set_mute(pa_source *source, pa_bool_t mute);
 241 pa_bool_t pa_source_get_mute(pa_source *source, pa_bool_t force_refresh);
 242
 243 pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p);
 244
 245 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
 246 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */
 247 unsigned pa_source_check_suspend(pa_source *s); /* Returns how many streams are active that don't allow suspensions */
 248 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
 249
 250 /* Moves all inputs away, and stores them in pa_queue */
 251 pa_queue *pa_source_move_all_start(pa_source *s);
 252 void pa_source_move_all_finish(pa_source *s, pa_queue *q, pa_bool_t save);
 253 void pa_source_move_all_fail(pa_queue *q);
 254
 255 /*** To be called exclusively by the source driver, from IO context */
 256
 257 void pa_source_post(pa_source*s, const pa_memchunk *chunk);
 258 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk);
 259 void pa_source_process_rewind(pa_source *s, size_t nbytes);
 260
 261 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
 262
 263 void pa_source_attach_within_thread(pa_source *s);
 264 void pa_source_detach_within_thread(pa_source *s);
 265
 266 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s);
 267
 268 void pa_source_set_max_rewind_within_thread(pa_source *s, size_t max_rewind);
 269 void pa_source_set_latency_range_within_thread(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
 270
 271 /*** To be called exclusively by source output drivers, from IO context */
 272
 273 void pa_source_invalidate_requested_latency(pa_source *s);
 274 pa_usec_t pa_source_get_latency_within_thread(pa_source *s);
 275
 276 #endif