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

Diff of /linuxsampler/trunk/ChangeLog

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

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

Legend:
Removed from v.3552  
changed lines
  Added in v.3987

  ViewVC Help
Powered by ViewVC