1 #ifndef foopulsesourceoutputhfoo
2 #define foopulsesourceoutputhfoo
5 This file is part of PulseAudio.
7 Copyright 2004-2006 Lennart Poettering
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
27 typedef struct pa_source_output pa_source_output
;
29 #include <pulse/sample.h>
30 #include <pulsecore/source.h>
31 #include <pulsecore/memblockq.h>
32 #include <pulsecore/resampler.h>
33 #include <pulsecore/module.h>
34 #include <pulsecore/client.h>
36 typedef enum pa_source_output_state
{
37 PA_SOURCE_OUTPUT_INIT
,
38 PA_SOURCE_OUTPUT_RUNNING
,
39 PA_SOURCE_OUTPUT_CORKED
,
40 PA_SOURCE_OUTPUT_UNLINKED
41 } pa_source_output_state_t
;
43 static inline pa_bool_t
PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_state_t x
) {
44 return x
== PA_SOURCE_OUTPUT_RUNNING
|| x
== PA_SOURCE_OUTPUT_CORKED
;
47 typedef enum pa_source_output_flags
{
48 PA_SOURCE_OUTPUT_VARIABLE_RATE
= 1,
49 PA_SOURCE_OUTPUT_DONT_MOVE
= 2,
50 PA_SOURCE_OUTPUT_START_CORKED
= 4,
51 PA_SOURCE_OUTPUT_NO_REMAP
= 8,
52 PA_SOURCE_OUTPUT_NO_REMIX
= 16,
53 PA_SOURCE_OUTPUT_FIX_FORMAT
= 32,
54 PA_SOURCE_OUTPUT_FIX_RATE
= 64,
55 PA_SOURCE_OUTPUT_FIX_CHANNELS
= 128,
56 PA_SOURCE_OUTPUT_DONT_INHIBIT_AUTO_SUSPEND
= 256
57 } pa_source_output_flags_t
;
59 struct pa_source_output
{
65 pa_source_output_state_t state
;
66 pa_source_output_flags_t flags
;
68 char *driver
; /* may be NULL */
69 pa_proplist
*proplist
;
71 pa_module
*module
; /* may be NULL */
72 pa_client
*client
; /* may be NULL */
74 pa_source
*source
; /* NULL while being moved */
76 /* A source output can monitor just a single input of a sink, in which case we find it here */
77 pa_sink_input
*direct_on_input
; /* may be NULL */
79 pa_sample_spec sample_spec
;
80 pa_channel_map channel_map
;
82 /* if TRUE then the source we are connected to is worth
83 * remembering, i.e. was explicitly chosen by the user and not
84 * automatically. module-stream-restore looks for this.*/
85 pa_bool_t save_source
:1;
87 pa_resample_method_t requested_resample_method
, actual_resample_method
;
89 /* Pushes a new memchunk into the output. Called from IO thread
91 void (*push
)(pa_source_output
*o
, const pa_memchunk
*chunk
); /* may NOT be NULL */
93 /* Only relevant for monitor sources right now: called when the
94 * recorded stream is rewound. Called from IO context */
95 void (*process_rewind
)(pa_source_output
*o
, size_t nbytes
); /* may be NULL */
97 /* Called whenever the maximum rewindable size of the source
98 * changes. Called from IO thread context. */
99 void (*update_max_rewind
) (pa_source_output
*o
, size_t nbytes
); /* may be NULL */
101 /* Called whenever the configured latency of the source
102 * changes. Called from IO context. */
103 void (*update_source_requested_latency
) (pa_source_output
*o
); /* may be NULL */
105 /* Called whenver the latency range of the source changes. Called
106 * from IO context. */
107 void (*update_source_latency_range
) (pa_source_output
*o
); /* may be NULL */
109 /* If non-NULL this function is called when the output is first
110 * connected to a source. Called from IO thread context */
111 void (*attach
) (pa_source_output
*o
); /* may be NULL */
113 /* If non-NULL this function is called when the output is
114 * disconnected from its source. Called from IO thread context */
115 void (*detach
) (pa_source_output
*o
); /* may be NULL */
117 /* If non-NULL called whenever the the source this output is attached
118 * to suspends or resumes. Called from main context */
119 void (*suspend
) (pa_source_output
*o
, pa_bool_t b
); /* may be NULL */
121 /* If non-NULL called whenever the the source this output is attached
122 * to changes. Called from main context */
123 void (*moved
) (pa_source_output
*o
); /* may be NULL */
125 /* Supposed to unlink and destroy this stream. Called from main
127 void (*kill
)(pa_source_output
* o
); /* may NOT be NULL */
129 /* Return the current latency (i.e. length of bufferd audio) of
130 this stream. Called from main context. This is added to what the
131 PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY message sent to the IO thread
133 pa_usec_t (*get_latency
) (pa_source_output
*o
); /* may be NULL */
135 /* If non-NULL this function is called from thread context if the
136 * state changes. The old state is found in thread_info.state. */
137 void (*state_change
) (pa_source_output
*o
, pa_source_output_state_t state
); /* may be NULL */
139 /* If non-NULL this function is called before this source output
140 * is moved to a source and if it returns FALSE the move
141 * will not be allowed */
142 pa_bool_t (*may_move_to
) (pa_source_output
*o
, pa_source
*s
); /* may be NULL */
145 pa_source_output_state_t state
;
147 pa_bool_t attached
:1; /* True only between ->attach() and ->detach() calls */
149 pa_sample_spec sample_spec
;
151 pa_resampler
* resampler
; /* may be NULL */
153 /* We maintain a delay memblockq here for source outputs that
154 * don't implement rewind() */
155 pa_memblockq
*delay_memblockq
;
157 /* The requested latency for the source */
158 pa_usec_t requested_source_latency
;
160 pa_sink_input
*direct_on_input
; /* may be NULL */
166 PA_DECLARE_CLASS(pa_source_output
);
167 #define PA_SOURCE_OUTPUT(o) pa_source_output_cast(o)
170 PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY
,
171 PA_SOURCE_OUTPUT_MESSAGE_SET_RATE
,
172 PA_SOURCE_OUTPUT_MESSAGE_SET_STATE
,
173 PA_SOURCE_OUTPUT_MESSAGE_SET_REQUESTED_LATENCY
,
174 PA_SOURCE_OUTPUT_MESSAGE_GET_REQUESTED_LATENCY
,
175 PA_SOURCE_OUTPUT_MESSAGE_MAX
178 typedef struct pa_source_output_new_data
{
179 pa_proplist
*proplist
;
180 pa_sink_input
*direct_on_input
;
188 pa_resample_method_t resample_method
;
190 pa_sample_spec sample_spec
;
191 pa_channel_map channel_map
;
193 pa_bool_t sample_spec_is_set
:1;
194 pa_bool_t channel_map_is_set
:1;
196 pa_bool_t save_source
:1;
197 } pa_source_output_new_data
;
199 pa_source_output_new_data
* pa_source_output_new_data_init(pa_source_output_new_data
*data
);
200 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data
*data
, const pa_sample_spec
*spec
);
201 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data
*data
, const pa_channel_map
*map
);
202 void pa_source_output_new_data_done(pa_source_output_new_data
*data
);
204 /* To be called by the implementing module only */
206 pa_source_output
* pa_source_output_new(
208 pa_source_output_new_data
*data
,
209 pa_source_output_flags_t flags
);
211 void pa_source_output_put(pa_source_output
*o
);
212 void pa_source_output_unlink(pa_source_output
*o
);
214 void pa_source_output_set_name(pa_source_output
*o
, const char *name
);
216 pa_usec_t
pa_source_output_set_requested_latency(pa_source_output
*o
, pa_usec_t usec
);
218 void pa_source_output_cork(pa_source_output
*o
, pa_bool_t b
);
220 int pa_source_output_set_rate(pa_source_output
*o
, uint32_t rate
);
222 /* Callable by everyone */
224 /* External code may request disconnection with this funcion */
225 void pa_source_output_kill(pa_source_output
*o
);
227 pa_usec_t
pa_source_output_get_latency(pa_source_output
*o
, pa_usec_t
*source_latency
);
229 pa_bool_t
pa_source_output_update_proplist(pa_source_output
*o
, pa_update_mode_t mode
, pa_proplist
*p
);
231 pa_resample_method_t
pa_source_output_get_resample_method(pa_source_output
*o
);
233 pa_bool_t
pa_source_output_may_move(pa_source_output
*o
);
234 pa_bool_t
pa_source_output_may_move_to(pa_source_output
*o
, pa_source
*dest
);
235 int pa_source_output_move_to(pa_source_output
*o
, pa_source
*dest
, pa_bool_t save
);
237 /* The same as pa_source_output_move_to() but in two seperate steps,
238 * first the detaching from the old source, then the attaching to the
240 int pa_source_output_start_move(pa_source_output
*o
);
241 int pa_source_output_finish_move(pa_source_output
*o
, pa_source
*dest
, pa_bool_t save
);
243 #define pa_source_output_get_state(o) ((o)->state)
245 pa_usec_t
pa_source_output_get_requested_latency(pa_source_output
*o
);
247 /* To be used exclusively by the source driver thread */
249 void pa_source_output_push(pa_source_output
*o
, const pa_memchunk
*chunk
);
250 void pa_source_output_process_rewind(pa_source_output
*o
, size_t nbytes
);
251 void pa_source_output_update_max_rewind(pa_source_output
*o
, size_t nbytes
);
253 void pa_source_output_set_state_within_thread(pa_source_output
*o
, pa_source_output_state_t state
);
255 int pa_source_output_process_msg(pa_msgobject
*mo
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);
257 pa_usec_t
pa_source_output_set_requested_latency_within_thread(pa_source_output
*o
, pa_usec_t usec
);