CUSoundLoader.h

//
//  CUSoundLoader.h
//  Cornell University Game Library (CUGL)
//
//  This module provides a specific implementation of the Loader class to load
//  sound assets (e.g. in-memory audio files). A sound asset is identified by
//  both its source file and its volume.
//
//  As with all of our loaders, this loader is designed to be attached to an
//  asset manager.  In addition, this class uses our standard shared-pointer
//  architecture.
//
//  1. The constructor does not perform any initialization; it just sets all
//     attributes to their defaults.
//
//  2. All initialization takes place via init methods, which can fail if an
//     object is initialized more than once.
//
//  3. All allocation takes place via static constructors which return a shared
//     pointer.
//
//
//  CUGL MIT License:
//
//      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.
//
//  Author: Walker White
//  Version: 12/20/18
//
#ifndef __CU_SOUND_LOADER_H__
#define __CU_SOUND_LOADER_H__
#include <cugl/assets/CULoader.h>
#include <cugl/audio/CUSound.h>
 
namespace cugl {
    
class SoundLoader : public Loader<Sound> {
private:
    CU_DISALLOW_COPY_AND_ASSIGN(SoundLoader);
    
protected:
    float _volume;
    
#pragma mark Asset Loading
 
    void materialize(const std::string& key, const std::shared_ptr<Sound>& sound,
                     LoaderCallback callback);
    
    virtual bool read(const std::string& key, const std::string& source,
                      LoaderCallback callback, bool async) override;
    
    virtual bool read(const std::shared_ptr<JsonValue>& json,
                      LoaderCallback callback, bool async) override;
    
    
public:
#pragma mark -
#pragma mark Constructors
 
    SoundLoader();
    
    void dispose() override {
        _assets.clear();
        _loader = nullptr;
    }
    
    static std::shared_ptr<SoundLoader> alloc() {
        std::shared_ptr<SoundLoader> result = std::make_shared<SoundLoader>();
        return (result->init() ? result : nullptr);
    }
    
    static std::shared_ptr<SoundLoader> alloc(const std::shared_ptr<ThreadPool>& threads) {
        std::shared_ptr<SoundLoader> result = std::make_shared<SoundLoader>();
        return (result->init(threads) ? result : nullptr);
    }
    
#pragma mark -
#pragma mark Properties
 
    float getVolume() const     { return _volume; }
    
    void setVolume(float volume) { _volume = volume; }
    
};
    
}
#endif /* __CU_SOUND_LOADER_H__ */