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>
46 #define PA_MAX_OUTPUTS_PER_SOURCE 32
48 typedef enum pa_source_state {
52 PA_SOURCE_DISCONNECTED
63 char *description, *driver; /* may be NULL */
66 pa_module *module; /* may be NULL */
68 pa_sample_spec sample_spec;
69 pa_channel_map channel_map;
72 pa_sink *monitor_of; /* may be NULL */
79 void (*start)(pa_source*source); /* may be NULL */
80 void (*stop)(pa_source*source); /* may be NULL */
81 int (*set_volume)(pa_source *s); /* dito */
82 int (*get_volume)(pa_source *s); /* dito */
83 int (*set_mute)(pa_source *s); /* dito */
84 int (*get_mute)(pa_source *s); /* dito */
85 pa_usec_t (*get_latency)(pa_source *s); /* dito */
87 pa_asyncmsgq *asyncmsgq;
91 pa_cvolume soft_volume;
98 PA_DECLARE_CLASS(pa_source);
99 #define PA_SOURCE(s) ((pa_source*) (s))
101 typedef enum pa_source_message {
102 PA_SOURCE_MESSAGE_ADD_OUTPUT,
103 PA_SOURCE_MESSAGE_REMOVE_OUTPUT,
104 PA_SOURCE_MESSAGE_GET_VOLUME,
105 PA_SOURCE_MESSAGE_SET_VOLUME,
106 PA_SOURCE_MESSAGE_GET_MUTE,
107 PA_SOURCE_MESSAGE_SET_MUTE,
108 PA_SOURCE_MESSAGE_GET_LATENCY,
109 PA_SOURCE_MESSAGE_START,
110 PA_SOURCE_MESSAGE_STOP,
111 PA_SOURCE_MESSAGE_MAX
112 } pa_source_message_t;
114 /* To be used exclusively by the source driver */
116 pa_source* pa_source_new(
121 const pa_sample_spec *spec,
122 const pa_channel_map *map);
124 void pa_source_disconnect(pa_source *s);
126 void pa_source_set_module(pa_source *s, pa_module *m);
127 void pa_source_set_description(pa_source *s, const char *description);
129 /* Callable by everyone */
131 pa_usec_t pa_source_get_latency(pa_source *s);
133 void pa_source_update_status(pa_source*s);
134 void pa_source_suspend(pa_source *s);
136 void pa_source_set_volume(pa_source *source, const pa_cvolume *volume);
137 const pa_cvolume *pa_source_get_volume(pa_source *source);
138 void pa_source_set_mute(pa_source *source, int mute);
139 int pa_source_get_mute(pa_source *source);
141 unsigned pa_source_used_by(pa_source *s);
142 #define pa_source_get_state(s) ((pa_source_state_t) pa_atomic_load(&(s)->state))
144 /* To be used exclusively by the source driver thread */
146 void pa_source_post(pa_source*s, const pa_memchunk *b);
147 void pa_source_process_msg(pa_msgobject *o, int code, void *userdata, pa_memchunk *chunk);