/[svn]/libgig/trunk/ChangeLog
ViewVC logotype

Diff of /libgig/trunk/ChangeLog

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3349 by schoenebeck, Tue Oct 3 17:12:07 2017 UTC revision 3979 by schoenebeck, Mon Jul 19 14:43:22 2021 UTC
# Line 1  Line 1 
1  Version SVN trunk  Version SVN trunk (?)
2    
3      * src/gig.cpp, src/gig.h:
4        - Region::DeleteDimensionZone(): Fix clang sanatizer warning.
5        - Region::SplitDimensionZone(): Fix clang sanatizer warning.
6        - Sample: Fix unnecessary RAM consumption in case of 24 bit samples
7          (InternalDecompressionBuffer is no longer needed for 24 bit samples since
8          SVN r902 / libgig release 3.1.0).
9        - Use GetSubChunkAt() instead of GetFirstSubChunk() / GetNextSubChunk() in
10          entire gig.cpp file.
11        - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in
12          entire gig.cpp file.
13        - Added method Instrument::GetRegionAt().
14        - Marked methods Instrument::GetFirstRegion() and
15          Instrument::GetNextRegion() as deprecated.
16        - Use GetRegionAt() instead of GetFirstRegion() / GetNextRegion() in entire
17          gig.cpp file.
18        - Changed signature of method File::GetSample(uint) to
19          File::GetSample(size_t,progress_t*).
20        - Marked methods File::GetFirstSample() and File::GetNextSample() as
21          deprecated.
22        - Use File::GetSample() instead of File::GetFirstSample() /
23          File::GetNextSample() in entire gig.cpp file.
24        - Added method Group::GetSample().
25        - Marked methods Group::GetFirstSample() and Group::GetNextSample() as
26          deprecated.
27        - Use Group::GetSample() instead of Group::GetFirstSample() /
28          Group::GetNextSample() in entire gig.cpp file.
29        - Changed signature of method File::GetGroup(uint) to
30          File::GetGroup(size_t).
31        - Fixed File::GetGroup(size_t) to be reentrant-safe.
32        - Marked methods GetFirstGroup() and GetNextGroup() as deprecated.
33        - Fixed GetGroup(String) to be reentrant-safe.
34        - Use GetGroup() instead of GetFirstGroup() / GetNextGroup() in entire
35          gig.cpp file.
36        - Changed signature of method File::GetInstrument(uint,progress_t*) to
37          File::GetInstrument(size_t,progress_t*).
38        - Fixed File::GetInstrument(size_t,progress_t*) to be reentrant-safe.
39        - Marked methods File::GetFirstInstrument() and File::GetNextInstrument()
40          as deprecated.
41        - Use File::GetInstrument() instead of File::GetFirstInstrument() /
42          File::GetNextInstrument() in entire gig.cpp file.
43        - Optimized method ScriptGroup::GetScript() to have constant time
44          efficiency.
45        - Changed signature of method File::GetScriptGroup(uint) to
46          File::GetScriptGroup(size_t).
47        - Optimized method File::GetScriptGroup(size_t) to have constant time
48          efficiency.
49        - Changed signature of method ScriptGroup::GetScript(uint) to
50          ScriptGroup::GetScript(size_t).
51        - Changed signature of method Instrument::GetScriptOfSlot(uint) to
52          Instrument::GetScriptOfSlot(size_t).
53        - Changed signature of method Instrument::SwapScriptSlots(uint,uint) to
54          Instrument::SwapScriptSlots(size_t,size_t).
55        - Changed signature of method Instrument::RemoveScriptSlot(uint) to
56          Instrument::RemoveScriptSlot(size_t).
57        - Changed signature of method Instrument::ScriptSlotCount() to return
58          size_t instead of uint.
59        - Changed signature of method Instrument::IsScriptSlotBypassed(uint) to
60          Instrument::IsScriptSlotBypassed(size_t).
61        - Changed signature of method Instrument::SetScriptSlotBypassed(uint,bool)
62          to Instrument::SetScriptSlotBypassed(size_t,bool).
63        - Changed signature of method
64          Instrument::IsScriptPatchVariableSet(int,String) to
65          Instrument::IsScriptPatchVariableSet(size_t,String).
66        - Changed signature of method Instrument::GetScriptPatchVariables(int) to
67          Instrument::GetScriptPatchVariables(size_t).
68        - Changed signature of method
69          Instrument::GetScriptPatchVariable(int,String) to
70          Instrument::GetScriptPatchVariable(size_t,String).
71        - Changed signature of method
72          Instrument::SetScriptPatchVariable(int,String,String) to
73          Instrument::SetScriptPatchVariable(size_t,String,String).
74        - Changed signature of method
75          Instrument::UnsetScriptPatchVariable(int,String) to
76          Instrument::UnsetScriptPatchVariable(ssize_t,String).
77        - Fixed iterator invalidation (i.e. crash) caused by adding / removing
78          samples (only triggered if now deprecated File::GetFirstSample() /
79          File::GetNextSample() methods were still used).
80        - Fixed Sample::Write() method not having updated sample's CRC (correctly)
81          if sample was previously resized.
82        - Fixed iterator invalidation (i.e. crash) caused by adding / removing /
83          moving regions (only triggered if now deprecated File::GetFirstRegion() /
84          File::GetNextRegion() methods were still used).
85        - Fixed iterator invalidation (i.e. crash) caused by adding / removing
86          instruments (only triggered if now deprecated File::GetFirstInstrument() /
87          File::GetNextInstrument() methods were still used).
88    
89      * src/SF.cpp, src/SF.h:
90        - File::DeleteInstrument(): Fix clang sanatizer warning.
91    
92      * src/DLS.cpp, src/DLS.h:
93        - Use GetSubChunkAt() instead of GetFirstSubChunk() / GetNextSubChunk() in
94          entire DLS.cpp file.
95        - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in
96          entire DLS.cpp file.
97        - Added method Instrument::GetRegionAt().
98        - Marked methods Instrument::GetFirstRegion() and
99          Instrument::GetNextRegion() as deprecated.
100        - Use GetRegionAt() instead of GetFirstRegion() / GetNextRegion() in entire
101          DLS.cpp file.
102        - Added method File::GetSample().
103        - Marked methods File::GetFirstSample() and File::GetNextSample() as
104          deprecated.
105        - Use File::GetSample() instead of File::GetFirstSample() /
106          File::GetNextSample() in entire DLS.cpp file.
107        - Added method Articulator::GetArticulation().
108        - Marked methods Articulator::GetFirstArticulation() and
109          Articulator::GetNextArticulation() as deprecated.
110        - Added method File::GetInstrument().
111        - Marked methods File::GetFirstInstrument() and File::GetNextInstrument()
112          as deprecated.
113        - Added method Instrument::CountRegions().
114        - Fixed iterator invalidation (i.e. crash) caused by adding / removing
115          samples (only triggered if now deprecated File::GetFirstSample() /
116          File::GetNextSample() methods were still used).
117        - Fixed iterator invalidation (i.e. crash) caused by adding / removing /
118          moving regions (only triggered if now deprecated File::GetFirstRegion() /
119          File::GetNextRegion() methods were still used).
120        - Fixed iterator invalidation (i.e. crash) caused by adding / removing
121          instruments (only triggered if now deprecated File::GetFirstInstrument() /
122          File::GetNextInstrument() methods were still used).
123    
124      * src/RIFF.cpp, src/RIFF.h:
125        - Chunk::LoadChunkData(): Fix clang sanatizer warning.
126        - List::LoadSubChunks(): Fix potential garbage data access if reading a
127          RIFF chunk ID failed.
128        - Added methods File::IsIOPerThread() and File::SetIOPerThread(bool); the
129          latter allows to automatically use a separate file I/O stream state for
130          each thread.
131        - Added method List::GetSubChunkAt().
132        - Added method List::GetSubListAt().
133        - Marked methods List::GetFirstSubChunk(), List::GetNextSubChunk(),
134          List::GetFirstSubList() and List::GetNextSubList() as deprecated.
135        - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in
136          entire RIFF.cpp file.
137    
138    Version 4.3.0 (9 May 2021)
139    
140      * general changes:
141        - Require at least a C++11 compliant compiler.
142        - Require some UUID generating function by underlying system.
143    
144      * src/gig.cpp, src/gig.h:
145        - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1WaveForm,
146          DimensionRegion::LFO2WaveForm and DimensionRegion::LFO3WaveForm, which
147          allow to define override LFOs' wave form (e.g. saw or square instead of
148          the default wave form which was always sine in the original
149          Gigasampler/GigaStudio software).
150        - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1Phase,
151          DimensionRegion::LFO2Phase and DimensionRegion::LFO3Phase, which allow to
152          move the start point horizontally of the LFOs' waves (0° ... 360°).
153        - GIG FORMAT EXTENSION: Added attribute DimensionRegion::LFO3FlipPhase
154          (the original Gigasampler/GigaStudio software only had that flip phase
155          option for LFO1 and LFO2).
156        - Added methods DimensionRegion::UsesAnyGigFormatExtension(),
157          Region::UsesAnyGigFormatExtension(),
158          Instrument::UsesAnyGigFormatExtension() and
159          File::UsesAnyGigFormatExtension() (however only as private methods yet,
160          see comments on methods why).
161        - GIG FORMAT EXTENSION: added LinuxSampler specific filter type
162          implementations to enum vcf_type_t: vcf_type_lowpass_1p,
163          vcf_type_lowpass_2p, vcf_type_lowpass_4p, vcf_type_lowpass_6p,
164          vcf_type_highpass_1p, vcf_type_highpass_2p, vcf_type_highpass_4p,
165          vcf_type_highpass_6p, vcf_type_bandpass_2p, vcf_type_bandreject_2p.
166        - Compatibility fix: GigaStudio always expects 128 '3gnm' RIFF chunks
167          (patch by Ivan Maguidhir).
168        - Compatibility fix: GigaStudio 3 expects '3dnm' and '3ddp' RIFF chunks
169          (original patch by Ivan Maguidhir).
170        - Region::DeleteDimensionZone() and Region::SplitDimensionZone(): Fixed
171          dimensions being in different order after deleting a dimension zone.
172        - Script: Generate a persistent UUID for each script.
173        - GIG FORMAT EXTENSION: Added support for script 'patch' variables and
174          accordingly added new methods to Instrument class:
175          IsScriptPatchVariableSet(), GetScriptPatchVariables(),
176          GetScriptPatchVariable(), SetScriptPatchVariable(),
177          UnsetScriptPatchVariable(); stored persistently as new 'SCPV' RIFF chunk
178          as child of our '3LS ' list chunk on Instrument level.
179        - Fixed undefined behaviour when modifying script slots on an instrument
180          that had been cloned and not been saved yet (e.g. unintended modification
181          of original instrument's script slots, and crash on Instrument destruction
182          due to double free of pScriptRefs).
183    
184      * src/Serialization.cpp, src/Serialization.h:
185        - Fixed broken Archive(RawData) constructor which always threw an
186          Exception.
187        - Added built-in support for C++ String objects (a.k.a. std::string
188          from the STL) and bumped Srx format version to 1.1 for that reason.
189        - Fixed assertion fault on some systems if a member variable defined was
190          serialized which was declared as size_t or ssize_t data type.
191        - Added new method Archive::operation() which allows applications to
192          distinguish between serialization vs. deserialization in their
193          serialize() method implementations.
194        - Added built-in support for C++ Array<> objects (a.k.a. std::vector from
195          the STL).
196        - Member offsets are now signed and for (newly added support of) member
197          variables on the heap -1 is always used as offset instead.
198        - Added built-in support for C++ Set<> objects (a.k.a. std::set from the
199          STL).
200        - DataType: Added optional 2nd custom type name.
201        - Added built-in support for C++ Map<> objects (a.k.a. std::map from the
202          STL).
203    
204      * src/helper.h:
205        - Fix compile error with GCC 9 due to ignored result value of vasprintf()
206          function call.
207    
208      * src/tools/gigdump.cpp:
209        - Print dimension region properties LFO1WaveForm, LFO2WaveForm,
210          LFO3WaveForm, LFO1Phase, LFO2Phase, LFO3Phase, LFO1FlipPhase,
211          LFO2FlipPhase and LFO3FlipPhase.
212    
213    Version 4.2.0 (25 Jul 2019)
214    
215      * general changes:
216        - Added MSVC build support (anonymous patch from mailing list).
217        - Introduced CMake build support (yet constrained for building with MSVC)
218          (anonymous patch from mailing list).
219        - Fix: Don't automatically delete RIFF chunks from DLS/gig classes'
220          destructors. Added new virtual method DeleteChunks() to those classes
221          for this which must be explicitly called instead to remove their RIFF
222          chunks.
223        - Fix: Many methods of DLS/gig classes assumed a RIFF chunk read position
224          of zero; which is unsafe per se.
225        - Added C++11 "override" keyword where appropriate.
226        - Fixed crash in RIFF, DLS and gig classes which occurred on certain
227          of their actions when not passing a progress_t callback structure.
228    
229      * src/gig.cpp, src/gig.h:
230        - Fixed Doxygen API comments for enum types (currently latest Doxygen
231          [v1.8.13] only supports C comments in macro arguments expansion, but
232          not C++ comments; see <FindDefineArgs> lexer rules in src/pre.l of
233          the Doxygen source code, which currently also filter out new line
234          \n chars).
235        - Added new method File::CountSamples().
236        - Added new method File::CountInstruments().
237        - Fixed gig v4 files falsely being handled as v2 format
238          (patch by Ivan Maguidhir).
239        - Added gig v4 version identifier (File::VERSION_4).
240        - GIG FORMAT EXTENSION: Added attribute
241          DimensionRegion::SustainReleaseTrigger which allows to define whether
242          a sustain pedal up event shall cause a release trigger sample to be
243          played (default: don't play release trigger sample by sustain pedal).
244        - GIG FORMAT EXTENSION: Added attribute
245          DimensionRegion::NoNoteOffReleaseTrigger which allows to disable the
246          regular behaviour of playing release trigger sample on MIDI note-off
247          events.
248        - Introduced support for writing extension files (.gx01, .gx02, ...)
249          (original patch by Ivan Maguidhir).
250        - Many gig classes derive now from DLS::Storage (see DLS changes below).
251        - Added File::GetRiffFile() method.
252    
253      * src/DLS.cpp, src/DLS.h:
254        - File: Fixed implicitly allocated RIFF::File object never been freed.
255        - Added new abstract interface base class DLS::Storage which is derived by
256          the respective classes for implementing (the old) UpdateChunks() and the
257          new DeleteChunks() method.
258        - Added File::GetRiffFile() method.
259    
260      * src/sf2.cpp, src/sf2.h:
261        - Added Sample::GetFile() method.
262        - Added File::GetRiffFile() method.
263    
264      * src/Serialization.cpp, src/Serialization.h:
265        - Hide pure internal declarations from header file to avoid numerous
266          compiler warnings when building and linking against the public API.
267        - Fixed comparision logic bug
268        - Fixed memory leak in DataType::customTypeName().
269    
270      * src/RIFF.cpp, src/RIFF.h:
271        - Fix: Calling File::SetMode() left an undefined file handle on Windows and
272          caused a resource leak
273        - Avoid compiler warning when building for 32 bit windows.
274        - Added new method progress_t::subdivide().
275        - Fix: API doc comment for Chunk::GetFilePos() was completely wrong.
276        - progress_t: Added a 2nd (overridden) progress_t::subdivide() method which
277          allows a more fine graded control into which portions the subtasks are
278          divided to.
279    
280      * src/tools/gigdump.cpp:
281        - Added command line option --instrument-names which causes only
282          instrument names and their index numbers to be printed.
283    
284    Version 4.1.0 (25 Nov 2017)
285    * general changes:    * general changes:
286      - removed 2 GB limitation when loading a gig or DLS file      - removed 2 GB limitation when loading a gig or DLS file
287      - using now native integer size where appropriate      - using now native integer size where appropriate
# Line 12  Version SVN trunk Line 295  Version SVN trunk
295        korgdump and sf2extract.        korgdump and sf2extract.
296      - Fixed CVE-2017-12950, CVE-2017-12952, CVE-2017-12953      - Fixed CVE-2017-12950, CVE-2017-12952, CVE-2017-12953
297        (original patch by Paul Brossier, slightly modified).        (original patch by Paul Brossier, slightly modified).
298        - Debian: Fixed packaging error about invalid substitution variable
299          "Source-Version".
300        - Raised Debian compatibility level to Debian 9 "Stretch".
301    
302    * src/gig.cpp, src/gig.h:    * src/gig.cpp, src/gig.h:
303      - fixed bug in Script::SetGroup: the script chunk wasn't moved      - fixed bug in Script::SetGroup: the script chunk wasn't moved
# Line 50  Version SVN trunk Line 336  Version SVN trunk
336        behavior of the first two EGs' state machines.        behavior of the first two EGs' state machines.
337      - Fixed undefined behavior when loading a gig file with invalid      - Fixed undefined behavior when loading a gig file with invalid
338        velocity curve parameters (fixes CVE-2017-12951).        velocity curve parameters (fixes CVE-2017-12951).
339        - Fixed undefined behavior when loading a gig file with invalid wave
340          pool index number (fixes CVE-2017-12954).
341    
342    * src/DLS.cpp, src/DLS.h:    * src/DLS.cpp, src/DLS.h:
343      - Sample: wave pool offsets are now 64 bits (to allow support for files      - Sample: wave pool offsets are now 64 bits (to allow support for files
344        larger than 4 GB).        larger than 4 GB).
345      - Exception class now has a variadic constructor which allows to add      - Exception class now has a variadic constructor which allows to add
346        textual format specifiers like with printf().        textual format specifiers like with printf().
347          
348    * src/RIFF.cpp, src/RIFF.h:    * src/RIFF.cpp, src/RIFF.h:
349      - added support for RIFF files larger than 4 GB, by default the required      - added support for RIFF files larger than 4 GB, by default the required
350        internal RIFF file offset size is automatically detected (that is RIFF        internal RIFF file offset size is automatically detected (that is RIFF
# Line 95  Version SVN trunk Line 383  Version SVN trunk
383      - DataType fix: Retain backward compatibility to older versions of native      - DataType fix: Retain backward compatibility to older versions of native
384        C++ classes/structs.        C++ classes/structs.
385    
386      * src/Akai.cpp:
387        - Fixed compilation error with recent, more strict compilers.
388    
389    * src/tools/akaidump.cpp, src/tools/akaiextract.cpp:    * src/tools/akaidump.cpp, src/tools/akaiextract.cpp:
390      - improved output of non-ascii characters in usage messages      - improved output of non-ascii characters in usage messages
391      - fixed printf format strings      - fixed printf format strings

Legend:
Removed from v.3349  
changed lines
  Added in v.3979

  ViewVC Help
Powered by ViewVC