sound_legacy.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::SoundSystem class.  Allows playback of digitized audio.

  \par Copyright Information

  Copyright (c) 2015 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef _SOUND_LEGACY_H
#define _SOUND_LEGACY_H

#include "disti_include.h"

namespace disti
{

#ifdef SGI
typedef struct
{
    char *name;
    short *sampleBuffer;
    long samplesPerFrame;
    long numberSamples;
    long samplesPerBuffer;
    long audioRate;
    int  bitsPerSample;
    int  sampleFormat;
    int  byteOrder;
} SoundBuffer;
#endif

#if defined(LINUX) || defined(SUNOS)
typedef struct
{
    char   *file_name;
    void   *sample_buffer; /** Preloaded sound to play faster */
    int    frame_count;    /** How many frames in the sound */
    int    channel_count;  /** Mono (1), or Stereo (2) */
    int    sample_format;  /** Format of the sound, A Law, U Law, etc... */
    int    sample_width;   /** 8 bit, or 16 bits per sound sample */
    int    frame_size;     /** How many bytes per frame, Channels times
                             * width, e.g. (mono (1)) * (8 bit (1)) = 1 bytes
                             * (Stereo (2)) * (16 bit (2)) = 4 bytes */
    double rate;           /** Sampling frequency of the sound in Hz */
} SoundBuffer;  
#endif

class SoundSystem
{
    int _maxSounds;            /** Maximum number of supported sounds */
    
#ifndef _WIN32
        SoundBuffer *_sounds;  /** A dynamically allocated array of SoundBuffers */
#endif
    char **audioptr;

    public:

    /** Creates a new sound system
      * \param maxSounds  Maximum number of soundfiles in the sound system
      */
    DISTI_EXPORT SoundSystem(int maxSounds);
    DISTI_EXPORT ~SoundSystem(void);

    /** Plays the sound at the given index
      * \param which The zero based index of the sound to play
      */
    DISTI_EXPORT void Play(int which);

    /** Plays the sound at the given index,  attenuated for distancec
      * \param which The zero based index of the sound to play
      * \param distance The distance in meters of the sound
      */
    DISTI_EXPORT void Play(int which,float distance);

    /** Loads the sound from a file into a slot in the sound system
      * \param fn The name of the file to load from
      * \param index The zero based index to load the file into
      */
    DISTI_EXPORT void LoadSound(char *fn,int index);

    /** Loads a number of sounds from files into the sound system
      * The sounds are loaded sequentially starting at slot zero
      * \param firstArg Filenames to load, followed by a NULL
      */
    DISTI_EXPORT void LoadSounds(char *firstArg, ...);

    /** Deletes the sound from the given index
      * \param index Zero based index to clear
      */
    DISTI_EXPORT void ClearSound(int index);
};

} // namespace disti

#endif