CUSound.h

//
//  CUSound.h
//  Cornell University Game Library (CUGL)
//
//  This module provides a sound asset. Historically, these would just be
//  prerecorded sound files encoded a WAV, MP3, or OGG files.  However, our
//  long term roadmap is to support arbitrary audio graphs created by programs
//  like PureData, Max DSP or Abelton. For that reason, the sound asset is
//  an abstract class that is the base for several asset types.
//
//  To get a specific sound asset type, either use a specific class (like
//  AudioSample or AudioWaveform) or use the factory allocator in this class.
//
//  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: 11/20/18
//
#ifndef __CU_SOUND_H__
#define __CU_SOUND_H__
#include <cugl/audio/graph/CUAudioNode.h>
#include <cugl/audio/graph/CUAudioNode.h>
#include <cugl/math/CUMathBase.h>

namespace  cugl {
class Sound : public std::enable_shared_from_this<Sound> {
private:
    CU_DISALLOW_COPY_AND_ASSIGN(Sound);
    
protected:
    Uint8  _channels;
    
    Uint32 _rate;
    
    std::string _file;

    float _volume;
    
public:
#pragma mark Constructors

    Sound();
    
    ~Sound() { dispose(); }

    virtual void dispose();
    
#pragma mark Attributes

    Uint32 getRate() const { return _rate; }
    
    Uint32 getChannels() const { return _channels; }
    
    virtual Sint64 getLength() const { return -1; }
    
    virtual double getDuration() const { return -1; }

    std::string getFile() const { return _file; }
    
    std::string getSuffix() const;
    
    float getVolume() const { return _volume; }
    
    void setVolume(float volume);
    
    virtual std::shared_ptr<audio::AudioNode> createNode() { return nullptr; };
};
    
}

#endif /* __CU_SOUND_H__ */