Skip to content

Commit

Permalink
Update readmes and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
HEnquist committed Jan 23, 2021
1 parent 3a8f816 commit 5151e48
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
## 0.5.0
New features:
- Add RMS and Peak measurement for each channel at input and output.
- Add a Volume filter for volume control.
- Add a `Volume` filter for volume control.
- Add exit codes.
- Adapt `check` output to be more suitable for scripts.
- Search for filter coefficient files with relative paths first in config file dir.
- Add ShibataLow dither types.
- Add `ShibataLow` dither types.
- Add option to write logs to file.
- Skip processing of channels that are not used in the pipeline.
- Update to new faster RustFFT.
- Overriding samplerate also scales chunksize.
- Use updated faster resampler.
- Enable experimental neon support in resampler via `neon` feature.
- Add `Loudness` volume control filter.
- Add mute option on mixer outputs.
- Add mute options in mixer and Gain filters.
- Add mute function to Volume and Loundness filters, with websocket commands.


## 0.4.0
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ The filters section defines the filter configurations to use in the pipeline. It
The supported filter types are Biquad, BiquadCombo and DiffEq for IIR and Conv for FIR. There are also filters just providing gain and delay. The last filter type is Dither, which is used to add dither when quantizing the output.
### Gain
The gain filter simply changes the amplitude of the signal. The `inverted` parameter simply inverts the signal. This parameter is optional and the default is to not invert. The `gain` value is given in dB, and a positive value means the signal will be amplified while a negative values attenuates.
The gain filter simply changes the amplitude of the signal. The `inverted` parameter simply inverts the signal. This parameter is optional and the default is to not invert. The `gain` value is given in dB, and a positive value means the signal will be amplified while a negative values attenuates. The `mute` parameter determines if the the signal should be muted. This is optional and defaults to not mute.
Example Gain filter:
```
Expand All @@ -733,10 +733,11 @@ filters:
parameters:
gain: -6.0
inverted: false
mute: false (*)
```
### Volume
The Volume filter is intended to be used as a volume control. The inital volume can be set with the `gain` command line parameter. The volume can then be changed via the websocket. A request to set the volume will be applied to all Volume filters. When the volume is changed, the gain is ramped smoothly to the new value. The duration of this ramp is set by the `ramp_time` parameter (unit milliseconds). If left out, this defaults to 200 ms. This value will be rounded to the nearest number of chunks. To use this filter, insert a Volume filter somewhere in the pipeline for each channel. It's possible to use this to make a dithered volume control by placing the Volume filter somewhere in the pipeline, and having a Dither filter as the last step.
The Volume filter is intended to be used as a volume control. The inital volume and muting state can be set with the `gain` and `mute` command line parameters. The volume can then be changed via the websocket. A request to set the volume will be applied to all Volume filters. When the volume or mute state is changed, the gain is ramped smoothly to the new value. The duration of this ramp is set by the `ramp_time` parameter (unit milliseconds). If left out, this defaults to 200 ms. This value will be rounded to the nearest number of chunks. To use this filter, insert a Volume filter somewhere in the pipeline for each channel. It's possible to use this to make a dithered volume control by placing the Volume filter somewhere in the pipeline, and having a Dither filter as the last step.
Example Volume filter:
```
Expand Down
5 changes: 4 additions & 1 deletion websocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,13 @@ Commands for reading status parameters.

### Volume control

Commands for setting and getting the volume setting. These are only relevant if the pipeline includes "Volume" filters.
Commands for setting and getting the volume setting. These are only relevant if the pipeline includes "Volume" or "Loudness" filters.
- `GetVolume` : get the current volume setting in dB.
* returns the value as a float
- `SetVolume` : set the volume control to the given value in dB.
- `GetMute` : get the current mute setting.
* returns the muting status as a boolean
- `SetMute` : set muting to the given value.

### Config management

Expand Down

0 comments on commit 5151e48

Please sign in to comment.