audio_frontend.h

Go to the documentation of this file.

#pragma once
 
#include <defines.h>
#include <math/math_types.h>
#include <strings/kname.h>
 
#include "audio/kaudio_types.h"
#include "core_audio_types.h"
 
#define AUDIO_CHANNEL_MAX_COUNT 16
 
struct kaudio_system_state;
struct frame_data;
 
typedef u16 kaudio_emitter;
#define KAUDIO_EMITTER_INVALID INVALID_ID_U16
 
b8 kaudio_system_initialize(u64* memory_requirement, void* memory, const char* config_str);
void kaudio_system_shutdown(struct kaudio_system_state* state);
 
b8 kaudio_system_update(struct kaudio_system_state* state, struct frame_data* p_frame_data);
 
// To be invoked by the audio plugin when a non-looping audio has completed play.
// Should not be called anywhere except by the plugin.
KAPI void _kaudio_system_play_completed(struct kaudio_system_state* state, kaudio audio, u16 instance_id);
 
KAPI void kaudio_system_listener_orientation_set(struct kaudio_system_state* state, vec3 position, vec3 forward, vec3 up);
 
KAPI void kaudio_master_volume_set(struct kaudio_system_state* state, f32 volume);
KAPI f32 kaudio_system_master_volume_get(struct kaudio_system_state* state);
 
// Preloads audio only, does not create instance.
KAPI kaudio kaudio_preload(struct kaudio_system_state* state, kname asset_name, b8 is_streaming);
KAPI kaudio kaudio_preload_from_package(struct kaudio_system_state* state, kname asset_name, kname package_name, b8 is_streaming);
KAPI kaudio_instance kaudio_acquire_from_base(struct kaudio_system_state* state, kaudio base, kaudio_space audio_space);
KAPI kaudio_instance kaudio_acquire(struct kaudio_system_state* state, kname asset_name, b8 is_streaming, kaudio_space audio_space);
KAPI kaudio_instance kaudio_acquire_from_package(struct kaudio_system_state* state, kname asset_name, kname package_name, b8 is_streaming, kaudio_space audio_space);
KAPI void kaudio_release(struct kaudio_system_state* state, kaudio_instance* instance);
 
KAPI vec3 kaudio_position_get(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_position_set(struct kaudio_system_state* state, kaudio_instance instance, vec3 position);
KAPI f32 kaudio_inner_radius_get(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_inner_radius_set(struct kaudio_system_state* state, kaudio_instance instance, f32 inner_radius);
KAPI f32 kaudio_outer_radius_get(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_outer_radius_set(struct kaudio_system_state* state, kaudio_instance instance, f32 outer_radius);
KAPI f32 kaudio_falloff_get(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_falloff_set(struct kaudio_system_state* state, kaudio_instance instance, f32 falloff);
 
KAPI i8 kaudio_category_id_get(struct kaudio_system_state* state, kname name);
KAPI b8 kaudio_play_in_category_by_name(struct kaudio_system_state* state, kaudio_instance instance, kname category_name);
KAPI b8 kaudio_play_in_category(struct kaudio_system_state* state, kaudio_instance instance, u8 category_index);
KAPI b8 kaudio_play(struct kaudio_system_state* state, kaudio_instance instance, i8 channel_index);
KAPI b8 kaudio_stop(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_pause(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_resume(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_is_valid(struct kaudio_system_state* state, kaudio_instance instance);
KAPI f32 kaudio_pitch_get(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_pitch_set(struct kaudio_system_state* state, kaudio_instance instance, f32 pitch);
KAPI f32 kaudio_volume_get(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_volume_set(struct kaudio_system_state* state, kaudio_instance instance, f32 volume);
KAPI b8 kaudio_looping_get(struct kaudio_system_state* state, kaudio_instance instance);
KAPI b8 kaudio_looping_set(struct kaudio_system_state* state, kaudio_instance instance, b8 looping);
 
// KAPI b8 kaudio_seek(struct kaudio_system_state* state, audio_instance instance, f32 seconds);
// KAPI f32 kaudio_time_played_get(struct kaudio_system_state* state, audio_instance instance);
// KAPI f32 kaudio_time_length_get(struct kaudio_system_state* state, audio_instance instance);
 
KAPI b8 kaudio_channel_play(struct kaudio_system_state* state, u8 channel_index);
KAPI b8 kaudio_channel_pause(struct kaudio_system_state* state, u8 channel_index);
KAPI b8 kaudio_channel_resume(struct kaudio_system_state* state, u8 channel_index);
KAPI b8 kaudio_channel_stop(struct kaudio_system_state* state, u8 channel_index);
KAPI b8 kaudio_channel_is_playing(struct kaudio_system_state* state, u8 channel_index);
KAPI b8 kaudio_channel_is_paused(struct kaudio_system_state* state, u8 channel_index);
KAPI b8 kaudio_channel_is_stopped(struct kaudio_system_state* state, u8 channel_index);
KAPI b8 kaudio_channel_looping_get(struct kaudio_system_state* state, u8 channel_index);
KAPI b8 kaudio_channel_looping_set(struct kaudio_system_state* state, u8 channel_index, b8 looping);
 
KAPI f32 kaudio_channel_volume_get(struct kaudio_system_state* state, u8 channel_index);
 
KAPI b8 kaudio_channel_volume_set(struct kaudio_system_state* state, u8 channel_index, f32 volume);
 
KAPI b8 kaudio_emitter_create(struct kaudio_system_state* state, f32 inner_radius, f32 outer_radius, f32 volume, f32 falloff, b8 is_looping, b8 is_streaming, kname audio_resource_name, kname package_name, kaudio_emitter* out_emitter);
 
KAPI b8 kaudio_emitter_destroy(struct kaudio_system_state* state, kaudio_emitter* emitter);
 
KAPI b8 kaudio_emitter_world_position_set(struct kaudio_system_state* state, kaudio_emitter emitter_handle, vec3 world_position);