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

Diff of /libgig/trunk/ChangeLog

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

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

Legend:
Removed from v.1953  
changed lines
  Added in v.3939

  ViewVC Help
Powered by ViewVC