brickworks/TODO

1.0.0
-----

* clearly specify that state is tied to a particular set of coeffs (1:N)
* state that sample rate is finite and > 0
* state that audio cannot be inf (also in reset)
* state that you need different output buffers to reset
* state that mem_set() can/must be called on uninitialized state (before reset_state)

build system:
* single header generation (vs modules in bwp... to think about)?

post 1.0.0
----------

code:
* get() parameters?
* blep etc in a module?
* optimize triangle generation for constant pulse width
* compute bit depth reduction only when input changes? (state, option?)
* avoid "force" in coeffs update by using inline functions?
* csch for bw_peak bandwidth -> Q, inv sqrt ls2 hs2
* separate tests and examples?
* define common midi CCs for examples
* MEM_REQ_ROUGH() macro?
* web examples: need to export memset?
* check unused param warning visual studio
* float -> double, etc. ?
* bw_buf_copy (to be used in bw_slew_lim)?
* src post filt?
* web examples construction/destruction
* web effect mono->stereo and stereo->mono inputs? or display "input needs to be n channels"?
* fix vst3 mapped values (visible in Ableton Live) and short names
* polish examples (ranges, etc.)
* dump data structures (see note queue) and indicate error precisely
* process (multi) no update
* examples cpu usage
* bw_math: review types in implementation
* way to detect extern "C"? perhaps hidden "trap" preprocessor definition?
* any chance to avoid casts in C for const X * const * input arguments?
* heavy debug (e.g. also stripping restrict) vs light debug vs release vs optimized makefile rules
* smaller optimized modules (e.g., simple one pole)
* one pole, slew lim, maybe others: process const input? (return also if const out)
* pan process with no out: should just reset coeffs?
* float in [0,1] or [-1,1] for velocity, pitch bend, mod wheel in examples
* bw_satur gain compensation, divide by actual gain (derivative) mode? what about around flat line? bw_clip?
* gain compensation in distortions?
* sr-dependent vs cr-dependent coeffs? see synth poly example and pan case
* modulation vs process (multi) no update (post 1.0.0)???
* reset_state_multi allow NULL input?
* process allow NULL output?
* #if __cplusplus >= 201103L ? - see https://stackoverflow.com/questions/5047971/how-do-i-check-for-c11-support
* get current compression level, knee
* src inside distortions? w/ control from outside?
* make all outs nullable?
* make all reset state outs nullable (svf, phase_gen, ...)?
* ring mod fx module?
* bitcrusher module?
* return output std::array rather than have it as input argument?
* common smoothing policy (as control rate as possible?) - smoothing control?
* max_delay -> set sample rate? see reverb
* mem req -> return value of set sample rate? or sample rate argument of mem req?
* c++ get coeffs/state? or public? src nIn/OutSamples case (array vs single value pre 1.0.0), delay read/write, process1? process single?
* bw_comb: should also modulate feedback?
* bw_comb: integer target delay values?
* are we sure about inlining everything?
* reset style is not enough when you have feedbacks... (see reverb)
* IMPLEMENTATION/DECL/DEF prepocessor defs, maybe if DECL/DEF is defined then IMPLEMENTATION is needed to get implementation, etc.
* actually assert no buffer overlap

build system:
* make makefiles handle paths with spaces etc
* can run su on windows? (system-wide install)
* make autodependencies (.d?) - https://make.mad-scientist.net/papers/advanced-auto-dependency-generation/
* make from... directories
* recursive make?
* make hashdeps (https://github.com/olipratt/hashdeps)?
* VC, XCode, etc project files?
* single header(s)
* cross compile (rpi etc.)
* better use of xcodegen (see xcode warnings) and/or consider tuist (https://tuist.io/), bazel (https://bazel.build/), pants (https://www.pantsbuild.org/), buck (https://buck2.build/), please (https://please.build/index.html) for mobile apps
* homogenize android and ios common code (e.g., same index)
update TODO 2023-07-11 14:33:43 +00:00			`1.0.0`
			`-----`

const arg for bw_note_queue_is_valid() + bw_one_pole_process{_multi} use BW_SIZE_T + beginning of debugging code in bw_one_pole 2023-07-25 13:03:29 +00:00			`* clearly specify that state is tied to a particular set of coeffs (1:N)`
finalize bw_one_pole + adjust example Makefiles + fix stupid bug in bw_dist 2023-08-29 08:49:08 +00:00			`* state that sample rate is finite and > 0`
fix, finalize bw_svf + examples + more restrict + better debug 2023-09-03 18:22:52 +00:00			`* state that audio cannot be inf (also in reset)`
			`* state that you need different output buffers to reset`
finalized bw_comb + examples + better debug in bw_delay 2023-09-22 12:52:45 +00:00			`* state that mem_set() can/must be called on uninitialized state (before reset_state)`
multichannel api for bw(pp)_{noise_gen,osc_filt,osc_saw,osc_sin,pink_filt,sr_reduce} 2023-07-04 07:34:37 +00:00
			`build system:`
finalized bw_reverb + examples + fix bw_dry_wet + cosmetics 2023-09-22 16:34:16 +00:00			`* single header generation (vs modules in bwp... to think about)?`
multichannel api for bw(pp)_{noise_gen,osc_filt,osc_saw,osc_sin,pink_filt,sr_reduce} 2023-07-04 07:34:37 +00:00
			`post 1.0.0`
			`----------`

			`code:`
finalize all 1st order filter modules and examples + bw_*_reset_state_multi() and init values + bw_gain get gain improv + use bw_gain_process1() in bw_dry_wet 2023-09-01 17:43:50 +00:00			`* get() parameters?`
multichannel api for bw(pp)_{noise_gen,osc_filt,osc_saw,osc_sin,pink_filt,sr_reduce} 2023-07-04 07:34:37 +00:00			`* blep etc in a module?`
			`* optimize triangle generation for constant pulse width`
			`* compute bit depth reduction only when input changes? (state, option?)`
			`* avoid "force" in coeffs update by using inline functions?`
			`* csch for bw_peak bandwidth -> Q, inv sqrt ls2 hs2`
			`* separate tests and examples?`
			`* define common midi CCs for examples`
			`* MEM_REQ_ROUGH() macro?`
			`* web examples: need to export memset?`
			`* check unused param warning visual studio`
			`* float -> double, etc. ?`
			`* bw_buf_copy (to be used in bw_slew_lim)?`
			`* src post filt?`
update TODO 2023-07-11 14:33:43 +00:00			`* web examples construction/destruction`
			`* web effect mono->stereo and stereo->mono inputs? or display "input needs to be n channels"?`
			`* fix vst3 mapped values (visible in Ableton Live) and short names`
			`* polish examples (ranges, etc.)`
use NDEBUG in examples + fix velocity in synth(pp)_poly + really remove bw_omega* + fix bw_math + fix high cutoff in bw_one_pole + debugging in bw_{note_queue,rand,voice_alloc} 2023-07-25 06:52:01 +00:00			`* dump data structures (see note queue) and indicate error precisely`
android support done + fixes bw_{note_queue,voice_alloc} 2023-07-30 07:48:56 +00:00			`* process (multi) no update`
			`* examples cpu usage`
update doc and TODO 2023-08-11 08:25:41 +00:00			`* bw_math: review types in implementation`
renamed bw_{drywet,ringmod} -> bw_{dry_wet,ring_mod} 2023-08-14 04:05:21 +00:00			`* way to detect extern "C"? perhaps hidden "trap" preprocessor definition?`
			`* any chance to avoid casts in C for const X * const * input arguments?`
restrict qualified everything 2023-08-14 07:57:06 +00:00			`* heavy debug (e.g. also stripping restrict) vs light debug vs release vs optimized makefile rules`
			`* smaller optimized modules (e.g., simple one pole)`
renamed bw_env_gen_update_state_ctrl as bw_env_gen_process_ctrl 2023-08-14 10:22:56 +00:00			`* one pole, slew lim, maybe others: process const input? (return also if const out)`
cite scientific articles 2023-08-14 13:05:30 +00:00			`* pan process with no out: should just reset coeffs?`
			`* float in [0,1] or [-1,1] for velocity, pitch bend, mod wheel in examples`
changed default gain compensation value in bw_{clip,satur} 2023-08-15 04:48:19 +00:00			`* bw_satur gain compensation, divide by actual gain (derivative) mode? what about around flat line? bw_clip?`
			`* gain compensation in distortions?`
wip on many modules, all is broken, all is good 2023-08-20 13:49:04 +00:00			`* sr-dependent vs cr-dependent coeffs? see synth poly example and pan case`
			`* modulation vs process (multi) no update (post 1.0.0)???`
fix, finalize bw_svf + examples + more restrict + better debug 2023-09-03 18:22:52 +00:00			`* reset_state_multi allow NULL input?`
			`* process allow NULL output?`
set harder limits for gains in bw_{gain,hs1,hs2,ls1,ls2,peak} 2023-09-11 12:40:33 +00:00			`* #if __cplusplus >= 201103L ? - see https://stackoverflow.com/questions/5047971/how-do-i-check-for-c11-support`
finalized bw_comp + fixed missing smooth init + examples 2023-09-15 09:01:58 +00:00			`* get current compression level, knee`
finalize bw_{pan,ppm} + examples + fix bw_env_follow debug, bw_wah reset 2023-09-15 19:05:50 +00:00			`* src inside distortions? w/ control from outside?`
			`* make all outs nullable?`
finalized bw_phase_gen + updated synth(pp)_simple + better bw_svf doc 2023-09-18 11:41:15 +00:00			`* make all reset state outs nullable (svf, phase_gen, ...)?`
finalized bw_trem + examples 2023-09-19 06:49:56 +00:00			`* ring mod fx module?`
finalized bw_{sr_reduce,bd_reduce} + examples 2023-09-19 12:35:38 +00:00			`* bitcrusher module?`
finalized bw_src + extra touches to bw_src_int 2023-09-21 12:32:17 +00:00			`* return output std::array rather than have it as input argument?`
change C++ process() using std::array in bw_src 2023-09-21 15:05:37 +00:00			`* common smoothing policy (as control rate as possible?) - smoothing control?`
update TODO 2023-09-22 05:52:58 +00:00			`* max_delay -> set sample rate? see reverb`
			`* mem req -> return value of set sample rate? or sample rate argument of mem req?`
			`* c++ get coeffs/state? or public? src nIn/OutSamples case (array vs single value pre 1.0.0), delay read/write, process1? process single?`
			`* bw_comb: should also modulate feedback?`
			`* bw_comb: integer target delay values?`
finalized bw_delay + examples 2023-09-22 09:21:08 +00:00			`* are we sure about inlining everything?`
finalized bw_reverb + examples + fix bw_dry_wet + cosmetics 2023-09-22 16:34:16 +00:00			`* reset style is not enough when you have feedbacks... (see reverb)`
update TODO 2023-09-23 05:45:49 +00:00			`* IMPLEMENTATION/DECL/DEF prepocessor defs, maybe if DECL/DEF is defined then IMPLEMENTATION is needed to get implementation, etc.`
more debug 2023-09-25 15:16:42 +00:00			`* actually assert no buffer overlap`
initial import 2022-11-15 23:49:51 +00:00
			`build system:`
			`* make makefiles handle paths with spaces etc`
			`* can run su on windows? (system-wide install)`
MIDI CC mappings for daisy seed synth examples 2023-02-15 11:45:21 +00:00			`* make autodependencies (.d?) - https://make.mad-scientist.net/papers/advanced-auto-dependency-generation/`
initial import 2022-11-15 23:49:51 +00:00			`* make from... directories`
implemented bw_wah and bw_example_fx_wah + renamed bw_example_fx to bw_example_fx_svf, removed "Level" parameter, and using correct "Fx\|Filter" VST3 subcategory 2022-11-20 09:20:32 +00:00			`* recursive make?`
MIDI CC mappings for daisy seed synth examples 2023-02-15 11:45:21 +00:00			`* make hashdeps (https://github.com/olipratt/hashdeps)?`
taking TODO notes 2023-06-14 06:07:53 +00:00			`* VC, XCode, etc project files?`
more TODO 2023-06-14 06:44:59 +00:00			`* single header(s)`
more c++ wrappers 2023-06-19 16:06:19 +00:00			`* cross compile (rpi etc.)`
ios ffs 2023-08-04 13:08:46 +00:00			`* better use of xcodegen (see xcode warnings) and/or consider tuist (https://tuist.io/), bazel (https://bazel.build/), pants (https://www.pantsbuild.org/), buck (https://buck2.build/), please (https://please.build/index.html) for mobile apps`
improved android code + fixes in bw_ppm and bw_rand 2023-08-04 05:30:57 +00:00			`* homogenize android and ios common code (e.g., same index)`