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-def.h>
37 #include <pulsecore/core.h>
38 #include <pulsecore/idxset.h>
39 #include <pulsecore/memblock.h>
40 #include <pulsecore/memchunk.h>
41 #include <pulsecore/sink.h>
42 #include <pulsecore/module.h>
43 #include <pulsecore/asyncmsgq.h>
44 #include <pulsecore/msgobject.h>
45 #include <pulsecore/rtpoll.h>
47 #define PA_MAX_OUTPUTS_PER_SOURCE 32
49 typedef enum pa_source_state
{
57 static inline pa_bool_t
PA_SOURCE_OPENED(pa_source_state_t x
) {
58 return x
== PA_SOURCE_RUNNING
|| x
== PA_SOURCE_IDLE
;
61 static inline pa_bool_t
PA_SOURCE_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 *description
, *driver
; /* may be NULL */
76 pa_module
*module
; /* may be NULL */
78 pa_sample_spec sample_spec
;
79 pa_channel_map channel_map
;
83 pa_sink
*monitor_of
; /* may be NULL */
87 pa_bool_t refresh_volume
;
88 pa_bool_t refresh_muted
;
90 int (*set_state
)(pa_source
*source
, pa_source_state_t state
); /* may be NULL */
91 int (*set_volume
)(pa_source
*s
); /* dito */
92 int (*get_volume
)(pa_source
*s
); /* dito */
93 int (*set_mute
)(pa_source
*s
); /* dito */
94 int (*get_mute
)(pa_source
*s
); /* dito */
95 pa_usec_t (*get_latency
)(pa_source
*s
); /* dito */
97 pa_asyncmsgq
*asyncmsgq
;
100 /* Contains copies of the above data so that the real-time worker
101 * thread can work without access locking */
103 pa_source_state_t state
;
105 pa_cvolume soft_volume
;
106 pa_bool_t soft_muted
;
112 PA_DECLARE_CLASS(pa_source
);
113 #define PA_SOURCE(s) pa_source_cast(s)
115 typedef enum pa_source_message
{
116 PA_SOURCE_MESSAGE_ADD_OUTPUT
,
117 PA_SOURCE_MESSAGE_REMOVE_OUTPUT
,
118 PA_SOURCE_MESSAGE_GET_VOLUME
,
119 PA_SOURCE_MESSAGE_SET_VOLUME
,
120 PA_SOURCE_MESSAGE_GET_MUTE
,
121 PA_SOURCE_MESSAGE_SET_MUTE
,
122 PA_SOURCE_MESSAGE_GET_LATENCY
,
123 PA_SOURCE_MESSAGE_SET_STATE
,
124 PA_SOURCE_MESSAGE_PING
,
125 PA_SOURCE_MESSAGE_ATTACH
,
126 PA_SOURCE_MESSAGE_DETACH
,
127 PA_SOURCE_MESSAGE_MAX
128 } pa_source_message_t
;
130 /* To be called exclusively by the source driver, from main context */
132 pa_source
* pa_source_new(
137 const pa_sample_spec
*spec
,
138 const pa_channel_map
*map
);
140 void pa_source_put(pa_source
*s
);
141 void pa_source_unlink(pa_source
*s
);
143 void pa_source_set_module(pa_source
*s
, pa_module
*m
);
144 void pa_source_set_description(pa_source
*s
, const char *description
);
145 void pa_source_set_asyncmsgq(pa_source
*s
, pa_asyncmsgq
*q
);
146 void pa_source_set_rtpoll(pa_source
*s
, pa_rtpoll
*p
);
148 void pa_source_detach(pa_source
*s
);
149 void pa_source_attach(pa_source
*s
);
151 /* May be called by everyone, from main context */
153 pa_usec_t
pa_source_get_latency(pa_source
*s
);
155 int pa_source_update_status(pa_source
*s
);
156 int pa_source_suspend(pa_source
*s
, pa_bool_t suspend
);
157 int pa_source_suspend_all(pa_core
*c
, pa_bool_t suspend
);
159 void pa_source_ping(pa_source
*s
);
161 void pa_source_set_volume(pa_source
*source
, const pa_cvolume
*volume
);
162 const pa_cvolume
*pa_source_get_volume(pa_source
*source
);
163 void pa_source_set_mute(pa_source
*source
, pa_bool_t mute
);
164 pa_bool_t
pa_source_get_mute(pa_source
*source
);
166 unsigned pa_source_linked_by(pa_source
*s
); /* Number of connected streams */
167 unsigned pa_source_used_by(pa_source
*s
); /* Number of connected streams that are not corked */
168 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
170 /* To be called exclusively by the source driver, from IO context */
172 void pa_source_post(pa_source
*s
, const pa_memchunk
*b
);
174 int pa_source_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t, pa_memchunk
*chunk
);
176 void pa_source_attach_within_thread(pa_source
*s
);
177 void pa_source_detach_within_thread(pa_source
*s
);