diff --git a/README.md b/README.md index 84ab158..e74705e 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,9 @@ - [Workflows](#workflows) - [Plot Waveform](#plot-waveform) - [Nodes](#nodes) - - [I/O](#io) + - [Audio Waveforms](#audio-waveforms) + - [Spectrograms](#spectrograms) - [Filter Banks](#filter-banks) - - [Plotting](#plotting) - - [Spectrogram](#spectrogram) - [License](#license) > [!NOTE] @@ -21,11 +20,26 @@ ## Nodes -### I/O +### Audio Waveforms | Name | Description | |----------------------|-------------------------------------------------------------------------------------| | Load Audio From Path | Same as "Load Audio" but loads from a local path instead of an uploaded audio file. | +| Plot Waveform | Plots the waveform of an `AUDIO` object. | + +### Spectrograms + +| 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. | +| Plot Spectrogram | Plots the spectrogram of a `SPECT` 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); ### Filter Banks @@ -33,27 +47,7 @@ |-----------------------|-----------------------------------------------------| | Mel-scale Filter Bank | Create a mel-scale filter bank. | | Apply Filter Bank | Apply the specified filter bank to the spectrogram. | - -### Plotting - -| Name | Description | -|----------------------------|--------------------------------------------| -| Plot Waveform | Plots the waveform of an `AUDIO` object. | -| Plot Spectrogram | Plots the spectrogram of a `SPECT` object. | -| Plot Filter Bank | Plots the `FILTER_BANK` 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. | - -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); +| Plot Filter Bank | Plots the `FILTER_BANK` object. | ## License Copyright (C) 2024 Reece H. Dunn diff --git a/plot_nodes.py b/plot_nodes.py index 7bd3270..bb564de 100644 --- a/plot_nodes.py +++ b/plot_nodes.py @@ -25,7 +25,7 @@ class PlotWaveform: "ylabel": ("STRING", {"default": "Amplitude"}), "show_grid": ("BOOLEAN", {"default": True}),}} - CATEGORY = "audio processing/plot" + CATEGORY = "audio processing" RETURN_TYPES = ("IMAGE", ) FUNCTION = "plot" @@ -58,7 +58,7 @@ class PlotSpectrogram: "ylabel": ("STRING", {"default": "Frequency (Hz)"}), "show_grid": ("BOOLEAN", {"default": False}),}} - CATEGORY = "audio processing/plot" + CATEGORY = "audio processing/spectrogram" RETURN_TYPES = ("IMAGE", ) FUNCTION = "plot" @@ -97,7 +97,7 @@ class PlotFilterBank: "xlabel": ("STRING", {"default": "filter bin"}), "ylabel": ("STRING", {"default": "frequency bin"}),}} - CATEGORY = "audio processing/plot" + CATEGORY = "audio processing/filter bank" RETURN_TYPES = ("IMAGE", ) FUNCTION = "plot"