libgig  3.3.0
DLS::Sampler Class Reference

Abstract base class which provides mandatory informations about sample players in general. More...

#include <DLS.h>

Inheritance diagram for DLS::Sampler:
DLS::Region gig::DimensionRegion gig::Region

Public Member Functions

void AddSampleLoop (sample_loop_t *pLoopDef)
 Adds a new sample loop with the provided loop definition.
void DeleteSampleLoop (sample_loop_t *pLoopDef)
 Deletes an existing sample loop.
virtual void SetGain (int32_t gain)
virtual void UpdateChunks ()
 Apply all sample player options to the respective RIFF chunk.

Public Attributes

uint8_t UnityNote
int16_t FineTune
int32_t Gain
bool NoSampleDepthTruncation
bool NoSampleCompression
uint32_t SampleLoops
 Reflects the number of sample loops.
sample_loop_tpSampleLoops
 Points to the beginning of a sample loop array, or is NULL if there are no loops defined.

Protected Member Functions

 Sampler (RIFF::List *ParentList)
virtual ~Sampler ()

Protected Attributes

RIFF::ListpParentList
uint32_t uiHeaderSize
uint32_t SamplerOptions

Detailed Description

Abstract base class which provides mandatory informations about sample players in general.

Definition at line 356 of file DLS.h.

Constructor & Destructor Documentation

DLS::Sampler::~Sampler ( )
protectedvirtual

Definition at line 527 of file DLS.cpp.

References pSampleLoops.

Member Function Documentation

void DLS::Sampler::AddSampleLoop ( sample_loop_t pLoopDef)

Adds a new sample loop with the provided loop definition.

Parameters
pLoopDef- points to a loop definition that is to be copied

Definition at line 576 of file DLS.cpp.

References pSampleLoops, SampleLoops, and DLS::sample_loop_t::Size.

void DLS::Sampler::DeleteSampleLoop ( sample_loop_t pLoopDef)

Deletes an existing sample loop.

Parameters
pLoopDef- pointer to existing loop definition
Exceptions
Exception- if given loop definition does not exist

Definition at line 598 of file DLS.cpp.

References pSampleLoops, and SampleLoops.

void DLS::Sampler::SetGain ( int32_t  gain)
virtual

Reimplemented in gig::DimensionRegion.

Definition at line 531 of file DLS.cpp.

References Gain.

void DLS::Sampler::UpdateChunks ( )
virtual

Member Data Documentation

int16_t DLS::Sampler::FineTune

Definition at line 359 of file DLS.h.

Referenced by Sampler(), and UpdateChunks().

int32_t DLS::Sampler::Gain
Deprecated:
Don't alter directly, use SetGain() instead!

Definition at line 360 of file DLS.h.

Referenced by gig::DimensionRegion::DimensionRegion(), Sampler(), SetGain(), gig::DimensionRegion::SetGain(), and UpdateChunks().

bool DLS::Sampler::NoSampleCompression

Definition at line 362 of file DLS.h.

Referenced by Sampler(), and UpdateChunks().

bool DLS::Sampler::NoSampleDepthTruncation

Definition at line 361 of file DLS.h.

Referenced by Sampler(), and UpdateChunks().

RIFF::List* DLS::Sampler::pParentList
protected
sample_loop_t* DLS::Sampler::pSampleLoops

Points to the beginning of a sample loop array, or is NULL if there are no loops defined.

Definition at line 364 of file DLS.h.

Referenced by AddSampleLoop(), DeleteSampleLoop(), gig::DimensionRegion::DimensionRegion(), gig::Sample::ReadAndLoop(), Sampler(), UpdateChunks(), and ~Sampler().

uint32_t DLS::Sampler::SampleLoops
uint32_t DLS::Sampler::SamplerOptions
protected

Definition at line 373 of file DLS.h.

Referenced by gig::DimensionRegion::DimensionRegion(), Sampler(), and UpdateChunks().

uint32_t DLS::Sampler::uiHeaderSize
protected

Definition at line 372 of file DLS.h.

Referenced by Sampler(), and UpdateChunks().

uint8_t DLS::Sampler::UnityNote

Definition at line 358 of file DLS.h.

Referenced by Sampler(), and UpdateChunks().


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