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

Diff of /libgig/trunk/ChangeLog

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

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

Legend:
Removed from v.2764  
changed lines
  Added in v.3957

  ViewVC Help
Powered by ViewVC