KX_SoundActuator.cpp

Go to the documentation of this file.

/*
 * KX_SoundActuator.cpp
 *
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 *
 */

#include "KX_SoundActuator.h"

#ifdef WITH_AUDASPACE
#  include "AUD_C-API.h"
#  include "AUD_PingPongFactory.h"
#  include "AUD_IDevice.h"
#  include "AUD_I3DHandle.h"
#endif

#include "KX_GameObject.h"
#include "KX_PyMath.h" // needed for PyObjectFrom()
#include "KX_PythonInit.h"
#include "KX_Camera.h"
#include <iostream>

/* ------------------------------------------------------------------------- */
/* Native functions                                                          */
/* ------------------------------------------------------------------------- */
KX_SoundActuator::KX_SoundActuator(SCA_IObject* gameobj,
                                   AUD_Reference<AUD_IFactory> sound,
                                   float volume,
                                   float pitch,
                                   bool is3d,
                                   KX_3DSoundSettings settings,
                                   KX_SOUNDACT_TYPE type)//,
                                   : SCA_IActuator(gameobj, KX_ACT_SOUND)
{
    m_sound = sound;
    m_volume = volume;
    m_pitch = pitch;
    m_is3d = is3d;
    m_3d = settings;
    m_type = type;
    m_isplaying = false;
}



KX_SoundActuator::~KX_SoundActuator()
{
    if(!m_handle.isNull())
        m_handle->stop();
}

void KX_SoundActuator::play()
{
    if(!m_handle.isNull())
        m_handle->stop();

    if(m_sound.isNull())
        return;

    // this is the sound that will be played and not deleted afterwards
    AUD_Reference<AUD_IFactory> sound = m_sound;

    bool loop = false;

    switch (m_type)
    {
    case KX_SOUNDACT_LOOPBIDIRECTIONAL:
    case KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP:
        sound =  new AUD_PingPongFactory(sound);
        // fall through
    case KX_SOUNDACT_LOOPEND:
    case KX_SOUNDACT_LOOPSTOP:
        loop = true;
        break;
    case KX_SOUNDACT_PLAYSTOP:
    case KX_SOUNDACT_PLAYEND:
    default:
        break;
    }

    try
    {
        m_handle = AUD_getDevice()->play(sound, 0);
    }
    catch(AUD_Exception&)
    {
        // cannot play back, ignore
        return;
    }

    AUD_Reference<AUD_I3DHandle> handle3d = AUD_Reference<AUD_I3DHandle>(m_handle);

    if(m_is3d && !handle3d.isNull())
    {
        handle3d->setRelative(true);
        handle3d->setVolumeMaximum(m_3d.max_gain);
        handle3d->setVolumeMinimum(m_3d.min_gain);
        handle3d->setDistanceReference(m_3d.reference_distance);
        handle3d->setDistanceMaximum(m_3d.max_distance);
        handle3d->setAttenuation(m_3d.rolloff_factor);
        handle3d->setConeAngleInner(m_3d.cone_inner_angle);
        handle3d->setConeAngleOuter(m_3d.cone_outer_angle);
        handle3d->setConeVolumeOuter(m_3d.cone_outer_gain);
    }

    if(loop)
        m_handle->setLoopCount(-1);
    m_handle->setPitch(m_pitch);
    m_handle->setVolume(m_volume);
    m_isplaying = true;
}

CValue* KX_SoundActuator::GetReplica()
{
    KX_SoundActuator* replica = new KX_SoundActuator(*this);
    replica->ProcessReplica();
    return replica;
};

void KX_SoundActuator::ProcessReplica()
{
    SCA_IActuator::ProcessReplica();
    m_handle = AUD_Reference<AUD_IHandle>();
}

bool KX_SoundActuator::Update(double curtime, bool frame)
{
    if (!frame)
        return true;
    bool result = false;

    // do nothing on negative events, otherwise sounds are played twice!
    bool bNegativeEvent = IsNegativeEvent();
    bool bPositiveEvent = m_posevent;
    
    RemoveAllEvents();

    if(m_sound.isNull())
        return false;

    // actual audio device playing state
    bool isplaying = m_handle.isNull() ? false : (m_handle->getStatus() == AUD_STATUS_PLAYING);

    if (bNegativeEvent)
    {
        // here must be a check if it is still playing
        if (m_isplaying && isplaying)
        {
            switch (m_type)
            {
            case KX_SOUNDACT_PLAYSTOP:
            case KX_SOUNDACT_LOOPSTOP:
            case KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP:
                {
                    // stop immediately
                    if(!m_handle.isNull())
                        m_handle->stop();
                    m_handle = AUD_Reference<AUD_IHandle>();
                    break;
                }
            case KX_SOUNDACT_PLAYEND:
                {
                    // do nothing, sound will stop anyway when it's finished
                    break;
                }
            case KX_SOUNDACT_LOOPEND:
            case KX_SOUNDACT_LOOPBIDIRECTIONAL:
                {
                    // stop the looping so that the sound stops when it finished
                    if(!m_handle.isNull())
                        m_handle->setLoopCount(0);
                    break;
                }
            default:
                // implement me !!
                break;
            }
        }
        // remember that we tried to stop the actuator
        m_isplaying = false;
    }
    
#if 1
    // Warning: when de-activating the actuator, after a single negative event this runs again with...
    // m_posevent==false && m_posevent==false, in this case IsNegativeEvent() returns false 
    // and assumes this is a positive event.
    // check that we actually have a positive event so as not to play sounds when being disabled.
    else if(bPositiveEvent) { // <- added since 2.49
#else
    else {  // <- works in most cases except a loop-end sound will never stop unless
            // the negative pulse is done continuesly
#endif
        if (!m_isplaying)
            play();
    }
    // verify that the sound is still playing
    isplaying = m_handle.isNull() ? false : (m_handle->getStatus() == AUD_STATUS_PLAYING);

    if (isplaying)
    {
        AUD_Reference<AUD_I3DHandle> handle3d = AUD_Reference<AUD_I3DHandle>(m_handle);

        if(m_is3d && !handle3d.isNull())
        {
            KX_Camera* cam = KX_GetActiveScene()->GetActiveCamera();
            if (cam)
            {
                KX_GameObject* obj = (KX_GameObject*)this->GetParent();
                MT_Point3 p;
                MT_Matrix3x3 Mo;
                AUD_Vector3 v;
                float q[4];

                Mo = cam->NodeGetWorldOrientation().inverse();
                p = (obj->NodeGetWorldPosition() - cam->NodeGetWorldPosition());
                p = Mo * p;
                p.getValue(v.get());
                handle3d->setSourceLocation(v);
                p = (obj->GetLinearVelocity() - cam->GetLinearVelocity());
                p = Mo * p;
                p.getValue(v.get());
                handle3d->setSourceVelocity(v);
                (Mo * obj->NodeGetWorldOrientation()).getRotation().getValue(q);
                handle3d->setSourceOrientation(AUD_Quaternion(q[3], q[0], q[1], q[2]));
            }
        }
        result = true;
    }
    else
    {
        m_isplaying = false;
        result = false;
    }
    return result;
}

#ifdef WITH_PYTHON

/* ------------------------------------------------------------------------- */
/* Python functions                                                          */
/* ------------------------------------------------------------------------- */



/* Integration hooks ------------------------------------------------------- */
PyTypeObject KX_SoundActuator::Type = {
    PyVarObject_HEAD_INIT(NULL, 0)
    "KX_SoundActuator",
    sizeof(PyObjectPlus_Proxy),
    0,
    py_base_dealloc,
    0,
    0,
    0,
    0,
    py_base_repr,
    0,0,0,0,0,0,0,0,0,
    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    0,0,0,0,0,0,0,
    Methods,
    0,
    0,
    &SCA_IActuator::Type,
    0,0,0,0,0,0,
    py_base_new
};

PyMethodDef KX_SoundActuator::Methods[] = {
    KX_PYMETHODTABLE_NOARGS(KX_SoundActuator, startSound),
    KX_PYMETHODTABLE_NOARGS(KX_SoundActuator, pauseSound),
    KX_PYMETHODTABLE_NOARGS(KX_SoundActuator, stopSound),
    {NULL, NULL} //Sentinel
};

PyAttributeDef KX_SoundActuator::Attributes[] = {
    KX_PYATTRIBUTE_BOOL_RO("is3D", KX_SoundActuator, m_is3d),
    KX_PYATTRIBUTE_RW_FUNCTION("volume_maximum", KX_SoundActuator, pyattr_get_3d_property, pyattr_set_3d_property),
    KX_PYATTRIBUTE_RW_FUNCTION("volume_minimum", KX_SoundActuator, pyattr_get_3d_property, pyattr_set_3d_property),
    KX_PYATTRIBUTE_RW_FUNCTION("distance_reference", KX_SoundActuator, pyattr_get_3d_property, pyattr_set_3d_property),
    KX_PYATTRIBUTE_RW_FUNCTION("distance_maximum", KX_SoundActuator, pyattr_get_3d_property, pyattr_set_3d_property),
    KX_PYATTRIBUTE_RW_FUNCTION("attenuation", KX_SoundActuator, pyattr_get_3d_property, pyattr_set_3d_property),
    KX_PYATTRIBUTE_RW_FUNCTION("cone_angle_inner", KX_SoundActuator, pyattr_get_3d_property, pyattr_set_3d_property),
    KX_PYATTRIBUTE_RW_FUNCTION("cone_angle_outer", KX_SoundActuator, pyattr_get_3d_property, pyattr_set_3d_property),
    KX_PYATTRIBUTE_RW_FUNCTION("cone_volume_outer", KX_SoundActuator, pyattr_get_3d_property, pyattr_set_3d_property),
    KX_PYATTRIBUTE_RW_FUNCTION("sound", KX_SoundActuator, pyattr_get_sound, pyattr_set_sound),

    KX_PYATTRIBUTE_RW_FUNCTION("time", KX_SoundActuator, pyattr_get_audposition, pyattr_set_audposition),
    KX_PYATTRIBUTE_RW_FUNCTION("volume", KX_SoundActuator, pyattr_get_gain, pyattr_set_gain),
    KX_PYATTRIBUTE_RW_FUNCTION("pitch", KX_SoundActuator, pyattr_get_pitch, pyattr_set_pitch),
    KX_PYATTRIBUTE_ENUM_RW("mode",KX_SoundActuator::KX_SOUNDACT_NODEF+1,KX_SoundActuator::KX_SOUNDACT_MAX-1,false,KX_SoundActuator,m_type),
    { NULL }    //Sentinel
};

/* Methods ----------------------------------------------------------------- */
KX_PYMETHODDEF_DOC_NOARGS(KX_SoundActuator, startSound,
"startSound()\n"
"\tStarts the sound.\n")
{
    if(!m_handle.isNull())
    {
        switch(m_handle->getStatus())
        {
        case AUD_STATUS_PLAYING:
            break;
        case AUD_STATUS_PAUSED:
            m_handle->resume();
            break;
        default:
            play();
        }
    }
    Py_RETURN_NONE;
}

KX_PYMETHODDEF_DOC_NOARGS(KX_SoundActuator, pauseSound,
"pauseSound()\n"
"\tPauses the sound.\n")
{
    if(!m_handle.isNull())
        m_handle->pause();
    Py_RETURN_NONE;
}

KX_PYMETHODDEF_DOC_NOARGS(KX_SoundActuator, stopSound,
"stopSound()\n"
"\tStops the sound.\n")
{
    if(!m_handle.isNull())
        m_handle->stop();
    m_handle = AUD_Reference<AUD_IHandle>();
    Py_RETURN_NONE;
}

/* Atribute setting and getting -------------------------------------------- */
PyObject* KX_SoundActuator::pyattr_get_3d_property(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef)
{
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);
    const char* prop = attrdef->m_name;
    float result_value = 0.0;

    if(!strcmp(prop, "volume_maximum")) {
        result_value = actuator->m_3d.max_gain;

    } else if (!strcmp(prop, "volume_minimum")) {
        result_value = actuator->m_3d.min_gain;

    } else if (!strcmp(prop, "distance_reference")) {
        result_value = actuator->m_3d.reference_distance;

    } else if (!strcmp(prop, "distance_maximum")) {
        result_value = actuator->m_3d.max_distance;

    } else if (!strcmp(prop, "attenuation")) {
        result_value = actuator->m_3d.rolloff_factor;

    } else if (!strcmp(prop, "cone_angle_inner")) {
        result_value = actuator->m_3d.cone_inner_angle;

    } else if (!strcmp(prop, "cone_angle_outer")) {
        result_value = actuator->m_3d.cone_outer_angle;

    } else if (!strcmp(prop, "cone_volume_outer")) {
        result_value = actuator->m_3d.cone_outer_gain;

    } else {
        Py_RETURN_NONE;
    }

    PyObject* result = PyFloat_FromDouble(result_value);
    return result;
}

PyObject* KX_SoundActuator::pyattr_get_audposition(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef)
{
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);
    float position = 0.0;

    if(!actuator->m_handle.isNull())
        position = actuator->m_handle->getPosition();

    PyObject* result = PyFloat_FromDouble(position);

    return result;
}

PyObject* KX_SoundActuator::pyattr_get_gain(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef)
{
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);
    float gain = actuator->m_volume;

    PyObject* result = PyFloat_FromDouble(gain);

    return result;
}

PyObject* KX_SoundActuator::pyattr_get_pitch(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef)
{
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);
    float pitch = actuator->m_pitch;

    PyObject* result = PyFloat_FromDouble(pitch);

    return result;
}

PyObject* KX_SoundActuator::pyattr_get_sound(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef)
{
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);
    if(!actuator->m_sound.isNull())
        return AUD_getPythonFactory(&actuator->m_sound);
    else
        Py_RETURN_NONE;
}

int KX_SoundActuator::pyattr_set_3d_property(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
{
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);
    const char* prop = attrdef->m_name;
    float prop_value = 0.0;

    if (!PyArg_Parse(value, "f", &prop_value))
        return PY_SET_ATTR_FAIL;

    AUD_Reference<AUD_I3DHandle> handle3d = AUD_Reference<AUD_I3DHandle>(actuator->m_handle);
    // if sound is working and 3D, set the new setting
    if(!actuator->m_is3d)
        return PY_SET_ATTR_FAIL;

    if(!strcmp(prop, "volume_maximum")) {
        actuator->m_3d.max_gain = prop_value;
        if(!handle3d.isNull())
            handle3d->setVolumeMaximum(prop_value);

    } else if (!strcmp(prop, "volume_minimum")) {
        actuator->m_3d.min_gain = prop_value;
        if(!handle3d.isNull())
            handle3d->setVolumeMinimum(prop_value);

    } else if (!strcmp(prop, "distance_reference")) {
        actuator->m_3d.reference_distance = prop_value;
        if(!handle3d.isNull())
            handle3d->setDistanceReference(prop_value);

    } else if (!strcmp(prop, "distance_maximum")) {
        actuator->m_3d.max_distance = prop_value;
        if(!handle3d.isNull())
            handle3d->setDistanceMaximum(prop_value);

    } else if (!strcmp(prop, "attenuation")) {
        actuator->m_3d.rolloff_factor = prop_value;
        if(!handle3d.isNull())
            handle3d->setAttenuation(prop_value);

    } else if (!!strcmp(prop, "cone_angle_inner")) {
        actuator->m_3d.cone_inner_angle = prop_value;
        if(!handle3d.isNull())
            handle3d->setConeAngleInner(prop_value);

    } else if (!strcmp(prop, "cone_angle_outer")) {
        actuator->m_3d.cone_outer_angle = prop_value;
        if(!handle3d.isNull())
            handle3d->setConeAngleOuter(prop_value);

    } else if (!strcmp(prop, "cone_volume_outer")) {
        actuator->m_3d.cone_outer_gain = prop_value;
        if(!handle3d.isNull())
            handle3d->setConeVolumeOuter(prop_value);

    } else {
        return PY_SET_ATTR_FAIL;
    }
    
    return PY_SET_ATTR_SUCCESS;
}

int KX_SoundActuator::pyattr_set_audposition(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
{
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);

    float position = 1.0;
    if (!PyArg_Parse(value, "f", &position))
        return PY_SET_ATTR_FAIL;

    if(!actuator->m_handle.isNull())
        actuator->m_handle->seek(position);
    return PY_SET_ATTR_SUCCESS;
}

int KX_SoundActuator::pyattr_set_gain(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
{
    float gain = 1.0;
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);
    if (!PyArg_Parse(value, "f", &gain))
        return PY_SET_ATTR_FAIL;

    actuator->m_volume = gain;
    if(!actuator->m_handle.isNull())
        actuator->m_handle->setVolume(gain);

    return PY_SET_ATTR_SUCCESS;
}

int KX_SoundActuator::pyattr_set_pitch(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
{
    float pitch = 1.0;
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);
    if (!PyArg_Parse(value, "f", &pitch))
        return PY_SET_ATTR_FAIL;

    actuator->m_pitch = pitch;
    if(!actuator->m_handle.isNull())
        actuator->m_handle->setPitch(pitch);

    return PY_SET_ATTR_SUCCESS;
}

int KX_SoundActuator::pyattr_set_sound(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
{
    PyObject* sound = NULL;
    KX_SoundActuator * actuator = static_cast<KX_SoundActuator *> (self);
    if (!PyArg_Parse(value, "O", &sound))
        return PY_SET_ATTR_FAIL;

    AUD_Reference<AUD_IFactory>* snd = reinterpret_cast<AUD_Reference<AUD_IFactory>*>(AUD_getPythonSound(sound));
    if(snd)
    {
        actuator->m_sound = *snd;
        delete snd;
        return PY_SET_ATTR_SUCCESS;
    }

    return PY_SET_ATTR_FAIL;
}

#endif // WITH_PYTHON