FS2_Open
Open source remastering of the Freespace 2 engine
Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
AudioStream Class Reference

Public Member Functions

 AudioStream (void)
 
 ~AudioStream (void)
 
bool Create (char *pszFilename)
 
bool Destroy (void)
 
void Play (float volume, int looping)
 
bool Is_Playing ()
 
bool Is_Paused ()
 
bool Is_Past_Limit ()
 
void Stop (int paused=0)
 
void Stop_and_Rewind (void)
 
void Fade_and_Destroy (void)
 
void Fade_and_Stop (void)
 
void Set_Volume (float vol)
 
float Get_Volume ()
 
void Init_Data ()
 
void Set_Sample_Cutoff (uint sample_cutoff)
 
void Set_Default_Volume (float vol)
 
float Get_Default_Volume ()
 
uint Get_Samples_Committed (void)
 
int Is_looping ()
 

Public Attributes

int status
 
int type
 
bool paused_via_sexp_or_script
 
ushort m_bits_per_sample_uncompressed
 

Protected Member Functions

void Cue (void)
 
bool WriteWaveData (uint cbSize, uint *num_bytes_written, int service=1)
 
uint GetMaxWriteSize (void)
 
bool ServiceBuffer (void)
 
bool PlaybackDone (void)
 

Static Protected Member Functions

static bool TimerCallback (ptr_u dwUser)
 

Protected Attributes

ALuint m_source_id
 
ALuint m_buffer_ids [MAX_STREAM_BUFFERS]
 
Timer m_timer
 
WaveFile * m_pwavefile
 
bool m_fCued
 
bool m_fPlaying
 
uint m_cbBufOffset
 
uint m_cbBufSize
 
uint m_nBufService
 
uint m_nTimeStarted
 
bool m_bLooping
 
bool m_bFade
 
bool m_bDestroy_when_faded
 
float m_lVolume
 
float m_lCutoffVolume
 
bool m_bIsPaused
 
bool m_bReadingDone
 
uint m_fade_timer_id
 
uint m_finished_id
 
bool m_bPastLimit
 
float m_lDefaultVolume
 
CRITICAL_SECTION write_lock
 

Detailed Description

Definition at line 234 of file audiostr.cpp.

Constructor & Destructor Documentation

AudioStream::AudioStream ( void  )

Definition at line 1039 of file audiostr.cpp.

AudioStream::~AudioStream ( void  )

Definition at line 1045 of file audiostr.cpp.

Member Function Documentation

bool AudioStream::Create ( char *  pszFilename)

Definition at line 1076 of file audiostr.cpp.

void AudioStream::Cue ( void  )
protected

Definition at line 1411 of file audiostr.cpp.

bool AudioStream::Destroy ( void  )

Definition at line 1165 of file audiostr.cpp.

void AudioStream::Fade_and_Destroy ( void  )

Have stream fade out and be destroyed when inaudabile. If stream is already done or never started just destroy it now.

Definition at line 1512 of file audiostr.cpp.

void AudioStream::Fade_and_Stop ( void  )

Definition at line 1526 of file audiostr.cpp.

float AudioStream::Get_Default_Volume ( )
inline

Definition at line 254 of file audiostr.cpp.

uint AudioStream::Get_Samples_Committed ( void  )

Definition at line 1500 of file audiostr.cpp.

float AudioStream::Get_Volume ( )

Definition at line 1591 of file audiostr.cpp.

uint AudioStream::GetMaxWriteSize ( void  )
protected

Definition at line 1283 of file audiostr.cpp.

void AudioStream::Init_Data ( )

Definition at line 1050 of file audiostr.cpp.

int AudioStream::Is_looping ( )
inline

Definition at line 256 of file audiostr.cpp.

bool AudioStream::Is_Past_Limit ( )
inline

Definition at line 244 of file audiostr.cpp.

bool AudioStream::Is_Paused ( )
inline

Definition at line 243 of file audiostr.cpp.

bool AudioStream::Is_Playing ( )
inline

Definition at line 242 of file audiostr.cpp.

void AudioStream::Play ( float  volume,
int  looping 
)

Definition at line 1449 of file audiostr.cpp.

bool AudioStream::PlaybackDone ( void  )
protected

Definition at line 1596 of file audiostr.cpp.

bool AudioStream::ServiceBuffer ( void  )
protected

Definition at line 1301 of file audiostr.cpp.

void AudioStream::Set_Default_Volume ( float  vol)
inline

Definition at line 253 of file audiostr.cpp.

void AudioStream::Set_Sample_Cutoff ( uint  sample_cutoff)

Definition at line 1492 of file audiostr.cpp.

void AudioStream::Set_Volume ( float  vol)

Definition at line 1580 of file audiostr.cpp.

void AudioStream::Stop ( int  paused = 0)

Definition at line 1534 of file audiostr.cpp.

void AudioStream::Stop_and_Rewind ( void  )

Definition at line 1552 of file audiostr.cpp.

bool AudioStream::TimerCallback ( ptr_u  dwUser)
staticprotected

Definition at line 1484 of file audiostr.cpp.

bool AudioStream::WriteWaveData ( uint  cbSize,
uint *  num_bytes_written,
int  service = 1 
)
protected

Definition at line 1207 of file audiostr.cpp.

Member Data Documentation

bool AudioStream::m_bDestroy_when_faded
protected

Definition at line 284 of file audiostr.cpp.

bool AudioStream::m_bFade
protected

Definition at line 283 of file audiostr.cpp.

bool AudioStream::m_bIsPaused
protected

Definition at line 287 of file audiostr.cpp.

ushort AudioStream::m_bits_per_sample_uncompressed

Definition at line 260 of file audiostr.cpp.

bool AudioStream::m_bLooping
protected

Definition at line 282 of file audiostr.cpp.

bool AudioStream::m_bPastLimit
protected

Definition at line 291 of file audiostr.cpp.

bool AudioStream::m_bReadingDone
protected

Definition at line 288 of file audiostr.cpp.

ALuint AudioStream::m_buffer_ids[MAX_STREAM_BUFFERS]
protected

Definition at line 271 of file audiostr.cpp.

uint AudioStream::m_cbBufOffset
protected

Definition at line 277 of file audiostr.cpp.

uint AudioStream::m_cbBufSize
protected

Definition at line 278 of file audiostr.cpp.

uint AudioStream::m_fade_timer_id
protected

Definition at line 289 of file audiostr.cpp.

bool AudioStream::m_fCued
protected

Definition at line 275 of file audiostr.cpp.

uint AudioStream::m_finished_id
protected

Definition at line 290 of file audiostr.cpp.

bool AudioStream::m_fPlaying
protected

Definition at line 276 of file audiostr.cpp.

float AudioStream::m_lCutoffVolume
protected

Definition at line 286 of file audiostr.cpp.

float AudioStream::m_lDefaultVolume
protected

Definition at line 292 of file audiostr.cpp.

float AudioStream::m_lVolume
protected

Definition at line 285 of file audiostr.cpp.

uint AudioStream::m_nBufService
protected

Definition at line 279 of file audiostr.cpp.

uint AudioStream::m_nTimeStarted
protected

Definition at line 280 of file audiostr.cpp.

WaveFile* AudioStream::m_pwavefile
protected

Definition at line 274 of file audiostr.cpp.

ALuint AudioStream::m_source_id
protected

Definition at line 270 of file audiostr.cpp.

Timer AudioStream::m_timer
protected

Definition at line 273 of file audiostr.cpp.

bool AudioStream::paused_via_sexp_or_script

Definition at line 259 of file audiostr.cpp.

int AudioStream::status

Definition at line 257 of file audiostr.cpp.

int AudioStream::type

Definition at line 258 of file audiostr.cpp.

CRITICAL_SECTION AudioStream::write_lock
protected

Definition at line 294 of file audiostr.cpp.

The documentation for this class was generated from the following file: