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

Diff of /libgig/trunk/ChangeLog

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

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

Legend:
Removed from v.1182  
changed lines
  Added in v.3524

  ViewVC Help
Powered by ViewVC