BC_smoothsw.ini_10-2023

#  _______                      __   __    _______             __       __
# |     __.--------.-----.-----|  |_|  |--|     __.--.--.--.  |__.-----|__|
# |__     |        |  _  |  _  |   _|     |__     |  |  |  |__|  |     |  | BC version in common folder
# |_______|__|__|__|_____|_____|____|__|__|_______|________|__|__|__|__|__|



# SmoothSwing algorithm version, you probably want to set this to 2.
Version=2

# Degrees of rotations per second required to reach full volume
# Default is 450.0 (any value)
SwingSensitivity=600
#SwingSensitivity=400 - too early loudness = wiggle swing

# Smoothswing volume multiplier (defaults to 3x normal volume)
# Default is 3.0 (value between 1 and 5)
MaxSwingVolume=3.5

# What percent the hum sound will decrease as swing increases
# Default is 75.0 (value between 1 and 100)
MaximumHumDucking=80

# non-linear swing response (higher values make it more non-linear)
# Values greater than 1 will result in the Smoothswing sound staying quieter
# at lower speeds and then ramping up quickly to full volume a higher speeds.
# Values less than 1 will result in the Smoothswing volume ramping up quickly
# at lower speeds and then staying there as you approach full speed.
# the default is 1.75 (any value)
SwingSharpness=2.5

# Degrees per second needed to register as a smoothswing
# Default is 20.0 (1 to 360)
SwingStrengthThreshold=30

# Length of first transition in degrees.
# If swings are not transitioning between swingl and swingh fast enough,
# try reducing this number, but stay above 10 or so.
# Default is 45.0 (1 to 360)
Transition1Degrees=45

# Length of second transition in degrees.
# Default is 160.0 (1 to 360)
Transition2Degrees=160

# If not zero, swngNNN.wav or swngNNN.wav will
# be played when we reach this swing speed.
# Unit is degrees per second, 450 is a reasonable value.
# Default is 0.0
AccentSwingSpeedThreshold=450

# If not zero AND accent swings are on, this defines the threshold for when
# a swing is considered a slash. Unit is degrees per second **per second**.
# NOTE - While 260 is the default value, it is subjective.
# Something like 100 might work better.
# The higher the accent swing threshold, the higher the slash threshold will need to be.
AccentSlashAccelerationThreshold=110

# NOTES
# 1. The length of the smoothswing pair wavs has nothing to do with
# the length of the swing movement or how it transitions.
# Try setting the SwingSensitivity number so that you're not
# detecting motion for smaller movements.


# 2. If you find that the same swing pair sounds play for subsequent swings,
# try adjusting SwingSensitivity. If the saber is moving faster than the threshold velocity,
# it is going to be playing one of the smoothswing pairs on loop.
# The algorithm only picks a new swing pair of swingl and swingh sounds when it thinks
# it's safe to do so (when you're not in the middle of a swing).


# 3. ProffieOS first reads the wav file, then applies a volume based on swing strength and settings.
# This volume defaults to 50% to avoid immediate clipping when the volume goes up.
# The output becomes a 16-bit stream, so if you *want* clipping, this is where it should happen.
# All the 16-bit streams are added up in the dynamic mixer, which applies 3dB of dynamic compression
# to adapt to high/low volumes without clipping too much. After that, the main volume is applied,
# the output is then converted to 16 bits and fed to the DAC.
# Clipping in the last step should generally be avoided as it is highly dependent on what else is playing.
# Clipping in the first step is fine, as it is calculated independently of all the other channels.

# As for improving the volume of Smoothswing sounds,
# MaxSwingVolume is what you should probably try adjusting first.