scripts/hplp.lua

   1 ardour {
   2         ["type"]    = "dsp",
   3         name        = "High/Low Pass Filter",
   4         category    = "Filter",
   5         license     = "MIT",
   6         author      = "Robin Gareus",
   7         email       = "robin@gareus.org",
   8         site        = "http://gareus.org",
   9         description = [[Example Ardour Lua DSP Plugin]]
  10 }
  11
  12 function dsp_ioconfig ()
  13         return
  14         {
  15                 -- allow any number of I/O as long as port-count matches
  16                 { audio_in = -1, audio_out = -1},
  17         }
  18 end
  19
  20
  21 function dsp_params ()
  22         return
  23         {
  24                 { ["type"] = "input", name = "Type", min = 0, max = 1, default = 0, enum = true, scalepoints =
  25                         {
  26                                 ["High Pass"]  = 0,
  27                                 ["Low Pass"]   = 1,
  28                         }
  29                 },
  30                 { ["type"] = "input", name = "Steepness", min = 1, max = 4, default = 1, enum = true, scalepoints =
  31                         {
  32                                 ["12dB/oct"] = 1,
  33                                 ["24dB/oct"] = 2,
  34                                 ["36dB/oct"] = 3,
  35                                 ["48dB/oct"] = 4,
  36                         }
  37                 },
  38                 { ["type"] = "input", name = "Cut off frequency", min =   5, max = 20000, default = 1000, unit="Hz", logarithmic = true },
  39                 { ["type"] = "input", name = "Resonance",         min = 0.1, max = 8,     default = .707, logarithmic = true },
  40         }
  41 end
  42
  43 -- translate type parameter to DSP enum
  44 -- http://manual.ardour.org/lua-scripting/class_reference/#ARDOUR.DSP.Biquad.Type
  45 function map_type (t)
  46         if     t == 1 then
  47                 return ARDOUR.DSP.BiquadType.LowPass
  48         else
  49                 return ARDOUR.DSP.BiquadType.HighPass
  50         end
  51 end
  52
  53 -- these globals are *not* shared between DSP and UI
  54 local filters = {}  -- the biquad filter instances (DSP)
  55 local filt -- the biquad filter instance (GUI, response)
  56 local cur = {0, 0, 0, 0} -- current parameters
  57 local lpf = 0.03 -- parameter low-pass filter time-constant
  58 local chn = 0 -- channel/filter count
  59
  60 function dsp_init (rate)
  61         self:shmem ():allocate (1) -- shared mem to tell the GUI the samplerate
  62         local cfg = self:shmem ():to_int (0):array ()
  63         cfg[1] = rate
  64         lpf = 13000 / rate -- interpolation time constant
  65 end
  66
  67 function dsp_configure (ins, outs)
  68         assert (ins:n_audio () == outs:n_audio ())
  69         local cfg = self:shmem ():to_int (0):array ()
  70         local rate = cfg[1]
  71         chn = ins:n_audio ()
  72         for c = 1, chn do
  73                 filters[c] = {}
  74                 -- http://manual.ardour.org/lua-scripting/class_reference/#ARDOUR:DSP:Biquad
  75                 for k = 1,4 do
  76                         filters[c][k] = ARDOUR.DSP.Biquad (rate) -- initialize filters
  77                 end
  78         end
  79         cur = {0, 0, 0, 0}
  80 end
  81
  82 -- helper functions for parameter interpolation
  83 function param_changed (ctrl)
  84         if math.floor(ctrl[1]) == math.floor(cur[1]) and math.floor(ctrl[2]) == math.floor(cur[2]) and ctrl[3] == cur[3] and ctrl[4] == cur[4] then
  85                 return false
  86         end
  87         return true
  88 end
  89
  90 function low_pass_filter_param (old, new, limit)
  91         if math.abs (old - new) < limit  then
  92                 return new
  93         else
  94                 return old + lpf * (new - old)
  95         end
  96 end
  97
  98 -- apply parameters, re-compute filter coefficients if needed
  99 function apply_params (ctrl)
 100         if not param_changed (ctrl) then
 101                 return
 102         end
 103
 104         if cur[1] ~= ctrl[1] or cur[2] ~= ctrl[2] then
 105                 -- reset filter state when type or order changes
 106                 for c = 1, chn do
 107                         for k = 1,4 do
 108                                 filters[c][k]:reset ()
 109                         end
 110                 end
 111                 for k = 1,4 do cur[k] = ctrl[k] end
 112         else
 113                 -- low-pass filter ctrl parameter values, smooth transition
 114                 cur[3] = low_pass_filter_param (cur[3], ctrl[3], 1.0) -- freq/Hz
 115                 cur[4] = low_pass_filter_param (cur[4], ctrl[4], 0.01) -- quality
 116         end
 117
 118         if cur[2] < 1 then cur[2] = 1 end
 119         if cur[2] > 4 then cur[2] = 4 end
 120
 121         for c = 1, chn do
 122                 for k = 1,4 do
 123                         filters[c][k]:compute (map_type (cur[1]), cur[3], cur[4], 0)
 124                 end
 125         end
 126 end
 127
 128
 129 -- the actual DSP callback
 130 function dsp_run (ins, outs, n_samples)
 131         local changed = false
 132         local siz = n_samples
 133         local off = 0
 134
 135         -- if a parameter was changed, process at most 64 samples at a time
 136         -- and interpolate parameters until the current settings match
 137         -- the target values
 138         if param_changed (CtrlPorts:array ()) then
 139                 changed = true
 140                 siz = 64
 141         end
 142
 143         local o = math.floor(cur[2])
 144
 145         while n_samples > 0 do
 146                 if changed then apply_params (CtrlPorts:array ()) end
 147                 if siz > n_samples then siz = n_samples end
 148
 149                 -- process all channels
 150                 for c = 1,#ins do
 151                         -- check if output and input buffers for this channel are identical
 152                         -- http://manual.ardour.org/lua-scripting/class_reference/#C:FloatArray
 153                         if not ins[c]:sameinstance (outs[c]) then
 154                                 -- http://manual.ardour.org/lua-scripting/class_reference/#ARDOUR:DSP
 155                                 ARDOUR.DSP.copy_vector (outs[c]:offset (off), ins[c]:offset (off), siz)
 156                         end
 157                         for k = 1,o do
 158                                 filters[c][k]:run (outs[c]:offset (off), siz) -- in-place processing
 159                         end
 160                 end
 161
 162                 n_samples = n_samples - siz
 163                 off = off + siz
 164         end
 165
 166         if changed then
 167                 -- notify display
 168                 self:queue_draw ()
 169         end
 170 end
 171
 172
 173 -------------------------------------------------------------------------------
 174 --- inline display
 175
 176 function round (n)
 177         return math.floor (n + .5)
 178 end
 179
 180 function freq_at_x (x, w)
 181         -- x-axis pixel for given freq, power-scale
 182         return 20 * 1000 ^ (x / w)
 183 end
 184
 185 function x_at_freq (f, w)
 186         -- frequency at given x-axis pixel
 187         return w * math.log (f / 20.0) / math.log (1000.0)
 188 end
 189
 190 function db_to_y (db, h)
 191         -- y-axis gain mapping
 192         if db < -48 then db = -48 end
 193         if db >  12 then db =  12 end
 194         return -.5 + round (0.2 * h) - h * db / 60
 195 end
 196
 197 function grid_db (ctx, w, h, db)
 198         -- draw horizontal grid line
 199         local y = -.5 + round (db_to_y (db, h))
 200         ctx:move_to (0, y)
 201         ctx:line_to (w, y)
 202         ctx:stroke ()
 203 end
 204
 205 function grid_freq (ctx, w, h, f)
 206         -- draw vertical grid line
 207         local x = -.5 + round (x_at_freq (f, w))
 208         ctx:move_to (x, 0)
 209         ctx:line_to (x, h)
 210         ctx:stroke ()
 211 end
 212
 213 function render_inline (ctx, w, max_h)
 214         if not filt then
 215                 -- the GUI is separate from the DSP, but the GUI needs to know
 216                 -- the sample-rate that the DSP is using.
 217                 local shmem = self:shmem () -- get shared memory region
 218                 local cfg = shmem:to_int (0):array () -- "cast" into lua-table
 219                 -- instantiate filter (to calculate the transfer function's response)
 220                 filt = ARDOUR.DSP.Biquad (cfg[1])
 221         end
 222
 223         -- set filter coefficients if they have changed
 224         if param_changed (CtrlPorts:array ()) then
 225                 local ctrl = CtrlPorts:array ()
 226                 for k = 1,4 do cur[k] = ctrl[k] end
 227                 if cur[2] < 1 then cur[2] = 1 end
 228                 if cur[2] > 4 then cur[2] = 4 end
 229                 filt:compute (map_type (cur[1]), cur[3], cur[4], 0)
 230         end
 231
 232         -- calc height of inline display
 233         local h = math.ceil (w * 10 / 16) -- use 16:10 aspect
 234         if (h > max_h) then h = max_h end -- but at most max-height
 235
 236         -- ctx is a http://cairographics.org/ context
 237         -- http://manual.ardour.org/lua-scripting/class_reference/#Cairo:Context
 238
 239         -- clear background
 240         ctx:rectangle (0, 0, w, h)
 241         ctx:set_source_rgba (.2, .2, .2, 1.0)
 242         ctx:fill ()
 243
 244         -- set line width: 1px
 245         -- Note: a cairo pixel at [1,1]  spans [0.5->1.5 , 0.5->1.5]
 246         -- hence the offset -0.5 in various move_to(), line_to() calls
 247         ctx:set_line_width (1.0)
 248
 249         -- draw grid
 250         local dash3 = C.DoubleVector ()
 251         local dash2 = C.DoubleVector ()
 252         dash2:add ({1, 2})
 253         dash3:add ({1, 3})
 254         ctx:set_dash (dash2, 2) -- dotted line
 255         ctx:set_source_rgba (.5, .5, .5, .8)
 256         grid_db (ctx, w, h, 0)
 257         ctx:set_dash (dash3, 2) -- dotted line
 258         ctx:set_source_rgba (.5, .5, .5, .5)
 259         grid_db (ctx, w, h, -12)
 260         grid_db (ctx, w, h, -24)
 261         grid_db (ctx, w, h, -36)
 262         grid_freq (ctx, w, h, 100)
 263         grid_freq (ctx, w, h, 1000)
 264         grid_freq (ctx, w, h, 10000)
 265         ctx:unset_dash ()
 266
 267         local o = math.floor(cur[2])
 268         -- draw transfer function line
 269         ctx:set_source_rgba (.8, .8, .8, 1.0)
 270         ctx:move_to (-.5, db_to_y (o * filt:dB_at_freq (freq_at_x (0, w)), h))
 271         for x = 1,w do
 272                 local db = o * filt:dB_at_freq (freq_at_x (x, w))
 273                 ctx:line_to (-.5 + x, db_to_y (db, h))
 274         end
 275         ctx:stroke_preserve ()
 276
 277         -- fill area to zero under the curve
 278         ctx:line_to (w, -.5 + round (db_to_y (0, h)))
 279         ctx:line_to (0, -.5 + round (db_to_y (0, h)))
 280         ctx:close_path ()
 281         ctx:set_source_rgba (.5, .5, .5, .5)
 282         ctx:fill ()
 283
 284         return {w, h}
 285 end