1 #ifndef foopulsesourcehfoo
2 #define foopulsesourcehfoo
5 This file is part of PulseAudio.
7 Copyright 2004-2006 Lennart Poettering
8 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
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 of the License,
13 or (at your option) any later version.
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.
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
26 typedef struct pa_source pa_source;
30 #include <pulse/sample.h>
31 #include <pulse/channelmap.h>
32 #include <pulse/volume.h>
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>
47 #define PA_MAX_OUTPUTS_PER_SOURCE 32
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;
59 pa_source_state_t state;
60 pa_source_flags_t flags;
63 char *driver; /* may be NULL */
64 pa_proplist *proplist;
66 pa_module *module; /* may be NULL */
67 pa_card *card; /* may be NULL */
69 pa_sample_spec sample_spec;
70 pa_channel_map channel_map;
74 pa_sink *monitor_of; /* may be NULL */
79 pa_volume_t base_volume; /* shall be constant */
81 pa_bool_t refresh_volume:1;
82 pa_bool_t refresh_muted:1;
84 pa_asyncmsgq *asyncmsgq;
89 /* Called when the main loop requests a state change. Called from
90 * main loop context. If returns -1 the state change will be
92 int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */
94 /* Callled when the volume is queried. Called from main loop
95 * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message
96 * will be sent to the IO thread instead. If refresh_volume is
97 * FALSE neither this function is called nor a message is sent. */
98 int (*get_volume)(pa_source *s); /* dito */
100 /* Called when the volume shall be changed. Called from main loop
101 * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message
102 * will be sent to the IO thread instead. */
103 int (*set_volume)(pa_source *s); /* dito */
105 /* Called when the mute setting is queried. Called from main loop
106 * context. If this is NULL a PA_SOURCE_MESSAGE_GET_MUTE message
107 * will be sent to the IO thread instead. If refresh_mute is
108 * FALSE neither this function is called nor a message is sent.*/
109 int (*get_mute)(pa_source *s); /* dito */
111 /* Called when the mute setting shall be changed. Called from main
112 * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE
113 * message will be sent to the IO thread instead. */
114 int (*set_mute)(pa_source *s); /* dito */
116 /* Called when a the requested latency is changed. Called from IO
118 void (*update_requested_latency)(pa_source *s); /* dito */
120 /* Contains copies of the above data so that the real-time worker
121 * thread can work without access locking */
123 pa_source_state_t state;
125 pa_cvolume soft_volume;
126 pa_bool_t soft_muted:1;
128 pa_bool_t requested_latency_valid:1;
129 pa_usec_t requested_latency;
131 /* Then number of bytes this source will be rewound for at
132 * max. (Only used on monitor sources) */
135 pa_usec_t min_latency; /* we won't go below this latency */
136 pa_usec_t max_latency; /* An upper limit for the latencies */
142 PA_DECLARE_CLASS(pa_source);
143 #define PA_SOURCE(s) pa_source_cast(s)
145 typedef enum pa_source_message {
146 PA_SOURCE_MESSAGE_ADD_OUTPUT,
147 PA_SOURCE_MESSAGE_REMOVE_OUTPUT,
148 PA_SOURCE_MESSAGE_GET_VOLUME,
149 PA_SOURCE_MESSAGE_SET_VOLUME,
150 PA_SOURCE_MESSAGE_GET_MUTE,
151 PA_SOURCE_MESSAGE_SET_MUTE,
152 PA_SOURCE_MESSAGE_GET_LATENCY,
153 PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY,
154 PA_SOURCE_MESSAGE_SET_STATE,
155 PA_SOURCE_MESSAGE_ATTACH,
156 PA_SOURCE_MESSAGE_DETACH,
157 PA_SOURCE_MESSAGE_SET_LATENCY_RANGE,
158 PA_SOURCE_MESSAGE_GET_LATENCY_RANGE,
159 PA_SOURCE_MESSAGE_GET_MAX_REWIND,
160 PA_SOURCE_MESSAGE_MAX
161 } pa_source_message_t;
163 typedef struct pa_source_new_data {
165 pa_proplist *proplist;
171 pa_sample_spec sample_spec;
172 pa_channel_map channel_map;
176 pa_bool_t volume_is_set:1;
177 pa_bool_t muted_is_set:1;
178 pa_bool_t sample_spec_is_set:1;
179 pa_bool_t channel_map_is_set:1;
181 pa_bool_t namereg_fail:1;
182 } pa_source_new_data;
184 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);
185 void pa_source_new_data_set_name(pa_source_new_data *data, const char *name);
186 void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sample_spec *spec);
187 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
188 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
189 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute);
190 void pa_source_new_data_done(pa_source_new_data *data);
192 /* To be called exclusively by the source driver, from main context */
194 pa_source* pa_source_new(
196 pa_source_new_data *data,
197 pa_source_flags_t flags);
199 void pa_source_put(pa_source *s);
200 void pa_source_unlink(pa_source *s);
202 void pa_source_set_description(pa_source *s, const char *description);
203 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
204 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
206 void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
208 void pa_source_detach(pa_source *s);
209 void pa_source_attach(pa_source *s);
211 /* May be called by everyone, from main context */
213 /* The returned value is supposed to be in the time domain of the sound card! */
214 pa_usec_t pa_source_get_latency(pa_source *s);
215 pa_usec_t pa_source_get_requested_latency(pa_source *s);
216 void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
218 size_t pa_source_get_max_rewind(pa_source *s);
220 int pa_source_update_status(pa_source*s);
221 int pa_source_suspend(pa_source *s, pa_bool_t suspend);
222 int pa_source_suspend_all(pa_core *c, pa_bool_t suspend);
224 void pa_source_set_volume(pa_source *source, const pa_cvolume *volume);
225 void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume);
226 const pa_cvolume *pa_source_get_volume(pa_source *source, pa_bool_t force_refresh);
227 void pa_source_set_mute(pa_source *source, pa_bool_t mute);
228 pa_bool_t pa_source_get_mute(pa_source *source, pa_bool_t force_refresh);
230 pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p);
232 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
233 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */
234 unsigned pa_source_check_suspend(pa_source *s); /* Returns how many streams are active that don't allow suspensions */
235 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
237 /* Moves all inputs away, and stores them in pa_queue */
238 pa_queue *pa_source_move_all_start(pa_source *s);
239 void pa_source_move_all_finish(pa_source *s, pa_queue *q);
240 void pa_source_move_all_fail(pa_queue *q);
242 /* To be called exclusively by the source driver, from IO context */
244 void pa_source_post(pa_source*s, const pa_memchunk *chunk);
245 void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk);
246 void pa_source_process_rewind(pa_source *s, size_t nbytes);
248 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
250 void pa_source_attach_within_thread(pa_source *s);
251 void pa_source_detach_within_thread(pa_source *s);
253 pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s);
255 void pa_source_set_max_rewind(pa_source *s, size_t max_rewind);
256 void pa_source_update_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
258 /* To be called exclusively by source output drivers, from IO context */
260 void pa_source_invalidate_requested_latency(pa_source *s);