update doc and TODO

This commit is contained in:
Stefano D'Angelo 2023-08-11 10:25:41 +02:00
parent 7616c590a0
commit 41f56ec91c
2 changed files with 3 additions and 7 deletions

4
TODO
View File

@ -14,10 +14,8 @@ code:
* should clip slope in triangle? * should clip slope in triangle?
* common smoothing policy (as control rate as possible?) - smoothing control? * common smoothing policy (as control rate as possible?) - smoothing control?
* svf bandpass out polarity too confusing (inverted in mm2)? * svf bandpass out polarity too confusing (inverted in mm2)?
* better common config.h (less stuff maybe, or more stuff - decide)
* pan process with no out: should just reset coeffs? * pan process with no out: should just reset coeffs?
* get_y_z1, common strategy? * get_y_z1, common strategy?
* sqrt(0) and corner cases, common strategy?
* bw_satur gain compensation to divide by actual gain (derivative) rather than gain parameter? * bw_satur gain compensation to divide by actual gain (derivative) rather than gain parameter?
* cite papers, thank authors * cite papers, thank authors
* add initial state (x0) to reset state of lp1, ap1, mm1, hs1, ls1, others? all? * add initial state (x0) to reset state of lp1, ap1, mm1, hs1, ls1, others? all?
@ -25,7 +23,6 @@ code:
* bw_comb: integer target delay values? * bw_comb: integer target delay values?
* bw_svf/lp1 automatically limited (max) prewarp frequency to avoid instability? * bw_svf/lp1 automatically limited (max) prewarp frequency to avoid instability?
* prewarp control in all derived filtering modules * prewarp control in all derived filtering modules
* bw_math: review types
* src inside distortions? w/ control from outside? * src inside distortions? w/ control from outside?
* bw_fuzz gain compensation? * bw_fuzz gain compensation?
* make gain of distortions homogeneous? * make gain of distortions homogeneous?
@ -78,6 +75,7 @@ code:
* dump data structures (see note queue) and indicate error precisely * dump data structures (see note queue) and indicate error precisely
* process (multi) no update * process (multi) no update
* examples cpu usage * examples cpu usage
* bw_math: review types in implementation
build system: build system:
* make makefiles handle paths with spaces etc * make makefiles handle paths with spaces etc

View File

@ -197,16 +197,12 @@ static inline float bw_minf(float a, float b);
/*! <<<``` /*! <<<```
* Returns the minimum of `a` and `b`. * Returns the minimum of `a` and `b`.
* *
* `a` and `b` must be finite.
*
* #### bw_maxf() * #### bw_maxf()
* ```>>> */ * ```>>> */
static inline float bw_maxf(float a, float b); static inline float bw_maxf(float a, float b);
/*! <<<``` /*! <<<```
* Returns the maximum of `a` and `b`. * Returns the maximum of `a` and `b`.
* *
* `a` and `b` must be finite.
*
* #### bw_clipf() * #### bw_clipf()
* ```>>> */ * ```>>> */
static inline float bw_clipf(float x, float m, float M); static inline float bw_clipf(float x, float m, float M);
@ -261,6 +257,8 @@ static inline void bw_intfracf(float x, float *i, float *f);
* Puts the integer part (floor) of `x` in `i` and the fractional part in * Puts the integer part (floor) of `x` in `i` and the fractional part in
* `f`. * `f`.
* *
* `x` must be finite.
*
* #### bw_rcpf() * #### bw_rcpf()
* ```>>> */ * ```>>> */
static inline float bw_rcpf(float x); static inline float bw_rcpf(float x);