remove native-common-internal
[platform/upstream/pulseaudio.git] / polyp / polyplib-stream.h
1 #ifndef foopolyplibstreamhfoo
2 #define foopolyplibstreamhfoo
3
4 /* $Id$ */
5
6 /***
7   This file is part of polypaudio.
8  
9   polypaudio is free software; you can redistribute it and/or modify
10   it under the terms of the GNU 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   polypaudio 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 General Public License
20   along with polypaudio; 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 <sys/types.h>
26
27 #include "sample.h"
28 #include "polyplib-def.h"
29 #include "cdecl.h"
30 #include "polyplib-operation.h"
31
32 /** \file
33  * Audio streams for input, output and sample upload */
34
35 PA_C_DECL_BEGIN
36
37 /** The state of a stream */
38 enum pa_stream_state {
39     PA_STREAM_DISCONNECTED, /**< The stream is not yet connected to any sink or source */
40     PA_STREAM_CREATING,     /**< The stream is being created */
41     PA_STREAM_READY,        /**< The stream is established, you may pass audio data to it now */
42     PA_STREAM_FAILED,       /**< An error occured that made the stream invalid */
43     PA_STREAM_TERMINATED,   /**< The stream has been terminated cleanly */
44 };
45
46 /** \struct pa_stream
47  * A stream for playback or recording */
48 struct pa_stream;
49
50 /** Create a new, unconnected stream with the specified name and sample type */
51 struct pa_stream* pa_stream_new(struct pa_context *c, const char *name, const struct pa_sample_spec *ss);
52
53 /** Decrease the reference counter by one */
54 void pa_stream_unref(struct pa_stream *s);
55
56 /** Increase the reference counter by one */
57 struct pa_stream *pa_stream_ref(struct pa_stream *s);
58
59 /** Return the current state of the stream */
60 enum pa_stream_state pa_stream_get_state(struct pa_stream *p);
61
62 /** Return the context this stream is attached to */
63 struct pa_context* pa_stream_get_context(struct pa_stream *p);
64
65 /** Return the device (sink input or source output) index this stream is connected to */
66 uint32_t pa_stream_get_index(struct pa_stream *s);
67
68 /** Connect the stream to a sink */
69 void pa_stream_connect_playback(struct pa_stream *s, const char *dev, const struct pa_buffer_attr *attr);
70
71 /** Connect the stream to a source */
72 void pa_stream_connect_record(struct pa_stream *s, const char *dev, const struct pa_buffer_attr *attr);
73
74 /** Disconnect a stream from a source/sink */
75 void pa_stream_disconnect(struct pa_stream *s);
76
77 /** Write some data to the server (for playback sinks), if free_cb is
78  * non-NULL this routine is called when all data has been written out
79  * and an internal reference to the specified data is kept, the data
80  * is not copied. If NULL, the data is copied into an internal
81  * buffer. */ 
82 void pa_stream_write(struct pa_stream *p, const void *data, size_t length, void (*free_cb)(void *p));
83
84 /** Return the amount of bytes that may be written using pa_stream_write() */
85 size_t pa_stream_writable_size(struct pa_stream *p);
86
87 /** Drain a playback stream */
88 struct pa_operation* pa_stream_drain(struct pa_stream *s, void (*cb) (struct pa_stream*s, int success, void *userdata), void *userdata);
89
90 /** Get the playback latency of a stream */
91 struct pa_operation* pa_stream_get_latency(struct pa_stream *p, void (*cb)(struct pa_stream *p, uint32_t latency, void *userdata), void *userdata);
92
93 /** Set the callback function that is called whenever the state of the stream changes */
94 void pa_stream_set_state_callback(struct pa_stream *s, void (*cb)(struct pa_stream *s, void *userdata), void *userdata);
95
96 /** Set the callback function that is called when new data may be written to the stream */
97 void pa_stream_set_write_callback(struct pa_stream *p, void (*cb)(struct pa_stream *p, size_t length, void *userdata), void *userdata);
98
99 /** Set the callback function that is called when new data is available from the stream */
100 void pa_stream_set_read_callback(struct pa_stream *p, void (*cb)(struct pa_stream *p, const void*data, size_t length, void *userdata), void *userdata);
101
102 PA_C_DECL_END
103
104 #endif