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