ITAVariableDelayLine.cpp 16 KB
Newer Older
1
2
3
4
5
6
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
#include <ITAVariableDelayLine.h>

#include <ITAInterpolation.h>
#include <ITAFastMath.h>
#include <ITANumericUtils.h>
#include <ITASampleBuffer.h>
#include <ITAStringUtils.h>
#include <ITAConstants.h>
#include <ITADebug.h>

#include <spline.h>

#include <cassert>
#include <cmath>
#include <iostream>


// Interpolation resampling factor range (otherwise crossfading is used)
#define MIN_RESAMPLING_FACTOR 0.0f // [0, inf) ... aber sinnvoll z.B. 0, 0.1, 0.5 (< 1)
#define MAX_RESAMPLING_FACTOR 25.0f // [0, inf) ... aber sinnvoll z.B. 1, 1.5, 2, 3 (> 1)


// --= VDL =--

CITAVariableDelayLine::CITAVariableDelayLine( double dSamplerate,
	int iBlocklength,
	float fReservedMaxDelaySamples,
	int iAlgorithm )
	: m_dSampleRate( dSamplerate ),
	m_iBlockLength( iBlocklength ),
	m_iSwitchingAlgorithm( iAlgorithm ),
	m_psbVDLBuffer( nullptr ),
	m_psbTemp( nullptr ),
	m_bFracDelays( false ),
	m_pInterpolationRoutine( nullptr )
{
	assert( dSamplerate > 0 );
	assert( iBlocklength > 0 );

	// Define size of temp buffer depending on maximum oversampling factor
	int iTempBufferBlockLength = ( ( int ) ceil( MAX_RESAMPLING_FACTOR ) + 1 )*m_iBlockLength;
	m_psbTemp = new ITASampleBuffer( iTempBufferBlockLength, true );

	ReserveMaximumDelaySamples( fReservedMaxDelaySamples );

	m_iFadeLength = std::min( m_iBlockLength, 32 );

	if( m_iSwitchingAlgorithm == LINEAR_INTERPOLATION )
		m_pInterpolationRoutine = new CITASampleLinearInterpolation();

	if( m_iSwitchingAlgorithm == CUBIC_SPLINE_INTERPOLATION )
		m_pInterpolationRoutine = new CITASampleCubicSplineInterpolation();

	if( m_iSwitchingAlgorithm == WINDOWED_SINC_INTERPOLATION )
		m_pInterpolationRoutine = new CITASampleWindowedSincInterpolation();

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
57
#if (ITA_DSP_VDL_DATA_LOG == 1)
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
	m_oDataLog.setOutputFile("VDL.log");
#endif

	Clear();
}

void CITAVariableDelayLine::Clear() {
	m_psbVDLBuffer->Zero();
	m_psbTemp->Zero();

	m_iWriteCursor = 0;
	m_fCurrentDelay = 0;
	m_fNewDelay = 0;
	m_bStarted = false;

	m_swProcess.reset();
	m_swBufferSizeInc.reset();
	m_iNumberOfDropouts = 0;
}

CITAVariableDelayLine::~CITAVariableDelayLine()
{
	delete m_psbVDLBuffer;
	delete m_psbTemp;

	std::string sAddition = "";
	if( m_iSwitchingAlgorithm == SWITCH )
		sAddition = "(Switching)";
	else if( m_iSwitchingAlgorithm == CROSSFADE )
		sAddition = "(Crossfading)";
	else
		sAddition = "(" + m_pInterpolationRoutine->GetName() + ")";

	delete m_pInterpolationRoutine;

	if( m_swProcess.cycles() > 0 )
	{
		DEBUG_PRINTF( " * [VDL] Process time monitor: avg=%.2f us max=%.2f us stddev=%.2f us, dropouts=%i %s\n", m_swProcess.mean()*1e6, m_swProcess.maximum()*1e6, m_swProcess.std_deviation()*1e6, m_iNumberOfDropouts, sAddition.c_str() );
	}
}

int CITAVariableDelayLine::GetAlgorithm() const {
	return m_iSwitchingAlgorithm;
}

void CITAVariableDelayLine::SetAlgorithm( int iAlgorithm ) {
	m_iSwitchingAlgorithm = iAlgorithm;
}

float CITAVariableDelayLine::GetReservedMaximumDelaySamples() const {
	return ( float ) ( m_iVDLBufferSize - m_iBlockLength );
}

float CITAVariableDelayLine::GetReservedMaximumDelayTime() const {
	return GetReservedMaximumDelaySamples() / ( float ) m_dSampleRate;
}

int CITAVariableDelayLine::GetMinimumDelaySamples() const
{
	if( !m_pInterpolationRoutine )
		return 0;

	int iLeft, iRight;
	m_pInterpolationRoutine->GetOverlapSamples( iLeft, iRight );

	return ( iLeft + iRight );
}

float CITAVariableDelayLine::GetMinimumDelayTime() const
{
	return GetMinimumDelaySamples() / ( float ) m_dSampleRate;
}

void CITAVariableDelayLine::ReserveMaximumDelaySamples( float fMaxDelaySamples )
{
	// Festlegung: Die Methode darf nicht parallel betreten werden (non-reentrant)

	assert( fMaxDelaySamples >= 0 ); // Verzgerung immer positiv

	// Anzahl Pufferblcke bestimmen
	int iNewBufferSize = uprmul( ( int ) ceil( fMaxDelaySamples ), m_iBlockLength );

	assert( iNewBufferSize > 0 ); // Puffer muss eine Gre haben

	if( !m_psbVDLBuffer )
	{

		/*
		 *  Erste Initalisierung des Puffers
		 *  Hinweis: Hier ist keine Synchronisierung erforderlich, da dieser Ast
		 *  nur durch den Konstruktor aufgerufen wird
		 */

		m_psbVDLBuffer = new ITASampleBuffer( iNewBufferSize, true );
		m_iVDLBufferSize = iNewBufferSize;
		m_iWriteCursor = 0;

	}
	else
	{

		// Puffer schon gross genug => Nichts tun...
		if( m_psbVDLBuffer->length() >= iNewBufferSize ) return;

		m_swBufferSizeInc.start();

		assert( m_psbVDLBuffer->length() >= 0 ); // VDL-Pufferlnge muss eine Gre haben

		m_csBuffer.enter();


		// Alte Puffergre sichern
		int iOldBufferSize = m_psbVDLBuffer->length();

		// Vorhandene Daten zyklisch Kopieren (aktuelle Schreibposition => Anfang abrollen)
		ITASampleBuffer* psbNewBuffer = new ITASampleBuffer( iNewBufferSize, true );
		psbNewBuffer->cyclic_write( m_psbVDLBuffer, iNewBufferSize, m_iWriteCursor, 0 );

		// Alten Puffer freigeben, neuen zuweisen
		delete m_psbVDLBuffer;
		m_psbVDLBuffer = psbNewBuffer;
		m_iVDLBufferSize = iNewBufferSize;
		m_iWriteCursor = iOldBufferSize; // Hinten anhngend weiterschreiben

		m_csBuffer.leave();

		double t = m_swBufferSizeInc.stop() * 1e6;
		std::cout << "VairableDelayLine: Buffer increment from " << iOldBufferSize << " samples to " << iNewBufferSize << " samples requested, took " << timeToString( t );
	}
}

void CITAVariableDelayLine::ReserveMaximumDelayTime( float fMaxDelaySecs )
{
	ReserveMaximumDelaySamples( fMaxDelaySecs * ( float ) m_dSampleRate );
}

bool CITAVariableDelayLine::GetFractionalDelaysEnabled() const {
	return m_bFracDelays;
}

void CITAVariableDelayLine::SetFractionalDelaysEnabled( bool bEnabled )
{
	m_bFracDelays = bEnabled;
}

float CITAVariableDelayLine::GetDelaySamples() const
{
	// Um Konsistenz zu wahren geben wir immer den
	// neuen Verzgerungswert zurck, da es sein kann,
	// dass Getter und Setter fr den Delay mehrmals benutzt werden,
	// ohne dass im Process() Schritt der neue Wert als Aktueller
	// bernommen wurde.
	if( m_fCurrentDelay == m_fNewDelay )
		return m_fCurrentDelay;
	else
		return m_fNewDelay;
}

float CITAVariableDelayLine::GetDelaySamples( int& iIntegerDelay, float& fFractionalDelay ) const
{
	// Lokale Kopie der Verzgerung
	float fDelay = GetDelaySamples();

	iIntegerDelay = ( int ) floor( fDelay );
	fFractionalDelay = fDelay - ( float ) iIntegerDelay;
	return fDelay;
}

void CITAVariableDelayLine::SetDelaySamples( float fDelaySamples )
{
	assert( fDelaySamples >= 0 ); // Verzgerung immer positiv

	// Internen Puffer vergrern
	/* Erfordert die neuen Verzgerung auch eine Puffer-Vergrerung,
	 * ist es wahrscheinlich, dass bald erneut eine Vergrerung ntig ist.
	 * Dies ist teuer, deshalb erzwingen wird hier direkt eine deutliche
	 * Vergrerung.
	 */
	if( m_iVDLBufferSize - m_iBlockLength < ceil( fDelaySamples ) )
		ReserveMaximumDelaySamples( ceil( fDelaySamples ) * 2 );

	// Neuen Wert nicht einfach bernehmen, sondern der
	// Process()-Routine berlassen
	m_fNewDelay = fDelaySamples;

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
243
	//DEBUG_PRINTF(" * [VDL] Delay set to %.3f samples\n", fDelaySamples);
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

	// Falls das Streaming noch nicht gestartet ist sofort die
	// neue Verzgerung bernehmen, sonst wird im ersten Block
	// gleich von 0 auf fDelaySamples umgesetzt und bei
	// Crossfading und Interpolieren gibts unerwnschte Effekte
	if( !m_bStarted )
		m_fCurrentDelay = m_fNewDelay;
}

void CITAVariableDelayLine::SetDelayTime( float fDelaySecs )
{
	SetDelaySamples( fDelaySecs * ( float ) m_dSampleRate );
}

void CITAVariableDelayLine::Process( const ITASampleBuffer* psbInput, ITASampleBuffer* psbOutput )
{
	m_swProcess.start();

	// Start-Flag setzen
	if( !m_bStarted ) m_bStarted = true;

	assert( m_iWriteCursor % m_iBlockLength == 0 ); // Schreibcursor immer Vielfaches der Blocklnge

	// Neue Daten in den VDL-Puffer schreiben
	m_psbVDLBuffer->write( psbInput, m_iBlockLength, 0, m_iWriteCursor );

	// Lokale Kopie des gewnschten Algorithmus (Atomare Membervariable)
	int iAlgorithm = m_iSwitchingAlgorithm;

	// Lokale Kopie der neuen Verzgerung
	float fCurrentDelay = m_fCurrentDelay;
	float fNewDelay = m_fNewDelay;

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
277
#if (ITA_DSP_VDL_DATA_LOG == 1)
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
	VDLLogData oLogDataItem;
	oLogDataItem.fCurrentDelay = fCurrentDelay;
	oLogDataItem.fNewDelay = m_fNewDelay;
	oLogDataItem.fResamplingFactor = 1;
	oLogDataItem.iTargetBlockSize = m_iBlockLength;
#endif

	// --= Keine nderung der Verzgerung (fr rasant schnelle statische Szenen) =--

	if( fNewDelay == fCurrentDelay ) {
		// Keine nderung der Verzgerung. Einfach Anfang der VDL in den Ausgang kopieren.
		int iReadCursor = ( m_iWriteCursor + m_iVDLBufferSize - ( int ) ceil( fCurrentDelay ) ) % m_iVDLBufferSize;
		psbOutput->cyclic_write( m_psbVDLBuffer, m_iBlockLength, iReadCursor, 0 );

		// Schreibzeiger um Blocklnge vergrern (BlockPointerIncrement)
		m_iWriteCursor = ( m_iWriteCursor + m_iBlockLength ) % m_iVDLBufferSize;

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
295
#if (ITA_DSP_VDL_DATA_LOG == 1)
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
		oLogDataItem.fProcessingTime = (float) (m_swProcess.stop()*1.0e6);
		m_oDataLog.log(oLogDataItem);
#endif

		return;
	}


	// --= nderung der Verzgerung =--

	// Zerlegen in Ganzzahl und Kommazahl
	int iCurrentIntDelay = ( int ) ceil( fCurrentDelay );
	float fCurrentFracDelay = ( float ) iCurrentIntDelay - fCurrentDelay;
	assert( fCurrentFracDelay >= 0.0f );  // Subsample darf nicht negativ sein
	int iNewIntDelay = ( int ) ceil( fNewDelay );
	float fNewFracDelay = ( float ) iNewIntDelay - fNewDelay;
	assert( fNewFracDelay >= 0.0f ); // Subsample darf nicht negativ sein
	int iDeltaDelay = iNewIntDelay - iCurrentIntDelay;

	// Falls Interpolation gewnscht ist, Grenzen prfen
	if( ( iAlgorithm == LINEAR_INTERPOLATION ) ||
		( iAlgorithm == WINDOWED_SINC_INTERPOLATION ) ||
		( iAlgorithm == CUBIC_SPLINE_INTERPOLATION ) )
	{

		/*
		 * Folgendes Problem kann bei der Abstandsverkleinerung auftreten:
		 * Ist die Abstandsverkleinerung zu schnell, werden Frequenzen so stark gestaucht,
		 * dass sie ber die Nyquist-Grenze der Soundkarte hinaus wandern (22.05 kHz) und
		 * bei der Abtastung zu Alias-Fehlern fhren. Es muss hierfr das Eingangssignal
		 * entsprechend tiefpass gefiltert werden. Eine synchrone Abtastratenerhhung
		 * kann auch sinnvoll sein. Diese muss nach der Interpolation erneut tp-gefiltert
		 * und entsprechend runtergesetzt werden.
		 *
		 * Folgendes Problem kann bei der Abstandsvergrerung auftreten:
		 * Ist die Abstandsvergrerung sehr schnell, werden im Grenzfall lediglich
		 * einige Sttzsamples zur Interpolation vieler Ausgangssamples genutzt,
		 * aber ein systembedingte Grenze existiert bis zur Schallgeschwindigkeit
		 * nicht.
		 *
		 * Kann die Interpolation die entsprechenden Frequenzen nicht nachbilden,
		 * treten Verzerrungen auf, bei der Linearinterpolation nicht-lineare Ver-
		 * zerrungen. Diese Fehler Verstrken sich zunehmend.
		 *
		 */

		// Resamplingfaktor auf dem Eingangsstream bezogen auf eine Blocklnge berechnen
		float fResamplingFactor = 1 - iDeltaDelay / ( float ) m_iBlockLength;

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
345
#if (ITA_DSP_VDL_DATA_LOG == 1)
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
		oLogDataItem.fResamplingFactor = fResamplingFactor;
#endif

		// Wenn Voraussetzungen verletzt werden, fr diesen Bearbeitungsschritt auf weiches Umschalten wechseln
		if( ( fResamplingFactor <= MIN_RESAMPLING_FACTOR ) || ( fResamplingFactor > MAX_RESAMPLING_FACTOR ) )
		{
			iAlgorithm = CROSSFADE;
			std::cout << "VariableDelayLine: Forced crossfading, because resampling factor is out of bounds: r=" << fResamplingFactor << "( min = " << MIN_RESAMPLING_FACTOR << ", max = " << MAX_RESAMPLING_FACTOR << " )";
		}
	}


	// --= Lesekpfe =--

	// VDL-Puffergre wird nur addiert, damit
	int iReadCursorCurrent = ( m_iWriteCursor - iCurrentIntDelay + m_iVDLBufferSize ) % m_iVDLBufferSize;
	int iReadCursorNew = ( m_iWriteCursor - iNewIntDelay + m_iVDLBufferSize ) % m_iVDLBufferSize;
	assert( iReadCursorCurrent >= 0 ); // Cursor darf nicht negativ sein
	assert( iReadCursorNew >= 0 ); // Cursor darf nicht negativ sein


	// --= Umschaltverfahren =--

	// TODO:  - vermutlich sehen die Rmpfe fr jede andere Interpolation hnlich aus, sodass man mit getOverlap() vereinheitlichen kann. 
	//			(LinInterp schon fertig, aber erst Erfahrungen mit den anderen Verfahren sammeln...)

	int iSize;
	int iLeft, iRight; // berlappung an den Grenzen
	switch( iAlgorithm )
	{

		// o Hartes Umschalten
	case SWITCH:
		// Direkt neue Verzgerung nehmen. Einfach kopieren. Keine Rcksicht nehmen.
		psbOutput->cyclic_write( m_psbVDLBuffer, m_iBlockLength, iReadCursorNew, 0 );

		break;

		// o Umschalten mittels Kreuzblende
	case CROSSFADE:
		// Kreuzblende mittels temporrem Puffer
		assert( m_iFadeLength <= m_psbTemp->length() ); // Zu groe Blende fr diesen Puffer
		m_psbTemp->cyclic_write( m_psbVDLBuffer, m_iFadeLength, iReadCursorCurrent, 0 );
		psbOutput->cyclic_write( m_psbVDLBuffer, m_iBlockLength, iReadCursorNew, 0 );

		psbOutput->Crossfade( m_psbTemp, 0, m_iFadeLength, ITASampleBuffer::CROSSFADE_FROM_SOURCE, ITASampleBuffer::COSINE_SQUARE );

		break;


		// o Umschalten durch Stauchen oder Strecken: Lineare Interpolation, Kubische Spline-Interpolation oder gefensterte Sinc-Interpolation
	default:

		/* Zur Erklrung:

			Verringerung der Verzgerung => Samples stauchen
			(Size > Blocklength), "Zeit" muss eingeholt werden
			Resamplingfaktor > 1

			Vergrern der Verzgerung => Samples strecken
			(Size < Blocklength), "Zeit" muss gedehnt werden
			Resamplingfaktor < 1
			*/

		// berlappung an den Grenzen holen
		m_pInterpolationRoutine->GetOverlapSamples( iLeft, iRight );

		// Neuer Abstand
		if( iNewIntDelay < iLeft )
			iSize = m_iBlockLength; // Kausalitt erzwingen, wenn der Abstand kleiner als linker berlappbereich ist
		else
			iSize = iCurrentIntDelay - iNewIntDelay + m_iBlockLength;

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
419
#if (ITA_DSP_VDL_DATA_LOG == 1)
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
		oLogDataItem.iTargetBlockSize = iSize;
#endif

		// Sicherstellen, dass Daten des rechten berlappungsbereichs vorhanden sind
		// (VDL Puffer sollte immer mindestens eine Blocklnge grer sein als die
		//  aktuelle Verzgerung)
		assert( iLeft < m_iBlockLength ); // berlapp links bereits grer als Blocklnge
		assert( iRight < m_iBlockLength ); // berlapp rechts bereits grer als Blocklnge
		assert( m_iVDLBufferSize > iNewIntDelay + iRight ); // Neue Verzgerung und rechter berlapp grer als VDL Lnge

		// "Size" Daten plus berlappung aus dem Hauptpuffer vom momentanen Lesekopf an
		// den Anfang des Temporrpuffers kopieren
		assert( iLeft + iSize + iRight <= m_psbTemp->length() ); // iTempBufferBlockLength zu klein
		m_psbTemp->cyclic_write( m_psbVDLBuffer, iLeft + iSize + iRight, iReadCursorCurrent - iLeft, 0 );

		// Interpolieren: Temporrpuffer (Gre Size+Offset) --> Output (Gre Blocklnge)
		// Input Offset = iLeft -> effektive Inputlnge = iSize
		// iRight wird implizit durch die Interpolationsroutine verwendet, d.h.
		// bei iInputLength von iLeft+iSize wird auf weitere Daten zugegriffen, die 
		// rechts davon liegen und im Temporrpuffer vorhanden sein mssen!
		int iInputLength = iLeft + iSize;
		int iInputStartOffset = iLeft;
		m_pInterpolationRoutine->Interpolate( m_psbTemp, iInputLength, iInputStartOffset, psbOutput, m_iBlockLength );

		break;


	} // end case switch

	// Neue Verzgerung speichern
	m_fCurrentDelay = fNewDelay;

	// Schreibzeiger inkrementieren
	// (Hinweis: Der Schreibzeiger ist immer Vielfaches der Blocklnge)
	m_iWriteCursor = ( m_iWriteCursor + m_iBlockLength ) % m_iVDLBufferSize;

	// Zeitnahme
	double t = m_swProcess.stop();
	if( t > m_iBlockLength / m_dSampleRate )
	{
		DEBUG_PRINTF( " * [VDL] Overload, processing took %.2f ms\n", t*1e3 );
		m_iNumberOfDropouts++;
	}

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
464
#if (ITA_DSP_VDL_DATA_LOG == 1)
465
466
467
468
469
470
471
	oLogDataItem.fProcessingTime = (float) (t*1e6);
	m_oDataLog.log(oLogDataItem);
#endif

	return;
}

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
472
#if (ITA_DSP_VDL_DATA_LOG == 1)
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
std::ostream& CITAVariableDelayLine::VDLLogData::outputDesc(std::ostream& os)
{
	os	<< "Current delay" << "\t" 
		<< "New delay" << "\t" 
		<< "Resampling factor" << "\t" 
		<< "Target block size" << "\t" 
		<<  "Processing time [us]" <<  std::endl;
	return os; 
}

std::ostream& CITAVariableDelayLine::VDLLogData::outputData(std::ostream& os) const {
	os << fCurrentDelay << "\t" << fNewDelay << "\t" << fResamplingFactor << "\t" << iTargetBlockSize << "\t" << fProcessingTime << std::endl;
	return os; 
}
#endif

float CITAVariableDelayLine::GetDelayTime() const
{
	return m_fCurrentDelay;
}

float CITAVariableDelayLine::GetNewDelayTime() const
{
	return float( m_fNewDelay / m_dSampleRate );
}