gig::Instrument Class Reference

Provides all neccessary information for the synthesis of an Instrument. More...

#include <gig.h>

Inheritance diagram for gig::Instrument:

DLS::Instrument DLS::Resource DLS::Articulator

List of all members.

Public Member Functions

RegionGetFirstRegion ()
 Returns the first Region of the instrument.
RegionGetNextRegion ()
 Returns the next Region of the instrument.
RegionAddRegion ()
void DeleteRegion (Region *pRegion)
virtual void UpdateChunks ()
 Apply Instrument with all its Regions to the respective RIFF chunks.
RegionGetRegion (unsigned int Key)
 Returns the appropriate Region for a triggered note.
MidiRuleGetMidiRule (int i)
 Returns a MIDI rule of the instrument.

Public Attributes

int32_t Attenuation
 in dB
uint16_t EffectSend
int16_t FineTune
 in cents
uint16_t PitchbendRange
 Number of semitones pitchbend controller can pitch (default is 2).
bool PianoReleaseMode
range_t DimensionKeyRange
 0-127 (where 0 means C1 and 127 means G9)

Protected Types

typedef std::list< Region * > RegionList
typedef std::list< Articulation * > ArticulationList

Protected Member Functions

 Instrument (File *pFile, RIFF::List *insList, progress_t *pProgress=NULL)
 ~Instrument ()
 Destructor.
void UpdateRegionKeyTable ()
void DeleteRegion (Region *pRegion)
virtual void LoadRegions ()
Resource * GetParent ()
void GenerateDLSID ()
 Generates a new DLSID for the resource.
Articulation * GetFirstArticulation ()
Articulation * GetNextArticulation ()
void LoadArticulations ()

Protected Attributes

RegionRegionKeyTable [128]
 fast lookup for the corresponding Region of a MIDI key
bool IsDrum
 Indicates if the Instrument is a drum type, as they differ in the synthesis model of DLS from melodic instruments.
uint16_t MIDIBank
 Reflects combination of MIDIBankCoarse and MIDIBankFine (bank 1 - bank 16384). Do not change this value, it will not be saved! Change MIDIBankCoarse and MIDIBankFine instead (we might change that in future).
uint8_t MIDIBankCoarse
 Reflects the MIDI Bank number for MIDI Control Change 0 (bank 1 - 128).
uint8_t MIDIBankFine
 Reflects the MIDI Bank number for MIDI Control Change 32 (bank 1 - 128).
uint32_t MIDIProgram
 Specifies the MIDI Program Change Number this Instrument should be assigned to.
uint32_t Regions
 Reflects the number of Region defintions this Instrument has.
RIFF::ListpCkInstrument
RegionListpRegions
RegionList::iterator RegionsIterator
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.
Resource * pParent
RIFF::ListpResourceList
RIFF::ListpParentList
ArticulationListpArticulations
ArticulationList::iterator ArticulationsIterator

Friends

class File
class Region


Detailed Description

Provides all neccessary information for the synthesis of an Instrument.

Definition at line 669 of file gig.h.


Member Typedef Documentation

typedef std::list<Articulation*> DLS::Articulator::ArticulationList [protected, inherited]

Definition at line 290 of file DLS.h.

typedef std::list<Region*> DLS::Instrument::RegionList [protected, inherited]

Definition at line 462 of file DLS.h.


Constructor & Destructor Documentation

gig::Instrument::Instrument ( File pFile,
RIFF::List insList,
progress_t pProgress = NULL 
) [protected]

gig::Instrument::~Instrument (  )  [protected, virtual]

Destructor.

Removes RIFF chunks associated with this Instrument and frees all memory occupied by this instrument.

Reimplemented from DLS::Instrument.

Definition at line 3038 of file gig.cpp.


Member Function Documentation

Region * gig::Instrument::AddRegion (  ) 

void DLS::Instrument::DeleteRegion ( Region pRegion  )  [inherited]

Definition at line 1120 of file DLS.cpp.

References DLS::Instrument::pRegions, and DLS::Instrument::Regions.

void gig::Instrument::DeleteRegion ( Region pRegion  ) 

Definition at line 3150 of file gig.cpp.

References DLS::Instrument::pRegions, and UpdateRegionKeyTable().

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().

Articulation * DLS::Articulator::GetFirstArticulation (  )  [inherited]

Region * gig::Instrument::GetFirstRegion (  ) 

Returns the first Region of the instrument.

You have to call this method once before you use GetNextRegion().

Returns:
pointer address to first region or NULL if there is none
See also:
GetNextRegion()

Reimplemented from DLS::Instrument.

Definition at line 3116 of file gig.cpp.

References DLS::Instrument::pRegions, and DLS::Instrument::RegionsIterator.

MidiRule * gig::Instrument::GetMidiRule ( int  i  ) 

Returns a MIDI rule of the instrument.

The list of MIDI rules, at least in gig v3, always contains at most two rules. The second rule can only be the DEF filter (which currently isn't supported by libgig).

Parameters:
i - MIDI rule number
Returns:
pointer address to MIDI rule number i or NULL if there is none

Definition at line 3167 of file gig.cpp.

Articulation * DLS::Articulator::GetNextArticulation (  )  [inherited]

Region * gig::Instrument::GetNextRegion (  ) 

Returns the next Region of the instrument.

You have to call GetFirstRegion() once before you can use this method. By calling this method multiple times it iterates through the available Regions.

Returns:
pointer address to the next region or NULL if end reached
See also:
GetFirstRegion()

Reimplemented from DLS::Instrument.

Definition at line 3130 of file gig.cpp.

References DLS::Instrument::pRegions, and DLS::Instrument::RegionsIterator.

Resource* DLS::Resource::GetParent (  )  [inline, inherited]

Region * gig::Instrument::GetRegion ( unsigned int  Key  ) 

Returns the appropriate Region for a triggered note.

Parameters:
Key MIDI Key number of triggered note / key (0 - 127)
Returns:
pointer adress to the appropriate Region or NULL if there there is no Region defined for the given Key

Definition at line 3098 of file gig.cpp.

References DLS::Instrument::pRegions, and RegionKeyTable.

void DLS::Articulator::LoadArticulations (  )  [protected, inherited]

void DLS::Instrument::LoadRegions (  )  [protected, virtual, inherited]

void gig::Instrument::UpdateChunks (  )  [virtual]

Apply Instrument with all its Regions 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::Exception if samples cannot be dereferenced

Reimplemented from DLS::Instrument.

Definition at line 3054 of file gig.cpp.

References RIFF::List::AddSubChunk(), RIFF::List::AddSubList(), Attenuation, CHUNK_ID_3EWG, DimensionKeyRange, EffectSend, FineTune, DLS::Resource::GetParent(), RIFF::List::GetSubChunk(), RIFF::List::GetSubList(), gig::range_t::high, LIST_TYPE_LART, RIFF::Chunk::LoadChunkData(), gig::range_t::low, DLS::Instrument::pCkInstrument, PianoReleaseMode, PitchbendRange, DLS::Instrument::pRegions, and DLS::File::pVersion.

void gig::Instrument::UpdateRegionKeyTable (  )  [protected]


Friends And Related Function Documentation

friend class File [friend]

Reimplemented from DLS::Instrument.

Definition at line 707 of file gig.h.

friend class Region [friend]

Reimplemented from DLS::Instrument.

Definition at line 708 of file gig.h.

Referenced by AddRegion(), and Instrument().


Member Data Documentation

ArticulationList::iterator DLS::Articulator::ArticulationsIterator [protected, inherited]

in dB

Definition at line 682 of file gig.h.

Referenced by Instrument(), and UpdateChunks().

0-127 (where 0 means C1 and 127 means G9)

Definition at line 687 of file gig.h.

Referenced by Instrument(), and UpdateChunks().

Definition at line 683 of file gig.h.

Referenced by Instrument(), and UpdateChunks().

in cents

Definition at line 684 of file gig.h.

Referenced by Instrument(), and UpdateChunks().

bool DLS::Instrument::IsDrum [inherited]

Indicates if the Instrument is a drum type, as they differ in the synthesis model of DLS from melodic instruments.

Definition at line 449 of file DLS.h.

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

uint16_t DLS::Instrument::MIDIBank [inherited]

Reflects combination of MIDIBankCoarse and MIDIBankFine (bank 1 - bank 16384). Do not change this value, it will not be saved! Change MIDIBankCoarse and MIDIBankFine instead (we might change that in future).

Definition at line 450 of file DLS.h.

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

uint8_t DLS::Instrument::MIDIBankCoarse [inherited]

Reflects the MIDI Bank number for MIDI Control Change 0 (bank 1 - 128).

Definition at line 451 of file DLS.h.

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

uint8_t DLS::Instrument::MIDIBankFine [inherited]

Reflects the MIDI Bank number for MIDI Control Change 32 (bank 1 - 128).

Definition at line 452 of file DLS.h.

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

uint32_t DLS::Instrument::MIDIProgram [inherited]

Specifies the MIDI Program Change Number this Instrument should be assigned to.

Definition at line 453 of file DLS.h.

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

RIFF::List* DLS::Instrument::pCkInstrument [protected, inherited]

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().

Definition at line 686 of file gig.h.

Referenced by Instrument(), and 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(), Instrument(), DLS::Resource::Resource(), gig::Sample::Sample(), DLS::Resource::UpdateChunks(), and DLS::Resource::~Resource().

Number of semitones pitchbend controller can pitch (default is 2).

Definition at line 685 of file gig.h.

Referenced by Instrument(), and UpdateChunks().

Resource* DLS::Resource::pParent [protected, inherited]

RIFF::List* DLS::Articulator::pParentList [protected, inherited]

RegionList* DLS::Instrument::pRegions [protected, inherited]

RIFF::List* DLS::Resource::pResourceList [protected, inherited]

Definition at line 349 of file DLS.h.

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

fast lookup for the corresponding Region of a MIDI key

Definition at line 702 of file gig.h.

Referenced by GetRegion(), Instrument(), and UpdateRegionKeyTable().

uint32_t DLS::Instrument::Regions [inherited]

RegionList::iterator DLS::Instrument::RegionsIterator [protected, inherited]


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

doxygen