--- libgig/trunk/ChangeLog 2017/10/03 17:12:07 3349 +++ libgig/trunk/ChangeLog 2021/06/19 10:58:51 3960 @@ -1,4 +1,260 @@ -Version SVN trunk +Version SVN trunk (?) + + * src/gig.cpp, src/gig.h: + - Region::DeleteDimensionZone(): Fix clang sanatizer warning. + - Region::SplitDimensionZone(): Fix clang sanatizer warning. + - Sample: Fix unnecessary RAM consumption in case of 24 bit samples + (InternalDecompressionBuffer is no longer needed for 24 bit samples since + SVN r902 / libgig release 3.1.0). + - Use GetSubChunkAt() instead of GetFirstSubChunk() / GetNextSubChunk() in + entire gig.cpp file. + - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in + entire gig.cpp file. + - Added method Instrument::GetRegionAt(). + - Marked methods Instrument::GetFirstRegion() and + Instrument::GetNextRegion() as deprecated. + - Use GetRegionAt() instead of GetFirstRegion() / GetNextRegion() in entire + gig.cpp file. + - Changed signature of method File::GetSample(uint) to + File::GetSample(size_t,progress_t*). + - Marked methods File::GetFirstSample() and File::GetNextSample() as + deprecated. + - Use File::GetSample() instead of File::GetFirstSample() / + File::GetNextSample() in entire gig.cpp file. + - Added method Group::GetSample(). + - Marked methods Group::GetFirstSample() and Group::GetNextSample() as + deprecated. + - Use Group::GetSample() instead of Group::GetFirstSample() / + Group::GetNextSample() in entire gig.cpp file. + - Changed signature of method File::GetGroup(uint) to + File::GetGroup(size_t). + - Fixed File::GetGroup(size_t) to be reentrant-safe. + - Marked methods GetFirstGroup() and GetNextGroup() as deprecated. + - Fixed GetGroup(String) to be reentrant-safe. + - Use GetGroup() instead of GetFirstGroup() / GetNextGroup() in entire + gig.cpp file. + - Changed signature of method File::GetInstrument(uint,progress_t*) to + File::GetInstrument(size_t,progress_t*). + - Fixed File::GetInstrument(size_t,progress_t*) to be reentrant-safe. + - Marked methods File::GetFirstInstrument() and File::GetNextInstrument() + as deprecated. + - Use File::GetInstrument() instead of File::GetFirstInstrument() / + File::GetNextInstrument() in entire gig.cpp file. + - Optimized method ScriptGroup::GetScript() to have constant time + efficiency. + - Changed signature of method File::GetScriptGroup(uint) to + File::GetScriptGroup(size_t). + - Optimized method File::GetScriptGroup(size_t) to have constant time + efficiency. + - Changed signature of method ScriptGroup::GetScript(uint) to + ScriptGroup::GetScript(size_t). + - Changed signature of method Instrument::GetScriptOfSlot(uint) to + Instrument::GetScriptOfSlot(size_t). + - Changed signature of method Instrument::SwapScriptSlots(uint,uint) to + Instrument::SwapScriptSlots(size_t,size_t). + - Changed signature of method Instrument::RemoveScriptSlot(uint) to + Instrument::RemoveScriptSlot(size_t). + - Changed signature of method Instrument::ScriptSlotCount() to return + size_t instead of uint. + - Changed signature of method Instrument::IsScriptSlotBypassed(uint) to + Instrument::IsScriptSlotBypassed(size_t). + - Changed signature of method Instrument::SetScriptSlotBypassed(uint,bool) + to Instrument::SetScriptSlotBypassed(size_t,bool). + - Changed signature of method + Instrument::IsScriptPatchVariableSet(int,String) to + Instrument::IsScriptPatchVariableSet(size_t,String). + - Changed signature of method Instrument::GetScriptPatchVariables(int) to + Instrument::GetScriptPatchVariables(size_t). + - Changed signature of method + Instrument::GetScriptPatchVariable(int,String) to + Instrument::GetScriptPatchVariable(size_t,String). + + * src/SF.cpp, src/SF.h: + - File::DeleteInstrument(): Fix clang sanatizer warning. + + * src/DLS.cpp, src/DLS.h: + - Use GetSubChunkAt() instead of GetFirstSubChunk() / GetNextSubChunk() in + entire DLS.cpp file. + - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in + entire DLS.cpp file. + - Added method Instrument::GetRegionAt(). + - Marked methods Instrument::GetFirstRegion() and + Instrument::GetNextRegion() as deprecated. + - Use GetRegionAt() instead of GetFirstRegion() / GetNextRegion() in entire + DLS.cpp file. + - Added method File::GetSample(). + - Marked methods File::GetFirstSample() and File::GetNextSample() as + deprecated. + - Use File::GetSample() instead of File::GetFirstSample() / + File::GetNextSample() in entire DLS.cpp file. + - Added method Articulator::GetArticulation(). + - Marked methods Articulator::GetFirstArticulation() and + Articulator::GetNextArticulation() as deprecated. + - Added method File::GetInstrument(). + - Marked methods File::GetFirstInstrument() and File::GetNextInstrument() + as deprecated. + + * src/RIFF.cpp, src/RIFF.h: + - Chunk::LoadChunkData(): Fix clang sanatizer warning. + - List::LoadSubChunks(): Fix potential garbage data access if reading a + RIFF chunk ID failed. + - Added methods File::IsIOPerThread() and File::SetIOPerThread(bool); the + latter allows to automatically use a separate file I/O stream state for + each thread. + - Added method List::GetSubChunkAt(). + - Added method List::GetSubListAt(). + - Marked methods List::GetFirstSubChunk(), List::GetNextSubChunk(), + List::GetFirstSubList() and List::GetNextSubList() as deprecated. + - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in + entire RIFF.cpp file. + +Version 4.3.0 (9 May 2021) + + * general changes: + - Require at least a C++11 compliant compiler. + - Require some UUID generating function by underlying system. + + * src/gig.cpp, src/gig.h: + - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1WaveForm, + DimensionRegion::LFO2WaveForm and DimensionRegion::LFO3WaveForm, which + allow to define override LFOs' wave form (e.g. saw or square instead of + the default wave form which was always sine in the original + Gigasampler/GigaStudio software). + - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1Phase, + DimensionRegion::LFO2Phase and DimensionRegion::LFO3Phase, which allow to + move the start point horizontally of the LFOs' waves (0° ... 360°). + - GIG FORMAT EXTENSION: Added attribute DimensionRegion::LFO3FlipPhase + (the original Gigasampler/GigaStudio software only had that flip phase + option for LFO1 and LFO2). + - Added methods DimensionRegion::UsesAnyGigFormatExtension(), + Region::UsesAnyGigFormatExtension(), + Instrument::UsesAnyGigFormatExtension() and + File::UsesAnyGigFormatExtension() (however only as private methods yet, + see comments on methods why). + - GIG FORMAT EXTENSION: added LinuxSampler specific filter type + implementations to enum vcf_type_t: vcf_type_lowpass_1p, + vcf_type_lowpass_2p, vcf_type_lowpass_4p, vcf_type_lowpass_6p, + vcf_type_highpass_1p, vcf_type_highpass_2p, vcf_type_highpass_4p, + vcf_type_highpass_6p, vcf_type_bandpass_2p, vcf_type_bandreject_2p. + - Compatibility fix: GigaStudio always expects 128 '3gnm' RIFF chunks + (patch by Ivan Maguidhir). + - Compatibility fix: GigaStudio 3 expects '3dnm' and '3ddp' RIFF chunks + (original patch by Ivan Maguidhir). + - Region::DeleteDimensionZone() and Region::SplitDimensionZone(): Fixed + dimensions being in different order after deleting a dimension zone. + - Script: Generate a persistent UUID for each script. + - GIG FORMAT EXTENSION: Added support for script 'patch' variables and + accordingly added new methods to Instrument class: + IsScriptPatchVariableSet(), GetScriptPatchVariables(), + GetScriptPatchVariable(), SetScriptPatchVariable(), + UnsetScriptPatchVariable(); stored persistently as new 'SCPV' RIFF chunk + as child of our '3LS ' list chunk on Instrument level. + - Fixed undefined behaviour when modifying script slots on an instrument + that had been cloned and not been saved yet (e.g. unintended modification + of original instrument's script slots, and crash on Instrument destruction + due to double free of pScriptRefs). + + * src/Serialization.cpp, src/Serialization.h: + - Fixed broken Archive(RawData) constructor which always threw an + Exception. + - Added built-in support for C++ String objects (a.k.a. std::string + from the STL) and bumped Srx format version to 1.1 for that reason. + - Fixed assertion fault on some systems if a member variable defined was + serialized which was declared as size_t or ssize_t data type. + - Added new method Archive::operation() which allows applications to + distinguish between serialization vs. deserialization in their + serialize() method implementations. + - Added built-in support for C++ Array<> objects (a.k.a. std::vector from + the STL). + - Member offsets are now signed and for (newly added support of) member + variables on the heap -1 is always used as offset instead. + - Added built-in support for C++ Set<> objects (a.k.a. std::set from the + STL). + - DataType: Added optional 2nd custom type name. + - Added built-in support for C++ Map<> objects (a.k.a. std::map from the + STL). + + * src/helper.h: + - Fix compile error with GCC 9 due to ignored result value of vasprintf() + function call. + + * src/tools/gigdump.cpp: + - Print dimension region properties LFO1WaveForm, LFO2WaveForm, + LFO3WaveForm, LFO1Phase, LFO2Phase, LFO3Phase, LFO1FlipPhase, + LFO2FlipPhase and LFO3FlipPhase. + +Version 4.2.0 (25 Jul 2019) + + * general changes: + - Added MSVC build support (anonymous patch from mailing list). + - Introduced CMake build support (yet constrained for building with MSVC) + (anonymous patch from mailing list). + - Fix: Don't automatically delete RIFF chunks from DLS/gig classes' + destructors. Added new virtual method DeleteChunks() to those classes + for this which must be explicitly called instead to remove their RIFF + chunks. + - Fix: Many methods of DLS/gig classes assumed a RIFF chunk read position + of zero; which is unsafe per se. + - Added C++11 "override" keyword where appropriate. + - Fixed crash in RIFF, DLS and gig classes which occurred on certain + of their actions when not passing a progress_t callback structure. + + * src/gig.cpp, src/gig.h: + - Fixed Doxygen API comments for enum types (currently latest Doxygen + [v1.8.13] only supports C comments in macro arguments expansion, but + not C++ comments; see lexer rules in src/pre.l of + the Doxygen source code, which currently also filter out new line + \n chars). + - Added new method File::CountSamples(). + - Added new method File::CountInstruments(). + - Fixed gig v4 files falsely being handled as v2 format + (patch by Ivan Maguidhir). + - Added gig v4 version identifier (File::VERSION_4). + - GIG FORMAT EXTENSION: Added attribute + DimensionRegion::SustainReleaseTrigger which allows to define whether + a sustain pedal up event shall cause a release trigger sample to be + played (default: don't play release trigger sample by sustain pedal). + - GIG FORMAT EXTENSION: Added attribute + DimensionRegion::NoNoteOffReleaseTrigger which allows to disable the + regular behaviour of playing release trigger sample on MIDI note-off + events. + - Introduced support for writing extension files (.gx01, .gx02, ...) + (original patch by Ivan Maguidhir). + - Many gig classes derive now from DLS::Storage (see DLS changes below). + - Added File::GetRiffFile() method. + + * src/DLS.cpp, src/DLS.h: + - File: Fixed implicitly allocated RIFF::File object never been freed. + - Added new abstract interface base class DLS::Storage which is derived by + the respective classes for implementing (the old) UpdateChunks() and the + new DeleteChunks() method. + - Added File::GetRiffFile() method. + + * src/sf2.cpp, src/sf2.h: + - Added Sample::GetFile() method. + - Added File::GetRiffFile() method. + + * src/Serialization.cpp, src/Serialization.h: + - Hide pure internal declarations from header file to avoid numerous + compiler warnings when building and linking against the public API. + - Fixed comparision logic bug + - Fixed memory leak in DataType::customTypeName(). + + * src/RIFF.cpp, src/RIFF.h: + - Fix: Calling File::SetMode() left an undefined file handle on Windows and + caused a resource leak + - Avoid compiler warning when building for 32 bit windows. + - Added new method progress_t::subdivide(). + - Fix: API doc comment for Chunk::GetFilePos() was completely wrong. + - progress_t: Added a 2nd (overridden) progress_t::subdivide() method which + allows a more fine graded control into which portions the subtasks are + divided to. + + * src/tools/gigdump.cpp: + - Added command line option --instrument-names which causes only + instrument names and their index numbers to be printed. + +Version 4.1.0 (25 Nov 2017) * general changes: - removed 2 GB limitation when loading a gig or DLS file - using now native integer size where appropriate @@ -12,6 +268,9 @@ korgdump and sf2extract. - Fixed CVE-2017-12950, CVE-2017-12952, CVE-2017-12953 (original patch by Paul Brossier, slightly modified). + - Debian: Fixed packaging error about invalid substitution variable + "Source-Version". + - Raised Debian compatibility level to Debian 9 "Stretch". * src/gig.cpp, src/gig.h: - fixed bug in Script::SetGroup: the script chunk wasn't moved @@ -50,13 +309,15 @@ behavior of the first two EGs' state machines. - Fixed undefined behavior when loading a gig file with invalid velocity curve parameters (fixes CVE-2017-12951). + - Fixed undefined behavior when loading a gig file with invalid wave + pool index number (fixes CVE-2017-12954). * src/DLS.cpp, src/DLS.h: - Sample: wave pool offsets are now 64 bits (to allow support for files larger than 4 GB). - Exception class now has a variadic constructor which allows to add textual format specifiers like with printf(). - + * src/RIFF.cpp, src/RIFF.h: - added support for RIFF files larger than 4 GB, by default the required internal RIFF file offset size is automatically detected (that is RIFF @@ -95,6 +356,9 @@ - DataType fix: Retain backward compatibility to older versions of native C++ classes/structs. + * src/Akai.cpp: + - Fixed compilation error with recent, more strict compilers. + * src/tools/akaidump.cpp, src/tools/akaiextract.cpp: - improved output of non-ascii characters in usage messages - fixed printf format strings