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

Diff of /libgig/trunk/ChangeLog

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

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

Legend:
Removed from v.2133  
changed lines
  Added in v.3773

  ViewVC Help
Powered by ViewVC