libgig  3.3.0
gig::Region Class Reference

Defines Region information of an Instrument. More...

#include <gig.h>

Inheritance diagram for gig::Region:
DLS::Region DLS::Resource DLS::Articulator DLS::Sampler

Public Member Functions

DimensionRegionGetDimensionRegionByValue (const uint DimValues[8])
 Use this method in your audio engine to get the appropriate dimension region with it's articulation data for the current situation.
DimensionRegionGetDimensionRegionByBit (const uint8_t DimBits[8])
 Returns the appropriate DimensionRegion for the given dimension bit numbers (zone index).
SampleGetSample ()
 Returns pointer address to the Sample referenced with this region.
void AddDimension (dimension_def_t *pDimDef)
 Einstein would have dreamed of it - create a new dimension.
void DeleteDimension (dimension_def_t *pDimDef)
 Delete an existing dimension.
virtual void SetKeyRange (uint16_t Low, uint16_t High)
 Modifies the key range of this Region and makes sure the respective chunks are in correct order.
virtual void UpdateChunks ()
 Apply Region settings and all its DimensionRegions to the respective RIFF chunks.
void SetSample (Sample *pSample)
 Assign another sample to this Region.
ResourceGetParent ()
void GenerateDLSID ()
 Generates a new DLSID for the resource.
Articulation * GetFirstArticulation ()
Articulation * GetNextArticulation ()
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)

Public Attributes

unsigned int Dimensions
 Number of defined dimensions, do not alter!
dimension_def_t pDimensionDefinitions [8]
 Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one.
uint32_t DimensionRegions
 Total number of DimensionRegions this Region contains, do not alter!
DimensionRegionpDimensionRegions [256]
 Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one (which will create or delete the respective dimension region(s) automatically).
unsigned int Layers
 Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there is Layer dimension. The same information can of course also be obtained by accessing pDimensionDefinitions. Do not alter this value!
range_t KeyRange
range_t VelocityRange
uint16_t KeyGroup
uint16_t Layer
bool SelfNonExclusive
bool PhaseMaster
uint16_t PhaseGroup
bool MultiChannel
uint32_t Channel
Info * pInfo
 Points (in any case) to an Info object, providing additional, optional infos and comments.
dlsid_t * pDLSID
 Points to a dlsid_t structure if the file provided a DLS ID else is NULL.
uint8_t UnityNote
int16_t FineTune
int32_t Gain
bool NoSampleDepthTruncation
bool NoSampleCompression
uint32_t SampleLoops
 Reflects the number of sample loops.
sample_loop_t * pSampleLoops
 Points to the beginning of a sample loop array, or is NULL if there are no loops defined.

Protected Types

typedef std::list< Articulation * > ArticulationList

Protected Member Functions

 Region (Instrument *pInstrument, RIFF::List *rgnList)
void LoadDimensionRegions (RIFF::List *rgn)
void UpdateVelocityTable ()
SampleGetSampleFromWavePool (unsigned int WavePoolTableIndex, progress_t *pProgress=NULL)
 ~Region ()
 Destructor.
void LoadArticulations ()

Protected Attributes

RIFF::ListpCkRegion
uint32_t WavePoolTableIndex
SamplepSample
uint16_t FormatOptionFlags
uint16_t WaveLinkOptionFlags
ResourcepParent
RIFF::ListpResourceList
RIFF::ListpParentList
RIFF::ListpParentList
ArticulationListpArticulations
ArticulationList::iterator ArticulationsIterator
uint32_t uiHeaderSize
uint32_t SamplerOptions

Friends

class Instrument

Detailed Description

Defines Region information of an Instrument.

Definition at line 616 of file gig.h.

Member Typedef Documentation

typedef std::list<Articulation*> DLS::Articulator::ArticulationList
protectedinherited

Definition at line 290 of file DLS.h.

Constructor & Destructor Documentation

gig::Region::~Region ( )
protectedvirtual

Destructor.

Removes RIFF chunks associated with this Region.

Reimplemented from DLS::Region.

Definition at line 2809 of file gig.cpp.

References pDimensionRegions.

Member Function Documentation

void gig::Region::AddDimension ( dimension_def_t pDimDef)

Einstein would have dreamed of it - create a new dimension.

Creates a new dimension with the dimension definition given by pDimDef. The appropriate amount of DimensionRegions will be created. There is a hard limit of dimensions and total amount of "bits" all dimensions can have. This limit is dependant to what gig file format version this file refers to. The gig v2 (and lower) format has a dimension limit and total amount of bits limit of 5, whereas the gig v3 format has a limit of 8.

Parameters
pDimDef- defintion of the new dimension
Exceptions
gig::Exceptionif dimension of the same type exists already
gig::Exceptionif amount of dimensions or total amount of dimension bits limit is violated

Definition at line 2633 of file gig.cpp.

References RIFF::List::AddSubList(), gig::dimension_def_t::bits, gig::dimension_def_t::dimension, gig::dimension_layer, gig::dimension_samplechannel, DimensionRegions, Dimensions, gig::DimensionRegion::DimensionUpperLimits, DLS::Resource::GetParent(), RIFF::List::GetSubList(), Layers, LIST_TYPE_3EWL, LIST_TYPE_3PRG, DLS::version_t::major, RIFF::List::MoveSubChunk(), DLS::Region::pCkRegion, pDimensionDefinitions, pDimensionRegions, DLS::Sampler::pParentList, DLS::File::pVersion, gig::dimension_def_t::split_type, UpdateVelocityTable(), gig::dimension_def_t::zone_size, and gig::dimension_def_t::zones.

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

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 DLS::Sampler::pSampleLoops, DLS::Sampler::SampleLoops, and DLS::sample_loop_t::Size.

void gig::Region::DeleteDimension ( dimension_def_t pDimDef)

Delete an existing dimension.

Deletes the dimension given by pDimDef and deletes all respective dimension regions, that is all dimension regions where the dimension's bit(s) part is greater than 0. In case of a 'sustain pedal' dimension for example this would delete all dimension regions for the case(s) where the sustain pedal is pressed down.

Parameters
pDimDef- dimension to delete
Exceptions
gig::Exceptionif given dimension cannot be found

Definition at line 2733 of file gig.cpp.

References gig::dimension_def_t::bits, RIFF::List::DeleteSubChunk(), gig::dimension_def_t::dimension, gig::dimension_layer, gig::dimension_none, DimensionRegions, Dimensions, gig::DimensionRegion::DimensionUpperLimits, RIFF::List::GetSubList(), Layers, LIST_TYPE_3PRG, DLS::Region::pCkRegion, pDimensionDefinitions, pDimensionRegions, DLS::Articulator::pParentList, and gig::dimension_def_t::zones.

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

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 DLS::Sampler::pSampleLoops, and DLS::Sampler::SampleLoops.

void DLS::Resource::GenerateDLSID ( )
inherited

Generates a new DLSID for the resource.

Definition at line 450 of file DLS.cpp.

References DLS::dlsid_t::abData, DLS::Resource::pDLSID, DLS::dlsid_t::ulData1, DLS::dlsid_t::usData2, and DLS::dlsid_t::usData3.

Referenced by gig::File::AddInstrument(), and gig::File::File().

DimensionRegion * gig::Region::GetDimensionRegionByBit ( const uint8_t  DimBits[8])

Returns the appropriate DimensionRegion for the given dimension bit numbers (zone index).

You usually use GetDimensionRegionByValue instead of calling this method directly!

Parameters
DimBitsBit numbers for dimension 0 to 7
Returns
adress to the DimensionRegion for the given dimension bit numbers
See Also
GetDimensionRegionByValue()

Definition at line 2890 of file gig.cpp.

References gig::dimension_def_t::bits, pDimensionDefinitions, and pDimensionRegions.

DimensionRegion * gig::Region::GetDimensionRegionByValue ( const uint  DimValues[8])

Use this method in your audio engine to get the appropriate dimension region with it's articulation data for the current situation.

Just call the method with the current MIDI controller values and you'll get the DimensionRegion with the appropriate articulation data for the current situation (for this Region of course only). To do that you'll first have to look which dimensions with which controllers and in which order are defined for this Region when you load the .gig file. Special cases are e.g. layer or channel dimensions where you just put in the index numbers instead of a MIDI controller value (means 0 for left channel, 1 for right channel or 0 for layer 0, 1 for layer 1, etc.).

Parameters
DimValuesMIDI controller values (0-127) for dimension 0 to 7
Returns
adress to the DimensionRegion for the given situation
See Also
pDimensionDefinitions
Dimensions

Definition at line 2833 of file gig.cpp.

References gig::dimension_def_t::bits, gig::dimension_velocity, Dimensions, pDimensionDefinitions, pDimensionRegions, gig::split_type_bit, gig::split_type_normal, gig::DimensionRegion::VelocityTable, and gig::dimension_def_t::zones.

Articulation * DLS::Articulator::GetFirstArticulation ( )
inherited
Articulation * DLS::Articulator::GetNextArticulation ( )
inherited
Sample * gig::Region::GetSample ( )

Returns pointer address to the Sample referenced with this region.

This is the global Sample for the entire Region (not sure if this is actually used by the Gigasampler engine - I would only use the Sample referenced by the appropriate DimensionRegion instead of this sample).

Returns
address to Sample or NULL if there is no reference to a sample saved in the .gig file

Reimplemented from DLS::Region.

Definition at line 2909 of file gig.cpp.

References GetSampleFromWavePool(), DLS::Region::pSample, and DLS::Region::WavePoolTableIndex.

Referenced by Region().

Sample * gig::Region::GetSampleFromWavePool ( unsigned int  WavePoolTableIndex,
progress_t pProgress = NULL 
)
protected
void gig::Region::LoadDimensionRegions ( RIFF::List rgn)
protected
void DLS::Sampler::SetGain ( int32_t  gain)
virtualinherited

Reimplemented in gig::DimensionRegion.

Definition at line 531 of file DLS.cpp.

References DLS::Sampler::Gain.

void gig::Region::SetKeyRange ( uint16_t  Low,
uint16_t  High 
)
virtual

Modifies the key range of this Region and makes sure the respective chunks are in correct order.

Parameters
Low- lower end of key range
High- upper end of key range

Reimplemented from DLS::Region.

Definition at line 2541 of file gig.cpp.

References DLS::Resource::GetParent().

void DLS::Region::SetSample ( Sample pSample)
inherited

Assign another sample to this Region.

Parameters
pSample- sample to be assigned

Definition at line 932 of file DLS.cpp.

References DLS::Region::pSample, and DLS::Region::WavePoolTableIndex.

void gig::Region::UpdateChunks ( )
virtual

Apply Region settings and all its DimensionRegions to the respective RIFF chunks.

You have to call File::Save() to make changes persistent.

Usually there is absolutely no need to call this method explicitly. It will be called automatically when File::Save() was called.

Exceptions
gig::Exceptionif samples cannot be dereferenced

Reimplemented from DLS::Region.

Definition at line 2460 of file gig.cpp.

References RIFF::List::AddSubChunk(), gig::dimension_def_t::bits, CHUNK_ID_3LNK, gig::dimension_def_t::dimension, gig::dimension_none, DimensionRegions, DLS::Resource::GetParent(), RIFF::List::GetSubChunk(), RIFF::List::GetSubList(), LIST_TYPE_3PRG, RIFF::Chunk::LoadChunkData(), DLS::version_t::major, RIFF::List::MoveSubChunk(), DLS::Region::pCkRegion, pDimensionDefinitions, pDimensionRegions, gig::DimensionRegion::pSample, DLS::Region::pSample, DLS::File::pSamples, DLS::File::pVersion, gig::DimensionRegion::UpdateChunks(), and gig::dimension_def_t::zones.

Friends And Related Function Documentation

friend class Instrument
friend

Definition at line 639 of file gig.h.

Member Data Documentation

ArticulationList::iterator DLS::Articulator::ArticulationsIterator
protectedinherited
uint32_t DLS::Region::Channel
inherited

Definition at line 428 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

uint32_t gig::Region::DimensionRegions

Total number of DimensionRegions this Region contains, do not alter!

Definition at line 620 of file gig.h.

Referenced by AddDimension(), DeleteDimension(), Region(), UpdateChunks(), and UpdateVelocityTable().

unsigned int gig::Region::Dimensions

Number of defined dimensions, do not alter!

Definition at line 618 of file gig.h.

Referenced by AddDimension(), DeleteDimension(), GetDimensionRegionByValue(), Region(), and UpdateVelocityTable().

int16_t DLS::Sampler::FineTune
inherited

Definition at line 359 of file DLS.h.

Referenced by DLS::Sampler::Sampler(), and DLS::Sampler::UpdateChunks().

uint16_t DLS::Region::FormatOptionFlags
protectedinherited

Definition at line 438 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

int32_t DLS::Sampler::Gain
inherited
uint16_t DLS::Region::KeyGroup
inherited

Definition at line 422 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

range_t DLS::Region::KeyRange
inherited
uint16_t DLS::Region::Layer
inherited

Definition at line 423 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

unsigned int gig::Region::Layers

Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there is Layer dimension. The same information can of course also be obtained by accessing pDimensionDefinitions. Do not alter this value!

Definition at line 622 of file gig.h.

Referenced by AddDimension(), DeleteDimension(), and Region().

bool DLS::Region::MultiChannel
inherited

Definition at line 427 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

bool DLS::Sampler::NoSampleCompression
inherited

Definition at line 362 of file DLS.h.

Referenced by DLS::Sampler::Sampler(), and DLS::Sampler::UpdateChunks().

bool DLS::Sampler::NoSampleDepthTruncation
inherited

Definition at line 361 of file DLS.h.

Referenced by DLS::Sampler::Sampler(), and DLS::Sampler::UpdateChunks().

RIFF::List* DLS::Region::pCkRegion
protectedinherited
dimension_def_t gig::Region::pDimensionDefinitions[8]

Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one.

Definition at line 619 of file gig.h.

Referenced by AddDimension(), DeleteDimension(), GetDimensionRegionByBit(), GetDimensionRegionByValue(), Region(), UpdateChunks(), and UpdateVelocityTable().

DimensionRegion* gig::Region::pDimensionRegions[256]

Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one (which will create or delete the respective dimension region(s) automatically).

Definition at line 621 of file gig.h.

Referenced by AddDimension(), DeleteDimension(), GetDimensionRegionByBit(), GetDimensionRegionByValue(), LoadDimensionRegions(), Region(), UpdateChunks(), UpdateVelocityTable(), and ~Region().

dlsid_t* DLS::Resource::pDLSID
inherited

Points to a dlsid_t structure if the file provided a DLS ID else is NULL.

Definition at line 342 of file DLS.h.

Referenced by DLS::Resource::GenerateDLSID(), DLS::Resource::Resource(), DLS::Resource::UpdateChunks(), and DLS::Resource::~Resource().

uint16_t DLS::Region::PhaseGroup
inherited

Definition at line 426 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

bool DLS::Region::PhaseMaster
inherited

Definition at line 425 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

Info* DLS::Resource::pInfo
inherited

Points (in any case) to an Info object, providing additional, optional infos and comments.

Definition at line 341 of file DLS.h.

Referenced by gig::File::AddInstrument(), gig::File::File(), gig::Instrument::Instrument(), DLS::Resource::Resource(), gig::Sample::Sample(), DLS::Resource::UpdateChunks(), and DLS::Resource::~Resource().

RIFF::List* DLS::Articulator::pParentList
protectedinherited
RIFF::List* DLS::Sampler::pParentList
protectedinherited
RIFF::List* DLS::Resource::pResourceList
protectedinherited

Definition at line 349 of file DLS.h.

Referenced by DLS::Resource::Resource(), and DLS::Resource::UpdateChunks().

Sample* DLS::Region::pSample
protectedinherited
sample_loop_t* DLS::Sampler::pSampleLoops
inherited

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 DLS::Sampler::AddSampleLoop(), DLS::Sampler::DeleteSampleLoop(), gig::DimensionRegion::DimensionRegion(), gig::Sample::ReadAndLoop(), DLS::Sampler::Sampler(), DLS::Sampler::UpdateChunks(), and DLS::Sampler::~Sampler().

uint32_t DLS::Sampler::SampleLoops
inherited
uint32_t DLS::Sampler::SamplerOptions
protectedinherited
bool DLS::Region::SelfNonExclusive
inherited

Definition at line 424 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

uint32_t DLS::Sampler::uiHeaderSize
protectedinherited

Definition at line 372 of file DLS.h.

Referenced by DLS::Sampler::Sampler(), and DLS::Sampler::UpdateChunks().

uint8_t DLS::Sampler::UnityNote
inherited

Definition at line 358 of file DLS.h.

Referenced by DLS::Sampler::Sampler(), and DLS::Sampler::UpdateChunks().

range_t DLS::Region::VelocityRange
inherited

Definition at line 421 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

uint16_t DLS::Region::WaveLinkOptionFlags
protectedinherited

Definition at line 439 of file DLS.h.

Referenced by DLS::Region::Region(), and DLS::Region::UpdateChunks().

uint32_t DLS::Region::WavePoolTableIndex
protectedinherited

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