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

Diff of /linuxsampler/trunk/ChangeLog

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

revision 3548 by schoenebeck, Wed Jul 31 09:35:10 2019 UTC revision 3986 by schoenebeck, Wed Aug 4 18:04:12 2021 UTC
# Line 1  Line 1 
1  Version SVN trunk (?)  Version SVN trunk (?)
2    
3      * Real-time instrument scripts:
4        - Fix: Do not share compiled instrument scripts among multiple engine
5          channels (sampler parts) as this can lead to crashes and would allow the
6          same global script variables to be accessible from multiple engine
7          channels which would not be the expected behaviour by instrument script
8          authors.
9    
10      * GigaStudio/Gigasampler format engine:
11        - Use libgig's new IO-per-thread feature to avoid file I/O concurrency
12          issues with .gig file.
13        - Use libgig's new method gig::File::GetSample() with method
14          gig::File::CountSamples() instead of now deprecated
15          gig::File::GetFirstSample() / gig::File::GetNextSample() pair.
16        - Use libgig's new method gig::Instrument::GetRegionAt() with method
17          gig::Instrument:CountRegions() instead of now deprecated
18          gig::Instrument::GetFirstRegion() / gig::Instrument::GetNextRegion() pair.
19        - Use libgig's gig::File::GetInstrument() method with method
20          gig::File::CountInstruments() instead of now deprecated
21          gig::File::GetFirstInstrument() / gig::File::GetNextInstrument() pair.
22    
23      * MIDI driver:
24        - VirtualMidiDevice: added method Reset() which is e.g. intended to be used
25          in "panic" / MIDI "all sound off" / MIDI "all note off" situations.
26    
27    Version 2.2.0 (9 May 2021)
28    
29    * general changes:    * general changes:
30      - Fixed compiler error in Pool.h.      - Fixed compiler error in Pool.h.
31        - Require C++14 compiler support.
32        - Autoconf: Added m4/ax_cxx_compile_stdcxx.m4 macro which is used
33          for checking in configure for C++14 support (as mandatory
34          requirement) and automatically adds compiler argument if required
35          (e.g. -std=C++14).
36        - RTMath: Implemented floating point comparison methods
37          fEqual32(float,float) and fEqual64(double,double) which take the
38          expected floating point tolerances into account.
39        - Added public API C++ class "LFO", which is a cluster class encapsulating
40          all the sampler's LFO implementations to be used by 3rd party applications
41          (e.g. by Gigedit).
42        - Added int math square LFO implementation.
43        - Added int math saw LFO implementation.
44        - Added numeric complex nr sine LFO implementation.
45        - Marked class LFOTriangleDiHarmonic as deprecated
46          (will be removed in future).
47        - Added LFOAll.h which includes all LFO implementation's header files.
48        - Refactored LFO class names and their file names (PulseLFO -> LFOPulse,
49          LFOSawIntMath -> LFOSawIntMathNew, SawLFO -> LFOSawIntMathOld,
50          SineLFO -> LFOSineBuiltinFn, LFOSine -> LFOSineNumericComplexNr,
51          SquareLFO -> LFOSquarePulse and separated the latter to its own header
52          file).
53        - Renamed type LFOSigned -> LFOTriangleSigned.
54        - Renamed type LFOUnsigned -> LFOTriangleUnsigned.
55        - Using now cubic interpolation as resampling algorithm by default; and
56          linear interpolation is deprecated now.
57        - Event:Init(): memset() entire Event::Param union to zero instead of trying
58          to do that for its individual members; the latter became error prone due
59          to the union's growing complexity meanwhile.
60        - EngineChannel: Overhaul of RPN/NRPN related methods: Added new
61          *Rpn*Parameter*() methods as replacement for previous *Rpn*Controller*()
62          methods and marked the old ones as deprecated; and likewise added new
63          *Nrpn*Parameter*() methods as replacement for previous *Nrpn*Controller*()
64          methods and marked those old ones deprecated as well.
65        - Added support for MIDI CC #38 (data entry LSB): this allows higher value
66          resolution for certain (e.g. hard coded) RPN and NRPN parameters.
67        - Implemented support for compressed RPN/NRPN message sequences (that is to
68          allow processing MIDI data entry messages without always having to be
69          preceded strictly by RPN/NRPN parameter selection messages on each value
70          change).
71        - Added support for MIDI CC #96 (data increment) and MIDI CC #97 (data
72          decrement).
73        - Added support for 'null function RPN/NRPN' (which is RPN/NRPN parameter
74          MSB=127 and LSB=127) and which is disabling subsequent data
75          entry/increment/decrement CC messages.
76        - Fixed crash when editing key groups (a.k.a. exclusive groups) with an
77          instrument editor.
78        - Fixed playing noise at the end of a disk stream under certain conditions.
79        - Fixed potential crash with high pitch at end of RAM playback.
80        - Added configure checks whether C++ compiler supports so called
81          'designated initializers'.
82        - Added global backtraceAsString() function for debugging purposes
83          (POSIX systems only, no Windows implementation yet).
84        - Thread class: Added new methods pushCancelable(), popCancelable(), name(),
85          nameOfCaller() and setNameOfCaller().
86        - configure: Always check for availability of pthread_testcancel() and use
87          it if so (previously it was only used if explicitly enabled by configure
88          option).
89        - Thread class: raise compiler warning if pthread_testcancel() is not
90          available, because it can lead to deadlocks.
91        - Mutex class: Implemented optional bug detection and deadlock debugging
92          features.
93        - Ref<> class is now thread safe (as lock-free and wait-free
94          implementation).
95        - Fixed compilation error with Bison >= 3.6.0.
96        - Fixed rare crash when switching between instruments that had instrument
97          scripts loaded.
98        - Allow EffectChain::InsertEffect() as alternative to
99          EffectChain::AppendEffect() (i.e. with index equal to current chain size).
100        - ConstCapacityArray class: Fixed bug in remove() method.
101        - Fixed crash on certain MIDI RPN and NRPN messages that occurred if no
102          real-time instrument script was loaded.
103    
104      * Real-time instrument scripts:
105        - Added method ScriptVM::setExitResultEnabled() which allows to
106          explicitly enable the built-in exit() function to optionally accept
107          one function argument; the value of the passed exit() function
108          argument will then become available by calling
109          VMExecContext::exitResult() after script execution.
110        - 64 bit support for NKSP integer scripts variables (declare $foo).
111        - Variable names, function names and preprocessor condition names must start
112          with a regular character (a-z or A-Z); starting them with a digit or
113          underscore is not allowed.
114        - NKSP parser fix: equal comparison operator "=" and not equal comparison
115          operator "#" must only accept integer operands.
116        - NKSP language: Implemented support for standard units like Hertz, seconds,
117          Bel including support for metric unit prefixes; so one can now e.g.
118          conveniently use numbers in scripts like "5us" meaning "5 microseconds",
119          or e.g. "12kHz" meaning "12 kilo Hertz", or e.g. "-14mdB" meaning
120          "minus 14 Millidecibel", or e.g. "28c" meaning "28 cents" (for tuning).
121        - NKSP language: Introduced "final" operator "!" which is specifically
122          intended for synthesis parameter values to denote that the synthesis
123          parameter value is intended to be the "final" value for that synthesis
124          parameter that should explicitly be used by the engine and thus causing
125          the sampler engine to ignore all other modulation sources for the same
126          synthesis parameter (like e.g. LFO, EG); by simply prefixing a value,
127          variable or formula with this new "!" operator the expression is marked as
128          being "final".
129        - NKSP script editor API: Added support for detecting standard unit tokens
130          and their potential metric prefix token.
131        - NKSP language: Added support for NKSP real number literals and
132          arithmetic operations on them (e.g. "(3.9 + 2.9) / 12.3 - 42.0").
133        - NKSP language: Added support for NKSP real number (floating point) script
134          variables (declare ~foo).
135        - NKSP language: Added support for NKSP real number (floating point) array
136          script variables (declare ?foo[]).
137        - Built-in script function "message()" accepts now real number argument as
138          well.
139        - Added built-in script function "real_to_int()" and its short hand form
140          "int()" for casting from real number to integer in NKSP scripts.
141        - Added built-in script function "int_to_real()" and its short hand form
142          "real()" for casting from integer to real number in NKSP scripts.
143        - Allow built-in exit() function to potentially accept real number type
144          argument as well.
145        - Built-in script functions may have a different return type depending on
146          the arguments passed to the function.
147        - Built-in script function "abs()" optionally accepts and returns real
148          number.
149        - Built-in script functions "min()" and "max()" optionally accept real
150          number arguments and return real number as result in that case.
151        - NKSP VM API: Allow units and 'final'ness to be returned as result from
152          built-in functions (added methods VMFunction::returnUnitType() and
153          VMFunction::returnsFinal() for that purpose which must be implemented by
154          built-in function implementations).
155        - NKSP language: Allow metric unit prefixes of numeric scalar and array
156          variables to be changed freely at runtime (unlike unit types like Hz etc.
157          which are still sticky, parse-time features of variables which cannot be
158          changed at runtime for the intentional sake of determinism).
159        - NKSP language: 'final' values are prohibited for array variables for now
160          (attempt causes a parsers error).
161        - NKSP language: expressions with unit types (e.g. Hz) are prohibited for
162          conditions of runtime control structures like if(), while(), select()
163          (attempt causes a parser error).
164        - NKSP VM API: Allow built-in functions to perform their own, individual
165          parse time checks of arguments going to be passed to the function at
166          runtime (added method VMFunction::checkArgs() for that purpose).
167        - NKSP language: raise parser warning if only one operand of binary
168          operators (like logical 'or' comparison) contain a 'final' value (because
169          it would always yield in a 'final' result in such cases).
170        - NKSP language: Allow comparison (=, #, <, >, <=, >=) of values with
171          different metric unit prefixes, which will behave as expected (e.g.
172          result of expression '1000us < 2ms' is true).
173        - NKSP language: Allow adding values with different metric unit prefixes
174          (e.g. result of expression '100Hz + 5kHz' is '5100Hz').
175        - NKSP language: Allow subtracting values with different metric unit
176          prefixes (e.g. result of expression '1ms - 20us' is '980us').
177        - NKSP language: Allow multiplying with any metric unit prefixes
178          (e.g. result of expression '2k * 3ms' is '6s'), however multiplications
179          with unit types on both sides (e.g. '2s * 2s') is still prohibited since
180          we don't have any considerable practical use for a term like '4s^2'
181          (hence any attempt multiplying two unit types still causes parser error).
182        - NKSP language: Allow dividing by any metric unit prefixes and allow
183          division of same unit type on both sides (e.g. expression '8kHz / 1000Hz'
184          yields in unit free result '8'). So this is now a way to cast units away
185          e.g. for passing the result to other expressions, certain function calls
186          or variables which are not accepting any units (or that specific unit).
187        - NKSP language: integer arrays and real number arrays can now be converted
188          to strings (e.g. for dumping their content with message() calls for
189          script debugging purposes).
190        - NKSP language: expressions and variables with units are now correctly
191          casted to strings (e.g. with message() calls).
192        - NKSP language: comparing real numbers for equalness (e.g. '~foo = 3.1') or
193          unequalness (e.g. '~foo # 3.1') is now less strict and takes the expected
194          floating point tolerances into account.
195        - NKSP VM API: Added methods VMScalarNumberExpr::evalCastInt() and
196          VMScalarNumberExpr::evalCastReal().
197        - NKSP VM API: Added base class 'VMNumberArrayExpr' for classes
198          'VMIntArrayExpr' and 'VMRealArrayExpr'.
199        - NKSP VM API: replaced all unitPrefix() (parse time) methods by
200          unitFactor() (runtime) methods.
201        - Built-in function "exit()" supports now returning units and 'final'ness
202          for test cases.
203        - The following built-in functions support now units as well: "abs()",
204          "random()", "inc()", "dec()", "in_range()", "min()", "max()",
205          "real_to_int()", "int()", "int_to_real()" and "real()".
206        - Built-in functions "array_equal()", "search()" and "sort()" support now
207          real number arrays (correctly) as well.
208        - Added individual parse time checks of arguments to be passed to built-in
209          functions "random()", "inc()", "dec()", "in_range()", "min()", "max()",
210          "array_equal()" and "search()" specific for their individual purposes.
211        - NKSP VM refactoring: Renamed all methods, functions and classes matching
212          pattern *ScalarNumber* to simply *Number* (that is i.e. classes
213          VMScalarNumberExpr -> VMNumberExpr, ScalarNumberExpr -> NumberExpr,
214          ScalarNumberVariable -> NumberVariable, ScalarNumberBinaryOp ->
215          NumberBinaryOp, VMScalarNumberResultFunction -> VMNumberResultFunction,
216          method VMExpr::asScalarNumberExpr() -> VMExpr::asNumber(), function
217          isScalarNumber() -> isNumber()).
218        - NKSP VM API: Added 4 overridden methods to class VMNumberExpr:
219          evalCastInt(MetricPrefix_t), evalCastInt(MetricPrefix_t,MetricPrefix_t),
220          evalCastReal(MetricPrefix_t), evalCastReal(MetricPrefix_t,MetricPrefix_t)
221          as convenient methods for automatically converting values to expected
222          metric value basis.
223        - Built-in function "wait()" accepts now both integers and real numbers as
224          argument.
225        - NKSP VM API cleanup: Get rid of legacy method
226          VMFunction::argType(vmint iArg) which was already superseded by its new
227          replacement VMFunction::acceptsArgType(vmint iArg, ExprType_t type).
228        - NKSP parser: if wrong argument type was passed to a built-in function and
229          that built-in function accepts more than one data type for the argument,
230          then show all supported data types as parser error message.
231        - Built-in function "play_note()" accepts now real numbers and seconds as
232          unit type as well for its 3rd and 4th function arguments.
233        - The following built-in functions accept now real numbers as well for their
234          2nd function argument: "change_vol()", "change_tune()", "change_cutoff()",
235          "change_attack()", "change_decay()", "change_release()",
236          "change_sustain()", "change_cutoff_attack()", "change_cutoff_decay()",
237          "change_cutoff_sustain()", "change_cutoff_release()",
238          "change_amp_lfo_freq()", "change_cutoff_lfo_freq()",
239          "change_pitch_lfo_freq()", "change_vol_time()", "change_tune_time()",
240          "change_pan_time()", "fade_in()", "fade_out()", "change_play_pos()".
241        - Fixed built-in function "change_play_pos()" not having accepted metric
242          prefixes at all.
243        - Fixed the following built-in functions having misinterpreted values given
244          with unit type (for their 2nd argument) as if they were relative values
245          (that is as if they were passed without a unit type): "change_attack()",
246          "change_decay()", "change_release()", "change_cutoff_attack()",
247          "change_cutoff_decay()", "change_cutoff_release()".
248        - Fixed the following built-in functions having applied completely wrong
249          'final' values: "change_sustain()", "change_cutoff_sustain()" (since the
250          respective EGs being their modulation sink assume uint data type with
251          value range 0..1000 instead of 0.0..1.0.
252        - Added individual parse-time checks of function arguments for the following
253          built-in functions: "play_note()", "note_off()", "set_event_mark()",
254          "delete_event_mark()", "by_marks()", "change_cutoff()", "change_attack()",
255          "change_decay()", "change_release()", "change_cutoff_attack()",
256          "change_cutoff_decay()", "change_cutoff_release()",
257          "change_amp_lfo_freq()", "change_cutoff_lfo_freq()",
258          "change_pitch_lfo_freq()", "change_vol_time()", "change_tune_time()" and
259          "change_pan_time()".
260        - Don't abort function call if unit type was used and at the same time
261          'final' operator was omitted for the primary value argument of the
262          following built-in functions: "change_cutoff()", "change_attack()",
263          "change_decay()", "change_release()", "change_cutoff_attack()",
264          "change_cutoff_decay()", "change_cutoff_release()",
265          "change_amp_lfo_freq()", "change_cutoff_lfo_freq()",
266          "change_pitch_lfo_freq()", "change_vol_time()", "change_tune_time()",
267          "change_pan_time()", instead imply 'final'ness at runtime and raise an
268          appropriate parser warning at parse time.
269        - Added built-in real number functions "round()", "ceil()", "floor()",
270          "sqrt()", "log()", "log2()", "log10()", "exp()", "pow()", "sin()",
271          "cos()", "tan()", "asin()", "acos()", "atan()".
272        - Added built-in script real number constant "~NI_MATH_PI".
273        - Added built-in script real number constant "~NI_MATH_E".
274        - NKSP language: Allow unary '+' operator.
275        - Added built-in script functions "msb()" and "lsb()".
276        - NKSP language: Added support for RPN event handler
277          ("on rpn ... end on" in instrument scripts).
278        - NKSP language: Added support for NRPN event handler
279          ("on nrpn ... end on" in instrument scripts).
280        - Added built-in read-only variables "$RPN_ADDRESS" and "$RPN_VALUE" which
281          may be read from the new RPN/NRPN script handlers to get the (N)RPN
282          parameter that had been changed and its new value.
283        - Added built-in const variables "$NI_CB_TYPE_RPN" and "$NI_CB_TYPE_NRPN"
284          which are identifying the new (N)RPN handlers as such at script runtime.
285        - Implemented built-in script function "set_rpn()".
286        - Implemented built-in script function "set_nrpn()".
287        - Fix: built-in functions returning an array type were broken and caused a
288          crash when the built-in function's (supposed to be array) result value was
289          used by the script VM.
290        - Removed upper value constraint for 2nd argument of built-in functions
291          "change_amp_lfo_freq()", "change_cutoff_lfo_freq()",
292          "change_pitch_lfo_freq()","change_reso()", "change_cutoff()",
293          "change_amp_lfo_depth()", "change_cutoff_lfo_depth()" and
294          "change_pitch_lfo_depth()", to allow e.g. passing value 2000000 to double
295          the LFO frequency / resonance / cutoff frequency.
296        - Reduced code involved for parsing NKSP variable declarations by using 2
297          generalized grammar rules with optional components (i.e. optional value
298          assignment and optional variable qualifiers) instead of previous linear
299          combinations of grammar rules, which also fixes some edge case.
300        - NKSP language parser: track code block locations also by a) raw byte
301          position in NKSP source code string and b) length of that code block in
302          bytes (along to the already existing code block tracking by line/column);
303          and added appropriate new members to public C++ API classes like
304          'firstByte' and 'lengthBytes' to class VMSourceToken and struct CodeBlock.
305        - NKSP language: Added support for 'patch' variable qualifier (capture their
306          locations and allow replacement of their assignment expression via VM C++
307          API).
308        - Fixed incorrect EG times if standard measuring unit was passed to built-in
309          functions "change_attack()", "change_decay()" or "change_release()".
310        - Fixed intermediate function result values never having reflected any
311          standard measuring unit type.
312        - Fixed re-entrant issue with function calls which caused wrong result
313          values if the same function was called multiple times in a term
314          (specifically if metric prefixes were used).
315        - NKSP language: Just throw a warning, not an error if an array variable of
316          size zero was declared.
317        - NKSP language: Allow omitting explicit array size on array variable
318          declaration if combined with immediate value assignment
319          (e.g. declare %foo[] := ( 1, 2, 3 ) ).
320        - NKSP language: emit warning if an array variable was declared with bigger
321          array size than amount of initial values been assigned, and initialize the
322          missing array elements with zero in this case.
323        - Fixed built-in NKSP exit() function to behave as return statement.
324        - NKSP parser: Fixed crash if unary '-' operator was used on a non-number
325          data type.
326        - NKSP VM: Fixed the "release" handler being executed too often under
327          certain situations if polyphonic data was passed from "note" handler to
328          "release" handler.
329        - Fixed memory leak in NKSP parser: string tokens were allocated as C
330          strings and never freed.
331        - Fixed incorrect polyphonic data transfer from wrong note handler to
332          release handler; which also fixes no release handler being executed
333          sometimes, and due to the latter it also fixes potential crashes as some
334          polyphonic script events were never released and the engine hence was
335          running out of free script events.
336        - Fixed crash when handling array results of built-in functions
337          (e.g. "num_elements(by_marks($MARK_1)").
338        - NKSP VM: Fixed dead note events not been removed from user's event groups
339          (i.e. causing incorrect behaviour of built-in NKSP functions by_marks()
340          and set_event_mark() after max. size of event group list was exhausted).
341    
342      * test cases:
343      - Fixed compiler errors in test cases.      - Fixed compiler errors in test cases.
344      - Updated README for how to compile & run test cases.      - Updated README for how to compile & run test cases.
345      - Updated test case      - Updated test case
346        MutexTest::testDoubleLockStillBlocksConcurrentThread() to latest        MutexTest::testDoubleLockStillBlocksConcurrentThread() to latest
347        expected behaviour of the Mutex class implementation (recursive        expected behaviour of the Mutex class implementation (recursive
348        mutex type).        mutex type).
349        - Added test cases for NKSP core language aspects and core built-in
350          functions.
351        - Fixed thread tests segfaulting on Linux.
352        - NKSP: Added real number test cases for built-in functions exit(),
353          int_to_real(), real(), real_to_int() and int(), as well as for the
354          plus, minus and negate language operators.
355        - Added massive amount of NKSP test cases for standard measuring units and
356          'final' operator usage cases.
357        - Added NKSP test cases for (floating point tolerance aware) real number
358          equalness / unequalness comparison.
359        - Added NKSP int array and real array tests for value assignment and
360          initialization of arrays.
361        - Added NKSP test cases for built-in functions "round()", "ceil()",
362          "floor()", "sqrt()", "log()", "log2()", "log10()", "exp()", "pow()",
363          "sin()", "cos()", "tan()", "asin()", "acos()", "atan()".
364        - Added NKSP test cases for unary '+' operator.
365        - Added NKSP test cases for core built-in variables.
366        - Added thorough NKSP test cases for variable declarations.
367    
368      * GigaStudio/Gigasampler format engine:
369        - LFOTriangleIntMath and LFOTriangleIntAbsMath: Fixed FlipPhase=true
370          behaviour for start_level_mid.
371        - Changed LFO start levels: LFO1 and LFO2 both to mid, LFO3 to max. start
372          level (see discussion "GigaStudio LFO compatibility" on mailing list
373          from 2019-09-26 for details).
374        - Changed default wave form for all 3 LFOs to sine (instead of triangle;
375          see discussion "GigaStudio LFO compatibility" on mailing list from
376          2019-09-26 for details).
377        - Format extension: Added support for different LFO wave forms (currently
378          either sine [default], triangle, saw or square).
379        - Format extension: Added support for LFO phase displacement (0°..360°).
380        - Format extension: Added support for flipping LFO polarity on LFO 3
381          (in the original gig format this was only available for LFO 1 and LFO 2).
382        - Format extension: Support for additional filter types:
383          lowpass 1/2/4/6-pole, highpass 1/2/4/6-pole, bandpass 2-pole,
384          bandreject 2-pole.
385        - Fixd potential crash with polynomial interpolator and max. pitch.
386        - If minimum cutoff is defined, remap cutoff controller CC values to really
387          span the entire possible cutoff range (and avoiding a dead controller
388          zone).
389        - Implemented support for loading instrument scripts with 'patch' variables
390          (by patching these script variables with potentially overridden ones by
391          gig Instrument).
392    
393      * SFZ format engine:
394        - Fixed support for regions with loccN/hiccN conditions on more than one
395          MIDI controller.
396        - Fixed internal opcode 'xfin_hivel' falsely being set by user opcode
397          'xfin_lovel' (patch by Christian Czezatke).
398    
399      * Benchmarks:
400        - Fixed benchmarks/triang.cpp falsely having favoured "int math abs"
401          algorithm (since result of 2nd run was not accumulated).
402        - Added benchmark for saw wave (benchmarks/saw.cpp).
403        - Added benchmark for sine wave (benchmarks/sine.cpp).
404        - Added benchmark for square wave (benchmarks/square.cpp).
405        - Increased amount of benchmarks runs by factor 6 to achieve benchmark times
406          which are large enough on modern systems.
407    
408  Version 2.1.1 (27 Jul 2019)  Version 2.1.1 (27 Jul 2019)
409    

Legend:
Removed from v.3548  
changed lines
  Added in v.3986

  ViewVC Help
Powered by ViewVC