summaryrefslogtreecommitdiffhomepage
path: root/src/raudio.h
diff options
context:
space:
mode:
authorRay <[email protected]>2019-07-24 22:37:24 +0200
committerRay <[email protected]>2019-07-24 22:37:24 +0200
commitae95111006251c1cfc5fb0e646f2ffcfa746bfbc (patch)
tree5b5f34c728819de044190eff4d1285ea93a44310 /src/raudio.h
parent8730f22371c8b25e28adda498d5a31d5ace53d80 (diff)
downloadraylib-ae95111006251c1cfc5fb0e646f2ffcfa746bfbc.tar.gz
raylib-ae95111006251c1cfc5fb0e646f2ffcfa746bfbc.zip
Some variables renamed
Diffstat (limited to 'src/raudio.h')
-rw-r--r--src/raudio.h164
1 files changed, 87 insertions, 77 deletions
diff --git a/src/raudio.h b/src/raudio.h
index e032d09b..7a3b7515 100644
--- a/src/raudio.h
+++ b/src/raudio.h
@@ -80,40 +80,44 @@
// Wave type, defines audio wave data
typedef struct Wave {
- unsigned int sampleCount; // Number of samples
- unsigned int sampleRate; // Frequency (samples per second)
- unsigned int sampleSize; // Bit depth (bits per sample): 8, 16, 32 (24 not supported)
- unsigned int channels; // Number of channels (1-mono, 2-stereo)
- void *data; // Buffer data pointer
+ unsigned int sampleCount; // Total number of samples
+ unsigned int sampleRate; // Frequency (samples per second)
+ unsigned int sampleSize; // Bit depth (bits per sample): 8, 16, 32 (24 not supported)
+ unsigned int channels; // Number of channels (1-mono, 2-stereo)
+ void *data; // Buffer data pointer
} Wave;
-// Sound source type
-typedef struct Sound {
- void *audioBuffer; // Pointer to internal data used by the audio system
-
- unsigned int source; // Audio source id
- unsigned int buffer; // Audio buffer id
- int format; // Audio format specifier
-} Sound;
-
-// Music type (file streaming from memory)
-// NOTE: Anything longer than ~10 seconds should be streamed
-typedef struct MusicData *Music;
+typedef struct rAudioBuffer rAudioBuffer;
// Audio stream type
// NOTE: Useful to create custom audio streams not bound to a specific file
typedef struct AudioStream {
- unsigned int sampleRate; // Frequency (samples per second)
- unsigned int sampleSize; // Bit depth (bits per sample): 8, 16, 32 (24 not supported)
- unsigned int channels; // Number of channels (1-mono, 2-stereo)
+ unsigned int sampleRate; // Frequency (samples per second)
+ unsigned int sampleSize; // Bit depth (bits per sample): 8, 16, 32 (24 not supported)
+ unsigned int channels; // Number of channels (1-mono, 2-stereo)
- void *audioBuffer; // Pointer to internal data used by the audio system.
-
- int format; // Audio format specifier
- unsigned int source; // Audio source id
- unsigned int buffers[2]; // Audio buffers (double buffering)
+ rAudioBuffer *buffer; // Pointer to internal data used by the audio system
} AudioStream;
+// Sound source type
+typedef struct Sound {
+ unsigned int sampleCount; // Total number of samples
+ AudioStream stream; // Audio stream
+} Sound;
+
+// Music stream type (audio file streaming from memory)
+// NOTE: Anything longer than ~10 seconds should be streamed
+typedef struct MusicStream {
+ int ctxType; // Type of music context (audio filetype)
+ void *ctxData; // Audio context data, depends on type
+
+ unsigned int sampleCount; // Total number of samples
+ unsigned int sampleLeft; // Number of samples left to end
+ unsigned int loopCount; // Loops count (times music will play), 0 means infinite loop
+
+ AudioStream stream; // Audio stream
+} MusicStream, *Music;
+
#ifdef __cplusplus
extern "C" { // Prevents name mangling of functions
#endif
@@ -126,60 +130,66 @@ extern "C" { // Prevents name mangling of functions
//----------------------------------------------------------------------------------
// Module Functions Declaration
//----------------------------------------------------------------------------------
-void InitAudioDevice(void); // Initialize audio device and context
-void CloseAudioDevice(void); // Close the audio device and context
-bool IsAudioDeviceReady(void); // Check if audio device has been initialized successfully
-void SetMasterVolume(float volume); // Set master volume (listener)
-
-Wave LoadWave(const char *fileName); // Load wave data from file
-Wave LoadWaveEx(void *data, int sampleCount, int sampleRate, int sampleSize, int channels); // Load wave data from raw array data
-Sound LoadSound(const char *fileName); // Load sound from file
-Sound LoadSoundFromWave(Wave wave); // Load sound from wave data
-void UpdateSound(Sound sound, const void *data, int samplesCount);// Update sound buffer with new data
-void UnloadWave(Wave wave); // Unload wave data
-void UnloadSound(Sound sound); // Unload sound
-void PlaySound(Sound sound); // Play a sound
-void PlaySoundMulti(Sound sound); // Play a sound using the multi channel buffer pool
-int GetSoundsPlaying(void); // Get number of sounds playing in the multichannel buffer pool
-void PauseSound(Sound sound); // Pause a sound
-void ResumeSound(Sound sound); // Resume a paused sound
-void StopSound(Sound sound); // Stop playing a sound
-void StopSoundMulti(void); // Stop any sound played with PlaySoundMulti()
-bool IsSoundPlaying(Sound sound); // Check if a sound is currently playing
-void SetSoundVolume(Sound sound, float volume); // Set volume for a sound (1.0 is max level)
-void SetSoundPitch(Sound sound, float pitch); // Set pitch for a sound (1.0 is base level)
-void WaveFormat(Wave *wave, int sampleRate, int sampleSize, int channels); // Convert wave data to desired format
-Wave WaveCopy(Wave wave); // Copy a wave to a new wave
-void WaveCrop(Wave *wave, int initSample, int finalSample); // Crop a wave to defined samples range
-float *GetWaveData(Wave wave); // Get samples data from wave as a floats array
-Music LoadMusicStream(const char *fileName); // Load music stream from file
-void UnloadMusicStream(Music music); // Unload music stream
-void PlayMusicStream(Music music); // Start music playing
-void UpdateMusicStream(Music music); // Updates buffers for music streaming
-void StopMusicStream(Music music); // Stop music playing
-void PauseMusicStream(Music music); // Pause music playing
-void ResumeMusicStream(Music music); // Resume playing paused music
-bool IsMusicPlaying(Music music); // Check if music is playing
-void SetMusicVolume(Music music, float volume); // Set volume for music (1.0 is max level)
-void SetMusicPitch(Music music, float pitch); // Set pitch for a music (1.0 is base level)
-void SetMusicLoopCount(Music music, int count); // Set music loop count (loop repeats)
-float GetMusicTimeLength(Music music); // Get music time length (in seconds)
-float GetMusicTimePlayed(Music music); // Get current music time played (in seconds)
+
+// Audio device management functions
+RLAPI void InitAudioDevice(void); // Initialize audio device and context
+RLAPI void CloseAudioDevice(void); // Close the audio device and context
+RLAPI bool IsAudioDeviceReady(void); // Check if audio device has been initialized successfully
+RLAPI void SetMasterVolume(float volume); // Set master volume (listener)
+
+// Wave/Sound loading/unloading functions
+RLAPI Wave LoadWave(const char *fileName); // Load wave data from file
+RLAPI Sound LoadSound(const char *fileName); // Load sound from file
+RLAPI Sound LoadSoundFromWave(Wave wave); // Load sound from wave data
+RLAPI void UpdateSound(Sound sound, const void *data, int samplesCount);// Update sound buffer with new data
+RLAPI void UnloadWave(Wave wave); // Unload wave data
+RLAPI void UnloadSound(Sound sound); // Unload sound
+RLAPI void ExportWave(Wave wave, const char *fileName); // Export wave data to file
+RLAPI void ExportWaveAsCode(Wave wave, const char *fileName); // Export wave sample data to code (.h)
+
+// Wave/Sound management functions
+RLAPI void PlaySound(Sound sound); // Play a sound
+RLAPI void StopSound(Sound sound); // Stop playing a sound
+RLAPI void PauseSound(Sound sound); // Pause a sound
+RLAPI void ResumeSound(Sound sound); // Resume a paused sound
+RLAPI void PlaySoundMulti(Sound sound); // Play a sound (using multichannel buffer pool)
+RLAPI void StopSoundMulti(void); // Stop any sound playing (using multichannel buffer pool)
+RLAPI int GetSoundsPlaying(void); // Get number of sounds playing in the multichannel
+RLAPI bool IsSoundPlaying(Sound sound); // Check if a sound is currently playing
+RLAPI void SetSoundVolume(Sound sound, float volume); // Set volume for a sound (1.0 is max level)
+RLAPI void SetSoundPitch(Sound sound, float pitch); // Set pitch for a sound (1.0 is base level)
+RLAPI void WaveFormat(Wave *wave, int sampleRate, int sampleSize, int channels); // Convert wave data to desired format
+RLAPI Wave WaveCopy(Wave wave); // Copy a wave to a new wave
+RLAPI void WaveCrop(Wave *wave, int initSample, int finalSample); // Crop a wave to defined samples range
+RLAPI float *GetWaveData(Wave wave); // Get samples data from wave as a floats array
+
+// Music management functions
+RLAPI Music LoadMusicStream(const char *fileName); // Load music stream from file
+RLAPI void UnloadMusicStream(Music music); // Unload music stream
+RLAPI void PlayMusicStream(Music music); // Start music playing
+RLAPI void UpdateMusicStream(Music music); // Updates buffers for music streaming
+RLAPI void StopMusicStream(Music music); // Stop music playing
+RLAPI void PauseMusicStream(Music music); // Pause music playing
+RLAPI void ResumeMusicStream(Music music); // Resume playing paused music
+RLAPI bool IsMusicPlaying(Music music); // Check if music is playing
+RLAPI void SetMusicVolume(Music music, float volume); // Set volume for music (1.0 is max level)
+RLAPI void SetMusicPitch(Music music, float pitch); // Set pitch for a music (1.0 is base level)
+RLAPI void SetMusicLoopCount(Music music, int count); // Set music loop count (loop repeats)
+RLAPI float GetMusicTimeLength(Music music); // Get music time length (in seconds)
+RLAPI float GetMusicTimePlayed(Music music); // Get current music time played (in seconds)
// AudioStream management functions
-AudioStream InitAudioStream(unsigned int sampleRate,
- unsigned int sampleSize,
- unsigned int channels); // Init audio stream (to stream raw audio pcm data)
-void UpdateAudioStream(AudioStream stream, const void *data, int samplesCount); // Update audio stream buffers with data
-void CloseAudioStream(AudioStream stream); // Close audio stream and free memory
-bool IsAudioBufferProcessed(AudioStream stream); // Check if any audio stream buffers requires refill
-void PlayAudioStream(AudioStream stream); // Play audio stream
-void PauseAudioStream(AudioStream stream); // Pause audio stream
-void ResumeAudioStream(AudioStream stream); // Resume audio stream
-bool IsAudioStreamPlaying(AudioStream stream); // Check if audio stream is playing
-void StopAudioStream(AudioStream stream); // Stop audio stream
-void SetAudioStreamVolume(AudioStream stream, float volume); // Set volume for audio stream (1.0 is max level)
-void SetAudioStreamPitch(AudioStream stream, float pitch); // Set pitch for audio stream (1.0 is base level)
+RLAPI AudioStream InitAudioStream(unsigned int sampleRate, unsigned int sampleSize, unsigned int channels); // Init audio stream (to stream raw audio pcm data)
+RLAPI void UpdateAudioStream(AudioStream stream, const void *data, int samplesCount); // Update audio stream buffers with data
+RLAPI void CloseAudioStream(AudioStream stream); // Close audio stream and free memory
+RLAPI bool IsAudioBufferProcessed(AudioStream stream); // Check if any audio stream buffers requires refill
+RLAPI void PlayAudioStream(AudioStream stream); // Play audio stream
+RLAPI void PauseAudioStream(AudioStream stream); // Pause audio stream
+RLAPI void ResumeAudioStream(AudioStream stream); // Resume audio stream
+RLAPI bool IsAudioStreamPlaying(AudioStream stream); // Check if audio stream is playing
+RLAPI void StopAudioStream(AudioStream stream); // Stop audio stream
+RLAPI void SetAudioStreamVolume(AudioStream stream, float volume); // Set volume for audio stream (1.0 is max level)
+RLAPI void SetAudioStreamPitch(AudioStream stream, float pitch); // Set pitch for audio stream (1.0 is base level)
#ifdef __cplusplus
}