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

Diff of /linuxsampler/trunk/ChangeLog

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

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

Legend:
Removed from v.3537  
changed lines
  Added in v.4002

  ViewVC Help
Powered by ViewVC