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 ***************************************************************************/
14 #include "spectrogram.h"
16 // Defines the number of FFT samples to store.
17 // Around 4 kB for a window size of 2000. Should be at least as large as the
18 // highest vertical screen resolution available for complete reconstruction.
19 // Can be less as a pre-rendered image is kept in space.
20 #define SPECTROGRAM_HISTORY_SIZE 1000
22 // Uncomment for debugging
23 //#define DEBUG_SPECTROGRAM
25 #ifdef DEBUG_SPECTROGRAM
29 #define MIN_DB_VALUE -120
30 #define MAX_FREQ_VALUE 96000
31 #define MIN_FREQ_VALUE 1000
33 Spectrogram::Spectrogram(QWidget *parent) :
34 AbstractAudioScopeWidget(true, parent)
42 , m_parameterChanged(false)
44 ui = new Ui::Spectrogram_UI;
48 m_aResetHz = new QAction(i18n("Reset maximum frequency to sampling rate"), this);
49 m_aGrid = new QAction(i18n("Draw grid"), this);
50 m_aGrid->setCheckable(true);
51 m_aTrackMouse = new QAction(i18n("Track mouse"), this);
52 m_aTrackMouse->setCheckable(true);
53 m_aHighlightPeaks = new QAction(i18n("Highlight peaks"), this);
54 m_aHighlightPeaks->setCheckable(true);
57 m_menu->addSeparator();
58 m_menu->addAction(m_aResetHz);
59 m_menu->addAction(m_aTrackMouse);
60 m_menu->addAction(m_aGrid);
61 m_menu->addAction(m_aHighlightPeaks);
62 m_menu->removeAction(m_aRealtime);
65 ui->windowSize->addItem("256", QVariant(256));
66 ui->windowSize->addItem("512", QVariant(512));
67 ui->windowSize->addItem("1024", QVariant(1024));
68 ui->windowSize->addItem("2048", QVariant(2048));
70 ui->windowFunction->addItem(i18n("Rectangular window"), FFTTools::Window_Rect);
71 ui->windowFunction->addItem(i18n("Triangular window"), FFTTools::Window_Triangle);
72 ui->windowFunction->addItem(i18n("Hamming window"), FFTTools::Window_Hamming);
74 // Note: These strings are used in both Spectogram and AudioSpectrum. Ideally change both (if necessary) to reduce workload on translators
75 ui->labelFFTSize->setToolTip(i18n("The maximum window size is limited by the number of samples per frame."));
76 ui->windowSize->setToolTip(i18n("A bigger window improves the accuracy at the cost of computational power."));
77 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."));
80 b &= connect(m_aResetHz, SIGNAL(triggered()), this, SLOT(slotResetMaxFreq()));
81 b &= connect(ui->windowFunction, SIGNAL(currentIndexChanged(int)), this, SLOT(forceUpdate()));
82 b &= connect(this, SIGNAL(signalMousePositionChanged()), this, SLOT(forceUpdateHUD()));
85 AbstractScopeWidget::init();
88 Spectrogram::~Spectrogram()
98 void Spectrogram::readConfig()
100 AbstractScopeWidget::readConfig();
102 KSharedConfigPtr config = KGlobal::config();
103 KConfigGroup scopeConfig(config, AbstractScopeWidget::configName());
105 ui->windowSize->setCurrentIndex(scopeConfig.readEntry("windowSize", 0));
106 ui->windowFunction->setCurrentIndex(scopeConfig.readEntry("windowFunction", 0));
107 m_aTrackMouse->setChecked(scopeConfig.readEntry("trackMouse", true));
108 m_aGrid->setChecked(scopeConfig.readEntry("drawGrid", true));
109 m_aHighlightPeaks->setChecked(scopeConfig.readEntry("highlightPeaks", true));
110 m_dBmax = scopeConfig.readEntry("dBmax", 0);
111 m_dBmin = scopeConfig.readEntry("dBmin", -70);
112 m_freqMax = scopeConfig.readEntry("freqMax", 0);
114 if (m_freqMax == 0) {
115 m_customFreq = false;
121 void Spectrogram::writeConfig()
123 KSharedConfigPtr config = KGlobal::config();
124 KConfigGroup scopeConfig(config, AbstractScopeWidget::configName());
126 scopeConfig.writeEntry("windowSize", ui->windowSize->currentIndex());
127 scopeConfig.writeEntry("windowFunction", ui->windowFunction->currentIndex());
128 scopeConfig.writeEntry("trackMouse", m_aTrackMouse->isChecked());
129 scopeConfig.writeEntry("drawGrid", m_aGrid->isChecked());
130 scopeConfig.writeEntry("highlightPeaks", m_aHighlightPeaks->isChecked());
131 scopeConfig.writeEntry("dBmax", m_dBmax);
132 scopeConfig.writeEntry("dBmin", m_dBmin);
135 scopeConfig.writeEntry("freqMax", m_freqMax);
137 scopeConfig.writeEntry("freqMax", 0);
143 QString Spectrogram::widgetName() const { return QString("Spectrogram"); }
145 QRect Spectrogram::scopeRect()
150 ui->verticalSpacer->geometry().top()+6 // Top
152 AbstractAudioScopeWidget::rect().bottomRight()
154 m_innerScopeRect = QRect(
156 m_scopeRect.left()+66, // Left
157 m_scopeRect.top()+6 // Top
159 ui->verticalSpacer->geometry().right()-70,
160 ui->verticalSpacer->geometry().bottom()-40
166 QImage Spectrogram::renderHUD(uint)
168 if (m_innerScopeRect.width() > 0 && m_innerScopeRect.height() > 0) {
169 QTime start = QTime::currentTime();
172 const uint minDistY = 30; // Minimum distance between two lines
173 const uint minDistX = 40;
174 const uint textDistX = 10;
175 const uint textDistY = 25;
176 const uint topDist = m_innerScopeRect.top() - m_scopeRect.top();
177 const uint leftDist = m_innerScopeRect.left() - m_scopeRect.left();
178 const int mouseX = m_mousePos.x() - m_innerScopeRect.left();
179 const int mouseY = m_mousePos.y() - m_innerScopeRect.top();
182 QImage hud(m_scopeRect.size(), QImage::Format_ARGB32);
183 hud.fill(qRgba(0,0,0,0));
185 QPainter davinci(&hud);
186 davinci.setPen(AbstractScopeWidget::penLight);
190 if (m_aGrid->isChecked()) {
191 for (int frameNumber = 0; frameNumber < m_innerScopeRect.height(); frameNumber += minDistY) {
192 y = topDist + m_innerScopeRect.height()-1 - frameNumber;
193 hideText = m_aTrackMouse->isChecked() && m_mouseWithinWidget && abs(y - mouseY) < (int)textDistY && mouseY < m_innerScopeRect.height()
194 && mouseX < m_innerScopeRect.width() && mouseX >= 0;
196 davinci.drawLine(leftDist, y, leftDist + m_innerScopeRect.width()-1, y);
198 davinci.drawText(leftDist + m_innerScopeRect.width() + textDistX, y + 6, QVariant(frameNumber).toString());
202 // Draw a line through the mouse position with the correct Frame number
203 if (m_aTrackMouse->isChecked() && m_mouseWithinWidget && mouseY < m_innerScopeRect.height()
204 && mouseX < m_innerScopeRect.width() && mouseX >= 0) {
205 davinci.setPen(AbstractScopeWidget::penLighter);
207 x = leftDist + mouseX;
208 y = topDist + mouseY - 20;
212 if (y > (int)topDist + m_innerScopeRect.height()-1 - 30) {
213 y = topDist + m_innerScopeRect.height()-1 - 30;
215 davinci.drawLine(x, topDist + mouseY, leftDist + m_innerScopeRect.width()-1, topDist + mouseY);
216 davinci.drawText(leftDist + m_innerScopeRect.width() + textDistX,
218 m_scopeRect.right()-m_innerScopeRect.right()-textDistX,
221 i18n("Frame\n%1", m_innerScopeRect.height()-1-mouseY));
225 const uint hzDiff = ceil( ((float)minDistX)/m_innerScopeRect.width() * m_freqMax / 1000 ) * 1000;
226 const int rightBorder = leftDist + m_innerScopeRect.width()-1;
228 y = topDist + m_innerScopeRect.height() + textDistY;
229 if (m_aGrid->isChecked()) {
230 for (uint hz = 0; x <= rightBorder; hz += hzDiff) {
231 davinci.setPen(AbstractScopeWidget::penLight);
232 x = leftDist + (m_innerScopeRect.width()-1) * ((float)hz)/m_freqMax;
234 // Hide text if it would overlap with the text drawn at the mouse position
235 hideText = m_aTrackMouse->isChecked() && m_mouseWithinWidget && abs(x-(leftDist + mouseX + 20)) < (int) minDistX + 16
236 && mouseX < m_innerScopeRect.width() && mouseX >= 0;
238 if (x <= rightBorder) {
239 davinci.drawLine(x, topDist, x, topDist + m_innerScopeRect.height()+6);
241 if (x+textDistY < leftDist + m_innerScopeRect.width()) {
242 // Only draw the text label if there is still enough room for the final one at the right.
244 davinci.drawText(x-4, y, QVariant(hz/1000).toString());
250 // Draw finer lines between the main lines
251 davinci.setPen(AbstractScopeWidget::penLightDots);
252 for (uint dHz = 3; dHz > 0; dHz--) {
253 x = leftDist + m_innerScopeRect.width() * ((float)hz - dHz * hzDiff/4.0f)/m_freqMax;
254 if (x > rightBorder) {
257 davinci.drawLine(x, topDist, x, topDist + m_innerScopeRect.height()-1);
261 // Draw the line at the very right (maximum frequency)
262 x = leftDist + m_innerScopeRect.width()-1;
263 hideText = m_aTrackMouse->isChecked() && m_mouseWithinWidget && abs(x-(leftDist + mouseX + 30)) < (int) minDistX
264 && mouseX < m_innerScopeRect.width() && mouseX >= 0;
265 davinci.drawLine(x, topDist, x, topDist + m_innerScopeRect.height()+6);
267 davinci.drawText(x-10, y, i18n("%1 kHz", QString("%1").arg((double)m_freqMax/1000, 0, 'f', 1)));
271 // Draw a line through the mouse position with the correct frequency label
272 if (m_aTrackMouse->isChecked() && m_mouseWithinWidget && mouseX < m_innerScopeRect.width() && mouseX >= 0) {
273 davinci.setPen(AbstractScopeWidget::penThin);
274 x = leftDist + mouseX;
275 davinci.drawLine(x, topDist, x, topDist + m_innerScopeRect.height()+6);
276 davinci.drawText(x-10, y, i18n("%1 kHz", QString("%1")
277 .arg((double)(m_mousePos.x()-m_innerScopeRect.left())/m_innerScopeRect.width() * m_freqMax/1000, 0, 'f', 2)));
280 // Draw the dB brightness scale
282 davinci.setPen(AbstractScopeWidget::penLighter);
283 for (y = topDist; y < (int)topDist + m_innerScopeRect.height(); y++) {
284 val = 1-((float)y-topDist)/(m_innerScopeRect.height()-1);
285 int col = qRgba(255, 255, 255, 255.0 * val);
286 for (x = leftDist-6; x >= (int)leftDist-13; x--) {
287 hud.setPixel(x, y, col);
290 const int rectWidth = leftDist-m_scopeRect.left()-22;
291 const int rectHeight = 50;
292 davinci.setFont(QFont(QFont().defaultFamily(), 10));
293 davinci.drawText(m_scopeRect.left(), topDist, rectWidth, rectHeight, Qt::AlignRight, i18n("%1\ndB", m_dBmax));
294 davinci.drawText(m_scopeRect.left(), topDist + m_innerScopeRect.height()-20, rectWidth, rectHeight, Qt::AlignRight, i18n("%1\ndB", m_dBmin));
297 emit signalHUDRenderingFinished(start.elapsed(), 1);
300 emit signalHUDRenderingFinished(0, 1);
304 QImage Spectrogram::renderAudioScope(uint, const QVector<int16_t> audioFrame, const int freq,
305 const int num_channels, const int num_samples, const int newData) {
307 audioFrame.size() > 63
308 && m_innerScopeRect.width() > 0 && m_innerScopeRect.height() > 0
311 m_freqMax = freq / 2;
313 bool newDataAvailable = newData > 0;
315 #ifdef DEBUG_SPECTROGRAM
316 qDebug() << "New data for " << widgetName() << ": " << newDataAvailable << " (" << newData << " units)";
319 QTime start = QTime::currentTime();
321 int fftWindow = ui->windowSize->itemData(ui->windowSize->currentIndex()).toInt();
322 if (fftWindow > num_samples) {
323 fftWindow = num_samples;
325 if ((fftWindow & 1) == 1) {
329 // Show the window size used, for information
330 ui->labelFFTSizeNumber->setText(QVariant(fftWindow).toString());
332 if (newDataAvailable) {
334 float freqSpectrum[fftWindow/2];
336 // Get the spectral power distribution of the input samples,
337 // using the given window size and function
338 FFTTools::WindowType windowType = (FFTTools::WindowType) ui->windowFunction->itemData(ui->windowFunction->currentIndex()).toInt();
339 m_fftTools.fftNormalized(audioFrame, 0, num_channels, freqSpectrum, windowType, fftWindow, 0);
341 // This methid might be called also when a simple refresh is required.
342 // In this case there is no data to append to the history. Only append new data.
343 QVector<float> spectrumVector(fftWindow/2);
344 memcpy(spectrumVector.data(), &freqSpectrum[0], fftWindow/2 * sizeof(float));
345 m_fftHistory.prepend(spectrumVector);
347 #ifdef DEBUG_SPECTROGRAM
349 qDebug() << widgetName() << ": Has no new data to Fourier-transform";
353 // Limit the maximum history size to avoid wasting space
354 while (m_fftHistory.size() > SPECTROGRAM_HISTORY_SIZE) {
355 m_fftHistory.removeLast();
359 QImage spectrum(m_scopeRect.size(), QImage::Format_ARGB32);
360 spectrum.fill(qRgba(0,0,0,0));
361 QPainter davinci(&spectrum);
362 const uint h = m_innerScopeRect.height();
363 const uint leftDist = m_innerScopeRect.left() - m_scopeRect.left();
364 const uint topDist = m_innerScopeRect.top() - m_scopeRect.top();
368 bool completeRedraw = true;
370 if (m_fftHistoryImg.size() == m_scopeRect.size() && !m_parameterChanged) {
371 // The size of the widget and the parameters (like min/max dB) have not changed since last time,
372 // so we can re-use it, shift it by one pixel, and render the single remaining line. Usually about
373 // 10 times faster for a widget height of around 400 px.
374 if (newDataAvailable) {
375 davinci.drawImage(0, -1, m_fftHistoryImg);
377 // spectrum = m_fftHistoryImg does NOT work, leads to segfaults (anyone knows why, please tell me)
378 davinci.drawImage(0, 0, m_fftHistoryImg);
380 completeRedraw = false;
384 if (newData || m_parameterChanged) {
385 m_parameterChanged = false;
388 QVector<float> dbMap;
390 for (QList<QVector<float> >::iterator it = m_fftHistory.begin(); it != m_fftHistory.end(); it++) {
392 windowSize = (*it).size();
394 // Interpolate the frequency data to match the pixel coordinates
395 right = ((float) m_freqMax)/(m_freq/2) * (windowSize - 1);
396 dbMap = FFTTools::interpolatePeakPreserving((*it), m_innerScopeRect.width(), 0, right, -180);
398 for (int i = 0; i < dbMap.size(); ++i) {
400 peak = val > m_dBmax;
402 // Normalize dB value to [0 1], 1 corresponding to dbMax dB and 0 to dbMin dB
403 val = (val-m_dBmax)/(m_dBmax-m_dBmin) + 1;
406 } else if (val > 1) {
409 if (!peak || !m_aHighlightPeaks->isChecked()) {
410 spectrum.setPixel(leftDist + i, topDist + h-1 - y, qRgba(255, 255, 255, val * 255));
412 spectrum.setPixel(leftDist + i, topDist + h-1 - y, AbstractScopeWidget::colHighlightDark.rgba());
417 if (y >= topDist + m_innerScopeRect.height()) {
420 if (!completeRedraw) {
426 #ifdef DEBUG_SPECTROGRAM
427 qDebug() << "Rendered " << y-topDist << "lines from " << m_fftHistory.size() << " available samples in " << start.elapsed() << " ms"
428 << (completeRedraw ? "" : " (re-used old image)");
429 uint storedBytes = 0;
430 for (QList< QVector<float> >::iterator it = m_fftHistory.begin(); it != m_fftHistory.end(); it++) {
431 storedBytes += (*it).size() * sizeof((*it)[0]);
433 qDebug() << QString("Total storage used: %1 kB").arg((double)storedBytes/1000, 0, 'f', 2);
436 m_fftHistoryImg = spectrum;
438 emit signalScopeRenderingFinished(start.elapsed(), 1);
441 emit signalScopeRenderingFinished(0, 1);
445 QImage Spectrogram::renderBackground(uint) { return QImage(); }
447 bool Spectrogram::isHUDDependingOnInput() const { return false; }
448 bool Spectrogram::isScopeDependingOnInput() const { return true; }
449 bool Spectrogram::isBackgroundDependingOnInput() const { return false; }
451 void Spectrogram::handleMouseDrag(const QPoint &movement, const RescaleDirection rescaleDirection, const Qt::KeyboardModifiers rescaleModifiers)
453 if (rescaleDirection == North) {
454 // Nort-South direction: Adjust the dB scale
456 if ((rescaleModifiers & Qt::ShiftModifier) == 0) {
458 // By default adjust the min dB value
459 m_dBmin += movement.y();
463 // Adjust max dB value if Shift is pressed.
464 m_dBmax += movement.y();
468 // Ensure the dB values lie in [-100, 0] (or rather [MIN_DB_VALUE, 0])
469 // 0 is the upper bound, everything below -70 dB is most likely noise
473 if (m_dBmin < MIN_DB_VALUE) {
474 m_dBmin = MIN_DB_VALUE;
476 // Ensure there is at least 6 dB between the minimum and the maximum value;
477 // lower values hardly make sense
478 if (m_dBmax - m_dBmin < 6) {
479 if ((rescaleModifiers & Qt::ShiftModifier) == 0) {
480 // min was adjusted; Try to adjust the max value to maintain the
481 // minimum dB difference of 6 dB
482 m_dBmax = m_dBmin + 6;
488 // max was adjusted, adjust min
489 m_dBmin = m_dBmax - 6;
490 if (m_dBmin < MIN_DB_VALUE) {
491 m_dBmin = MIN_DB_VALUE;
492 m_dBmax = MIN_DB_VALUE+6;
497 m_parameterChanged = true;
501 } else if (rescaleDirection == East) {
502 // East-West direction: Adjust the maximum frequency
503 m_freqMax -= 100*movement.x();
504 if (m_freqMax < MIN_FREQ_VALUE) {
505 m_freqMax = MIN_FREQ_VALUE;
507 if (m_freqMax > MAX_FREQ_VALUE) {
508 m_freqMax = MAX_FREQ_VALUE;
512 m_parameterChanged = true;
520 void Spectrogram::slotResetMaxFreq()
522 m_customFreq = false;
523 m_parameterChanged = true;
528 void Spectrogram::resizeEvent(QResizeEvent *event)
530 m_parameterChanged = true;
531 AbstractAudioScopeWidget::resizeEvent(event);
534 #undef SPECTROGRAM_HISTORY_SIZE
535 #ifdef DEBUG_SPECTROGRAM
536 #undef DEBUG_SPECTROGRAM