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

Diff of /libgig/trunk/ChangeLog

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

revision 2990 by schoenebeck, Sat Sep 24 15:02:28 2016 UTC revision 4076 by schoenebeck, Fri Jan 26 15:59:01 2024 UTC
# Line 1  Line 1 
1  Version SVN trunk  Version 4.4.0 (26 Jan 2024)
2    
3      * general changes:
4        - Add new command line tool "wav2gig".
5        - Fix build errors on Windows (patches by Ross Maxx).
6    
7      * src/gig.cpp, src/gig.h:
8        - Region::DeleteDimensionZone(): Fix clang sanatizer warning.
9        - Region::SplitDimensionZone(): Fix clang sanatizer warning.
10        - Sample: Fix unnecessary RAM consumption in case of 24 bit samples
11          (InternalDecompressionBuffer is no longer needed for 24 bit samples since
12          SVN r902 / libgig release 3.1.0).
13        - Use GetSubChunkAt() instead of GetFirstSubChunk() / GetNextSubChunk() in
14          entire gig.cpp file.
15        - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in
16          entire gig.cpp file.
17        - Added method Instrument::GetRegionAt().
18        - Marked methods Instrument::GetFirstRegion() and
19          Instrument::GetNextRegion() as deprecated.
20        - Use GetRegionAt() instead of GetFirstRegion() / GetNextRegion() in entire
21          gig.cpp file.
22        - Changed signature of method File::GetSample(uint) to
23          File::GetSample(size_t,progress_t*).
24        - Marked methods File::GetFirstSample() and File::GetNextSample() as
25          deprecated.
26        - Use File::GetSample() instead of File::GetFirstSample() /
27          File::GetNextSample() in entire gig.cpp file.
28        - Added method Group::GetSample().
29        - Marked methods Group::GetFirstSample() and Group::GetNextSample() as
30          deprecated.
31        - Use Group::GetSample() instead of Group::GetFirstSample() /
32          Group::GetNextSample() in entire gig.cpp file.
33        - Changed signature of method File::GetGroup(uint) to
34          File::GetGroup(size_t).
35        - Fixed File::GetGroup(size_t) to be reentrant-safe.
36        - Marked methods GetFirstGroup() and GetNextGroup() as deprecated.
37        - Fixed GetGroup(String) to be reentrant-safe.
38        - Use GetGroup() instead of GetFirstGroup() / GetNextGroup() in entire
39          gig.cpp file.
40        - Changed signature of method File::GetInstrument(uint,progress_t*) to
41          File::GetInstrument(size_t,progress_t*).
42        - Fixed File::GetInstrument(size_t,progress_t*) to be reentrant-safe.
43        - Marked methods File::GetFirstInstrument() and File::GetNextInstrument()
44          as deprecated.
45        - Use File::GetInstrument() instead of File::GetFirstInstrument() /
46          File::GetNextInstrument() in entire gig.cpp file.
47        - Optimized method ScriptGroup::GetScript() to have constant time
48          efficiency.
49        - Changed signature of method File::GetScriptGroup(uint) to
50          File::GetScriptGroup(size_t).
51        - Optimized method File::GetScriptGroup(size_t) to have constant time
52          efficiency.
53        - Changed signature of method ScriptGroup::GetScript(uint) to
54          ScriptGroup::GetScript(size_t).
55        - Changed signature of method Instrument::GetScriptOfSlot(uint) to
56          Instrument::GetScriptOfSlot(size_t).
57        - Changed signature of method Instrument::SwapScriptSlots(uint,uint) to
58          Instrument::SwapScriptSlots(size_t,size_t).
59        - Changed signature of method Instrument::RemoveScriptSlot(uint) to
60          Instrument::RemoveScriptSlot(size_t).
61        - Changed signature of method Instrument::ScriptSlotCount() to return
62          size_t instead of uint.
63        - Changed signature of method Instrument::IsScriptSlotBypassed(uint) to
64          Instrument::IsScriptSlotBypassed(size_t).
65        - Changed signature of method Instrument::SetScriptSlotBypassed(uint,bool)
66          to Instrument::SetScriptSlotBypassed(size_t,bool).
67        - Changed signature of method
68          Instrument::IsScriptPatchVariableSet(int,String) to
69          Instrument::IsScriptPatchVariableSet(size_t,String).
70        - Changed signature of method Instrument::GetScriptPatchVariables(int) to
71          Instrument::GetScriptPatchVariables(size_t).
72        - Changed signature of method
73          Instrument::GetScriptPatchVariable(int,String) to
74          Instrument::GetScriptPatchVariable(size_t,String).
75        - Changed signature of method
76          Instrument::SetScriptPatchVariable(int,String,String) to
77          Instrument::SetScriptPatchVariable(size_t,String,String).
78        - Changed signature of method
79          Instrument::UnsetScriptPatchVariable(int,String) to
80          Instrument::UnsetScriptPatchVariable(ssize_t,String).
81        - Fixed iterator invalidation (i.e. crash) caused by adding / removing
82          samples (only triggered if now deprecated File::GetFirstSample() /
83          File::GetNextSample() methods were still used).
84        - Fixed Sample::Write() method not having updated sample's CRC (correctly)
85          if sample was previously resized.
86        - Fixed iterator invalidation (i.e. crash) caused by adding / removing /
87          moving regions (only triggered if now deprecated File::GetFirstRegion() /
88          File::GetNextRegion() methods were still used).
89        - Fixed iterator invalidation (i.e. crash) caused by adding / removing
90          instruments (only triggered if now deprecated File::GetFirstInstrument() /
91          File::GetNextInstrument() methods were still used).
92    
93      * src/SF.cpp, src/SF.h:
94        - File::DeleteInstrument(): Fix clang sanatizer warning.
95    
96      * src/DLS.cpp, src/DLS.h:
97        - Use GetSubChunkAt() instead of GetFirstSubChunk() / GetNextSubChunk() in
98          entire DLS.cpp file.
99        - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in
100          entire DLS.cpp file.
101        - Added method Instrument::GetRegionAt().
102        - Marked methods Instrument::GetFirstRegion() and
103          Instrument::GetNextRegion() as deprecated.
104        - Use GetRegionAt() instead of GetFirstRegion() / GetNextRegion() in entire
105          DLS.cpp file.
106        - Added method File::GetSample().
107        - Marked methods File::GetFirstSample() and File::GetNextSample() as
108          deprecated.
109        - Use File::GetSample() instead of File::GetFirstSample() /
110          File::GetNextSample() in entire DLS.cpp file.
111        - Added method Articulator::GetArticulation().
112        - Marked methods Articulator::GetFirstArticulation() and
113          Articulator::GetNextArticulation() as deprecated.
114        - Added method File::GetInstrument().
115        - Marked methods File::GetFirstInstrument() and File::GetNextInstrument()
116          as deprecated.
117        - Added method Instrument::CountRegions().
118        - Fixed iterator invalidation (i.e. crash) caused by adding / removing
119          samples (only triggered if now deprecated File::GetFirstSample() /
120          File::GetNextSample() methods were still used).
121        - Fixed iterator invalidation (i.e. crash) caused by adding / removing /
122          moving regions (only triggered if now deprecated File::GetFirstRegion() /
123          File::GetNextRegion() methods were still used).
124        - Fixed iterator invalidation (i.e. crash) caused by adding / removing
125          instruments (only triggered if now deprecated File::GetFirstInstrument() /
126          File::GetNextInstrument() methods were still used).
127    
128      * src/RIFF.cpp, src/RIFF.h:
129        - Chunk::LoadChunkData(): Fix clang sanatizer warning.
130        - List::LoadSubChunks(): Fix potential garbage data access if reading a
131          RIFF chunk ID failed.
132        - Added methods File::IsIOPerThread() and File::SetIOPerThread(bool); the
133          latter allows to automatically use a separate file I/O stream state for
134          each thread.
135        - Added method List::GetSubChunkAt().
136        - Added method List::GetSubListAt().
137        - Marked methods List::GetFirstSubChunk(), List::GetNextSubChunk(),
138          List::GetFirstSubList() and List::GetNextSubList() as deprecated.
139        - Use GetSubListAt() instead of GetFirstSubList() / GetNextSubList() in
140          entire RIFF.cpp file.
141    
142    Version 4.3.0 (9 May 2021)
143    
144      * general changes:
145        - Require at least a C++11 compliant compiler.
146        - Require some UUID generating function by underlying system.
147    
148      * src/gig.cpp, src/gig.h:
149        - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1WaveForm,
150          DimensionRegion::LFO2WaveForm and DimensionRegion::LFO3WaveForm, which
151          allow to define override LFOs' wave form (e.g. saw or square instead of
152          the default wave form which was always sine in the original
153          Gigasampler/GigaStudio software).
154        - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1Phase,
155          DimensionRegion::LFO2Phase and DimensionRegion::LFO3Phase, which allow to
156          move the start point horizontally of the LFOs' waves (0° ... 360°).
157        - GIG FORMAT EXTENSION: Added attribute DimensionRegion::LFO3FlipPhase
158          (the original Gigasampler/GigaStudio software only had that flip phase
159          option for LFO1 and LFO2).
160        - Added methods DimensionRegion::UsesAnyGigFormatExtension(),
161          Region::UsesAnyGigFormatExtension(),
162          Instrument::UsesAnyGigFormatExtension() and
163          File::UsesAnyGigFormatExtension() (however only as private methods yet,
164          see comments on methods why).
165        - GIG FORMAT EXTENSION: added LinuxSampler specific filter type
166          implementations to enum vcf_type_t: vcf_type_lowpass_1p,
167          vcf_type_lowpass_2p, vcf_type_lowpass_4p, vcf_type_lowpass_6p,
168          vcf_type_highpass_1p, vcf_type_highpass_2p, vcf_type_highpass_4p,
169          vcf_type_highpass_6p, vcf_type_bandpass_2p, vcf_type_bandreject_2p.
170        - Compatibility fix: GigaStudio always expects 128 '3gnm' RIFF chunks
171          (patch by Ivan Maguidhir).
172        - Compatibility fix: GigaStudio 3 expects '3dnm' and '3ddp' RIFF chunks
173          (original patch by Ivan Maguidhir).
174        - Region::DeleteDimensionZone() and Region::SplitDimensionZone(): Fixed
175          dimensions being in different order after deleting a dimension zone.
176        - Script: Generate a persistent UUID for each script.
177        - GIG FORMAT EXTENSION: Added support for script 'patch' variables and
178          accordingly added new methods to Instrument class:
179          IsScriptPatchVariableSet(), GetScriptPatchVariables(),
180          GetScriptPatchVariable(), SetScriptPatchVariable(),
181          UnsetScriptPatchVariable(); stored persistently as new 'SCPV' RIFF chunk
182          as child of our '3LS ' list chunk on Instrument level.
183        - Fixed undefined behaviour when modifying script slots on an instrument
184          that had been cloned and not been saved yet (e.g. unintended modification
185          of original instrument's script slots, and crash on Instrument destruction
186          due to double free of pScriptRefs).
187    
188      * src/Serialization.cpp, src/Serialization.h:
189        - Fixed broken Archive(RawData) constructor which always threw an
190          Exception.
191        - Added built-in support for C++ String objects (a.k.a. std::string
192          from the STL) and bumped Srx format version to 1.1 for that reason.
193        - Fixed assertion fault on some systems if a member variable defined was
194          serialized which was declared as size_t or ssize_t data type.
195        - Added new method Archive::operation() which allows applications to
196          distinguish between serialization vs. deserialization in their
197          serialize() method implementations.
198        - Added built-in support for C++ Array<> objects (a.k.a. std::vector from
199          the STL).
200        - Member offsets are now signed and for (newly added support of) member
201          variables on the heap -1 is always used as offset instead.
202        - Added built-in support for C++ Set<> objects (a.k.a. std::set from the
203          STL).
204        - DataType: Added optional 2nd custom type name.
205        - Added built-in support for C++ Map<> objects (a.k.a. std::map from the
206          STL).
207    
208      * src/helper.h:
209        - Fix compile error with GCC 9 due to ignored result value of vasprintf()
210          function call.
211    
212      * src/tools/gigdump.cpp:
213        - Print dimension region properties LFO1WaveForm, LFO2WaveForm,
214          LFO3WaveForm, LFO1Phase, LFO2Phase, LFO3Phase, LFO1FlipPhase,
215          LFO2FlipPhase and LFO3FlipPhase.
216    
217    Version 4.2.0 (25 Jul 2019)
218    
219      * general changes:
220        - Added MSVC build support (anonymous patch from mailing list).
221        - Introduced CMake build support (yet constrained for building with MSVC)
222          (anonymous patch from mailing list).
223        - Fix: Don't automatically delete RIFF chunks from DLS/gig classes'
224          destructors. Added new virtual method DeleteChunks() to those classes
225          for this which must be explicitly called instead to remove their RIFF
226          chunks.
227        - Fix: Many methods of DLS/gig classes assumed a RIFF chunk read position
228          of zero; which is unsafe per se.
229        - Added C++11 "override" keyword where appropriate.
230        - Fixed crash in RIFF, DLS and gig classes which occurred on certain
231          of their actions when not passing a progress_t callback structure.
232    
233      * src/gig.cpp, src/gig.h:
234        - Fixed Doxygen API comments for enum types (currently latest Doxygen
235          [v1.8.13] only supports C comments in macro arguments expansion, but
236          not C++ comments; see <FindDefineArgs> lexer rules in src/pre.l of
237          the Doxygen source code, which currently also filter out new line
238          \n chars).
239        - Added new method File::CountSamples().
240        - Added new method File::CountInstruments().
241        - Fixed gig v4 files falsely being handled as v2 format
242          (patch by Ivan Maguidhir).
243        - Added gig v4 version identifier (File::VERSION_4).
244        - GIG FORMAT EXTENSION: Added attribute
245          DimensionRegion::SustainReleaseTrigger which allows to define whether
246          a sustain pedal up event shall cause a release trigger sample to be
247          played (default: don't play release trigger sample by sustain pedal).
248        - GIG FORMAT EXTENSION: Added attribute
249          DimensionRegion::NoNoteOffReleaseTrigger which allows to disable the
250          regular behaviour of playing release trigger sample on MIDI note-off
251          events.
252        - Introduced support for writing extension files (.gx01, .gx02, ...)
253          (original patch by Ivan Maguidhir).
254        - Many gig classes derive now from DLS::Storage (see DLS changes below).
255        - Added File::GetRiffFile() method.
256    
257      * src/DLS.cpp, src/DLS.h:
258        - File: Fixed implicitly allocated RIFF::File object never been freed.
259        - Added new abstract interface base class DLS::Storage which is derived by
260          the respective classes for implementing (the old) UpdateChunks() and the
261          new DeleteChunks() method.
262        - Added File::GetRiffFile() method.
263    
264      * src/sf2.cpp, src/sf2.h:
265        - Added Sample::GetFile() method.
266        - Added File::GetRiffFile() method.
267    
268      * src/Serialization.cpp, src/Serialization.h:
269        - Hide pure internal declarations from header file to avoid numerous
270          compiler warnings when building and linking against the public API.
271        - Fixed comparision logic bug
272        - Fixed memory leak in DataType::customTypeName().
273    
274      * src/RIFF.cpp, src/RIFF.h:
275        - Fix: Calling File::SetMode() left an undefined file handle on Windows and
276          caused a resource leak
277        - Avoid compiler warning when building for 32 bit windows.
278        - Added new method progress_t::subdivide().
279        - Fix: API doc comment for Chunk::GetFilePos() was completely wrong.
280        - progress_t: Added a 2nd (overridden) progress_t::subdivide() method which
281          allows a more fine graded control into which portions the subtasks are
282          divided to.
283    
284      * src/tools/gigdump.cpp:
285        - Added command line option --instrument-names which causes only
286          instrument names and their index numbers to be printed.
287    
288    Version 4.1.0 (25 Nov 2017)
289    * general changes:    * general changes:
290      - removed 2 GB limitation when loading a gig or DLS file      - removed 2 GB limitation when loading a gig or DLS file
291      - using now native integer size where appropriate      - using now native integer size where appropriate
292        - fixed minor issues with man pages (patch by Debian maintainer)
293        - fixed various spelling mistakes (patch by Debian maintainer)
294        - Added new "Serialization" framework (and equally named namespace)
295          which allows to serialize and deserialize native C++ objects
296          in a portable, easy and flexible way.
297        - print compiler warning if no RTTI available
298        - Fixed potential crash in command line tools gig2stereo, korg2gig,
299          korgdump and sf2extract.
300        - Fixed CVE-2017-12950, CVE-2017-12952, CVE-2017-12953
301          (original patch by Paul Brossier, slightly modified).
302        - Debian: Fixed packaging error about invalid substitution variable
303          "Source-Version".
304        - Raised Debian compatibility level to Debian 9 "Stretch".
305    
306    * src/gig.cpp, src/gig.h:    * src/gig.cpp, src/gig.h:
307      - fixed bug in Script::SetGroup: the script chunk wasn't moved      - fixed bug in Script::SetGroup: the script chunk wasn't moved
# Line 20  Version SVN trunk Line 320  Version SVN trunk
320      - Fix: samples' CRC checksums were misordered when a Sample was deleted.      - Fix: samples' CRC checksums were misordered when a Sample was deleted.
321      - Added new method Sample::GetWaveDataCRC32Checksum().      - Added new method Sample::GetWaveDataCRC32Checksum().
322      - Changed default value of EG2Release (filter release time) to 60s.      - Changed default value of EG2Release (filter release time) to 60s.
323        - Instruments' default pitch bend range is now +-2 semi tones.
324        - Fixed CRC checksums being wrong sometimes.
325        - Fix: method File::AddContentOf() did not clone script groups and scripts
326          of passed original file.
327        - Added support for serializing & deserializing DimensionRegion
328          objects (and crossfade_t and leverage_ctrl_t objects).
329        - Added enum reflection API functions for retrieving enum declaration type
330          information at runtime (enumCount(), enumKey(), enumKeys(), enumValue()).
331        - Exception class now has a variadic constructor which allows to add
332          textual format specifiers like with printf().
333        - On unknown leverage controller exception: show precise unknown leverage
334          controller number found.
335        - Ignore invalid leverage controller types and just show a warning on the
336          console instead of throwing an exception.
337        - Added new struct eg_opt_t and new class member variable
338          DimensionRegion::EG1Options and DimensionRegion::EG2Options as an
339          extension to the gig file format, which allows to override the default
340          behavior of the first two EGs' state machines.
341        - Fixed undefined behavior when loading a gig file with invalid
342          velocity curve parameters (fixes CVE-2017-12951).
343        - Fixed undefined behavior when loading a gig file with invalid wave
344          pool index number (fixes CVE-2017-12954).
345    
346    * src/DLS.cpp, src/DLS.h:    * src/DLS.cpp, src/DLS.h:
347      - 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
348        larger than 4 GB).        larger than 4 GB).
349              - Exception class now has a variadic constructor which allows to add
350          textual format specifiers like with printf().
351    
352    * src/RIFF.cpp, src/RIFF.h:    * src/RIFF.cpp, src/RIFF.h:
353      - 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
354        internal RIFF file offset size is automatically detected (that is RIFF        internal RIFF file offset size is automatically detected (that is RIFF
# Line 33  Version SVN trunk Line 357  Version SVN trunk
357        with a new option added to the RIFF File constructor though        with a new option added to the RIFF File constructor though
358      - when saving a modified, grown RIFF file, the temporary file size during      - when saving a modified, grown RIFF file, the temporary file size during
359        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
360        - Exception class now has a variadic constructor which allows to add
361          textual format specifiers like with printf().
362    
363      * src/Serialization.cpp, src/Serialization.h:
364        - Archive: Added method isModified().
365        - Archive: Added method setAutoValue().
366        - Archive: Added method setIntValue().
367        - Archive: Added method setRealValue().
368        - Archive: Added method setBoolValue().
369        - Archive: Added method setEnumValue().
370        - Archive: Added method valueAsString().
371        - Archive::rawData(): Automatically re-encode new raw data stream if
372          archive had been modified (i.e. by remove(), setAutoValue(), etc.).
373        - Object: Added method memberByUID().
374        - Object: remove() method is now protected.
375        - Archive: Added method removeMember().
376        - Archive: Added methods name() and setName().
377        - Archive: Added methods comment() and setComment().
378        - Archive: Added methods timeStampCreated(), timeStampModified(),
379          dateTimeCreated() and dateTimeModified().
380        - Archive: Added methods valueAsInt(), valueAsReal() and valueAsBool().
381        - DataType: Implemented demangling C++ type names (for methods
382          asLongDescr() and customTypeName(bool demangle=false)).
383        - Archive::setAutoValue(): Handle human readable boolean text
384          representations like "yes", "no", "true", "false" as expected.
385        - Exception class now has a variadic constructor which allows to add
386          textual format specifiers like with printf().
387        - DataType fix: Retain backward compatibility to older versions of native
388          C++ classes/structs.
389    
390      * src/Akai.cpp:
391        - Fixed compilation error with recent, more strict compilers.
392    
393    * src/tools/akaidump.cpp, src/tools/akaiextract.cpp:    * src/tools/akaidump.cpp, src/tools/akaiextract.cpp:
394      - improved output of non-ascii characters in usage messages      - improved output of non-ascii characters in usage messages
# Line 54  Version SVN trunk Line 410  Version SVN trunk
410        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
411        file's checksum table was damaged)        file's checksum table was damaged)
412      - print samples' CRC32 checksums      - print samples' CRC32 checksums
413        - Print the new EG behavior options (eg_opt_t).
414    
415    * src/tools/gigextract.cpp:    * src/tools/gigextract.cpp:
416      - Fix: if sample name contains a path separator (slash or backslash) then      - Fix: if sample name contains a path separator (slash or backslash) then
417        replace them by a minus sign to avoid file system issues.        replace them by a minus sign to avoid file system issues.
418    
419      * src/tools/gig2stereo.cpp:
420        - Also merge mono sample pairs with non matching loop information if
421          argument --incompatible was given.
422    
423    * packaging changes:    * packaging changes:
424      - Automake: set environment variable GCC_COLORS=auto to allow GCC to      - Automake: set environment variable GCC_COLORS=auto to allow GCC to
425        auto detect whether it (sh/c)ould output its messages in color.        auto detect whether it (sh/c)ould output its messages in color.
# Line 178  Version 4.0.0 (14 Jul 2015) Line 539  Version 4.0.0 (14 Jul 2015)
539      - POSIX: show operating system's error reason if opening a file failed      - POSIX: show operating system's error reason if opening a file failed
540      - Added support for custom progress notification while saving to RIFF file.      - Added support for custom progress notification while saving to RIFF file.
541      - Fixed embarrassing old bug: POSIX read() errors were never detected on      - Fixed embarrassing old bug: POSIX read() errors were never detected on
542        Chunk::Read() calls due to signment incompatible variable.        Chunk::Read() calls due to signment incompatible variable.
543      - Cleanup of an old DLL binary backward compatibility hack.      - Cleanup of an old DLL binary backward compatibility hack.
544    
545    * src/gigextract.cpp:    * src/gigextract.cpp:

Legend:
Removed from v.2990  
changed lines
  Added in v.4076

  ViewVC Help
Powered by ViewVC