scripts/HiAndLowPass.lua

   1 ardour {
   2         ["type"]    = "dsp",
   3         name        = "a-High and Low Pass Filter",
   4         category    = "Filter",
   5         license     = "GPLv2",
   6         author      = "Ardour Team",
   7         description = [[Example Ardour Lua DSP Plugin]]
   8 }
   9
  10 function dsp_ioconfig ()
  11         return
  12         {
  13                 -- allow any number of I/O as long as port-count matches
  14                 { audio_in = -1, audio_out = -1},
  15         }
  16 end
  17
  18
  19 function dsp_params ()
  20         return
  21         {
  22                 { ["type"] = "input", name = "High Pass Steepness", min = 0, max = 4, default = 1, enum = true, scalepoints =
  23                         {
  24                                 ["Off"] = 0,
  25                                 ["12dB/oct"] = 1,
  26                                 ["24dB/oct"] = 2,
  27                                 ["36dB/oct"] = 3,
  28                                 ["48dB/oct"] = 4,
  29                         }
  30                 },
  31                 { ["type"] = "input", name = "High Pass Cut off frequency", min =   5, max = 20000, default = 100, unit="Hz", logarithmic = true },
  32                 { ["type"] = "input", name = "High Pass Resonance",         min = 0.1, max = 6,     default = .707, logarithmic = true },
  33
  34                 { ["type"] = "input", name = "Low Pass Steepness", min = 0, max = 4, default = 1, enum = true, scalepoints =
  35                         {
  36                                 ["Off"] = 0,
  37                                 ["12dB/oct"] = 1,
  38                                 ["24dB/oct"] = 2,
  39                                 ["36dB/oct"] = 3,
  40                                 ["48dB/oct"] = 4,
  41                         }
  42                 },
  43                 { ["type"] = "input", name = "Low Pass Cut off frequency",  min =  20, max = 20000, default = 18000, unit="Hz", logarithmic = true },
  44                 { ["type"] = "input", name = "Low Pass Resonance",          min = 0.1, max = 6,     default = .707, logarithmic = true },
  45         }
  46 end
  47
  48 -- these globals are *not* shared between DSP and UI
  49 local hp = {}  -- the biquad high-pass filter instances (DSP)
  50 local lp = {}  -- the biquad high-pass filter instances (DSP)
  51 local filt = nil -- the biquad filter instance (GUI, response)
  52 local cur = {0, 0, 0, 0, 0, 0, 0} -- current parameters
  53 local lpf = 0.03 -- parameter low-pass filter time-constant
  54 local chn = 0 -- channel/filter count
  55
  56 local mem = nil -- memory x-fade buffer
  57
  58 function dsp_init (rate)
  59         -- allocate some mix-buffer
  60         mem = ARDOUR.DSP.DspShm (8192)
  61
  62         -- create a table of objects to share with the GUI
  63         local tbl = {}
  64         tbl['samplerate'] = rate
  65         self:table ():set (tbl)
  66
  67         -- interpolation time constant, 64fpp
  68         lpf = 15000 / rate
  69 end
  70
  71 function dsp_configure (ins, outs)
  72         assert (ins:n_audio () == outs:n_audio ())
  73         local tbl = self:table ():get () -- get shared memory table
  74
  75         chn = ins:n_audio ()
  76         cur = {0, 0, 0, 0, 0, 0}
  77
  78         hp = {}
  79         lp = {}
  80
  81         collectgarbage ()
  82
  83         for c = 1, chn do
  84                 hp[c] = {}
  85                 lp[c] = {}
  86                 -- initialize filters
  87                 -- http://manual.ardour.org/lua-scripting/class_reference/#ARDOUR:DSP:Biquad
  88                 for k = 1,4 do
  89                         hp[c][k] = ARDOUR.DSP.Biquad (tbl['samplerate'])
  90                         lp[c][k] = ARDOUR.DSP.Biquad (tbl['samplerate'])
  91                 end
  92         end
  93 end
  94
  95 -- helper functions for parameter interpolation
  96 function param_changed (ctrl)
  97         for p = 1,6 do
  98                 if ctrl[p] ~= cur[p] then
  99                         return true
 100                 end
 101         end
 102         return false
 103 end
 104
 105 function low_pass_filter_param (old, new, limit)
 106         if math.abs (old - new) < limit  then
 107                 return new
 108         else
 109                 return old + lpf * (new - old)
 110         end
 111 end
 112
 113 -- apply parameters, re-compute filter coefficients if needed
 114 function apply_params (ctrl)
 115         if not param_changed (ctrl) then
 116                 return
 117         end
 118
 119         -- low-pass filter ctrl parameter values, smooth transition
 120         cur[1] = low_pass_filter_param (cur[1], ctrl[1], 0.05) -- HP order x-fade
 121         cur[2] = low_pass_filter_param (cur[2], ctrl[2], 1.0)  -- HP freq/Hz
 122         cur[3] = low_pass_filter_param (cur[3], ctrl[3], 0.01) -- HP quality
 123         cur[4] = low_pass_filter_param (cur[4], ctrl[4], 0.05) -- LP order x-fade
 124         cur[5] = low_pass_filter_param (cur[5], ctrl[5], 1.0)  -- LP freq/Hz
 125         cur[6] = low_pass_filter_param (cur[6], ctrl[6], 0.01) -- LP quality
 126
 127         for c = 1, chn do
 128                 for k = 1,4 do
 129                         hp[c][k]:compute (ARDOUR.DSP.BiquadType.HighPass, cur[2], cur[3], 0)
 130                         lp[c][k]:compute (ARDOUR.DSP.BiquadType.LowPass,  cur[5], cur[6], 0)
 131                 end
 132         end
 133 end
 134
 135
 136 -- the actual DSP callback
 137 function dsp_run (ins, outs, n_samples)
 138         assert (n_samples < 8192)
 139         assert (#ins == chn)
 140
 141         local changed = false
 142         local siz = n_samples
 143         local off = 0
 144
 145         -- if a parameter was changed, process at most 64 samples at a time
 146         -- and interpolate parameters until the current settings match
 147         -- the target values
 148         if param_changed (CtrlPorts:array ()) then
 149                 changed = true
 150                 siz = 64
 151         end
 152
 153         while n_samples > 0 do
 154                 if changed then apply_params (CtrlPorts:array ()) end
 155                 if siz > n_samples then siz = n_samples end
 156
 157                 local ho = math.floor(cur[1])
 158                 local lo = math.floor(cur[4])
 159                 local hox = cur[1]
 160                 local lox = cur[4]
 161
 162                 -- process all channels
 163                 for c = 1, #ins do
 164
 165                         local xfade = hox - ho
 166                         assert (xfade >= 0 and xfade < 1)
 167
 168                         ARDOUR.DSP.copy_vector (mem:to_float (off), ins[c]:offset (off), siz)
 169
 170                         -- initialize output
 171                         if hox == 0 then
 172                                 -- high pass is disabled, just copy data.
 173                                 ARDOUR.DSP.copy_vector (outs[c]:offset (off), mem:to_float (off), siz)
 174                         else
 175                                 -- clear output, The filter mixes into the output buffer
 176                                 ARDOUR.DSP.memset (outs[c]:offset (off), 0, siz)
 177                         end
 178
 179                         -- high pass
 180                         -- allways run all filters so that we can interplate as needed.
 181                         for k = 1,4 do
 182                                 if xfade > 0 and k > ho and k <= ho + 1 then
 183                                         ARDOUR.DSP.mix_buffers_with_gain (outs[c]:offset (off), mem:to_float (off), siz, 1 - xfade)
 184                                 end
 185
 186                                 hp[c][k]:run (mem:to_float (off), siz)
 187
 188                                 if k == ho and xfade == 0 then
 189                                         ARDOUR.DSP.copy_vector (outs[c]:offset (off), mem:to_float (off), siz)
 190                                 elseif k > ho and k <= ho + 1 then
 191                                         ARDOUR.DSP.mix_buffers_with_gain (outs[c]:offset (off), mem:to_float (off), siz, xfade)
 192                                 end
 193                         end
 194
 195                         -- low pass
 196                         xfade = lox - lo
 197                         assert (xfade >= 0 and xfade < 1)
 198
 199                         -- copy output of high-pass into "processing memory"
 200                         ARDOUR.DSP.copy_vector (mem:to_float (off), outs[c]:offset (off), siz)
 201
 202                         if lox > 0 then
 203                                 -- clear output, Low-pass mixes interpolated data into output,
 204                                 -- in which case we just keep the output
 205                                 ARDOUR.DSP.memset (outs[c]:offset (off), 0, siz)
 206                         end
 207
 208                         for k = 1,4 do
 209                                 if xfade > 0 and k > lo and k <= lo + 1 then
 210                                         ARDOUR.DSP.mix_buffers_with_gain (outs[c]:offset (off), mem:to_float (off), siz, 1 - xfade)
 211                                 end
 212
 213                                 lp[c][k]:run (mem:to_float (off), siz)
 214
 215                                 if k == lo and xfade == 0 then
 216                                         ARDOUR.DSP.copy_vector (outs[c]:offset (off), mem:to_float (off), siz)
 217                                 elseif k > lo and k <= lo + 1 then
 218                                         ARDOUR.DSP.mix_buffers_with_gain (outs[c]:offset (off), mem:to_float (off), siz, xfade)
 219                                 end
 220                         end
 221
 222                 end
 223
 224                 n_samples = n_samples - siz
 225                 off = off + siz
 226         end
 227
 228         if changed then
 229                 -- notify display
 230                 self:queue_draw ()
 231         end
 232 end
 233
 234
 235 -------------------------------------------------------------------------------
 236 --- inline display
 237
 238 function round (n)
 239         return math.floor (n + .5)
 240 end
 241
 242 function freq_at_x (x, w)
 243         -- frequency in Hz at given x-axis pixel
 244         return 20 * 1000 ^ (x / w)
 245 end
 246
 247 function x_at_freq (f, w)
 248         -- x-axis pixel for given frequency, power-scale
 249         return w * math.log (f / 20.0) / math.log (1000.0)
 250 end
 251
 252 function db_to_y (db, h)
 253         -- y-axis gain mapping
 254         if db < -60 then db = -60 end
 255         if db >  12 then db =  12 end
 256         return -.5 + round (0.2 * h) - h * db / 60
 257 end
 258
 259 function grid_db (ctx, w, h, db)
 260         -- draw horizontal grid line
 261         -- note that a cairo pixel at Y spans [Y - 0.5 to Y + 0.5]
 262         local y = -.5 + round (db_to_y (db, h))
 263         ctx:move_to (0, y)
 264         ctx:line_to (w, y)
 265         ctx:stroke ()
 266 end
 267
 268 function grid_freq (ctx, w, h, f)
 269         -- draw vertical grid line
 270         local x = -.5 + round (x_at_freq (f, w))
 271         ctx:move_to (x, 0)
 272         ctx:line_to (x, h)
 273         ctx:stroke ()
 274 end
 275
 276 function response (ho, lo, f)
 277         -- calculate transfer function response for given
 278         -- hi/po pass order at given frequency [Hz]
 279         local db = ho * filt['hp']:dB_at_freq (f)
 280         return db + lo * filt['lp']:dB_at_freq (f)
 281 end
 282
 283 function render_inline (ctx, w, max_h)
 284         if not filt then
 285                 local tbl = self:table ():get () -- get shared memory table
 286                 -- instantiate filter (to calculate the transfer function's response)
 287                 filt = {}
 288                 filt['hp'] = ARDOUR.DSP.Biquad (tbl['samplerate'])
 289                 filt['lp'] = ARDOUR.DSP.Biquad (tbl['samplerate'])
 290         end
 291
 292         -- set filter coefficients if they have changed
 293         if param_changed (CtrlPorts:array ()) then
 294                 local ctrl = CtrlPorts:array ()
 295                 for k = 1,6 do cur[k] = ctrl[k] end
 296                 filt['hp']:compute (ARDOUR.DSP.BiquadType.HighPass, cur[2], cur[3], 0)
 297                 filt['lp']:compute (ARDOUR.DSP.BiquadType.LowPass,  cur[5], cur[6], 0)
 298         end
 299
 300         -- calc height of inline display
 301         local h = 1 | math.ceil (w * 9 / 16) -- use 16:9 aspect, odd number of y pixels
 302         if (h > max_h) then h = max_h end -- but at most max-height
 303
 304         -- ctx is a http://cairographics.org/ context
 305         -- http://manual.ardour.org/lua-scripting/class_reference/#Cairo:Context
 306
 307         -- clear background
 308         ctx:rectangle (0, 0, w, h)
 309         ctx:set_source_rgba (.2, .2, .2, 1.0)
 310         ctx:fill ()
 311         ctx:rectangle (0, 0, w, h)
 312         ctx:clip ()
 313
 314         -- set line width: 1px
 315         ctx:set_line_width (1.0)
 316
 317         -- draw grid
 318         local dash3 = C.DoubleVector ()
 319         local dash2 = C.DoubleVector ()
 320         dash2:add ({1, 2})
 321         dash3:add ({1, 3})
 322         ctx:set_dash (dash2, 2) -- dotted line: 1 pixel 2 space
 323         ctx:set_source_rgba (.5, .5, .5, .8)
 324         grid_db (ctx, w, h, 0)
 325         ctx:set_dash (dash3, 2) -- dashed line: 1 pixel 3 space
 326         ctx:set_source_rgba (.5, .5, .5, .5)
 327         grid_db (ctx, w, h, -12)
 328         grid_db (ctx, w, h, -24)
 329         grid_db (ctx, w, h, -36)
 330         grid_freq (ctx, w, h, 100)
 331         grid_freq (ctx, w, h, 1000)
 332         grid_freq (ctx, w, h, 10000)
 333         ctx:unset_dash ()
 334
 335         -- draw transfer function line
 336         local ho = math.floor(cur[1])
 337         local lo = math.floor(cur[4])
 338
 339         ctx:set_source_rgba (.8, .8, .8, 1.0)
 340         ctx:move_to (-.5, db_to_y (response(ho, lo, freq_at_x (0, w)), h))
 341         for x = 1,w do
 342                 local db = response(ho, lo, freq_at_x (x, w))
 343                 ctx:line_to (-.5 + x, db_to_y (db, h))
 344         end
 345         -- stoke a line, keep the path
 346         ctx:stroke_preserve ()
 347
 348         -- fill area to zero under the curve
 349         ctx:line_to (w, -.5 + round (db_to_y (0, h)))
 350         ctx:line_to (0, -.5 + round (db_to_y (0, h)))
 351         ctx:close_path ()
 352         ctx:set_source_rgba (.5, .5, .5, .5)
 353         ctx:fill ()
 354
 355         return {w, h}
 356 end