Annotate Artifact Blame Check-ins Using Doc Download Hex

File src/remiaudio/dsp/reverbs/schroeder-presets.cr from the latest check-in

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99

#### RemiAudio
#### Copyright (C) 2022-2024 Remilia Scarlet <remilia@posteo.jp>
####   Based on MVerb
####   Copyright (c) 2010 Martin Eastwood
####
#### This program is free software: you can redistribute it and/or modify it
#### under the terms of the GNU Affero General Public License as published by
#### the Free Software Foundation, either version 3 of the License, or (at your
#### option) any later version.
####
#### This program is distributed in the hope that it will be useful, but WITHOUT
#### ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
#### FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
#### License for more details.
####
#### You should have received a copy of the GNU Affero General Public License
#### along with this program.  If not, see <https://www.gnu.org/licenses/>.
require "./reverb"

module RemiAudio::DSP
  class Schroeder < Reverb
    # Defines a set of parameters for `Schroeder`.
    class Preset < Reverb::Preset
      getter roomSize : Float64 = DEFAULT_ROOM
      getter damping : Float64 = DEFAULT_DAMPING
      getter width : Float64 = DEFAULT_WIDTH
      getter wet : Float64 = DEFAULT_WET

      # Creates a new `Preset` instance.
      def initialize
      end

      # :ditto:
      def initialize(*, @roomSize : Float64 = DEFAULT_ROOM,
                     @damping : Float64 = DEFAULT_DAMPING,
                     @width : Float64 = DEFAULT_WIDTH,
                     @wet : Float64 = DEFAULT_WET)
        # Do a bunch of checks
        Schroeder.checkRoomSize(@roomSize)
        Schroeder.checkDamping(@damping)
        Schroeder.checkWidth(@width)
        Schroeder.checkWet(@wet)
      end

      def roomSize=(value : Float64)
        Schroeder.checkRoomSize(value)
        @roomSize = value
      end

      def damping=(value : Float64)
        Schroeder.checkDamping(value)
        @damping = value
      end

      def width=(value : Float64)
        Schroeder.checkWidth(value)
        @width = value
      end

      def wet=(value : Float64)
        Schroeder.checkWet(value)
        @wet = value
      end
    end

    # Names for the pre-constructed `Preset` instances in `MVerb::PRESETS`.
    enum PresetNames
      # A good default for General MIDI use.
      GmDefault

      # A small room.
      Room

      # A large concert hall.
      Hall
    end

    # Pre-constructed `Preset` instances for `MVerb` that correspond to the
    # names in `PresetNames`.
    PRESETS = {
      PresetNames::GmDefault => Preset.new(
        roomSize: 0.5,
        damping: 0.5,
        width: 1.0),

      PresetNames::Room => Preset.new(
        roomSize: 0.3,
        damping: 0.3,
        width: 0.94
      ),

      PresetNames::Hall => Preset.new(
        roomSize: 0.9,
        damping: 0.7,
        width: 1.1
      )
    }
  end
end