ITAUPFilterPool.h 2.87 KB
Newer Older
1
2
3
4
5
/*
 * ----------------------------------------------------------------
 *
 *		ITA core libs
 *		(c) Copyright Institute of Technical Acoustics (ITA)
Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
6
 *		RWTH Aachen University, Germany, 2015-2020
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 *
 * ----------------------------------------------------------------
 *				    ____  __________  _______
 *				   //  / //__   ___/ //  _   |
 *				  //  /    //  /    //  /_|  |
 *				 //  /    //  /    //  ___   |
 *				//__/    //__/    //__/   |__|
 *
 * ----------------------------------------------------------------
 *
 */

#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 ITAUPFilter;

/**
 * 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 ITAUPFilterPool
{
public:
	//! Konstruktor
	ITAUPFilterPool( const int iBlocklength, const int iMaxFilterLength, const int iInitialSize );

	//! Destruktor
	/**
	 * Hinweis: Das Objekt kann nur freigegeben werden, wenn es nicht mehr benutzt wird!
	 */
	virtual ~ITAUPFilterPool();

	//! Blocklänge zurückgeben
58
	int GetBlocklength() const;
59
60

	//! Maximale Filterlänge [Anzahl Filterkoeffizienten] zurückgeben
61
	int GetMaxFilterlength() const;
62
63

	//! Anzahl freier Filter zurückgeben
64
	int GetNumFreeFilters() const;
65
66

	//! Anzahl freier Filter zurückgeben
67
	int GetNumUsedFilters() const;
68
69

	//! Anzahl freier Filter zurückgeben
70
	int GetNumTotalFilters() const;
71
72

	//! Freies Filter anfordern
73
	ITAUPFilter* RequestFilter();
74
75
76
77
78

	//! 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,
79
	 * sobald es in einem Falter (ITAUPConvolution) nicht mehr in Benutzung ist
80
	 */
81
	void ReleaseFilter( ITAUPFilter* pFilter );
82
83
84
85
86
87
88
89
90
91
92

private:
	int m_iBlocklength;
	int m_iMaxFilterLength;
	std::list<ITAUPFilter*> m_lpFreeFilters;		// Unbenutzte (freie) Filter im Pool
	std::list<ITAUPFilter*> m_lpUsedFilters;		// Benutzte Filter im Pool
	std::list<ITAUPFilter*> 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