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

  ViewVC Help
Powered by ViewVC