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