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

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

  ViewVC Help
Powered by ViewVC