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

Diff of /linuxsampler/trunk/ChangeLog

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

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

Legend:
Removed from v.3573  
changed lines
  Added in v.3971

  ViewVC Help
Powered by ViewVC