diff options
Diffstat (limited to 'h1z1/libghack/CSFML-2.1-windows-64bits/CSFML-2.1/include/SFML/Audio/SoundBuffer.h')
| -rwxr-xr-x | h1z1/libghack/CSFML-2.1-windows-64bits/CSFML-2.1/include/SFML/Audio/SoundBuffer.h | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/h1z1/libghack/CSFML-2.1-windows-64bits/CSFML-2.1/include/SFML/Audio/SoundBuffer.h b/h1z1/libghack/CSFML-2.1-windows-64bits/CSFML-2.1/include/SFML/Audio/SoundBuffer.h new file mode 100755 index 0000000..4ec13e5 --- /dev/null +++ b/h1z1/libghack/CSFML-2.1-windows-64bits/CSFML-2.1/include/SFML/Audio/SoundBuffer.h @@ -0,0 +1,195 @@ +//////////////////////////////////////////////////////////// +// +// SFML - Simple and Fast Multimedia Library +// Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com) +// +// This software is provided 'as-is', without any express or implied warranty. +// In no event will the authors be held liable for any damages arising from the use of this software. +// +// Permission is granted to anyone to use this software for any purpose, +// including commercial applications, and to alter it and redistribute it freely, +// subject to the following restrictions: +// +// 1. The origin of this software must not be misrepresented; +// you must not claim that you wrote the original software. +// If you use this software in a product, an acknowledgment +// in the product documentation would be appreciated but is not required. +// +// 2. Altered source versions must be plainly marked as such, +// and must not be misrepresented as being the original software. +// +// 3. This notice may not be removed or altered from any source distribution. +// +//////////////////////////////////////////////////////////// + +#ifndef SFML_SOUNDBUFFER_H +#define SFML_SOUNDBUFFER_H + +//////////////////////////////////////////////////////////// +// Headers +//////////////////////////////////////////////////////////// +#include <SFML/Audio/Export.h> +#include <SFML/Audio/Types.h> +#include <SFML/System/InputStream.h> +#include <SFML/System/Time.h> +#include <stddef.h> + + +//////////////////////////////////////////////////////////// +/// \brief Create a new sound buffer and load it from a file +/// +/// Here is a complete list of all the supported audio formats: +/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, +/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. +/// +/// \param filename Path of the sound file to load +/// +/// \return A new sfSoundBuffer object (NULL if failed) +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API sfSoundBuffer* sfSoundBuffer_createFromFile(const char* filename); + +//////////////////////////////////////////////////////////// +/// \brief Create a new sound buffer and load it from a file in memory +/// +/// Here is a complete list of all the supported audio formats: +/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, +/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. +/// +/// \param data Pointer to the file data in memory +/// \param sizeInBytes Size of the data to load, in bytes +/// +/// \return A new sfSoundBuffer object (NULL if failed) +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API sfSoundBuffer* sfSoundBuffer_createFromMemory(const void* data, size_t sizeInBytes); + +//////////////////////////////////////////////////////////// +/// \brief Create a new sound buffer and load it from a custom stream +/// +/// Here is a complete list of all the supported audio formats: +/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, +/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. +/// +/// \param stream Source stream to read from +/// +/// \return A new sfSoundBuffer object (NULL if failed) +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API sfSoundBuffer* sfSoundBuffer_createFromStream(sfInputStream* stream); + +//////////////////////////////////////////////////////////// +/// \brief Create a new sound buffer and load it from an array of samples in memory +/// +/// The assumed format of the audio samples is 16 bits signed integer +/// (sfInt16). +/// +/// \param samples Pointer to the array of samples in memory +/// \param sampleCount Number of samples in the array +/// \param channelCount Number of channels (1 = mono, 2 = stereo, ...) +/// \param sampleRate Sample rate (number of samples to play per second) +/// +/// \return A new sfSoundBuffer object (NULL if failed) +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API sfSoundBuffer* sfSoundBuffer_createFromSamples(const sfInt16* samples, size_t sampleCount, unsigned int channelCount, unsigned int sampleRate); + +//////////////////////////////////////////////////////////// +/// \brief Create a new sound buffer by copying an existing one +/// +/// \param soundBuffer Sound buffer to copy +/// +/// \return A new sfSoundBuffer object which is a copy of \a soundBuffer +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API sfSoundBuffer* sfSoundBuffer_copy(const sfSoundBuffer* soundBuffer); + +//////////////////////////////////////////////////////////// +/// \brief Destroy a sound buffer +/// +/// \param soundBuffer Sound buffer to destroy +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API void sfSoundBuffer_destroy(sfSoundBuffer* soundBuffer); + +//////////////////////////////////////////////////////////// +/// \brief Save a sound buffer to an audio file +/// +/// Here is a complete list of all the supported audio formats: +/// ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, +/// w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64. +/// +/// \param soundBuffer Sound buffer object +/// \param filename Path of the sound file to write +/// +/// \return sfTrue if saving succeeded, sfFalse if it failed +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API sfBool sfSoundBuffer_saveToFile(const sfSoundBuffer* soundBuffer, const char* filename); + +//////////////////////////////////////////////////////////// +/// \brief Get the array of audio samples stored in a sound buffer +/// +/// The format of the returned samples is 16 bits signed integer +/// (sfInt16). The total number of samples in this array +/// is given by the sfSoundBuffer_getSampleCount function. +/// +/// \param soundBuffer Sound buffer object +/// +/// \return Read-only pointer to the array of sound samples +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API const sfInt16* sfSoundBuffer_getSamples(const sfSoundBuffer* soundBuffer); + +//////////////////////////////////////////////////////////// +/// \brief Get the number of samples stored in a sound buffer +/// +/// The array of samples can be accessed with the +/// sfSoundBuffer_getSamples function. +/// +/// \param soundBuffer Sound buffer object +/// +/// \return Number of samples +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API size_t sfSoundBuffer_getSampleCount(const sfSoundBuffer* soundBuffer); + +//////////////////////////////////////////////////////////// +/// \brief Get the sample rate of a sound buffer +/// +/// The sample rate is the number of samples played per second. +/// The higher, the better the quality (for example, 44100 +/// samples/s is CD quality). +/// +/// \param soundBuffer Sound buffer object +/// +/// \return Sample rate (number of samples per second) +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API unsigned int sfSoundBuffer_getSampleRate(const sfSoundBuffer* soundBuffer); + +//////////////////////////////////////////////////////////// +/// \brief Get the number of channels used by a sound buffer +/// +/// If the sound is mono then the number of channels will +/// be 1, 2 for stereo, etc. +/// +/// \param soundBuffer Sound buffer object +/// +/// \return Number of channels +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API unsigned int sfSoundBuffer_getChannelCount(const sfSoundBuffer* soundBuffer); + +//////////////////////////////////////////////////////////// +/// \brief Get the total duration of a sound buffer +/// +/// \param soundBuffer Sound buffer object +/// +/// \return Sound duration +/// +//////////////////////////////////////////////////////////// +CSFML_AUDIO_API sfTime sfSoundBuffer_getDuration(const sfSoundBuffer* soundBuffer); + + +#endif // SFML_SOUNDBUFFER_H |