7 This file is part of polypaudio.
9 polypaudio 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.
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.
19 You should have received a copy of the GNU Lesser 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
25 #include <sys/types.h>
27 #include <polyp/sample.h>
28 #include <polyp/channelmap.h>
29 #include <polyp/def.h>
30 #include <polyp/cdecl.h>
32 /** \page simple Simple API
34 * \section overv_sec Overview
36 * The simple API is designed for applications with very basic sound
37 * playback or capture needs. It can only support a single stream per
38 * connection and has no handling of complex features like events, channel
39 * mappings and volume control. It is, however, very simple to use and
40 * quite sufficent for many programs.
42 * \section conn_sec Connecting
44 * The first step before using the sound system is to connect to the
45 * server. This is normally done this way:
51 * ss.format = PA_SAMPLE_S16_NE;
55 * s = pa_simple_new(NULL, // Use the default server.
56 * "Fooapp", // Our application's name.
58 * NULL, // Use the default device.
59 * "Music", // Description of our stream.
60 * &ss, // Our sample format.
61 * NULL, // Use default channel map
62 * NULL, // Use default buffering attributes.
63 * NULL, // Ignore error code.
67 * At this point a connected object is returned, or NULL if there was a
70 * \section transfer_sec Transferring data
72 * Once the connection is established to the server, data can start flowing.
73 * Using the connection is very similar to the normal read() and write()
74 * system calls. The main difference is that they're call pa_simple_read()
75 * and pa_simple_write(). Note that these operations always block.
77 * \section ctrl_sec Buffer control
79 * If a playback stream is used then a few other operations are available:
81 * \li pa_simple_drain() - Will wait for all sent data to finish playing.
82 * \li pa_simple_flush() - Will throw away all data currently in buffers.
83 * \li pa_simple_get_playback_latency() - Will return the total latency of
84 * the playback pipeline.
86 * \section cleanup_sec Cleanup
88 * Once playback or capture is complete, the connection should be closed
89 * and resources freed. This is done through:
97 * A simple but limited synchronous playback and recording
98 * API. This is a synchronous, simplified wrapper around the standard
99 * asynchronous API. */
101 /** \example pacat-simple.c
102 * A simple playback tool using the simple API */
104 /** \example parec-simple.c
105 * A simple recording tool using the simple API */
109 /** \struct pa_simple
110 * An opaque simple connection object */
111 typedef struct pa_simple pa_simple
;
113 /** Create a new connection to the server */
114 pa_simple
* pa_simple_new(
115 const char *server
, /**< Server name, or NULL for default */
116 const char *name
, /**< A descriptive name for this client (application name, ...) */
117 pa_stream_direction_t dir
, /**< Open this stream for recording or playback? */
118 const char *dev
, /**< Sink (resp. source) name, or NULL for default */
119 const char *stream_name
, /**< A descriptive name for this client (application name, song title, ...) */
120 const pa_sample_spec
*ss
, /**< The sample type to use */
121 const pa_channel_map
*map
, /**< The channel map to use, or NULL for default */
122 const pa_buffer_attr
*attr
, /**< Buffering attributes, or NULL for default */
123 int *error
/**< A pointer where the error code is stored when the routine returns NULL. It is OK to pass NULL here. */
126 /** Close and free the connection to the server. The connection objects becomes invalid when this is called. */
127 void pa_simple_free(pa_simple
*s
);
129 /** Write some data to the server */
130 int pa_simple_write(pa_simple
*s
, const void*data
, size_t length
, int *error
);
132 /** Wait until all data already written is played by the daemon */
133 int pa_simple_drain(pa_simple
*s
, int *error
);
135 /** Read some data from the server */
136 int pa_simple_read(pa_simple
*s
, void*data
, size_t length
, int *error
);
138 /** Return the playback latency. \since 0.5 */
139 pa_usec_t
pa_simple_get_playback_latency(pa_simple
*s
, int *error
);
141 /** Flush the playback buffer. \since 0.5 */
142 int pa_simple_flush(pa_simple
*s
, int *error
);