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