Go to the documentation of this file.
8 #ifndef SOUNDIO_SOUNDIO_H
9 #define SOUNDIO_SOUNDIO_H
16 #define SOUNDIO_EXTERN_C extern "C"
18 #define SOUNDIO_EXTERN_C
21 #if defined(SOUNDIO_STATIC_LIBRARY)
22 # define SOUNDIO_EXPORT SOUNDIO_EXTERN_C
25 # if defined(SOUNDIO_BUILDING_LIBRARY)
26 # define SOUNDIO_EXPORT SOUNDIO_EXTERN_C __declspec(dllexport)
28 # define SOUNDIO_EXPORT SOUNDIO_EXTERN_C __declspec(dllimport)
31 # define SOUNDIO_EXPORT SOUNDIO_EXTERN_C __attribute__((visibility ("default")))
257 #if defined(SOUNDIO_OS_BIG_ENDIAN)
258 #define SoundIoFormatS16NE SoundIoFormatS16BE
259 #define SoundIoFormatU16NE SoundIoFormatU16BE
260 #define SoundIoFormatS24NE SoundIoFormatS24BE
261 #define SoundIoFormatU24NE SoundIoFormatU24BE
262 #define SoundIoFormatS32NE SoundIoFormatS32BE
263 #define SoundIoFormatU32NE SoundIoFormatU32BE
264 #define SoundIoFormatFloat32NE SoundIoFormatFloat32BE
265 #define SoundIoFormatFloat64NE SoundIoFormatFloat64BE
267 #define SoundIoFormatS16FE SoundIoFormatS16LE
268 #define SoundIoFormatU16FE SoundIoFormatU16LE
269 #define SoundIoFormatS24FE SoundIoFormatS24LE
270 #define SoundIoFormatU24FE SoundIoFormatU24LE
271 #define SoundIoFormatS32FE SoundIoFormatS32LE
272 #define SoundIoFormatU32FE SoundIoFormatU32LE
273 #define SoundIoFormatFloat32FE SoundIoFormatFloat32LE
274 #define SoundIoFormatFloat64FE SoundIoFormatFloat64LE
276 #elif defined(SOUNDIO_OS_LITTLE_ENDIAN)
278 #define SoundIoFormatS16NE SoundIoFormatS16LE
279 #define SoundIoFormatU16NE SoundIoFormatU16LE
280 #define SoundIoFormatS24NE SoundIoFormatS24LE
281 #define SoundIoFormatU24NE SoundIoFormatU24LE
282 #define SoundIoFormatS32NE SoundIoFormatS32LE
283 #define SoundIoFormatU32NE SoundIoFormatU32LE
284 #define SoundIoFormatFloat32NE SoundIoFormatFloat32LE
285 #define SoundIoFormatFloat64NE SoundIoFormatFloat64LE
287 #define SoundIoFormatS16FE SoundIoFormatS16BE
288 #define SoundIoFormatU16FE SoundIoFormatU16BE
289 #define SoundIoFormatS24FE SoundIoFormatS24BE
290 #define SoundIoFormatU24FE SoundIoFormatU24BE
291 #define SoundIoFormatS32FE SoundIoFormatS32BE
292 #define SoundIoFormatU32FE SoundIoFormatU32BE
293 #define SoundIoFormatFloat32FE SoundIoFormatFloat32BE
294 #define SoundIoFormatFloat64FE SoundIoFormatFloat64BE
297 #error unknown byte order
300 #define SOUNDIO_MAX_CHANNELS 24
555 int frame_count_min,
int frame_count_max);
1055 double *out_latency);
1160 double *out_latency);
1167 struct SoundIoRingBuffer;
void soundio_flush_events(struct SoundIo *soundio)
Atomically update information for all connected devices.
@ SoundIoChannelIdHeadphonesLeft
First of the "other" channel ids.
Definition: soundio.h:160
@ SoundIoErrorSystemResources
A system resource other than memory was not available.
Definition: soundio.h:79
@ SoundIoErrorBackendUnavailable
libsoundio was compiled without support for that backend.
Definition: soundio.h:86
@ SoundIoChannelLayoutIdHexagonal
Definition: soundio.h:206
const char * app_name
Optional: Application name.
Definition: soundio.h:360
char * soundio_ring_buffer_read_ptr(struct SoundIoRingBuffer *ring_buffer)
Do not read more than capacity.
int soundio_instream_pause(struct SoundIoInStream *instream, bool pause)
If the underyling device supports pausing, this pauses the stream and prevents SoundIoInStream::read_...
@ SoundIoChannelLayoutIdMono
Definition: soundio.h:190
int soundio_instream_get_latency(struct SoundIoInStream *instream, double *out_latency)
Obtain the number of seconds that the next frame of sound being captured will take to arrive in the b...
@ SoundIoChannelIdFrontRight
Definition: soundio.h:110
@ SoundIoChannelLayoutId5Point0Back
Definition: soundio.h:200
void(* jack_error_callback)(const char *msg)
Optional: JACK error callback.
Definition: soundio.h:379
struct SoundIo * soundio
Read-only. Set automatically.
Definition: soundio.h:385
void(* read_callback)(struct SoundIoInStream *, int frame_count_min, int frame_count_max)
In this function call soundio_instream_begin_read and soundio_instream_end_read as many times as nece...
Definition: soundio.h:639
@ SoundIoChannelIdLfe
Definition: soundio.h:112
@ SoundIoChannelIdBottomCenter
Definition: soundio.h:142
@ SoundIoErrorBackendDisconnected
Backend server shutdown or became inactive.
Definition: soundio.h:97
int soundio_ring_buffer_free_count(struct SoundIoRingBuffer *ring_buffer)
Returns how many bytes of the buffer is free, ready for writing.
@ SoundIoChannelIdMsMid
Mid/side recording.
Definition: soundio.h:147
@ SoundIoChannelIdForeignLanguage
Definition: soundio.h:163
void(* on_devices_change)(struct SoundIo *)
Optional callback.
Definition: soundio.h:329
@ SoundIoErrorNoSuchClient
When JACK returns JackNoSuchClient
Definition: soundio.h:93
@ SoundIoChannelIdFrontCenterHigh
Definition: soundio.h:133
struct SoundIoDevice * soundio_get_input_device(struct SoundIo *soundio, int index)
Always returns a device.
bool soundio_channel_layout_detect_builtin(struct SoundIoChannelLayout *layout)
Populates the name field of layout if it matches a builtin one.
const char * soundio_format_string(enum SoundIoFormat format)
Returns string representation of format.
@ SoundIoChannelIdFrontLeft
First of the more commonly supported ids.
Definition: soundio.h:109
@ SoundIoChannelIdTopSideRight
Definition: soundio.h:138
@ SoundIoChannelIdNarration
Definition: soundio.h:165
int min
Definition: soundio.h:310
@ SoundIoErrorStreaming
An open stream had an error that can only be recovered from by destroying the stream and creating it ...
Definition: soundio.h:89
@ SoundIoFormatU24LE
Unsigned 24 bit Little Endian using low three bytes in 32-bit word.
Definition: soundio.h:245
double software_latency_min
Software latency minimum in seconds.
Definition: soundio.h:456
@ SoundIoChannelLayoutId6Point0Front
Definition: soundio.h:205
struct SoundIoDevice * device
Populated automatically when you call soundio_outstream_create.
Definition: soundio.h:597
@ SoundIoChannelIdBackRight
Definition: soundio.h:114
bool soundio_device_supports_format(struct SoundIoDevice *device, enum SoundIoFormat format)
Convenience function.
@ SoundIoChannelIdAux1
Definition: soundio.h:171
bool non_terminal_hint
Optional: Hint that this output stream is nonterminal.
Definition: soundio.h:580
@ SoundIoChannelLayoutId2Point1
Definition: soundio.h:192
The size of this struct is OK to use.
Definition: soundio.h:302
bool soundio_device_equal(const struct SoundIoDevice *a, const struct SoundIoDevice *b)
Return true if and only if the devices have the same SoundIoDevice::id, SoundIoDevice::is_raw,...
double software_latency
Ignoring hardware latency, this is the number of seconds it takes for the last sample in a full buffe...
Definition: soundio.h:534
@ SoundIoChannelIdHaptic
Definition: soundio.h:166
@ SoundIoChannelIdFrontRightCenter
Definition: soundio.h:116
int format_count
How many formats are available in SoundIoDevice::formats.
Definition: soundio.h:416
enum SoundIoChannelId soundio_parse_channel_id(const char *str, int str_len)
Given UTF-8 encoded text which is the name of a channel such as "Front Left", "FL",...
const struct SoundIoChannelLayout * soundio_best_matching_channel_layout(const struct SoundIoChannelLayout *preferred_layouts, int preferred_layout_count, const struct SoundIoChannelLayout *available_layouts, int available_layout_count)
Iterates over preferred_layouts.
@ SoundIoChannelIdXyY
Definition: soundio.h:158
@ SoundIoBackendJack
Definition: soundio.h:220
void soundio_ring_buffer_advance_read_ptr(struct SoundIoRingBuffer *ring_buffer, int count)
count in bytes.
int soundio_instream_begin_read(struct SoundIoInStream *instream, struct SoundIoChannelArea **areas, int *frame_count)
Call this function when you are ready to begin reading from the device buffer.
bool non_terminal_hint
Optional: Hint that this input stream is nonterminal.
Definition: soundio.h:664
@ SoundIoFormatU16BE
Unsigned 16 bit Little Endian.
Definition: soundio.h:242
char * name
User-friendly UTF-8 encoded text to describe the device.
Definition: soundio.h:397
void soundio_sort_channel_layouts(struct SoundIoChannelLayout *layouts, int layout_count)
Sorts by channel count, descending.
enum SoundIoFormat current_format
A device is either a raw device or it is a virtual device that is provided by a software mixing servi...
Definition: soundio.h:435
@ SoundIoChannelIdAux2
Definition: soundio.h:172
void(* emit_rtprio_warning)(void)
Optional: Real time priority warning.
Definition: soundio.h:368
int soundio_channel_layout_builtin_count(void)
Returns the number of builtin channel layouts.
@ SoundIoChannelIdTopSideLeft
Definition: soundio.h:137
@ SoundIoChannelIdTopBackRight
Last of the more commonly supported ids.
Definition: soundio.h:126
@ SoundIoChannelIdFrontCenter
Definition: soundio.h:111
@ SoundIoChannelIdAux9
Definition: soundio.h:179
struct SoundIoDevice * soundio_get_output_device(struct SoundIo *soundio, int index)
Always returns a device.
@ SoundIoChannelIdTopFrontLeftCenter
Definition: soundio.h:135
static int soundio_get_bytes_per_second(enum SoundIoFormat format, int channel_count, int sample_rate)
Sample rate is the number of frames per second.
Definition: soundio.h:833
@ SoundIoChannelIdTopFrontLeft
Definition: soundio.h:121
int soundio_ring_buffer_capacity(struct SoundIoRingBuffer *ring_buffer)
When you create a ring buffer, capacity might be more than the requested capacity for alignment purpo...
The size of this struct is OK to use.
Definition: soundio.h:309
int soundio_default_output_device_index(struct SoundIo *soundio)
returns the index of the default output device returns -1 if there are no devices or if you never cal...
@ SoundIoChannelLayoutId7Point1WideBack
Definition: soundio.h:214
const struct SoundIoChannelLayout * soundio_channel_layout_get_builtin(int index)
Returns a builtin channel layout.
int layout_error
If setting the channel layout fails for some reason, this field is set to an error code.
Definition: soundio.h:673
@ SoundIoChannelIdAux14
Definition: soundio.h:184
@ SoundIoFormatS24BE
Signed 24 bit Big Endian using low three bytes in 32-bit word.
Definition: soundio.h:244
@ SoundIoChannelIdTopFrontRightCenter
Definition: soundio.h:136
@ SoundIoChannelLayoutId7Point1Wide
Definition: soundio.h:213
@ SoundIoChannelIdAux0
Definition: soundio.h:170
@ SoundIoChannelIdAux
Definition: soundio.h:169
int soundio_connect_backend(struct SoundIo *soundio, enum SoundIoBackend backend)
Instead of calling soundio_connect you may call this function to try a specific backend.
@ SoundIoFormatInvalid
Definition: soundio.h:236
const char * soundio_get_channel_name(enum SoundIoChannelId id)
@ SoundIoFormatU32LE
Unsigned 32 bit Little Endian.
Definition: soundio.h:249
@ SoundIoChannelLayoutId5Point1
Definition: soundio.h:202
void(* write_callback)(struct SoundIoOutStream *, int frame_count_min, int frame_count_max)
In this callback, you call soundio_outstream_begin_write and soundio_outstream_end_write as many time...
Definition: soundio.h:554
int sample_rate
Sample rate is the number of frames per second.
Definition: soundio.h:605
@ SoundIoChannelIdHeadphonesRight
Definition: soundio.h:161
@ SoundIoChannelLayoutId6Point1Front
Definition: soundio.h:209
@ SoundIoErrorInitAudioBackend
The backend does not appear to be active or running.
Definition: soundio.h:77
int soundio_version_major(void)
See also soundio_version_string, soundio_version_minor, soundio_version_patch.
int soundio_outstream_get_latency(struct SoundIoOutStream *outstream, double *out_latency)
Obtain the total number of seconds that the next frame written after the last frame written with soun...
@ SoundIoErrorOpeningDevice
Attempted to open a device and failed.
Definition: soundio.h:81
@ SoundIoChannelIdAux11
Definition: soundio.h:181
@ SoundIoChannelIdTopFrontCenter
Definition: soundio.h:122
@ SoundIoFormatU32BE
Unsigned 32 bit Big Endian.
Definition: soundio.h:250
struct SoundIoChannelLayout layout
Defaults to Stereo, if available, followed by the first layout supported.
Definition: soundio.h:609
@ SoundIoChannelIdBackLeft
Definition: soundio.h:113
int soundio_default_input_device_index(struct SoundIo *soundio)
returns the index of the default input device returns -1 if there are no devices or if you never call...
@ SoundIoChannelIdAux6
Definition: soundio.h:176
@ SoundIoChannelLayoutId6Point1Back
Definition: soundio.h:208
void soundio_device_unref(struct SoundIoDevice *device)
Remove 1 to the reference count of device.
int soundio_outstream_end_write(struct SoundIoOutStream *outstream)
Commits the write that you began with soundio_outstream_begin_write.
@ SoundIoChannelIdFrontLeftHigh
Definition: soundio.h:132
#define SOUNDIO_MAX_CHANNELS
Definition: soundio.h:300
enum SoundIoBackend current_backend
Read-only.
Definition: soundio.h:354
@ SoundIoChannelIdTopBackCenter
Definition: soundio.h:125
int soundio_outstream_clear_buffer(struct SoundIoOutStream *outstream)
Clears the output stream buffer.
SoundIoFormat
For your convenience, Native Endian and Foreign Endian constants are defined which point to the respe...
Definition: soundio.h:235
int soundio_connect(struct SoundIo *soundio)
Tries soundio_connect_backend on all available backends in order.
int probe_error
This is set to a SoundIoError representing the result of the device probe.
Definition: soundio.h:489
@ SoundIoChannelLayoutId6Point0Side
Definition: soundio.h:204
enum SoundIoFormat * formats
List of formats this device supports.
Definition: soundio.h:414
void soundio_ring_buffer_destroy(struct SoundIoRingBuffer *ring_buffer)
@ SoundIoChannelIdMsSide
Definition: soundio.h:148
@ SoundIoChannelIdAux8
Definition: soundio.h:178
@ SoundIoFormatFloat32BE
Float 32 bit Big Endian, Range -1.0 to 1.0.
Definition: soundio.h:252
@ SoundIoChannelIdFrontLeftCenter
Definition: soundio.h:115
const char * name
Optional: Name of the stream.
Definition: soundio.h:659
void * userdata
Optional. Put whatever you want here. Defaults to NULL.
Definition: soundio.h:326
char * id
A string of bytes that uniquely identifies this device.
Definition: soundio.h:395
@ SoundIoChannelIdFrontLeftWide
Definition: soundio.h:130
void soundio_outstream_destroy(struct SoundIoOutStream *outstream)
You may not call this function from the SoundIoOutStream::write_callback thread context.
@ SoundIoFormatFloat32LE
Float 32 bit Little Endian, Range -1.0 to 1.0.
Definition: soundio.h:251
@ SoundIoChannelLayoutId3Point0
Definition: soundio.h:193
int max
Definition: soundio.h:311
double software_latency
Ignoring hardware latency, this is the number of seconds it takes for a captured sample to become ava...
Definition: soundio.h:623
@ SoundIoChannelIdBackRightCenter
Definition: soundio.h:129
@ SoundIoErrorIncompatibleDevice
Attempted to use a device with parameters it cannot support.
Definition: soundio.h:91
@ SoundIoFormatS24LE
Signed 24 bit Little Endian using low three bytes in 32-bit word.
Definition: soundio.h:243
The size of this struct is not part of the API or ABI.
Definition: soundio.h:324
The size of this struct is not part of the API or ABI.
Definition: soundio.h:595
@ SoundIoChannelIdBackLeftCenter
First of the less commonly supported ids.
Definition: soundio.h:128
void(* jack_info_callback)(const char *msg)
Optional: JACK info callback.
Definition: soundio.h:376
@ SoundIoChannelIdAmbisonicY
Definition: soundio.h:153
void soundio_ring_buffer_clear(struct SoundIoRingBuffer *ring_buffer)
Must be called by the writer.
int soundio_output_device_count(struct SoundIo *soundio)
Get the number of output devices.
@ SoundIoChannelLayoutId5Point1Back
Definition: soundio.h:203
@ SoundIoChannelIdAux13
Definition: soundio.h:183
struct SoundIoChannelLayout layout
Defaults to Stereo, if available, followed by the first layout supported.
Definition: soundio.h:507
@ SoundIoErrorNone
Definition: soundio.h:73
char * ptr
Base address of buffer.
Definition: soundio.h:317
@ SoundIoBackendNone
Definition: soundio.h:219
int soundio_outstream_begin_write(struct SoundIoOutStream *outstream, struct SoundIoChannelArea **areas, int *frame_count)
Call this function when you are ready to begin writing to the device buffer.
void soundio_wakeup(struct SoundIo *soundio)
Makes soundio_wait_events stop blocking.
bool soundio_channel_layout_equal(const struct SoundIoChannelLayout *a, const struct SoundIoChannelLayout *b)
Returns whether the channel count field and each channel id matches in the supplied channel layouts.
int soundio_device_nearest_sample_rate(struct SoundIoDevice *device, int sample_rate)
Convenience function.
struct SoundIoSampleRateRange * sample_rates
Sample rate is the number of frames per second.
Definition: soundio.h:443
char * soundio_ring_buffer_write_ptr(struct SoundIoRingBuffer *ring_buffer)
Do not write more than capacity.
int layout_count
Definition: soundio.h:408
int layout_error
If setting the channel layout fails for some reason, this field is set to an error code.
Definition: soundio.h:591
int bytes_per_frame
computed automatically when you call soundio_outstream_open
Definition: soundio.h:584
@ SoundIoFormatS8
Signed 8 bit.
Definition: soundio.h:237
void(* underflow_callback)(struct SoundIoOutStream *)
This optional callback happens when the sound device runs out of buffered audio data to play.
Definition: soundio.h:560
struct SoundIoChannelLayout * layouts
Channel layouts are handled similarly to SoundIoDevice::formats.
Definition: soundio.h:407
@ SoundIoChannelIdAmbisonicZ
Definition: soundio.h:154
SoundIoChannelId
Specifies where a channel is physically located.
Definition: soundio.h:106
const char * name
Definition: soundio.h:303
@ SoundIoChannelIdSideRight
Definition: soundio.h:119
int soundio_outstream_pause(struct SoundIoOutStream *outstream, bool pause)
If the underlying backend and device support pausing, this pauses the stream.
@ SoundIoChannelLayoutId4Point0
Definition: soundio.h:196
const char * soundio_backend_name(enum SoundIoBackend backend)
Get a string representation of a SoundIoBackend.
int bytes_per_frame
computed automatically when you call soundio_instream_open
Definition: soundio.h:667
bool soundio_device_supports_layout(struct SoundIoDevice *device, const struct SoundIoChannelLayout *layout)
Convenience function.
int channel_count
Definition: soundio.h:304
struct SoundIoInStream * soundio_instream_create(struct SoundIoDevice *device)
Allocates memory and sets defaults.
void soundio_instream_destroy(struct SoundIoInStream *instream)
You may not call this function from SoundIoInStream::read_callback.
@ SoundIoErrorIncompatibleBackend
Attempted to use parameters that the backend cannot support.
Definition: soundio.h:95
@ SoundIoChannelLayoutId7Point0Front
Definition: soundio.h:211
@ SoundIoChannelLayoutId3Point1
Definition: soundio.h:195
@ SoundIoErrorNoSuchDevice
Definition: soundio.h:82
@ SoundIoFormatFloat64LE
Float 64 bit Little Endian, Range -1.0 to 1.0.
Definition: soundio.h:253
@ SoundIoFormatS32LE
Signed 32 bit Little Endian.
Definition: soundio.h:247
int soundio_backend_count(struct SoundIo *soundio)
Returns the number of available backends.
void * userdata
Defaults to NULL. Put whatever you want here.
Definition: soundio.h:537
@ SoundIoBackendAlsa
Definition: soundio.h:222
void soundio_wait_events(struct SoundIo *soundio)
This function calls soundio_flush_events then blocks until another event is ready or you call soundio...
@ SoundIoChannelLayoutId3Point0Back
Definition: soundio.h:194
The size of this struct is not part of the API or ABI.
Definition: soundio.h:383
struct SoundIoChannelLayout current_layout
See SoundIoDevice::current_format.
Definition: soundio.h:410
int soundio_instream_end_read(struct SoundIoInStream *instream)
This will drop all of the frames from when you called soundio_instream_begin_read.
enum SoundIoChannelId channels[SOUNDIO_MAX_CHANNELS]
Definition: soundio.h:305
@ SoundIoChannelLayoutId6Point1
Definition: soundio.h:207
@ SoundIoChannelIdTopBackLeft
Definition: soundio.h:124
void soundio_ring_buffer_advance_write_ptr(struct SoundIoRingBuffer *ring_buffer, int count)
count in bytes.
const char * soundio_strerror(int error)
Get a string representation of a SoundIoError.
enum SoundIoBackend soundio_get_backend(struct SoundIo *soundio, int index)
get the available backend at the specified index (0 <= index < soundio_backend_count)
@ SoundIoFormatU24BE
Unsigned 24 bit Big Endian using low three bytes in 32-bit word.
Definition: soundio.h:246
@ SoundIoErrorInvalid
The programmer did not comply with the API.
Definition: soundio.h:84
int soundio_version_minor(void)
See also soundio_version_major, soundio_version_string, soundio_version_patch.
@ SoundIoChannelIdAmbisonicW
first order ambisonic channels
Definition: soundio.h:151
The size of this struct is not part of the API or ABI.
Definition: soundio.h:493
const struct SoundIoChannelLayout * soundio_channel_layout_get_default(int channel_count)
Get the default builtin channel layout for the given number of channels.
void soundio_destroy(struct SoundIo *soundio)
@ SoundIoDeviceAimOutput
playback
Definition: soundio.h:230
@ SoundIoChannelIdAux15
Definition: soundio.h:185
@ SoundIoChannelIdAux3
Definition: soundio.h:173
@ SoundIoDeviceAimInput
capture / recording
Definition: soundio.h:229
@ SoundIoChannelIdAux7
Definition: soundio.h:177
struct SoundIoRingBuffer * soundio_ring_buffer_create(struct SoundIo *soundio, int requested_capacity)
requested_capacity in bytes.
@ SoundIoChannelIdAux5
Definition: soundio.h:175
@ SoundIoChannelIdAux12
Definition: soundio.h:182
bool is_raw
Raw means that you are directly opening the hardware device and not going through a proxy such as dmi...
Definition: soundio.h:474
@ SoundIoChannelIdInvalid
Definition: soundio.h:107
int soundio_channel_layout_find_channel(const struct SoundIoChannelLayout *layout, enum SoundIoChannelId channel)
Return the index of channel in layout, or -1 if not found.
void soundio_device_ref(struct SoundIoDevice *device)
Add 1 to the reference count of device.
SoundIoChannelLayoutId
Built-in channel layouts for convenience.
Definition: soundio.h:189
int soundio_outstream_start(struct SoundIoOutStream *outstream)
After you call this function, SoundIoOutStream::write_callback will be called.
@ SoundIoChannelIdAmbisonicX
Definition: soundio.h:152
void soundio_device_sort_channel_layouts(struct SoundIoDevice *device)
Sorts channel layouts by channel count, descending.
void * userdata
Defaults to NULL. Put whatever you want here.
Definition: soundio.h:626
@ SoundIoFormatS16LE
Signed 16 bit Little Endian.
Definition: soundio.h:239
@ SoundIoBackendPulseAudio
Definition: soundio.h:221
@ SoundIoBackendDummy
Definition: soundio.h:225
@ SoundIoChannelIdAux4
Definition: soundio.h:174
int soundio_input_device_count(struct SoundIo *soundio)
When you call soundio_flush_events, a snapshot of all device state is saved and these functions merel...
const char * soundio_version_string(void)
See also soundio_version_major, soundio_version_minor, soundio_version_patch.
@ SoundIoChannelLayoutIdQuadSide
Definition: soundio.h:198
static int soundio_get_bytes_per_frame(enum SoundIoFormat format, int channel_count)
A frame is one sample per channel.
Definition: soundio.h:828
@ SoundIoErrorUnderflow
Buffer underrun occurred.
Definition: soundio.h:100
@ SoundIoChannelIdFrontRightWide
Definition: soundio.h:131
const char * name
Optional: Name of the stream.
Definition: soundio.h:575
void(* error_callback)(struct SoundIoOutStream *, int err)
Optional callback.
Definition: soundio.h:567
int step
How many bytes it takes to get from the beginning of one sample to the beginning of the next sample.
Definition: soundio.h:320
int ref_count
Devices are reference counted.
Definition: soundio.h:478
@ SoundIoChannelIdLfe2
Definition: soundio.h:141
@ SoundIoErrorNoMem
Out of memory.
Definition: soundio.h:75
The size of this struct is OK to use.
Definition: soundio.h:315
@ SoundIoChannelLayoutIdQuad
Definition: soundio.h:197
@ SoundIoFormatFloat64BE
Float 64 bit Big Endian, Range -1.0 to 1.0.
Definition: soundio.h:254
bool soundio_have_backend(enum SoundIoBackend backend)
Returns whether libsoundio was compiled with backend.
@ SoundIoChannelLayoutId7Point1
Definition: soundio.h:212
@ SoundIoChannelLayoutId7Point0
Definition: soundio.h:210
enum SoundIoFormat format
Defaults to #SoundIoFormatFloat32NE, followed by the first one supported.
Definition: soundio.h:499
int sample_rate
Sample rate is the number of frames per second.
Definition: soundio.h:503
@ SoundIoChannelIdTopFrontRight
Definition: soundio.h:123
@ SoundIoErrorEncodingString
Unable to convert to or from UTF-8 to the native string format.
Definition: soundio.h:102
@ SoundIoChannelIdTopCenter
Definition: soundio.h:120
int sample_rate_current
See SoundIoDevice::current_format 0 if sample rate information is missing due to a probe error.
Definition: soundio.h:450
int bytes_per_sample
computed automatically when you call soundio_outstream_open
Definition: soundio.h:586
SoundIoDeviceAim
Definition: soundio.h:228
SoundIoError
See also soundio_strerror.
Definition: soundio.h:72
@ SoundIoChannelLayoutIdStereo
Definition: soundio.h:191
SoundIoBackend
Definition: soundio.h:218
double software_latency_current
Software latency in seconds.
Definition: soundio.h:467
int bytes_per_sample
computed automatically when you call soundio_instream_open
Definition: soundio.h:669
@ SoundIoBackendCoreAudio
Definition: soundio.h:223
@ SoundIoChannelLayoutId5Point0Side
Definition: soundio.h:201
bool soundio_device_supports_sample_rate(struct SoundIoDevice *device, int sample_rate)
Convenience function.
int soundio_ring_buffer_fill_count(struct SoundIoRingBuffer *ring_buffer)
Returns how many bytes of the buffer is used, ready for reading.
@ SoundIoChannelIdXyX
X-Y Recording.
Definition: soundio.h:157
@ SoundIoChannelIdSideLeft
Definition: soundio.h:118
@ SoundIoBackendWasapi
Definition: soundio.h:224
@ SoundIoChannelIdDialogCentricMix
Last of the "other" channel ids.
Definition: soundio.h:167
struct SoundIoDevice * device
Populated automatically when you call soundio_outstream_create.
Definition: soundio.h:495
@ SoundIoChannelIdLeftLfe
Definition: soundio.h:139
int sample_rate_count
How many sample rate ranges are available in SoundIoDevice::sample_rates.
Definition: soundio.h:447
enum SoundIoFormat format
Defaults to #SoundIoFormatFloat32NE, followed by the first one supported.
Definition: soundio.h:601
struct SoundIoOutStream * soundio_outstream_create(struct SoundIoDevice *device)
Allocates memory and sets defaults.
void(* on_events_signal)(struct SoundIo *)
Optional callback.
Definition: soundio.h:350
@ SoundIoChannelIdHearingImpaired
Definition: soundio.h:164
@ SoundIoChannelIdAux10
Definition: soundio.h:180
@ SoundIoChannelIdBackCenter
Definition: soundio.h:117
int soundio_instream_start(struct SoundIoInStream *instream)
After you call this function, SoundIoInStream::read_callback will be called.
void soundio_force_device_scan(struct SoundIo *soundio)
If necessary you can manually trigger a device rescan.
@ SoundIoChannelIdClickTrack
Definition: soundio.h:162
@ SoundIoErrorInterrupted
Definition: soundio.h:98
int soundio_get_bytes_per_sample(enum SoundIoFormat format)
Returns -1 on invalid format.
void(* on_backend_disconnect)(struct SoundIo *, int err)
Optional callback.
Definition: soundio.h:346
int soundio_instream_open(struct SoundIoInStream *instream)
After you call this function, SoundIoInStream::software_latency is set to the correct value.
@ SoundIoFormatU16LE
Unsigned 16 bit Little Endian.
Definition: soundio.h:241
@ SoundIoChannelLayoutId4Point1
Definition: soundio.h:199
@ SoundIoChannelIdRightLfe
Definition: soundio.h:140
int soundio_outstream_open(struct SoundIoOutStream *outstream)
After you call this function, SoundIoOutStream::software_latency is set to the correct value.
double software_latency_max
Software latency maximum in seconds.
Definition: soundio.h:461
@ SoundIoFormatU8
Unsigned 8 bit.
Definition: soundio.h:238
void soundio_disconnect(struct SoundIo *soundio)
void(* overflow_callback)(struct SoundIoInStream *)
This optional callback happens when the sound device buffer is full, yet there is more captured audio...
Definition: soundio.h:644
@ SoundIoChannelLayoutIdOctagonal
Definition: soundio.h:215
enum SoundIoDeviceAim aim
Tells whether this device is an input device or an output device.
Definition: soundio.h:400
@ SoundIoChannelIdBottomLeftCenter
Definition: soundio.h:143
struct SoundIo * soundio_create(void)
Create a SoundIo context.
@ SoundIoFormatS16BE
Signed 16 bit Big Endian.
Definition: soundio.h:240
void(* error_callback)(struct SoundIoInStream *, int err)
Optional callback.
Definition: soundio.h:651
int soundio_version_patch(void)
See also soundio_version_major, soundio_version_minor, soundio_version_string.
@ SoundIoChannelIdFrontRightHigh
Definition: soundio.h:134
@ SoundIoChannelIdBottomRightCenter
Definition: soundio.h:144
@ SoundIoFormatS32BE
Signed 32 bit Big Endian.
Definition: soundio.h:248