include/sound/orxSound.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2011 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxSOUND_H_
#define _orxSOUND_H_


#include "orxInclude.h"
#include "sound/orxSoundSystem.h"
#include "math/orxVector.h"


typedef enum __orxSOUND_STATUS_t
{
  orxSOUND_STATUS_PLAY = 0,
  orxSOUND_STATUS_PAUSE,
  orxSOUND_STATUS_STOP,

  orxSOUND_STATUS_NUMBER,

  orxSOUND_STATUS_NONE = orxENUM_NONE

} orxSOUND_STATUS;


typedef struct __orxSOUND_t                   orxSOUND;


typedef enum __orxSOUND_EVENT_t
{
  orxSOUND_EVENT_START = 0,                   
  orxSOUND_EVENT_STOP,                        
  orxSOUND_EVENT_PACKET,                      
  orxSOUND_EVENT_RECORDING_START,             
  orxSOUND_EVENT_RECORDING_STOP,              
  orxSOUND_EVENT_RECORDING_PACKET,            
  orxSOUND_EVENT_NUMBER,

  orxSOUND_EVENT_NONE = orxENUM_NONE

} orxSOUND_EVENT;

typedef struct __orxSOUND_STREAM_INFO_t
{
  orxU32    u32SampleRate;                    
  orxU32    u32ChannelNumber;                 
} orxSOUND_STREAM_INFO;

typedef struct __orxSOUND_STREAM_PACKET_t
{
  orxU32    u32SampleNumber;                  
  orxS16   *as16SampleList;                   
  orxBOOL   bDiscard;                         
  orxFLOAT  fTimeStamp;                       
} orxSOUND_STREAM_PACKET;

typedef struct __orxSOUND_EVENT_PAYLOAD_t
{
  const orxSTRING               zSoundName;   
  union
  {
    orxSOUND                   *pstSound;     
    struct
    {
      orxSOUND_STREAM_INFO      stInfo;       
      orxSOUND_STREAM_PACKET    stPacket;     
    } stStream;
  };                                          
} orxSOUND_EVENT_PAYLOAD;


extern orxDLLAPI void orxFASTCALL             orxSound_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_Init();

extern orxDLLAPI void orxFASTCALL             orxSound_Exit();


extern orxDLLAPI orxSOUND *orxFASTCALL        orxSound_CreateFromConfig(const orxSTRING _zConfigID);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_Delete(orxSOUND *_pstSound);


extern orxDLLAPI orxBOOL orxFASTCALL          orxSound_IsStream(orxSOUND *_pstSound);


extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_Play(orxSOUND *_pstSound);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_Pause(orxSOUND *_pstSound);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_Stop(orxSOUND *_pstSound);


extern orxDLLAPI orxSTATUS orxFASTCALL                orxSound_StartRecording(const orxCHAR *_zName, orxBOOL _bWriteToFile, orxU32 _u32SampleRate, orxU32 _u32ChannelNumber);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxSound_StopRecording();

extern orxDLLAPI orxBOOL orxFASTCALL                  orxSound_HasRecordingSupport();


extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_SetVolume(orxSOUND *_pstSound, orxFLOAT _fVolume);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_SetPitch(orxSOUND *_pstSound, orxFLOAT _fPitch);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_SetPosition(orxSOUND *_pstSound, const orxVECTOR *_pvPosition);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_SetAttenuation(orxSOUND *_pstSound, orxFLOAT _fAttenuation);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_SetReferenceDistance(orxSOUND *_pstSound, orxFLOAT _fDistance);

extern orxDLLAPI orxSTATUS orxFASTCALL        orxSound_Loop(orxSOUND *_pstSound, orxBOOL _bLoop);


extern orxDLLAPI orxFLOAT orxFASTCALL         orxSound_GetVolume(const orxSOUND *_pstSound);

extern orxDLLAPI orxFLOAT orxFASTCALL         orxSound_GetPitch(const orxSOUND *_pstSound);

extern orxDLLAPI orxVECTOR *orxFASTCALL       orxSound_GetPosition(const orxSOUND *_pstSound, orxVECTOR *_pvPosition);

extern orxDLLAPI orxFLOAT orxFASTCALL         orxSound_GetAttenuation(const orxSOUND *_pstSound);

extern orxDLLAPI orxFLOAT orxFASTCALL         orxSound_GetReferenceDistance(const orxSOUND *_pstSound);

extern orxDLLAPI orxBOOL orxFASTCALL          orxSound_IsLooping(const orxSOUND *_pstSound);


extern orxDLLAPI orxFLOAT orxFASTCALL         orxSound_GetDuration(const orxSOUND *_pstSound);

extern orxDLLAPI orxSOUND_STATUS orxFASTCALL  orxSound_GetStatus(const orxSOUND *_pstSound);

extern orxDLLAPI const orxSTRING orxFASTCALL  orxSound_GetName(const orxSOUND *_pstSound);

#endif /*_orxSOUND_H_*/