Merge pull request #50 from phandasm/develop

Merge develop branch for v1.7.0

Author: phandasm

CMakeLists.txt

@@ -1,14 +1,14 @@
 cmake_minimum_required(VERSION 3.16)
 
-set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
 include(CheckSymbolExists)
 
 project(waveform)
 
-set(WAVEFORM_VERSION "1.6.1")
+set(WAVEFORM_VERSION "1.7.0")
 
 # set default install prefix to OBS plugin path on linux and MacOS
 # otherwise set it to the windows installer source folder
@@ -48,13 +48,13 @@ if(NOT TARGET OBS::libobs)
     find_package(LibObs REQUIRED)
 
     # emulate modern target
-    add_library(OBS::libobs INTERFACE IMPORTED GLOBAL)
+    add_library(OBS::libobs INTERFACE IMPORTED)
     target_link_libraries(OBS::libobs INTERFACE ${LIBOBS_LIBRARIES})
     target_include_directories(OBS::libobs INTERFACE ${LIBOBS_INCLUDE_DIRS})
 endif()
 
 if(MSVC)
-    add_definitions(/MP) # parallel builds
+    add_compile_options(/MP) # parallel builds
 
     option(EXTRA_OPTIMIZATIONS "Enable additional compiler optimizations" OFF)
     if(EXTRA_OPTIMIZATIONS)
@@ -139,7 +139,7 @@ set(PLUGIN_SOURCES
     "src/source.hpp"
     "src/source.cpp"
     "src/source_generic.cpp"
-    "src/membuf.hpp"
+    "src/aligned_buffer.hpp"
     "src/math_funcs.hpp"
     "src/filter.hpp"
     "src/settings.hpp"
@@ -152,7 +152,6 @@ if(NOT DISABLE_X86_SIMD)
         "src/source_avx2.cpp"
         "src/source_avx.cpp"
         "src/filter_fma3.cpp"
-        "src/aligned_mem.hpp"
     )
 
     # arch flags
@@ -194,7 +193,6 @@ target_link_libraries(waveform PRIVATE OBS::libobs ${FFTW_LIBRARIES})
 if(NOT DISABLE_X86_SIMD)
     target_link_libraries(waveform PRIVATE cpu_features)
 endif()
-target_compile_definitions(waveform PRIVATE _USE_MATH_DEFINES)
 if(MSVC)
     target_compile_options(waveform PRIVATE "/W4") # warning level
     target_link_options(waveform PRIVATE "$<$<CONFIG:Release>:/OPT:REF>") # reduce size of release binaries

README.md

@@ -9,12 +9,18 @@ It is based on [FFTW](https://www.fftw.org/) and optimized for AVX2/FMA3.
 Clone the repo with submodules: `git clone --recurse-submodules`  
 Or if you already cloned without them: `git submodule update --init --recursive`
 
+## Minimum Supported Compilers
+- GCC 10.1
+- Clang 11.0
+- VS 2019 16.8
+
 ## Windows
 Waveform's only external dependency is libobs.  
 You'll need to build obs-studio separately and point [CMake](https://cmake.org/) to it when building Waveform.  
 From the CLI interface, the latter can be accomplished via `-DCMAKE_PREFIX_PATH="path/to/obs-studio/build"`.
 
-## Linux (Ubuntu 20.04.3 LTS)
+## Linux
+### Ubuntu 20.04
 ```bash
 # install build tools
 sudo apt-get install build-essential git cmake
@@ -34,3 +40,18 @@ cmake ..
 make
 make install
 ```
+
+### Fedora
+**Prerequisite:** OBS packages from RPM Fusion (see [OBS Wiki](https://obsproject.com/wiki/unofficial-linux-builds#fedora)).  
+
+```bash
+sudo dnf install @development-tools cmake obs-studio-devel fftw-devel
+
+git clone --recurse-submodules https://github.com/phandasm/waveform.git
+mkdir waveform/build
+cd waveform/build
+
+cmake ..
+make
+make install
+```

THANKS

@@ -5,3 +5,4 @@ Romain <https://github.com/rmnvgr>
 神枪968 <https://github.com/GodGun968>
 Ori Sky <https://github.com/ori-sky>
 Kai Lee <https://github.com/KaiLee2588>
+Peppe73

changelog.md

@@ -1,22 +1,14 @@
-# Notice to Intel Mac users
-OBS requirement has been bumped to 28, please uninstall older versions of waveform first.
-
-## Changes in 1.6.1
-- Fix MacOS x64 installer
-- Update Chinese localization (#43 thanks to GodGun968)
-
-## Changes in 1.6.0
-- Add option to mirror frequency axis
-- Add option to adjust arc angle in radial mode
-- Add option for minimum bar height
-- Add option to adjust normalized volume target
-- Add "Single" channel mode to allow selection of specific audio channel
-- Fix some potential crashes
-- Fix graph frozen after playback of media file finishes
-- Fix "Hide graph when audio is silent" option for level meters
-- Update Chinese localization (#32, #38 thanks to GodGun968)
-- Improve rendering of curve graph in some cases
-- Performance improvements
+## Changes in 1.7.0-beta1
+- Add the ironically missing-until-now waveform display mode (experimental)
+- Add 'Pulse' render mode
+- Add option to continue processing audio while source is muted
+- Add option to adjust maximum volume normalization gain
+- Add option to adjust rotation of radial display
+- Add Traditional Chinese localization (#44 thanks to Kai Lee)
+- Add Italian localization (thanks to Peppe73)
+- Attempt to mitigate A/V desync in some setups
+- Fix spectrum accuracy, **spectrum graphs will appear slightly "louder" now.**
+- Increase 'FFT Size' limit
 
 ## Installation
 ### Windows
@@ -33,7 +25,7 @@ or
 - Download Waveform\_v#.#.#\_Ubuntu\_x86\_64.deb and install it using your distro's package manager (Debian/Ubuntu only).  
 
 #### Flatpak
-- `flatpak install flathub com.obsproject.Studio.Plugins.waveform`  
+- `flatpak install flathub com.obsproject.Studio.Plugin.waveform`  
 
 #### Source Build
 - Step-by-step instructions in the [readme](https://github.com/phandasm/waveform/blob/master/README.md#linux-ubuntu-20043-lts).  

data/gradient.effect

@@ -11,6 +11,7 @@ uniform float graph_deadzone = 0.0;
 uniform bool graph_invert = false;
 uniform float2 radial_center = {0.0, 0.0};
 uniform float radial_arc = 1.0;
+uniform float radial_rotation = 0.0;
 
 struct VertInOut {
 	float4 pos : POSITION;
@@ -39,7 +40,7 @@ VertGrad VSGradient(VertInOut vert_in)
 VertGrad VSRadial(VertInOut vert_in)
 {
 	VertGrad vert_out;
-	float angle = saturate(vert_in.pos.x / graph_width) * radial_arc * 6.283185307179586f;
+	float angle = (saturate(vert_in.pos.x / graph_width) * radial_arc * 6.283185307179586f) + radial_rotation;
 	vert_out.pos = float4(vert_in.pos.xyz, 1.0);
 	if(graph_invert)
 	{

data/locale/en-US.ini

@@ -9,11 +9,17 @@ ignore_mute="Process While Muted"
 
 normalize_volume="Normalize Volume"
 volume_target="Target Volume"
+max_gain="Maximum Gain"
 
 render_mode="Render Mode"
 line="Line"
 solid="Solid"
 gradient="Gradient"
+pulse="Pulse"
+
+pulse_mode="Pulse Mode"
+peak_magnitude="Peak Magnitude"
+peak_frequency="Peak Frequency"
 
 width="Video Width"
 height="Video Height"
@@ -26,6 +32,7 @@ radial_layout="Radial Layout"
 invert_direction="Invert Radial Direction"
 deadzone="Deadzone"
 radial_arc="Radial Arc"
+radial_rotation="Radial Rotation"
 
 rounded_caps="Rounded Caps"
 
@@ -81,9 +88,10 @@ bars="Bars"
 stepped_bars="Stepped Bars"
 level_meter="Level Meter"
 stepped_level_meter="Stepped Level Meter"
+waveform="Waveform (experimental)"
 
 rms_mode="RMS Mode"
-meter_buf="Meter Buffer"
+meter_buf="Buffer Size"
 
 bar_width="Bar Width"
 bar_gap="Bar Gap"

data/locale/it-IT.ini

@@ -0,0 +1,99 @@
+source_name="Waveform"
+
+audio_source="Sorgente audio"
+none="Nessuno"
+output_bus="Bus di uscita"
+
+hide_on_silent="Nascondi il grafico quando l'audio è silenzioso".
+
+normalize_volume="Normalizza volume".
+
+render_mode="Modalità di rendering".
+line="Linea"
+solid="Solido"
+gradient="Gradiente"
+
+width="Larghezza spettro"
+height="Altezza spettro"
+
+log_scale="Scala frequenza logaritmica"
+
+radial_layout="Spettro rotondo".
+invert_direction="Inverti direzione radiale"
+deadzone="Zona morta"
+
+rounded_caps="Tappi arrotondati".
+
+window="Finestra"
+hann="Hann"
+hamming="Hamming"
+blackman="Blackman"
+blackman_harris="Blackman-Harris"
+
+auto_fft_size="Dimensione FFT automatica"
+fft_size="Dimensione FFT".
+
+channel_mode="Modalità canale"
+mono="Mono"
+stereo="Stereo"
+
+channel_spacing="Spaziatura tra i canali".
+
+interp_mode="Interpolazione"
+point="Molto vicini"
+lanczos="Lanczos"
+
+filter_mode="Filtro"
+filter_radius="Raggio del filtro".
+gauss="Gaussiana"
+
+cutoff_low="Taglio bassi"
+cutoff_high="Taglio alti"
+
+floor="Onda bassa"
+ceiling="Onda alta"
+
+slope="Pendenza"
+
+rolloff_q="Larghezza di banda di roll-off (ottave)".
+rolloff_rate="Velocità di roll-off (dB/Ottava)".
+
+gravity="Gravità"
+temporal_smoothing="Attenuazione temporale".
+exp_moving_avg="Media mobile esponenziale".
+fast_peaks="Picchi veloci".
+
+color_base="Colore di base"
+color_crest="Colore della cresta".
+grad_ratio="Rapporto gradiente".
+
+display_mode="Modalità di visualizzazione"
+curve="Curva"
+bars="Barre"
+stepped_bars="Barre a gradini".
+level_meter="Misuratore di livello"
+stepped_level_meter="Misuratore di livello a gradini".
+
+rms_mode="Modo RMS"
+meter_buf="Buffer del misuratore"
+
+bar_width="Larghezza barra"
+bar_gap="Intervallo barra"
+step_width="Larghezza passo"
+step_gap="Spazio tra i passi".
+
+chan_desc="Grafico canali L/R separati o singolo canale sommato".
+auto_fft_desc="Calcola le dimensioni della FFT in base a FPS e frequenza di campionamento."
+fft_desc="Valori più grandi aumentano la risoluzione della frequenza, ma sono più intensivi per la CPU e aumentano la latenza."
+window_desc="Funzione finestra FFT".
+temporal_desc="Smussamento nel dominio del tempo dei bins di frequenza. Riduce il jitter".
+gravity_desc="Controlla la velocità di risposta del grafico ai nuovi input."
+fast_peaks_desc="I bins di frequenza rispondono istantaneamente agli aumenti di magnitudine (utile con la media mobile lenta)."
+interp_desc="Ricampionamento dei bins di frequenza."
+filter_desc="Smussamento geometrico".
+slope_desc="Aumenta le alte frequenze".
+deadzone_desc="Quantità di spazio da lasciare vuoto al centro di un layout radiale."
+caps_desc="Arrotonda la parte superiore e inferiore di ogni barra".
+rolloff_q_desc="Arrotonda i bordi del grafico a partire da N ottave dai punti di taglio."
+rolloff_rate_desc="Tasso di attenuazione ai bordi in decibel per ottava".
+volume_normalization_desc="Scala dinamicamente il grafico per compensare le variazioni di volume."

src/aligned_buffer.hpp

@@ -0,0 +1,80 @@
+/*
+    Copyright (C) 2023 Devin Davila
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU 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 General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+#include "waveform_config.hpp"
+#include <cstddef>
+#include <type_traits>
+#include <memory>
+#include <new>
+
+// RAII uninitialized memory buffer with suitable alignment
+// for data processing on the target architecture.
+// 32-byte aligned on x86 with SIMD enabled,
+// otherwise default alignment of operator new.
+
+template<typename T>
+class AlignedBuffer
+{
+public:
+    static_assert(std::is_trivial_v<T>, "Only trivial types are supported");
+    AlignedBuffer() = default;
+    AlignedBuffer(const AlignedBuffer&) = delete;
+    AlignedBuffer& operator=(const AlignedBuffer&) = delete;
+    AlignedBuffer(AlignedBuffer&&) = default;
+    AlignedBuffer& operator=(AlignedBuffer&&) = default;
+    ~AlignedBuffer() = default;
+
+    T& operator[](std::size_t i) const { return m_buf[i]; }
+    T *get() const noexcept { return m_buf.get(); }
+    explicit operator bool() const noexcept { return static_cast<bool>(m_buf); }
+
+    void reset() { m_buf.reset(); }
+    void reset(std::size_t count) { m_buf.reset(alloc(count)); }
+
+private:
+#ifndef DISABLE_X86_SIMD
+    static constexpr std::size_t ALIGNMENT = ((alignof(T) > 32u) ? alignof(T) : 32u);
+#else
+    static constexpr std::size_t ALIGNMENT = alignof(T);
+#endif // !DISABLE_X86_SIMD
+
+    T *alloc(std::size_t count)
+    {
+        if constexpr (ALIGNMENT > __STDCPP_DEFAULT_NEW_ALIGNMENT__)
+            return static_cast<T*>(::operator new(sizeof(T) * count, std::align_val_t{ ALIGNMENT }));
+        else
+            return static_cast<T*>(::operator new(sizeof(T) * count));
+    }
+
+    class Deleter
+    {
+    public:
+        void operator()(void *p)
+        {
+            if constexpr (ALIGNMENT > __STDCPP_DEFAULT_NEW_ALIGNMENT__)
+                ::operator delete(p, std::align_val_t{ ALIGNMENT });
+            else
+                ::operator delete(p);
+        }
+    };
+
+    friend bool operator==(const AlignedBuffer& a, std::nullptr_t) { return a.m_buf == nullptr; }
+    friend bool operator!=(const AlignedBuffer& a, std::nullptr_t) { return a.m_buf != nullptr; }
+
+    std::unique_ptr<T[], Deleter> m_buf;
+};