Skip to content

GitLab

ITAConvolution
ITAConvolution
Commit 297ebd0d authored by Dipl.-Ing. Jonas Stienen's avatar Dipl.-Ing. Jonas Stienen
Browse files
Options

Renaming files (no DSMBC, now ITAUP -> uniform partitioned convolution)

parent 22d5121b
Hide whitespace changes
Inline Side-by-side
Showing with 127 additions and 1690 deletions
CMakeLists.txt
View file @ 297ebd0d
......@@ -5,6 +5,10 @@ project( ITAConvolution )
list( APPEND CMAKE_MODULE_PATH "$ENV{VISTA_CMAKE_COMMON}" )
include( VistaCommon )
if( NOT DEFINED ITA_CONVOLUTION_UPCONV_WITH_POWER_SAVER )
set( ITA_CONVOLUTION_UPCONV_WITH_POWER_SAVER ON CACHE BOOL "Use power saving mode for uniform partitioned convolution (do not convolve blocks with zeros)" )
endif( )
# dependencies
vista_use_package( ITABase REQUIRED FIND_DEPENDENCIES )
vista_use_package( ITAFFT REQUIRED FIND_DEPENDENCIES )
......@@ -16,20 +20,20 @@ include_directories( "include" )
# sources
set( ITAConvolutionHeader
include/DSMBCConvolver.h
include/DSMBCFilter.h
include/DSMBCFilterPool.h
include/DSMBCTrigger.h
include/ITAConvolution.h
include/ITAConvolutionDefinitions.h
"include/ITAUPConvolution.h"
"include/ITAUPFilter.h"
"include/ITAUPFilterPool.h"
"include/ITAUPTrigger.h"
"include/ITADirectConvolution.h"
"include/ITAConvolutionDefinitions.h"
)
set( ITAConvolutionSources
src/DSMBCConvolver.cpp
src/DSMBCFilter.cpp
src/DSMBCFilterPool.cpp
src/ITAConvolution.cpp
src/ITAConvolutionImpl.cpp
src/ITAConvolutionImpl.h
"src/ITAUPConvolution.cpp"
"src/ITAUPFilter.cpp"
"src/ITAUPFilterPool.cpp"
"src/ITADirectConvolution.cpp"
"src/ITADirectConvolutionImpl.cpp"
"src/ITADirectConvolutionImpl.h"
)
......@@ -47,6 +51,10 @@ if( NOT WIN32 )
add_definitions( -std=gnu++11)
endif( )
if( ITA_CONVOLUTION_UPCONV_WITH_POWER_SAVER )
add_definitions( -DITA_CONVOLUTION_UPCONV_WITH_POWER_SAVER )
endif( )
# linker
add_library( ITAConvolution ${ITAConvolutionHeader} ${ITAConvolutionSources} )
......
apps/ita_convoi/ita_convoi.cpp
View file @ 297ebd0d
......@@ -15,9 +15,9 @@
* ----------------------------------------------------------------
*
*/
#include <DSMBCConvolver.h>
#include <DSMBCFilter.h>
#include <DSMBCFilterPool.h>
#include <ITAUPConvolution.h>
#include <ITAUPFilter.h>
#include <ITAUPFilterPool.h>
#include <ITAFileDataSource.h>
#include <ITAPortaudioInterface.h>
......
include/DSMBCConvolver.h deleted 100644 → 0
View file @ 22d5121b
/*
* ----------------------------------------------------------------
*
* ITA core libs
* (c) Copyright Institute of Technical Acoustics (ITA)
* RWTH Aachen University, Germany, 2015-2017
*
* ----------------------------------------------------------------
* ____ __________ _______
* // / //__ ___/ // _ |
* // / // / // /_| |
* // / // / // ___ |
* //__/ //__/ //__/ |__|
*
* ----------------------------------------------------------------
*
*/
#ifndef INCLUDE_WATCHER_DSMBC_CONVOLVER
#define INCLUDE_WATCHER_DSMBC_CONVOLVER
#include <ITAConvolutionDefinitions.h>
#include <ITACriticalSection.h>
#include <ITAUncopyable.h>
#include <vector>
#include <tbb/concurrent_queue.h>
#include <DSMBCTrigger.h>
#include <atomic>
// Vorwürtsdeklarationen
class DSMBCFilter;
class DSMBCFilterPool;
class ITAFFT;
/**
* Diese Klasse realisiert einen schnellen (einkanaligen) Falter (dynamic single-channel multi-block convolver),
* welcher die effiziente Overlap-Save Blockfaltung zusammen mit einer frequency-domain delay-line (FDL)
* benutzt um eine Impulsantwortet zu falten, welche in mehrere gleichlange Teile zerlegt wird.
* Dieser Ansatz ermüglicht eine wesentlich grüüere Leistung als ein einfacher Blockfaltungsansatz,
* bei welchem die komplette Impulsantwort mit einem Block gefaltet werden. Der Falter ist dynamisch,
* d.h. er erlaubt den Austausch der Filter zur Laufzeit bzw. Streamingzeit. Der Austausch der Filter
* geschieht entweder durch hartes Umschalten oder überblendung im Zeitbereich.
*
* Nebenlüufigkeit & Synchronisation:
*
* Folgende Methoden sind synchronisiert:
*
* - getFilterPool, setFilterPool, requestFilter, releaseFilter => Blocking aber leichtgewichtig, reentrant
* - getFilterExchangeMode, setFilterExchangeMode, getFilterCrossfadeLength, setFilterCrossfadeLength,
* getActiveFilter, exchangeFilter => Non-blocking und wait-free, reentrant
* - process => Non-blocking, wait-free aber NICHT REENTRANT (!!)
*
* Alle anderen Methoden sind nicht synchronisiert.
*
* Müchtest Du mehr zu den Details wissen? Frag mich! -> Frank.Wefers@akustik.rwth-aachen.de
*/
class ITA_CONVOLUTION_API DSMBCConvolver : public ITAUncopyable
{
public:
//! Austausch-Modi
enum
{
SWITCH = 0, //!< Hartes Umschalten
CROSSFADE_LINEAR, //!< Lineare Kreuzblende
CROSSFADE_COSINE_SQUARE //!< Cosinus-Quadrat Kreuzblende
};
//! Ausgabe-Modi
enum
{
OUTPUT_OVERWRITE = 0, //!< Daten im Ausgabepuffer mit neuen Daten überschreiben
OUTPUT_MIX, //!< Neue Daten in den Ausgabepuffer einmischen
};
static const int AUTO = -1;
//! Standard-Konstruktor
/**
* Erzeugt einen Falter der seinen eigenen Filterpool betreibt
*/
DSMBCConvolver();
//! Initialierungs-Konstruktor
/**
* Erzeugt einen Falter.
*
* \param iBlocklength Blocklänge [in Samples]
* \param iMaxFilterlength Maximale Filterlänge [Anzahl Filterkoeffizienten]
*/
DSMBCConvolver( const int iBlocklength, const int iMaxFilterlength, DSMBCFilterPool* pFilterPool = NULL );
//! Destruktor
virtual ~DSMBCConvolver();
//! Initialisieren
/**
* Initialisiert einen Falter.
*
* \param iBlocklength Blocklänge [in Samples]
* \param iMaxFilterlength Maximale Filterlänge [Anzahl Filterkoeffizienten]
*/
void init( const int iBlocklength, const int iFilterLength );
//! Blocklänge zurückgeben
int getBlocklength() const;
//! Maximale Filterlänge [Anzahl Filterkoeffizienten] zurückgeben
int getMaxFilterlength() const;
//! Trigger für den Filteraustausch zurückgeben (NULL falls keiner zugeordnet)
const DSMBCTrigger* getFilterExchangeTrigger() const;
//! Trigger für den Filteraustausch setzen
void setFilterExchangeTrigger( const DSMBCTrigger* pTrigger );
//! Filteraustausch-Modus zurückgeben
int getFilterExchangeMode();
//! Filteraustausch-Modus setzen
void setFilterExchangeMode( const int iMode );
//! überblendlänge [Samples] des Filteraustauschs zurückgeben
int getFilterCrossfadeLength();
//! überblendlänge [Samples] für den Filteraustausch setzen
void setFilterCrossfadeLength( const int iLength );
//! Verstärkung zurückgeben
float getGain() const;
//! Verstärkung setzen
// Hinweis: Falls bSetImmediately==true gesetzt, wird die Verstärkung nicht
// dynamisch angepasst, sondern hart auf den angegebenen Wert gesetzt.
void setGain( const float fGain, const bool bSetImmediately = false );
//! Filterpool zurückgeben
DSMBCFilterPool* getFilterPool() const;
//! Filterpool setzen
/**
* NULL => Falter-eigenen Pool benutzen
*/
void setFilterPool( DSMBCFilterPool* pFilterPool );
//! Freies Filter anfordern
DSMBCFilter* requestFilter();
//! Filter wieder zur anderweitigen Benutzung freigeben
void releaseFilter( DSMBCFilter* pFilter );
//! Aktives Filter zurückgeben
/**
* Das aktive Filter ist jenes, welches der Falter momentan benutzt.
*/
DSMBCFilter* getActiveFilter();
//! Filter austauschen
/**
* Hinweis: Nullzeiger => Aktives Filter entfernen
*/
void exchangeFilter( DSMBCFilter* pNewFilter, const int iExchangeMode = AUTO, const int iCrossfadeLength = AUTO );
//! Löscht alle internen Samplepuffer
void clear();
//! Faltungsmethode
/**
* Nimmt einen neuen Block Eingangsdaten entgegen und faltet ihn mit der Impulsantwortet.
* Das (partielle) Ausgangssignal wird als Block im Zielarray gespeichert.
*
* \param pfInputData Array der Eingangsdaten (Exakt soviele Elemente wie die Blocklänge ist)
* \param pfOutputData Array der Ausgangsdaten (Exakt soviele Elemente wie die Blocklänge ist)
* \param iOutputMode Ausgabemodus (überschreiben oder Einmischen)
*/
// TODO: Hier wird Austausch durchgeführt!
void process( const float* pfInputData, float* pfOutputData, const int iOutputMode = OUTPUT_OVERWRITE );
//! Faltungsmethode (Erweitert)
/**
* Nimmt einen neuen Block Eingangsdaten entgegen und faltet ihn mit der Impulsantwortet.
* Das (partielle) Ausgangssignal wird als Block im Zielarray gespeichert.
*
* \param pfInputData Array der Eingangsdaten
* \param iInputLength Anzahl der Samples in den Eingangsdaten
* \param pfOutputData Array der Ausgangsdaten (Exakt soviele Elemente wie die Blocklänge ist)
* \param iOutputLength Anzahl der Samples in den Ausgabedaten
* \param iOutputMode Ausgabemodus (überschreiben oder Einmischen)
*/
void process( const float* pfInputData, const int iInputLength, float* pfOutputData, const int iOutputLength, const int iOutputMode = OUTPUT_OVERWRITE );
private:
typedef struct
{
DSMBCFilter* pFilter;
int iExchangeMode;
int iCrossfadeLength;
} FilterUpdate;
int m_iBlocklength;
int m_iMaxFilterlength;
std::atomic< int > m_iExchangeMode; // Austauschmodus
std::atomic< int > m_iCrossfadeLength; // überblendlänge
std::atomic< float > m_fCurrentGain; // Aktuelle Verstärkung
std::atomic< float > m_fNewGain; // Gewünschte Verstärkung
std::atomic< DSMBCFilter* > m_pCurrentFilter; // Aktives Filter
tbb::strict_ppl::concurrent_queue<FilterUpdate> m_qExchangeFilters; // Queue: Nächste Filter zum Austausch
float *m_pfTimeInputBuffer; // Eingangspuffer (Zeitbereich)
float *m_pfTimeOutputBuffer1; // Ausgangspuffer (Zeitbereich)
float *m_pfTimeOutputBuffer2; // Ausgangspuffer (Zeitbereich)
float *m_pfFreqAuxBuffer; // Hilfspuffer (Frequenz-bereich)
float *m_pfFreqMixdownBuffer; // Mischpuffer (Frequenz-bereich)
int m_iFreqCoeffs; // Anzahl DFT-Koeffizienten (Symetrien eingerechnet)
std::vector< float* > m_vpfFreqDelayLine; // Frequency-domain delay line (FDL)
ITAFFT *m_pFFT, *m_pIFFT; // FFT, IFFT der Daten
ITACriticalSection m_csPool; // Exklusiver Zugriff auf den Filterpool
DSMBCFilterPool* m_pCurrentPool; // Gesetzer Filterpool
DSMBCFilterPool* m_pOwnPool; // Falter-eigener Filterpool
DSMBCTriggerWatch m_oTriggerWatch; // TriggerWatch für den Filteraustausch
void copyOutputApplyGain1( float* pfDest, const float* pfSrc, const int iNumSamples, const int iOutputMode );
void copyOutputApplyGain2( float* pfDest, const float* pfSrc1, const float* pfSrc2, const int iOutputLength, const int iCrossfadeLength, const int iOutputMode );
};
#endif // INCLUDE_WATCHER_DSMBC_CONVOLVER
include/DSMBCFilter.h deleted 100644 → 0
View file @ 22d5121b
/*
* ----------------------------------------------------------------
*
* ITA core libs
* (c) Copyright Institute of Technical Acoustics (ITA)
* RWTH Aachen University, Germany, 2015-2017
*
* ----------------------------------------------------------------
* ____ __________ _______
* // / //__ ___/ // _ |
* // / // / // /_| |
* // / // / // ___ |
* //__/ //__/ //__/ |__|
*
* ----------------------------------------------------------------
*
*/
#ifndef INCLUDE_WATCHER_DSMBC_FILTER
#define INCLUDE_WATCHER_DSMBC_FILTER
#include <ITAConvolutionDefinitions.h>
#include <ITACriticalSection.h>
#include <ITATypes.h>
#include <ITAUncopyable.h>
#include <atomic>
#include <vector>
// Vorwärtsdeklarationen
class DSMBCFilterPool;
class ITAFFT;
/**
* Diese Klasse realisiert Filter (d.h. Representationen von Impulsantworten im Frequenzbereich)
* für DSMBCConvolver. Solche Filter haben einen Zustand: 1) unbenutzt oder 2) momentan in einem
* Falter in Benutzung. Generell kann 1 Filter in beliebig vielen Faltern verwendet werden.
* Seine Daten dürfen aber nur modifiziert werden, wenn es nicht in Benutzung ist.
*
* Eine neue Impulsantwort wird mittels der Methode load geladen und intern transformiert.
*
* Nebenläufigkeit & Synchronisation:
*
* Instanzen der Klasse sollen nur von einem Thread zu einer Zeit benutzt werden
* (üblicherweise der Thread der die Filterdaten generiert hat). Im Sinne der Anwendung
* macht es keinen Sinn das mehrere Threads um beispielsweise die load-Methode konkurrieren.
* Deshalb unternimmt die Klasse keine Maßnahmen zur Synchronisation.
*/
class ITA_CONVOLUTION_API DSMBCFilter : public ITAUncopyable {
public:
//! Konstruktor
DSMBCFilter(int iBlocklength, int iMaxFilterLength);
//! Destruktor
/**
* Hinweis: Das Objekt kann nur freigegeben werden, wenn es nicht mehr benutzt wird!
*/
virtual ~DSMBCFilter();
//! Gibt zurück ob der Filter aktuell in Benutzung ist
bool isInUse() const;
//! übergeordneten Filterpool zurückgeben (falls nicht vorhanden NULL)
DSMBCFilterPool* getParentFilterPool() const;
//! Filter übergeordneten Filterpool freigeben (falls Teil eines Filterpools)
void release();
//! Filterdaten laden
/**
* \param pfFilterData Array mit den Filterkoeffizienten
* \param iFilterLength Anzahl Filterkoeffizienten in pfFilterData (maximal iMaxFilterLength)
*
* \note Falls das Filter in Benutzung ist wird eine ITAException geworfen!
*/
void load(const float* pfFilterData, int iFilterLength);
//! Nullen setzen
void zeros();
//! Einheitsimpuls (Dirac) setzen
void identity();
//private:
// Interne Zustandklasse, welche Referenzzähler enthält.
// Es werden immer zwei Zähler benötigt: Prep und Use.
class State {
public:
State(DSMBCFilter* pParent);
bool isInUse() const;
void addPrep();
void removePrep();
void xchangePrep2Use();
void removeUse();
//private:
// Damit auf älteren Windows-System, welche keine DCAS-Operationen bereistellen,
// dieser zwei-elementige Zustand atomar verändert werden kann,
// muss eine Datenstruktur von 32-Bit realisiert werden.
// 16-Bit für die Zähler ist immer noch ausreichend
typedef struct
{
std::atomic< int16_t > iPrepRefCount;
std::atomic< int16_t > iUseRefCount;
} StateStruct;
DSMBCFilter* m_pParent;
StateStruct m_oState;
void modifyState(int16_t iPrepDelta, int16_t iUseDelta);
};
DSMBCFilterPool* m_pParent; // Übergeordneter Filterpool
int m_iBlocklength; // Blocklänge (Zeitbereich)
int m_iNumFilterParts; // Anzahl Filterteile
int m_iNumEffectiveFilterParts; // Anzahl effektiver Filterteile mit Filterkoeff. != 0
std::vector<float*> m_vpfFreqData; // Filterdaten im Frequenzbereich (DFT-Spektren der Teile)
ITAFFT* m_pFFT;
ITACriticalSection m_csReentrance; // Reentrance-Lock für die Load-Methode
State m_oState; // Zustand
friend class DSMBCConvolver;
friend class DSMBCFilterPool;
};
#endif // INCLUDE_WATCHER_DSMBC_FILTER
include/DSMBCFilterPool.h deleted 100644 → 0
View file @ 22d5121b
/*
* ----------------------------------------------------------------
*
* ITA core libs
* (c) Copyright Institute of Technical Acoustics (ITA)
* RWTH Aachen University, Germany, 2015-2017
*
* ----------------------------------------------------------------
* ____ __________ _______
* // / //__ ___/ // _ |
* // / // / // /_| |
* // / // / // ___ |
* //__/ //__/ //__/ |__|
*
* ----------------------------------------------------------------
*
*/
#ifndef INCLUDE_WATCHER_DSMBC_FILTER_POOL
#define INCLUDE_WATCHER_DSMBC_FILTER_POOL
#include <ITAConvolutionDefinitions.h>
#include <ITACriticalSection.h>
#include <ITAFFT.h>
#include <list>
// Vorwärtsdeklarationen
class DSMBCFilter;
/**
* Diese Klasse realisiert eine Verwalter für Filterobjekte und
* ermöglicht ein effizientes Filter-Management mit geringem Speicherverbrauch,
* durch die automatische Wiederverwendung von Filtern.
*
* Nebenläufigkeit & Synchronisation:
*
* Instanzen der Klasse können von beliebig vielen Threads gleichzeitig benutzt werden.
* Alle Methoden mittels synchronisiert und dürfen auch mehrfach parallel aufgerufen
* werden (reentrant). Die Synchronisation ist blocking, aber die Wartezeiten sind
* gering, da innerhalb des exklusiven Zugriffs nur kurze Operationen durchgeführt werden.
*
*/
class ITA_CONVOLUTION_API DSMBCFilterPool
{
public:
//! Konstruktor
DSMBCFilterPool(int iBlocklength, int iMaxFilterLength, int iInitialSize);
//! Destruktor
/**
* Hinweis: Das Objekt kann nur freigegeben werden, wenn es nicht mehr benutzt wird!
*/
virtual ~DSMBCFilterPool();
//! Blocklänge zurückgeben
int getBlocklength() const;
//! Maximale Filterlänge [Anzahl Filterkoeffizienten] zurückgeben
int getMaxFilterlength() const;
//! Anzahl freier Filter zurückgeben
int getNumFreeFilters() const;
//! Anzahl freier Filter zurückgeben
int getNumUsedFilters() const;
//! Anzahl freier Filter zurückgeben
int getNumTotalFilters() const;
//! Freies Filter anfordern
DSMBCFilter* requestFilter();
//! Filter wieder zur anderweitigen Benutzung freigeben
/**
* Ist das Filter nicht in Benutzung, so kann es sofort weiterbenutzt werden.
* Ist das Filter in Benutzung, so wird es für die Weiterbenutzung freigebenen,
* sobald es in einem Falter (DSMBCConvolver) nicht mehr in Benutzung ist
*/
void releaseFilter(DSMBCFilter* pFilter);
private:
int m_iBlocklength;
int m_iMaxFilterLength;
std::list<DSMBCFilter*> m_lpFreeFilters; // Unbenutzte (freie) Filter im Pool
std::list<DSMBCFilter*> m_lpUsedFilters; // Benutzte Filter im Pool
std::list<DSMBCFilter*> m_lpAutoFilters; // Filter welche nicht mehr seitens den Benutzers
// gebraucht werden, aber noch in einem Falter benutzt werden
ITACriticalSection m_csFilters; // Exklusiver Zugriff auf die Listen
};
#endif // INCLUDE_WATCHER_DSMBC_FILTER_POOL
\ No newline at end of file
include/DSMBCTrigger.h deleted 100644 → 0
View file @ 22d5121b
/*
* ----------------------------------------------------------------
*
* ITA core libs
* (c) Copyright Institute of Technical Acoustics (ITA)
* RWTH Aachen University, Germany, 2015-2017
*
* ----------------------------------------------------------------
* ____ __________ _______
* // / //__ ___/ // _ |
* // / // / // /_| |
* // / // / // ___ |
* //__/ //__/ //__/ |__|
*
* ----------------------------------------------------------------
*
*/
#ifndef INCLUDE_WATCHER_DSMBC_TRIGGER
#define INCLUDE_WATCHER_DSMBC_TRIGGER
#include <ITAConvolutionDefinitions.h>
#include <ITAUncopyable.h>
// Lightweight atomic trigger for synchronized filter exchanges
class ITA_CONVOLUTION_API DSMBCTrigger : public ITAUncopyable
{
public:
DSMBCTrigger() : m_iState(0) {};
// Returns the current state
int getState() const { return m_iState; };
// Pull the trigger. Update/alter the state.
void trigger() { ++m_iState; };
private:
volatile int m_iState;
};
// Simple watcher class, realization update checks on a trigger
class ITA_CONVOLUTION_API DSMBCTriggerWatch
{
public:
DSMBCTriggerWatch() : m_pTrigger(0), bFirst(true), m_iPrevTriggerState(0) {};
const DSMBCTrigger* getWatchedTrigger() const { return m_pTrigger; };
void setWatchedTrigger(const DSMBCTrigger* pNewTrigger) {
m_pTrigger = pNewTrigger;
bFirst = true;
};
// Logic: We always fire, if there is no trigger associated. This is needed in the convolver.
bool fire() {
if (!m_pTrigger) return true;
int iNewTriggerState = m_pTrigger->getState();
if ((iNewTriggerState != m_iPrevTriggerState) || bFirst) {
m_iPrevTriggerState = iNewTriggerState;
bFirst = false;
return true;
}
return false;
};
private:
const DSMBCTrigger* m_pTrigger;
bool bFirst;
int m_iPrevTriggerState;
};
#endif // INCLUDE_WATCHER_DSMBC_TRIGGER
include/ITAConvolution.h deleted 100644 → 0
View file @ 22d5121b
/*
* ----------------------------------------------------------------
*
* ITA core libs
* (c) Copyright Institute of Technical Acoustics (ITA)
* RWTH Aachen University, Germany, 2015-2017
*
* ----------------------------------------------------------------
* ____ __________ _______
* // / //__ ___/ // _ |
* // / // / // /_| |
* // / // / // ___ |
* //__/ //__/ //__/ |__|
*
* ----------------------------------------------------------------
*
*/
#ifndef INCLUDE_WATCHER_ITA_CONVOLUTION
#define INCLUDE_WATCHER_ITA_CONVOLUTION
#include <ITAConvolutionDefinitions.h>
#include <ITASampleBuffer.h>
#include <ITASampleFrame.h>
#include <ITAUncopyable.h>
// Vorwärtsdeklarationen
class ITAConvolutionImpl;
/**
* Diese Klasse definiert die Schnittstelle für schnelle (offline) Faltungen.
* Die Funktionalität besteht darin zwei Signale möglichst schnell und effizient
* miteinander zu falten. Die Eingaben und Ausgaben werden im Zeitbereich übergeben.