Add documentation to the README file.
This commit is contained in:
@@ -1,6 +1,44 @@
|
||||
# comfyui-audio-plugin
|
||||
> A collection of nodes for working with audio data.
|
||||
|
||||
- [I/O](#io)
|
||||
- [Plotting](#plotting)
|
||||
- [Spectrogram](#spectrogram)
|
||||
- [License](#license)
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> This plugin is compatible with the ComfyUI audio nodes.
|
||||
|
||||
## I/O
|
||||
|
||||
| Name | Description |
|
||||
|----------------------|-------------------------------------------------------------------------------------|
|
||||
| Load Audio From Path | Same as "Load Audio" but loads from a local path instead of an uploaded audio file. |
|
||||
|
||||
## Plotting
|
||||
|
||||
| Name | Description |
|
||||
|---------------|------------------------------------------|
|
||||
| Plot Waveform | Plots the waveform of an `AUDIO` object. |
|
||||
|
||||
## Spectrogram
|
||||
|
||||
| Name | Description |
|
||||
|-----------------------|--------------------------------------------------------------------------------|
|
||||
| Spectrogram | Computes the spectrogram of a given `AUDIO` object. |
|
||||
| Inverse Spectrogram | Converts a complex-valued spectrogram to `AUDIO`. |
|
||||
| Griffin Lim | Converts a real-valued spectrogram to `AUDIO` using the Griffin-Lim algorithm. |
|
||||
| Mel-scale Spectrogram | Computes the mel-scale spectrogram of a given `AUDIO` object. |
|
||||
|
||||
A spectrogram (`SPECT`) can be one of three types:
|
||||
1. `complex` – a complex number valued spectrogram;
|
||||
2. `magnitude` – a real valued spectrogram that is the absolute value of the `complex` spectrogram (power 1);
|
||||
3. `power` – a real valued spectrogram that is the square of the `magnitude` spectrogram (power 2);
|
||||
|
||||
A mel-scale spectrogram (`MEL_SPECT`) is a `magnitude` or `power` spectrogram that has been converted
|
||||
to the mel audio scale.
|
||||
|
||||
## License
|
||||
Copyright (C) 2024 Reece H. Dunn
|
||||
|
||||
|
||||
Reference in New Issue
Block a user