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

Diff of /libgig/trunk/ChangeLog

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

revision 2543 by schoenebeck, Sat May 10 02:06:58 2014 UTC revision 3902 by schoenebeck, Wed May 12 17:57:42 2021 UTC
# Line 1  Line 1 
1  Version CVS HEAD (?)  Version SVN trunk (?)
2    
3      * src/SF.cpp, src/SF.h:
4        - File::DeleteInstrument(): Fix clang sanatizer warning.
5    
6      * src/RIFF.cpp, src/RIFF.h:
7        - Chunk::LoadChunkData(): Fix clang sanatizer warning.
8        - List::LoadSubChunks(): Fix potential garbage data access if reading a
9          RIFF chunk ID failed.
10    
11    Version 4.3.0 (9 May 2021)
12    
13      * general changes:
14        - Require at least a C++11 compliant compiler.
15        - Require some UUID generating function by underlying system.
16    
17      * src/gig.cpp, src/gig.h:
18        - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1WaveForm,
19          DimensionRegion::LFO2WaveForm and DimensionRegion::LFO3WaveForm, which
20          allow to define override LFOs' wave form (e.g. saw or square instead of
21          the default wave form which was always sine in the original
22          Gigasampler/GigaStudio software).
23        - GIG FORMAT EXTENSION: Added attributes DimensionRegion::LFO1Phase,
24          DimensionRegion::LFO2Phase and DimensionRegion::LFO3Phase, which allow to
25          move the start point horizontally of the LFOs' waves (0° ... 360°).
26        - GIG FORMAT EXTENSION: Added attribute DimensionRegion::LFO3FlipPhase
27          (the original Gigasampler/GigaStudio software only had that flip phase
28          option for LFO1 and LFO2).
29        - Added methods DimensionRegion::UsesAnyGigFormatExtension(),
30          Region::UsesAnyGigFormatExtension(),
31          Instrument::UsesAnyGigFormatExtension() and
32          File::UsesAnyGigFormatExtension() (however only as private methods yet,
33          see comments on methods why).
34        - GIG FORMAT EXTENSION: added LinuxSampler specific filter type
35          implementations to enum vcf_type_t: vcf_type_lowpass_1p,
36          vcf_type_lowpass_2p, vcf_type_lowpass_4p, vcf_type_lowpass_6p,
37          vcf_type_highpass_1p, vcf_type_highpass_2p, vcf_type_highpass_4p,
38          vcf_type_highpass_6p, vcf_type_bandpass_2p, vcf_type_bandreject_2p.
39        - Compatibility fix: GigaStudio always expects 128 '3gnm' RIFF chunks
40          (patch by Ivan Maguidhir).
41        - Compatibility fix: GigaStudio 3 expects '3dnm' and '3ddp' RIFF chunks
42          (original patch by Ivan Maguidhir).
43        - Region::DeleteDimensionZone() and Region::SplitDimensionZone(): Fixed
44          dimensions being in different order after deleting a dimension zone.
45        - Script: Generate a persistent UUID for each script.
46        - GIG FORMAT EXTENSION: Added support for script 'patch' variables and
47          accordingly added new methods to Instrument class:
48          IsScriptPatchVariableSet(), GetScriptPatchVariables(),
49          GetScriptPatchVariable(), SetScriptPatchVariable(),
50          UnsetScriptPatchVariable(); stored persistently as new 'SCPV' RIFF chunk
51          as child of our '3LS ' list chunk on Instrument level.
52        - Fixed undefined behaviour when modifying script slots on an instrument
53          that had been cloned and not been saved yet (e.g. unintended modification
54          of original instrument's script slots, and crash on Instrument destruction
55          due to double free of pScriptRefs).
56    
57      * src/Serialization.cpp, src/Serialization.h:
58        - Fixed broken Archive(RawData) constructor which always threw an
59          Exception.
60        - Added built-in support for C++ String objects (a.k.a. std::string
61          from the STL) and bumped Srx format version to 1.1 for that reason.
62        - Fixed assertion fault on some systems if a member variable defined was
63          serialized which was declared as size_t or ssize_t data type.
64        - Added new method Archive::operation() which allows applications to
65          distinguish between serialization vs. deserialization in their
66          serialize() method implementations.
67        - Added built-in support for C++ Array<> objects (a.k.a. std::vector from
68          the STL).
69        - Member offsets are now signed and for (newly added support of) member
70          variables on the heap -1 is always used as offset instead.
71        - Added built-in support for C++ Set<> objects (a.k.a. std::set from the
72          STL).
73        - DataType: Added optional 2nd custom type name.
74        - Added built-in support for C++ Map<> objects (a.k.a. std::map from the
75          STL).
76    
77      * src/helper.h:
78        - Fix compile error with GCC 9 due to ignored result value of vasprintf()
79          function call.
80    
81      * src/tools/gigdump.cpp:
82        - Print dimension region properties LFO1WaveForm, LFO2WaveForm,
83          LFO3WaveForm, LFO1Phase, LFO2Phase, LFO3Phase, LFO1FlipPhase,
84          LFO2FlipPhase and LFO3FlipPhase.
85    
86    Version 4.2.0 (25 Jul 2019)
87    
88      * general changes:
89        - Added MSVC build support (anonymous patch from mailing list).
90        - Introduced CMake build support (yet constrained for building with MSVC)
91          (anonymous patch from mailing list).
92        - Fix: Don't automatically delete RIFF chunks from DLS/gig classes'
93          destructors. Added new virtual method DeleteChunks() to those classes
94          for this which must be explicitly called instead to remove their RIFF
95          chunks.
96        - Fix: Many methods of DLS/gig classes assumed a RIFF chunk read position
97          of zero; which is unsafe per se.
98        - Added C++11 "override" keyword where appropriate.
99        - Fixed crash in RIFF, DLS and gig classes which occurred on certain
100          of their actions when not passing a progress_t callback structure.
101    
102      * src/gig.cpp, src/gig.h:
103        - Fixed Doxygen API comments for enum types (currently latest Doxygen
104          [v1.8.13] only supports C comments in macro arguments expansion, but
105          not C++ comments; see <FindDefineArgs> lexer rules in src/pre.l of
106          the Doxygen source code, which currently also filter out new line
107          \n chars).
108        - Added new method File::CountSamples().
109        - Added new method File::CountInstruments().
110        - Fixed gig v4 files falsely being handled as v2 format
111          (patch by Ivan Maguidhir).
112        - Added gig v4 version identifier (File::VERSION_4).
113        - GIG FORMAT EXTENSION: Added attribute
114          DimensionRegion::SustainReleaseTrigger which allows to define whether
115          a sustain pedal up event shall cause a release trigger sample to be
116          played (default: don't play release trigger sample by sustain pedal).
117        - GIG FORMAT EXTENSION: Added attribute
118          DimensionRegion::NoNoteOffReleaseTrigger which allows to disable the
119          regular behaviour of playing release trigger sample on MIDI note-off
120          events.
121        - Introduced support for writing extension files (.gx01, .gx02, ...)
122          (original patch by Ivan Maguidhir).
123        - Many gig classes derive now from DLS::Storage (see DLS changes below).
124        - Added File::GetRiffFile() method.
125    
126      * src/DLS.cpp, src/DLS.h:
127        - File: Fixed implicitly allocated RIFF::File object never been freed.
128        - Added new abstract interface base class DLS::Storage which is derived by
129          the respective classes for implementing (the old) UpdateChunks() and the
130          new DeleteChunks() method.
131        - Added File::GetRiffFile() method.
132    
133      * src/sf2.cpp, src/sf2.h:
134        - Added Sample::GetFile() method.
135        - Added File::GetRiffFile() method.
136    
137      * src/Serialization.cpp, src/Serialization.h:
138        - Hide pure internal declarations from header file to avoid numerous
139          compiler warnings when building and linking against the public API.
140        - Fixed comparision logic bug
141        - Fixed memory leak in DataType::customTypeName().
142    
143      * src/RIFF.cpp, src/RIFF.h:
144        - Fix: Calling File::SetMode() left an undefined file handle on Windows and
145          caused a resource leak
146        - Avoid compiler warning when building for 32 bit windows.
147        - Added new method progress_t::subdivide().
148        - Fix: API doc comment for Chunk::GetFilePos() was completely wrong.
149        - progress_t: Added a 2nd (overridden) progress_t::subdivide() method which
150          allows a more fine graded control into which portions the subtasks are
151          divided to.
152    
153      * src/tools/gigdump.cpp:
154        - Added command line option --instrument-names which causes only
155          instrument names and their index numbers to be printed.
156    
157    Version 4.1.0 (25 Nov 2017)
158      * general changes:
159        - removed 2 GB limitation when loading a gig or DLS file
160        - using now native integer size where appropriate
161        - fixed minor issues with man pages (patch by Debian maintainer)
162        - fixed various spelling mistakes (patch by Debian maintainer)
163        - Added new "Serialization" framework (and equally named namespace)
164          which allows to serialize and deserialize native C++ objects
165          in a portable, easy and flexible way.
166        - print compiler warning if no RTTI available
167        - Fixed potential crash in command line tools gig2stereo, korg2gig,
168          korgdump and sf2extract.
169        - Fixed CVE-2017-12950, CVE-2017-12952, CVE-2017-12953
170          (original patch by Paul Brossier, slightly modified).
171        - Debian: Fixed packaging error about invalid substitution variable
172          "Source-Version".
173        - Raised Debian compatibility level to Debian 9 "Stretch".
174    
175      * src/gig.cpp, src/gig.h:
176        - fixed bug in Script::SetGroup: the script chunk wasn't moved
177        - fixed compilation error with clang 3.4
178        - GIG FORMAT EXTENSION: added support for saving gig file larger than 4 GB
179          as one single monolithic gig file. In case .gig file is >= 2GB expect a
180          large monolithic file, otherwise if .gig file is < 2 GB check for
181          "extension" files (.gx01, .gx02, ...) instead.
182        - fixed Region::UpdateUpdateVelocityTable() which did not work correctly
183          if there were dimensions after the velocity dimension: it only created
184          valid velocity tables for cases of dimensions lower than the velocity
185          dimension.
186        - added new method Sample::VerifyWaveData() which allows to check whether
187          a sample had been damaged for some reason
188        - Fix: samples' CRC checksums were damaged on file structure changes.
189        - Fix: samples' CRC checksums were misordered when a Sample was deleted.
190        - Added new method Sample::GetWaveDataCRC32Checksum().
191        - Changed default value of EG2Release (filter release time) to 60s.
192        - Instruments' default pitch bend range is now +-2 semi tones.
193        - Fixed CRC checksums being wrong sometimes.
194        - Fix: method File::AddContentOf() did not clone script groups and scripts
195          of passed original file.
196        - Added support for serializing & deserializing DimensionRegion
197          objects (and crossfade_t and leverage_ctrl_t objects).
198        - Added enum reflection API functions for retrieving enum declaration type
199          information at runtime (enumCount(), enumKey(), enumKeys(), enumValue()).
200        - Exception class now has a variadic constructor which allows to add
201          textual format specifiers like with printf().
202        - On unknown leverage controller exception: show precise unknown leverage
203          controller number found.
204        - Ignore invalid leverage controller types and just show a warning on the
205          console instead of throwing an exception.
206        - Added new struct eg_opt_t and new class member variable
207          DimensionRegion::EG1Options and DimensionRegion::EG2Options as an
208          extension to the gig file format, which allows to override the default
209          behavior of the first two EGs' state machines.
210        - Fixed undefined behavior when loading a gig file with invalid
211          velocity curve parameters (fixes CVE-2017-12951).
212        - Fixed undefined behavior when loading a gig file with invalid wave
213          pool index number (fixes CVE-2017-12954).
214    
215      * src/DLS.cpp, src/DLS.h:
216        - Sample: wave pool offsets are now 64 bits (to allow support for files
217          larger than 4 GB).
218        - Exception class now has a variadic constructor which allows to add
219          textual format specifiers like with printf().
220    
221      * src/RIFF.cpp, src/RIFF.h:
222        - added support for RIFF files larger than 4 GB, by default the required
223          internal RIFF file offset size is automatically detected (that is RIFF
224          files < 4 GB automatically use 32 bit offsets while files >= 4 GB
225          automatically use 64 bit offsets), a particular offset size can be forced
226          with a new option added to the RIFF File constructor though
227        - when saving a modified, grown RIFF file, the temporary file size during
228          Save() operation will no longer be larger than the final grown file size
229        - Exception class now has a variadic constructor which allows to add
230          textual format specifiers like with printf().
231    
232      * src/Serialization.cpp, src/Serialization.h:
233        - Archive: Added method isModified().
234        - Archive: Added method setAutoValue().
235        - Archive: Added method setIntValue().
236        - Archive: Added method setRealValue().
237        - Archive: Added method setBoolValue().
238        - Archive: Added method setEnumValue().
239        - Archive: Added method valueAsString().
240        - Archive::rawData(): Automatically re-encode new raw data stream if
241          archive had been modified (i.e. by remove(), setAutoValue(), etc.).
242        - Object: Added method memberByUID().
243        - Object: remove() method is now protected.
244        - Archive: Added method removeMember().
245        - Archive: Added methods name() and setName().
246        - Archive: Added methods comment() and setComment().
247        - Archive: Added methods timeStampCreated(), timeStampModified(),
248          dateTimeCreated() and dateTimeModified().
249        - Archive: Added methods valueAsInt(), valueAsReal() and valueAsBool().
250        - DataType: Implemented demangling C++ type names (for methods
251          asLongDescr() and customTypeName(bool demangle=false)).
252        - Archive::setAutoValue(): Handle human readable boolean text
253          representations like "yes", "no", "true", "false" as expected.
254        - Exception class now has a variadic constructor which allows to add
255          textual format specifiers like with printf().
256        - DataType fix: Retain backward compatibility to older versions of native
257          C++ classes/structs.
258    
259      * src/Akai.cpp:
260        - Fixed compilation error with recent, more strict compilers.
261    
262      * src/tools/akaidump.cpp, src/tools/akaiextract.cpp:
263        - improved output of non-ascii characters in usage messages
264        - fixed printf format strings
265    
266      * src/tools/korg2gig.cpp:
267        - fixed c++11 narrowing warnings
268        - fixed fine tuning which was not translated at all
269    
270      * src/tools/gigdump.cpp:
271        - additionally print VelocityUpperLimit and DimensionUpperLimits of all
272          dimension regions
273        - additionally print RIFF chunk file offset and RIFF chunk size of sample
274          data
275        - added and implemented new parameter "--verify" which allows to check
276          the raw wave form data integrity of all samples
277        - added and implemented new parameter "--rebuild-checksums" which allows
278          to recalculate the CRC32 checksum of all samples' raw wave data and
279          rebuilding the gig file's global checksum table (i.e. in case the
280          file's checksum table was damaged)
281        - print samples' CRC32 checksums
282        - Print the new EG behavior options (eg_opt_t).
283    
284      * src/tools/gigextract.cpp:
285        - Fix: if sample name contains a path separator (slash or backslash) then
286          replace them by a minus sign to avoid file system issues.
287    
288      * src/tools/gig2stereo.cpp:
289        - Also merge mono sample pairs with non matching loop information if
290          argument --incompatible was given.
291    
292      * packaging changes:
293        - Automake: set environment variable GCC_COLORS=auto to allow GCC to
294          auto detect whether it (sh/c)ould output its messages in color.
295    
296    Version 4.0.0 (14 Jul 2015)
297    * general changes:    * general changes:
298      - minor Makefile fix for parallel make      - minor Makefile fix for parallel make
299      - Mac OS X: link with CoreFoundation (for the UUID function)      - Mac OS X: link with CoreFoundation (for the UUID function)
# Line 11  Version CVS HEAD (?) Line 306  Version CVS HEAD (?)
306      - added man page for "sf2dump"      - added man page for "sf2dump"
307      - added new command line tool "korgdump" (and a man page for it)      - added new command line tool "korgdump" (and a man page for it)
308      - added new command line tool "korg2gig" (and a man page for it)      - added new command line tool "korg2gig" (and a man page for it)
309        - moved source files of command line tools to new subdir src/tools
310        - libgig.so and libakai.so files are now installed under
311          $(prefix)/lib/libgig/ by default.
312        - Header files are now installed under $(prefix)/include/libgig/ by default.
313        - Fixed various packaging issues regarding installation directories
314          (fixes #218).
315        - added new command line tool "gig2stereo" (and a man page for it)
316        - unit tests: fixed wrong return value when test suite app exits
317          (patch by Ryan Schmidt)
318        - added new command line tool "sf2extract" (and a man page for it)
319    
320    * SoundFont file format:    * SoundFont file format:
321      - initial implementation      - initial implementation
# Line 22  Version CVS HEAD (?) Line 327  Version CVS HEAD (?)
327      - initial support for sample based instruments in KORG's file format      - initial support for sample based instruments in KORG's file format
328        (.KMP and .KSF files)        (.KMP and .KSF files)
329    
330      * AKAI file format:
331        - Added Linux/POSIX ported version of libakai. Note that libakai is released
332          under LGPL terms while libgig is released under GPL terms. To handle this
333          license difference appropriately the AKAI support part is built as
334          separate DLL (.so file).
335        - Fixed Mac OSX support so that the Akai lib files and tools compile without
336          any exotic third party libraries.
337        - Fixed various compilation errors for Windows.
338        - POSIX fix: open() requires third (mode) argument if used with O_CREAT
339          (fixes #219).
340    
341    * src/gig.cpp:    * src/gig.cpp:
342      - bugfix: VCF velocity dynamic range and VCF velocity curve      - bugfix: VCF velocity dynamic range and VCF velocity curve
343        weren't saved correctly        weren't saved correctly
# Line 38  Version CVS HEAD (?) Line 354  Version CVS HEAD (?)
354        controller types (only works with LinuxSampler & gigedit, will not        controller types (only works with LinuxSampler & gigedit, will not
355        work with Gigasampler/GigaStudio)        work with Gigasampler/GigaStudio)
356      - added new method File::GetGroup(String name) for getting group by name      - added new method File::GetGroup(String name) for getting group by name
357        - added new method Region::GetDimensionDefinition(dimension_t type)
358        - bugfix: don't alter region pointer in DimensionRegion::CopyAssign()
359        - added some more sanity checks in Region::AddDimension()
360        - added new method Region::DeleteDimensionZone(dimension_t, int)
361        - added new method Region::SplitDimensionZone(dimension_t, int)
362        - Fixed crash caused by Region::GetDimensionRegionByValue() that happened
363          with certain velocity split sounds under certain conditions (added bound
364          constraints to prevent that)
365        - GIG FORMAT EXTENSION: added support for real-time instrument scripts.
366        - added new method Region::GetDimensionRegionIndexByValue()
367        - added new method Script::GetGroup()
368        - added new method Region::SetDimensionType()
369        - Added support for custom progress notification while saving to gig file.
370        - Bugfix: Adding a new region in between two existing regions caused the
371          new one being dropped after save operation and the gig file being tainted
372          (chunks at wrong location in the RIFF tree).
373        - Added new method Instrument::MoveTo() which allows to rearrange the order
374          of instruments within the same gig file.
375    
376    * src/DLS.cpp, src/DLS.h:    * src/DLS.cpp, src/DLS.h:
377      - added new method File::GetFileName()      - added new method File::GetFileName()
# Line 45  Version CVS HEAD (?) Line 379  Version CVS HEAD (?)
379      - added new method File::GetExtensionFile(int index)      - added new method File::GetExtensionFile(int index)
380      - added new method File::SetFileName() allowing to call File::Save()      - added new method File::SetFileName() allowing to call File::Save()
381        later on without passing a file name        later on without passing a file name
382        - added inline helper methods overlaps() for struct range_t
383        - Added support for custom progress notification while saving to DLS file.
384        - Bugfix: Adding a new region in between two existing regions caused the
385          new one being dropped after save operation and the gig file being tainted
386          (chunks at wrong location in the RIFF tree).
387    
388      * src/SF.cpp, src/SF.h:
389        - added new method Sample::ReadNoClear()
390    
391    * src/RIFF.cpp, src/RIFF.h:    * src/RIFF.cpp, src/RIFF.h:
392      - bugfix: avoid calling read() with count 0 when writing a file,      - bugfix: avoid calling read() with count 0 when writing a file,
# Line 59  Version CVS HEAD (?) Line 401  Version CVS HEAD (?)
401        than "real" RIFF files (used for KORG format support)        than "real" RIFF files (used for KORG format support)
402      - added new method Chunk::GetFile()      - added new method Chunk::GetFile()
403      - added new method Chunk::GetLayout()      - added new method Chunk::GetLayout()
404        - added 2nd, alternative method for List::MoveSubChunk(), the old 1st one
405          allows to move a subchunk within the current List, whereas the new 2nd
406          one allows to move the subchunk from the current list to another list
407        - POSIX: only assume -1 result value as error on open() calls
408        - POSIX: show operating system's error reason if opening a file failed
409        - Added support for custom progress notification while saving to RIFF file.
410        - Fixed embarrassing old bug: POSIX read() errors were never detected on
411          Chunk::Read() calls due to signment incompatible variable.
412        - Cleanup of an old DLL binary backward compatibility hack.
413    
414    * src/gigextract.cpp:    * src/gigextract.cpp:
415      - export sample loop, unity note and fine tune with libsndfile      - export sample loop, unity note and fine tune with libsndfile

Legend:
Removed from v.2543  
changed lines
  Added in v.3902

  ViewVC Help
Powered by ViewVC