1 #ifndef foopulsesourcehfoo
2 #define foopulsesourcehfoo
7 This file is part of PulseAudio.
9 Copyright 2004-2006 Lennart Poettering
10 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
12 PulseAudio is free software; you can redistribute it and/or modify
13 it under the terms of the GNU Lesser General Public License as published
14 by the Free Software Foundation; either version 2 of the License,
15 or (at your option) any later version.
17 PulseAudio is distributed in the hope that it will be useful, but
18 WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public License
23 along with PulseAudio; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
28 typedef struct pa_source pa_source
;
32 #include <pulse/sample.h>
33 #include <pulse/channelmap.h>
34 #include <pulse/volume.h>
36 #include <pulsecore/core.h>
37 #include <pulsecore/idxset.h>
38 #include <pulsecore/memblock.h>
39 #include <pulsecore/memchunk.h>
40 #include <pulsecore/sink.h>
41 #include <pulsecore/module.h>
42 #include <pulsecore/asyncmsgq.h>
43 #include <pulsecore/msgobject.h>
44 #include <pulsecore/rtpoll.h>
45 #include <pulsecore/source-output.h>
47 #define PA_MAX_OUTPUTS_PER_SOURCE 32
49 typedef enum pa_source_state
{
57 static inline pa_bool_t
PA_SOURCE_IS_OPENED(pa_source_state_t x
) {
58 return x
== PA_SOURCE_RUNNING
|| x
== PA_SOURCE_IDLE
;
61 static inline pa_bool_t
PA_SOURCE_IS_LINKED(pa_source_state_t x
) {
62 return x
== PA_SOURCE_RUNNING
|| x
== PA_SOURCE_IDLE
|| x
== PA_SOURCE_SUSPENDED
;
70 pa_source_state_t state
;
71 pa_source_flags_t flags
;
74 char *driver
; /* may be NULL */
75 pa_proplist
*proplist
;
77 pa_module
*module
; /* may be NULL */
79 pa_sample_spec sample_spec
;
80 pa_channel_map channel_map
;
84 pa_sink
*monitor_of
; /* may be NULL */
88 pa_bool_t refresh_volume
;
89 pa_bool_t refresh_muted
;
91 pa_asyncmsgq
*asyncmsgq
;
96 pa_usec_t min_latency
; /* we won't go below this latency setting */
97 pa_usec_t max_latency
; /* An upper limit for the latencies */
99 int (*set_state
)(pa_source
*source
, pa_source_state_t state
); /* may be NULL */
100 int (*set_volume
)(pa_source
*s
); /* dito */
101 int (*get_volume
)(pa_source
*s
); /* dito */
102 int (*set_mute
)(pa_source
*s
); /* dito */
103 int (*get_mute
)(pa_source
*s
); /* dito */
104 void (*update_requested_latency
)(pa_source
*s
); /* dito */
106 /* Contains copies of the above data so that the real-time worker
107 * thread can work without access locking */
109 pa_source_state_t state
;
111 pa_cvolume soft_volume
;
112 pa_bool_t soft_muted
;
114 pa_bool_t requested_latency_valid
;
115 pa_usec_t requested_latency
;
117 /* Then number of bytes this source will be rewound for at
125 PA_DECLARE_CLASS(pa_source
);
126 #define PA_SOURCE(s) pa_source_cast(s)
128 typedef enum pa_source_message
{
129 PA_SOURCE_MESSAGE_ADD_OUTPUT
,
130 PA_SOURCE_MESSAGE_REMOVE_OUTPUT
,
131 PA_SOURCE_MESSAGE_GET_VOLUME
,
132 PA_SOURCE_MESSAGE_SET_VOLUME
,
133 PA_SOURCE_MESSAGE_GET_MUTE
,
134 PA_SOURCE_MESSAGE_SET_MUTE
,
135 PA_SOURCE_MESSAGE_GET_LATENCY
,
136 PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY
,
137 PA_SOURCE_MESSAGE_SET_STATE
,
138 PA_SOURCE_MESSAGE_ATTACH
,
139 PA_SOURCE_MESSAGE_DETACH
,
140 PA_SOURCE_MESSAGE_MAX
141 } pa_source_message_t
;
143 typedef struct pa_source_new_data
{
145 pa_bool_t namereg_fail
;
146 pa_proplist
*proplist
;
151 pa_sample_spec sample_spec
;
152 pa_bool_t sample_spec_is_set
;
153 pa_channel_map channel_map
;
154 pa_bool_t channel_map_is_set
;
157 pa_bool_t volume_is_set
;
159 pa_bool_t muted_is_set
;
160 } pa_source_new_data
;
162 pa_source_new_data
* pa_source_new_data_init(pa_source_new_data
*data
);
163 void pa_source_new_data_set_name(pa_source_new_data
*data
, const char *name
);
164 void pa_source_new_data_set_sample_spec(pa_source_new_data
*data
, const pa_sample_spec
*spec
);
165 void pa_source_new_data_set_channel_map(pa_source_new_data
*data
, const pa_channel_map
*map
);
166 void pa_source_new_data_set_volume(pa_source_new_data
*data
, const pa_cvolume
*volume
);
167 void pa_source_new_data_set_muted(pa_source_new_data
*data
, pa_bool_t mute
);
168 void pa_source_new_data_done(pa_source_new_data
*data
);
170 /* To be called exclusively by the source driver, from main context */
172 pa_source
* pa_source_new(
174 pa_source_new_data
*data
,
175 pa_source_flags_t flags
);
177 void pa_source_put(pa_source
*s
);
178 void pa_source_unlink(pa_source
*s
);
180 void pa_source_set_description(pa_source
*s
, const char *description
);
181 void pa_source_set_asyncmsgq(pa_source
*s
, pa_asyncmsgq
*q
);
182 void pa_source_set_rtpoll(pa_source
*s
, pa_rtpoll
*p
);
184 void pa_source_set_latency_range(pa_source
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
);
186 void pa_source_detach(pa_source
*s
);
187 void pa_source_attach(pa_source
*s
);
189 /* May be called by everyone, from main context */
191 pa_usec_t
pa_source_get_latency(pa_source
*s
);
192 pa_usec_t
pa_source_get_requested_latency(pa_source
*s
);
194 int pa_source_update_status(pa_source
*s
);
195 int pa_source_suspend(pa_source
*s
, pa_bool_t suspend
);
196 int pa_source_suspend_all(pa_core
*c
, pa_bool_t suspend
);
198 void pa_source_set_volume(pa_source
*source
, const pa_cvolume
*volume
);
199 const pa_cvolume
*pa_source_get_volume(pa_source
*source
);
200 void pa_source_set_mute(pa_source
*source
, pa_bool_t mute
);
201 pa_bool_t
pa_source_get_mute(pa_source
*source
);
203 unsigned pa_source_linked_by(pa_source
*s
); /* Number of connected streams */
204 unsigned pa_source_used_by(pa_source
*s
); /* Number of connected streams that are not corked */
205 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
207 /* To be called exclusively by the source driver, from IO context */
209 void pa_source_post(pa_source
*s
, const pa_memchunk
*chunk
);
210 void pa_source_post_direct(pa_source
*s
, pa_source_output
*o
, const pa_memchunk
*chunk
);
211 void pa_source_process_rewind(pa_source
*s
, size_t nbytes
);
213 int pa_source_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t, pa_memchunk
*chunk
);
215 void pa_source_attach_within_thread(pa_source
*s
);
216 void pa_source_detach_within_thread(pa_source
*s
);
218 pa_usec_t
pa_source_get_requested_latency_within_thread(pa_source
*s
);
220 void pa_source_set_max_rewind(pa_source
*s
, size_t max_rewind
);
222 /* To be called exclusively by source output drivers, from IO context */
224 void pa_source_invalidate_requested_latency(pa_source
*s
);