]> code.delx.au - pulseaudio/blob - src/pulsecore/source-output.h
Add copyright notices to all relevant files. (based on svn log)
[pulseaudio] / src / pulsecore / source-output.h
1 #ifndef foosourceoutputhfoo
2 #define foosourceoutputhfoo
3
4 /* $Id$ */
5
6 /***
7 This file is part of PulseAudio.
8
9 Copyright 2004-2006 Lennart Poettering
10
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.
15
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.
20
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
24 USA.
25 ***/
26
27 #include <inttypes.h>
28
29 typedef struct pa_source_output pa_source_output;
30
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>
37
38 typedef enum {
39 PA_SOURCE_OUTPUT_RUNNING,
40 PA_SOURCE_OUTPUT_CORKED,
41 PA_SOURCE_OUTPUT_DISCONNECTED
42 } pa_source_output_state_t;
43
44 typedef enum pa_source_output_flags {
45 PA_SOURCE_OUTPUT_NO_HOOKS = 1
46 } pa_source_output_flags_t;
47
48 struct pa_source_output {
49 int ref;
50 uint32_t index;
51 pa_source_output_state_t state;
52
53 char *name, *driver; /* may be NULL */
54 pa_module *module; /* may be NULL */
55
56 pa_source *source;
57 pa_client *client; /* may be NULL */
58
59 pa_sample_spec sample_spec;
60 pa_channel_map channel_map;
61
62 void (*push)(pa_source_output *o, const pa_memchunk *chunk);
63 void (*kill)(pa_source_output* o); /* may be NULL */
64 pa_usec_t (*get_latency) (pa_source_output *o); /* may be NULL */
65
66 pa_resampler* resampler; /* may be NULL */
67 pa_resample_method_t resample_method;
68
69 void *userdata;
70 };
71
72 typedef struct pa_source_output_new_data {
73 const char *name, *driver;
74 pa_module *module;
75 pa_client *client;
76
77 pa_source *source;
78
79 pa_sample_spec sample_spec;
80 int sample_spec_is_set;
81 pa_channel_map channel_map;
82 int channel_map_is_set;
83
84 pa_resample_method_t resample_method;
85 } pa_source_output_new_data;
86
87 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data);
88 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec);
89 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map);
90 void pa_source_output_new_data_set_volume(pa_source_output_new_data *data, const pa_cvolume *volume);
91
92 pa_source_output* pa_source_output_new(
93 pa_core *core,
94 pa_source_output_new_data *data,
95 pa_source_output_flags_t flags);
96
97 void pa_source_output_unref(pa_source_output* o);
98 pa_source_output* pa_source_output_ref(pa_source_output *o);
99
100 /* To be called by the implementing module only */
101 void pa_source_output_disconnect(pa_source_output*o);
102
103 /* External code may request disconnection with this funcion */
104 void pa_source_output_kill(pa_source_output*o);
105
106 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk);
107
108 void pa_source_output_set_name(pa_source_output *i, const char *name);
109
110 pa_usec_t pa_source_output_get_latency(pa_source_output *i);
111
112 void pa_source_output_cork(pa_source_output *i, int b);
113
114 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o);
115
116 int pa_source_output_move_to(pa_source_output *o, pa_source *dest);
117
118 #endif