libgig
4.0.0
|
Encapsulates sample waves used for playback. More...
#include <DLS.h>
Public Member Functions | |
void * | LoadSampleData () |
Load sample data into RAM. More... | |
void | ReleaseSampleData () |
Free sample data from RAM. More... | |
unsigned long | GetSize () const |
Returns sample size. More... | |
void | Resize (int iNewSize) |
Resize sample. More... | |
unsigned long | SetPos (unsigned long SampleCount, RIFF::stream_whence_t Whence=RIFF::stream_start) |
Sets the position within the sample (in sample points, not in bytes). More... | |
unsigned long | Read (void *pBuffer, unsigned long SampleCount) |
Reads SampleCount number of sample points from the current position into the buffer pointed by pBuffer and increments the position within the sample. More... | |
unsigned long | Write (void *pBuffer, unsigned long SampleCount) |
Write sample wave data. More... | |
virtual void | UpdateChunks (progress_t *pProgress) |
Apply sample and its settings to the respective RIFF chunks. More... | |
virtual void | CopyAssign (const Sample *orig) |
Make a deep copy of the Sample object given by orig and assign it to this object. More... | |
Resource * | GetParent () |
const Resource * | GetParent () const |
void | GenerateDLSID () |
Generates a new DLSID for the resource. More... | |
virtual void | CopyAssign (const Resource *orig) |
Make a deep copy of the Resource object given by orig and assign it to this object. More... | |
Public Attributes | |
uint16_t | FormatTag |
Format ID of the waveform data (should be DLS_WAVE_FORMAT_PCM for DLS1 compliant files, this is also the default value if Sample was created with Instrument::AddSample()). More... | |
uint16_t | Channels |
Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo (defaults to 1=mono if Sample was created with Instrument::AddSample() previously). More... | |
uint32_t | SamplesPerSecond |
Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously). More... | |
uint32_t | AverageBytesPerSecond |
The average number of bytes per second at which the waveform data should be transferred (Playback software can estimate the buffer size using this value). More... | |
uint16_t | BlockAlign |
The block alignment (in bytes) of the waveform data. Playback software needs to process a multiple of BlockAlign bytes of data at a time, so the value of BlockAlign can be used for buffer alignment. More... | |
uint16_t | BitDepth |
Size of each sample per channel (only if known sample data format is used, 0 otherwise). More... | |
unsigned long | SamplesTotal |
Reflects total number of sample points (only if known sample data format is used, 0 otherwise), do not bother to change this value, it will not be saved. More... | |
uint | FrameSize |
Reflects the size (in bytes) of one single sample point (only if known sample data format is used, 0 otherwise). Caution: with the current version of libgig you have to upate this field by yourself whenever you change one of the following fields: Channels, BitDepth ! Ignoring this might lead to undesired behavior when i.e. calling Resize(), SetPos(), Write() or Read(). More... | |
Info * | pInfo |
Points (in any case) to an Info object, providing additional, optional infos and comments. More... | |
dlsid_t * | pDLSID |
Points to a dlsid_t structure if the file provided a DLS ID else is NULL. More... | |
Protected Member Functions | |
Sample (File *pFile, RIFF::List *waveList, unsigned long WavePoolOffset) | |
Constructor. More... | |
virtual | ~Sample () |
Destructor. More... | |
void | CopyAssignCore (const Sample *orig) |
Make a deep copy of the Sample object given by orig (without the actual sample waveform data however) and assign it to this object. More... | |
Protected Attributes | |
RIFF::List * | pWaveList |
RIFF::Chunk * | pCkData |
RIFF::Chunk * | pCkFormat |
unsigned long | ulWavePoolOffset |
Resource * | pParent |
RIFF::List * | pResourceList |
Friends | |
class | File |
class | Region |
Encapsulates sample waves used for playback.
In case you created a new sample with File::AddSample(), you should first update all attributes with the desired meta informations (amount of channels, bit depth, sample rate, etc.), then call Resize() with the desired sample size. The latter will create the mandatory RIFF chunk which will hold the sample wave data.
|
protected |
Constructor.
Load an existing sample or create a new one. A 'wave' list chunk must be given to this constructor. In case the given 'wave' list chunk contains a 'fmt' and 'data' chunk, the format and sample data will be loaded from there, otherwise default values will be used and those chunks will be created when File::Save() will be called later on.
pFile | - pointer to DLS::File where this sample is located (or will be located) |
waveList | - pointer to 'wave' list chunk which is (or will be) associated with this sample |
WavePoolOffset | - offset of this sample data from wave pool ('wvpl') list chunk |
Definition at line 714 of file DLS.cpp.
References AverageBytesPerSecond, BitDepth, BlockAlign, Channels, CHUNK_ID_DATA, CHUNK_ID_FMT, DLS_WAVE_FORMAT_PCM, FormatTag, FrameSize, RIFF::Chunk::GetSize(), RIFF::List::GetSubChunk(), LIST_HEADER_SIZE, pCkData, pCkFormat, pWaveList, RIFF::Chunk::ReadUint16(), RIFF::Chunk::ReadUint32(), SamplesPerSecond, SamplesTotal, and ulWavePoolOffset.
|
protectedvirtual |
Destructor.
Removes RIFF chunks associated with this Sample and frees all memory occupied by this sample.
Reimplemented in gig::Sample.
Definition at line 753 of file DLS.cpp.
References RIFF::List::DeleteSubChunk(), RIFF::Chunk::GetParent(), DLS::Resource::pParent, and pWaveList.
|
virtualinherited |
Make a deep copy of the Resource object given by orig and assign it to this object.
orig | - original Resource object to be copied from |
Definition at line 542 of file DLS.cpp.
References DLS::Resource::pInfo.
Referenced by DLS::Region::CopyAssign(), CopyAssignCore(), and DLS::Instrument::CopyAssignCore().
|
virtual |
Make a deep copy of the Sample object given by orig and assign it to this object.
orig | - original Sample object to be copied from |
Definition at line 789 of file DLS.cpp.
References CopyAssignCore(), FrameSize, RIFF::Chunk::GetPos(), GetSize(), LoadSampleData(), pCkData, Read(), Resize(), RIFF::Chunk::SetPos(), and SetPos().
|
protected |
Make a deep copy of the Sample object given by orig (without the actual sample waveform data however) and assign it to this object.
This is a special internal variant of CopyAssign() which only copies the most mandatory member variables. It will be called by gig::Sample descendent instead of CopyAssign() since gig::Sample has its own implementation to access and copy the actual sample waveform data.
orig | - original Sample object to be copied from |
Definition at line 769 of file DLS.cpp.
References AverageBytesPerSecond, BitDepth, BlockAlign, Channels, DLS::Resource::CopyAssign(), FormatTag, FrameSize, SamplesPerSecond, and SamplesTotal.
Referenced by CopyAssign(), and gig::Sample::CopyAssignMeta().
|
inherited |
Generates a new DLSID for the resource.
Definition at line 495 of file DLS.cpp.
Referenced by gig::File::AddInstrument(), and gig::File::File().
|
inlineinherited |
Definition at line 350 of file DLS.h.
Referenced by gig::Region::AddDimension(), DLS::Region::CopyAssign(), gig::DimensionRegion::CopyAssign(), gig::Region::DeleteDimensionZone(), DLS::Region::GetSample(), gig::Region::GetSampleFromWavePool(), gig::Instrument::LoadScripts(), gig::Instrument::MoveTo(), gig::Region::Region(), DLS::Region::SetKeyRange(), gig::Region::SetKeyRange(), gig::Region::SplitDimensionZone(), DLS::Region::UpdateChunks(), gig::DimensionRegion::UpdateChunks(), gig::Region::UpdateChunks(), gig::Instrument::UpdateChunks(), and gig::Sample::Write().
|
inlineinherited |
unsigned long DLS::Sample::GetSize | ( | ) | const |
Returns sample size.
Returns the sample wave form's data size (in sample points). This is actually the current, physical size (converted to sample points) of the RIFF chunk which encapsulates the sample's wave data. The returned value is dependant to the current FrameSize value.
Definition at line 858 of file DLS.cpp.
References DLS_WAVE_FORMAT_PCM, FormatTag, FrameSize, RIFF::Chunk::GetSize(), and pCkData.
Referenced by CopyAssign(), gig::Sample::CopyAssignMeta(), Write(), and gig::Sample::Write().
void * DLS::Sample::LoadSampleData | ( | ) |
Load sample data into RAM.
In case the respective 'data' chunk exists, the sample data will be loaded into RAM (if not done already) and a pointer to the data in RAM will be returned. If this is a new sample, you have to call Resize() with the desired sample size to create the mandatory RIFF chunk for the sample wave data.
You can call LoadChunkData() again if you previously scheduled to enlarge the sample data RIFF chunk with a Resize() call. In that case the buffer will be enlarged to the new, scheduled size and you can already place the sample wave data to the buffer and finally call File::Save() to enlarge the sample data's chunk physically and write the new sample wave data in one rush. This approach is definitely recommended if you have to enlarge and write new sample data to a lot of samples.
Caution: the buffer pointer will be invalidated once File::Save() was called. You have to call LoadChunkData() again to get a new, valid pointer whenever File::Save() was called.
Exception | if data buffer could not be enlarged |
Definition at line 835 of file DLS.cpp.
References RIFF::Chunk::LoadChunkData(), and pCkData.
Referenced by CopyAssign().
unsigned long DLS::Sample::Read | ( | void * | pBuffer, |
unsigned long | SampleCount | ||
) |
Reads SampleCount number of sample points from the current position into the buffer pointed by pBuffer and increments the position within the sample.
Use this method and SetPos() if you don't want to load the sample into RAM, thus for disk streaming.
pBuffer | destination buffer |
SampleCount | number of sample points to read |
Definition at line 934 of file DLS.cpp.
References DLS_WAVE_FORMAT_PCM, FormatTag, FrameSize, pCkData, and RIFF::Chunk::Read().
Referenced by CopyAssign().
void DLS::Sample::ReleaseSampleData | ( | ) |
Free sample data from RAM.
In case sample data was previously successfully loaded into RAM with LoadSampleData(), this method will free the sample data from RAM.
Definition at line 844 of file DLS.cpp.
References pCkData, and RIFF::Chunk::ReleaseChunkData().
void DLS::Sample::Resize | ( | int | iNewSize | ) |
Resize sample.
Resizes the sample's wave form data, that is the actual size of sample wave data possible to be written for this sample. This call will return immediately and just schedule the resize operation. You should call File::Save() to actually perform the resize operation(s) "physically" to the file. As this can take a while on large files, it is recommended to call Resize() first on all samples which have to be resized and finally to call File::Save() to perform all those resize operations in one rush.
The actual size (in bytes) is dependant to the current FrameSize value. You may want to set FrameSize before calling Resize().
Caution: You cannot directly write to enlarged samples before calling File::Save() as this might exceed the current sample's boundary!
Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to resize samples with other formats will fail!
iNewSize | - new sample wave data size in sample points (must be greater than zero) |
Excecption | if FormatTag != DLS_WAVE_FORMAT_PCM |
Exception | if iNewSize is less than 1 |
Definition at line 891 of file DLS.cpp.
References RIFF::List::AddSubChunk(), CHUNK_ID_DATA, DLS_WAVE_FORMAT_PCM, FormatTag, FrameSize, RIFF::List::GetSubChunk(), pCkData, pWaveList, and RIFF::Chunk::Resize().
Referenced by CopyAssign(), and gig::Sample::Resize().
unsigned long DLS::Sample::SetPos | ( | unsigned long | SampleCount, |
RIFF::stream_whence_t | Whence = RIFF::stream_start |
||
) |
Sets the position within the sample (in sample points, not in bytes).
Use this method and Read() if you don't want to load the sample into RAM, thus for disk streaming.
Also note: only DLS_WAVE_FORMAT_PCM is currently supported, that is FormatTag must be DLS_WAVE_FORMAT_PCM. Trying to reposition the sample with other formats will fail!
SampleCount | number of sample points |
Whence | to which relation SampleCount refers to |
Definition at line 916 of file DLS.cpp.
References DLS_WAVE_FORMAT_PCM, FormatTag, FrameSize, pCkData, and RIFF::Chunk::SetPos().
Referenced by CopyAssign().
|
virtual |
Apply sample and its settings to the respective RIFF chunks.
You have to call File::Save() to make changes persistent.
pProgress | - callback function for progress notification |
Exception | if FormatTag != DLS_WAVE_FORMAT_PCM or no sample data was provided yet |
Reimplemented from DLS::Resource.
Reimplemented in gig::Sample.
Definition at line 968 of file DLS.cpp.
References RIFF::List::AddSubChunk(), AverageBytesPerSecond, BitDepth, BlockAlign, Channels, CHUNK_ID_FMT, DLS_WAVE_FORMAT_PCM, FormatTag, RIFF::List::GetSubChunk(), RIFF::Chunk::LoadChunkData(), pCkData, pCkFormat, pWaveList, SamplesPerSecond, and DLS::Resource::UpdateChunks().
Referenced by gig::Sample::UpdateChunks().
unsigned long DLS::Sample::Write | ( | void * | pBuffer, |
unsigned long | SampleCount | ||
) |
Write sample wave data.
Writes SampleCount number of sample points from the buffer pointed by pBuffer and increments the position within the sample. Use this method to directly write the sample data to disk, i.e. if you don't want or cannot load the whole sample data into RAM.
You have to Resize() the sample to the desired size and call File::Save() before using Write().
pBuffer | - source buffer |
SampleCount | - number of sample points to write |
Exception | if current sample size is too small |
Definition at line 954 of file DLS.cpp.
References DLS_WAVE_FORMAT_PCM, FormatTag, FrameSize, GetSize(), pCkData, and RIFF::Chunk::Write().
uint32_t DLS::Sample::AverageBytesPerSecond |
The average number of bytes per second at which the waveform data should be transferred (Playback software can estimate the buffer size using this value).
Definition at line 400 of file DLS.h.
Referenced by CopyAssignCore(), Sample(), and UpdateChunks().
uint16_t DLS::Sample::BitDepth |
Size of each sample per channel (only if known sample data format is used, 0 otherwise).
Definition at line 402 of file DLS.h.
Referenced by CopyAssignCore(), gig::Sample::Read(), Sample(), gig::Sample::Sample(), UpdateChunks(), gig::Sample::UpdateChunks(), and gig::Sample::Write().
uint16_t DLS::Sample::BlockAlign |
The block alignment (in bytes) of the waveform data. Playback software needs to process a multiple of BlockAlign bytes of data at a time, so the value of BlockAlign can be used for buffer alignment.
Definition at line 401 of file DLS.h.
Referenced by CopyAssignCore(), Sample(), and UpdateChunks().
uint16_t DLS::Sample::Channels |
Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo (defaults to 1=mono if Sample was created with Instrument::AddSample() previously).
Definition at line 398 of file DLS.h.
Referenced by CopyAssignCore(), gig::Sample::Read(), Sample(), gig::Sample::Sample(), UpdateChunks(), gig::Sample::UpdateChunks(), gig::File::UpdateChunks(), and gig::Sample::Write().
uint16_t DLS::Sample::FormatTag |
Format ID of the waveform data (should be DLS_WAVE_FORMAT_PCM for DLS1 compliant files, this is also the default value if Sample was created with Instrument::AddSample()).
Definition at line 397 of file DLS.h.
Referenced by CopyAssignCore(), GetSize(), Read(), Resize(), Sample(), SetPos(), UpdateChunks(), and Write().
uint DLS::Sample::FrameSize |
Reflects the size (in bytes) of one single sample point (only if known sample data format is used, 0 otherwise). Caution: with the current version of libgig you have to upate this field by yourself whenever you change one of the following fields: Channels, BitDepth ! Ignoring this might lead to undesired behavior when i.e. calling Resize(), SetPos(), Write() or Read().
Definition at line 404 of file DLS.h.
Referenced by CopyAssign(), CopyAssignCore(), gig::Sample::CopyAssignWave(), gig::Sample::GetPos(), GetSize(), gig::Sample::LoadSampleDataWithNullSamplesExtension(), Read(), gig::Sample::Read(), gig::Sample::ReadAndLoop(), Resize(), Sample(), SetPos(), gig::Sample::SetPos(), gig::Sample::UpdateChunks(), Write(), and gig::Sample::Write().
|
protected |
Definition at line 417 of file DLS.h.
Referenced by CopyAssign(), gig::Sample::GetPos(), GetSize(), LoadSampleData(), Read(), gig::Sample::Read(), ReleaseSampleData(), Resize(), Sample(), SetPos(), gig::Sample::SetPos(), UpdateChunks(), gig::Sample::UpdateChunks(), Write(), and gig::Sample::Write().
|
protected |
Definition at line 418 of file DLS.h.
Referenced by Sample(), and UpdateChunks().
|
inherited |
|
inherited |
Points (in any case) to an Info object, providing additional, optional infos and comments.
Definition at line 347 of file DLS.h.
Referenced by gig::File::AddInstrument(), DLS::Resource::CopyAssign(), gig::File::File(), gig::Instrument::Instrument(), and gig::Sample::Sample().
|
protectedinherited |
Definition at line 356 of file DLS.h.
Referenced by gig::Sample::UpdateChunks(), DLS::Instrument::~Instrument(), DLS::Region::~Region(), and ~Sample().
|
protectedinherited |
|
protected |
Definition at line 416 of file DLS.h.
Referenced by Resize(), Sample(), UpdateChunks(), gig::Sample::UpdateChunks(), and ~Sample().
uint32_t DLS::Sample::SamplesPerSecond |
Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously).
Definition at line 399 of file DLS.h.
Referenced by CopyAssignCore(), Sample(), gig::Sample::Sample(), UpdateChunks(), and gig::Sample::UpdateChunks().
unsigned long DLS::Sample::SamplesTotal |
Reflects total number of sample points (only if known sample data format is used, 0 otherwise), do not bother to change this value, it will not be saved.
Definition at line 403 of file DLS.h.
Referenced by CopyAssignCore(), gig::Sample::LoadSampleData(), gig::Sample::LoadSampleDataWithNullSamplesExtension(), gig::Sample::Read(), Sample(), gig::Sample::SetPos(), and gig::Sample::UpdateChunks().
|
protected |
Definition at line 419 of file DLS.h.
Referenced by DLS::Region::GetSample(), gig::Region::GetSampleFromWavePool(), and Sample().