git.sesse.net Git - kdenlive/blob - src/audioscopes/audiospectrum.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2010 by Simon Andreas Eugster (simon.eu@gmail.com)      *
   3  *   This file is part of kdenlive. See www.kdenlive.org.                  *
   4  *                                                                         *
   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  ***************************************************************************/
  10
  11
  12
  13 #include "audiospectrum.h"
  14 #include "ffttools.h"
  15 #include "tools/kiss_fftr.h"
  16
  17 #include <QMenu>
  18 #include <QPainter>
  19 #include <QMouseEvent>
  20
  21 #include <iostream>
  22
  23 // Enables debugging, like writing a GNU Octave .m file to /tmp
  24 //#define DEBUG_AUDIOSPEC
  25 #ifdef DEBUG_AUDIOSPEC
  26 #include <fstream>
  27 bool fileWritten = false;
  28 #endif
  29
  30 #define MIN_DB_VALUE -120
  31
  32 const QString AudioSpectrum::directions[] =  {"North", "Northeast", "East", "Southeast"};
  33
  34 AudioSpectrum::AudioSpectrum(QWidget *parent) :
  35         AbstractAudioScopeWidget(false, parent),
  36         m_windowFunctions(),
  37         m_rescaleMinDist(8),
  38         m_rescaleVerticalThreshold(2.0f),
  39         m_rescaleActive(false),
  40         m_rescalePropertiesLocked(false),
  41         m_rescaleScale(1)
  42 {
  43     ui = new Ui::AudioSpectrum_UI;
  44     ui->setupUi(this);
  45
  46     m_distance = QSize(65, 30);
  47     m_freqMax = 10000;
  48
  49
  50     m_aLockHz = new QAction(i18n("Lock maximum frequency"), this);
  51     m_aLockHz->setCheckable(true);
  52     m_aLockHz->setEnabled(false);
  53
  54
  55     m_menu->addSeparator();
  56     m_menu->addAction(m_aLockHz);
  57
  58
  59     ui->windowSize->addItem("256", QVariant(256));
  60     ui->windowSize->addItem("512", QVariant(512));
  61     ui->windowSize->addItem("1024", QVariant(1024));
  62     ui->windowSize->addItem("2048", QVariant(2048));
  63
  64     ui->windowFunction->addItem(i18n("Rectangular window"), FFTTools::Window_Rect);
  65     ui->windowFunction->addItem(i18n("Triangular window"), FFTTools::Window_Triangle);
  66     ui->windowFunction->addItem(i18n("Hamming window"), FFTTools::Window_Hamming);
  67
  68
  69     m_cfg = kiss_fftr_alloc(ui->windowSize->itemData(ui->windowSize->currentIndex()).toInt(), 0,0,0);
  70     //m_windowFunctions.insert("tri512", FFTTools::window(FFTTools::Window_Hamming, 8, 0));
  71     // TODO Window function cache
  72
  73
  74     bool b = true;
  75     b &= connect(ui->windowSize, SIGNAL(currentIndexChanged(int)), this, SLOT(slotUpdateCfg()));
  76     Q_ASSERT(b);
  77
  78     AbstractScopeWidget::init();
  79 }
  80 AudioSpectrum::~AudioSpectrum()
  81 {
  82     writeConfig();
  83
  84     free(m_cfg);
  85     delete m_aLockHz;
  86 }
  87
  88 void AudioSpectrum::readConfig()
  89 {
  90     AbstractScopeWidget::readConfig();
  91
  92     KSharedConfigPtr config = KGlobal::config();
  93     KConfigGroup scopeConfig(config, AbstractScopeWidget::configName());
  94     m_aLockHz->setChecked(scopeConfig.readEntry("lockHz", false));
  95     ui->windowSize->setCurrentIndex(scopeConfig.readEntry("windowSize", 0));
  96     m_dBmax = scopeConfig.readEntry("dBmax", 0);
  97     m_dBmin = scopeConfig.readEntry("dBmin", -70);
  98     ui->windowFunction->setCurrentIndex(scopeConfig.readEntry("windowFunction", 0));
  99 }
 100 void AudioSpectrum::writeConfig()
 101 {
 102     KSharedConfigPtr config = KGlobal::config();
 103     KConfigGroup scopeConfig(config, AbstractScopeWidget::configName());
 104     scopeConfig.writeEntry("windowSize", ui->windowSize->currentIndex());
 105     scopeConfig.writeEntry("windowFunction", ui->windowFunction->currentIndex());
 106     scopeConfig.writeEntry("lockHz", m_aLockHz->isChecked());
 107     scopeConfig.writeEntry("dBmax", m_dBmax);
 108     scopeConfig.writeEntry("dBmin", m_dBmin);
 109     scopeConfig.sync();
 110 }
 111
 112 QString AudioSpectrum::widgetName() const { return QString("AudioSpectrum"); }
 113 bool AudioSpectrum::isBackgroundDependingOnInput() const { return false; }
 114 bool AudioSpectrum::isScopeDependingOnInput() const { return true; }
 115 bool AudioSpectrum::isHUDDependingOnInput() const { return false; }
 116
 117 QImage AudioSpectrum::renderBackground(uint) { return QImage(); }
 118
 119 QImage AudioSpectrum::renderAudioScope(uint, const QVector<int16_t> audioFrame, const int freq, const int num_channels, const int num_samples)
 120 {
 121     if (audioFrame.size() > 63) {
 122         m_freqMax = freq / 2;
 123
 124         QTime start = QTime::currentTime();
 125
 126         bool customCfg = false;
 127         kiss_fftr_cfg myCfg = m_cfg;
 128         int fftWindow = ui->windowSize->itemData(ui->windowSize->currentIndex()).toInt();
 129         if (fftWindow > num_samples) {
 130             fftWindow = num_samples;
 131             customCfg = true;
 132         }
 133         if ((fftWindow & 1) == 1) {
 134             fftWindow--;
 135             customCfg = true;
 136         }
 137         if (customCfg) {
 138             myCfg = kiss_fftr_alloc(fftWindow, 0,0,0);
 139         }
 140
 141         float data[fftWindow];
 142         float freqSpectrum[fftWindow/2];
 143
 144         int16_t maxSig = 0;
 145         for (int i = 0; i < fftWindow; i++) {
 146             if (audioFrame.data()[i*num_channels] > maxSig) {
 147                 maxSig = audioFrame.data()[i*num_channels];
 148             }
 149         }
 150
 151         // Prepare frequency space vector. The resulting FFT vector is only half as long.
 152         kiss_fft_cpx freqData[fftWindow/2];
 153
 154
 155
 156         // Copy the first channel's audio into a vector for the FFT display
 157         // (only one channel handled at the moment)
 158         if (num_samples < fftWindow) {
 159             std::fill(&data[num_samples], &data[fftWindow-1], 0);
 160         }
 161
 162         FFTTools::WindowType windowType = (FFTTools::WindowType) ui->windowFunction->itemData(ui->windowFunction->currentIndex()).toInt();
 163         QVector<float> window;
 164         float windowScaleFactor = 1;
 165         if (windowType != FFTTools::Window_Rect) {
 166             window = FFTTools::window(windowType, fftWindow, 0);
 167             windowScaleFactor = 1.0/window[fftWindow];
 168             qDebug() << "Using a window scaling factor of " << windowScaleFactor;
 169         }
 170
 171         // Normalize signals to [0,1] to get correct dB values later on
 172         for (int i = 0; i < num_samples && i < fftWindow; i++) {
 173             if (windowType != FFTTools::Window_Rect) {
 174                 data[i] = (float) audioFrame.data()[i*num_channels] / 32767.0f * window[i];
 175             } else {
 176                 data[i] = (float) audioFrame.data()[i*num_channels] / 32767.0f;
 177             }
 178         }
 179
 180         // Calculate the Fast Fourier Transform for the input data
 181         kiss_fftr(myCfg, data, freqData);
 182
 183
 184         float max = -100;
 185         // Logarithmic scale: 20 * log ( 2 * magnitude / N ) with magnitude = sqrt(r² + i²)
 186         // with N = FFT size (after FFT, 1/2 window size)
 187         for (int i = 0; i < fftWindow/2; i++) {
 188             // Logarithmic scale: 20 * log ( 2 * magnitude / N ) with magnitude = sqrt(r² + i²)
 189             // with N = FFT size (after FFT, 1/2 window size)
 190             freqSpectrum[i] = 20*log(pow(pow(fabs(freqData[i].r * windowScaleFactor),2) + pow(fabs(freqData[i].i * windowScaleFactor),2), .5)/((float)fftWindow/2.0f))/log(10);;
 191             if (freqSpectrum[i] > max) { max = freqSpectrum[i]; }
 192         }
 193         qDebug() << "Maximum (dB) is " << max;
 194
 195
 196
 197         // Draw the spectrum
 198         QImage spectrum(m_scopeRect.size(), QImage::Format_ARGB32);
 199         spectrum.fill(qRgba(0,0,0,0));
 200         uint w = m_innerScopeRect.width();
 201         uint h = m_innerScopeRect.height();
 202         float x;
 203         float val;
 204         for (uint i = 0; i < w; i++) {
 205
 206             x = i/((float) w) * fftWindow/2;
 207
 208             // Use linear interpolation in order to get smoother display
 209             if (i == 0 || i == w-1) {
 210                 val = freqSpectrum[i];
 211             } else {
 212                 // Use floor(x)+1 instead of ceil(x) as floor(x) == ceil(x) is possible.
 213                 val = (floor(x)+1 - x)*freqSpectrum[(int) floor(x)] + (x-floor(x))*freqSpectrum[(int) floor(x)+1];
 214             }
 215
 216             // freqSpectrum values range from 0 to -inf as they are relative dB values.
 217             for (uint y = 0; y < h*(1 - (val - m_dBmax)/(m_dBmin-m_dBmax)) && y < h; y++) {
 218                 spectrum.setPixel(i, h-y-1, qRgba(225, 182, 255, 255));
 219             }
 220         }
 221
 222         emit signalScopeRenderingFinished(start.elapsed(), 1);
 223
 224 #ifdef DEBUG_AUDIOSPEC
 225         if (!fileWritten || true) {
 226             std::ofstream mFile;
 227             mFile.open("/tmp/freq.m");
 228             if (!mFile) {
 229                 qDebug() << "Opening file failed.";
 230             } else {
 231                 mFile << "val = [ ";
 232
 233                 for (int sample = 0; sample < 256; sample++) {
 234                     mFile << data[sample] << " ";
 235                 }
 236                 mFile << " ];\n";
 237
 238                 mFile << "freq = [ ";
 239                 for (int sample = 0; sample < 256; sample++) {
 240                     mFile << freqData[sample].r << "+" << freqData[sample].i << "*i ";
 241                 }
 242                 mFile << " ];\n";
 243
 244                 mFile.close();
 245                 fileWritten = true;
 246                 qDebug() << "File written.";
 247             }
 248         } else {
 249             qDebug() << "File already written.";
 250         }
 251 #endif
 252
 253         if (customCfg) {
 254             free(myCfg);
 255         }
 256
 257         return spectrum;
 258     } else {
 259         emit signalScopeRenderingFinished(0, 1);
 260         return QImage();
 261     }
 262 }
 263 QImage AudioSpectrum::renderHUD(uint)
 264 {
 265     QTime start = QTime::currentTime();
 266
 267     // Minimum distance between two lines
 268     const uint minDistY = 30;
 269     const uint minDistX = 40;
 270     const uint textDist = 5;
 271     const uint dbDiff = ceil((float)minDistY/m_innerScopeRect.height() * (m_dBmax-m_dBmin));
 272
 273     QImage hud(AbstractAudioScopeWidget::rect().size(), QImage::Format_ARGB32);
 274     hud.fill(qRgba(0,0,0,0));
 275
 276     QPainter davinci(&hud);
 277     davinci.setPen(AbstractAudioScopeWidget::penLight);
 278
 279     // TODO lower boundary
 280     int y;
 281     for (int db = -dbDiff; db > m_dBmin; db -= dbDiff) {
 282         y = m_innerScopeRect.height() * ((float)db)/(m_dBmin - m_dBmax);
 283         davinci.drawLine(0, y, m_innerScopeRect.width()-1, y);
 284         davinci.drawText(m_innerScopeRect.width() + textDist, y + 6, i18n("%1 dB", m_dBmax + db));
 285     }
 286
 287
 288     // TODO more vertical lines in-between
 289     const uint hzDiff = ceil( ((float)minDistX)/m_innerScopeRect.width() * m_freqMax / 1000 ) * 1000;
 290     int x;
 291     for (uint hz = hzDiff; hz < m_freqMax; hz += hzDiff) {
 292         x = m_innerScopeRect.width() * ((float)hz)/m_freqMax;
 293         davinci.drawLine(x, 0, x, m_innerScopeRect.height()+4);
 294         davinci.drawText(x-4, m_innerScopeRect.height() + 20, QVariant(hz/1000).toString());
 295     }
 296     davinci.drawText(m_innerScopeRect.width(), m_innerScopeRect.height() + 20, "[kHz]");
 297
 298
 299     emit signalHUDRenderingFinished(start.elapsed(), 1);
 300     return hud;
 301 }
 302
 303 QRect AudioSpectrum::scopeRect() {
 304     m_innerScopeRect = QRect(
 305             QPoint(
 306                     0,                                      // Left
 307                     ui->verticalSpacer->geometry().top()    // Top
 308             ), QPoint(
 309                     ui->verticalSpacer->geometry().right()-70,
 310                     ui->verticalSpacer->geometry().bottom()-40
 311             )
 312     );
 313     m_scopeRect = QRect(
 314             m_innerScopeRect.topLeft(),
 315             AbstractAudioScopeWidget::rect().bottomRight()
 316     );
 317     return m_scopeRect;
 318 }
 319
 320
 321 void AudioSpectrum::slotUpdateCfg()
 322 {
 323     free(m_cfg);
 324     m_cfg = kiss_fftr_alloc(ui->windowSize->itemData(ui->windowSize->currentIndex()).toInt(), 0,0,0);
 325 }
 326
 327
 328 ///// EVENTS /////
 329
 330 void AudioSpectrum::mouseMoveEvent(QMouseEvent *event)
 331 {
 332     QPoint movement = event->pos()-m_rescaleStartPoint;
 333
 334     if (m_rescaleActive) {
 335         if (m_rescalePropertiesLocked) {
 336             // Direction is known, now adjust parameters
 337
 338             // Reset the starting point to make the next moveEvent relative to the current one
 339             m_rescaleStartPoint = event->pos();
 340
 341
 342             if (!m_rescaleFirstRescaleDone) {
 343                 // We have just learned the desired direction; Normalize the movement to one pixel
 344                 // to avoid a jump by m_rescaleMinDist
 345
 346                 if (movement.x() != 0) {
 347                     movement.setX(movement.x() / abs(movement.x()));
 348                 }
 349                 if (movement.y() != 0) {
 350                     movement.setY(movement.y() / abs(movement.y()));
 351                 }
 352
 353                 m_rescaleFirstRescaleDone = true;
 354             }
 355
 356             if (m_rescaleClockDirection == AudioSpectrum::North) {
 357                 // Nort-South direction: Adjust the dB scale
 358
 359                 if ((m_rescaleModifiers & Qt::ShiftModifier) == 0) {
 360
 361                     // By default adjust the min dB value
 362                     m_dBmin += movement.y();
 363
 364                 } else {
 365
 366                     // Adjust max dB value if Shift is pressed.
 367                     m_dBmax += movement.y();
 368
 369                 }
 370
 371                 // Ensure the dB values lie in [-100, 0] (or rather [MIN_DB_VALUE, 0])
 372                 // 0 is the upper bound, everything below -70 dB is most likely noise
 373                 if (m_dBmax > 0) {
 374                     m_dBmax = 0;
 375                 }
 376                 if (m_dBmin < MIN_DB_VALUE) {
 377                     m_dBmin = MIN_DB_VALUE;
 378                 }
 379                 // Ensure there is at least 6 dB between the minimum and the maximum value;
 380                 // lower values hardly make sense
 381                 if (m_dBmax - m_dBmin < 6) {
 382                     if ((m_rescaleModifiers & Qt::ShiftModifier) == 0) {
 383                         // min was adjusted; Try to adjust the max value to maintain the
 384                         // minimum dB difference of 6 dB
 385                         m_dBmax = m_dBmin + 6;
 386                         if (m_dBmax > 0) {
 387                             m_dBmax = 0;
 388                             m_dBmin = -6;
 389                         }
 390                     } else {
 391                         // max was adjusted, adjust min
 392                         m_dBmin = m_dBmax - 6;
 393                         if (m_dBmin < MIN_DB_VALUE) {
 394                             m_dBmin = MIN_DB_VALUE;
 395                             m_dBmax = MIN_DB_VALUE+6;
 396                         }
 397                     }
 398                 }
 399
 400                 forceUpdateHUD();
 401                 forceUpdateScope();
 402
 403             }
 404
 405
 406         } else {
 407             // Detect the movement direction here.
 408             // This algorithm relies on the aspect ratio of dy/dx (size and signum).
 409             if (movement.manhattanLength() > m_rescaleMinDist) {
 410                 float diff = ((float) movement.y())/movement.x();
 411
 412                 if (abs(diff) > m_rescaleVerticalThreshold || movement.x() == 0) {
 413                     m_rescaleClockDirection = AudioSpectrum::North;
 414                 } else if (abs(diff) < 1/m_rescaleVerticalThreshold) {
 415                     m_rescaleClockDirection = AudioSpectrum::East;
 416                 } else if (diff < 0) {
 417                     m_rescaleClockDirection = AudioSpectrum::Northeast;
 418                 } else {
 419                     m_rescaleClockDirection = AudioSpectrum::Southeast;
 420                 }
 421 #ifdef DEBUG_AUDIOSPEC
 422                 qDebug() << "Diff is " << diff << "; chose " << directions[m_rescaleClockDirection] << " as direction";
 423 #endif
 424                 m_rescalePropertiesLocked = true;
 425             }
 426         }
 427     } else {
 428         AbstractAudioScopeWidget::mouseMoveEvent(event);
 429     }
 430 }
 431
 432 void AudioSpectrum::mousePressEvent(QMouseEvent *event)
 433 {
 434     if (event->button() == Qt::LeftButton) {
 435         // Rescaling mode starts
 436         m_rescaleActive = true;
 437         m_rescalePropertiesLocked = false;
 438         m_rescaleFirstRescaleDone = false;
 439         m_rescaleStartPoint = event->pos();
 440         m_rescaleModifiers = event->modifiers();
 441
 442     } else {
 443         AbstractAudioScopeWidget::mousePressEvent(event);
 444     }
 445 }
 446
 447 void AudioSpectrum::mouseReleaseEvent(QMouseEvent *event)
 448 {
 449     m_rescaleActive = false;
 450     m_rescalePropertiesLocked = false;
 451
 452     AbstractAudioScopeWidget::mouseReleaseEvent(event);
 453 }
 454
 455
 456 #ifdef DEBUG_AUDIOSPEC
 457 #undef DEBUG_AUDIOSPEC
 458 #endif