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