1 #ifndef foopulsesinkinputhfoo
2 #define foopulsesinkinputhfoo
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
30 typedef struct pa_sink_input pa_sink_input;
32 #include <pulse/sample.h>
33 #include <pulsecore/hook-list.h>
34 #include <pulsecore/memblockq.h>
35 #include <pulsecore/resampler.h>
36 #include <pulsecore/module.h>
37 #include <pulsecore/client.h>
38 #include <pulsecore/sink.h>
39 #include <pulsecore/core.h>
41 typedef enum pa_sink_input_state {
42 PA_SINK_INPUT_DRAINED, /*< The stream stopped playing because there was no data to play */
43 PA_SINK_INPUT_RUNNING, /*< The stream is alive and kicking */
44 PA_SINK_INPUT_CORKED, /*< The stream was corked on user request */
45 PA_SINK_INPUT_DISCONNECTED /*< The stream is dead */
46 } pa_sink_input_state_t;
48 typedef enum pa_sink_input_flags {
49 PA_SINK_INPUT_VARIABLE_RATE = 1,
50 PA_SINK_INPUT_NO_HOOKS = 2
51 } pa_sink_input_flags_t;
53 struct pa_sink_input {
59 /* Please note that this state should only be read with
60 * pa_sink_input_get_state(). That function will transparently
61 * merge the thread_info.drained value in. */
62 pa_sink_input_state_t state;
63 pa_sink_input_flags_t flags;
65 char *name, *driver; /* may be NULL */
66 pa_module *module; /* may be NULL */
67 pa_client *client; /* may be NULL */
71 pa_sample_spec sample_spec;
72 pa_channel_map channel_map;
77 int (*peek) (pa_sink_input *i, pa_memchunk *chunk);
78 void (*drop) (pa_sink_input *i, const pa_memchunk *chunk, size_t length);
79 void (*kill) (pa_sink_input *i); /* may be NULL */
80 pa_usec_t (*get_latency) (pa_sink_input *i); /* may be NULL */
81 void (*underrun) (pa_sink_input *i); /* may be NULL */
83 pa_resample_method_t resample_method;
86 pa_sink_input_state_t state;
89 pa_sample_spec sample_spec;
91 pa_memchunk resampled_chunk;
92 pa_resampler *resampler; /* may be NULL */
94 /* Some silence to play before the actual data. This is used to
95 * compensate for latency differences when moving a sink input
96 * "hot" between sinks. */
97 /* size_t move_silence; */
98 pa_memblock *silence_memblock; /* may be NULL */
107 PA_DECLARE_CLASS(pa_sink_input);
108 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
111 PA_SINK_INPUT_MESSAGE_SET_VOLUME,
112 PA_SINK_INPUT_MESSAGE_SET_MUTE,
113 PA_SINK_INPUT_MESSAGE_GET_LATENCY,
114 PA_SINK_INPUT_MESSAGE_SET_RATE,
115 PA_SINK_INPUT_MESSAGE_SET_STATE,
116 PA_SINK_INPUT_MESSAGE_MAX
119 typedef struct pa_sink_input_new_data {
120 const char *name, *driver;
126 pa_sample_spec sample_spec;
127 int sample_spec_is_set;
128 pa_channel_map channel_map;
129 int channel_map_is_set;
135 pa_resample_method_t resample_method;
136 } pa_sink_input_new_data;
138 pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data);
139 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec);
140 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map);
141 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume);
142 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, int mute);
144 /* To be called by the implementing module only */
146 pa_sink_input* pa_sink_input_new(
148 pa_sink_input_new_data *data,
149 pa_sink_input_flags_t flags);
151 void pa_sink_input_put(pa_sink_input *i);
152 void pa_sink_input_disconnect(pa_sink_input* i);
154 void pa_sink_input_set_name(pa_sink_input *i, const char *name);
156 /* Callable by everyone */
158 /* External code may request disconnection with this function */
159 void pa_sink_input_kill(pa_sink_input*i);
161 pa_usec_t pa_sink_input_get_latency(pa_sink_input *i);
163 void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume);
164 const pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i);
165 void pa_sink_input_set_mute(pa_sink_input *i, int mute);
166 int pa_sink_input_get_mute(pa_sink_input *i);
168 void pa_sink_input_cork(pa_sink_input *i, int b);
170 int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate);
172 pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i);
174 int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, int immediately);
176 pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i);
178 /* To be used exclusively by the sink driver thread */
180 int pa_sink_input_peek(pa_sink_input *i, pa_memchunk *chunk, pa_cvolume *volume);
181 void pa_sink_input_drop(pa_sink_input *i, const pa_memchunk *chunk, size_t length);
182 int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, pa_memchunk *chunk);