CAudioSource.h

Go to the documentation of this file.

//==============================================================================
/*
    Software License Agreement (BSD License)
    Copyright (c) 2003-2016, CHAI3D.
    (www.chai3d.org)

    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
    copyright notice, this list of conditions and the following
    disclaimer in the documentation and/or other materials provided
    with the distribution.

    * Neither the name of CHAI3D nor the names of its contributors may
    be used to endorse or promote products derived from this software
    without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE. 

    \author    <http://www.chai3d.org>
    \author    Francois Conti
    \version   3.2.0 $Rev: 2017 $
*/
//==============================================================================

//------------------------------------------------------------------------------
#ifndef CAudioSourceH
#define CAudioSourceH
//------------------------------------------------------------------------------
#include "audio/CAudioBuffer.h"
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
namespace chai3d {
//------------------------------------------------------------------------------

//==============================================================================
//==============================================================================

//==============================================================================
//==============================================================================
class cAudioSource
{    
    //--------------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //--------------------------------------------------------------------------

public:

    cAudioSource();

    virtual ~cAudioSource();


    //--------------------------------------------------------------------------
    // PUBLIC METHODS:
    //--------------------------------------------------------------------------

public:

    bool setAudioBuffer(cAudioBuffer* a_audioBuffer);

    cAudioBuffer* getAudioBuffer() { return (m_audioBuffer); }

    bool play();

    bool isPlaying();

    bool pause();

    bool stop();

    bool rewind();

    bool setPosTime(const float a_time);

    float getPosTime();

    // This method returns a left sample at a given time.
    short getSampleLeft(double a_time);

    // This method returns a right sample at a given time.
    short getSampleRight(double a_time);

    bool setPitch(const float a_pitch);

    float getPitch() { return (m_pitch); }

    bool setGain(const float a_gain);

    float getGain() { return (m_gain); }

    bool setSourcePos(const cVector3d a_sourcePos);

    cVector3d getSourcePos() { return (m_sourcePos); }

    bool setSourceVel(const cVector3d a_sourceVel);

    cVector3d getSourceVel() { return (m_sourceVel); }

    bool setLoop(const bool a_loop);

    bool getLoop() { return (m_loop); }


    //--------------------------------------------------------------------------
    // PROTECTED METHODS:
    //--------------------------------------------------------------------------

protected:

    bool checkError();


    //--------------------------------------------------------------------------
    // PROTECTED MEMBERS:
    //--------------------------------------------------------------------------

protected:

    unsigned int m_source;

    float m_pitch;

    float m_gain;

    cVector3d m_sourcePos;

    cVector3d m_sourceVel;

    bool m_loop;

    cAudioBuffer* m_audioBuffer;
};

//------------------------------------------------------------------------------
} // namespace chai3d
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
#endif
//------------------------------------------------------------------------------