mirror of
https://github.com/TorqueGameEngines/Torque3D.git
synced 2026-01-20 04:34:48 +00:00
301 lines
9 KiB
C++
301 lines
9 KiB
C++
//-----------------------------------------------------------------------------
|
|
// Copyright (c) 2013 GarageGames, LLC
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to
|
|
// deal in the Software without restriction, including without limitation the
|
|
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
// sell copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
// IN THE SOFTWARE.
|
|
//-----------------------------------------------------------------------------
|
|
|
|
#ifndef SOUND_ASSET_H
|
|
#include "SoundAsset.h"
|
|
#endif
|
|
|
|
#ifndef _ASSET_MANAGER_H_
|
|
#include "assets/assetManager.h"
|
|
#endif
|
|
|
|
#ifndef _CONSOLETYPES_H_
|
|
#include "console/consoleTypes.h"
|
|
#endif
|
|
|
|
#ifndef _TAML_
|
|
#include "persistence/taml/taml.h"
|
|
#endif
|
|
|
|
#ifndef _ASSET_PTR_H_
|
|
#include "assets/assetPtr.h"
|
|
#endif
|
|
|
|
// Debug Profiling.
|
|
#include "platform/profiler.h"
|
|
#include "sfx/sfxTypes.h"
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
IMPLEMENT_CONOBJECT(SoundAsset);
|
|
|
|
ConsoleType(SoundAssetPtr, TypeSoundAssetPtr, const char*, ASSET_ID_FIELD_PREFIX)
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
ConsoleGetType(TypeSoundAssetPtr)
|
|
{
|
|
// Fetch asset Id.
|
|
return *((const char**)(dptr));
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
ConsoleSetType(TypeSoundAssetPtr)
|
|
{
|
|
// Was a single argument specified?
|
|
if (argc == 1)
|
|
{
|
|
// Yes, so fetch field value.
|
|
*((const char**)dptr) = StringTable->insert(argv[0]);
|
|
|
|
return;
|
|
}
|
|
|
|
// Warn.
|
|
Con::warnf("(TypeSoundAssetPtr) - Cannot set multiple args to a single asset.");
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
ConsoleType(assetIdString, TypeSoundAssetId, const char*, ASSET_ID_FIELD_PREFIX)
|
|
|
|
ConsoleGetType(TypeSoundAssetId)
|
|
{
|
|
// Fetch asset Id.
|
|
return *((const char**)(dptr));
|
|
}
|
|
|
|
ConsoleSetType(TypeSoundAssetId)
|
|
{
|
|
// Was a single argument specified?
|
|
if (argc == 1)
|
|
{
|
|
// Yes, so fetch field value.
|
|
*((const char**)dptr) = StringTable->insert(argv[0]);
|
|
|
|
return;
|
|
}
|
|
|
|
// Warn.
|
|
Con::warnf("(TypeAssetId) - Cannot set multiple args to a single asset.");
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
SoundAsset::SoundAsset()
|
|
{
|
|
mSoundFile = StringTable->EmptyString();
|
|
mSoundPath = StringTable->EmptyString();
|
|
mSubtitleString = StringTable->EmptyString();
|
|
|
|
mLoadedState = AssetErrCode::NotLoaded;
|
|
mPreload = false;
|
|
// SFX description inits
|
|
// reverb is useless here, reverb is inacted on listener.
|
|
mProfileDesc.mPitch = 1;
|
|
mProfileDesc.mVolume = 1;
|
|
mProfileDesc.mIs3D = false;
|
|
mProfileDesc.mIsLooping = false;
|
|
mProfileDesc.mIsStreaming = false;
|
|
mProfileDesc.mUseHardware = false;
|
|
mProfileDesc.mMinDistance = 1;
|
|
mProfileDesc.mMaxDistance = 100;
|
|
mProfileDesc.mConeInsideAngle = 360;
|
|
mProfileDesc.mConeOutsideAngle = 360;
|
|
mProfileDesc.mConeOutsideVolume = 1;
|
|
mProfileDesc.mRolloffFactor = -1.0f;
|
|
mProfileDesc.mScatterDistance = Point3F(0.f, 0.f, 0.f);
|
|
mProfileDesc.mPriority = 1.0f;
|
|
mProfileDesc.mSourceGroup = NULL;
|
|
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
SoundAsset::~SoundAsset()
|
|
{
|
|
}
|
|
|
|
//-----------------------------------------------------------------------------
|
|
|
|
void SoundAsset::initPersistFields()
|
|
{
|
|
// Call parent.
|
|
Parent::initPersistFields();
|
|
|
|
addProtectedField("soundFile", TypeAssetLooseFilePath, Offset(mSoundFile, SoundAsset),
|
|
&setSoundFile, &getSoundFile, "Path to the sound file.");
|
|
|
|
addField("pitchAdjust", TypeF32, Offset(mProfileDesc.mPitch, SoundAsset), "Adjustment of the pitch value 1 is default.");
|
|
addField("volumeAdjust", TypeF32, Offset(mProfileDesc.mVolume, SoundAsset), "Adjustment to the volume.");
|
|
addField("is3D", TypeBool, Offset(mProfileDesc.mIs3D, SoundAsset), "Set this sound to 3D.");
|
|
addField("isLooping", TypeBool, Offset(mProfileDesc.mIsLooping, SoundAsset), "Does this sound loop.");
|
|
// if streaming, a default packet size should be chosen for all sounds.
|
|
addField("isStreaming", TypeBool, Offset(mProfileDesc.mIsStreaming, SoundAsset), "Use streaming.");
|
|
//....why?
|
|
addField("useHardware", TypeBool, Offset(mProfileDesc.mUseHardware, SoundAsset), "Use hardware mixing for this sound.");
|
|
addField("minDistance", TypeF32, Offset(mProfileDesc.mMinDistance, SoundAsset), "Minimum distance for sound.");
|
|
// more like it.
|
|
addField("maxDistance", TypeF32, Offset(mProfileDesc.mMaxDistance, SoundAsset), "Max distance for sound.");
|
|
addField("coneInsideAngle", TypeS32, Offset(mProfileDesc.mConeInsideAngle, SoundAsset), "Cone inside angle.");
|
|
addField("coneOutsideAngle", TypeS32, Offset(mProfileDesc.mConeOutsideAngle, SoundAsset), "Cone outside angle.");
|
|
addField("coneOutsideVolume", TypeS32, Offset(mProfileDesc.mConeOutsideVolume, SoundAsset), "Cone outside volume.");
|
|
addField("rolloffFactor", TypeF32, Offset(mProfileDesc.mRolloffFactor, SoundAsset), "Rolloff factor.");
|
|
addField("scatterDistance", TypePoint3F, Offset(mProfileDesc.mScatterDistance, SoundAsset), "Randomization to the spacial position of the sound.");
|
|
addField("sourceGroup", TypeSFXSourceName, Offset(mProfileDesc.mSourceGroup, SoundAsset), "Group that sources playing with this description should be put into.");
|
|
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
void SoundAsset::copyTo(SimObject* object)
|
|
{
|
|
// Call to parent.
|
|
Parent::copyTo(object);
|
|
}
|
|
|
|
void SoundAsset::initializeAsset(void)
|
|
{
|
|
Parent::initializeAsset();
|
|
|
|
if (mSoundFile == StringTable->EmptyString())
|
|
return;
|
|
|
|
//ResourceManager::get().getChangedSignal.notify(this, &SoundAsset::_onResourceChanged);
|
|
|
|
//Ensure our path is expando'd if it isn't already
|
|
mSoundPath = getOwned() ? expandAssetFilePath(mSoundFile) : mSoundPath;
|
|
|
|
mSoundPath = expandAssetFilePath(mSoundPath);
|
|
|
|
loadSound();
|
|
}
|
|
|
|
void SoundAsset::_onResourceChanged(const Torque::Path &path)
|
|
{
|
|
if (path != Torque::Path(mSoundPath))
|
|
return;
|
|
|
|
refreshAsset();
|
|
|
|
loadSound();
|
|
}
|
|
|
|
void SoundAsset::onAssetRefresh(void)
|
|
{
|
|
if (mSoundFile == StringTable->EmptyString())
|
|
return;
|
|
|
|
//Update
|
|
mSoundPath = getOwned() ? expandAssetFilePath(mSoundFile) : mSoundPath;
|
|
|
|
loadSound();
|
|
}
|
|
|
|
bool SoundAsset::loadSound()
|
|
{
|
|
if (mSoundPath)
|
|
{
|
|
if (!Torque::FS::IsFile(mSoundPath))
|
|
{
|
|
Con::errorf("SoundAsset::initializeAsset: Attempted to load file %s but it was not valid!", mSoundFile);
|
|
mLoadedState = BadFileReference;
|
|
return false;
|
|
}
|
|
else
|
|
{// = new SFXProfile(mProfileDesc, mSoundFile, mPreload);
|
|
mSFXProfile.setDescription(&mProfileDesc);
|
|
mSFXProfile.setSoundFileName(mSoundFile);
|
|
mSFXProfile.setPreload(mPreload);
|
|
}
|
|
|
|
}
|
|
mChangeSignal.trigger();
|
|
mLoadedState = Ok;
|
|
return true;
|
|
}
|
|
|
|
void SoundAsset::setSoundFile(const char* pSoundFile)
|
|
{
|
|
// Sanity!
|
|
AssertFatal(pSoundFile != NULL, "Cannot use a NULL sound file.");
|
|
|
|
// Fetch sound file.
|
|
pSoundFile = StringTable->insert(pSoundFile, true);
|
|
|
|
// Ignore no change,
|
|
if (pSoundFile == mSoundFile)
|
|
return;
|
|
|
|
// Update.
|
|
mSoundFile = getOwned() ? expandAssetFilePath(pSoundFile) : pSoundFile;
|
|
|
|
// Refresh the asset.
|
|
refreshAsset();
|
|
}
|
|
|
|
DefineEngineMethod(SoundAsset, getSoundPath, const char*, (), , "")
|
|
{
|
|
return object->getSoundPath();
|
|
}
|
|
|
|
IMPLEMENT_CONOBJECT(GuiInspectorTypeSoundAssetPtr);
|
|
|
|
ConsoleDocClass(GuiInspectorTypeSoundAssetPtr,
|
|
"@brief Inspector field type for Sounds\n\n"
|
|
"Editor use only.\n\n"
|
|
"@internal"
|
|
);
|
|
|
|
void GuiInspectorTypeSoundAssetPtr::consoleInit()
|
|
{
|
|
Parent::consoleInit();
|
|
|
|
ConsoleBaseType::getType(TypeSoundAssetPtr)->setInspectorFieldType("GuiInspectorTypeSoundAssetPtr");
|
|
}
|
|
|
|
GuiControl * GuiInspectorTypeSoundAssetPtr::constructEditControl()
|
|
{
|
|
return nullptr;
|
|
}
|
|
|
|
bool GuiInspectorTypeSoundAssetPtr::updateRects()
|
|
{
|
|
return false;
|
|
}
|
|
|
|
IMPLEMENT_CONOBJECT(GuiInspectorTypeSoundAssetId);
|
|
|
|
ConsoleDocClass(GuiInspectorTypeSoundAssetId,
|
|
"@brief Inspector field type for Sounds\n\n"
|
|
"Editor use only.\n\n"
|
|
"@internal"
|
|
);
|
|
|
|
void GuiInspectorTypeSoundAssetId::consoleInit()
|
|
{
|
|
Parent::consoleInit();
|
|
|
|
ConsoleBaseType::getType(TypeSoundAssetId)->setInspectorFieldType("GuiInspectorTypeSoundAssetId");
|
|
}
|