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