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

Diff of /libgig/trunk/ChangeLog

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

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