git.sesse.net Git - kdenlive/blob - src/abstractscopewidget.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 #include "qtconcurrentrun.h"
  12
  13 #include "abstractscopewidget.h"
  14 #include "renderer.h"
  15 #include "monitor.h"
  16
  17 #include <QFuture>
  18 #include <QColor>
  19 #include <QMenu>
  20 #include <QMouseEvent>
  21 #include <QPainter>
  22
  23 const int REALTIME_FPS = 30;
  24
  25 const QColor light(250, 238, 226, 255);
  26 const QColor dark ( 40,  40,  39, 255);
  27 const QColor dark2( 25,  25,  23, 255);
  28
  29 const QPen AbstractScopeWidget::penThick(QBrush(QColor(250,250,250)),     2, Qt::SolidLine);
  30 const QPen AbstractScopeWidget::penThin (QBrush(QColor(250,250,250)),     1, Qt::SolidLine);
  31 const QPen AbstractScopeWidget::penLight(QBrush(QColor(200,200,250,150)), 1, Qt::SolidLine);
  32 const QPen AbstractScopeWidget::penDark (QBrush(QColor(0,0,20,250)),      1, Qt::SolidLine);
  33
  34 AbstractScopeWidget::AbstractScopeWidget(Monitor *projMonitor, Monitor *clipMonitor, bool trackMouse, QWidget *parent) :
  35     QWidget(parent),
  36     m_projMonitor(projMonitor),
  37     m_clipMonitor(clipMonitor),
  38     m_mousePos(0,0),
  39     m_mouseWithinWidget(false),
  40     offset(5),
  41     m_accelFactorHUD(1),
  42     m_accelFactorScope(1),
  43     m_accelFactorBackground(1),
  44     m_semaphoreHUD(1),
  45     m_semaphoreScope(1),
  46     m_semaphoreBackground(1),
  47     initialDimensionUpdateDone(false)
  48
  49 {
  50     m_scopePalette = QPalette();
  51     m_scopePalette.setBrush(QPalette::Window, QBrush(dark2));
  52     m_scopePalette.setBrush(QPalette::Base, QBrush(dark));
  53     m_scopePalette.setBrush(QPalette::Button, QBrush(dark));
  54     m_scopePalette.setBrush(QPalette::Text, QBrush(light));
  55     m_scopePalette.setBrush(QPalette::WindowText, QBrush(light));
  56     m_scopePalette.setBrush(QPalette::ButtonText, QBrush(light));
  57     this->setPalette(m_scopePalette);
  58     this->setAutoFillBackground(true);
  59
  60     m_aAutoRefresh = new QAction(i18n("Auto Refresh"), this);
  61     m_aAutoRefresh->setCheckable(true);
  62     m_aRealtime = new QAction(i18n("Realtime (with precision loss)"), this);
  63     m_aRealtime->setCheckable(true);
  64
  65     m_menu = new QMenu(this);
  66     m_menu->setPalette(m_scopePalette);
  67     m_menu->addAction(m_aAutoRefresh);
  68     m_menu->addAction(m_aRealtime);
  69
  70     this->setContextMenuPolicy(Qt::CustomContextMenu);
  71
  72     m_activeRender = (m_clipMonitor->isActive()) ? m_clipMonitor->render : m_projMonitor->render;
  73
  74     bool b = true;
  75     b &= connect(this, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(customContextMenuRequested(QPoint)));
  76
  77     b &= connect(m_activeRender, SIGNAL(rendererPosition(int)), this, SLOT(slotRenderZoneUpdated()));
  78     b &= connect(m_activeRender, SIGNAL(frameUpdated(QImage)), this, SLOT(slotRenderZoneUpdated(QImage)));
  79
  80     b &= connect(this, SIGNAL(signalHUDRenderingFinished(uint,uint)), this, SLOT(slotHUDRenderingFinished(uint,uint)));
  81     b &= connect(this, SIGNAL(signalScopeRenderingFinished(uint,uint)), this, SLOT(slotScopeRenderingFinished(uint,uint)));
  82     b &= connect(this, SIGNAL(signalBackgroundRenderingFinished(uint,uint)), this, SLOT(slotBackgroundRenderingFinished(uint,uint)));
  83     b &= connect(m_aRealtime, SIGNAL(toggled(bool)), this, SLOT(slotResetRealtimeFactor(bool)));
  84     b &= connect(m_aAutoRefresh, SIGNAL(toggled(bool)), this, SLOT(slotAutoRefreshToggled(bool)));
  85     Q_ASSERT(b);
  86
  87     // Enable mouse tracking if desired.
  88     // Causes the mouseMoved signal to be emitted when the mouse moves inside the
  89     // widget, even when no mouse button is pressed.
  90     this->setMouseTracking(trackMouse);
  91 }
  92
  93 AbstractScopeWidget::~AbstractScopeWidget()
  94 {
  95     writeConfig();
  96
  97     delete m_menu;
  98     delete m_aAutoRefresh;
  99     delete m_aRealtime;
 100 }
 101
 102 void AbstractScopeWidget::init()
 103 {
 104     m_widgetName = widgetName();
 105     readConfig();
 106 }
 107
 108 void AbstractScopeWidget::readConfig()
 109 {
 110     KSharedConfigPtr config = KGlobal::config();
 111     KConfigGroup scopeConfig(config, configName());
 112     m_aAutoRefresh->setChecked(scopeConfig.readEntry("autoRefresh", true));
 113     m_aRealtime->setChecked(scopeConfig.readEntry("realtime", false));
 114     scopeConfig.sync();
 115 }
 116
 117 void AbstractScopeWidget::writeConfig()
 118 {
 119     KSharedConfigPtr config = KGlobal::config();
 120     KConfigGroup scopeConfig(config, configName());
 121     scopeConfig.writeEntry("autoRefresh", m_aAutoRefresh->isChecked());
 122     scopeConfig.writeEntry("realtime", m_aRealtime->isChecked());
 123     scopeConfig.sync();
 124 }
 125
 126 QString AbstractScopeWidget::configName() { return "Scope_" + m_widgetName; }
 127
 128 void AbstractScopeWidget::prodHUDThread()
 129 {
 130     if (this->visibleRegion().isEmpty()) {
 131 //        qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating HUD.";
 132     } else {
 133         if (m_semaphoreHUD.tryAcquire(1)) {
 134             Q_ASSERT(!m_threadHUD.isRunning());
 135
 136             m_newHUDFrames.fetchAndStoreRelaxed(0);
 137             m_newHUDUpdates.fetchAndStoreRelaxed(0);
 138             m_threadHUD = QtConcurrent::run(this, &AbstractScopeWidget::renderHUD, m_accelFactorHUD);
 139 //            qDebug() << "HUD thread started in " << m_widgetName;
 140
 141         } else {
 142 //            qDebug() << "HUD semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadHUD.isRunning();
 143         }
 144     }
 145 }
 146
 147 void AbstractScopeWidget::prodScopeThread()
 148 {
 149     // Only start a new thread if the scope is actually visible
 150     // and not hidden by another widget on the stack.
 151     if (this->visibleRegion().isEmpty()) {
 152 //        qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating scope.";
 153     } else {
 154         // Try to acquire the semaphore. This must only succeed if m_threadScope is not running
 155         // anymore. Therefore the semaphore must NOT be released before m_threadScope ends.
 156         // If acquiring the semaphore fails, the thread is still running.
 157         if (m_semaphoreScope.tryAcquire(1)) {
 158             Q_ASSERT(!m_threadScope.isRunning());
 159
 160             m_newScopeFrames.fetchAndStoreRelaxed(0);
 161             m_newScopeUpdates.fetchAndStoreRelaxed(0);
 162
 163             Q_ASSERT(m_accelFactorScope > 0);
 164
 165             // See http://doc.qt.nokia.com/latest/qtconcurrentrun.html#run about
 166             // running member functions in a thread
 167             m_threadScope = QtConcurrent::run(this, &AbstractScopeWidget::renderScope, m_accelFactorScope, m_scopeImage);
 168
 169 //            qDebug() << "Scope thread started in " << m_widgetName;
 170
 171         } else {
 172 //            qDebug() << "Scope semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadScope.isRunning();
 173         }
 174     }
 175 }
 176 void AbstractScopeWidget::prodBackgroundThread()
 177 {
 178     if (this->visibleRegion().isEmpty()) {
 179 //        qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating background.";
 180     } else {
 181         if (m_semaphoreBackground.tryAcquire(1)) {
 182             Q_ASSERT(!m_threadBackground.isRunning());
 183
 184             m_newBackgroundFrames.fetchAndStoreRelaxed(0);
 185             m_newBackgroundUpdates.fetchAndStoreRelaxed(0);
 186             m_threadBackground = QtConcurrent::run(this, &AbstractScopeWidget::renderBackground, m_accelFactorBackground);
 187 //            qDebug() << "Background thread started in " << m_widgetName;
 188
 189         } else {
 190 //            qDebug() << "Background semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadBackground.isRunning();
 191         }
 192     }
 193 }
 194
 195 void AbstractScopeWidget::forceUpdate(bool doUpdate)
 196 {
 197 //    qDebug() << "Force update called in " << widgetName() << ". Arg: " << doUpdate;
 198     if (!doUpdate) { return; }
 199     m_newHUDUpdates.fetchAndAddRelaxed(1);
 200     m_newScopeUpdates.fetchAndAddRelaxed(1);
 201     m_newBackgroundUpdates.fetchAndAddRelaxed(1);
 202     prodHUDThread();
 203     prodScopeThread();
 204     prodBackgroundThread();
 205 }
 206 void AbstractScopeWidget::forceUpdateHUD()
 207 {
 208     m_newHUDUpdates.fetchAndAddRelaxed(1);
 209     prodHUDThread();
 210
 211 }
 212 void AbstractScopeWidget::forceUpdateScope()
 213 {
 214     m_newScopeUpdates.fetchAndAddRelaxed(1);
 215     prodScopeThread();
 216
 217 }
 218 void AbstractScopeWidget::forceUpdateBackground()
 219 {
 220     m_newBackgroundUpdates.fetchAndAddRelaxed(1);
 221     prodBackgroundThread();
 222
 223 }
 224
 225
 226 ///// Events /////
 227
 228 void AbstractScopeWidget::mouseReleaseEvent(QMouseEvent *event)
 229 {
 230     prodHUDThread();
 231     prodScopeThread();
 232     prodBackgroundThread();
 233     QWidget::mouseReleaseEvent(event);
 234 }
 235
 236 void AbstractScopeWidget::resizeEvent(QResizeEvent *event)
 237 {
 238     // Update the dimension of the available rect for painting
 239     m_scopeRect = scopeRect();
 240
 241     forceUpdate();
 242
 243     QWidget::resizeEvent(event);
 244 }
 245
 246 void AbstractScopeWidget::showEvent(QShowEvent *event)
 247 {
 248     QWidget::showEvent(event);
 249     m_scopeRect = scopeRect();
 250 }
 251
 252 void AbstractScopeWidget::paintEvent(QPaintEvent *)
 253 {
 254     QPainter davinci(this);
 255     davinci.drawImage(m_scopeRect.topLeft(), m_imgBackground);
 256     davinci.drawImage(m_scopeRect.topLeft(), m_imgScope);
 257     davinci.drawImage(m_scopeRect.topLeft(), m_imgHUD);
 258 }
 259
 260 void AbstractScopeWidget::mouseMoveEvent(QMouseEvent *event)
 261 {
 262     m_mousePos = event->pos();
 263     m_mouseWithinWidget = true;
 264     emit signalMousePositionChanged();
 265 }
 266 void AbstractScopeWidget::leaveEvent(QEvent *)
 267 {
 268     m_mouseWithinWidget = false;
 269     emit signalMousePositionChanged();
 270 }
 271
 272 void AbstractScopeWidget::customContextMenuRequested(const QPoint &pos)
 273 {
 274     m_menu->exec(this->mapToGlobal(pos));
 275 }
 276
 277 uint AbstractScopeWidget::calculateAccelFactorHUD(uint oldMseconds, uint) { return ceil((float)oldMseconds*REALTIME_FPS/1000 ); }
 278 uint AbstractScopeWidget::calculateAccelFactorScope(uint oldMseconds, uint) { return ceil((float)oldMseconds*REALTIME_FPS/1000 ); }
 279 uint AbstractScopeWidget::calculateAccelFactorBackground(uint oldMseconds, uint) { return ceil((float)oldMseconds*REALTIME_FPS/1000 ); }
 280
 281
 282 ///// Slots /////
 283
 284 void AbstractScopeWidget::slotHUDRenderingFinished(uint mseconds, uint oldFactor)
 285 {
 286 //    qDebug() << "HUD rendering has finished, waiting for termination in " << m_widgetName;
 287     m_threadHUD.waitForFinished();
 288     m_imgHUD = m_threadHUD.result();
 289
 290     m_semaphoreHUD.release(1);
 291     this->update();
 292
 293     int accel;
 294     if (m_aRealtime->isChecked()) {
 295         accel = calculateAccelFactorHUD(mseconds, oldFactor);
 296         if (m_accelFactorHUD < 1) {
 297             accel = 1;
 298         }
 299         m_accelFactorHUD = accel;
 300     }
 301
 302     if ( (m_newHUDFrames > 0 && m_aAutoRefresh->isChecked()) || m_newHUDUpdates > 0) {
 303 //        qDebug() << "Trying to start a new HUD thread for " << m_widgetName
 304 //                << ". New frames/updates: " << m_newHUDFrames << "/" << m_newHUDUpdates;
 305         prodHUDThread();;
 306     }
 307 }
 308
 309 void AbstractScopeWidget::slotScopeRenderingFinished(uint mseconds, uint oldFactor)
 310 {
 311     // The signal can be received before the thread has really finished. So we
 312     // need to wait until it has really finished before starting a new thread.
 313 //    qDebug() << "Scope rendering has finished, waiting for termination in " << m_widgetName;
 314     m_threadScope.waitForFinished();
 315     m_imgScope = m_threadScope.result();
 316
 317     // The scope thread has finished. Now we can release the semaphore, allowing a new thread.
 318     // See prodScopeThread where the semaphore is acquired again.
 319     m_semaphoreScope.release(1);
 320     this->update();
 321
 322     // Calculate the acceleration factor hint to get «realtime» updates.
 323     int accel;
 324     if (m_aRealtime->isChecked()) {
 325         accel = calculateAccelFactorScope(mseconds, oldFactor);
 326         if (accel < 1) {
 327             // If mseconds happens to be 0.
 328             accel = 1;
 329         }
 330         // Don't directly calculate with m_accelFactorScope as we are dealing with concurrency.
 331         // If m_accelFactorScope is set to 0 at the wrong moment, who knows what might happen
 332         // then :) Therefore use a local variable.
 333         m_accelFactorScope = accel;
 334     }
 335
 336     if ( (m_newScopeFrames > 0 && m_aAutoRefresh->isChecked()) || m_newScopeUpdates > 0) {
 337 //        qDebug() << "Trying to start a new scope thread for " << m_widgetName
 338 //                << ". New frames/updates: " << m_newScopeFrames << "/" << m_newScopeUpdates;
 339         prodScopeThread();
 340     }
 341 }
 342
 343 void AbstractScopeWidget::slotBackgroundRenderingFinished(uint mseconds, uint oldFactor)
 344 {
 345 //    qDebug() << "Background rendering has finished, waiting for termination in " << m_widgetName;
 346     m_threadBackground.waitForFinished();
 347     m_imgBackground = m_threadBackground.result();
 348
 349     m_semaphoreBackground.release(1);
 350     this->update();
 351
 352     int accel;
 353     if (m_aRealtime->isChecked()) {
 354         accel = calculateAccelFactorBackground(mseconds, oldFactor);
 355         if (m_accelFactorBackground < 1) {
 356             accel = 1;
 357         }
 358         m_accelFactorBackground = accel;
 359     }
 360
 361     if ( (m_newBackgroundFrames > 0 && m_aAutoRefresh->isChecked()) || m_newBackgroundUpdates > 0) {
 362 //        qDebug() << "Trying to start a new background thread for " << m_widgetName
 363 //                << ". New frames/updates: " << m_newBackgroundFrames << "/" << m_newBackgroundUpdates;
 364         prodBackgroundThread();;
 365     }
 366 }
 367
 368 void AbstractScopeWidget::slotActiveMonitorChanged(bool isClipMonitor)
 369 {
 370 //    qDebug() << "Active monitor has changed in " << m_widgetName << ". Is the clip monitor active now? " << isClipMonitor;
 371
 372     bool b = m_activeRender->disconnect(this);
 373     Q_ASSERT(b);
 374
 375     m_activeRender = (isClipMonitor) ? m_clipMonitor->render : m_projMonitor->render;
 376
 377     b &= connect(m_activeRender, SIGNAL(rendererPosition(int)), this, SLOT(slotRenderZoneUpdated()));
 378     b &= connect(m_activeRender, SIGNAL(frameUpdated(QImage)), this, SLOT(slotRenderZoneUpdated(QImage)));
 379     Q_ASSERT(b);
 380
 381     // Update the scope for the new monitor.
 382     prodHUDThread();
 383     prodScopeThread();
 384     prodBackgroundThread();
 385 }
 386
 387 void AbstractScopeWidget::slotRenderZoneUpdated()
 388 {
 389     m_newHUDFrames.fetchAndAddRelaxed(1);
 390     m_newScopeFrames.fetchAndAddRelaxed(1);
 391     m_newBackgroundFrames.fetchAndAddRelaxed(1);
 392
 393 //    qDebug() << "Monitor incoming. New frames total HUD/Scope/Background: " << m_newHUDFrames
 394 //            << "/" << m_newScopeFrames << "/" << m_newBackgroundFrames;
 395
 396     if (this->visibleRegion().isEmpty()) {
 397 //        qDebug() << "Scope of widget " << m_widgetName << " is not at the top, not rendering.";
 398     } else {
 399         if (m_aAutoRefresh->isChecked()) {
 400             prodHUDThread();
 401             prodScopeThread();
 402             prodBackgroundThread();
 403         }
 404     }
 405 }
 406
 407 void AbstractScopeWidget::slotRenderZoneUpdated(QImage frame)
 408 {
 409     m_scopeImage = frame;
 410     slotRenderZoneUpdated();
 411 }
 412
 413 void AbstractScopeWidget::slotResetRealtimeFactor(bool realtimeChecked)
 414 {
 415     if (!realtimeChecked) {
 416         m_accelFactorHUD = 1;
 417         m_accelFactorScope = 1;
 418         m_accelFactorBackground = 1;
 419     }
 420 }
 421
 422 void AbstractScopeWidget::slotAutoRefreshToggled(bool autoRefresh)
 423 {
 424     // TODO only if depends on input
 425     if (autoRefresh) {
 426         forceUpdate();
 427     }
 428 }