1 /***************************************************************************
2 * Copyright (C) 2010 by Simon Andreas Eugster (simon.eu@gmail.com) *
3 * This file is part of kdenlive. See www.kdenlive.org. *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
9 ***************************************************************************/
13 #include "audiospectrum.h"
15 #include "kiss_fft/tools/kiss_fftr.h"
19 #include <QMouseEvent>
23 // (defined in the header file)
24 #ifdef DEBUG_AUDIOSPEC
28 // (defined in the header file)
29 #ifdef DETECT_OVERMODULATION
34 // Draw lines instead of single pixels.
35 // This is about 25 % faster, especially when enlarging the scope to e.g. 1680x1050 px.
36 #define AUDIOSPEC_LINES
38 #define MIN_DB_VALUE -120
39 #define MAX_FREQ_VALUE 96000
40 #define MIN_FREQ_VALUE 1000
41 #define ALPHA_MOVING_AVG 0.125
42 #define MAX_OVM_COLOR 0.7
44 AudioSpectrum::AudioSpectrum(QWidget *parent) :
45 AbstractAudioScopeWidget(true, parent),
50 #ifdef DEBUG_AUDIOSPEC
56 ui = new Ui::AudioSpectrum_UI;
60 m_aResetHz = new QAction(i18n("Reset maximum frequency to sampling rate"), this);
61 m_aTrackMouse = new QAction(i18n("Track mouse"), this);
62 m_aTrackMouse->setCheckable(true);
63 m_aShowMax = new QAction(i18n("Show maximum"), this);
64 m_aShowMax->setCheckable(true);
67 m_menu->addSeparator();
68 m_menu->addAction(m_aResetHz);
69 m_menu->addAction(m_aTrackMouse);
70 m_menu->addAction(m_aShowMax);
71 m_menu->removeAction(m_aRealtime);
74 ui->windowSize->addItem("256", QVariant(256));
75 ui->windowSize->addItem("512", QVariant(512));
76 ui->windowSize->addItem("1024", QVariant(1024));
77 ui->windowSize->addItem("2048", QVariant(2048));
79 ui->windowFunction->addItem(i18n("Rectangular window"), FFTTools::Window_Rect);
80 ui->windowFunction->addItem(i18n("Triangular window"), FFTTools::Window_Triangle);
81 ui->windowFunction->addItem(i18n("Hamming window"), FFTTools::Window_Hamming);
85 b &= connect(m_aResetHz, SIGNAL(triggered()), this, SLOT(slotResetMaxFreq()));
86 b &= connect(ui->windowFunction, SIGNAL(currentIndexChanged(int)), this, SLOT(forceUpdate()));
87 b &= connect(this, SIGNAL(signalMousePositionChanged()), this, SLOT(forceUpdateHUD()));
91 // Note: These strings are used in both Spectogram and AudioSpectrum. Ideally change both (if necessary) to reduce workload on translators
92 ui->labelFFTSize->setToolTip(i18n("The maximum window size is limited by the number of samples per frame."));
93 ui->windowSize->setToolTip(i18n("A bigger window improves the accuracy at the cost of computational power."));
94 ui->windowFunction->setToolTip(i18n("The rectangular window function is good for signals with equal signal strength (narrow peak), but creates more smearing. See Window function on Wikipedia."));
96 AbstractScopeWidget::init();
98 AudioSpectrum::~AudioSpectrum()
103 delete m_aTrackMouse;
107 void AudioSpectrum::readConfig()
109 AbstractScopeWidget::readConfig();
111 KSharedConfigPtr config = KGlobal::config();
112 KConfigGroup scopeConfig(config, AbstractScopeWidget::configName());
114 ui->windowSize->setCurrentIndex(scopeConfig.readEntry("windowSize", 0));
115 ui->windowFunction->setCurrentIndex(scopeConfig.readEntry("windowFunction", 0));
116 m_aTrackMouse->setChecked(scopeConfig.readEntry("trackMouse", true));
117 m_aShowMax->setChecked(scopeConfig.readEntry("showMax", true));
118 m_dBmax = scopeConfig.readEntry("dBmax", 0);
119 m_dBmin = scopeConfig.readEntry("dBmin", -70);
120 m_freqMax = scopeConfig.readEntry("freqMax", 0);
122 if (m_freqMax == 0) {
123 m_customFreq = false;
129 void AudioSpectrum::writeConfig()
131 KSharedConfigPtr config = KGlobal::config();
132 KConfigGroup scopeConfig(config, AbstractScopeWidget::configName());
134 scopeConfig.writeEntry("windowSize", ui->windowSize->currentIndex());
135 scopeConfig.writeEntry("windowFunction", ui->windowFunction->currentIndex());
136 scopeConfig.writeEntry("trackMouse", m_aTrackMouse->isChecked());
137 scopeConfig.writeEntry("showMax", m_aShowMax->isChecked());
138 scopeConfig.writeEntry("dBmax", m_dBmax);
139 scopeConfig.writeEntry("dBmin", m_dBmin);
141 scopeConfig.writeEntry("freqMax", m_freqMax);
143 scopeConfig.writeEntry("freqMax", 0);
149 QString AudioSpectrum::widgetName() const { return QString("AudioSpectrum"); }
150 bool AudioSpectrum::isBackgroundDependingOnInput() const { return false; }
151 bool AudioSpectrum::isScopeDependingOnInput() const { return true; }
152 bool AudioSpectrum::isHUDDependingOnInput() const { return false; }
154 QImage AudioSpectrum::renderBackground(uint) { return QImage(); }
156 QImage AudioSpectrum::renderAudioScope(uint, const QVector<int16_t> audioFrame, const int freq, const int num_channels,
157 const int num_samples, const int)
160 audioFrame.size() > 63
161 && m_innerScopeRect.width() > 0 && m_innerScopeRect.height() > 0 // <= 0 if widget is too small (resized by user)
164 m_freqMax = freq / 2;
167 QTime start = QTime::currentTime();
170 #ifdef DETECT_OVERMODULATION
171 bool overmodulated = false;
172 int overmodulateCount = 0;
174 for (int i = 0; i < audioFrame.size(); i++) {
176 audioFrame[i] == std::numeric_limits<int16_t>::max()
177 || audioFrame[i] == std::numeric_limits<int16_t>::min()) {
179 if (overmodulateCount > 3) {
180 overmodulated = true;
188 if (colorizeFactor > 0) {
189 colorizeFactor -= .08;
190 if (colorizeFactor < 0) {
198 // Determine the window size to use. It should be
199 // * not bigger than the number of samples actually available
201 int fftWindow = ui->windowSize->itemData(ui->windowSize->currentIndex()).toInt();
202 if (fftWindow > num_samples) {
203 fftWindow = num_samples;
205 if ((fftWindow & 1) == 1) {
209 // Show the window size used, for information
210 ui->labelFFTSizeNumber->setText(QVariant(fftWindow).toString());
213 // Get the spectral power distribution of the input samples,
214 // using the given window size and function
215 float freqSpectrum[fftWindow/2];
216 FFTTools::WindowType windowType = (FFTTools::WindowType) ui->windowFunction->itemData(ui->windowFunction->currentIndex()).toInt();
217 m_fftTools.fftNormalized(audioFrame, 0, num_channels, freqSpectrum, windowType, fftWindow, 0);
220 // Store the current FFT window (for the HUD) and run the interpolation
221 // for easy pixel-based dB value access
222 QVector<float> dbMap;
223 m_lastFFTLock.acquire();
224 m_lastFFT = QVector<float>(fftWindow/2);
225 memcpy(m_lastFFT.data(), &(freqSpectrum[0]), fftWindow/2 * sizeof(float));
227 uint right = ((float) m_freqMax)/(m_freq/2) * (m_lastFFT.size() - 1);
228 dbMap = FFTTools::interpolatePeakPreserving(m_lastFFT, m_innerScopeRect.width(), 0, right, -180);
229 m_lastFFTLock.release();
232 #ifdef DEBUG_AUDIOSPEC
233 QTime drawTime = QTime::currentTime();
237 QImage spectrum(m_scopeRect.size(), QImage::Format_ARGB32);
238 spectrum.fill(qRgba(0,0,0,0));
239 const uint w = m_innerScopeRect.width();
240 const uint h = m_innerScopeRect.height();
241 const uint leftDist = m_innerScopeRect.left() - m_scopeRect.left();
242 const uint topDist = m_innerScopeRect.top() - m_scopeRect.top();
243 QColor spectrumColor(AbstractScopeWidget::colDarkWhite);
246 #ifdef DETECT_OVERMODULATION
247 if (colorizeFactor > 0) {
248 QColor col = AbstractScopeWidget::colHighlightDark;
249 QColor spec = spectrumColor;
250 float f = std::sin(M_PI_2 * colorizeFactor);
251 spectrumColor = QColor(
252 (int) (f * col.red() + (1-f) * spec.red()),
253 (int) (f * col.green() + (1-f) * spec.green()),
254 (int) (f * col.blue() + (1-f) * spec.blue()),
257 // Limit the maximum colorization for non-overmodulated frames to better
258 // recognize consecutively overmodulated frames
259 if (colorizeFactor > MAX_OVM_COLOR) {
260 colorizeFactor = MAX_OVM_COLOR;
265 #ifdef AUDIOSPEC_LINES
266 QPainter davinci(&spectrum);
267 davinci.setPen(QPen(QBrush(spectrumColor.rgba()), 1, Qt::SolidLine));
270 for (uint i = 0; i < w; i++) {
271 yMax = (dbMap[i] - m_dBmin) / (m_dBmax-m_dBmin) * (h-1);
274 } else if (yMax >= (int)h) {
277 #ifdef AUDIOSPEC_LINES
278 davinci.drawLine(leftDist + i, topDist + h-1, leftDist + i, topDist + h-1 - yMax);
280 for (int y = 0; y < yMax && y < (int)h; y++) {
281 spectrum.setPixel(leftDist + i, topDist + h-y-1, spectrumColor.rgba());
286 // Calculate the peak values. Use the new value if it is bigger, otherwise adapt to lower
287 // values using the Moving Average formula
288 if (m_aShowMax->isChecked()) {
289 davinci.setPen(QPen(QBrush(AbstractScopeWidget::colHighlightLight), 2));
290 if (m_peaks.size() != fftWindow/2) {
291 m_peaks = QVector<float>(m_lastFFT);
293 for (int i = 0; i < fftWindow/2; i++) {
294 if (m_lastFFT[i] > m_peaks[i]) {
295 m_peaks[i] = m_lastFFT[i];
297 m_peaks[i] = ALPHA_MOVING_AVG * m_lastFFT[i] + (1-ALPHA_MOVING_AVG) * m_peaks[i];
302 m_peakMap = FFTTools::interpolatePeakPreserving(m_peaks, m_innerScopeRect.width(), 0, right, -180);
303 for (uint i = 0; i < w; i++) {
304 yMax = (m_peakMap[i] - m_dBmin) / (m_dBmax-m_dBmin) * (h-1);
307 } else if (yMax >= (int)h) {
311 davinci.drawLine(leftDist + i-1, topDist + h-prev-1, leftDist + i, topDist + h-yMax-1);
312 spectrum.setPixel(leftDist + i, topDist + h-yMax-1, AbstractScopeWidget::colHighlightLight.rgba());
317 #ifdef DEBUG_AUDIOSPEC
319 m_timeTotal += drawTime.elapsed();
320 qDebug() << widgetName() << " took " << drawTime.elapsed() << " ms for drawing. Average: " << ((float)m_timeTotal/m_showTotal) ;
323 emit signalScopeRenderingFinished(start.elapsed(), 1);
328 emit signalScopeRenderingFinished(0, 1);
332 QImage AudioSpectrum::renderHUD(uint)
334 QTime start = QTime::currentTime();
336 if (m_innerScopeRect.height() > 0 && m_innerScopeRect.width() > 0) { // May be below 0 if widget is too small
338 // Minimum distance between two lines
339 const uint minDistY = 30;
340 const uint minDistX = 40;
341 const uint textDistX = 10;
342 const uint textDistY = 25;
343 const uint topDist = m_innerScopeRect.top() - m_scopeRect.top();
344 const uint leftDist = m_innerScopeRect.left() - m_scopeRect.left();
345 const uint dbDiff = ceil((float)minDistY/m_innerScopeRect.height() * (m_dBmax-m_dBmin));
346 const int mouseX = m_mousePos.x() - m_innerScopeRect.left();
347 const int mouseY = m_mousePos.y() - m_innerScopeRect.top();
350 QImage hud(m_scopeRect.size(), QImage::Format_ARGB32);
351 hud.fill(qRgba(0,0,0,0));
353 QPainter davinci(&hud);
354 davinci.setPen(AbstractScopeWidget::penLight);
357 for (int db = -dbDiff; db > m_dBmin; db -= dbDiff) {
358 y = topDist + m_innerScopeRect.height() * ((float)db)/(m_dBmin - m_dBmax);
359 if (y-topDist > m_innerScopeRect.height()-minDistY+10) {
360 // Abort here, there is still a line left for min dB to paint which needs some room.
363 davinci.drawLine(leftDist, y, leftDist + m_innerScopeRect.width()-1, y);
364 davinci.drawText(leftDist + m_innerScopeRect.width() + textDistX, y + 6, i18n("%1 dB", m_dBmax + db));
366 davinci.drawLine(leftDist, topDist, leftDist + m_innerScopeRect.width()-1, topDist);
367 davinci.drawText(leftDist + m_innerScopeRect.width() + textDistX, topDist+6, i18n("%1 dB", m_dBmax));
368 davinci.drawLine(leftDist, topDist+m_innerScopeRect.height()-1, leftDist + m_innerScopeRect.width()-1, topDist+m_innerScopeRect.height()-1);
369 davinci.drawText(leftDist + m_innerScopeRect.width() + textDistX, topDist+m_innerScopeRect.height()+6, i18n("%1 dB", m_dBmin));
371 const uint hzDiff = ceil( ((float)minDistX)/m_innerScopeRect.width() * m_freqMax / 1000 ) * 1000;
373 const int rightBorder = leftDist + m_innerScopeRect.width()-1;
374 y = topDist + m_innerScopeRect.height() + textDistY;
375 for (int hz = 0; x <= rightBorder; hz += hzDiff) {
376 davinci.setPen(AbstractScopeWidget::penLighter);
377 x = leftDist + m_innerScopeRect.width() * ((float)hz)/m_freqMax;
379 if (x <= rightBorder) {
380 davinci.drawLine(x, topDist, x, topDist + m_innerScopeRect.height()+6);
382 if (hz < m_freqMax && x+textDistY < leftDist + m_innerScopeRect.width()) {
383 davinci.drawText(x-4, y, QVariant(hz/1000).toString());
385 x = leftDist + m_innerScopeRect.width();
386 davinci.drawLine(x, topDist, x, topDist + m_innerScopeRect.height()+6);
387 davinci.drawText(x-10, y, i18n("%1 kHz").arg((double)m_freqMax/1000, 0, 'f', 1));
391 // Draw finer lines between the main lines
392 davinci.setPen(AbstractScopeWidget::penLightDots);
393 for (uint dHz = 3; dHz > 0; dHz--) {
394 x = leftDist + m_innerScopeRect.width() * ((float)hz - dHz * hzDiff/4.0f)/m_freqMax;
395 if (x > rightBorder) {
398 davinci.drawLine(x, topDist, x, topDist + m_innerScopeRect.height()-1);
403 if (m_aTrackMouse->isChecked() && m_mouseWithinWidget && mouseX < m_innerScopeRect.width()-1) {
404 davinci.setPen(AbstractScopeWidget::penThin);
406 x = leftDist + mouseX;
409 float freq = ((float) mouseX)/(m_innerScopeRect.width()-1) * m_freqMax;
412 m_lastFFTLock.acquire();
413 // We need to test whether the mouse is inside the widget
414 // because the position could already have changed in the meantime (-> crash)
415 if (m_lastFFT.size() > 0 && mouseX >= 0 && mouseX < m_innerScopeRect.width()) {
416 uint right = ((float) m_freqMax)/(m_freq/2) * (m_lastFFT.size() - 1);
417 QVector<float> dbMap = FFTTools::interpolatePeakPreserving(m_lastFFT, m_innerScopeRect.width(), 0, right, -120);
420 y = topDist + m_innerScopeRect.height()-1 - (dbMap[mouseX] - m_dBmin) / (m_dBmax-m_dBmin) * (m_innerScopeRect.height()-1);
422 if (y < (int)topDist + m_innerScopeRect.height()-1) {
424 davinci.drawLine(x, y, leftDist + m_innerScopeRect.width()-1, y);
427 y = topDist + mouseY;
429 m_lastFFTLock.release();
431 if (y > (int)topDist + mouseY) {
434 davinci.drawLine(x, y, x, topDist + m_innerScopeRect.height()-1);
437 QPoint dist(20, -20);
439 leftDist + mouseX + dist.x(),
440 topDist + mouseY + dist.y(),
444 if (rect.right() > (int)leftDist + m_innerScopeRect.width()-1) {
445 // Mirror the rectangle at the y axis to keep it inside the widget
447 rect.topLeft() - QPoint(rect.width() + 2*dist.x(), 0),
452 rect.topLeft() + QPoint(12, 4),
456 davinci.fillRect(rect, AbstractScopeWidget::penBackground.brush());
457 davinci.setPen(AbstractScopeWidget::penLighter);
458 davinci.drawRect(rect);
459 davinci.drawText(textRect, QString(
460 i18n("%1 dB", QString("%1").arg(db, 0, 'f', 2))
462 + i18n("%1 kHz", QString("%1").arg(freq/1000, 0, 'f', 2))));
467 emit signalHUDRenderingFinished(start.elapsed(), 1);
471 #ifdef DEBUG_AUDIOSPEC
472 qDebug() << "Widget is too small for painting inside. Size of inner scope rect is "
473 << m_innerScopeRect.width() << "x" << m_innerScopeRect.height() <<".";
475 emit signalHUDRenderingFinished(0, 1);
481 QRect AudioSpectrum::scopeRect()
486 ui->verticalSpacer->geometry().top()+6 // Top
488 AbstractAudioScopeWidget::rect().bottomRight()
490 m_innerScopeRect = QRect(
492 m_scopeRect.left()+6, // Left
493 m_scopeRect.top()+6 // Top
495 ui->verticalSpacer->geometry().right()-70,
496 ui->verticalSpacer->geometry().bottom()-40
502 void AudioSpectrum::slotResetMaxFreq()
504 m_customFreq = false;
512 void AudioSpectrum::handleMouseDrag(const QPoint &movement, const RescaleDirection rescaleDirection, const Qt::KeyboardModifiers rescaleModifiers)
514 if (rescaleDirection == North) {
515 // Nort-South direction: Adjust the dB scale
517 if ((rescaleModifiers & Qt::ShiftModifier) == 0) {
519 // By default adjust the min dB value
520 m_dBmin += movement.y();
524 // Adjust max dB value if Shift is pressed.
525 m_dBmax += movement.y();
529 // Ensure the dB values lie in [-100, 0] (or rather [MIN_DB_VALUE, 0])
530 // 0 is the upper bound, everything below -70 dB is most likely noise
534 if (m_dBmin < MIN_DB_VALUE) {
535 m_dBmin = MIN_DB_VALUE;
537 // Ensure there is at least 6 dB between the minimum and the maximum value;
538 // lower values hardly make sense
539 if (m_dBmax - m_dBmin < 6) {
540 if ((rescaleModifiers & Qt::ShiftModifier) == 0) {
541 // min was adjusted; Try to adjust the max value to maintain the
542 // minimum dB difference of 6 dB
543 m_dBmax = m_dBmin + 6;
549 // max was adjusted, adjust min
550 m_dBmin = m_dBmax - 6;
551 if (m_dBmin < MIN_DB_VALUE) {
552 m_dBmin = MIN_DB_VALUE;
553 m_dBmax = MIN_DB_VALUE+6;
561 } else if (rescaleDirection == East) {
562 // East-West direction: Adjust the maximum frequency
563 m_freqMax -= 100*movement.x();
564 if (m_freqMax < MIN_FREQ_VALUE) {
565 m_freqMax = MIN_FREQ_VALUE;
567 if (m_freqMax > MAX_FREQ_VALUE) {
568 m_freqMax = MAX_FREQ_VALUE;