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 /** \struct pa_stream
  38  * An opaque stream for playback or recording */
  39 struct pa_stream;
  40
  41 /** Create a new, unconnected stream with the specified name and sample type */
  42 struct pa_stream* pa_stream_new(struct pa_context *c, const char *name, const struct pa_sample_spec *ss);
  43
  44 /** Decrease the reference counter by one */
  45 void pa_stream_unref(struct pa_stream *s);
  46
  47 /** Increase the reference counter by one */
  48 struct pa_stream *pa_stream_ref(struct pa_stream *s);
  49
  50 /** Return the current state of the stream */
  51 enum pa_stream_state pa_stream_get_state(struct pa_stream *p);
  52
  53 /** Return the context this stream is attached to */
  54 struct pa_context* pa_stream_get_context(struct pa_stream *p);
  55
  56 /** Return the device (sink input or source output) index this stream is connected to */
  57 uint32_t pa_stream_get_index(struct pa_stream *s);
  58
  59 /** Connect the stream to a sink */
  60 void pa_stream_connect_playback(struct pa_stream *s, const char *dev, const struct pa_buffer_attr *attr);
  61
  62 /** Connect the stream to a source */
  63 void pa_stream_connect_record(struct pa_stream *s, const char *dev, const struct pa_buffer_attr *attr);
  64
  65 /** Disconnect a stream from a source/sink */
  66 void pa_stream_disconnect(struct pa_stream *s);
  67
  68 /** Write some data to the server (for playback sinks), if free_cb is
  69  * non-NULL this routine is called when all data has been written out
  70  * and an internal reference to the specified data is kept, the data
  71  * is not copied. If NULL, the data is copied into an internal
  72  * buffer. */
  73 void pa_stream_write(struct pa_stream *p, const void *data, size_t length, void (*free_cb)(void *p));
  74
  75 /** Return the amount of bytes that may be written using pa_stream_write() */
  76 size_t pa_stream_writable_size(struct pa_stream *p);
  77
  78 /** Drain a playback stream */
  79 struct pa_operation* pa_stream_drain(struct pa_stream *s, void (*cb) (struct pa_stream*s, int success, void *userdata), void *userdata);
  80
  81 /** Get the playback latency of a stream */
  82 struct pa_operation* pa_stream_get_latency(struct pa_stream *p, void (*cb)(struct pa_stream *p, uint32_t latency, void *userdata), void *userdata);
  83
  84 /** Set the callback function that is called whenever the state of the stream changes */
  85 void pa_stream_set_state_callback(struct pa_stream *s, void (*cb)(struct pa_stream *s, void *userdata), void *userdata);
  86
  87 /** Set the callback function that is called when new data may be written to the stream */
  88 void pa_stream_set_write_callback(struct pa_stream *p, void (*cb)(struct pa_stream *p, size_t length, void *userdata), void *userdata);
  89
  90 /** Set the callback function that is called when new data is available from the stream */
  91 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);
  92
  93 PA_C_DECL_END
  94
  95 #endif