OpenSceneGraph osgAL
OpenSceneGraph Audio Library (osgAL)
osgAL is a toolkit for handling spatial (3D) sound in the OpenSceneGraph rendering library. It utilizes OpenAL++ which is an portable object oriented toolkit ontop of OpenAL. It has been compiled and tested under Windows (.NET2003) and Linux (gcc3.5).
Documentation
API reference
Dependencies
osgAL depends on OpenAL++ and OpenSceneGraph. It has been compiled with OSG 0.9.9. Download and build OpenAL++ and OSG and install header files and library files where the compiler can find them.
Under Windows, you have to setup the INCLUDE, LIB and PATH path, which can be done with the Environment variables
DOS> set INCLUDE=%INCLUDE%;c:\tools\openalpp\include DOS> set LIB=%LIB%;c:\tools\openalpp\lib DOS> set PATH=%PATH%;c:\tools\openalpp\bin
respectively.
Basic Concepts
There are five main classes:
SoundManager
SoundState
SoundNode
SoundRoot
SoundOccluder
SoundState
A SoundState is a small lightweight class that contains a reference to a osgAL::Sample and the settings for a Sample. This class does nothing more than keeping this Sample and its associated attributes together. It can either have a osgAL::SoundSource (usually a limited resources, 32 or more) associated to it. Sometimes it is necessary to allocate a hardware soundsource to a soundstate, for example looping sounds with ambient sound or music.
SoundNode
SoundSource is derived from osg::Node and can be inserted into the scenegraph wherever one wants it to be. During update traversal it will calculate its world position and position the associated SoundState to right orientation and position. No culling is done currently.
SoundManager
The SoundManager is responsible for handling queued SoundStates (for sound events described below) and to store all SoundStates to make it possible to find them later on.
SoundRoot
A node that during cull traversal updates the SoundManager and updates the transformation for the current listener from the current modelView matrix. This could be done manually, but this node makes it all happen automatically during the cull traversal, which reduces the need of inserting code in the viewer run loop.
OccludeCallback
This is a callback class, called during the update of the transformation of the SoundNode. If enabled this callback will shoot a ray from the listener to this SoundNode. If this ray is unoccluded nothing will happen. But if this ray is occluded by some geometry, the gain of the SoundState associated to this node will be reduced by some amount. The functionality of this callback can be extended by inheriting from OccludeCallback and attaching it to the SoundNode.
Sound Events
There is a concept that I call event, for example an explosion is a typical event where a short sound is played once. Another example is the contact sound generated from two colliding objects. When using for example rigid body dynamics, there can be a lot of sound events when objects collides, therefore, the osgAL::SoundManager has a method called pushSoundEvent(osgAL::SoundState *, int priority)
This method takes a SoundState as argument. By making a copy of this SoundState (it uses an internal flyweight pattern to avoid creating new SoundStates on the fly) it builds up a queue of SoundStates. Theese SoundStates are played one by one by the SoundManager during its update() call. This makes it possible to have a lot of SoundStates "playing" when there is a real shortage of hardware sound sources (usually 32 or so).
IO Support
Thanks to a great contribution of Alberto Jaspe, videaLAB, University of La Coruña ([email protected]), osgAL now also support IO. This is easily tested by running one of the sample application, (i.e. osgal) and press 'o' to save the current scene to a file named saved_model.osg. The file saved_model.osg will then also contain the information from osgAL regarding soundnodes, soundstates etc...
This means that scenes containing sound can also be authored through the .osg file format. The best documentation for the file format is to look into an existing file, in the /data subdirectory there are a few sample scenes.
Example
osgal.cpp - Code for testapplication.
osgalmultiple.cpp - Shows dynamic allocation/deallocation of samples.
osgalocclude.cpp - Demonstrates a simple sound occlusion example.
To run the examples:
Change directory to the data sub-directory that contains the bee.wav sample file (data). Start the test application with osgal (make sure you have the path to the dynamic libraries (OSG, Producer, OpenThreads, OpenAL++ and osgAL).
Keybindings
space - Pushes a SoundState as an Event (non-looping). Results in a sound that plays once at the position of the listener. Pressing it repeatedly will add even more SoundStates...
The examples demonstrates the basic functionality of the OSGAL toolkit:
Creating an osgal::Sample (which holds the .wav sample file)
Creating an osgAL::SoundState (which holds a Sample and settings)
Creating an osgAL::SoundNode (which holds a SoundState) and attaching it to a transformation node to make it move.
Creating an osgAL::SoundRoot (which updates the SoundManager and the transformation of the listener according to the modelViewMatrix).
Accessing the osgAL::SoundManager to add SoundStates and pushing SoundStates as events.
Handling occlusions of geometry in the scene
Comments
Direct your comments, bug reports to [email protected]