Banjo API 1.1.0-alpha
Low-level C99 game development API
Loading...
Searching...
No Matches
audio.h
Go to the documentation of this file.
1
106#ifndef BJ_AUDIO_H
107#define BJ_AUDIO_H
108
109#include <banjo/error.h>
110#include <banjo/api.h>
111#include <stdint.h>
112
122struct bj_audio_device;
123
141#ifndef BJ_NO_TYPEDEF
143#endif
144
151#define BJ_AUDIO_FORMAT_WIDTH(x) ((x) & (0xFFu))
152
159#define BJ_AUDIO_FORMAT_FLOAT(x) ((x) & (1u<<8))
160
167#define BJ_AUDIO_FORMAT_INT(x) (!((x) & (1u<<8)))
168
175#define BJ_AUDIO_FORMAT_BIG_ENDIAN(x) ((x) & (1u<<12))
176
183#define BJ_AUDIO_FORMAT_SIGNED(x) ((x) & (1u<<15))
184
195 int16_t amplitude;
196 unsigned int channels;
197 unsigned int sample_rate;
198};
199
221typedef void (*bj_audio_callback_fn)(
222 void* buffer,
223 unsigned frames,
224 const struct bj_audio_properties* audio,
225 void* user_data,
226 uint64_t base_sample_index
227);
228
254 const struct bj_audio_properties* properties,
255 bj_audio_callback_fn callback,
256 void* callback_user_data,
257 struct bj_error** error
258);
259
262 const struct bj_audio_properties* properties,
263 bj_audio_callback_fn callback,
264 void* callback_user_data,
265 struct bj_error** error
266);
267
283 struct bj_audio_device* device
284);
285
288 struct bj_audio_device* device
289);
290
303 struct bj_audio_device* device
304);
305
318 struct bj_audio_device* device
319);
320
332 struct bj_audio_device* device
333);
334
346 struct bj_audio_device* device
347);
348
360 const struct bj_audio_device* device
361);
362
365 const struct bj_audio_device* device
366);
367
380#ifndef BJ_NO_TYPEDEF
382#endif
383
385#define BJ_AUDIO_PLAY_SINE BJ_AUDIO_WAVEFORM_SINE
387#define BJ_AUDIO_PLAY_SQUARE BJ_AUDIO_WAVEFORM_SQUARE
389#define BJ_AUDIO_PLAY_TRIANGLE BJ_AUDIO_WAVEFORM_TRIANGLE
391#define BJ_AUDIO_PLAY_SAWTOOTH BJ_AUDIO_WAVEFORM_SAWTOOTH
392
408
444 void* buffer,
445 unsigned frames,
446 const struct bj_audio_properties* audio,
447 void* user_data,
448 uint64_t base_sample_index
449);
450
451#endif /* BJ_AUDIO_H */
General-purpose definitions for Banjo API.
Recoverable error handling.
int16_t amplitude
Maximum amplitude of the output samples.
Definition audio.h:195
double frequency
Frequency of the waveform (Hz).
Definition audio.h:402
enum bj_audio_waveform function
Type of waveform to generate.
Definition audio.h:401
double phase
Phase of the next sample, in radians, which bj_play_audio_note advances and wraps to [0,...
Definition audio.h:404
enum bj_audio_format format
Sampling format.
Definition audio.h:194
unsigned int sample_rate
Number of samples per second (Hz).
Definition audio.h:197
unsigned int channels
Number of interleaved channels (1 = mono, 2 = stereo, ...). The opened device may negotiate a differe...
Definition audio.h:196
void bj_play_audio_note(void *buffer, unsigned frames, const struct bj_audio_properties *audio, void *user_data, uint64_t base_sample_index)
Generate a basic waveform tone using a built-in callback.
bj_audio_waveform
Waveform types for audio note generation.
Definition audio.h:374
void bj_destroy_audio_device(struct bj_audio_device *device)
Close an audio device and release all associated resources.
bj_bool bj_audio_playing(const struct bj_audio_device *device)
bj_audio_format
Audio sample format descriptor.
Definition audio.h:136
bj_bool bj_audio_device_is_playing(const struct bj_audio_device *device)
Query whether the device is currently playing audio.
void bj_reset_audio_device(struct bj_audio_device *device)
Reset the playback stream sample index to 0.
void bj_pause_audio_device(struct bj_audio_device *device)
Pause audio playback.
void bj_close_audio_device(struct bj_audio_device *device)
void bj_stop_audio_device(struct bj_audio_device *device)
Stop playback and reset the sample stream.
struct bj_audio_device * bj_create_audio_device(const struct bj_audio_properties *properties, bj_audio_callback_fn callback, void *callback_user_data, struct bj_error **error)
Open the default audio device for playback.
void(* bj_audio_callback_fn)(void *buffer, unsigned frames, const struct bj_audio_properties *audio, void *user_data, uint64_t base_sample_index)
Define a callback for generating audio samples.
Definition audio.h:221
struct bj_audio_device * bj_open_audio_device(const struct bj_audio_properties *properties, bj_audio_callback_fn callback, void *callback_user_data, struct bj_error **error)
void bj_play_audio_device(struct bj_audio_device *device)
Resume audio playback.
@ BJ_AUDIO_WAVEFORM_SINE
Generate a sine wave.
Definition audio.h:375
@ BJ_AUDIO_WAVEFORM_SAWTOOTH
Generate a sawtooth wave.
Definition audio.h:378
@ BJ_AUDIO_WAVEFORM_TRIANGLE
Generate a triangle wave.
Definition audio.h:377
@ BJ_AUDIO_WAVEFORM_SQUARE
Generate a square wave.
Definition audio.h:376
@ BJ_AUDIO_FORMAT_F32
32-bit IEEE-754 float PCM.
Definition audio.h:139
@ BJ_AUDIO_FORMAT_UNKNOWN
Unknown/unspecified format.
Definition audio.h:137
@ BJ_AUDIO_FORMAT_INT16
16-bit signed integer PCM.
Definition audio.h:138
Define parameters for generating simple waveforms.
Definition audio.h:400
Describe properties of an audio device.
Definition audio.h:193
struct bj_error bj_error
Definition api.h:348
#define BANJO_EXPORT
Definition api.h:179
uint32_t bj_bool
Boolean type used throughout the Banjo API.
Definition api.h:264
struct bj_audio_device bj_audio_device
Definition api.h:337