AUD_Space.h

Go to the documentation of this file.

/*
 * $Id: AUD_Space.h 35141 2011-02-25 10:21:56Z jesterking $
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * Copyright 2009-2011 Jörg Hermann Müller
 *
 * This file is part of AudaSpace.
 *
 * Audaspace is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * AudaSpace is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Audaspace; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef AUD_SPACE
#define AUD_SPACE

#define AUD_FORMAT_SIZE(format) (format & 0x0F)

#define AUD_DEVICE_SAMPLE_SIZE(specs) (specs.channels * (specs.format & 0x0F))

#define AUD_SAMPLE_SIZE(specs) (specs.channels * sizeof(sample_t))

#define AUD_THROW(exception, errorstr) { AUD_Exception e; e.error = exception; e.str = errorstr; throw e; }

#define AUD_MIN(a, b) (((a) < (b)) ? (a) : (b))

#define AUD_MAX(a, b) (((a) > (b)) ? (a) : (b))

// 5 sec * 44100 samples/sec * 4 bytes/sample * 6 channels
#define AUD_BUFFER_RESIZE_BYTES 5292000

#define AUD_DEFAULT_BUFFER_SIZE 1024

typedef enum
{
        AUD_FORMAT_INVALID = 0x00,              
        AUD_FORMAT_U8      = 0x01,              
        AUD_FORMAT_S16     = 0x12,              
        AUD_FORMAT_S24     = 0x13,              
        AUD_FORMAT_S32     = 0x14,              
        AUD_FORMAT_FLOAT32 = 0x24,              
        AUD_FORMAT_FLOAT64 = 0x28               
} AUD_SampleFormat;

typedef enum
{
        AUD_CHANNELS_INVALID    = 0,    
        AUD_CHANNELS_MONO       = 1,    
        AUD_CHANNELS_STEREO     = 2,    
        AUD_CHANNELS_STEREO_LFE = 3,    
        AUD_CHANNELS_SURROUND4  = 4,    
        AUD_CHANNELS_SURROUND5  = 5,    
        AUD_CHANNELS_SURROUND51 = 6,    
        AUD_CHANNELS_SURROUND61 = 7,    
        AUD_CHANNELS_SURROUND71 = 8,    
        AUD_CHANNELS_SURROUND72 = 9             
} AUD_Channels;

typedef enum
{
        AUD_RATE_INVALID = 0,                   
        AUD_RATE_8000    = 8000,                
        AUD_RATE_16000   = 16000,               
        AUD_RATE_11025   = 11025,               
        AUD_RATE_22050   = 22050,               
        AUD_RATE_32000   = 32000,               
        AUD_RATE_44100   = 44100,               
        AUD_RATE_48000   = 48000,               
        AUD_RATE_88200   = 88200,               
        AUD_RATE_96000   = 96000,               
        AUD_RATE_192000  = 192000               
} AUD_SampleRate;

typedef enum
{
        AUD_STATUS_INVALID = 0,                 
        AUD_STATUS_PLAYING,                             
        AUD_STATUS_PAUSED                               
} AUD_Status;

typedef enum
{
        AUD_NO_ERROR = 0,
        AUD_ERROR_SPECS,
        AUD_ERROR_PROPS,
        AUD_ERROR_FILE,
        AUD_ERROR_SRC,
        AUD_ERROR_FFMPEG,
        AUD_ERROR_OPENAL,
        AUD_ERROR_SDL,
        AUD_ERROR_JACK,
} AUD_Error;

typedef enum
{
        AUD_FADE_IN,
        AUD_FADE_OUT
} AUD_FadeType;

typedef enum
{
        AUD_DISTANCE_MODEL_INVALID = 0,
        AUD_DISTANCE_MODEL_INVERSE,
        AUD_DISTANCE_MODEL_INVERSE_CLAMPED,
        AUD_DISTANCE_MODEL_LINEAR,
        AUD_DISTANCE_MODEL_LINEAR_CLAMPED,
        AUD_DISTANCE_MODEL_EXPONENT,
        AUD_DISTANCE_MODEL_EXPONENT_CLAMPED,
} AUD_DistanceModel;

typedef float sample_t;

typedef unsigned char data_t;

typedef struct
{
        AUD_SampleRate rate;

        AUD_Channels channels;
} AUD_Specs;

typedef struct
{
        AUD_SampleFormat format;

        union
        {
                struct
                {
                        AUD_SampleRate rate;

                        AUD_Channels channels;
                };
                AUD_Specs specs;
        };
} AUD_DeviceSpecs;

typedef struct
{
        AUD_Error error;

        const char* str;

        // void* userData; - for the case it is needed someday
} AUD_Exception;

#endif //AUD_SPACE