1 #ifndef foopulsesourceoutputhfoo
2 #define foopulsesourceoutputhfoo
7 This file is part of PulseAudio.
9 Copyright 2004-2006 Lennart Poettering
11 PulseAudio is free software; you can redistribute it and/or modify
12 it under the terms of the GNU Lesser General Public License as published
13 by the Free Software Foundation; either version 2 of the License,
14 or (at your option) any later version.
16 PulseAudio is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public License
22 along with PulseAudio; if not, write to the Free Software
23 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
29 typedef struct pa_source_output pa_source_output
;
31 #include <pulse/sample.h>
32 #include <pulsecore/source.h>
33 #include <pulsecore/memblockq.h>
34 #include <pulsecore/resampler.h>
35 #include <pulsecore/module.h>
36 #include <pulsecore/client.h>
38 typedef enum pa_source_output_state
{
39 PA_SOURCE_OUTPUT_INIT
,
40 PA_SOURCE_OUTPUT_RUNNING
,
41 PA_SOURCE_OUTPUT_CORKED
,
42 PA_SOURCE_OUTPUT_UNLINKED
43 } pa_source_output_state_t
;
45 static inline int PA_SOURCE_OUTPUT_LINKED(pa_source_output_state_t x
) {
46 return x
== PA_SOURCE_OUTPUT_RUNNING
|| x
== PA_SOURCE_OUTPUT_CORKED
;
49 typedef enum pa_source_output_flags
{
50 PA_SOURCE_OUTPUT_VARIABLE_RATE
= 1,
51 PA_SOURCE_OUTPUT_DONT_MOVE
= 2,
52 PA_SOURCE_OUTPUT_START_CORKED
= 4
53 } pa_source_output_flags_t
;
55 struct pa_source_output
{
60 pa_source_output_state_t state
;
61 pa_source_output_flags_t flags
;
63 char *name
, *driver
; /* may be NULL */
64 pa_module
*module
; /* may be NULL */
65 pa_client
*client
; /* may be NULL */
69 pa_sample_spec sample_spec
;
70 pa_channel_map channel_map
;
72 /* Pushes a new memchunk into the output. Called from IO thread
74 void (*push
)(pa_source_output
*o
, const pa_memchunk
*chunk
);
76 /* If non-NULL this function is called in each IO event loop and
77 * can be used to do additional processing even when the device is
78 * suspended and peek() is never called. Should return 1 when
79 * "some work" has been done and the IO event loop should be
80 * reiterated immediately. Called from IO thread context. */
81 int (*process
) (pa_source_output
*o
); /* may be NULL */
83 /* If non-NULL this function is called when the output is first
84 * connected to a source. Called from IO thread context */
85 void (*attach
) (pa_source_output
*o
); /* may be NULL */
87 /* If non-NULL this function is called when the output is
88 * disconnected from its source. Called from IO thread context */
89 void (*detach
) (pa_source_output
*o
); /* may be NULL */
91 /* If non-NULL called whenever the the source this output is attached
92 * to suspends or resumes. Called from main context */
93 void (*suspend
) (pa_source_output
*o
, int b
); /* may be NULL */
95 /* Supposed to unlink and destroy this stream. Called from main
97 void (*kill
)(pa_source_output
* o
); /* may be NULL */
99 /* Return the current latency (i.e. length of bufferd audio) of
100 this stream. Called from main context. If NULL a
101 PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY message is sent to the IO
103 pa_usec_t (*get_latency
) (pa_source_output
*o
); /* may be NULL */
105 pa_resample_method_t resample_method
;
108 pa_source_output_state_t state
;
110 pa_sample_spec sample_spec
;
112 pa_resampler
* resampler
; /* may be NULL */
118 PA_DECLARE_CLASS(pa_source_output
);
119 #define PA_SOURCE_OUTPUT(o) pa_source_output_cast(o)
122 PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY
,
123 PA_SOURCE_OUTPUT_MESSAGE_SET_RATE
,
124 PA_SOURCE_OUTPUT_MESSAGE_SET_STATE
,
125 PA_SOURCE_OUTPUT_MESSAGE_MAX
128 typedef struct pa_source_output_new_data
{
129 const char *name
, *driver
;
135 pa_sample_spec sample_spec
;
136 int sample_spec_is_set
;
137 pa_channel_map channel_map
;
138 int channel_map_is_set
;
140 pa_resample_method_t resample_method
;
141 } pa_source_output_new_data
;
143 pa_source_output_new_data
* pa_source_output_new_data_init(pa_source_output_new_data
*data
);
144 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data
*data
, const pa_sample_spec
*spec
);
145 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data
*data
, const pa_channel_map
*map
);
146 void pa_source_output_new_data_set_volume(pa_source_output_new_data
*data
, const pa_cvolume
*volume
);
148 /* To be called by the implementing module only */
150 pa_source_output
* pa_source_output_new(
152 pa_source_output_new_data
*data
,
153 pa_source_output_flags_t flags
);
155 void pa_source_output_put(pa_source_output
*o
);
156 void pa_source_output_unlink(pa_source_output
*o
);
158 void pa_source_output_set_name(pa_source_output
*i
, const char *name
);
160 /* Callable by everyone */
162 /* External code may request disconnection with this funcion */
163 void pa_source_output_kill(pa_source_output
*o
);
165 pa_usec_t
pa_source_output_get_latency(pa_source_output
*i
);
167 void pa_source_output_cork(pa_source_output
*i
, int b
);
169 int pa_source_output_set_rate(pa_source_output
*o
, uint32_t rate
);
171 pa_resample_method_t
pa_source_output_get_resample_method(pa_source_output
*o
);
173 int pa_source_output_move_to(pa_source_output
*o
, pa_source
*dest
);
175 #define pa_source_output_get_state(o) ((o)->state)
177 /* To be used exclusively by the source driver thread */
179 void pa_source_output_push(pa_source_output
*o
, const pa_memchunk
*chunk
);
180 int pa_source_output_process_msg(pa_msgobject
*mo
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);