audio3d.h

Go to the documentation of this file.

/*
 * audio3d.h
 *
 * Copyright (C) 2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Basic 3D sound support
 */

#ifndef WAVE_AUDIO_AUDIO3D_H__
#define WAVE_AUDIO_AUDIO3D_H__

// includes --------------------------------------------------------------------
#include "common/common.h"

#include "audiere/audiere.h"
#include "geometry/geometry_3d.h"
#include "threadsafe/smart_ptr.h"


namespace audio3d {




//
//      public API
//

typedef dword_t id_t;



class SoundManager {
public:
        // virtual destructor --------------------------------------------------
        virtual ~SoundManager(void) throw();

        // audio3d::SoundManager class interface methods -----------------------

        virtual id_t createListener(void) = 0;

        virtual void updateListener(IN id_t listenerId,
                                IN const point3d_t& position,
                                IN const point3d_t& facing,
                                IN const point3d_t& up) = 0;

        virtual bool removeListener(IN id_t listenerId) = 0;

        virtual id_t createSound(IN id_t listenerId,
                                IN const char * filename,
                                IN float baseVolume) = 0;

        virtual void updateSound(IN id_t soundId,
                                IN const point3d_t& position) = 0;

        virtual bool removeSound(IN id_t soundId) = 0;

        virtual void updateSounds(void) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<SoundManager> create(IN const char * device_name,
                                IN const char * parameters);
};



};      // audio3d namespace


#endif  // WAVE_AUDIO_AUDIO3D_H__