SoundBuffer.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 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_HPP
#define SFML_SOUNDBUFFER_HPP

// Headers
#include <SFML/Config.hpp>
#include <SFML/System/Resource.hpp>
#include <string>
#include <vector>
#include <set>


namespace sf
{
class Sound;

class SFML_API SoundBuffer : public Resource<SoundBuffer>
{
public :

    SoundBuffer();

    SoundBuffer(const SoundBuffer& copy);

    ~SoundBuffer();

    bool LoadFromFile(const std::string& filename);

    bool LoadFromMemory(const void* data, std::size_t sizeInBytes);

    bool LoadFromSamples(const Int16* samples, std::size_t samplesCount, unsigned int channelsCount, unsigned int sampleRate);

    bool SaveToFile(const std::string& filename) const;

    const Int16* GetSamples() const;

    std::size_t GetSamplesCount() const;

    unsigned int GetSampleRate() const;

    unsigned int GetChannelsCount() const;

    float GetDuration() const;

    SoundBuffer& operator =(const SoundBuffer& right);

private :

    friend class Sound;

    bool Update(unsigned int channelsCount, unsigned int sampleRate);

    void AttachSound(Sound* sound) const;

    void DetachSound(Sound* sound) const;

    // Types
    typedef std::set<Sound*> SoundList; 

    // Member data
    unsigned int       myBuffer;   
    std::vector<Int16> mySamples;  
    float              myDuration; 
    mutable SoundList  mySounds;   
};

} // namespace sf


#endif // SFML_SOUNDBUFFER_HPP

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  ::