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

Diff of /libgig/trunk/ChangeLog

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

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

Legend:
Removed from v.2182  
changed lines
  Added in v.3929

  ViewVC Help
Powered by ViewVC