1 #ifndef foopulsesinkhfoo
2 #define foopulsesinkhfoo
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_sink pa_sink
;
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/source.h>
40 #include <pulsecore/module.h>
41 #include <pulsecore/refcnt.h>
42 #include <pulsecore/msgobject.h>
44 #define PA_MAX_INPUTS_PER_SINK 32
46 typedef enum pa_sink_state
{
58 pa_sink_state_t state
;
61 char *description
, *driver
; /* may be NULL */
64 pa_module
*module
; /* may be NULL */
66 pa_sample_spec sample_spec
;
67 pa_channel_map channel_map
;
70 pa_source
*monitor_source
; /* may be NULL */
77 int (*set_state
)(pa_sink
*s
, pa_sink_state_t state
);
78 int (*set_volume
)(pa_sink
*s
); /* dito */
79 int (*get_volume
)(pa_sink
*s
); /* dito */
80 int (*get_mute
)(pa_sink
*s
); /* dito */
81 int (*set_mute
)(pa_sink
*s
); /* dito */
82 pa_usec_t (*get_latency
)(pa_sink
*s
); /* dito */
84 pa_asyncmsgq
*asyncmsgq
;
86 /* Contains copies of the above data so that the real-time worker
87 * thread can work without access locking */
89 pa_sink_state_t state
;
91 pa_cvolume soft_volume
;
100 PA_DECLARE_CLASS(pa_sink
);
101 #define PA_SINK(s) (pa_sink_cast(s))
103 typedef enum pa_sink_message
{
104 PA_SINK_MESSAGE_ADD_INPUT
,
105 PA_SINK_MESSAGE_REMOVE_INPUT
,
106 PA_SINK_MESSAGE_GET_VOLUME
,
107 PA_SINK_MESSAGE_SET_VOLUME
,
108 PA_SINK_MESSAGE_GET_MUTE
,
109 PA_SINK_MESSAGE_SET_MUTE
,
110 PA_SINK_MESSAGE_GET_LATENCY
,
111 PA_SINK_MESSAGE_SET_STATE
,
112 PA_SINK_MESSAGE_PING
,
113 PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER
,
117 /* To be used exclusively by the sink driver */
119 pa_sink
* pa_sink_new(
124 const pa_sample_spec
*spec
,
125 const pa_channel_map
*map
);
127 void pa_sink_disconnect(pa_sink
* s
);
129 void pa_sink_set_module(pa_sink
*sink
, pa_module
*m
);
130 void pa_sink_set_description(pa_sink
*s
, const char *description
);
131 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
);
133 /* Usable by everyone */
135 pa_usec_t
pa_sink_get_latency(pa_sink
*s
);
137 int pa_sink_update_status(pa_sink
*s
);
138 int pa_sink_suspend(pa_sink
*s
, int suspend
);
140 /* Sends a ping message to the sink thread, to make it wake up and
141 * check for data to process even if there is no real message is
143 void pa_sink_ping(pa_sink
*s
);
145 void pa_sink_set_volume(pa_sink
*sink
, const pa_cvolume
*volume
);
146 const pa_cvolume
*pa_sink_get_volume(pa_sink
*sink
);
147 void pa_sink_set_mute(pa_sink
*sink
, int mute
);
148 int pa_sink_get_mute(pa_sink
*sink
);
150 unsigned pa_sink_used_by(pa_sink
*s
);
151 #define pa_sink_get_state(s) ((s)->state)
153 /* To be used exclusively by the sink driver thread */
155 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
156 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
157 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
);
158 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
);
160 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);
162 static inline int PA_SINK_OPENED(pa_sink_state_t x
) {
163 return x
== PA_SINK_RUNNING
|| x
== PA_SINK_IDLE
;