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

Diff of /libgig/trunk/ChangeLog

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

revision 3173 by schoenebeck, Wed May 10 23:07:28 2017 UTC revision 3977 by schoenebeck, Mon Jul 19 14:31:43 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    
86      * src/SF.cpp, src/SF.h:
87        - File::DeleteInstrument(): Fix clang sanatizer warning.
88    
89      * src/DLS.cpp, src/DLS.h:
90        - Use GetSubChunkAt() instead of GetFirstSubChunk() / GetNextSubChunk() in
91          entire DLS.cpp file.
92        - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in
93          entire DLS.cpp file.
94        - Added method Instrument::GetRegionAt().
95        - Marked methods Instrument::GetFirstRegion() and
96          Instrument::GetNextRegion() as deprecated.
97        - Use GetRegionAt() instead of GetFirstRegion() / GetNextRegion() in entire
98          DLS.cpp file.
99        - Added method File::GetSample().
100        - Marked methods File::GetFirstSample() and File::GetNextSample() as
101          deprecated.
102        - Use File::GetSample() instead of File::GetFirstSample() /
103          File::GetNextSample() in entire DLS.cpp file.
104        - Added method Articulator::GetArticulation().
105        - Marked methods Articulator::GetFirstArticulation() and
106          Articulator::GetNextArticulation() as deprecated.
107        - Added method File::GetInstrument().
108        - Marked methods File::GetFirstInstrument() and File::GetNextInstrument()
109          as deprecated.
110        - Added method Instrument::CountRegions().
111        - Fixed iterator invalidation (i.e. crash) caused by adding / removing
112          samples (only triggered if now deprecated File::GetFirstSample() /
113          File::GetNextSample() methods were still used).
114        - Fixed iterator invalidation (i.e. crash) caused by adding / removing /
115          moving regions (only triggered if now deprecated File::GetFirstRegion() /
116          File::GetNextRegion() methods were still used).
117    
118      * src/RIFF.cpp, src/RIFF.h:
119        - Chunk::LoadChunkData(): Fix clang sanatizer warning.
120        - List::LoadSubChunks(): Fix potential garbage data access if reading a
121          RIFF chunk ID failed.
122        - Added methods File::IsIOPerThread() and File::SetIOPerThread(bool); the
123          latter allows to automatically use a separate file I/O stream state for
124          each thread.
125        - Added method List::GetSubChunkAt().
126        - Added method List::GetSubListAt().
127        - Marked methods List::GetFirstSubChunk(), List::GetNextSubChunk(),
128          List::GetFirstSubList() and List::GetNextSubList() as deprecated.
129        - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in
130          entire RIFF.cpp file.
131    
132    Version 4.3.0 (9 May 2021)
133    
134      * general changes:
135        - Require at least a C++11 compliant compiler.
136        - Require some UUID generating function by underlying system.
137    
138      * src/gig.cpp, src/gig.h:
139        - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1WaveForm,
140          DimensionRegion::LFO2WaveForm and DimensionRegion::LFO3WaveForm, which
141          allow to define override LFOs' wave form (e.g. saw or square instead of
142          the default wave form which was always sine in the original
143          Gigasampler/GigaStudio software).
144        - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1Phase,
145          DimensionRegion::LFO2Phase and DimensionRegion::LFO3Phase, which allow to
146          move the start point horizontally of the LFOs' waves (0° ... 360°).
147        - GIG FORMAT EXTENSION: Added attribute DimensionRegion::LFO3FlipPhase
148          (the original Gigasampler/GigaStudio software only had that flip phase
149          option for LFO1 and LFO2).
150        - Added methods DimensionRegion::UsesAnyGigFormatExtension(),
151          Region::UsesAnyGigFormatExtension(),
152          Instrument::UsesAnyGigFormatExtension() and
153          File::UsesAnyGigFormatExtension() (however only as private methods yet,
154          see comments on methods why).
155        - GIG FORMAT EXTENSION: added LinuxSampler specific filter type
156          implementations to enum vcf_type_t: vcf_type_lowpass_1p,
157          vcf_type_lowpass_2p, vcf_type_lowpass_4p, vcf_type_lowpass_6p,
158          vcf_type_highpass_1p, vcf_type_highpass_2p, vcf_type_highpass_4p,
159          vcf_type_highpass_6p, vcf_type_bandpass_2p, vcf_type_bandreject_2p.
160        - Compatibility fix: GigaStudio always expects 128 '3gnm' RIFF chunks
161          (patch by Ivan Maguidhir).
162        - Compatibility fix: GigaStudio 3 expects '3dnm' and '3ddp' RIFF chunks
163          (original patch by Ivan Maguidhir).
164        - Region::DeleteDimensionZone() and Region::SplitDimensionZone(): Fixed
165          dimensions being in different order after deleting a dimension zone.
166        - Script: Generate a persistent UUID for each script.
167        - GIG FORMAT EXTENSION: Added support for script 'patch' variables and
168          accordingly added new methods to Instrument class:
169          IsScriptPatchVariableSet(), GetScriptPatchVariables(),
170          GetScriptPatchVariable(), SetScriptPatchVariable(),
171          UnsetScriptPatchVariable(); stored persistently as new 'SCPV' RIFF chunk
172          as child of our '3LS ' list chunk on Instrument level.
173        - Fixed undefined behaviour when modifying script slots on an instrument
174          that had been cloned and not been saved yet (e.g. unintended modification
175          of original instrument's script slots, and crash on Instrument destruction
176          due to double free of pScriptRefs).
177    
178      * src/Serialization.cpp, src/Serialization.h:
179        - Fixed broken Archive(RawData) constructor which always threw an
180          Exception.
181        - Added built-in support for C++ String objects (a.k.a. std::string
182          from the STL) and bumped Srx format version to 1.1 for that reason.
183        - Fixed assertion fault on some systems if a member variable defined was
184          serialized which was declared as size_t or ssize_t data type.
185        - Added new method Archive::operation() which allows applications to
186          distinguish between serialization vs. deserialization in their
187          serialize() method implementations.
188        - Added built-in support for C++ Array<> objects (a.k.a. std::vector from
189          the STL).
190        - Member offsets are now signed and for (newly added support of) member
191          variables on the heap -1 is always used as offset instead.
192        - Added built-in support for C++ Set<> objects (a.k.a. std::set from the
193          STL).
194        - DataType: Added optional 2nd custom type name.
195        - Added built-in support for C++ Map<> objects (a.k.a. std::map from the
196          STL).
197    
198      * src/helper.h:
199        - Fix compile error with GCC 9 due to ignored result value of vasprintf()
200          function call.
201    
202      * src/tools/gigdump.cpp:
203        - Print dimension region properties LFO1WaveForm, LFO2WaveForm,
204          LFO3WaveForm, LFO1Phase, LFO2Phase, LFO3Phase, LFO1FlipPhase,
205          LFO2FlipPhase and LFO3FlipPhase.
206    
207    Version 4.2.0 (25 Jul 2019)
208    
209      * general changes:
210        - Added MSVC build support (anonymous patch from mailing list).
211        - Introduced CMake build support (yet constrained for building with MSVC)
212          (anonymous patch from mailing list).
213        - Fix: Don't automatically delete RIFF chunks from DLS/gig classes'
214          destructors. Added new virtual method DeleteChunks() to those classes
215          for this which must be explicitly called instead to remove their RIFF
216          chunks.
217        - Fix: Many methods of DLS/gig classes assumed a RIFF chunk read position
218          of zero; which is unsafe per se.
219        - Added C++11 "override" keyword where appropriate.
220        - Fixed crash in RIFF, DLS and gig classes which occurred on certain
221          of their actions when not passing a progress_t callback structure.
222    
223      * src/gig.cpp, src/gig.h:
224        - Fixed Doxygen API comments for enum types (currently latest Doxygen
225          [v1.8.13] only supports C comments in macro arguments expansion, but
226          not C++ comments; see <FindDefineArgs> lexer rules in src/pre.l of
227          the Doxygen source code, which currently also filter out new line
228          \n chars).
229        - Added new method File::CountSamples().
230        - Added new method File::CountInstruments().
231        - Fixed gig v4 files falsely being handled as v2 format
232          (patch by Ivan Maguidhir).
233        - Added gig v4 version identifier (File::VERSION_4).
234        - GIG FORMAT EXTENSION: Added attribute
235          DimensionRegion::SustainReleaseTrigger which allows to define whether
236          a sustain pedal up event shall cause a release trigger sample to be
237          played (default: don't play release trigger sample by sustain pedal).
238        - GIG FORMAT EXTENSION: Added attribute
239          DimensionRegion::NoNoteOffReleaseTrigger which allows to disable the
240          regular behaviour of playing release trigger sample on MIDI note-off
241          events.
242        - Introduced support for writing extension files (.gx01, .gx02, ...)
243          (original patch by Ivan Maguidhir).
244        - Many gig classes derive now from DLS::Storage (see DLS changes below).
245        - Added File::GetRiffFile() method.
246    
247      * src/DLS.cpp, src/DLS.h:
248        - File: Fixed implicitly allocated RIFF::File object never been freed.
249        - Added new abstract interface base class DLS::Storage which is derived by
250          the respective classes for implementing (the old) UpdateChunks() and the
251          new DeleteChunks() method.
252        - Added File::GetRiffFile() method.
253    
254      * src/sf2.cpp, src/sf2.h:
255        - Added Sample::GetFile() method.
256        - Added File::GetRiffFile() method.
257    
258      * src/Serialization.cpp, src/Serialization.h:
259        - Hide pure internal declarations from header file to avoid numerous
260          compiler warnings when building and linking against the public API.
261        - Fixed comparision logic bug
262        - Fixed memory leak in DataType::customTypeName().
263    
264      * src/RIFF.cpp, src/RIFF.h:
265        - Fix: Calling File::SetMode() left an undefined file handle on Windows and
266          caused a resource leak
267        - Avoid compiler warning when building for 32 bit windows.
268        - Added new method progress_t::subdivide().
269        - Fix: API doc comment for Chunk::GetFilePos() was completely wrong.
270        - progress_t: Added a 2nd (overridden) progress_t::subdivide() method which
271          allows a more fine graded control into which portions the subtasks are
272          divided to.
273    
274      * src/tools/gigdump.cpp:
275        - Added command line option --instrument-names which causes only
276          instrument names and their index numbers to be printed.
277    
278    Version 4.1.0 (25 Nov 2017)
279    * general changes:    * general changes:
280      - removed 2 GB limitation when loading a gig or DLS file      - removed 2 GB limitation when loading a gig or DLS file
281      - using now native integer size where appropriate      - using now native integer size where appropriate
# Line 8  Version SVN trunk Line 285  Version SVN trunk
285        which allows to serialize and deserialize native C++ objects        which allows to serialize and deserialize native C++ objects
286        in a portable, easy and flexible way.        in a portable, easy and flexible way.
287      - print compiler warning if no RTTI available      - print compiler warning if no RTTI available
288        - Fixed potential crash in command line tools gig2stereo, korg2gig,
289          korgdump and sf2extract.
290        - Fixed CVE-2017-12950, CVE-2017-12952, CVE-2017-12953
291          (original patch by Paul Brossier, slightly modified).
292        - Debian: Fixed packaging error about invalid substitution variable
293          "Source-Version".
294        - Raised Debian compatibility level to Debian 9 "Stretch".
295    
296    * src/gig.cpp, src/gig.h:    * src/gig.cpp, src/gig.h:
297      - fixed bug in Script::SetGroup: the script chunk wasn't moved      - fixed bug in Script::SetGroup: the script chunk wasn't moved
# Line 33  Version SVN trunk Line 317  Version SVN trunk
317      - Added support for serializing & deserializing DimensionRegion      - Added support for serializing & deserializing DimensionRegion
318        objects (and crossfade_t and leverage_ctrl_t objects).        objects (and crossfade_t and leverage_ctrl_t objects).
319      - Added enum reflection API functions for retrieving enum declaration type      - Added enum reflection API functions for retrieving enum declaration type
320        information at runtime (countEnum(), enumKey(), enumKeys(), enumValue()).        information at runtime (enumCount(), enumKey(), enumKeys(), enumValue()).
321        - Exception class now has a variadic constructor which allows to add
322          textual format specifiers like with printf().
323        - On unknown leverage controller exception: show precise unknown leverage
324          controller number found.
325        - Ignore invalid leverage controller types and just show a warning on the
326          console instead of throwing an exception.
327        - Added new struct eg_opt_t and new class member variable
328          DimensionRegion::EG1Options and DimensionRegion::EG2Options as an
329          extension to the gig file format, which allows to override the default
330          behavior of the first two EGs' state machines.
331        - Fixed undefined behavior when loading a gig file with invalid
332          velocity curve parameters (fixes CVE-2017-12951).
333        - Fixed undefined behavior when loading a gig file with invalid wave
334          pool index number (fixes CVE-2017-12954).
335    
336    * src/DLS.cpp, src/DLS.h:    * src/DLS.cpp, src/DLS.h:
337      - 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
338        larger than 4 GB).        larger than 4 GB).
339              - Exception class now has a variadic constructor which allows to add
340          textual format specifiers like with printf().
341    
342    * src/RIFF.cpp, src/RIFF.h:    * src/RIFF.cpp, src/RIFF.h:
343      - 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
344        internal RIFF file offset size is automatically detected (that is RIFF        internal RIFF file offset size is automatically detected (that is RIFF
# Line 47  Version SVN trunk Line 347  Version SVN trunk
347        with a new option added to the RIFF File constructor though        with a new option added to the RIFF File constructor though
348      - when saving a modified, grown RIFF file, the temporary file size during      - when saving a modified, grown RIFF file, the temporary file size during
349        Save() operation will no longer be larger than the final grown file size        Save() operation will no longer be larger than the final grown file size
350        - Exception class now has a variadic constructor which allows to add
351          textual format specifiers like with printf().
352    
353    * src/Serialization.cpp, src/Serialization.h:    * src/Serialization.cpp, src/Serialization.h:
354      - Archive: Added method isModified().      - Archive: Added method isModified().
# Line 68  Version SVN trunk Line 370  Version SVN trunk
370      - Archive: Added methods valueAsInt(), valueAsReal() and valueAsBool().      - Archive: Added methods valueAsInt(), valueAsReal() and valueAsBool().
371      - DataType: Implemented demangling C++ type names (for methods      - DataType: Implemented demangling C++ type names (for methods
372        asLongDescr() and customTypeName(bool demangle=false)).        asLongDescr() and customTypeName(bool demangle=false)).
373        - Archive::setAutoValue(): Handle human readable boolean text
374          representations like "yes", "no", "true", "false" as expected.
375        - Exception class now has a variadic constructor which allows to add
376          textual format specifiers like with printf().
377        - DataType fix: Retain backward compatibility to older versions of native
378          C++ classes/structs.
379    
380      * src/Akai.cpp:
381        - Fixed compilation error with recent, more strict compilers.
382    
383    * src/tools/akaidump.cpp, src/tools/akaiextract.cpp:    * src/tools/akaidump.cpp, src/tools/akaiextract.cpp:
384      - improved output of non-ascii characters in usage messages      - improved output of non-ascii characters in usage messages
# Line 89  Version SVN trunk Line 400  Version SVN trunk
400        rebuilding the gig file's global checksum table (i.e. in case the        rebuilding the gig file's global checksum table (i.e. in case the
401        file's checksum table was damaged)        file's checksum table was damaged)
402      - print samples' CRC32 checksums      - print samples' CRC32 checksums
403        - Print the new EG behavior options (eg_opt_t).
404    
405    * src/tools/gigextract.cpp:    * src/tools/gigextract.cpp:
406      - Fix: if sample name contains a path separator (slash or backslash) then      - Fix: if sample name contains a path separator (slash or backslash) then
Legend:
Removed from v.3173  
changed lines
  Added in v.3977
  ViewVC Help
Powered by ViewVC