1 2 /* ============================================================================================ */ 3 /* FMOD Ex - Main C/C++ header file. Copyright (c), Firelight Technologies Pty, Ltd. 2004-2011. */ 4 /* */ 5 /* This header is the base header for all other FMOD headers. If you are programming in C */ 6 /* use this exclusively, or if you are programming C++ use this in conjunction with FMOD.HPP */ 7 /* */ 8 /* ============================================================================================ */ 9 10 #ifndef _FMOD_H 11 #define _FMOD_H 12 13 /* 14 FMOD version number. Check this against FMOD::System::getVersion. 15 0xaaaabbcc -> aaaa = major version number. bb = minor version number. cc = development version number. 16 */ 17 18 #define FMOD_VERSION 0x00044412 19 20 /* 21 Compiler specific settings. 22 */ 23 24 #if defined(__CYGWIN32__) 25 #define F_CDECL __cdecl 26 #define F_STDCALL __stdcall 27 #define F_DECLSPEC __declspec 28 #define F_DLLEXPORT ( dllexport ) 29 #elif defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(_WIN64) 30 #define F_CDECL _cdecl 31 #define F_STDCALL _stdcall 32 #define F_DECLSPEC __declspec 33 #define F_DLLEXPORT ( dllexport ) 34 #elif defined(__MACH__) || defined(__ANDROID__) || defined(__linux__) || defined(__QNX__) 35 #define F_CDECL 36 #define F_STDCALL 37 #define F_DECLSPEC 38 #define F_DLLEXPORT __attribute__ ((visibility("default"))) 39 #else 40 #define F_CDECL 41 #define F_STDCALL 42 #define F_DECLSPEC 43 #define F_DLLEXPORT 44 #endif 45 46 #ifdef DLL_EXPORTS 47 #if defined(__MACH__) || defined(__ANDROID__) || defined(__linux__) || defined(__QNX__) 48 #define F_API __attribute__ ((visibility("default"))) 49 #else 50 #define F_API __declspec(dllexport) F_STDCALL 51 #endif 52 #else 53 #define F_API F_STDCALL 54 #endif 55 56 #define F_CALLBACK F_STDCALL 57 58 /* 59 FMOD types. 60 */ 61 62 typedef int FMOD_BOOL; 63 typedef struct FMOD_SYSTEM FMOD_SYSTEM; 64 typedef struct FMOD_SOUND FMOD_SOUND; 65 typedef struct FMOD_CHANNEL FMOD_CHANNEL; 66 typedef struct FMOD_CHANNELGROUP FMOD_CHANNELGROUP; 67 typedef struct FMOD_SOUNDGROUP FMOD_SOUNDGROUP; 68 typedef struct FMOD_REVERB FMOD_REVERB; 69 typedef struct FMOD_DSP FMOD_DSP; 70 typedef struct FMOD_DSPCONNECTION FMOD_DSPCONNECTION; 71 typedef struct FMOD_POLYGON FMOD_POLYGON; 72 typedef struct FMOD_GEOMETRY FMOD_GEOMETRY; 73 typedef struct FMOD_SYNCPOINT FMOD_SYNCPOINT; 74 typedef unsigned int FMOD_MODE; 75 typedef unsigned int FMOD_TIMEUNIT; 76 typedef unsigned int FMOD_INITFLAGS; 77 typedef unsigned int FMOD_CAPS; 78 typedef unsigned int FMOD_DEBUGLEVEL; 79 typedef unsigned int FMOD_MEMORY_TYPE; 80 81 /* 82 [ENUM] 83 [ 84 [DESCRIPTION] 85 error codes. Returned from every function. 86 87 [REMARKS] 88 89 [PLATFORMS] 90 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 91 92 [SEE_ALSO] 93 ] 94 */ 95 typedef enum 96 { 97 FMOD_OK, /* No errors. */ 98 FMOD_ERR_ALREADYLOCKED, /* Tried to call lock a second time before unlock was called. */ 99 FMOD_ERR_BADCOMMAND, /* Tried to call a function on a data type that does not allow this type of functionality (ie calling Sound::lock on a streaming sound). */ 100 FMOD_ERR_CDDA_DRIVERS, /* Neither NTSCSI nor ASPI could be initialised. */ 101 FMOD_ERR_CDDA_INIT, /* An error occurred while initialising the CDDA subsystem. */ 102 FMOD_ERR_CDDA_INVALID_DEVICE, /* Couldn't find the specified device. */ 103 FMOD_ERR_CDDA_NOAUDIO, /* No audio tracks on the specified disc. */ 104 FMOD_ERR_CDDA_NODEVICES, /* No CD/DVD devices were found. */ 105 FMOD_ERR_CDDA_NODISC, /* No disc present in the specified drive. */ 106 FMOD_ERR_CDDA_READ, /* A CDDA read error occurred. */ 107 FMOD_ERR_CHANNEL_ALLOC, /* Error trying to allocate a channel. */ 108 FMOD_ERR_CHANNEL_STOLEN, /* The specified channel has been reused to play another sound. */ 109 FMOD_ERR_COM, /* A Win32 COM related error occured. COM failed to initialize or a QueryInterface failed meaning a Windows codec or driver was not installed properly. */ 110 FMOD_ERR_DMA, /* DMA Failure. See debug output for more information. */ 111 FMOD_ERR_DSP_CONNECTION, /* DSP connection error. Connection possibly caused a cyclic dependancy. Or tried to connect a tree too many units deep (more than 128). */ 112 FMOD_ERR_DSP_FORMAT, /* DSP Format error. A DSP unit may have attempted to connect to this network with the wrong format. */ 113 FMOD_ERR_DSP_NOTFOUND, /* DSP connection error. Couldn't find the DSP unit specified. */ 114 FMOD_ERR_DSP_RUNNING, /* DSP error. Cannot perform this operation while the network is in the middle of running. This will most likely happen if a connection or disconnection is attempted in a DSP callback. */ 115 FMOD_ERR_DSP_TOOMANYCONNECTIONS,/* DSP connection error. The unit being connected to or disconnected should only have 1 input or output. */ 116 FMOD_ERR_FILE_BAD, /* Error loading file. */ 117 FMOD_ERR_FILE_COULDNOTSEEK, /* Couldn't perform seek operation. This is a limitation of the medium (ie netstreams) or the file format. */ 118 FMOD_ERR_FILE_DISKEJECTED, /* Media was ejected while reading. */ 119 FMOD_ERR_FILE_EOF, /* End of file unexpectedly reached while trying to read essential data (truncated data?). */ 120 FMOD_ERR_FILE_NOTFOUND, /* File not found. */ 121 FMOD_ERR_FILE_UNWANTED, /* Unwanted file access occured. */ 122 FMOD_ERR_FORMAT, /* Unsupported file or audio format. */ 123 FMOD_ERR_HTTP, /* A HTTP error occurred. This is a catch-all for HTTP errors not listed elsewhere. */ 124 FMOD_ERR_HTTP_ACCESS, /* The specified resource requires authentication or is forbidden. */ 125 FMOD_ERR_HTTP_PROXY_AUTH, /* Proxy authentication is required to access the specified resource. */ 126 FMOD_ERR_HTTP_SERVER_ERROR, /* A HTTP server error occurred. */ 127 FMOD_ERR_HTTP_TIMEOUT, /* The HTTP request timed out. */ 128 FMOD_ERR_INITIALIZATION, /* FMOD was not initialized correctly to support this function. */ 129 FMOD_ERR_INITIALIZED, /* Cannot call this command after System::init. */ 130 FMOD_ERR_INTERNAL, /* An error occured that wasn't supposed to. Contact support. */ 131 FMOD_ERR_INVALID_ADDRESS, /* On Xbox 360, this memory address passed to FMOD must be physical, (ie allocated with XPhysicalAlloc.) */ 132 FMOD_ERR_INVALID_FLOAT, /* Value passed in was a NaN, Inf or denormalized float. */ 133 FMOD_ERR_INVALID_HANDLE, /* An invalid object handle was used. */ 134 FMOD_ERR_INVALID_PARAM, /* An invalid parameter was passed to this function. */ 135 FMOD_ERR_INVALID_POSITION, /* An invalid seek position was passed to this function. */ 136 FMOD_ERR_INVALID_SPEAKER, /* An invalid speaker was passed to this function based on the current speaker mode. */ 137 FMOD_ERR_INVALID_SYNCPOINT, /* The syncpoint did not come from this sound handle. */ 138 FMOD_ERR_INVALID_VECTOR, /* The vectors passed in are not unit length, or perpendicular. */ 139 FMOD_ERR_MAXAUDIBLE, /* Reached maximum audible playback count for this sound's soundgroup. */ 140 FMOD_ERR_MEMORY, /* Not enough memory or resources. */ 141 FMOD_ERR_MEMORY_CANTPOINT, /* Can't use FMOD_OPENMEMORY_POINT on non PCM source data, or non mp3/xma/adpcm data if FMOD_CREATECOMPRESSEDSAMPLE was used. */ 142 FMOD_ERR_MEMORY_SRAM, /* Not enough memory or resources on console sound ram. */ 143 FMOD_ERR_NEEDS2D, /* Tried to call a command on a 3d sound when the command was meant for 2d sound. */ 144 FMOD_ERR_NEEDS3D, /* Tried to call a command on a 2d sound when the command was meant for 3d sound. */ 145 FMOD_ERR_NEEDSHARDWARE, /* Tried to use a feature that requires hardware support. (ie trying to play a GCADPCM compressed sound in software on Wii). */ 146 FMOD_ERR_NEEDSSOFTWARE, /* Tried to use a feature that requires the software engine. Software engine has either been turned off, or command was executed on a hardware channel which does not support this feature. */ 147 FMOD_ERR_NET_CONNECT, /* Couldn't connect to the specified host. */ 148 FMOD_ERR_NET_SOCKET_ERROR, /* A socket error occurred. This is a catch-all for socket-related errors not listed elsewhere. */ 149 FMOD_ERR_NET_URL, /* The specified URL couldn't be resolved. */ 150 FMOD_ERR_NET_WOULD_BLOCK, /* Operation on a non-blocking socket could not complete immediately. */ 151 FMOD_ERR_NOTREADY, /* Operation could not be performed because specified sound/DSP connection is not ready. */ 152 FMOD_ERR_OUTPUT_ALLOCATED, /* Error initializing output device, but more specifically, the output device is already in use and cannot be reused. */ 153 FMOD_ERR_OUTPUT_CREATEBUFFER, /* Error creating hardware sound buffer. */ 154 FMOD_ERR_OUTPUT_DRIVERCALL, /* A call to a standard soundcard driver failed, which could possibly mean a bug in the driver or resources were missing or exhausted. */ 155 FMOD_ERR_OUTPUT_ENUMERATION, /* Error enumerating the available driver list. List may be inconsistent due to a recent device addition or removal. */ 156 FMOD_ERR_OUTPUT_FORMAT, /* Soundcard does not support the minimum features needed for this soundsystem (16bit stereo output). */ 157 FMOD_ERR_OUTPUT_INIT, /* Error initializing output device. */ 158 FMOD_ERR_OUTPUT_NOHARDWARE, /* FMOD_HARDWARE was specified but the sound card does not have the resources necessary to play it. */ 159 FMOD_ERR_OUTPUT_NOSOFTWARE, /* Attempted to create a software sound but no software channels were specified in System::init. */ 160 FMOD_ERR_PAN, /* Panning only works with mono or stereo sound sources. */ 161 FMOD_ERR_PLUGIN, /* An unspecified error has been returned from a 3rd party plugin. */ 162 FMOD_ERR_PLUGIN_INSTANCES, /* The number of allowed instances of a plugin has been exceeded. */ 163 FMOD_ERR_PLUGIN_MISSING, /* A requested output, dsp unit type or codec was not available. */ 164 FMOD_ERR_PLUGIN_RESOURCE, /* A resource that the plugin requires cannot be found. (ie the DLS file for MIDI playback or other DLLs that it needs to load) */ 165 FMOD_ERR_PRELOADED, /* The specified sound is still in use by the event system, call EventSystem::unloadFSB before trying to release it. */ 166 FMOD_ERR_PROGRAMMERSOUND, /* The specified sound is still in use by the event system, wait for the event which is using it finish with it. */ 167 FMOD_ERR_RECORD, /* An error occured trying to initialize the recording device. */ 168 FMOD_ERR_REVERB_INSTANCE, /* Specified instance in FMOD_REVERB_PROPERTIES couldn't be set. Most likely because it is an invalid instance number or the reverb doesnt exist. */ 169 FMOD_ERR_SUBSOUND_ALLOCATED, /* This subsound is already being used by another sound, you cannot have more than one parent to a sound. Null out the other parent's entry first. */ 170 FMOD_ERR_SUBSOUND_CANTMOVE, /* Shared subsounds cannot be replaced or moved from their parent stream, such as when the parent stream is an FSB file. */ 171 FMOD_ERR_SUBSOUND_MODE, /* The subsound's mode bits do not match with the parent sound's mode bits. See documentation for function that it was called with. */ 172 FMOD_ERR_SUBSOUNDS, /* The error occured because the sound referenced contains subsounds when it shouldn't have, or it doesn't contain subsounds when it should have. The operation may also not be able to be performed on a parent sound, or a parent sound was played without setting up a sentence first. */ 173 FMOD_ERR_TAGNOTFOUND, /* The specified tag could not be found or there are no tags. */ 174 FMOD_ERR_TOOMANYCHANNELS, /* The sound created exceeds the allowable input channel count. This can be increased using the maxinputchannels parameter in System::setSoftwareFormat. */ 175 FMOD_ERR_UNIMPLEMENTED, /* Something in FMOD hasn't been implemented when it should be! contact support! */ 176 FMOD_ERR_UNINITIALIZED, /* This command failed because System::init or System::setDriver was not called. */ 177 FMOD_ERR_UNSUPPORTED, /* A command issued was not supported by this object. Possibly a plugin without certain callbacks specified. */ 178 FMOD_ERR_UPDATE, /* An error caused by System::update occured. */ 179 FMOD_ERR_VERSION, /* The version number of this file format is not supported. */ 180 181 FMOD_ERR_EVENT_FAILED, /* An Event failed to be retrieved, most likely due to 'just fail' being specified as the max playbacks behavior. */ 182 FMOD_ERR_EVENT_INFOONLY, /* Can't execute this command on an EVENT_INFOONLY event. */ 183 FMOD_ERR_EVENT_INTERNAL, /* An error occured that wasn't supposed to. See debug log for reason. */ 184 FMOD_ERR_EVENT_MAXSTREAMS, /* Event failed because 'Max streams' was hit when FMOD_EVENT_INIT_FAIL_ON_MAXSTREAMS was specified. */ 185 FMOD_ERR_EVENT_MISMATCH, /* FSB mismatches the FEV it was compiled with, the stream/sample mode it was meant to be created with was different, or the FEV was built for a different platform. */ 186 FMOD_ERR_EVENT_NAMECONFLICT, /* A category with the same name already exists. */ 187 FMOD_ERR_EVENT_NOTFOUND, /* The requested event, event group, event category or event property could not be found. */ 188 FMOD_ERR_EVENT_NEEDSSIMPLE, /* Tried to call a function on a complex event that's only supported by simple events. */ 189 FMOD_ERR_EVENT_GUIDCONFLICT, /* An event with the same GUID already exists. */ 190 FMOD_ERR_EVENT_ALREADY_LOADED, /* The specified project or bank has already been loaded. Having multiple copies of the same project loaded simultaneously is forbidden. */ 191 192 FMOD_ERR_MUSIC_UNINITIALIZED, /* Music system is not initialized probably because no music data is loaded. */ 193 FMOD_ERR_MUSIC_NOTFOUND, /* The requested music entity could not be found. */ 194 FMOD_ERR_MUSIC_NOCALLBACK, /* The music callback is required, but it has not been set. */ 195 196 FMOD_RESULT_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 197 } FMOD_RESULT; 198 199 200 /* 201 [STRUCTURE] 202 [ 203 [DESCRIPTION] 204 Structure describing a point in 3D space. 205 206 [REMARKS] 207 FMOD uses a left handed co-ordinate system by default. 208 To use a right handed co-ordinate system specify FMOD_INIT_3D_RIGHTHANDED from FMOD_INITFLAGS in System::init. 209 210 [PLATFORMS] 211 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 212 213 [SEE_ALSO] 214 System::set3DListenerAttributes 215 System::get3DListenerAttributes 216 Channel::set3DAttributes 217 Channel::get3DAttributes 218 Channel::set3DCustomRolloff 219 Channel::get3DCustomRolloff 220 Sound::set3DCustomRolloff 221 Sound::get3DCustomRolloff 222 Geometry::addPolygon 223 Geometry::setPolygonVertex 224 Geometry::getPolygonVertex 225 Geometry::setRotation 226 Geometry::getRotation 227 Geometry::setPosition 228 Geometry::getPosition 229 Geometry::setScale 230 Geometry::getScale 231 FMOD_INITFLAGS 232 ] 233 */ 234 typedef struct 235 { 236 float x; /* X co-ordinate in 3D space. */ 237 float y; /* Y co-ordinate in 3D space. */ 238 float z; /* Z co-ordinate in 3D space. */ 239 } FMOD_VECTOR; 240 241 /* 242 [STRUCTURE] 243 [ 244 [DESCRIPTION] 245 Structure describing a globally unique identifier. 246 247 [REMARKS] 248 249 [PLATFORMS] 250 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 251 252 [SEE_ALSO] 253 System::getDriverInfo 254 ] 255 */ 256 typedef struct 257 { 258 unsigned int Data1; /* Specifies the first 8 hexadecimal digits of the GUID */ 259 unsigned short Data2; /* Specifies the first group of 4 hexadecimal digits. */ 260 unsigned short Data3; /* Specifies the second group of 4 hexadecimal digits. */ 261 unsigned char Data4[8]; /* Array of 8 bytes. The first 2 bytes contain the third group of 4 hexadecimal digits. The remaining 6 bytes contain the final 12 hexadecimal digits. */ 262 } FMOD_GUID; 263 264 /* 265 [STRUCTURE] 266 [ 267 [DESCRIPTION] 268 Structure that is passed into FMOD_FILE_ASYNCREADCALLBACK. Use the information in this structure to perform 269 270 [REMARKS] 271 Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value. 272 Members marked with [w] mean the variable can be written to. The user can set the value. 273 274 Instructions: write to 'buffer', and 'bytesread' <b>BEFORE</b> setting 'result'. 275 As soon as result is set, FMOD will asynchronously continue internally using the data provided in this structure. 276 277 Set 'result' to the result expected from a normal file read callback. 278 If the read was successful, set it to FMOD_OK. 279 If it read some data but hit the end of the file, set it to FMOD_ERR_FILE_EOF. 280 If a bad error occurred, return FMOD_ERR_FILE_BAD 281 If a disk was ejected, return FMOD_ERR_FILE_DISKEJECTED. 282 283 [PLATFORMS] 284 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 285 286 [SEE_ALSO] 287 FMOD_FILE_ASYNCREADCALLBACK 288 FMOD_FILE_ASYNCCANCELCALLBACK 289 ] 290 */ 291 typedef struct 292 { 293 void *handle; /* [r] The file handle that was filled out in the open callback. */ 294 unsigned int offset; /* [r] Seek position, make sure you read from this file offset. */ 295 unsigned int sizebytes; /* [r] how many bytes requested for read. */ 296 int priority; /* [r] 0 = low importance. 100 = extremely important (ie 'must read now or stuttering may occur') */ 297 298 void *buffer; /* [w] Buffer to read file data into. */ 299 unsigned int bytesread; /* [w] Fill this in before setting result code to tell FMOD how many bytes were read. */ 300 FMOD_RESULT result; /* [r/w] Result code, FMOD_OK tells the system it is ready to consume the data. Set this last! Default value = FMOD_ERR_NOTREADY. */ 301 302 void *userdata; /* [r] User data pointer. */ 303 } FMOD_ASYNCREADINFO; 304 305 306 /* 307 [ENUM] 308 [ 309 [DESCRIPTION] 310 These output types are used with System::setOutput / System::getOutput, to choose which output method to use. 311 312 [REMARKS] 313 To pass information to the driver when initializing fmod use the extradriverdata parameter in System::init for the following reasons. 314 - FMOD_OUTPUTTYPE_WAVWRITER - extradriverdata is a pointer to a char * filename that the wav writer will output to. 315 - FMOD_OUTPUTTYPE_WAVWRITER_NRT - extradriverdata is a pointer to a char * filename that the wav writer will output to. 316 - FMOD_OUTPUTTYPE_DSOUND - extradriverdata is a pointer to a HWND so that FMOD can set the focus on the audio for a particular window. 317 - FMOD_OUTPUTTYPE_PS3 - extradriverdata is a pointer to a FMOD_PS3_EXTRADRIVERDATA struct. This can be found in fmodps3.h. 318 - FMOD_OUTPUTTYPE_GC - extradriverdata is a pointer to a FMOD_GC_INFO struct. This can be found in fmodgc.h. 319 - FMOD_OUTPUTTYPE_WII - extradriverdata is a pointer to a FMOD_WII_INFO struct. This can be found in fmodwii.h. 320 - FMOD_OUTPUTTYPE_ALSA - extradriverdata is a pointer to a FMOD_LINUX_EXTRADRIVERDATA struct. This can be found in fmodlinux.h. 321 322 Currently these are the only FMOD drivers that take extra information. Other unknown plugins may have different requirements. 323 324 Note! If FMOD_OUTPUTTYPE_WAVWRITER_NRT or FMOD_OUTPUTTYPE_NOSOUND_NRT are used, and if the System::update function is being called 325 very quickly (ie for a non realtime decode) it may be being called too quickly for the FMOD streamer thread to respond to. 326 The result will be a skipping/stuttering output in the captured audio. 327 328 To remedy this, disable the FMOD Ex streamer thread, and use FMOD_INIT_STREAM_FROM_UPDATE to avoid skipping in the output stream, 329 as it will lock the mixer and the streamer together in the same thread. 330 331 [PLATFORMS] 332 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 333 334 [SEE_ALSO] 335 System::setOutput 336 System::getOutput 337 System::setSoftwareFormat 338 System::getSoftwareFormat 339 System::init 340 System::update 341 FMOD_INITFLAGS 342 ] 343 */ 344 typedef enum 345 { 346 FMOD_OUTPUTTYPE_AUTODETECT, /* Picks the best output mode for the platform. This is the default. */ 347 348 FMOD_OUTPUTTYPE_UNKNOWN, /* All - 3rd party plugin, unknown. This is for use with System::getOutput only. */ 349 FMOD_OUTPUTTYPE_NOSOUND, /* All - All calls in this mode succeed but make no sound. */ 350 FMOD_OUTPUTTYPE_WAVWRITER, /* All - Writes output to fmodoutput.wav by default. Use the 'extradriverdata' parameter in System::init, by simply passing the filename as a string, to set the wav filename. */ 351 FMOD_OUTPUTTYPE_NOSOUND_NRT, /* All - Non-realtime version of FMOD_OUTPUTTYPE_NOSOUND. User can drive mixer with System::update at whatever rate they want. */ 352 FMOD_OUTPUTTYPE_WAVWRITER_NRT, /* All - Non-realtime version of FMOD_OUTPUTTYPE_WAVWRITER. User can drive mixer with System::update at whatever rate they want. */ 353 354 FMOD_OUTPUTTYPE_DSOUND, /* Win32/Win64 - DirectSound output. (Default on Windows XP and below) */ 355 FMOD_OUTPUTTYPE_WINMM, /* Win32/Win64 - Windows Multimedia output. */ 356 FMOD_OUTPUTTYPE_WASAPI, /* Win32 - Windows Audio Session API. (Default on Windows Vista and above) */ 357 FMOD_OUTPUTTYPE_ASIO, /* Win32 - Low latency ASIO 2.0 driver. */ 358 FMOD_OUTPUTTYPE_OSS, /* Linux/Linux64 - Open Sound System output. (Default on Linux, third preference) */ 359 FMOD_OUTPUTTYPE_ALSA, /* Linux/Linux64 - Advanced Linux Sound Architecture output. (Default on Linux, second preference if available) */ 360 FMOD_OUTPUTTYPE_ESD, /* Linux/Linux64 - Enlightment Sound Daemon output. */ 361 FMOD_OUTPUTTYPE_PULSEAUDIO, /* Linux/Linux64 - PulseAudio output. (Default on Linux, first preference if available) */ 362 FMOD_OUTPUTTYPE_COREAUDIO, /* Mac - Macintosh CoreAudio output. (Default on Mac) */ 363 FMOD_OUTPUTTYPE_XBOX360, /* Xbox 360 - Native Xbox360 output. (Default on Xbox 360) */ 364 FMOD_OUTPUTTYPE_PSP, /* PSP - Native PSP output. (Default on PSP) */ 365 FMOD_OUTPUTTYPE_PS3, /* PS3 - Native PS3 output. (Default on PS3) */ 366 FMOD_OUTPUTTYPE_NGP, /* NGP - Native NGP output. (Default on NGP) */ 367 FMOD_OUTPUTTYPE_WII, /* Wii - Native Wii output. (Default on Wii) */ 368 FMOD_OUTPUTTYPE_3DS, /* 3DS - Native 3DS output (Default on 3DS) */ 369 FMOD_OUTPUTTYPE_AUDIOTRACK, /* Android - Java Audio Track output. (Default on Android 2.2 and below) */ 370 FMOD_OUTPUTTYPE_OPENSL, /* Android - OpenSL ES output. (Default on Android 2.3 and above) */ 371 FMOD_OUTPUTTYPE_NACL, /* Native Client - Native Client output. (Default on Native Client) */ 372 FMOD_OUTPUTTYPE_WIIU, /* Wii U - Native Wii U output. (Default on Wii U) */ 373 FMOD_OUTPUTTYPE_ASOUND, /* BlackBerry - Native BlackBerry asound output. (Default on BlackBerry) */ 374 375 FMOD_OUTPUTTYPE_MAX, /* Maximum number of output types supported. */ 376 FMOD_OUTPUTTYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 377 } FMOD_OUTPUTTYPE; 378 379 380 /* 381 [DEFINE] 382 [ 383 [NAME] 384 FMOD_CAPS 385 386 [DESCRIPTION] 387 Bit fields to use with System::getDriverCaps to determine the capabilities of a card / output device. 388 389 [REMARKS] 390 It is important to check FMOD_CAPS_HARDWARE_EMULATED on windows machines, to then adjust System::setDSPBufferSize to (1024, 10) to compensate for the higher latency. 391 392 [PLATFORMS] 393 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 394 395 [SEE_ALSO] 396 System::getDriverCaps 397 System::setDSPBufferSize 398 ] 399 */ 400 #define FMOD_CAPS_NONE 0x00000000 /* Device has no special capabilities. */ 401 #define FMOD_CAPS_HARDWARE 0x00000001 /* Device supports hardware mixing. */ 402 #define FMOD_CAPS_HARDWARE_EMULATED 0x00000002 /* User has device set to 'Hardware acceleration = off' in control panel, and now extra 200ms latency is incurred. */ 403 #define FMOD_CAPS_OUTPUT_MULTICHANNEL 0x00000004 /* Device can do multichannel output, ie greater than 2 channels. */ 404 #define FMOD_CAPS_OUTPUT_FORMAT_PCM8 0x00000008 /* Device can output to 8bit integer PCM. */ 405 #define FMOD_CAPS_OUTPUT_FORMAT_PCM16 0x00000010 /* Device can output to 16bit integer PCM. */ 406 #define FMOD_CAPS_OUTPUT_FORMAT_PCM24 0x00000020 /* Device can output to 24bit integer PCM. */ 407 #define FMOD_CAPS_OUTPUT_FORMAT_PCM32 0x00000040 /* Device can output to 32bit integer PCM. */ 408 #define FMOD_CAPS_OUTPUT_FORMAT_PCMFLOAT 0x00000080 /* Device can output to 32bit floating point PCM. */ 409 #define FMOD_CAPS_REVERB_LIMITED 0x00002000 /* Device supports some form of limited hardware reverb, maybe parameterless and only selectable by environment. */ 410 #define FMOD_CAPS_LOOPBACK 0x00004000 /* Device is a loopback recording device */ 411 /* [DEFINE_END] */ 412 413 /* 414 [DEFINE] 415 [ 416 [NAME] 417 FMOD_DEBUGLEVEL 418 419 [DESCRIPTION] 420 Bit fields to use with FMOD::Debug_SetLevel / FMOD::Debug_GetLevel to control the level of tty debug output with logging versions of FMOD (fmodL). 421 422 [REMARKS] 423 424 [PLATFORMS] 425 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 426 427 [SEE_ALSO] 428 Debug_SetLevel 429 Debug_GetLevel 430 ] 431 */ 432 #define FMOD_DEBUG_LEVEL_NONE 0x00000000 433 #define FMOD_DEBUG_LEVEL_LOG 0x00000001 /* Will display generic logging messages. */ 434 #define FMOD_DEBUG_LEVEL_ERROR 0x00000002 /* Will display errors. */ 435 #define FMOD_DEBUG_LEVEL_WARNING 0x00000004 /* Will display warnings that are not fatal. */ 436 #define FMOD_DEBUG_LEVEL_HINT 0x00000008 /* Will hint to you if there is something possibly better you could be doing. */ 437 #define FMOD_DEBUG_LEVEL_ALL 0x000000FF 438 #define FMOD_DEBUG_TYPE_MEMORY 0x00000100 /* Show FMOD memory related logging messages. */ 439 #define FMOD_DEBUG_TYPE_THREAD 0x00000200 /* Show FMOD thread related logging messages. */ 440 #define FMOD_DEBUG_TYPE_FILE 0x00000400 /* Show FMOD file system related logging messages. */ 441 #define FMOD_DEBUG_TYPE_NET 0x00000800 /* Show FMOD network related logging messages. */ 442 #define FMOD_DEBUG_TYPE_EVENT 0x00001000 /* Show FMOD Event related logging messages. */ 443 #define FMOD_DEBUG_TYPE_ALL 0x0000FFFF 444 #define FMOD_DEBUG_DISPLAY_TIMESTAMPS 0x01000000 /* Display the timestamp of the log entry in milliseconds. */ 445 #define FMOD_DEBUG_DISPLAY_LINENUMBERS 0x02000000 /* Display the FMOD Ex source code line numbers, for debugging purposes. */ 446 #define FMOD_DEBUG_DISPLAY_COMPRESS 0x04000000 /* If a message is repeated more than 5 times it will stop displaying it and instead display the number of times the message was logged. */ 447 #define FMOD_DEBUG_DISPLAY_THREAD 0x08000000 /* Display the thread ID of the calling function that caused this log entry to appear. */ 448 #define FMOD_DEBUG_DISPLAY_ALL 0x0F000000 449 #define FMOD_DEBUG_ALL 0xFFFFFFFF 450 /* [DEFINE_END] */ 451 452 453 /* 454 [DEFINE] 455 [ 456 [NAME] 457 FMOD_MEMORY_TYPE 458 459 [DESCRIPTION] 460 Bit fields for memory allocation type being passed into FMOD memory callbacks. 461 462 [REMARKS] 463 Remember this is a bitfield. You may get more than 1 bit set (ie physical + persistent) so do not simply switch on the types! You must check each bit individually or clear out the bits that you do not want within the callback. 464 Bits can be excluded if you want during Memory_Initialize so that you never get them. 465 466 [PLATFORMS] 467 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 468 469 [SEE_ALSO] 470 FMOD_MEMORY_ALLOCCALLBACK 471 FMOD_MEMORY_REALLOCCALLBACK 472 FMOD_MEMORY_FREECALLBACK 473 Memory_Initialize 474 475 ] 476 */ 477 #define FMOD_MEMORY_NORMAL 0x00000000 /* Standard memory. */ 478 #define FMOD_MEMORY_STREAM_FILE 0x00000001 /* Stream file buffer, size controllable with System::setStreamBufferSize. */ 479 #define FMOD_MEMORY_STREAM_DECODE 0x00000002 /* Stream decode buffer, size controllable with FMOD_CREATESOUNDEXINFO::decodebuffersize. */ 480 #define FMOD_MEMORY_SAMPLEDATA 0x00000004 /* Sample data buffer. Raw audio data, usually PCM/MPEG/ADPCM/XMA data. */ 481 #define FMOD_MEMORY_DSP_OUTPUTBUFFER 0x00000008 /* DSP memory block allocated when more than 1 output exists on a DSP node. */ 482 #define FMOD_MEMORY_XBOX360_PHYSICAL 0x00100000 /* Requires XPhysicalAlloc / XPhysicalFree. */ 483 #define FMOD_MEMORY_PERSISTENT 0x00200000 /* Persistent memory. Memory will be freed when System::release is called. */ 484 #define FMOD_MEMORY_SECONDARY 0x00400000 /* Secondary memory. Allocation should be in secondary memory. For example RSX on the PS3. */ 485 #define FMOD_MEMORY_ALL 0xFFFFFFFF 486 /* [DEFINE_END] */ 487 488 489 /* 490 [ENUM] 491 [ 492 [DESCRIPTION] 493 These are speaker types defined for use with the System::setSpeakerMode or System::getSpeakerMode command. 494 495 [REMARKS] 496 These are important notes on speaker modes in regards to sounds created with FMOD_SOFTWARE. 497 Note below the phrase 'sound channels' is used. These are the subchannels inside a sound, they are not related and 498 have nothing to do with the FMOD class "Channel". 499 For example a mono sound has 1 sound channel, a stereo sound has 2 sound channels, and an AC3 or 6 channel wav file have 6 "sound channels". 500 501 FMOD_SPEAKERMODE_RAW 502 --------------------- 503 This mode is for output devices that are not specifically mono/stereo/quad/surround/5.1 or 7.1, but are multichannel. 504 Use System::setSoftwareFormat to specify the number of speakers you want to address, otherwise it will default to 2 (stereo). 505 Sound channels map to speakers sequentially, so a mono sound maps to output speaker 0, stereo sound maps to output speaker 0 & 1. 506 The user assumes knowledge of the speaker order. FMOD_SPEAKER enumerations may not apply, so raw channel indices should be used. 507 Multichannel sounds map input channels to output channels 1:1. 508 Channel::setPan and Channel::setSpeakerMix do not work. 509 Speaker levels must be manually set with Channel::setSpeakerLevels. 510 511 FMOD_SPEAKERMODE_MONO 512 --------------------- 513 This mode is for a 1 speaker arrangement. 514 Panning does not work in this speaker mode. 515 Mono, stereo and multichannel sounds have each sound channel played on the one speaker unity. 516 Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels. 517 Channel::setSpeakerMix does not work. 518 519 FMOD_SPEAKERMODE_STEREO 520 ----------------------- 521 This mode is for 2 speaker arrangements that have a left and right speaker. 522 - Mono sounds default to an even distribution between left and right. They can be panned with Channel::setPan. 523 - Stereo sounds default to the middle, or full left in the left speaker and full right in the right speaker. 524 - They can be cross faded with Channel::setPan. 525 - Multichannel sounds have each sound channel played on each speaker at unity. 526 - Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels. 527 - Channel::setSpeakerMix works but only front left and right parameters are used, the rest are ignored. 528 529 FMOD_SPEAKERMODE_QUAD 530 ------------------------ 531 This mode is for 4 speaker arrangements that have a front left, front right, rear left and a rear right speaker. 532 - Mono sounds default to an even distribution between front left and front right. They can be panned with Channel::setPan. 533 - Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right. 534 - They can be cross faded with Channel::setPan. 535 - Multichannel sounds default to all of their sound channels being played on each speaker in order of input. 536 - Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels. 537 - Channel::setSpeakerMix works but side left, side right, center and lfe are ignored. 538 539 FMOD_SPEAKERMODE_SURROUND 540 ------------------------ 541 This mode is for 5 speaker arrangements that have a left/right/center/rear left/rear right. 542 - Mono sounds default to the center speaker. They can be panned with Channel::setPan. 543 - Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right. 544 - They can be cross faded with Channel::setPan. 545 - Multichannel sounds default to all of their sound channels being played on each speaker in order of input. 546 - Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels. 547 - Channel::setSpeakerMix works but side left / side right are ignored. 548 549 FMOD_SPEAKERMODE_5POINT1 550 ------------------------ 551 This mode is for 5.1 speaker arrangements that have a left/right/center/rear left/rear right and a subwoofer speaker. 552 - Mono sounds default to the center speaker. They can be panned with Channel::setPan. 553 - Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right. 554 - They can be cross faded with Channel::setPan. 555 - Multichannel sounds default to all of their sound channels being played on each speaker in order of input. 556 - Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels. 557 - Channel::setSpeakerMix works but side left / side right are ignored. 558 559 FMOD_SPEAKERMODE_7POINT1 560 ------------------------ 561 This mode is for 7.1 speaker arrangements that have a left/right/center/rear left/rear right/side left/side right 562 and a subwoofer speaker. 563 - Mono sounds default to the center speaker. They can be panned with Channel::setPan. 564 - Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right. 565 - They can be cross faded with Channel::setPan. 566 - Multichannel sounds default to all of their sound channels being played on each speaker in order of input. 567 - Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels. 568 - Channel::setSpeakerMix works and every parameter is used to set the balance of a sound in any speaker. 569 570 FMOD_SPEAKERMODE_SRS5_1_MATRIX 571 ------------------------------------------------------ 572 This mode is for mono, stereo, 5.1 and 6.1 speaker arrangements, as it is backwards and forwards compatible with 573 stereo, but to get a surround effect a SRS 5.1, Prologic or Prologic 2 hardware decoder / amplifier is needed or 574 a compatible SRS equipped device (e.g., laptop, TV, etc.) or accessory (e.g., headphone). 575 Pan behavior is the same as FMOD_SPEAKERMODE_5POINT1. 576 577 If this function is called the numoutputchannels setting in System::setSoftwareFormat is overwritten. 578 579 Output rate must be 44100, 48000 or 96000 for this to work otherwise FMOD_ERR_OUTPUT_INIT will be returned. 580 581 FMOD_SPEAKERMODE_DOLBY5_1_MATRIX 582 ------------------------------------------------------ 583 This mode is for 5.1 speaker arrangements using a stereo signal, to get a surround effect a Dolby Pro Logic II 584 hardware decoder / amplifier is needed. 585 Pan behavior is the same as FMOD_SPEAKERMODE_5POINT1. 586 587 If this function is called the numoutputchannels setting in System::setSoftwareFormat is overwritten. 588 589 Output rate must be 32000, 44100 or 48000 for this to work otherwise FMOD_ERR_OUTPUT_INIT will be returned. 590 591 FMOD_SPEAKERMODE_MYEARS 592 ------------------------------------------------------ 593 This mode is for headphones. This will attempt to load a MyEars profile (see myears.net.au) and use it to generate 594 surround sound on headphones using a personalized HRTF algorithm, for realistic 3d sound. 595 Pan behavior is the same as FMOD_SPEAKERMODE_7POINT1. 596 MyEars speaker mode will automatically be set if the speakermode is FMOD_SPEAKERMODE_STEREO and the MyEars profile exists. 597 If this mode is set explicitly, FMOD_INIT_DISABLE_MYEARS_AUTODETECT has no effect. 598 If this mode is set explicitly and the MyEars profile does not exist, FMOD_ERR_OUTPUT_DRIVERCALL will be returned. 599 600 [PLATFORMS] 601 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 602 603 [SEE_ALSO] 604 System::setSpeakerMode 605 System::getSpeakerMode 606 System::getDriverCaps 607 System::setSoftwareFormat 608 Channel::setSpeakerLevels 609 ] 610 */ 611 typedef enum 612 { 613 FMOD_SPEAKERMODE_RAW, /* There is no specific speakermode. Sound channels are mapped in order of input to output. Use System::setSoftwareFormat to specify speaker count. See remarks for more information. */ 614 FMOD_SPEAKERMODE_MONO, /* The speakers are monaural. */ 615 FMOD_SPEAKERMODE_STEREO, /* The speakers are stereo (DEFAULT). */ 616 FMOD_SPEAKERMODE_QUAD, /* 4 speaker setup. This includes front left, front right, rear left, rear right. */ 617 FMOD_SPEAKERMODE_SURROUND, /* 5 speaker setup. This includes front left, front right, center, rear left, rear right. */ 618 FMOD_SPEAKERMODE_5POINT1, /* 5.1 speaker setup. This includes front left, front right, center, rear left, rear right and a subwoofer. */ 619 FMOD_SPEAKERMODE_7POINT1, /* 7.1 speaker setup. This includes front left, front right, center, rear left, rear right, side left, side right and a subwoofer. */ 620 621 FMOD_SPEAKERMODE_SRS5_1_MATRIX, /* Stereo compatible output, embedded with surround information. SRS 5.1/Prologic/Prologic2 decoders will split the signal into a 5.1 speaker set-up or SRS virtual surround will decode into a 2-speaker/headphone setup. See remarks about limitations.*/ 622 FMOD_SPEAKERMODE_DOLBY5_1_MATRIX, /* Stereo compatible output, embedded with surround information. Dolby Pro Logic II decoders will split the signal into a 5.1 speaker set-up. */ 623 FMOD_SPEAKERMODE_MYEARS, /* Stereo output, but data is encoded using personalized HRTF algorithms. See myears.net.au */ 624 625 FMOD_SPEAKERMODE_MAX, /* Maximum number of speaker modes supported. */ 626 FMOD_SPEAKERMODE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 627 } FMOD_SPEAKERMODE; 628 629 630 /* 631 [ENUM] 632 [ 633 [DESCRIPTION] 634 These are speaker types defined for use with the Channel::setSpeakerLevels command. 635 It can also be used for speaker placement in the System::set3DSpeakerPosition command. 636 637 [REMARKS] 638 If you are using FMOD_SPEAKERMODE_RAW and speaker assignments are meaningless, just cast a raw integer value to this type. 639 For example (FMOD_SPEAKER)7 would use the 7th speaker (also the same as FMOD_SPEAKER_SIDE_RIGHT). 640 Values higher than this can be used if an output system has more than 8 speaker types / output channels. 15 is the current maximum. 641 642 NOTE: On Playstation 3 in 7.1, the extra 2 speakers are not side left/side right, they are 'surround back left'/'surround back right' which 643 locate the speakers behind the listener instead of to the sides like on PC. FMOD_SPEAKER_SBL/FMOD_SPEAKER_SBR are provided to make it 644 clearer what speaker is being addressed on that platform. 645 646 [PLATFORMS] 647 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 648 649 [SEE_ALSO] 650 FMOD_SPEAKERMODE 651 Channel::setSpeakerLevels 652 Channel::getSpeakerLevels 653 System::set3DSpeakerPosition 654 System::get3DSpeakerPosition 655 ] 656 */ 657 typedef enum 658 { 659 FMOD_SPEAKER_FRONT_LEFT, 660 FMOD_SPEAKER_FRONT_RIGHT, 661 FMOD_SPEAKER_FRONT_CENTER, 662 FMOD_SPEAKER_LOW_FREQUENCY, 663 FMOD_SPEAKER_BACK_LEFT, 664 FMOD_SPEAKER_BACK_RIGHT, 665 FMOD_SPEAKER_SIDE_LEFT, 666 FMOD_SPEAKER_SIDE_RIGHT, 667 668 FMOD_SPEAKER_MAX, /* Maximum number of speaker types supported. */ 669 FMOD_SPEAKER_MONO = FMOD_SPEAKER_FRONT_LEFT, /* For use with FMOD_SPEAKERMODE_MONO and Channel::SetSpeakerLevels. Mapped to same value as FMOD_SPEAKER_FRONT_LEFT. */ 670 FMOD_SPEAKER_NULL = 65535, /* A non speaker. Use this with ASIO mapping to ignore a speaker. */ 671 FMOD_SPEAKER_SBL = FMOD_SPEAKER_SIDE_LEFT, /* For use with FMOD_SPEAKERMODE_7POINT1 on PS3 where the extra speakers are surround back inside of side speakers. */ 672 FMOD_SPEAKER_SBR = FMOD_SPEAKER_SIDE_RIGHT, /* For use with FMOD_SPEAKERMODE_7POINT1 on PS3 where the extra speakers are surround back inside of side speakers. */ 673 FMOD_SPEAKER_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 674 } FMOD_SPEAKER; 675 676 677 /* 678 [ENUM] 679 [ 680 [DESCRIPTION] 681 These are plugin types defined for use with the System::getNumPlugins, 682 System::getPluginInfo and System::unloadPlugin functions. 683 684 [REMARKS] 685 686 [PLATFORMS] 687 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 688 689 [SEE_ALSO] 690 System::getNumPlugins 691 System::getPluginInfo 692 System::unloadPlugin 693 ] 694 */ 695 typedef enum 696 { 697 FMOD_PLUGINTYPE_OUTPUT, /* The plugin type is an output module. FMOD mixed audio will play through one of these devices */ 698 FMOD_PLUGINTYPE_CODEC, /* The plugin type is a file format codec. FMOD will use these codecs to load file formats for playback. */ 699 FMOD_PLUGINTYPE_DSP, /* The plugin type is a DSP unit. FMOD will use these plugins as part of its DSP network to apply effects to output or generate sound in realtime. */ 700 701 FMOD_PLUGINTYPE_MAX, /* Maximum number of plugin types supported. */ 702 FMOD_PLUGINTYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 703 } FMOD_PLUGINTYPE; 704 705 706 /* 707 [DEFINE] 708 [ 709 [NAME] 710 FMOD_INITFLAGS 711 712 [DESCRIPTION] 713 Initialization flags. Use them with System::init in the flags parameter to change various behavior. 714 715 [REMARKS] 716 Use System::setAdvancedSettings to adjust settings for some of the features that are enabled by these flags. 717 718 [PLATFORMS] 719 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 720 721 [SEE_ALSO] 722 System::init 723 System::update 724 System::setAdvancedSettings 725 Channel::set3DOcclusion 726 ] 727 */ 728 #define FMOD_INIT_NORMAL 0x00000000 /* All platforms - Initialize normally */ 729 #define FMOD_INIT_STREAM_FROM_UPDATE 0x00000001 /* All platforms - No stream thread is created internally. Streams are driven from System::update. Mainly used with non-realtime outputs. */ 730 #define FMOD_INIT_3D_RIGHTHANDED 0x00000002 /* All platforms - FMOD will treat +X as right, +Y as up and +Z as backwards (towards you). */ 731 #define FMOD_INIT_SOFTWARE_DISABLE 0x00000004 /* All platforms - Disable software mixer to save memory. Anything created with FMOD_SOFTWARE will fail and DSP will not work. */ 732 #define FMOD_INIT_OCCLUSION_LOWPASS 0x00000008 /* All platforms - All FMOD_SOFTWARE (and FMOD_HARDWARE on 3DS and NGP) with FMOD_3D based voices will add a software lowpass filter effect into the DSP chain which is automatically used when Channel::set3DOcclusion is used or the geometry API. */ 733 #define FMOD_INIT_HRTF_LOWPASS 0x00000010 /* All platforms - All FMOD_SOFTWARE (and FMOD_HARDWARE on 3DS and NGP) with FMOD_3D based voices will add a software lowpass filter effect into the DSP chain which causes sounds to sound duller when the sound goes behind the listener. Use System::setAdvancedSettings to adjust cutoff frequency. */ 734 #define FMOD_INIT_DISTANCE_FILTERING 0x00000200 /* All platforms - All FMOD_SOFTWARE with FMOD_3D based voices will add a software lowpass and highpass filter effect into the DSP chain which will act as a distance-automated bandpass filter. Use System::setAdvancedSettings to adjust the center frequency. */ 735 #define FMOD_INIT_REVERB_PREALLOCBUFFERS 0x00000040 /* All platforms - FMOD Software reverb will preallocate enough buffers for reverb per channel, rather than allocating them and freeing them at runtime. */ 736 #define FMOD_INIT_ENABLE_PROFILE 0x00000020 /* All platforms - Enable TCP/IP based host which allows FMOD Designer or FMOD Profiler to connect to it, and view memory, CPU and the DSP network graph in real-time. */ 737 #define FMOD_INIT_VOL0_BECOMES_VIRTUAL 0x00000080 /* All platforms - Any sounds that are 0 volume will go virtual and not be processed except for having their positions updated virtually. Use System::setAdvancedSettings to adjust what volume besides zero to switch to virtual at. */ 738 #define FMOD_INIT_WASAPI_EXCLUSIVE 0x00000100 /* Win32 Vista only - for WASAPI output - Enable exclusive access to hardware, lower latency at the expense of excluding other applications from accessing the audio hardware. */ 739 #define FMOD_INIT_PS3_PREFERDTS 0x00800000 /* PS3 only - Prefer DTS over Dolby Digital if both are supported. Note: 8 and 6 channel LPCM is always preferred over both DTS and Dolby Digital. */ 740 #define FMOD_INIT_PS3_FORCE2CHLPCM 0x01000000 /* PS3 only - Force PS3 system output mode to 2 channel LPCM. */ 741 #define FMOD_INIT_DISABLEDOLBY 0x00100000 /* Wii / 3DS - Disable Dolby Pro Logic surround. Speakermode will be set to STEREO even if user has selected surround in the system settings. */ 742 #define FMOD_INIT_SYSTEM_MUSICMUTENOTPAUSE 0x00200000 /* Xbox 360 / PS3 - The "music" channelgroup which by default pauses when custom 360 dashboard / PS3 BGM music is played, can be changed to mute (therefore continues playing) instead of pausing, by using this flag. */ 743 #define FMOD_INIT_SYNCMIXERWITHUPDATE 0x00400000 /* Win32/Wii/PS3/Xbox/Xbox 360 - FMOD Mixer thread is woken up to do a mix when System::update is called rather than waking periodically on its own timer. */ 744 #define FMOD_INIT_GEOMETRY_USECLOSEST 0x04000000 /* All platforms - With the geometry engine, only process the closest polygon rather than accumulating all polygons the sound to listener line intersects. */ 745 #define FMOD_INIT_DISABLE_MYEARS_AUTODETECT 0x08000000 /* Win32 - Disables automatic setting of FMOD_SPEAKERMODE_STEREO to FMOD_SPEAKERMODE_MYEARS if the MyEars profile exists on the PC. MyEars is HRTF 7.1 downmixing through headphones. */ 746 #define FMOD_INIT_PS3_DISABLEDTS 0x10000000 /* PS3 only - Disable DTS output mode selection */ 747 #define FMOD_INIT_PS3_DISABLEDOLBYDIGITAL 0x20000000 /* PS3 only - Disable Dolby Digital output mode selection */ 748 /* [DEFINE_END] */ 749 750 751 /* 752 [ENUM] 753 [ 754 [DESCRIPTION] 755 These definitions describe the type of song being played. 756 757 [REMARKS] 758 759 [PLATFORMS] 760 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 761 762 [SEE_ALSO] 763 Sound::getFormat 764 ] 765 */ 766 typedef enum 767 { 768 FMOD_SOUND_TYPE_UNKNOWN, /* 3rd party / unknown plugin format. */ 769 FMOD_SOUND_TYPE_AIFF, /* AIFF. */ 770 FMOD_SOUND_TYPE_ASF, /* Microsoft Advanced Systems Format (ie WMA/ASF/WMV). */ 771 FMOD_SOUND_TYPE_AT3, /* Sony ATRAC 3 format */ 772 FMOD_SOUND_TYPE_CDDA, /* Digital CD audio. */ 773 FMOD_SOUND_TYPE_DLS, /* Sound font / downloadable sound bank. */ 774 FMOD_SOUND_TYPE_FLAC, /* FLAC lossless codec. */ 775 FMOD_SOUND_TYPE_FSB, /* FMOD Sample Bank. */ 776 FMOD_SOUND_TYPE_GCADPCM, /* Nintendo GameCube/Wii ADPCM */ 777 FMOD_SOUND_TYPE_IT, /* Impulse Tracker. */ 778 FMOD_SOUND_TYPE_MIDI, /* MIDI. extracodecdata is a pointer to an FMOD_MIDI_EXTRACODECDATA structure. */ 779 FMOD_SOUND_TYPE_MOD, /* Protracker / Fasttracker MOD. */ 780 FMOD_SOUND_TYPE_MPEG, /* MP2/MP3 MPEG. */ 781 FMOD_SOUND_TYPE_OGGVORBIS, /* Ogg vorbis. */ 782 FMOD_SOUND_TYPE_PLAYLIST, /* Information only from ASX/PLS/M3U/WAX playlists */ 783 FMOD_SOUND_TYPE_RAW, /* Raw PCM data. */ 784 FMOD_SOUND_TYPE_S3M, /* ScreamTracker 3. */ 785 FMOD_SOUND_TYPE_SF2, /* Sound font 2 format. */ 786 FMOD_SOUND_TYPE_USER, /* User created sound. */ 787 FMOD_SOUND_TYPE_WAV, /* Microsoft WAV. */ 788 FMOD_SOUND_TYPE_XM, /* FastTracker 2 XM. */ 789 FMOD_SOUND_TYPE_XMA, /* Xbox360 XMA */ 790 FMOD_SOUND_TYPE_VAG, /* PlayStation Portable ADPCM VAG format. */ 791 FMOD_SOUND_TYPE_AUDIOQUEUE, /* iPhone hardware decoder, supports AAC, ALAC and MP3. extracodecdata is a pointer to an FMOD_AUDIOQUEUE_EXTRACODECDATA structure. */ 792 FMOD_SOUND_TYPE_XWMA, /* Xbox360 XWMA */ 793 FMOD_SOUND_TYPE_BCWAV, /* 3DS BCWAV container format for DSP ADPCM and PCM */ 794 FMOD_SOUND_TYPE_AT9, /* NGP ATRAC 9 format */ 795 FMOD_SOUND_TYPE_VORBIS, /* Raw vorbis */ 796 FMOD_SOUND_TYPE_MEDIA_FOUNDATION,/* Microsoft Media Foundation wrappers, supports ASF/WMA */ 797 798 FMOD_SOUND_TYPE_MAX, /* Maximum number of sound types supported. */ 799 FMOD_SOUND_TYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 800 } FMOD_SOUND_TYPE; 801 802 803 /* 804 [ENUM] 805 [ 806 [DESCRIPTION] 807 These definitions describe the native format of the hardware or software buffer that will be used. 808 809 [REMARKS] 810 This is the format the native hardware or software buffer will be or is created in. 811 812 [PLATFORMS] 813 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 814 815 [SEE_ALSO] 816 System::createSound 817 Sound::getFormat 818 ] 819 */ 820 typedef enum 821 { 822 FMOD_SOUND_FORMAT_NONE, /* Unitialized / unknown. */ 823 FMOD_SOUND_FORMAT_PCM8, /* 8bit integer PCM data. */ 824 FMOD_SOUND_FORMAT_PCM16, /* 16bit integer PCM data. */ 825 FMOD_SOUND_FORMAT_PCM24, /* 24bit integer PCM data. */ 826 FMOD_SOUND_FORMAT_PCM32, /* 32bit integer PCM data. */ 827 FMOD_SOUND_FORMAT_PCMFLOAT, /* 32bit floating point PCM data. */ 828 FMOD_SOUND_FORMAT_GCADPCM, /* Compressed Nintendo 3DS/Wii DSP data. */ 829 FMOD_SOUND_FORMAT_IMAADPCM, /* Compressed IMA ADPCM data. */ 830 FMOD_SOUND_FORMAT_VAG, /* Compressed PlayStation Portable ADPCM data. */ 831 FMOD_SOUND_FORMAT_HEVAG, /* Compressed PSVita ADPCM data. */ 832 FMOD_SOUND_FORMAT_XMA, /* Compressed Xbox360 XMA data. */ 833 FMOD_SOUND_FORMAT_MPEG, /* Compressed MPEG layer 2 or 3 data. */ 834 FMOD_SOUND_FORMAT_CELT, /* Compressed CELT data. */ 835 FMOD_SOUND_FORMAT_AT9, /* Compressed PSVita ATRAC9 data. */ 836 FMOD_SOUND_FORMAT_XWMA, /* Compressed Xbox360 xWMA data. */ 837 FMOD_SOUND_FORMAT_VORBIS, /* Compressed Vorbis data. */ 838 839 FMOD_SOUND_FORMAT_MAX, /* Maximum number of sound formats supported. */ 840 FMOD_SOUND_FORMAT_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 841 } FMOD_SOUND_FORMAT; 842 843 844 /* 845 [DEFINE] 846 [ 847 [NAME] 848 FMOD_MODE 849 850 [DESCRIPTION] 851 Sound description bitfields, bitwise OR them together for loading and describing sounds. 852 853 [REMARKS] 854 By default a sound will open as a static sound that is decompressed fully into memory to PCM. (ie equivalent of FMOD_CREATESAMPLE) 855 To have a sound stream instead, use FMOD_CREATESTREAM, or use the wrapper function System::createStream. 856 Some opening modes (ie FMOD_OPENUSER, FMOD_OPENMEMORY, FMOD_OPENMEMORY_POINT, FMOD_OPENRAW) will need extra information. 857 This can be provided using the FMOD_CREATESOUNDEXINFO structure. 858 859 Specifying FMOD_OPENMEMORY_POINT will POINT to your memory rather allocating its own sound buffers and duplicating it internally. 860 <b><u>This means you cannot free the memory while FMOD is using it, until after Sound::release is called.</b></u> 861 With FMOD_OPENMEMORY_POINT, for PCM formats, only WAV, FSB, and RAW are supported. For compressed formats, only those formats supported by FMOD_CREATECOMPRESSEDSAMPLE are supported. 862 With FMOD_OPENMEMORY_POINT and FMOD_OPENRAW or PCM, if using them together, note that you must pad the data on each side by 16 bytes. This is so fmod can modify the ends of the data for looping/interpolation/mixing purposes. If a wav file, you will need to insert silence, and then reset loop points to stop the playback from playing that silence. 863 With FMOD_OPENMEMORY_POINT, For Wii/PSP FMOD_HARDWARE supports this flag for the GCADPCM/VAG formats. On other platforms FMOD_SOFTWARE must be used. 864 865 <b>Xbox 360 memory</b> On Xbox 360 Specifying FMOD_OPENMEMORY_POINT to a virtual memory address will cause FMOD_ERR_INVALID_ADDRESS 866 to be returned. Use physical memory only for this functionality. 867 868 FMOD_LOWMEM is used on a sound if you want to minimize the memory overhead, by having FMOD not allocate memory for certain 869 features that are not likely to be used in a game environment. These are : 870 1. Sound::getName functionality is removed. 256 bytes per sound is saved. 871 872 [PLATFORMS] 873 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 874 875 [SEE_ALSO] 876 System::createSound 877 System::createStream 878 Sound::setMode 879 Sound::getMode 880 Channel::setMode 881 Channel::getMode 882 Sound::set3DCustomRolloff 883 Channel::set3DCustomRolloff 884 Sound::getOpenState 885 ] 886 */ 887 #define FMOD_DEFAULT 0x00000000 /* Default for all modes listed below. FMOD_LOOP_OFF, FMOD_2D, FMOD_HARDWARE */ 888 #define FMOD_LOOP_OFF 0x00000001 /* For non looping sounds. (DEFAULT). Overrides FMOD_LOOP_NORMAL / FMOD_LOOP_BIDI. */ 889 #define FMOD_LOOP_NORMAL 0x00000002 /* For forward looping sounds. */ 890 #define FMOD_LOOP_BIDI 0x00000004 /* For bidirectional looping sounds. (only works on software mixed static sounds). */ 891 #define FMOD_2D 0x00000008 /* Ignores any 3d processing. (DEFAULT). */ 892 #define FMOD_3D 0x00000010 /* Makes the sound positionable in 3D. Overrides FMOD_2D. */ 893 #define FMOD_HARDWARE 0x00000020 /* Attempts to make sounds use hardware acceleration. (DEFAULT). Note on platforms that don't support FMOD_HARDWARE (only 3DS, PS Vita, PSP, Wii and Wii U support FMOD_HARDWARE), this will be internally treated as FMOD_SOFTWARE. */ 894 #define FMOD_SOFTWARE 0x00000040 /* Makes the sound be mixed by the FMOD CPU based software mixer. Overrides FMOD_HARDWARE. Use this for FFT, DSP, compressed sample support, 2D multi-speaker support and other software related features. */ 895 #define FMOD_CREATESTREAM 0x00000080 /* Decompress at runtime, streaming from the source provided (ie from disk). Overrides FMOD_CREATESAMPLE and FMOD_CREATECOMPRESSEDSAMPLE. Note a stream can only be played once at a time due to a stream only having 1 stream buffer and file handle. Open multiple streams to have them play concurrently. */ 896 #define FMOD_CREATESAMPLE 0x00000100 /* Decompress at loadtime, decompressing or decoding whole file into memory as the target sample format (ie PCM). Fastest for FMOD_SOFTWARE based playback and most flexible. */ 897 #define FMOD_CREATECOMPRESSEDSAMPLE 0x00000200 /* Load MP2, MP3, IMAADPCM or XMA into memory and leave it compressed. During playback the FMOD software mixer will decode it in realtime as a 'compressed sample'. Can only be used in combination with FMOD_SOFTWARE. Overrides FMOD_CREATESAMPLE. If the sound data is not ADPCM, MPEG or XMA it will behave as if it was created with FMOD_CREATESAMPLE and decode the sound into PCM. */ 898 #define FMOD_OPENUSER 0x00000400 /* Opens a user created static sample or stream. Use FMOD_CREATESOUNDEXINFO to specify format and/or read callbacks. If a user created 'sample' is created with no read callback, the sample will be empty. Use Sound::lock and Sound::unlock to place sound data into the sound if this is the case. */ 899 #define FMOD_OPENMEMORY 0x00000800 /* "name_or_data" will be interpreted as a pointer to memory instead of filename for creating sounds. Use FMOD_CREATESOUNDEXINFO to specify length. If used with FMOD_CREATESAMPLE or FMOD_CREATECOMPRESSEDSAMPLE, FMOD duplicates the memory into its own buffers. Your own buffer can be freed after open. If used with FMOD_CREATESTREAM, FMOD will stream out of the buffer whose pointer you passed in. In this case, your own buffer should not be freed until you have finished with and released the stream.*/ 900 #define FMOD_OPENMEMORY_POINT 0x10000000 /* "name_or_data" will be interpreted as a pointer to memory instead of filename for creating sounds. Use FMOD_CREATESOUNDEXINFO to specify length. This differs to FMOD_OPENMEMORY in that it uses the memory as is, without duplicating the memory into its own buffers. For Wii/PSP FMOD_HARDWARE supports this flag for the GCADPCM/VAG formats. On other platforms FMOD_SOFTWARE must be used, as sound hardware on the other platforms (ie PC) cannot access main ram. Cannot be freed after open, only after Sound::release. Will not work if the data is compressed and FMOD_CREATECOMPRESSEDSAMPLE is not used. */ 901 #define FMOD_OPENRAW 0x00001000 /* Will ignore file format and treat as raw pcm. Use FMOD_CREATESOUNDEXINFO to specify format. Requires at least defaultfrequency, numchannels and format to be specified before it will open. Must be little endian data. */ 902 #define FMOD_OPENONLY 0x00002000 /* Just open the file, dont prebuffer or read. Good for fast opens for info, or when sound::readData is to be used. */ 903 #define FMOD_ACCURATETIME 0x00004000 /* For System::createSound - for accurate Sound::getLength/Channel::setPosition on VBR MP3, and MOD/S3M/XM/IT/MIDI files. Scans file first, so takes longer to open. FMOD_OPENONLY does not affect this. */ 904 #define FMOD_MPEGSEARCH 0x00008000 /* For corrupted / bad MP3 files. This will search all the way through the file until it hits a valid MPEG header. Normally only searches for 4k. */ 905 #define FMOD_NONBLOCKING 0x00010000 /* For opening sounds and getting streamed subsounds (seeking) asyncronously. Use Sound::getOpenState to poll the state of the sound as it opens or retrieves the subsound in the background. */ 906 #define FMOD_UNIQUE 0x00020000 /* Unique sound, can only be played one at a time */ 907 #define FMOD_3D_HEADRELATIVE 0x00040000 /* Make the sound's position, velocity and orientation relative to the listener. */ 908 #define FMOD_3D_WORLDRELATIVE 0x00080000 /* Make the sound's position, velocity and orientation absolute (relative to the world). (DEFAULT) */ 909 #define FMOD_3D_INVERSEROLLOFF 0x00100000 /* This sound will follow the inverse rolloff model where mindistance = full volume, maxdistance = where sound stops attenuating, and rolloff is fixed according to the global rolloff factor. (DEFAULT) */ 910 #define FMOD_3D_LINEARROLLOFF 0x00200000 /* This sound will follow a linear rolloff model where mindistance = full volume, maxdistance = silence. Rolloffscale is ignored. */ 911 #define FMOD_3D_LINEARSQUAREROLLOFF 0x00400000 /* This sound will follow a linear-square rolloff model where mindistance = full volume, maxdistance = silence. Rolloffscale is ignored. */ 912 #define FMOD_3D_CUSTOMROLLOFF 0x04000000 /* This sound will follow a rolloff model defined by Sound::set3DCustomRolloff / Channel::set3DCustomRolloff. */ 913 #define FMOD_3D_IGNOREGEOMETRY 0x40000000 /* Is not affect by geometry occlusion. If not specified in Sound::setMode, or Channel::setMode, the flag is cleared and it is affected by geometry again. */ 914 #define FMOD_UNICODE 0x01000000 /* Filename is double-byte unicode. */ 915 #define FMOD_IGNORETAGS 0x02000000 /* Skips id3v2/asf/etc tag checks when opening a sound, to reduce seek/read overhead when opening files (helps with CD performance). */ 916 #define FMOD_LOWMEM 0x08000000 /* Removes some features from samples to give a lower memory overhead, like Sound::getName. See remarks. */ 917 #define FMOD_LOADSECONDARYRAM 0x20000000 /* Load sound into the secondary RAM of supported platform. On PS3, sounds will be loaded into RSX/VRAM. */ 918 #define FMOD_VIRTUAL_PLAYFROMSTART 0x80000000 /* For sounds that start virtual (due to being quiet or low importance), instead of swapping back to audible, and playing at the correct offset according to time, this flag makes the sound play from the start. */ 919 920 /* [DEFINE_END] */ 921 922 923 /* 924 [ENUM] 925 [ 926 [DESCRIPTION] 927 These values describe what state a sound is in after FMOD_NONBLOCKING has been used to open it. 928 929 [REMARKS] 930 With streams, if you are using FMOD_NONBLOCKING, note that if the user calls Sound::getSubSound, a stream will go into FMOD_OPENSTATE_SEEKING state and sound related commands will return FMOD_ERR_NOTREADY. 931 With streams, if you are using FMOD_NONBLOCKING, note that if the user calls Channel::getPosition, a stream will go into FMOD_OPENSTATE_SETPOSITION state and sound related commands will return FMOD_ERR_NOTREADY. 932 933 [PLATFORMS] 934 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 935 936 [SEE_ALSO] 937 Sound::getOpenState 938 FMOD_MODE 939 ] 940 */ 941 typedef enum 942 { 943 FMOD_OPENSTATE_READY = 0, /* Opened and ready to play. */ 944 FMOD_OPENSTATE_LOADING, /* Initial load in progress. */ 945 FMOD_OPENSTATE_ERROR, /* Failed to open - file not found, out of memory etc. See return value of Sound::getOpenState for what happened. */ 946 FMOD_OPENSTATE_CONNECTING, /* Connecting to remote host (internet sounds only). */ 947 FMOD_OPENSTATE_BUFFERING, /* Buffering data. */ 948 FMOD_OPENSTATE_SEEKING, /* Seeking to subsound and re-flushing stream buffer. */ 949 FMOD_OPENSTATE_PLAYING, /* Ready and playing, but not possible to release at this time without stalling the main thread. */ 950 FMOD_OPENSTATE_SETPOSITION, /* Seeking within a stream to a different position. */ 951 952 FMOD_OPENSTATE_MAX, /* Maximum number of open state types. */ 953 FMOD_OPENSTATE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 954 } FMOD_OPENSTATE; 955 956 957 /* 958 [ENUM] 959 [ 960 [DESCRIPTION] 961 These flags are used with SoundGroup::setMaxAudibleBehavior to determine what happens when more sounds 962 are played than are specified with SoundGroup::setMaxAudible. 963 964 [REMARKS] 965 When using FMOD_SOUNDGROUP_BEHAVIOR_MUTE, SoundGroup::setMuteFadeSpeed can be used to stop a sudden transition. 966 Instead, the time specified will be used to cross fade between the sounds that go silent and the ones that become audible. 967 968 [PLATFORMS] 969 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 970 971 [SEE_ALSO] 972 SoundGroup::setMaxAudibleBehavior 973 SoundGroup::getMaxAudibleBehavior 974 SoundGroup::setMaxAudible 975 SoundGroup::getMaxAudible 976 SoundGroup::setMuteFadeSpeed 977 SoundGroup::getMuteFadeSpeed 978 ] 979 */ 980 typedef enum 981 { 982 FMOD_SOUNDGROUP_BEHAVIOR_FAIL, /* Any sound played that puts the sound count over the SoundGroup::setMaxAudible setting, will simply fail during System::playSound. */ 983 FMOD_SOUNDGROUP_BEHAVIOR_MUTE, /* Any sound played that puts the sound count over the SoundGroup::setMaxAudible setting, will be silent, then if another sound in the group stops the sound that was silent before becomes audible again. */ 984 FMOD_SOUNDGROUP_BEHAVIOR_STEALLOWEST, /* Any sound played that puts the sound count over the SoundGroup::setMaxAudible setting, will steal the quietest / least important sound playing in the group. */ 985 986 FMOD_SOUNDGROUP_BEHAVIOR_MAX, /* Maximum number of open state types. */ 987 FMOD_SOUNDGROUP_BEHAVIOR_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 988 } FMOD_SOUNDGROUP_BEHAVIOR; 989 990 991 /* 992 [ENUM] 993 [ 994 [DESCRIPTION] 995 These callback types are used with Channel::setCallback. 996 997 [REMARKS] 998 Each callback has commanddata parameters passed as int unique to the type of callback. 999 See reference to FMOD_CHANNEL_CALLBACK to determine what they might mean for each type of callback. 1000 1001 <b>Note!</b> Currently the user must call System::update for these callbacks to trigger! 1002 1003 [PLATFORMS] 1004 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1005 1006 [SEE_ALSO] 1007 Channel::setCallback 1008 FMOD_CHANNEL_CALLBACK 1009 System::update 1010 ] 1011 */ 1012 typedef enum 1013 { 1014 FMOD_CHANNEL_CALLBACKTYPE_END, /* Called when a sound ends. */ 1015 FMOD_CHANNEL_CALLBACKTYPE_VIRTUALVOICE, /* Called when a voice is swapped out or swapped in. */ 1016 FMOD_CHANNEL_CALLBACKTYPE_SYNCPOINT, /* Called when a syncpoint is encountered. Can be from wav file markers. */ 1017 FMOD_CHANNEL_CALLBACKTYPE_OCCLUSION, /* Called when the channel has its geometry occlusion value calculated. Can be used to clamp or change the value. */ 1018 1019 FMOD_CHANNEL_CALLBACKTYPE_MAX, /* Maximum number of callback types supported. */ 1020 FMOD_CHANNEL_CALLBACKTYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 1021 } FMOD_CHANNEL_CALLBACKTYPE; 1022 1023 1024 /* 1025 [ENUM] 1026 [ 1027 [DESCRIPTION] 1028 These callback types are used with System::setCallback. 1029 1030 [REMARKS] 1031 Each callback has commanddata parameters passed as void* unique to the type of callback. 1032 See reference to FMOD_SYSTEM_CALLBACK to determine what they might mean for each type of callback. 1033 1034 <b>Note!</b> Using FMOD_SYSTEM_CALLBACKTYPE_DEVICELISTCHANGED (on Mac only) requires the application to be running an event loop which will allow external changes to device list to be detected by FMOD. 1035 1036 <b>Note!</b> The 'system' object pointer will be null for FMOD_SYSTEM_CALLBACKTYPE_THREADCREATED and FMOD_SYSTEM_CALLBACKTYPE_MEMORYALLOCATIONFAILED callbacks. 1037 1038 [PLATFORMS] 1039 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1040 1041 [SEE_ALSO] 1042 System::setCallback 1043 FMOD_SYSTEM_CALLBACK 1044 System::update 1045 DSP::addInput 1046 ] 1047 */ 1048 typedef enum 1049 { 1050 FMOD_SYSTEM_CALLBACKTYPE_DEVICELISTCHANGED, /* Called from System::update when the enumerated list of devices has changed. */ 1051 FMOD_SYSTEM_CALLBACKTYPE_DEVICELOST, /* Called from System::update when an output device has been lost due to control panel parameter changes and FMOD cannot automatically recover. */ 1052 FMOD_SYSTEM_CALLBACKTYPE_MEMORYALLOCATIONFAILED, /* Called directly when a memory allocation fails somewhere in FMOD. (NOTE - 'system' will be NULL in this callback type.)*/ 1053 FMOD_SYSTEM_CALLBACKTYPE_THREADCREATED, /* Called directly when a thread is created. (NOTE - 'system' will be NULL in this callback type.) */ 1054 FMOD_SYSTEM_CALLBACKTYPE_BADDSPCONNECTION, /* Called when a bad connection was made with DSP::addInput. Usually called from mixer thread because that is where the connections are made. */ 1055 FMOD_SYSTEM_CALLBACKTYPE_BADDSPLEVEL, /* Called when too many effects were added exceeding the maximum tree depth of 128. This is most likely caused by accidentally adding too many DSP effects. Usually called from mixer thread because that is where the connections are made. */ 1056 1057 FMOD_SYSTEM_CALLBACKTYPE_MAX, /* Maximum number of callback types supported. */ 1058 FMOD_SYSTEM_CALLBACKTYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 1059 } FMOD_SYSTEM_CALLBACKTYPE; 1060 1061 1062 /* 1063 FMOD Callbacks 1064 */ 1065 typedef FMOD_RESULT (F_CALLBACK *FMOD_SYSTEM_CALLBACK) (FMOD_SYSTEM *system, FMOD_SYSTEM_CALLBACKTYPE type, void *commanddata1, void *commanddata2); 1066 1067 typedef FMOD_RESULT (F_CALLBACK *FMOD_CHANNEL_CALLBACK) (FMOD_CHANNEL *channel, FMOD_CHANNEL_CALLBACKTYPE type, void *commanddata1, void *commanddata2); 1068 1069 typedef FMOD_RESULT (F_CALLBACK *FMOD_SOUND_NONBLOCKCALLBACK)(FMOD_SOUND *sound, FMOD_RESULT result); 1070 typedef FMOD_RESULT (F_CALLBACK *FMOD_SOUND_PCMREADCALLBACK)(FMOD_SOUND *sound, void *data, unsigned int datalen); 1071 typedef FMOD_RESULT (F_CALLBACK *FMOD_SOUND_PCMSETPOSCALLBACK)(FMOD_SOUND *sound, int subsound, unsigned int position, FMOD_TIMEUNIT postype); 1072 1073 typedef FMOD_RESULT (F_CALLBACK *FMOD_FILE_OPENCALLBACK) (const char *name, int unicode, unsigned int *filesize, void **handle, void **userdata); 1074 typedef FMOD_RESULT (F_CALLBACK *FMOD_FILE_CLOSECALLBACK) (void *handle, void *userdata); 1075 typedef FMOD_RESULT (F_CALLBACK *FMOD_FILE_READCALLBACK) (void *handle, void *buffer, unsigned int sizebytes, unsigned int *bytesread, void *userdata); 1076 typedef FMOD_RESULT (F_CALLBACK *FMOD_FILE_SEEKCALLBACK) (void *handle, unsigned int pos, void *userdata); 1077 typedef FMOD_RESULT (F_CALLBACK *FMOD_FILE_ASYNCREADCALLBACK)(FMOD_ASYNCREADINFO *info, void *userdata); 1078 typedef FMOD_RESULT (F_CALLBACK *FMOD_FILE_ASYNCCANCELCALLBACK)(void *handle, void *userdata); 1079 1080 typedef void * (F_CALLBACK *FMOD_MEMORY_ALLOCCALLBACK) (unsigned int size, FMOD_MEMORY_TYPE type, const char *sourcestr); 1081 typedef void * (F_CALLBACK *FMOD_MEMORY_REALLOCCALLBACK)(void *ptr, unsigned int size, FMOD_MEMORY_TYPE type, const char *sourcestr); 1082 typedef void (F_CALLBACK *FMOD_MEMORY_FREECALLBACK) (void *ptr, FMOD_MEMORY_TYPE type, const char *sourcestr); 1083 1084 typedef float (F_CALLBACK *FMOD_3D_ROLLOFFCALLBACK) (FMOD_CHANNEL *channel, float distance); 1085 1086 1087 /* 1088 [ENUM] 1089 [ 1090 [DESCRIPTION] 1091 List of windowing methods used in spectrum analysis to reduce leakage / transient signals intefering with the analysis. 1092 This is a problem with analysis of continuous signals that only have a small portion of the signal sample (the fft window size). 1093 Windowing the signal with a curve or triangle tapers the sides of the fft window to help alleviate this problem. 1094 1095 [REMARKS] 1096 Cyclic signals such as a sine wave that repeat their cycle in a multiple of the window size do not need windowing. 1097 I.e. If the sine wave repeats every 1024, 512, 256 etc samples and the FMOD fft window is 1024, then the signal would not need windowing. 1098 Not windowing is the same as FMOD_DSP_FFT_WINDOW_RECT, which is the default. 1099 If the cycle of the signal (ie the sine wave) is not a multiple of the window size, it will cause frequency abnormalities, so a different windowing method is needed. 1100 1101 [PLATFORMS] 1102 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1103 1104 [SEE_ALSO] 1105 System::getSpectrum 1106 Channel::getSpectrum 1107 ] 1108 */ 1109 typedef enum 1110 { 1111 FMOD_DSP_FFT_WINDOW_RECT, /* w[n] = 1.0 */ 1112 FMOD_DSP_FFT_WINDOW_TRIANGLE, /* w[n] = TRI(2n/N) */ 1113 FMOD_DSP_FFT_WINDOW_HAMMING, /* w[n] = 0.54 - (0.46 * COS(n/N) ) */ 1114 FMOD_DSP_FFT_WINDOW_HANNING, /* w[n] = 0.5 * (1.0 - COS(n/N) ) */ 1115 FMOD_DSP_FFT_WINDOW_BLACKMAN, /* w[n] = 0.42 - (0.5 * COS(n/N) ) + (0.08 * COS(2.0 * n/N) ) */ 1116 FMOD_DSP_FFT_WINDOW_BLACKMANHARRIS, /* w[n] = 0.35875 - (0.48829 * COS(1.0 * n/N)) + (0.14128 * COS(2.0 * n/N)) - (0.01168 * COS(3.0 * n/N)) */ 1117 1118 FMOD_DSP_FFT_WINDOW_MAX, /* Maximum number of FFT window types supported. */ 1119 FMOD_DSP_FFT_WINDOW_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 1120 } FMOD_DSP_FFT_WINDOW; 1121 1122 1123 /* 1124 [ENUM] 1125 [ 1126 [DESCRIPTION] 1127 List of interpolation types that the FMOD Ex software mixer supports. 1128 1129 [REMARKS] 1130 The default resampler type is FMOD_DSP_RESAMPLER_LINEAR. 1131 Use System::setSoftwareFormat to tell FMOD the resampling quality you require for FMOD_SOFTWARE based sounds. 1132 1133 [PLATFORMS] 1134 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1135 1136 [SEE_ALSO] 1137 System::setSoftwareFormat 1138 System::getSoftwareFormat 1139 ] 1140 */ 1141 typedef enum 1142 { 1143 FMOD_DSP_RESAMPLER_NOINTERP, /* No interpolation. High frequency aliasing hiss will be audible depending on the sample rate of the sound. */ 1144 FMOD_DSP_RESAMPLER_LINEAR, /* Linear interpolation (default method). Fast and good quality, causes very slight lowpass effect on low frequency sounds. */ 1145 FMOD_DSP_RESAMPLER_CUBIC, /* Cubic interpolation. Slower than linear interpolation but better quality. */ 1146 FMOD_DSP_RESAMPLER_SPLINE, /* 5 point spline interpolation. Slowest resampling method but best quality. */ 1147 1148 FMOD_DSP_RESAMPLER_MAX, /* Maximum number of resample methods supported. */ 1149 FMOD_DSP_RESAMPLER_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 1150 } FMOD_DSP_RESAMPLER; 1151 1152 1153 /* 1154 [ENUM] 1155 [ 1156 [DESCRIPTION] 1157 List of tag types that could be stored within a sound. These include id3 tags, metadata from netstreams and vorbis/asf data. 1158 1159 [REMARKS] 1160 1161 [PLATFORMS] 1162 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1163 1164 [SEE_ALSO] 1165 Sound::getTag 1166 ] 1167 */ 1168 typedef enum 1169 { 1170 FMOD_TAGTYPE_UNKNOWN = 0, 1171 FMOD_TAGTYPE_ID3V1, 1172 FMOD_TAGTYPE_ID3V2, 1173 FMOD_TAGTYPE_VORBISCOMMENT, 1174 FMOD_TAGTYPE_SHOUTCAST, 1175 FMOD_TAGTYPE_ICECAST, 1176 FMOD_TAGTYPE_ASF, 1177 FMOD_TAGTYPE_MIDI, 1178 FMOD_TAGTYPE_PLAYLIST, 1179 FMOD_TAGTYPE_FMOD, 1180 FMOD_TAGTYPE_USER, 1181 1182 FMOD_TAGTYPE_MAX, /* Maximum number of tag types supported. */ 1183 FMOD_TAGTYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 1184 } FMOD_TAGTYPE; 1185 1186 1187 /* 1188 [ENUM] 1189 [ 1190 [DESCRIPTION] 1191 List of data types that can be returned by Sound::getTag 1192 1193 [REMARKS] 1194 1195 [PLATFORMS] 1196 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1197 1198 [SEE_ALSO] 1199 Sound::getTag 1200 ] 1201 */ 1202 typedef enum 1203 { 1204 FMOD_TAGDATATYPE_BINARY = 0, 1205 FMOD_TAGDATATYPE_INT, 1206 FMOD_TAGDATATYPE_FLOAT, 1207 FMOD_TAGDATATYPE_STRING, 1208 FMOD_TAGDATATYPE_STRING_UTF16, 1209 FMOD_TAGDATATYPE_STRING_UTF16BE, 1210 FMOD_TAGDATATYPE_STRING_UTF8, 1211 FMOD_TAGDATATYPE_CDTOC, 1212 1213 FMOD_TAGDATATYPE_MAX, /* Maximum number of tag datatypes supported. */ 1214 FMOD_TAGDATATYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 1215 } FMOD_TAGDATATYPE; 1216 1217 1218 /* 1219 [ENUM] 1220 [ 1221 [DESCRIPTION] 1222 Types of delay that can be used with Channel::setDelay / Channel::getDelay. 1223 1224 [REMARKS] 1225 If you haven't called Channel::setDelay yet, if you call Channel::getDelay with FMOD_DELAYTYPE_DSPCLOCK_START it will return the 1226 equivalent global DSP clock value to determine when a channel started, so that you can use it for other channels to sync against. 1227 1228 Use System::getDSPClock to also get the current dspclock time, a base for future calls to Channel::setDelay. 1229 1230 Use FMOD_64BIT_ADD or FMOD_64BIT_SUB to add a hi/lo combination together and cope with wraparound. 1231 1232 If FMOD_DELAYTYPE_END_MS is specified, the value is not treated as a 64 bit number, just the delayhi value is used and it is treated as milliseconds. 1233 1234 [PLATFORMS] 1235 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1236 1237 [SEE_ALSO] 1238 Channel::setDelay 1239 Channel::getDelay 1240 System::getDSPClock 1241 ] 1242 */ 1243 typedef enum 1244 { 1245 FMOD_DELAYTYPE_END_MS, /* Delay at the end of the sound in milliseconds. Use delayhi only. Channel::isPlaying will remain true until this delay has passed even though the sound itself has stopped playing.*/ 1246 FMOD_DELAYTYPE_DSPCLOCK_START, /* Time the sound started if Channel::getDelay is used, or if Channel::setDelay is used, the sound will delay playing until this exact tick. */ 1247 FMOD_DELAYTYPE_DSPCLOCK_END, /* Time the sound should end. If this is non-zero, the channel will go silent at this exact tick. */ 1248 FMOD_DELAYTYPE_DSPCLOCK_PAUSE, /* Time the sound should pause. If this is non-zero, the channel will pause at this exact tick. */ 1249 1250 FMOD_DELAYTYPE_MAX, /* Maximum number of tag datatypes supported. */ 1251 FMOD_DELAYTYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */ 1252 } FMOD_DELAYTYPE; 1253 1254 1255 #define FMOD_64BIT_ADD(_hi1, _lo1, _hi2, _lo2) _hi1 += ((_hi2) + ((((_lo1) + (_lo2)) < (_lo1)) ? 1 : 0)); (_lo1) += (_lo2); 1256 #define FMOD_64BIT_SUB(_hi1, _lo1, _hi2, _lo2) _hi1 -= ((_hi2) + ((((_lo1) - (_lo2)) > (_lo1)) ? 1 : 0)); (_lo1) -= (_lo2); 1257 1258 1259 /* 1260 [STRUCTURE] 1261 [ 1262 [DESCRIPTION] 1263 Structure describing a piece of tag data. 1264 1265 [REMARKS] 1266 Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value. 1267 Members marked with [w] mean the variable can be written to. The user can set the value. 1268 1269 [PLATFORMS] 1270 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1271 1272 [SEE_ALSO] 1273 Sound::getTag 1274 FMOD_TAGTYPE 1275 FMOD_TAGDATATYPE 1276 ] 1277 */ 1278 typedef struct FMOD_TAG 1279 { 1280 FMOD_TAGTYPE type; /* [r] The type of this tag. */ 1281 FMOD_TAGDATATYPE datatype; /* [r] The type of data that this tag contains */ 1282 char *name; /* [r] The name of this tag i.e. "TITLE", "ARTIST" etc. */ 1283 void *data; /* [r] Pointer to the tag data - its format is determined by the datatype member */ 1284 unsigned int datalen; /* [r] Length of the data contained in this tag */ 1285 FMOD_BOOL updated; /* [r] True if this tag has been updated since last being accessed with Sound::getTag */ 1286 } FMOD_TAG; 1287 1288 1289 /* 1290 [STRUCTURE] 1291 [ 1292 [DESCRIPTION] 1293 Structure describing a CD/DVD table of contents 1294 1295 [REMARKS] 1296 Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value. 1297 Members marked with [w] mean the variable can be written to. The user can set the value. 1298 1299 [PLATFORMS] 1300 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1301 1302 [SEE_ALSO] 1303 Sound::getTag 1304 ] 1305 */ 1306 typedef struct FMOD_CDTOC 1307 { 1308 int numtracks; /* [r] The number of tracks on the CD */ 1309 int min[100]; /* [r] The start offset of each track in minutes */ 1310 int sec[100]; /* [r] The start offset of each track in seconds */ 1311 int frame[100]; /* [r] The start offset of each track in frames */ 1312 } FMOD_CDTOC; 1313 1314 1315 /* 1316 [DEFINE] 1317 [ 1318 [NAME] 1319 FMOD_TIMEUNIT 1320 1321 [DESCRIPTION] 1322 List of time types that can be returned by Sound::getLength and used with Channel::setPosition or Channel::getPosition. 1323 1324 [REMARKS] 1325 FMOD_TIMEUNIT_SENTENCE_MS, FMOD_TIMEUNIT_SENTENCE_PCM, FMOD_TIMEUNIT_SENTENCE_PCMBYTES, FMOD_TIMEUNIT_SENTENCE and FMOD_TIMEUNIT_SENTENCE_SUBSOUND are only supported by Channel functions. 1326 Do not combine flags except FMOD_TIMEUNIT_BUFFERED. 1327 1328 [PLATFORMS] 1329 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1330 1331 [SEE_ALSO] 1332 Sound::getLength 1333 Channel::setPosition 1334 Channel::getPosition 1335 ] 1336 */ 1337 #define FMOD_TIMEUNIT_MS 0x00000001 /* Milliseconds. */ 1338 #define FMOD_TIMEUNIT_PCM 0x00000002 /* PCM samples, related to milliseconds * samplerate / 1000. */ 1339 #define FMOD_TIMEUNIT_PCMBYTES 0x00000004 /* Bytes, related to PCM samples * channels * datawidth (ie 16bit = 2 bytes). */ 1340 #define FMOD_TIMEUNIT_RAWBYTES 0x00000008 /* Raw file bytes of (compressed) sound data (does not include headers). Only used by Sound::getLength and Channel::getPosition. */ 1341 #define FMOD_TIMEUNIT_PCMFRACTION 0x00000010 /* Fractions of 1 PCM sample. Unsigned int range 0 to 0xFFFFFFFF. Used for sub-sample granularity for DSP purposes. */ 1342 #define FMOD_TIMEUNIT_MODORDER 0x00000100 /* MOD/S3M/XM/IT. Order in a sequenced module format. Use Sound::getFormat to determine the PCM format being decoded to. */ 1343 #define FMOD_TIMEUNIT_MODROW 0x00000200 /* MOD/S3M/XM/IT. Current row in a sequenced module format. Sound::getLength will return the number of rows in the currently playing or seeked to pattern. */ 1344 #define FMOD_TIMEUNIT_MODPATTERN 0x00000400 /* MOD/S3M/XM/IT. Current pattern in a sequenced module format. Sound::getLength will return the number of patterns in the song and Channel::getPosition will return the currently playing pattern. */ 1345 #define FMOD_TIMEUNIT_SENTENCE_MS 0x00010000 /* Currently playing subsound in a sentence time in milliseconds. */ 1346 #define FMOD_TIMEUNIT_SENTENCE_PCM 0x00020000 /* Currently playing subsound in a sentence time in PCM Samples, related to milliseconds * samplerate / 1000. */ 1347 #define FMOD_TIMEUNIT_SENTENCE_PCMBYTES 0x00040000 /* Currently playing subsound in a sentence time in bytes, related to PCM samples * channels * datawidth (ie 16bit = 2 bytes). */ 1348 #define FMOD_TIMEUNIT_SENTENCE 0x00080000 /* Currently playing sentence index according to the channel. */ 1349 #define FMOD_TIMEUNIT_SENTENCE_SUBSOUND 0x00100000 /* Currently playing subsound index in a sentence. */ 1350 #define FMOD_TIMEUNIT_BUFFERED 0x10000000 /* Time value as seen by buffered stream. This is always ahead of audible time, and is only used for processing. */ 1351 /* [DEFINE_END] */ 1352 1353 1354 /* 1355 [ENUM] 1356 [ 1357 [DESCRIPTION] 1358 When creating a multichannel sound, FMOD will pan them to their default speaker locations, for example a 6 channel sound will default to one channel per 5.1 output speaker. 1359 Another example is a stereo sound. It will default to left = front left, right = front right. 1360 1361 This is for sounds that are not 'default'. For example you might have a sound that is 6 channels but actually made up of 3 stereo pairs, that should all be located in front left, front right only. 1362 1363 [REMARKS] 1364 For full flexibility of speaker assignments, use Channel::setSpeakerLevels. 1365 1366 [PLATFORMS] 1367 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1368 1369 [SEE_ALSO] 1370 FMOD_CREATESOUNDEXINFO 1371 Channel::setSpeakerLevels 1372 ] 1373 */ 1374 typedef enum 1375 { 1376 FMOD_SPEAKERMAPTYPE_DEFAULT, /* This is the default, and just means FMOD decides which speakers it puts the source channels. */ 1377 FMOD_SPEAKERMAPTYPE_ALLMONO, /* This means the sound is made up of all mono sounds. All voices will be panned to the front center by default in this case. */ 1378 FMOD_SPEAKERMAPTYPE_ALLSTEREO, /* This means the sound is made up of all stereo sounds. All voices will be panned to front left and front right alternating every second channel. */ 1379 FMOD_SPEAKERMAPTYPE_51_PROTOOLS /* Map a 5.1 sound to use protools L C R Ls Rs LFE mapping. Will return an error if not a 6 channel sound. */ 1380 } FMOD_SPEAKERMAPTYPE; 1381 1382 1383 /* 1384 [STRUCTURE] 1385 [ 1386 [DESCRIPTION] 1387 Use this structure with System::createSound when more control is needed over loading. 1388 The possible reasons to use this with System::createSound are: 1389 - Loading a file from memory. 1390 - Loading a file from within another larger (possibly wad/pak) file, by giving the loader an offset and length. 1391 - To create a user created / non file based sound. 1392 - To specify a starting subsound to seek to within a multi-sample sounds (ie FSB/DLS/SF2) when created as a stream. 1393 - To specify which subsounds to load for multi-sample sounds (ie FSB/DLS/SF2) so that memory is saved and only a subset is actually loaded/read from disk. 1394 - To specify 'piggyback' read and seek callbacks for capture of sound data as fmod reads and decodes it. Useful for ripping decoded PCM data from sounds as they are loaded / played. 1395 - To specify a MIDI DLS/SF2 sample set file to load when opening a MIDI file. 1396 See below on what members to fill for each of the above types of sound you want to create. 1397 1398 [REMARKS] 1399 This structure is optional! Specify 0 or NULL in System::createSound if you don't need it! 1400 1401 <u>Loading a file from memory.</u> 1402 - Create the sound using the FMOD_OPENMEMORY flag. 1403 - Mandatory. Specify 'length' for the size of the memory block in bytes. 1404 - Other flags are optional. 1405 1406 1407 <u>Loading a file from within another larger (possibly wad/pak) file, by giving the loader an offset and length.</u> 1408 - Mandatory. Specify 'fileoffset' and 'length'. 1409 - Other flags are optional. 1410 1411 1412 <u>To create a user created / non file based sound.</u> 1413 - Create the sound using the FMOD_OPENUSER flag. 1414 - Mandatory. Specify 'defaultfrequency, 'numchannels' and 'format'. 1415 - Other flags are optional. 1416 1417 1418 <u>To specify a starting subsound to seek to and flush with, within a multi-sample stream (ie FSB/DLS/SF2).</u> 1419 1420 - Mandatory. Specify 'initialsubsound'. 1421 1422 1423 <u>To specify which subsounds to load for multi-sample sounds (ie FSB/DLS/SF2) so that memory is saved and only a subset is actually loaded/read from disk.</u> 1424 1425 - Mandatory. Specify 'inclusionlist' and 'inclusionlistnum'. 1426 1427 1428 <u>To specify 'piggyback' read and seek callbacks for capture of sound data as fmod reads and decodes it. Useful for ripping decoded PCM data from sounds as they are loaded / played.</u> 1429 1430 - Mandatory. Specify 'pcmreadcallback' and 'pcmseekcallback'. 1431 1432 1433 <u>To specify a MIDI DLS/SF2 sample set file to load when opening a MIDI file.</u> 1434 1435 - Mandatory. Specify 'dlsname'. 1436 1437 1438 Setting the 'decodebuffersize' is for cpu intensive codecs that may be causing stuttering, not file intensive codecs (ie those from CD or netstreams) which are normally 1439 altered with System::setStreamBufferSize. As an example of cpu intensive codecs, an mp3 file will take more cpu to decode than a PCM wav file. 1440 If you have a stuttering effect, then it is using more cpu than the decode buffer playback rate can keep up with. Increasing the decode buffersize will most likely solve this problem. 1441 1442 1443 FSB codec. If inclusionlist and numsubsounds are used together, this will trigger a special mode where subsounds are shuffled down to save memory. (useful for large FSB 1444 files where you only want to load 1 sound). There will be no gaps, ie no null subsounds. As an example, if there are 10,000 subsounds and there is an inclusionlist with only 1 entry, 1445 and numsubsounds = 1, then subsound 0 will be that entry, and there will only be the memory allocated for 1 subsound. Previously there would still be 10,000 subsound pointers and other 1446 associated codec entries allocated along with it multiplied by 10,000. 1447 1448 Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value. 1449 Members marked with [w] mean the variable can be written to. The user can set the value. 1450 1451 [PLATFORMS] 1452 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1453 1454 [SEE_ALSO] 1455 System::createSound 1456 System::setStreamBufferSize 1457 FMOD_MODE 1458 FMOD_SOUND_FORMAT 1459 FMOD_SOUND_TYPE 1460 FMOD_SPEAKERMAPTYPE 1461 ] 1462 */ 1463 typedef struct FMOD_CREATESOUNDEXINFO 1464 { 1465 int cbsize; /* [w] Size of this structure. This is used so the structure can be expanded in the future and still work on older versions of FMOD Ex. */ 1466 unsigned int length; /* [w] Optional. Specify 0 to ignore. Size in bytes of file to load, or sound to create (in this case only if FMOD_OPENUSER is used). Required if loading from memory. If 0 is specified, then it will use the size of the file (unless loading from memory then an error will be returned). */ 1467 unsigned int fileoffset; /* [w] Optional. Specify 0 to ignore. Offset from start of the file to start loading from. This is useful for loading files from inside big data files. */ 1468 int numchannels; /* [w] Optional. Specify 0 to ignore. Number of channels in a sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. */ 1469 int defaultfrequency; /* [w] Optional. Specify 0 to ignore. Default frequency of sound in a sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. Other formats use the frequency determined by the file format. */ 1470 FMOD_SOUND_FORMAT format; /* [w] Optional. Specify 0 or FMOD_SOUND_FORMAT_NONE to ignore. Format of the sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. Other formats use the format determined by the file format. */ 1471 unsigned int decodebuffersize; /* [w] Optional. Specify 0 to ignore. For streams. This determines the size of the double buffer (in PCM samples) that a stream uses. Use this for user created streams if you want to determine the size of the callback buffer passed to you. Specify 0 to use FMOD's default size which is currently equivalent to 400ms of the sound format created/loaded. */ 1472 int initialsubsound; /* [w] Optional. Specify 0 to ignore. In a multi-sample file format such as .FSB/.DLS/.SF2, specify the initial subsound to seek to, only if FMOD_CREATESTREAM is used. */ 1473 int numsubsounds; /* [w] Optional. Specify 0 to ignore or have no subsounds. In a sound created with FMOD_OPENUSER, specify the number of subsounds that are accessable with Sound::getSubSound. If not created with FMOD_OPENUSER, this will limit the number of subsounds loaded within a multi-subsound file. If using FSB, then if FMOD_CREATESOUNDEXINFO::inclusionlist is used, this will shuffle subsounds down so that there are not any gaps. It will mean that the indices of the sounds will be different. */ 1474 int *inclusionlist; /* [w] Optional. Specify 0 to ignore. In a multi-sample format such as .FSB/.DLS/.SF2 it may be desirable to specify only a subset of sounds to be loaded out of the whole file. This is an array of subsound indices to load into memory when created. */ 1475 int inclusionlistnum; /* [w] Optional. Specify 0 to ignore. This is the number of integers contained within the inclusionlist array. */ 1476 FMOD_SOUND_PCMREADCALLBACK pcmreadcallback; /* [w] Optional. Specify 0 to ignore. Callback to 'piggyback' on FMOD's read functions and accept or even write PCM data while FMOD is opening the sound. Used for user sounds created with FMOD_OPENUSER or for capturing decoded data as FMOD reads it. */ 1477 FMOD_SOUND_PCMSETPOSCALLBACK pcmsetposcallback; /* [w] Optional. Specify 0 to ignore. Callback for when the user calls a seeking function such as Channel::setTime or Channel::setPosition within a multi-sample sound, and for when it is opened.*/ 1478 FMOD_SOUND_NONBLOCKCALLBACK nonblockcallback; /* [w] Optional. Specify 0 to ignore. Callback for successful completion, or error while loading a sound that used the FMOD_NONBLOCKING flag.*/ 1479 const char *dlsname; /* [w] Optional. Specify 0 to ignore. Filename for a DLS or SF2 sample set when loading a MIDI file. If not specified, on Windows it will attempt to open /windows/system32/drivers/gm.dls or /windows/system32/drivers/etc/gm.dls, on Mac it will attempt to load /System/Library/Components/CoreAudio.component/Contents/Resources/gs_instruments.dls, otherwise the MIDI will fail to open. Current DLS support is for level 1 of the specification. */ 1480 const char *encryptionkey; /* [w] Optional. Specify 0 to ignore. Key for encrypted FSB file. Without this key an encrypted FSB file will not load. */ 1481 int maxpolyphony; /* [w] Optional. Specify 0 to ignore. For sequenced formats with dynamic channel allocation such as .MID and .IT, this specifies the maximum voice count allowed while playing. .IT defaults to 64. .MID defaults to 32. */ 1482 void *userdata; /* [w] Optional. Specify 0 to ignore. This is user data to be attached to the sound during creation. Access via Sound::getUserData. Note: This is not passed to FMOD_FILE_OPENCALLBACK, that is a different userdata that is file specific. */ 1483 FMOD_SOUND_TYPE suggestedsoundtype; /* [w] Optional. Specify 0 or FMOD_SOUND_TYPE_UNKNOWN to ignore. Instead of scanning all codec types, use this to speed up loading by making it jump straight to this codec. */ 1484 FMOD_FILE_OPENCALLBACK useropen; /* [w] Optional. Specify 0 to ignore. Callback for opening this file. */ 1485 FMOD_FILE_CLOSECALLBACK userclose; /* [w] Optional. Specify 0 to ignore. Callback for closing this file. */ 1486 FMOD_FILE_READCALLBACK userread; /* [w] Optional. Specify 0 to ignore. Callback for reading from this file. */ 1487 FMOD_FILE_SEEKCALLBACK userseek; /* [w] Optional. Specify 0 to ignore. Callback for seeking within this file. */ 1488 FMOD_FILE_ASYNCREADCALLBACK userasyncread; /* [w] Optional. Specify 0 to ignore. Callback for seeking within this file. */ 1489 FMOD_FILE_ASYNCCANCELCALLBACK userasynccancel; /* [w] Optional. Specify 0 to ignore. Callback for seeking within this file. */ 1490 FMOD_SPEAKERMAPTYPE speakermap; /* [w] Optional. Specify 0 to ignore. Use this to differ the way fmod maps multichannel sounds to speakers. See FMOD_SPEAKERMAPTYPE for more. */ 1491 FMOD_SOUNDGROUP *initialsoundgroup; /* [w] Optional. Specify 0 to ignore. Specify a sound group if required, to put sound in as it is created. */ 1492 unsigned int initialseekposition;/* [w] Optional. Specify 0 to ignore. For streams. Specify an initial position to seek the stream to. */ 1493 FMOD_TIMEUNIT initialseekpostype; /* [w] Optional. Specify 0 to ignore. For streams. Specify the time unit for the position set in initialseekposition. */ 1494 int ignoresetfilesystem;/* [w] Optional. Specify 0 to ignore. Set to 1 to use fmod's built in file system. Ignores setFileSystem callbacks and also FMOD_CREATESOUNEXINFO file callbacks. Useful for specific cases where you don't want to use your own file system but want to use fmod's file system (ie net streaming). */ 1495 int cddaforceaspi; /* [w] Optional. Specify 0 to ignore. For CDDA sounds only - if non-zero use ASPI instead of NTSCSI to access the specified CD/DVD device. */ 1496 unsigned int audioqueuepolicy; /* [w] Optional. Specify 0 or FMOD_AUDIOQUEUE_CODECPOLICY_DEFAULT to ignore. Policy used to determine whether hardware or software is used for decoding, see FMOD_AUDIOQUEUE_CODECPOLICY for options (iOS >= 3.0 required, otherwise only hardware is available) */ 1497 unsigned int minmidigranularity; /* [w] Optional. Specify 0 to ignore. Allows you to set a minimum desired MIDI mixer granularity. Values smaller than 512 give greater than default accuracy at the cost of more CPU and vice versa. Specify 0 for default (512 samples). */ 1498 int nonblockthreadid; /* [w] Optional. Specify 0 to ignore. Specifies a thread index to execute non blocking load on. Allows for up to 5 threads to be used for loading at once. This is to avoid one load blocking another. Maximum value = 4. */ 1499 } FMOD_CREATESOUNDEXINFO; 1500 1501 1502 /* 1503 [STRUCTURE] 1504 [ 1505 [DESCRIPTION] 1506 Structure defining a reverb environment. 1507 1508 [REMARKS] 1509 Note the default reverb properties are the same as the FMOD_PRESET_GENERIC preset. 1510 Note that integer values that typically range from -10,000 to 1000 are represented in 1511 decibels, and are of a logarithmic scale, not linear, wheras float values are always linear. 1512 1513 The numerical values listed below are the maximum, minimum and default values for each variable respectively. 1514 1515 <b>SUPPORTED</b> next to each parameter means the platform the parameter can be set on. Some platforms support all parameters and some don't. 1516 WII means Nintendo Wii hardware reverb (must use FMOD_HARDWARE). 1517 PSP means Playstation Portable hardware reverb (must use FMOD_HARDWARE). 1518 SFX means FMOD SFX software reverb. This works on any platform that uses FMOD_SOFTWARE for loading sounds. 1519 --- means unsupported/deprecated. Will either be removed or supported by SFX in the future. 1520 1521 Nintendo Wii Notes: 1522 This structure supports only limited parameters, and maps them to the Wii hardware reverb as follows. 1523 DecayTime = 'time' 1524 ReverbDelay = 'predelay' 1525 ModulationDepth = 'damping' 1526 Reflections = 'coloration' 1527 EnvDiffusion = 'crosstalk' 1528 Room = 'mix' 1529 1530 Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value. 1531 Members marked with [w] mean the variable can be written to. The user can set the value. 1532 Members marked with [r/w] are either read or write depending on if you are using System::setReverbProperties (w) or System::getReverbProperties (r). 1533 1534 [PLATFORMS] 1535 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1536 1537 [SEE_ALSO] 1538 System::setReverbProperties 1539 System::getReverbProperties 1540 FMOD_REVERB_PRESETS 1541 FMOD_REVERB_FLAGS 1542 ] 1543 */ 1544 typedef struct FMOD_REVERB_PROPERTIES 1545 { /* MIN MAX DEFAULT DESCRIPTION */ 1546 int Instance; /* [w] 0 3 0 Environment Instance. (SUPPORTED:SFX(4 instances) and Wii (3 instances)) */ 1547 int Environment; /* [r/w] -1 25 -1 Sets all listener properties. -1 = OFF. (SUPPORTED:SFX(-1 only)/PSP) */ 1548 float EnvDiffusion; /* [r/w] 0.0 1.0 1.0 Environment diffusion (SUPPORTED:WII) */ 1549 int Room; /* [r/w] -10000 0 -1000 Room effect level (at mid frequencies) (SUPPORTED:SFX/WII/PSP) */ 1550 int RoomHF; /* [r/w] -10000 0 -100 Relative room effect level at high frequencies (SUPPORTED:SFX) */ 1551 int RoomLF; /* [r/w] -10000 0 0 Relative room effect level at low frequencies (SUPPORTED:SFX) */ 1552 float DecayTime; /* [r/w] 0.1 20.0 1.49 Reverberation decay time at mid frequencies (SUPPORTED:SFX/WII) */ 1553 float DecayHFRatio; /* [r/w] 0.1 2.0 0.83 High-frequency to mid-frequency decay time ratio (SUPPORTED:SFX) */ 1554 float DecayLFRatio; /* [r/w] 0.1 2.0 1.0 Low-frequency to mid-frequency decay time ratio (SUPPORTED:---) */ 1555 int Reflections; /* [r/w] -10000 1000 -2602 Early reflections level relative to room effect (SUPPORTED:SFX/WII) */ 1556 float ReflectionsDelay; /* [r/w] 0.0 0.3 0.007 Initial reflection delay time (SUPPORTED:SFX) */ 1557 int Reverb; /* [r/w] -10000 2000 200 Late reverberation level relative to room effect (SUPPORTED:SFX) */ 1558 float ReverbDelay; /* [r/w] 0.0 0.1 0.011 Late reverberation delay time relative to initial reflection (SUPPORTED:SFX/WII) */ 1559 float ModulationTime; /* [r/w] 0.04 4.0 0.25 Modulation time (SUPPORTED:---) */ 1560 float ModulationDepth; /* [r/w] 0.0 1.0 0.0 Modulation depth (SUPPORTED:WII) */ 1561 float HFReference; /* [r/w] 20.0 20000.0 5000.0 Reference high frequency (hz) (SUPPORTED:SFX) */ 1562 float LFReference; /* [r/w] 20.0 1000.0 250.0 Reference low frequency (hz) (SUPPORTED:SFX) */ 1563 float Diffusion; /* [r/w] 0.0 100.0 100.0 Value that controls the echo density in the late reverberation decay. (SUPPORTED:SFX) */ 1564 float Density; /* [r/w] 0.0 100.0 100.0 Value that controls the modal density in the late reverberation decay (SUPPORTED:SFX) */ 1565 unsigned int Flags; /* [r/w] FMOD_REVERB_FLAGS - modifies the behavior of above properties (SUPPORTED:WII) */ 1566 } FMOD_REVERB_PROPERTIES; 1567 1568 1569 /* 1570 [DEFINE] 1571 [ 1572 [NAME] 1573 FMOD_REVERB_FLAGS 1574 1575 [DESCRIPTION] 1576 Values for the Flags member of the FMOD_REVERB_PROPERTIES structure. 1577 1578 [REMARKS] 1579 1580 [PLATFORMS] 1581 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1582 1583 [SEE_ALSO] 1584 FMOD_REVERB_PROPERTIES 1585 ] 1586 */ 1587 #define FMOD_REVERB_FLAGS_HIGHQUALITYREVERB 0x00000400 /* Wii. Use high quality reverb */ 1588 #define FMOD_REVERB_FLAGS_HIGHQUALITYDPL2REVERB 0x00000800 /* Wii. Use high quality DPL2 reverb */ 1589 #define FMOD_REVERB_FLAGS_HARDWAREONLY 0x00001000 /* Don't create an SFX reverb for FMOD_SOFTWARE channels, hardware reverb only */ 1590 #define FMOD_REVERB_FLAGS_DEFAULT 0x00000000 1591 /* [DEFINE_END] */ 1592 1593 1594 /* 1595 [DEFINE] 1596 [ 1597 [NAME] 1598 FMOD_REVERB_PRESETS 1599 1600 [DESCRIPTION] 1601 A set of predefined environment PARAMETERS. 1602 These are used to initialize an FMOD_REVERB_PROPERTIES structure statically. 1603 i.e. 1604 FMOD_REVERB_PROPERTIES prop = FMOD_PRESET_GENERIC; 1605 1606 [REMARKS] 1607 1608 [PLATFORMS] 1609 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1610 1611 [SEE_ALSO] 1612 System::setReverbProperties 1613 ] 1614 */ 1615 /* Inst Env Diffus Room RoomHF RmLF DecTm DecHF DecLF Refl RefDel Revb RevDel ModTm ModDp HFRef LFRef Diffus Densty FLAGS */ 1616 #define FMOD_PRESET_OFF { 0, -1, 1.00f, -10000, -10000, 0, 1.00f, 1.00f, 1.0f, -2602, 0.007f, 200, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 0.0f, 0.0f, 0x33f } 1617 #define FMOD_PRESET_GENERIC { 0, 0, 1.00f, -1000, -100, 0, 1.49f, 0.83f, 1.0f, -2602, 0.007f, 200, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1618 #define FMOD_PRESET_PADDEDCELL { 0, 1, 1.00f, -1000, -6000, 0, 0.17f, 0.10f, 1.0f, -1204, 0.001f, 207, 0.002f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1619 #define FMOD_PRESET_ROOM { 0, 2, 1.00f, -1000, -454, 0, 0.40f, 0.83f, 1.0f, -1646, 0.002f, 53, 0.003f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1620 #define FMOD_PRESET_BATHROOM { 0, 3, 1.00f, -1000, -1200, 0, 1.49f, 0.54f, 1.0f, -370, 0.007f, 1030, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 60.0f, 0x3f } 1621 #define FMOD_PRESET_LIVINGROOM { 0, 4, 1.00f, -1000, -6000, 0, 0.50f, 0.10f, 1.0f, -1376, 0.003f, -1104, 0.004f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1622 #define FMOD_PRESET_STONEROOM { 0, 5, 1.00f, -1000, -300, 0, 2.31f, 0.64f, 1.0f, -711, 0.012f, 83, 0.017f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1623 #define FMOD_PRESET_AUDITORIUM { 0, 6, 1.00f, -1000, -476, 0, 4.32f, 0.59f, 1.0f, -789, 0.020f, -289, 0.030f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1624 #define FMOD_PRESET_CONCERTHALL { 0, 7, 1.00f, -1000, -500, 0, 3.92f, 0.70f, 1.0f, -1230, 0.020f, -2, 0.029f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1625 #define FMOD_PRESET_CAVE { 0, 8, 1.00f, -1000, 0, 0, 2.91f, 1.30f, 1.0f, -602, 0.015f, -302, 0.022f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x1f } 1626 #define FMOD_PRESET_ARENA { 0, 9, 1.00f, -1000, -698, 0, 7.24f, 0.33f, 1.0f, -1166, 0.020f, 16, 0.030f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1627 #define FMOD_PRESET_HANGAR { 0, 10, 1.00f, -1000, -1000, 0, 10.05f, 0.23f, 1.0f, -602, 0.020f, 198, 0.030f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1628 #define FMOD_PRESET_CARPETTEDHALLWAY { 0, 11, 1.00f, -1000, -4000, 0, 0.30f, 0.10f, 1.0f, -1831, 0.002f, -1630, 0.030f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1629 #define FMOD_PRESET_HALLWAY { 0, 12, 1.00f, -1000, -300, 0, 1.49f, 0.59f, 1.0f, -1219, 0.007f, 441, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1630 #define FMOD_PRESET_STONECORRIDOR { 0, 13, 1.00f, -1000, -237, 0, 2.70f, 0.79f, 1.0f, -1214, 0.013f, 395, 0.020f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1631 #define FMOD_PRESET_ALLEY { 0, 14, 0.30f, -1000, -270, 0, 1.49f, 0.86f, 1.0f, -1204, 0.007f, -4, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1632 #define FMOD_PRESET_FOREST { 0, 15, 0.30f, -1000, -3300, 0, 1.49f, 0.54f, 1.0f, -2560, 0.162f, -229, 0.088f, 0.25f, 0.000f, 5000.0f, 250.0f, 79.0f, 100.0f, 0x3f } 1633 #define FMOD_PRESET_CITY { 0, 16, 0.50f, -1000, -800, 0, 1.49f, 0.67f, 1.0f, -2273, 0.007f, -1691, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 50.0f, 100.0f, 0x3f } 1634 #define FMOD_PRESET_MOUNTAINS { 0, 17, 0.27f, -1000, -2500, 0, 1.49f, 0.21f, 1.0f, -2780, 0.300f, -1434, 0.100f, 0.25f, 0.000f, 5000.0f, 250.0f, 27.0f, 100.0f, 0x1f } 1635 #define FMOD_PRESET_QUARRY { 0, 18, 1.00f, -1000, -1000, 0, 1.49f, 0.83f, 1.0f, -10000, 0.061f, 500, 0.025f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1636 #define FMOD_PRESET_PLAIN { 0, 19, 0.21f, -1000, -2000, 0, 1.49f, 0.50f, 1.0f, -2466, 0.179f, -1926, 0.100f, 0.25f, 0.000f, 5000.0f, 250.0f, 21.0f, 100.0f, 0x3f } 1637 #define FMOD_PRESET_PARKINGLOT { 0, 20, 1.00f, -1000, 0, 0, 1.65f, 1.50f, 1.0f, -1363, 0.008f, -1153, 0.012f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x1f } 1638 #define FMOD_PRESET_SEWERPIPE { 0, 21, 0.80f, -1000, -1000, 0, 2.81f, 0.14f, 1.0f, 429, 0.014f, 1023, 0.021f, 0.25f, 0.000f, 5000.0f, 250.0f, 80.0f, 60.0f, 0x3f } 1639 #define FMOD_PRESET_UNDERWATER { 0, 22, 1.00f, -1000, -4000, 0, 1.49f, 0.10f, 1.0f, -449, 0.007f, 1700, 0.011f, 1.18f, 0.348f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f } 1640 1641 /* PlayStation Portable Only presets */ 1642 #define FMOD_PRESET_PSP_ROOM { 0, 1, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f } 1643 #define FMOD_PRESET_PSP_STUDIO_A { 0, 2, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f } 1644 #define FMOD_PRESET_PSP_STUDIO_B { 0, 3, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f } 1645 #define FMOD_PRESET_PSP_STUDIO_C { 0, 4, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f } 1646 #define FMOD_PRESET_PSP_HALL { 0, 5, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f } 1647 #define FMOD_PRESET_PSP_SPACE { 0, 6, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f } 1648 #define FMOD_PRESET_PSP_ECHO { 0, 7, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f } 1649 #define FMOD_PRESET_PSP_DELAY { 0, 8, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f } 1650 #define FMOD_PRESET_PSP_PIPE { 0, 9, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f } 1651 /* [DEFINE_END] */ 1652 1653 1654 /* 1655 [STRUCTURE] 1656 [ 1657 [DESCRIPTION] 1658 Structure defining the properties for a reverb source, related to a FMOD channel. 1659 1660 Note the default reverb properties are the same as the FMOD_PRESET_GENERIC preset. 1661 Note that integer values that typically range from -10,000 to 1000 are represented in 1662 decibels, and are of a logarithmic scale, not linear, wheras float values are typically linear. 1663 PORTABILITY: Each member has the platform it supports in braces ie (win32/wii). 1664 1665 The numerical values listed below are the maximum, minimum and default values for each variable respectively. 1666 1667 [REMARKS] 1668 <b>SUPPORTED</b> next to each parameter means the platform the parameter can be set on. Some platforms support all parameters and some don't. 1669 WII means Nintendo Wii hardware reverb (must use FMOD_HARDWARE). 1670 PSP means Playstation Portable hardware reverb (must use FMOD_HARDWARE). 1671 SFX means FMOD SFX software reverb. This works on any platform that uses FMOD_SOFTWARE for loading sounds. 1672 --- means unsupported/deprecated. Will either be removed or supported by SFX in the future. 1673 1674 1675 <b>'ConnectionPoint' Parameter.</b> This parameter is for the FMOD software reverb only (known as SFX in the list above). 1676 By default the dsp network connection for a channel and its reverb is between the 'SFX Reverb' unit, and the channel's wavetable/resampler/dspcodec/oscillator unit (the unit below the channel DSP head). NULL can be used for this parameter to make it use this default behaviour. 1677 This parameter allows the user to connect the SFX reverb to somewhere else internally, for example the channel DSP head, or a related channelgroup. The event system uses this so that it can have the output of an event going to the reverb, instead of just the output of the event's channels (thereby ignoring event effects/submixes etc). 1678 Do not use if you are unaware of DSP network connection issues. Leave it at the default of NULL instead. 1679 1680 Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value. 1681 Members marked with [w] mean the variable can be written to. The user can set the value. 1682 Members marked with [r/w] are either read or write depending on if you are using Channel::setReverbProperties (w) or Channel::getReverbProperties (r). 1683 1684 [PLATFORMS] 1685 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1686 1687 [SEE_ALSO] 1688 Channel::setReverbProperties 1689 Channel::getReverbProperties 1690 FMOD_REVERB_CHANNELFLAGS 1691 ] 1692 */ 1693 typedef struct FMOD_REVERB_CHANNELPROPERTIES 1694 { /* MIN MAX DEFAULT DESCRIPTION */ 1695 int Direct; /* [r/w] -10000 1000 0 Direct path level (SUPPORTED:SFX) */ 1696 int Room; /* [r/w] -10000 1000 0 Room effect level (SUPPORTED:SFX) */ 1697 unsigned int Flags; /* [r/w] FMOD_REVERB_CHANNELFLAGS - modifies the behavior of properties (SUPPORTED:SFX) */ 1698 FMOD_DSP *ConnectionPoint; /* [r/w] See remarks. DSP network location to connect reverb for this channel. (SUPPORTED:SFX).*/ 1699 } FMOD_REVERB_CHANNELPROPERTIES; 1700 1701 1702 /* 1703 [DEFINE] 1704 [ 1705 [NAME] 1706 FMOD_REVERB_CHANNELFLAGS 1707 1708 [DESCRIPTION] 1709 Values for the Flags member of the FMOD_REVERB_CHANNELPROPERTIES structure. 1710 1711 [REMARKS] 1712 For SFX Reverb, there is support for multiple reverb environments. 1713 Use FMOD_REVERB_CHANNELFLAGS_ENVIRONMENT0 to FMOD_REVERB_CHANNELFLAGS_ENVIRONMENT3 in the flags member 1714 of FMOD_REVERB_CHANNELPROPERTIES to specify which environment instance(s) to target. 1715 - If you do not specify any instance the first reverb instance will be used. 1716 - If you specify more than one instance with getReverbProperties, the first instance will be used. 1717 - If you specify more than one instance with setReverbProperties, it will set more than 1 instance at once. 1718 1719 [PLATFORMS] 1720 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1721 1722 [SEE_ALSO] 1723 FMOD_REVERB_CHANNELPROPERTIES 1724 ] 1725 */ 1726 #define FMOD_REVERB_CHANNELFLAGS_INSTANCE0 0x00000010 /* SFX/Wii. Specify channel to target reverb instance 0. Default target. */ 1727 #define FMOD_REVERB_CHANNELFLAGS_INSTANCE1 0x00000020 /* SFX/Wii. Specify channel to target reverb instance 1. */ 1728 #define FMOD_REVERB_CHANNELFLAGS_INSTANCE2 0x00000040 /* SFX/Wii. Specify channel to target reverb instance 2. */ 1729 #define FMOD_REVERB_CHANNELFLAGS_INSTANCE3 0x00000080 /* SFX. Specify channel to target reverb instance 3. */ 1730 1731 #define FMOD_REVERB_CHANNELFLAGS_DEFAULT FMOD_REVERB_CHANNELFLAGS_INSTANCE0 1732 /* [DEFINE_END] */ 1733 1734 1735 /* 1736 [STRUCTURE] 1737 [ 1738 [DESCRIPTION] 1739 Settings for advanced features like configuring memory and cpu usage for the FMOD_CREATECOMPRESSEDSAMPLE feature. 1740 1741 [REMARKS] 1742 maxMPEGcodecs / maxADPCMcodecs / maxXMAcodecs will determine the maximum cpu usage of playing realtime samples. Use this to lower potential excess cpu usage and also control memory usage. 1743 1744 maxPCMcodecs is for use with PS3 only. It will determine the maximum number of PCM voices that can be played at once. This includes streams of any format and all sounds created 1745 *without* the FMOD_CREATECOMPRESSEDSAMPLE flag. 1746 1747 Memory will be allocated for codecs 'up front' (during System::init) if these values are specified as non zero. If any are zero, it allocates memory for the codec whenever a file of the type in question is loaded. So if maxMPEGcodecs is 0 for example, it will allocate memory for the mpeg codecs the first time an mp3 is loaded or an mp3 based .FSB file is loaded. 1748 1749 Due to inefficient encoding techniques on certain .wav based ADPCM files, FMOD can can need an extra 29720 bytes per codec. This means for lowest memory consumption. Use FSB as it uses an optimal/small ADPCM block size. 1750 1751 Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value. 1752 Members marked with [w] mean the variable can be written to. The user can set the value. 1753 Members marked with [r/w] are either read or write depending on if you are using System::setAdvancedSettings (w) or System::getAdvancedSettings (r). 1754 1755 [PLATFORMS] 1756 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1757 1758 [SEE_ALSO] 1759 System::setAdvancedSettings 1760 System::getAdvancedSettings 1761 System::init 1762 FMOD_MODE 1763 ] 1764 */ 1765 typedef struct FMOD_ADVANCEDSETTINGS 1766 { 1767 int cbsize; /* [w] Size of this structure. Use sizeof(FMOD_ADVANCEDSETTINGS) NOTE: This must be set before calling System::getAdvancedSettings! */ 1768 int maxMPEGcodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. Mpeg codecs consume 21,684 bytes per instance and this number will determine how many mpeg channels can be played simultaneously. Default = 32. */ 1769 int maxADPCMcodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. ADPCM codecs consume 2,136 bytes per instance and this number will determine how many ADPCM channels can be played simultaneously. Default = 32. */ 1770 int maxXMAcodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. XMA codecs consume 14,836 bytes per instance and this number will determine how many XMA channels can be played simultaneously. Default = 32. */ 1771 int maxCELTcodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. CELT codecs consume 11,500 bytes per instance and this number will determine how many CELT channels can be played simultaneously. Default = 32. */ 1772 int maxVORBIScodecs; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. Vorbis codecs consume 12,000 bytes per instance and this number will determine how many Vorbis channels can be played simultaneously. Default = 32. */ 1773 int maxPCMcodecs; /* [r/w] Optional. Specify 0 to ignore. For use with PS3 only. PCM codecs consume 12,672 bytes per instance and this number will determine how many streams and PCM voices can be played simultaneously. Default = 16. */ 1774 int ASIONumChannels; /* [r/w] Optional. Specify 0 to ignore. Number of channels available on the ASIO device. */ 1775 char **ASIOChannelList; /* [r/w] Optional. Specify 0 to ignore. Pointer to an array of strings (number of entries defined by ASIONumChannels) with ASIO channel names. */ 1776 FMOD_SPEAKER *ASIOSpeakerList; /* [r/w] Optional. Specify 0 to ignore. Pointer to a list of speakers that the ASIO channels map to. This can be called after System::init to remap ASIO output. */ 1777 int max3DReverbDSPs; /* [r/w] Optional. Specify 0 to ignore. The max number of 3d reverb DSP's in the system. (NOTE: CURRENTLY DISABLED / UNUSED) */ 1778 float HRTFMinAngle; /* [r/w] Optional. For use with FMOD_INIT_HRTF_LOWPASS. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function begins to have an effect. 0 = in front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 180.0. */ 1779 float HRTFMaxAngle; /* [r/w] Optional. For use with FMOD_INIT_HRTF_LOWPASS. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function has maximum effect. 0 = front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 360.0. */ 1780 float HRTFFreq; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_HRTF_LOWPASS. The cutoff frequency of the HRTF's lowpass filter function when at maximum effect. (i.e. at HRTFMaxAngle). Default = 4000.0. */ 1781 float vol0virtualvol; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_VOL0_BECOMES_VIRTUAL. If this flag is used, and the volume is 0.0, then the sound will become virtual. Use this value to raise the threshold to a different point where a sound goes virtual. */ 1782 int eventqueuesize; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD Event system only. Specifies the number of slots available for simultaneous non blocking loads, across all threads. Default = 32. */ 1783 unsigned int defaultDecodeBufferSize; /* [r/w] Optional. Specify 0 to ignore. For streams. This determines the default size of the double buffer (in milliseconds) that a stream uses. Default = 400ms */ 1784 char *debugLogFilename; /* [r/w] Optional. Specify 0 to ignore. Gives fmod's logging system a path/filename. Normally the log is placed in the same directory as the executable and called fmod.log. When using System::getAdvancedSettings, provide at least 256 bytes of memory to copy into. */ 1785 unsigned short profileport; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_ENABLE_PROFILE. Specify the port to listen on for connections by the profiler application. */ 1786 unsigned int geometryMaxFadeTime; /* [r/w] Optional. Specify 0 to ignore. The maximum time in miliseconds it takes for a channel to fade to the new level when its occlusion changes. */ 1787 unsigned int maxSpectrumWaveDataBuffers; /* [r/w] Optional. Specify 0 to ignore. Tells System::init to allocate a pool of wavedata/spectrum buffers to prevent memory fragmentation, any additional buffers will be allocated normally. */ 1788 unsigned int musicSystemCacheDelay; /* [r/w] Optional. Specify 0 to ignore. The delay the music system should allow for loading a sample from disk (in milliseconds). Default = 400 ms. */ 1789 float distanceFilterCenterFreq; /* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_DISTANCE_FILTERING. The default center frequency in Hz for the distance filtering effect. Default = 1500.0. */ 1790 unsigned int stackSizeStream; /* [r/w] Optional. Specify 0 to ignore. Specify the stack size for the FMOD Stream thread in bytes. Useful for custom codecs that use excess stack. Default 49,152 (48kb) */ 1791 unsigned int stackSizeNonBlocking; /* [r/w] Optional. Specify 0 to ignore. Specify the stack size for the FMOD_NONBLOCKING loading thread. Useful for custom codecs that use excess stack. Default 65,536 (64kb) */ 1792 unsigned int stackSizeMixer; /* [r/w] Optional. Specify 0 to ignore. Specify the stack size for the FMOD mixer thread. Useful for custom dsps that use excess stack. Default 49,152 (48kb) */ 1793 } FMOD_ADVANCEDSETTINGS; 1794 1795 1796 /* 1797 [ENUM] 1798 [ 1799 [DESCRIPTION] 1800 Special channel index values for FMOD functions. 1801 1802 [REMARKS] 1803 To get 'all' of the channels, use System::getMasterChannelGroup. 1804 1805 [PLATFORMS] 1806 Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android 1807 1808 [SEE_ALSO] 1809 System::playSound 1810 System::playDSP 1811 System::getChannel 1812 System::getMasterChannelGroup 1813 ] 1814 */ 1815 typedef enum 1816 { 1817 FMOD_CHANNEL_FREE = -1, /* For a channel index, FMOD chooses a free voice using the priority system. */ 1818 FMOD_CHANNEL_REUSE = -2 /* For a channel index, re-use the channel handle that was passed in. */ 1819 } FMOD_CHANNELINDEX; 1820 1821 #include "fmod_codec.h" 1822 #include "fmod_dsp.h" 1823 #include "fmod_memoryinfo.h" 1824 1825 /* ========================================================================================== */ 1826 /* FUNCTION PROTOTYPES */ 1827 /* ========================================================================================== */ 1828 1829 #ifdef __cplusplus 1830 extern "C" 1831 { 1832 #endif 1833 1834 /* 1835 FMOD global system functions (optional). 1836 */ 1837 1838 FMOD_RESULT F_API FMOD_Memory_Initialize (void *poolmem, int poollen, FMOD_MEMORY_ALLOCCALLBACK useralloc, FMOD_MEMORY_REALLOCCALLBACK userrealloc, FMOD_MEMORY_FREECALLBACK userfree, FMOD_MEMORY_TYPE memtypeflags); 1839 FMOD_RESULT F_API FMOD_Memory_GetStats (int *currentalloced, int *maxalloced, FMOD_BOOL blocking); 1840 FMOD_RESULT F_API FMOD_Debug_SetLevel (FMOD_DEBUGLEVEL level); 1841 FMOD_RESULT F_API FMOD_Debug_GetLevel (FMOD_DEBUGLEVEL *level); 1842 FMOD_RESULT F_API FMOD_File_SetDiskBusy (int busy); 1843 FMOD_RESULT F_API FMOD_File_GetDiskBusy (int *busy); 1844 1845 /* 1846 FMOD System factory functions. Use this to create an FMOD System Instance. below you will see FMOD_System_Init/Close to get started. 1847 */ 1848 1849 FMOD_RESULT F_API FMOD_System_Create (FMOD_SYSTEM **system); 1850 FMOD_RESULT F_API FMOD_System_Release (FMOD_SYSTEM *system); 1851 1852 1853 /* 1854 'System' API 1855 */ 1856 1857 /* 1858 Pre-init functions. 1859 */ 1860 1861 FMOD_RESULT F_API FMOD_System_SetOutput (FMOD_SYSTEM *system, FMOD_OUTPUTTYPE output); 1862 FMOD_RESULT F_API FMOD_System_GetOutput (FMOD_SYSTEM *system, FMOD_OUTPUTTYPE *output); 1863 FMOD_RESULT F_API FMOD_System_GetNumDrivers (FMOD_SYSTEM *system, int *numdrivers); 1864 FMOD_RESULT F_API FMOD_System_GetDriverInfo (FMOD_SYSTEM *system, int id, char *name, int namelen, FMOD_GUID *guid); 1865 FMOD_RESULT F_API FMOD_System_GetDriverInfoW (FMOD_SYSTEM *system, int id, short *name, int namelen, FMOD_GUID *guid); 1866 FMOD_RESULT F_API FMOD_System_GetDriverCaps (FMOD_SYSTEM *system, int id, FMOD_CAPS *caps, int *controlpaneloutputrate, FMOD_SPEAKERMODE *controlpanelspeakermode); 1867 FMOD_RESULT F_API FMOD_System_SetDriver (FMOD_SYSTEM *system, int driver); 1868 FMOD_RESULT F_API FMOD_System_GetDriver (FMOD_SYSTEM *system, int *driver); 1869 FMOD_RESULT F_API FMOD_System_SetHardwareChannels (FMOD_SYSTEM *system, int numhardwarechannels); 1870 FMOD_RESULT F_API FMOD_System_SetSoftwareChannels (FMOD_SYSTEM *system, int numsoftwarechannels); 1871 FMOD_RESULT F_API FMOD_System_GetSoftwareChannels (FMOD_SYSTEM *system, int *numsoftwarechannels); 1872 FMOD_RESULT F_API FMOD_System_SetSoftwareFormat (FMOD_SYSTEM *system, int samplerate, FMOD_SOUND_FORMAT format, int numoutputchannels, int maxinputchannels, FMOD_DSP_RESAMPLER resamplemethod); 1873 FMOD_RESULT F_API FMOD_System_GetSoftwareFormat (FMOD_SYSTEM *system, int *samplerate, FMOD_SOUND_FORMAT *format, int *numoutputchannels, int *maxinputchannels, FMOD_DSP_RESAMPLER *resamplemethod, int *bits); 1874 FMOD_RESULT F_API FMOD_System_SetDSPBufferSize (FMOD_SYSTEM *system, unsigned int bufferlength, int numbuffers); 1875 FMOD_RESULT F_API FMOD_System_GetDSPBufferSize (FMOD_SYSTEM *system, unsigned int *bufferlength, int *numbuffers); 1876 FMOD_RESULT F_API FMOD_System_SetFileSystem (FMOD_SYSTEM *system, FMOD_FILE_OPENCALLBACK useropen, FMOD_FILE_CLOSECALLBACK userclose, FMOD_FILE_READCALLBACK userread, FMOD_FILE_SEEKCALLBACK userseek, FMOD_FILE_ASYNCREADCALLBACK userasyncread, FMOD_FILE_ASYNCCANCELCALLBACK userasynccancel, int blockalign); 1877 FMOD_RESULT F_API FMOD_System_AttachFileSystem (FMOD_SYSTEM *system, FMOD_FILE_OPENCALLBACK useropen, FMOD_FILE_CLOSECALLBACK userclose, FMOD_FILE_READCALLBACK userread, FMOD_FILE_SEEKCALLBACK userseek); 1878 FMOD_RESULT F_API FMOD_System_SetAdvancedSettings (FMOD_SYSTEM *system, FMOD_ADVANCEDSETTINGS *settings); 1879 FMOD_RESULT F_API FMOD_System_GetAdvancedSettings (FMOD_SYSTEM *system, FMOD_ADVANCEDSETTINGS *settings); 1880 FMOD_RESULT F_API FMOD_System_SetSpeakerMode (FMOD_SYSTEM *system, FMOD_SPEAKERMODE speakermode); 1881 FMOD_RESULT F_API FMOD_System_GetSpeakerMode (FMOD_SYSTEM *system, FMOD_SPEAKERMODE *speakermode); 1882 FMOD_RESULT F_API FMOD_System_SetCallback (FMOD_SYSTEM *system, FMOD_SYSTEM_CALLBACK callback); 1883 1884 /* 1885 Plug-in support 1886 */ 1887 1888 FMOD_RESULT F_API FMOD_System_SetPluginPath (FMOD_SYSTEM *system, const char *path); 1889 FMOD_RESULT F_API FMOD_System_LoadPlugin (FMOD_SYSTEM *system, const char *filename, unsigned int *handle, unsigned int priority); 1890 FMOD_RESULT F_API FMOD_System_UnloadPlugin (FMOD_SYSTEM *system, unsigned int handle); 1891 FMOD_RESULT F_API FMOD_System_GetNumPlugins (FMOD_SYSTEM *system, FMOD_PLUGINTYPE plugintype, int *numplugins); 1892 FMOD_RESULT F_API FMOD_System_GetPluginHandle (FMOD_SYSTEM *system, FMOD_PLUGINTYPE plugintype, int index, unsigned int *handle); 1893 FMOD_RESULT F_API FMOD_System_GetPluginInfo (FMOD_SYSTEM *system, unsigned int handle, FMOD_PLUGINTYPE *plugintype, char *name, int namelen, unsigned int *version); 1894 FMOD_RESULT F_API FMOD_System_SetOutputByPlugin (FMOD_SYSTEM *system, unsigned int handle); 1895 FMOD_RESULT F_API FMOD_System_GetOutputByPlugin (FMOD_SYSTEM *system, unsigned int *handle); 1896 FMOD_RESULT F_API FMOD_System_CreateDSPByPlugin (FMOD_SYSTEM *system, unsigned int handle, FMOD_DSP **dsp); 1897 FMOD_RESULT F_API FMOD_System_RegisterCodec (FMOD_SYSTEM *system, FMOD_CODEC_DESCRIPTION *description, unsigned int *handle, unsigned int priority); 1898 FMOD_RESULT F_API FMOD_System_RegisterDSP (FMOD_SYSTEM *system, FMOD_DSP_DESCRIPTION *description, unsigned int *handle); 1899 1900 /* 1901 Init/Close 1902 */ 1903 1904 FMOD_RESULT F_API FMOD_System_Init (FMOD_SYSTEM *system, int maxchannels, FMOD_INITFLAGS flags, void *extradriverdata); 1905 FMOD_RESULT F_API FMOD_System_Close (FMOD_SYSTEM *system); 1906 1907 /* 1908 General post-init system functions 1909 */ 1910 1911 FMOD_RESULT F_API FMOD_System_Update (FMOD_SYSTEM *system); 1912 1913 FMOD_RESULT F_API FMOD_System_Set3DSettings (FMOD_SYSTEM *system, float dopplerscale, float distancefactor, float rolloffscale); 1914 FMOD_RESULT F_API FMOD_System_Get3DSettings (FMOD_SYSTEM *system, float *dopplerscale, float *distancefactor, float *rolloffscale); 1915 FMOD_RESULT F_API FMOD_System_Set3DNumListeners (FMOD_SYSTEM *system, int numlisteners); 1916 FMOD_RESULT F_API FMOD_System_Get3DNumListeners (FMOD_SYSTEM *system, int *numlisteners); 1917 FMOD_RESULT F_API FMOD_System_Set3DListenerAttributes(FMOD_SYSTEM *system, int listener, const FMOD_VECTOR *pos, const FMOD_VECTOR *vel, const FMOD_VECTOR *forward, const FMOD_VECTOR *up); 1918 FMOD_RESULT F_API FMOD_System_Get3DListenerAttributes(FMOD_SYSTEM *system, int listener, FMOD_VECTOR *pos, FMOD_VECTOR *vel, FMOD_VECTOR *forward, FMOD_VECTOR *up); 1919 FMOD_RESULT F_API FMOD_System_Set3DRolloffCallback (FMOD_SYSTEM *system, FMOD_3D_ROLLOFFCALLBACK callback); 1920 FMOD_RESULT F_API FMOD_System_Set3DSpeakerPosition (FMOD_SYSTEM *system, FMOD_SPEAKER speaker, float x, float y, FMOD_BOOL active); 1921 FMOD_RESULT F_API FMOD_System_Get3DSpeakerPosition (FMOD_SYSTEM *system, FMOD_SPEAKER speaker, float *x, float *y, FMOD_BOOL *active); 1922 1923 FMOD_RESULT F_API FMOD_System_SetStreamBufferSize (FMOD_SYSTEM *system, unsigned int filebuffersize, FMOD_TIMEUNIT filebuffersizetype); 1924 FMOD_RESULT F_API FMOD_System_GetStreamBufferSize (FMOD_SYSTEM *system, unsigned int *filebuffersize, FMOD_TIMEUNIT *filebuffersizetype); 1925 1926 /* 1927 System information functions. 1928 */ 1929 1930 FMOD_RESULT F_API FMOD_System_GetVersion (FMOD_SYSTEM *system, unsigned int *version); 1931 FMOD_RESULT F_API FMOD_System_GetOutputHandle (FMOD_SYSTEM *system, void **handle); 1932 FMOD_RESULT F_API FMOD_System_GetChannelsPlaying (FMOD_SYSTEM *system, int *channels); 1933 FMOD_RESULT F_API FMOD_System_GetHardwareChannels (FMOD_SYSTEM *system, int *numhardwarechannels); 1934 FMOD_RESULT F_API FMOD_System_GetCPUUsage (FMOD_SYSTEM *system, float *dsp, float *stream, float *geometry, float *update, float *total); 1935 FMOD_RESULT F_API FMOD_System_GetSoundRAM (FMOD_SYSTEM *system, int *currentalloced, int *maxalloced, int *total); 1936 FMOD_RESULT F_API FMOD_System_GetNumCDROMDrives (FMOD_SYSTEM *system, int *numdrives); 1937 FMOD_RESULT F_API FMOD_System_GetCDROMDriveName (FMOD_SYSTEM *system, int drive, char *drivename, int drivenamelen, char *scsiname, int scsinamelen, char *devicename, int devicenamelen); 1938 FMOD_RESULT F_API FMOD_System_GetSpectrum (FMOD_SYSTEM *system, float *spectrumarray, int numvalues, int channeloffset, FMOD_DSP_FFT_WINDOW windowtype); 1939 FMOD_RESULT F_API FMOD_System_GetWaveData (FMOD_SYSTEM *system, float *wavearray, int numvalues, int channeloffset); 1940 1941 /* 1942 Sound/DSP/Channel/FX creation and retrieval. 1943 */ 1944 1945 FMOD_RESULT F_API FMOD_System_CreateSound (FMOD_SYSTEM *system, const char *name_or_data, FMOD_MODE mode, FMOD_CREATESOUNDEXINFO *exinfo, FMOD_SOUND **sound); 1946 FMOD_RESULT F_API FMOD_System_CreateStream (FMOD_SYSTEM *system, const char *name_or_data, FMOD_MODE mode, FMOD_CREATESOUNDEXINFO *exinfo, FMOD_SOUND **sound); 1947 FMOD_RESULT F_API FMOD_System_CreateDSP (FMOD_SYSTEM *system, FMOD_DSP_DESCRIPTION *description, FMOD_DSP **dsp); 1948 FMOD_RESULT F_API FMOD_System_CreateDSPByType (FMOD_SYSTEM *system, FMOD_DSP_TYPE type, FMOD_DSP **dsp); 1949 FMOD_RESULT F_API FMOD_System_CreateChannelGroup (FMOD_SYSTEM *system, const char *name, FMOD_CHANNELGROUP **channelgroup); 1950 FMOD_RESULT F_API FMOD_System_CreateSoundGroup (FMOD_SYSTEM *system, const char *name, FMOD_SOUNDGROUP **soundgroup); 1951 FMOD_RESULT F_API FMOD_System_CreateReverb (FMOD_SYSTEM *system, FMOD_REVERB **reverb); 1952 1953 FMOD_RESULT F_API FMOD_System_PlaySound (FMOD_SYSTEM *system, FMOD_CHANNELINDEX channelid, FMOD_SOUND *sound, FMOD_BOOL paused, FMOD_CHANNEL **channel); 1954 FMOD_RESULT F_API FMOD_System_PlayDSP (FMOD_SYSTEM *system, FMOD_CHANNELINDEX channelid, FMOD_DSP *dsp, FMOD_BOOL paused, FMOD_CHANNEL **channel); 1955 FMOD_RESULT F_API FMOD_System_GetChannel (FMOD_SYSTEM *system, int channelid, FMOD_CHANNEL **channel); 1956 FMOD_RESULT F_API FMOD_System_GetMasterChannelGroup (FMOD_SYSTEM *system, FMOD_CHANNELGROUP **channelgroup); 1957 FMOD_RESULT F_API FMOD_System_GetMasterSoundGroup (FMOD_SYSTEM *system, FMOD_SOUNDGROUP **soundgroup); 1958 1959 /* 1960 Reverb API 1961 */ 1962 1963 FMOD_RESULT F_API FMOD_System_SetReverbProperties (FMOD_SYSTEM *system, const FMOD_REVERB_PROPERTIES *prop); 1964 FMOD_RESULT F_API FMOD_System_GetReverbProperties (FMOD_SYSTEM *system, FMOD_REVERB_PROPERTIES *prop); 1965 FMOD_RESULT F_API FMOD_System_SetReverbAmbientProperties(FMOD_SYSTEM *system, FMOD_REVERB_PROPERTIES *prop); 1966 FMOD_RESULT F_API FMOD_System_GetReverbAmbientProperties(FMOD_SYSTEM *system, FMOD_REVERB_PROPERTIES *prop); 1967 1968 /* 1969 System level DSP access. 1970 */ 1971 1972 FMOD_RESULT F_API FMOD_System_GetDSPHead (FMOD_SYSTEM *system, FMOD_DSP **dsp); 1973 FMOD_RESULT F_API FMOD_System_AddDSP (FMOD_SYSTEM *system, FMOD_DSP *dsp, FMOD_DSPCONNECTION **connection); 1974 FMOD_RESULT F_API FMOD_System_LockDSP (FMOD_SYSTEM *system); 1975 FMOD_RESULT F_API FMOD_System_UnlockDSP (FMOD_SYSTEM *system); 1976 FMOD_RESULT F_API FMOD_System_GetDSPClock (FMOD_SYSTEM *system, unsigned int *hi, unsigned int *lo); 1977 1978 /* 1979 Recording API. 1980 */ 1981 1982 FMOD_RESULT F_API FMOD_System_GetRecordNumDrivers (FMOD_SYSTEM *system, int *numdrivers); 1983 FMOD_RESULT F_API FMOD_System_GetRecordDriverInfo (FMOD_SYSTEM *system, int id, char *name, int namelen, FMOD_GUID *guid); 1984 FMOD_RESULT F_API FMOD_System_GetRecordDriverInfoW (FMOD_SYSTEM *system, int id, short *name, int namelen, FMOD_GUID *guid); 1985 FMOD_RESULT F_API FMOD_System_GetRecordDriverCaps (FMOD_SYSTEM *system, int id, FMOD_CAPS *caps, int *minfrequency, int *maxfrequency); 1986 FMOD_RESULT F_API FMOD_System_GetRecordPosition (FMOD_SYSTEM *system, int id, unsigned int *position); 1987 1988 FMOD_RESULT F_API FMOD_System_RecordStart (FMOD_SYSTEM *system, int id, FMOD_SOUND *sound, FMOD_BOOL loop); 1989 FMOD_RESULT F_API FMOD_System_RecordStop (FMOD_SYSTEM *system, int id); 1990 FMOD_RESULT F_API FMOD_System_IsRecording (FMOD_SYSTEM *system, int id, FMOD_BOOL *recording); 1991 1992 /* 1993 Geometry API. 1994 */ 1995 1996 FMOD_RESULT F_API FMOD_System_CreateGeometry (FMOD_SYSTEM *system, int maxpolygons, int maxvertices, FMOD_GEOMETRY **geometry); 1997 FMOD_RESULT F_API FMOD_System_SetGeometrySettings (FMOD_SYSTEM *system, float maxworldsize); 1998 FMOD_RESULT F_API FMOD_System_GetGeometrySettings (FMOD_SYSTEM *system, float *maxworldsize); 1999 FMOD_RESULT F_API FMOD_System_LoadGeometry (FMOD_SYSTEM *system, const void *data, int datasize, FMOD_GEOMETRY **geometry); 2000 FMOD_RESULT F_API FMOD_System_GetGeometryOcclusion (FMOD_SYSTEM *system, const FMOD_VECTOR *listener, const FMOD_VECTOR *source, float *direct, float *reverb); 2001 2002 /* 2003 Network functions. 2004 */ 2005 2006 FMOD_RESULT F_API FMOD_System_SetNetworkProxy (FMOD_SYSTEM *system, const char *proxy); 2007 FMOD_RESULT F_API FMOD_System_GetNetworkProxy (FMOD_SYSTEM *system, char *proxy, int proxylen); 2008 FMOD_RESULT F_API FMOD_System_SetNetworkTimeout (FMOD_SYSTEM *system, int timeout); 2009 FMOD_RESULT F_API FMOD_System_GetNetworkTimeout (FMOD_SYSTEM *system, int *timeout); 2010 2011 /* 2012 Userdata set/get. 2013 */ 2014 2015 FMOD_RESULT F_API FMOD_System_SetUserData (FMOD_SYSTEM *system, void *userdata); 2016 FMOD_RESULT F_API FMOD_System_GetUserData (FMOD_SYSTEM *system, void **userdata); 2017 2018 FMOD_RESULT F_API FMOD_System_GetMemoryInfo (FMOD_SYSTEM *system, unsigned int memorybits, unsigned int event_memorybits, unsigned int *memoryused, FMOD_MEMORY_USAGE_DETAILS *memoryused_details); 2019 2020 /* 2021 'Sound' API 2022 */ 2023 2024 FMOD_RESULT F_API FMOD_Sound_Release (FMOD_SOUND *sound); 2025 FMOD_RESULT F_API FMOD_Sound_GetSystemObject (FMOD_SOUND *sound, FMOD_SYSTEM **system); 2026 2027 /* 2028 Standard sound manipulation functions. 2029 */ 2030 2031 FMOD_RESULT F_API FMOD_Sound_Lock (FMOD_SOUND *sound, unsigned int offset, unsigned int length, void **ptr1, void **ptr2, unsigned int *len1, unsigned int *len2); 2032 FMOD_RESULT F_API FMOD_Sound_Unlock (FMOD_SOUND *sound, void *ptr1, void *ptr2, unsigned int len1, unsigned int len2); 2033 FMOD_RESULT F_API FMOD_Sound_SetDefaults (FMOD_SOUND *sound, float frequency, float volume, float pan, int priority); 2034 FMOD_RESULT F_API FMOD_Sound_GetDefaults (FMOD_SOUND *sound, float *frequency, float *volume, float *pan, int *priority); 2035 FMOD_RESULT F_API FMOD_Sound_SetVariations (FMOD_SOUND *sound, float frequencyvar, float volumevar, float panvar); 2036 FMOD_RESULT F_API FMOD_Sound_GetVariations (FMOD_SOUND *sound, float *frequencyvar, float *volumevar, float *panvar); 2037 FMOD_RESULT F_API FMOD_Sound_Set3DMinMaxDistance (FMOD_SOUND *sound, float min, float max); 2038 FMOD_RESULT F_API FMOD_Sound_Get3DMinMaxDistance (FMOD_SOUND *sound, float *min, float *max); 2039 FMOD_RESULT F_API FMOD_Sound_Set3DConeSettings (FMOD_SOUND *sound, float insideconeangle, float outsideconeangle, float outsidevolume); 2040 FMOD_RESULT F_API FMOD_Sound_Get3DConeSettings (FMOD_SOUND *sound, float *insideconeangle, float *outsideconeangle, float *outsidevolume); 2041 FMOD_RESULT F_API FMOD_Sound_Set3DCustomRolloff (FMOD_SOUND *sound, FMOD_VECTOR *points, int numpoints); 2042 FMOD_RESULT F_API FMOD_Sound_Get3DCustomRolloff (FMOD_SOUND *sound, FMOD_VECTOR **points, int *numpoints); 2043 FMOD_RESULT F_API FMOD_Sound_SetSubSound (FMOD_SOUND *sound, int index, FMOD_SOUND *subsound); 2044 FMOD_RESULT F_API FMOD_Sound_GetSubSound (FMOD_SOUND *sound, int index, FMOD_SOUND **subsound); 2045 FMOD_RESULT F_API FMOD_Sound_SetSubSoundSentence (FMOD_SOUND *sound, int *subsoundlist, int numsubsounds); 2046 FMOD_RESULT F_API FMOD_Sound_GetName (FMOD_SOUND *sound, char *name, int namelen); 2047 FMOD_RESULT F_API FMOD_Sound_GetLength (FMOD_SOUND *sound, unsigned int *length, FMOD_TIMEUNIT lengthtype); 2048 FMOD_RESULT F_API FMOD_Sound_GetFormat (FMOD_SOUND *sound, FMOD_SOUND_TYPE *type, FMOD_SOUND_FORMAT *format, int *channels, int *bits); 2049 FMOD_RESULT F_API FMOD_Sound_GetNumSubSounds (FMOD_SOUND *sound, int *numsubsounds); 2050 FMOD_RESULT F_API FMOD_Sound_GetNumTags (FMOD_SOUND *sound, int *numtags, int *numtagsupdated); 2051 FMOD_RESULT F_API FMOD_Sound_GetTag (FMOD_SOUND *sound, const char *name, int index, FMOD_TAG *tag); 2052 FMOD_RESULT F_API FMOD_Sound_GetOpenState (FMOD_SOUND *sound, FMOD_OPENSTATE *openstate, unsigned int *percentbuffered, FMOD_BOOL *starving, FMOD_BOOL *diskbusy); 2053 FMOD_RESULT F_API FMOD_Sound_ReadData (FMOD_SOUND *sound, void *buffer, unsigned int lenbytes, unsigned int *read); 2054 FMOD_RESULT F_API FMOD_Sound_SeekData (FMOD_SOUND *sound, unsigned int pcm); 2055 2056 FMOD_RESULT F_API FMOD_Sound_SetSoundGroup (FMOD_SOUND *sound, FMOD_SOUNDGROUP *soundgroup); 2057 FMOD_RESULT F_API FMOD_Sound_GetSoundGroup (FMOD_SOUND *sound, FMOD_SOUNDGROUP **soundgroup); 2058 2059 /* 2060 Synchronization point API. These points can come from markers embedded in wav files, and can also generate channel callbacks. 2061 */ 2062 2063 FMOD_RESULT F_API FMOD_Sound_GetNumSyncPoints (FMOD_SOUND *sound, int *numsyncpoints); 2064 FMOD_RESULT F_API FMOD_Sound_GetSyncPoint (FMOD_SOUND *sound, int index, FMOD_SYNCPOINT **point); 2065 FMOD_RESULT F_API FMOD_Sound_GetSyncPointInfo (FMOD_SOUND *sound, FMOD_SYNCPOINT *point, char *name, int namelen, unsigned int *offset, FMOD_TIMEUNIT offsettype); 2066 FMOD_RESULT F_API FMOD_Sound_AddSyncPoint (FMOD_SOUND *sound, unsigned int offset, FMOD_TIMEUNIT offsettype, const char *name, FMOD_SYNCPOINT **point); 2067 FMOD_RESULT F_API FMOD_Sound_DeleteSyncPoint (FMOD_SOUND *sound, FMOD_SYNCPOINT *point); 2068 2069 /* 2070 Functions also in Channel class but here they are the 'default' to save having to change it in Channel all the time. 2071 */ 2072 2073 FMOD_RESULT F_API FMOD_Sound_SetMode (FMOD_SOUND *sound, FMOD_MODE mode); 2074 FMOD_RESULT F_API FMOD_Sound_GetMode (FMOD_SOUND *sound, FMOD_MODE *mode); 2075 FMOD_RESULT F_API FMOD_Sound_SetLoopCount (FMOD_SOUND *sound, int loopcount); 2076 FMOD_RESULT F_API FMOD_Sound_GetLoopCount (FMOD_SOUND *sound, int *loopcount); 2077 FMOD_RESULT F_API FMOD_Sound_SetLoopPoints (FMOD_SOUND *sound, unsigned int loopstart, FMOD_TIMEUNIT loopstarttype, unsigned int loopend, FMOD_TIMEUNIT loopendtype); 2078 FMOD_RESULT F_API FMOD_Sound_GetLoopPoints (FMOD_SOUND *sound, unsigned int *loopstart, FMOD_TIMEUNIT loopstarttype, unsigned int *loopend, FMOD_TIMEUNIT loopendtype); 2079 2080 /* 2081 For MOD/S3M/XM/IT/MID sequenced formats only. 2082 */ 2083 2084 FMOD_RESULT F_API FMOD_Sound_GetMusicNumChannels (FMOD_SOUND *sound, int *numchannels); 2085 FMOD_RESULT F_API FMOD_Sound_SetMusicChannelVolume (FMOD_SOUND *sound, int channel, float volume); 2086 FMOD_RESULT F_API FMOD_Sound_GetMusicChannelVolume (FMOD_SOUND *sound, int channel, float *volume); 2087 FMOD_RESULT F_API FMOD_Sound_SetMusicSpeed (FMOD_SOUND *sound, float speed); 2088 FMOD_RESULT F_API FMOD_Sound_GetMusicSpeed (FMOD_SOUND *sound, float *speed); 2089 2090 /* 2091 Userdata set/get. 2092 */ 2093 2094 FMOD_RESULT F_API FMOD_Sound_SetUserData (FMOD_SOUND *sound, void *userdata); 2095 FMOD_RESULT F_API FMOD_Sound_GetUserData (FMOD_SOUND *sound, void **userdata); 2096 2097 FMOD_RESULT F_API FMOD_Sound_GetMemoryInfo (FMOD_SOUND *sound, unsigned int memorybits, unsigned int event_memorybits, unsigned int *memoryused, FMOD_MEMORY_USAGE_DETAILS *memoryused_details); 2098 2099 /* 2100 'Channel' API 2101 */ 2102 2103 FMOD_RESULT F_API FMOD_Channel_GetSystemObject (FMOD_CHANNEL *channel, FMOD_SYSTEM **system); 2104 2105 FMOD_RESULT F_API FMOD_Channel_Stop (FMOD_CHANNEL *channel); 2106 FMOD_RESULT F_API FMOD_Channel_SetPaused (FMOD_CHANNEL *channel, FMOD_BOOL paused); 2107 FMOD_RESULT F_API FMOD_Channel_GetPaused (FMOD_CHANNEL *channel, FMOD_BOOL *paused); 2108 FMOD_RESULT F_API FMOD_Channel_SetVolume (FMOD_CHANNEL *channel, float volume); 2109 FMOD_RESULT F_API FMOD_Channel_GetVolume (FMOD_CHANNEL *channel, float *volume); 2110 FMOD_RESULT F_API FMOD_Channel_SetFrequency (FMOD_CHANNEL *channel, float frequency); 2111 FMOD_RESULT F_API FMOD_Channel_GetFrequency (FMOD_CHANNEL *channel, float *frequency); 2112 FMOD_RESULT F_API FMOD_Channel_SetPan (FMOD_CHANNEL *channel, float pan); 2113 FMOD_RESULT F_API FMOD_Channel_GetPan (FMOD_CHANNEL *channel, float *pan); 2114 FMOD_RESULT F_API FMOD_Channel_SetDelay (FMOD_CHANNEL *channel, FMOD_DELAYTYPE delaytype, unsigned int delayhi, unsigned int delaylo); 2115 FMOD_RESULT F_API FMOD_Channel_GetDelay (FMOD_CHANNEL *channel, FMOD_DELAYTYPE delaytype, unsigned int *delayhi, unsigned int *delaylo); 2116 FMOD_RESULT F_API FMOD_Channel_SetSpeakerMix (FMOD_CHANNEL *channel, float frontleft, float frontright, float center, float lfe, float backleft, float backright, float sideleft, float sideright); 2117 FMOD_RESULT F_API FMOD_Channel_GetSpeakerMix (FMOD_CHANNEL *channel, float *frontleft, float *frontright, float *center, float *lfe, float *backleft, float *backright, float *sideleft, float *sideright); 2118 FMOD_RESULT F_API FMOD_Channel_SetSpeakerLevels (FMOD_CHANNEL *channel, FMOD_SPEAKER speaker, float *levels, int numlevels); 2119 FMOD_RESULT F_API FMOD_Channel_GetSpeakerLevels (FMOD_CHANNEL *channel, FMOD_SPEAKER speaker, float *levels, int numlevels); 2120 FMOD_RESULT F_API FMOD_Channel_SetInputChannelMix (FMOD_CHANNEL *channel, float *levels, int numlevels); 2121 FMOD_RESULT F_API FMOD_Channel_GetInputChannelMix (FMOD_CHANNEL *channel, float *levels, int numlevels); 2122 FMOD_RESULT F_API FMOD_Channel_SetMute (FMOD_CHANNEL *channel, FMOD_BOOL mute); 2123 FMOD_RESULT F_API FMOD_Channel_GetMute (FMOD_CHANNEL *channel, FMOD_BOOL *mute); 2124 FMOD_RESULT F_API FMOD_Channel_SetPriority (FMOD_CHANNEL *channel, int priority); 2125 FMOD_RESULT F_API FMOD_Channel_GetPriority (FMOD_CHANNEL *channel, int *priority); 2126 FMOD_RESULT F_API FMOD_Channel_SetPosition (FMOD_CHANNEL *channel, unsigned int position, FMOD_TIMEUNIT postype); 2127 FMOD_RESULT F_API FMOD_Channel_GetPosition (FMOD_CHANNEL *channel, unsigned int *position, FMOD_TIMEUNIT postype); 2128 FMOD_RESULT F_API FMOD_Channel_SetReverbProperties (FMOD_CHANNEL *channel, const FMOD_REVERB_CHANNELPROPERTIES *prop); 2129 FMOD_RESULT F_API FMOD_Channel_GetReverbProperties (FMOD_CHANNEL *channel, FMOD_REVERB_CHANNELPROPERTIES *prop); 2130 FMOD_RESULT F_API FMOD_Channel_SetLowPassGain (FMOD_CHANNEL *channel, float gain); 2131 FMOD_RESULT F_API FMOD_Channel_GetLowPassGain (FMOD_CHANNEL *channel, float *gain); 2132 2133 FMOD_RESULT F_API FMOD_Channel_SetChannelGroup (FMOD_CHANNEL *channel, FMOD_CHANNELGROUP *channelgroup); 2134 FMOD_RESULT F_API FMOD_Channel_GetChannelGroup (FMOD_CHANNEL *channel, FMOD_CHANNELGROUP **channelgroup); 2135 FMOD_RESULT F_API FMOD_Channel_SetCallback (FMOD_CHANNEL *channel, FMOD_CHANNEL_CALLBACK callback); 2136 2137 /* 2138 3D functionality. 2139 */ 2140 2141 FMOD_RESULT F_API FMOD_Channel_Set3DAttributes (FMOD_CHANNEL *channel, const FMOD_VECTOR *pos, const FMOD_VECTOR *vel); 2142 FMOD_RESULT F_API FMOD_Channel_Get3DAttributes (FMOD_CHANNEL *channel, FMOD_VECTOR *pos, FMOD_VECTOR *vel); 2143 FMOD_RESULT F_API FMOD_Channel_Set3DMinMaxDistance (FMOD_CHANNEL *channel, float mindistance, float maxdistance); 2144 FMOD_RESULT F_API FMOD_Channel_Get3DMinMaxDistance (FMOD_CHANNEL *channel, float *mindistance, float *maxdistance); 2145 FMOD_RESULT F_API FMOD_Channel_Set3DConeSettings (FMOD_CHANNEL *channel, float insideconeangle, float outsideconeangle, float outsidevolume); 2146 FMOD_RESULT F_API FMOD_Channel_Get3DConeSettings (FMOD_CHANNEL *channel, float *insideconeangle, float *outsideconeangle, float *outsidevolume); 2147 FMOD_RESULT F_API FMOD_Channel_Set3DConeOrientation (FMOD_CHANNEL *channel, FMOD_VECTOR *orientation); 2148 FMOD_RESULT F_API FMOD_Channel_Get3DConeOrientation (FMOD_CHANNEL *channel, FMOD_VECTOR *orientation); 2149 FMOD_RESULT F_API FMOD_Channel_Set3DCustomRolloff (FMOD_CHANNEL *channel, FMOD_VECTOR *points, int numpoints); 2150 FMOD_RESULT F_API FMOD_Channel_Get3DCustomRolloff (FMOD_CHANNEL *channel, FMOD_VECTOR **points, int *numpoints); 2151 FMOD_RESULT F_API FMOD_Channel_Set3DOcclusion (FMOD_CHANNEL *channel, float directocclusion, float reverbocclusion); 2152 FMOD_RESULT F_API FMOD_Channel_Get3DOcclusion (FMOD_CHANNEL *channel, float *directocclusion, float *reverbocclusion); 2153 FMOD_RESULT F_API FMOD_Channel_Set3DSpread (FMOD_CHANNEL *channel, float angle); 2154 FMOD_RESULT F_API FMOD_Channel_Get3DSpread (FMOD_CHANNEL *channel, float *angle); 2155 FMOD_RESULT F_API FMOD_Channel_Set3DPanLevel (FMOD_CHANNEL *channel, float level); 2156 FMOD_RESULT F_API FMOD_Channel_Get3DPanLevel (FMOD_CHANNEL *channel, float *level); 2157 FMOD_RESULT F_API FMOD_Channel_Set3DDopplerLevel (FMOD_CHANNEL *channel, float level); 2158 FMOD_RESULT F_API FMOD_Channel_Get3DDopplerLevel (FMOD_CHANNEL *channel, float *level); 2159 FMOD_RESULT F_API FMOD_Channel_Set3DDistanceFilter (FMOD_CHANNEL *channel, FMOD_BOOL custom, float customLevel, float centerFreq); 2160 FMOD_RESULT F_API FMOD_Channel_Get3DDistanceFilter (FMOD_CHANNEL *channel, FMOD_BOOL *custom, float *customLevel, float *centerFreq); 2161 2162 /* 2163 DSP functionality only for channels playing sounds created with FMOD_SOFTWARE. 2164 */ 2165 2166 FMOD_RESULT F_API FMOD_Channel_GetDSPHead (FMOD_CHANNEL *channel, FMOD_DSP **dsp); 2167 FMOD_RESULT F_API FMOD_Channel_AddDSP (FMOD_CHANNEL *channel, FMOD_DSP *dsp, FMOD_DSPCONNECTION **connection); 2168 2169 /* 2170 Information only functions. 2171 */ 2172 2173 FMOD_RESULT F_API FMOD_Channel_IsPlaying (FMOD_CHANNEL *channel, FMOD_BOOL *isplaying); 2174 FMOD_RESULT F_API FMOD_Channel_IsVirtual (FMOD_CHANNEL *channel, FMOD_BOOL *isvirtual); 2175 FMOD_RESULT F_API FMOD_Channel_GetAudibility (FMOD_CHANNEL *channel, float *audibility); 2176 FMOD_RESULT F_API FMOD_Channel_GetCurrentSound (FMOD_CHANNEL *channel, FMOD_SOUND **sound); 2177 FMOD_RESULT F_API FMOD_Channel_GetSpectrum (FMOD_CHANNEL *channel, float *spectrumarray, int numvalues, int channeloffset, FMOD_DSP_FFT_WINDOW windowtype); 2178 FMOD_RESULT F_API FMOD_Channel_GetWaveData (FMOD_CHANNEL *channel, float *wavearray, int numvalues, int channeloffset); 2179 FMOD_RESULT F_API FMOD_Channel_GetIndex (FMOD_CHANNEL *channel, int *index); 2180 2181 /* 2182 Functions also found in Sound class but here they can be set per channel. 2183 */ 2184 2185 FMOD_RESULT F_API FMOD_Channel_SetMode (FMOD_CHANNEL *channel, FMOD_MODE mode); 2186 FMOD_RESULT F_API FMOD_Channel_GetMode (FMOD_CHANNEL *channel, FMOD_MODE *mode); 2187 FMOD_RESULT F_API FMOD_Channel_SetLoopCount (FMOD_CHANNEL *channel, int loopcount); 2188 FMOD_RESULT F_API FMOD_Channel_GetLoopCount (FMOD_CHANNEL *channel, int *loopcount); 2189 FMOD_RESULT F_API FMOD_Channel_SetLoopPoints (FMOD_CHANNEL *channel, unsigned int loopstart, FMOD_TIMEUNIT loopstarttype, unsigned int loopend, FMOD_TIMEUNIT loopendtype); 2190 FMOD_RESULT F_API FMOD_Channel_GetLoopPoints (FMOD_CHANNEL *channel, unsigned int *loopstart, FMOD_TIMEUNIT loopstarttype, unsigned int *loopend, FMOD_TIMEUNIT loopendtype); 2191 2192 /* 2193 Userdata set/get. 2194 */ 2195 2196 FMOD_RESULT F_API FMOD_Channel_SetUserData (FMOD_CHANNEL *channel, void *userdata); 2197 FMOD_RESULT F_API FMOD_Channel_GetUserData (FMOD_CHANNEL *channel, void **userdata); 2198 2199 FMOD_RESULT F_API FMOD_Channel_GetMemoryInfo (FMOD_CHANNEL *channel, unsigned int memorybits, unsigned int event_memorybits, unsigned int *memoryused, FMOD_MEMORY_USAGE_DETAILS *memoryused_details); 2200 2201 /* 2202 'ChannelGroup' API 2203 */ 2204 2205 FMOD_RESULT F_API FMOD_ChannelGroup_Release (FMOD_CHANNELGROUP *channelgroup); 2206 FMOD_RESULT F_API FMOD_ChannelGroup_GetSystemObject (FMOD_CHANNELGROUP *channelgroup, FMOD_SYSTEM **system); 2207 2208 /* 2209 Channelgroup scale values. (changes attributes relative to the channels, doesn't overwrite them) 2210 */ 2211 2212 FMOD_RESULT F_API FMOD_ChannelGroup_SetVolume (FMOD_CHANNELGROUP *channelgroup, float volume); 2213 FMOD_RESULT F_API FMOD_ChannelGroup_GetVolume (FMOD_CHANNELGROUP *channelgroup, float *volume); 2214 FMOD_RESULT F_API FMOD_ChannelGroup_SetPitch (FMOD_CHANNELGROUP *channelgroup, float pitch); 2215 FMOD_RESULT F_API FMOD_ChannelGroup_GetPitch (FMOD_CHANNELGROUP *channelgroup, float *pitch); 2216 FMOD_RESULT F_API FMOD_ChannelGroup_Set3DOcclusion (FMOD_CHANNELGROUP *channelgroup, float directocclusion, float reverbocclusion); 2217 FMOD_RESULT F_API FMOD_ChannelGroup_Get3DOcclusion (FMOD_CHANNELGROUP *channelgroup, float *directocclusion, float *reverbocclusion); 2218 FMOD_RESULT F_API FMOD_ChannelGroup_SetPaused (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL paused); 2219 FMOD_RESULT F_API FMOD_ChannelGroup_GetPaused (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL *paused); 2220 FMOD_RESULT F_API FMOD_ChannelGroup_SetMute (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL mute); 2221 FMOD_RESULT F_API FMOD_ChannelGroup_GetMute (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL *mute); 2222 2223 /* 2224 Channelgroup override values. (recursively overwrites whatever settings the channels had) 2225 */ 2226 2227 FMOD_RESULT F_API FMOD_ChannelGroup_Stop (FMOD_CHANNELGROUP *channelgroup); 2228 FMOD_RESULT F_API FMOD_ChannelGroup_OverrideVolume (FMOD_CHANNELGROUP *channelgroup, float volume); 2229 FMOD_RESULT F_API FMOD_ChannelGroup_OverrideFrequency(FMOD_CHANNELGROUP *channelgroup, float frequency); 2230 FMOD_RESULT F_API FMOD_ChannelGroup_OverridePan (FMOD_CHANNELGROUP *channelgroup, float pan); 2231 FMOD_RESULT F_API FMOD_ChannelGroup_OverrideReverbProperties(FMOD_CHANNELGROUP *channelgroup, const FMOD_REVERB_CHANNELPROPERTIES *prop); 2232 FMOD_RESULT F_API FMOD_ChannelGroup_Override3DAttributes(FMOD_CHANNELGROUP *channelgroup, const FMOD_VECTOR *pos, const FMOD_VECTOR *vel); 2233 FMOD_RESULT F_API FMOD_ChannelGroup_OverrideSpeakerMix(FMOD_CHANNELGROUP *channelgroup, float frontleft, float frontright, float center, float lfe, float backleft, float backright, float sideleft, float sideright); 2234 2235 /* 2236 Nested channel groups. 2237 */ 2238 2239 FMOD_RESULT F_API FMOD_ChannelGroup_AddGroup (FMOD_CHANNELGROUP *channelgroup, FMOD_CHANNELGROUP *group); 2240 FMOD_RESULT F_API FMOD_ChannelGroup_GetNumGroups (FMOD_CHANNELGROUP *channelgroup, int *numgroups); 2241 FMOD_RESULT F_API FMOD_ChannelGroup_GetGroup (FMOD_CHANNELGROUP *channelgroup, int index, FMOD_CHANNELGROUP **group); 2242 FMOD_RESULT F_API FMOD_ChannelGroup_GetParentGroup (FMOD_CHANNELGROUP *channelgroup, FMOD_CHANNELGROUP **group); 2243 2244 /* 2245 DSP functionality only for channel groups playing sounds created with FMOD_SOFTWARE. 2246 */ 2247 2248 FMOD_RESULT F_API FMOD_ChannelGroup_GetDSPHead (FMOD_CHANNELGROUP *channelgroup, FMOD_DSP **dsp); 2249 FMOD_RESULT F_API FMOD_ChannelGroup_AddDSP (FMOD_CHANNELGROUP *channelgroup, FMOD_DSP *dsp, FMOD_DSPCONNECTION **connection); 2250 2251 /* 2252 Information only functions. 2253 */ 2254 2255 FMOD_RESULT F_API FMOD_ChannelGroup_GetName (FMOD_CHANNELGROUP *channelgroup, char *name, int namelen); 2256 FMOD_RESULT F_API FMOD_ChannelGroup_GetNumChannels (FMOD_CHANNELGROUP *channelgroup, int *numchannels); 2257 FMOD_RESULT F_API FMOD_ChannelGroup_GetChannel (FMOD_CHANNELGROUP *channelgroup, int index, FMOD_CHANNEL **channel); 2258 FMOD_RESULT F_API FMOD_ChannelGroup_GetSpectrum (FMOD_CHANNELGROUP *channelgroup, float *spectrumarray, int numvalues, int channeloffset, FMOD_DSP_FFT_WINDOW windowtype); 2259 FMOD_RESULT F_API FMOD_ChannelGroup_GetWaveData (FMOD_CHANNELGROUP *channelgroup, float *wavearray, int numvalues, int channeloffset); 2260 2261 /* 2262 Userdata set/get. 2263 */ 2264 2265 FMOD_RESULT F_API FMOD_ChannelGroup_SetUserData (FMOD_CHANNELGROUP *channelgroup, void *userdata); 2266 FMOD_RESULT F_API FMOD_ChannelGroup_GetUserData (FMOD_CHANNELGROUP *channelgroup, void **userdata); 2267 2268 FMOD_RESULT F_API FMOD_ChannelGroup_GetMemoryInfo (FMOD_CHANNELGROUP *channelgroup, unsigned int memorybits, unsigned int event_memorybits, unsigned int *memoryused, FMOD_MEMORY_USAGE_DETAILS *memoryused_details); 2269 2270 /* 2271 'SoundGroup' API 2272 */ 2273 2274 FMOD_RESULT F_API FMOD_SoundGroup_Release (FMOD_SOUNDGROUP *soundgroup); 2275 FMOD_RESULT F_API FMOD_SoundGroup_GetSystemObject (FMOD_SOUNDGROUP *soundgroup, FMOD_SYSTEM **system); 2276 2277 /* 2278 SoundGroup control functions. 2279 */ 2280 2281 FMOD_RESULT F_API FMOD_SoundGroup_SetMaxAudible (FMOD_SOUNDGROUP *soundgroup, int maxaudible); 2282 FMOD_RESULT F_API FMOD_SoundGroup_GetMaxAudible (FMOD_SOUNDGROUP *soundgroup, int *maxaudible); 2283 FMOD_RESULT F_API FMOD_SoundGroup_SetMaxAudibleBehavior(FMOD_SOUNDGROUP *soundgroup, FMOD_SOUNDGROUP_BEHAVIOR behavior); 2284 FMOD_RESULT F_API FMOD_SoundGroup_GetMaxAudibleBehavior(FMOD_SOUNDGROUP *soundgroup, FMOD_SOUNDGROUP_BEHAVIOR *behavior); 2285 FMOD_RESULT F_API FMOD_SoundGroup_SetMuteFadeSpeed (FMOD_SOUNDGROUP *soundgroup, float speed); 2286 FMOD_RESULT F_API FMOD_SoundGroup_GetMuteFadeSpeed (FMOD_SOUNDGROUP *soundgroup, float *speed); 2287 FMOD_RESULT F_API FMOD_SoundGroup_SetVolume (FMOD_SOUNDGROUP *soundgroup, float volume); 2288 FMOD_RESULT F_API FMOD_SoundGroup_GetVolume (FMOD_SOUNDGROUP *soundgroup, float *volume); 2289 FMOD_RESULT F_API FMOD_SoundGroup_Stop (FMOD_SOUNDGROUP *soundgroup); 2290 2291 /* 2292 Information only functions. 2293 */ 2294 2295 FMOD_RESULT F_API FMOD_SoundGroup_GetName (FMOD_SOUNDGROUP *soundgroup, char *name, int namelen); 2296 FMOD_RESULT F_API FMOD_SoundGroup_GetNumSounds (FMOD_SOUNDGROUP *soundgroup, int *numsounds); 2297 FMOD_RESULT F_API FMOD_SoundGroup_GetSound (FMOD_SOUNDGROUP *soundgroup, int index, FMOD_SOUND **sound); 2298 FMOD_RESULT F_API FMOD_SoundGroup_GetNumPlaying (FMOD_SOUNDGROUP *soundgroup, int *numplaying); 2299 2300 /* 2301 Userdata set/get. 2302 */ 2303 2304 FMOD_RESULT F_API FMOD_SoundGroup_SetUserData (FMOD_SOUNDGROUP *soundgroup, void *userdata); 2305 FMOD_RESULT F_API FMOD_SoundGroup_GetUserData (FMOD_SOUNDGROUP *soundgroup, void **userdata); 2306 2307 FMOD_RESULT F_API FMOD_SoundGroup_GetMemoryInfo (FMOD_SOUNDGROUP *soundgroup, unsigned int memorybits, unsigned int event_memorybits, unsigned int *memoryused, FMOD_MEMORY_USAGE_DETAILS *memoryused_details); 2308 2309 /* 2310 'DSP' API 2311 */ 2312 2313 FMOD_RESULT F_API FMOD_DSP_Release (FMOD_DSP *dsp); 2314 FMOD_RESULT F_API FMOD_DSP_GetSystemObject (FMOD_DSP *dsp, FMOD_SYSTEM **system); 2315 2316 /* 2317 Connection / disconnection / input and output enumeration. 2318 */ 2319 2320 FMOD_RESULT F_API FMOD_DSP_AddInput (FMOD_DSP *dsp, FMOD_DSP *target, FMOD_DSPCONNECTION **connection); 2321 FMOD_RESULT F_API FMOD_DSP_DisconnectFrom (FMOD_DSP *dsp, FMOD_DSP *target); 2322 FMOD_RESULT F_API FMOD_DSP_DisconnectAll (FMOD_DSP *dsp, FMOD_BOOL inputs, FMOD_BOOL outputs); 2323 FMOD_RESULT F_API FMOD_DSP_Remove (FMOD_DSP *dsp); 2324 FMOD_RESULT F_API FMOD_DSP_GetNumInputs (FMOD_DSP *dsp, int *numinputs); 2325 FMOD_RESULT F_API FMOD_DSP_GetNumOutputs (FMOD_DSP *dsp, int *numoutputs); 2326 FMOD_RESULT F_API FMOD_DSP_GetInput (FMOD_DSP *dsp, int index, FMOD_DSP **input, FMOD_DSPCONNECTION **inputconnection); 2327 FMOD_RESULT F_API FMOD_DSP_GetOutput (FMOD_DSP *dsp, int index, FMOD_DSP **output, FMOD_DSPCONNECTION **outputconnection); 2328 2329 /* 2330 DSP unit control. 2331 */ 2332 2333 FMOD_RESULT F_API FMOD_DSP_SetActive (FMOD_DSP *dsp, FMOD_BOOL active); 2334 FMOD_RESULT F_API FMOD_DSP_GetActive (FMOD_DSP *dsp, FMOD_BOOL *active); 2335 FMOD_RESULT F_API FMOD_DSP_SetBypass (FMOD_DSP *dsp, FMOD_BOOL bypass); 2336 FMOD_RESULT F_API FMOD_DSP_GetBypass (FMOD_DSP *dsp, FMOD_BOOL *bypass); 2337 FMOD_RESULT F_API FMOD_DSP_SetSpeakerActive (FMOD_DSP *dsp, FMOD_SPEAKER speaker, FMOD_BOOL active); 2338 FMOD_RESULT F_API FMOD_DSP_GetSpeakerActive (FMOD_DSP *dsp, FMOD_SPEAKER speaker, FMOD_BOOL *active); 2339 FMOD_RESULT F_API FMOD_DSP_Reset (FMOD_DSP *dsp); 2340 2341 /* 2342 DSP parameter control. 2343 */ 2344 2345 FMOD_RESULT F_API FMOD_DSP_SetParameter (FMOD_DSP *dsp, int index, float value); 2346 FMOD_RESULT F_API FMOD_DSP_GetParameter (FMOD_DSP *dsp, int index, float *value, char *valuestr, int valuestrlen); 2347 FMOD_RESULT F_API FMOD_DSP_GetNumParameters (FMOD_DSP *dsp, int *numparams); 2348 FMOD_RESULT F_API FMOD_DSP_GetParameterInfo (FMOD_DSP *dsp, int index, char *name, char *label, char *description, int descriptionlen, float *min, float *max); 2349 FMOD_RESULT F_API FMOD_DSP_ShowConfigDialog (FMOD_DSP *dsp, void *hwnd, FMOD_BOOL show); 2350 2351 /* 2352 DSP attributes. 2353 */ 2354 2355 FMOD_RESULT F_API FMOD_DSP_GetInfo (FMOD_DSP *dsp, char *name, unsigned int *version, int *channels, int *configwidth, int *configheight); 2356 FMOD_RESULT F_API FMOD_DSP_GetType (FMOD_DSP *dsp, FMOD_DSP_TYPE *type); 2357 FMOD_RESULT F_API FMOD_DSP_SetDefaults (FMOD_DSP *dsp, float frequency, float volume, float pan, int priority); 2358 FMOD_RESULT F_API FMOD_DSP_GetDefaults (FMOD_DSP *dsp, float *frequency, float *volume, float *pan, int *priority); 2359 2360 /* 2361 Userdata set/get. 2362 */ 2363 2364 FMOD_RESULT F_API FMOD_DSP_SetUserData (FMOD_DSP *dsp, void *userdata); 2365 FMOD_RESULT F_API FMOD_DSP_GetUserData (FMOD_DSP *dsp, void **userdata); 2366 2367 FMOD_RESULT F_API FMOD_DSP_GetMemoryInfo (FMOD_DSP *dsp, unsigned int memorybits, unsigned int event_memorybits, unsigned int *memoryused, FMOD_MEMORY_USAGE_DETAILS *memoryused_details); 2368 2369 /* 2370 'DSPConnection' API 2371 */ 2372 2373 FMOD_RESULT F_API FMOD_DSPConnection_GetInput (FMOD_DSPCONNECTION *dspconnection, FMOD_DSP **input); 2374 FMOD_RESULT F_API FMOD_DSPConnection_GetOutput (FMOD_DSPCONNECTION *dspconnection, FMOD_DSP **output); 2375 FMOD_RESULT F_API FMOD_DSPConnection_SetMix (FMOD_DSPCONNECTION *dspconnection, float volume); 2376 FMOD_RESULT F_API FMOD_DSPConnection_GetMix (FMOD_DSPCONNECTION *dspconnection, float *volume); 2377 FMOD_RESULT F_API FMOD_DSPConnection_SetLevels (FMOD_DSPCONNECTION *dspconnection, FMOD_SPEAKER speaker, float *levels, int numlevels); 2378 FMOD_RESULT F_API FMOD_DSPConnection_GetLevels (FMOD_DSPCONNECTION *dspconnection, FMOD_SPEAKER speaker, float *levels, int numlevels); 2379 2380 /* 2381 Userdata set/get. 2382 */ 2383 2384 FMOD_RESULT F_API FMOD_DSPConnection_SetUserData (FMOD_DSPCONNECTION *dspconnection, void *userdata); 2385 FMOD_RESULT F_API FMOD_DSPConnection_GetUserData (FMOD_DSPCONNECTION *dspconnection, void **userdata); 2386 2387 FMOD_RESULT F_API FMOD_DSPConnection_GetMemoryInfo (FMOD_DSPCONNECTION *dspconnection, unsigned int memorybits, unsigned int event_memorybits, unsigned int *memoryused, FMOD_MEMORY_USAGE_DETAILS *memoryused_details); 2388 2389 /* 2390 'Geometry' API 2391 */ 2392 2393 FMOD_RESULT F_API FMOD_Geometry_Release (FMOD_GEOMETRY *geometry); 2394 2395 /* 2396 Polygon manipulation. 2397 */ 2398 2399 FMOD_RESULT F_API FMOD_Geometry_AddPolygon (FMOD_GEOMETRY *geometry, float directocclusion, float reverbocclusion, FMOD_BOOL doublesided, int numvertices, const FMOD_VECTOR *vertices, int *polygonindex); 2400 FMOD_RESULT F_API FMOD_Geometry_GetNumPolygons (FMOD_GEOMETRY *geometry, int *numpolygons); 2401 FMOD_RESULT F_API FMOD_Geometry_GetMaxPolygons (FMOD_GEOMETRY *geometry, int *maxpolygons, int *maxvertices); 2402 FMOD_RESULT F_API FMOD_Geometry_GetPolygonNumVertices(FMOD_GEOMETRY *geometry, int index, int *numvertices); 2403 FMOD_RESULT F_API FMOD_Geometry_SetPolygonVertex (FMOD_GEOMETRY *geometry, int index, int vertexindex, const FMOD_VECTOR *vertex); 2404 FMOD_RESULT F_API FMOD_Geometry_GetPolygonVertex (FMOD_GEOMETRY *geometry, int index, int vertexindex, FMOD_VECTOR *vertex); 2405 FMOD_RESULT F_API FMOD_Geometry_SetPolygonAttributes (FMOD_GEOMETRY *geometry, int index, float directocclusion, float reverbocclusion, FMOD_BOOL doublesided); 2406 FMOD_RESULT F_API FMOD_Geometry_GetPolygonAttributes (FMOD_GEOMETRY *geometry, int index, float *directocclusion, float *reverbocclusion, FMOD_BOOL *doublesided); 2407 2408 /* 2409 Object manipulation. 2410 */ 2411 2412 FMOD_RESULT F_API FMOD_Geometry_SetActive (FMOD_GEOMETRY *geometry, FMOD_BOOL active); 2413 FMOD_RESULT F_API FMOD_Geometry_GetActive (FMOD_GEOMETRY *geometry, FMOD_BOOL *active); 2414 FMOD_RESULT F_API FMOD_Geometry_SetRotation (FMOD_GEOMETRY *geometry, const FMOD_VECTOR *forward, const FMOD_VECTOR *up); 2415 FMOD_RESULT F_API FMOD_Geometry_GetRotation (FMOD_GEOMETRY *geometry, FMOD_VECTOR *forward, FMOD_VECTOR *up); 2416 FMOD_RESULT F_API FMOD_Geometry_SetPosition (FMOD_GEOMETRY *geometry, const FMOD_VECTOR *position); 2417 FMOD_RESULT F_API FMOD_Geometry_GetPosition (FMOD_GEOMETRY *geometry, FMOD_VECTOR *position); 2418 FMOD_RESULT F_API FMOD_Geometry_SetScale (FMOD_GEOMETRY *geometry, const FMOD_VECTOR *scale); 2419 FMOD_RESULT F_API FMOD_Geometry_GetScale (FMOD_GEOMETRY *geometry, FMOD_VECTOR *scale); 2420 FMOD_RESULT F_API FMOD_Geometry_Save (FMOD_GEOMETRY *geometry, void *data, int *datasize); 2421 2422 /* 2423 Userdata set/get. 2424 */ 2425 2426 FMOD_RESULT F_API FMOD_Geometry_SetUserData (FMOD_GEOMETRY *geometry, void *userdata); 2427 FMOD_RESULT F_API FMOD_Geometry_GetUserData (FMOD_GEOMETRY *geometry, void **userdata); 2428 2429 FMOD_RESULT F_API FMOD_Geometry_GetMemoryInfo (FMOD_GEOMETRY *geometry, unsigned int memorybits, unsigned int event_memorybits, unsigned int *memoryused, FMOD_MEMORY_USAGE_DETAILS *memoryused_details); 2430 2431 /* 2432 'Reverb' API 2433 */ 2434 2435 FMOD_RESULT F_API FMOD_Reverb_Release (FMOD_REVERB *reverb); 2436 2437 /* 2438 Reverb manipulation. 2439 */ 2440 2441 FMOD_RESULT F_API FMOD_Reverb_Set3DAttributes (FMOD_REVERB *reverb, const FMOD_VECTOR *position, float mindistance, float maxdistance); 2442 FMOD_RESULT F_API FMOD_Reverb_Get3DAttributes (FMOD_REVERB *reverb, FMOD_VECTOR *position, float *mindistance, float *maxdistance); 2443 FMOD_RESULT F_API FMOD_Reverb_SetProperties (FMOD_REVERB *reverb, const FMOD_REVERB_PROPERTIES *properties); 2444 FMOD_RESULT F_API FMOD_Reverb_GetProperties (FMOD_REVERB *reverb, FMOD_REVERB_PROPERTIES *properties); 2445 FMOD_RESULT F_API FMOD_Reverb_SetActive (FMOD_REVERB *reverb, FMOD_BOOL active); 2446 FMOD_RESULT F_API FMOD_Reverb_GetActive (FMOD_REVERB *reverb, FMOD_BOOL *active); 2447 2448 /* 2449 Userdata set/get. 2450 */ 2451 2452 FMOD_RESULT F_API FMOD_Reverb_SetUserData (FMOD_REVERB *reverb, void *userdata); 2453 FMOD_RESULT F_API FMOD_Reverb_GetUserData (FMOD_REVERB *reverb, void **userdata); 2454 2455 FMOD_RESULT F_API FMOD_Reverb_GetMemoryInfo (FMOD_REVERB *reverb, unsigned int memorybits, unsigned int event_memorybits, unsigned int *memoryused, FMOD_MEMORY_USAGE_DETAILS *memoryused_details); 2456 2457 #ifdef __cplusplus 2458 } 2459 #endif 2460 2461 #endif 2462 2463