big s/polyp/pulse/g
[profile/ivi/pulseaudio-panda.git] / 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   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.
13  
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.
18  
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
22   USA.
23 ***/
24
25 #include <inttypes.h>
26
27 typedef struct pa_source_output pa_source_output;
28
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>
35
36 typedef enum {
37     PA_SOURCE_OUTPUT_RUNNING,
38     PA_SOURCE_OUTPUT_CORKED,
39     PA_SOURCE_OUTPUT_DISCONNECTED
40 } pa_source_output_state_t;
41
42 struct pa_source_output {
43     int ref;
44     uint32_t index;
45     pa_source_output_state_t state;
46     
47     char *name, *driver;
48     pa_module *owner;
49
50     pa_source *source;
51     pa_client *client;
52
53     pa_sample_spec sample_spec;
54     pa_channel_map channel_map;
55     
56     void (*push)(pa_source_output *o, const pa_memchunk *chunk);
57     void (*kill)(pa_source_output* o);
58     pa_usec_t (*get_latency) (pa_source_output *o);
59
60     pa_resampler* resampler;
61     
62     void *userdata;
63 };
64
65 pa_source_output* pa_source_output_new(
66     pa_source *s,
67     const char *driver,
68     const char *name,
69     const pa_sample_spec *spec,
70     const pa_channel_map *map,
71     int resample_method);
72
73 void pa_source_output_unref(pa_source_output* o);
74 pa_source_output* pa_source_output_ref(pa_source_output *o);
75
76 /* To be called by the implementing module only */
77 void pa_source_output_disconnect(pa_source_output*o);
78
79 /* External code may request disconnection with this funcion */
80 void pa_source_output_kill(pa_source_output*o);
81
82 void pa_source_output_push(pa_source_output *o, const pa_memchunk *chunk);
83
84 void pa_source_output_set_name(pa_source_output *i, const char *name);
85
86 pa_usec_t pa_source_output_get_latency(pa_source_output *i);
87
88 void pa_source_output_cork(pa_source_output *i, int b);
89
90 pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o);
91
92 #endif