Resources/AudioKeys.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011 Jan Haller
// 
// 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 THOR_AUDIOKEYS_HPP
#define THOR_AUDIOKEYS_HPP

#include <Thor/Resources/ResourceKeyTraits.hpp>
#include <Thor/Detail/Swap.hpp>
#include <Thor/Config.hpp>

#include <SFML/Config.hpp>

#include THOR_TR1_HEADER(functional)
#include <string>


namespace thor
{


namespace Resources
{

    class THOR_API SoundBufferKey
    {
        // ---------------------------------------------------------------------------------------------------------------------------
        // Public member functions
        public:
            static SoundBufferKey       FromFile(const std::string& fileName, const std::string& tag = "");

            static SoundBufferKey       FromMemory(const void* data, std::size_t size, const std::string& tag = "");

            static SoundBufferKey       FromSamples(const sf::Int16* samples, std::size_t samplesCount,
                                            unsigned int channelsCount, unsigned int sampleRate, const std::string& tag = "");

            MovedPtr<sf::SoundBuffer>   Load() const;

            void                        Swap(SoundBufferKey& other);


        // ---------------------------------------------------------------------------------------------------------------------------
        // Private member functions
        private:
            // Make default constructor private
                                        SoundBufferKey();

        
        // ---------------------------------------------------------------------------------------------------------------------------
        // Private variables
        private:
            std::tr1::function<bool(sf::SoundBuffer&)>  mLoader;
            std::string                                 mKey;

    
        // ---------------------------------------------------------------------------------------------------------------------------
        // Friends
        friend struct detail::KeyInfoAccessor<true>;
    };


    class THOR_API MusicKey
    {
        // ---------------------------------------------------------------------------------------------------------------------------
        // Public member functions
        public:
            static MusicKey             FromFile(const std::string& fileName, const std::string& tag = "");

            static MusicKey             FromMemory(const void* data, std::size_t size, const std::string& tag = "");

            MovedPtr<sf::Music>         Load() const;

            void                        Swap(MusicKey& other);


        // ---------------------------------------------------------------------------------------------------------------------------
        // Private member functions
        private:
            // Make default constructor private
                                        MusicKey();

        
        // ---------------------------------------------------------------------------------------------------------------------------
        // Private variables
        private:
            std::tr1::function<bool(sf::Music&)>    mLoader;
            std::string                             mKey;

    
        // ---------------------------------------------------------------------------------------------------------------------------
        // Friends
        friend struct detail::KeyInfoAccessor<true>;
    };


    bool THOR_API               operator< (const SoundBufferKey& lhs, const SoundBufferKey& rhs);
    
    bool THOR_API               operator< (const MusicKey& lhs, const MusicKey& rhs);


    THOR_GLOBAL_SWAP(SoundBufferKey)

    

    THOR_GLOBAL_SWAP(MusicKey)

} // namespace Resources


} // namespace thor

#endif // THOR_AUDIOKEYS_HPP