sf2::File Class Reference

#include <SF.h>

Public Member Functions
	File (RIFF::File *pRIFF)
	Constructor. More...
	~File ()
int	GetPresetCount ()
Preset *	GetPreset (int idx)
int	GetInstrumentCount ()
Instrument *	GetInstrument (int idx)
void	DeleteInstrument (Instrument *pInstrument)
int	GetSampleCount ()
Sample *	GetSample (int idx)
void	DeleteSample (Sample *pSample)
bool	HasSamples ()

Public Attributes
Info *	pInfo

Protected Attributes
RIFF::File *	pRIFF
std::vector< PresetBag >	PresetBags
std::vector< ModList >	PresetModLists
std::vector< GenList >	PresetGenLists
std::vector< InstBag >	InstBags
std::vector< ModList >	InstModLists
std::vector< GenList >	InstGenLists

Friends
class	Region
class	Instrument
class	Preset

Detailed Description

Definition at line 520 of file SF.h.

Constructor & Destructor Documentation

sf2::File::File

(

RIFF::File *

pRIFF

)

Constructor.

Load an existing SF2 file.

Parameters

pRIFF

- pointer to a RIFF file which is actually the SF2 file to load

Exceptions

Exception

if given file is not a SF2 file, expected chunks are missing

Definition at line 977 of file SF.cpp.

References CHUNK_ID_IBAG, CHUNK_ID_IGEN, CHUNK_ID_IMOD, CHUNK_ID_INST, CHUNK_ID_PBAG, CHUNK_ID_PGEN, CHUNK_ID_PHDR, CHUNK_ID_PMOD, CHUNK_ID_SHDR, CHUNK_ID_SM24, CHUNK_ID_SMPL, sf2::_GenList::GenAmount, sf2::_PresetBag::GenNdx, sf2::_GenList::GenOper, RIFF::List::GetListType(), sf2::GetMandatoryChunk(), RIFF::Chunk::GetSize(), RIFF::List::GetSubChunk(), RIFF::List::GetSubList(), sf2::Instrument::InstBagNdx, sf2::_InstBag::InstGenNdx, sf2::_InstBag::InstModNdx, LIST_TYPE_PDTA, LIST_TYPE_SDTA, sf2::Instrument::LoadRegions(), sf2::Preset::LoadRegions(), sf2::_ModList::ModAmount, sf2::_ModList::ModAmtSrcOper, sf2::_ModList::ModDestOper, sf2::_PresetBag::ModNdx, sf2::_ModList::ModSrcOper, sf2::_ModList::ModTransOper, sf2::Preset::Preset(), sf2::Preset::PresetBagNdx, RIFF::Chunk::ReadInt16(), RIFF_TYPE_SF2, and sf2::_GenAmountType::wAmount.

sf2::File::~File

(

)

Definition at line 1153 of file SF.cpp.

Member Function Documentation

void sf2::File::DeleteInstrument

(

Instrument *

pInstrument

)

Definition at line 1190 of file SF.cpp.

References sf2::InstrumentBase::GetRegion(), sf2::InstrumentBase::GetRegionCount(), and sf2::Region::pInstrument.

void sf2::File::DeleteSample

(

Sample *

pSample

)

Definition at line 1221 of file SF.cpp.

References sf2::InstrumentBase::GetRegion(), sf2::InstrumentBase::GetRegionCount(), sf2::Region::GetSample(), and sf2::Sample::Name.

Instrument * sf2::File::GetInstrument

(

int

idx

)

Definition at line 1182 of file SF.cpp.

int sf2::File::GetInstrumentCount

(

)

Definition at line 1178 of file SF.cpp.

Preset * sf2::File::GetPreset

(

int

idx

)

Definition at line 1170 of file SF.cpp.

int sf2::File::GetPresetCount

(

)

Definition at line 1166 of file SF.cpp.

Sample * sf2::File::GetSample

(

int

idx

)

Definition at line 1213 of file SF.cpp.

int sf2::File::GetSampleCount

(

)

Definition at line 1209 of file SF.cpp.

bool sf2::File::HasSamples

(

)

Definition at line 1246 of file SF.cpp.

Friends And Related Function Documentation

friend class Instrument

friend

Definition at line 538 of file SF.h.

friend class Preset

friend

Definition at line 539 of file SF.h.

friend class Region

friend

Definition at line 537 of file SF.h.

Member Data Documentation

std::vector<InstBag> sf2::File::InstBags

protected

Definition at line 546 of file SF.h.

Referenced by sf2::Instrument::LoadRegions().

std::vector<GenList> sf2::File::InstGenLists

protected

Definition at line 548 of file SF.h.

Referenced by sf2::Instrument::LoadRegions().

std::vector<ModList> sf2::File::InstModLists

protected

Definition at line 547 of file SF.h.

Referenced by sf2::Instrument::LoadRegions().

Info* sf2::File::pInfo

Definition at line 522 of file SF.h.

std::vector<PresetBag> sf2::File::PresetBags

protected

Definition at line 543 of file SF.h.

Referenced by sf2::Preset::LoadRegions().

std::vector<GenList> sf2::File::PresetGenLists

protected

Definition at line 545 of file SF.h.

Referenced by sf2::Preset::LoadRegions().

std::vector<ModList> sf2::File::PresetModLists

protected

Definition at line 544 of file SF.h.

RIFF::File* sf2::File::pRIFF

protected

Definition at line 542 of file SF.h.

---

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

• SF.h
• SF.cpp