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 ***************************************************************************/
11 #include "qtconcurrentrun.h"
13 #include "abstractscopewidget.h"
20 #include <QMouseEvent>
23 #include <KConfigGroup>
25 // Uncomment for Scope debugging.
32 const int REALTIME_FPS = 30;
34 const QColor light(250, 238, 226, 255);
35 const QColor dark(40, 40, 39, 255);
36 const QColor dark2(25, 25, 23, 255);
37 const QColor AbstractScopeWidget::colHighlightLight(18, 130, 255, 255);
38 const QColor AbstractScopeWidget::colHighlightDark(255, 64, 19, 255);
39 const QColor AbstractScopeWidget::colDarkWhite(250, 250, 250);
41 const QPen AbstractScopeWidget::penThick(QBrush(AbstractScopeWidget::colDarkWhite.rgb()), 2, Qt::SolidLine);
42 const QPen AbstractScopeWidget::penThin(QBrush(AbstractScopeWidget::colDarkWhite.rgb()), 1, Qt::SolidLine);
43 const QPen AbstractScopeWidget::penLight(QBrush(QColor(200, 200, 250, 150)), 1, Qt::SolidLine);
44 const QPen AbstractScopeWidget::penLightDots(QBrush(QColor(200, 200, 250, 150)), 1, Qt::DotLine);
45 const QPen AbstractScopeWidget::penLighter(QBrush(QColor(225, 225, 250, 225)), 1, Qt::SolidLine);
46 const QPen AbstractScopeWidget::penDark(QBrush(QColor(0, 0, 20, 250)), 1, Qt::SolidLine);
47 const QPen AbstractScopeWidget::penDarkDots(QBrush(QColor(0, 0, 20, 250)), 1, Qt::DotLine);
48 const QPen AbstractScopeWidget::penBackground(QBrush(dark2), 1, Qt::SolidLine);
50 const QString AbstractScopeWidget::directions[] = {"North", "Northeast", "East", "Southeast"};
52 AbstractScopeWidget::AbstractScopeWidget(bool trackMouse, QWidget *parent) :
55 , m_mouseWithinWidget(false)
58 , m_accelFactorScope(1)
59 , m_accelFactorBackground(1)
62 , m_semaphoreBackground(1)
63 , initialDimensionUpdateDone(false)
64 , m_requestForcedUpdate(false)
66 , m_rescaleVerticalThreshold(2.0f)
67 , m_rescaleActive(false)
68 , m_rescalePropertiesLocked(false)
69 , m_rescaleFirstRescaleDone(true)
70 , m_rescaleDirection(North)
73 m_scopePalette = QPalette();
74 m_scopePalette.setBrush(QPalette::Window, QBrush(dark2));
75 m_scopePalette.setBrush(QPalette::Base, QBrush(dark));
76 m_scopePalette.setBrush(QPalette::Button, QBrush(dark));
77 m_scopePalette.setBrush(QPalette::Text, QBrush(light));
78 m_scopePalette.setBrush(QPalette::WindowText, QBrush(light));
79 m_scopePalette.setBrush(QPalette::ButtonText, QBrush(light));
80 this->setPalette(m_scopePalette);
81 this->setAutoFillBackground(true);
83 m_aAutoRefresh = new QAction(i18n("Auto Refresh"), this);
84 m_aAutoRefresh->setCheckable(true);
85 m_aRealtime = new QAction(i18n("Realtime (with precision loss)"), this);
86 m_aRealtime->setCheckable(true);
88 m_menu = new QMenu(this);
89 // Disabled dark palette on menus since it breaks up with some themes: kdenlive issue #2950
90 //m_menu->setPalette(m_scopePalette);
91 m_menu->addAction(m_aAutoRefresh);
92 m_menu->addAction(m_aRealtime);
94 this->setContextMenuPolicy(Qt::CustomContextMenu);
97 b &= connect(this, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(customContextMenuRequested(QPoint)));
99 b &= connect(this, SIGNAL(signalHUDRenderingFinished(uint, uint)), this, SLOT(slotHUDRenderingFinished(uint, uint)));
100 b &= connect(this, SIGNAL(signalScopeRenderingFinished(uint, uint)), this, SLOT(slotScopeRenderingFinished(uint, uint)));
101 b &= connect(this, SIGNAL(signalBackgroundRenderingFinished(uint, uint)), this, SLOT(slotBackgroundRenderingFinished(uint, uint)));
102 b &= connect(m_aRealtime, SIGNAL(toggled(bool)), this, SLOT(slotResetRealtimeFactor(bool)));
103 b &= connect(m_aAutoRefresh, SIGNAL(toggled(bool)), this, SLOT(slotAutoRefreshToggled(bool)));
106 // Enable mouse tracking if desired.
107 // Causes the mouseMoved signal to be emitted when the mouse moves inside the
108 // widget, even when no mouse button is pressed.
109 this->setMouseTracking(trackMouse);
112 AbstractScopeWidget::~AbstractScopeWidget()
117 delete m_aAutoRefresh;
121 void AbstractScopeWidget::init()
123 m_widgetName = widgetName();
127 void AbstractScopeWidget::readConfig()
129 KSharedConfigPtr config = KGlobal::config();
130 KConfigGroup scopeConfig(config, configName());
131 m_aAutoRefresh->setChecked(scopeConfig.readEntry("autoRefresh", true));
132 m_aRealtime->setChecked(scopeConfig.readEntry("realtime", false));
136 void AbstractScopeWidget::writeConfig()
138 KSharedConfigPtr config = KGlobal::config();
139 KConfigGroup scopeConfig(config, configName());
140 scopeConfig.writeEntry("autoRefresh", m_aAutoRefresh->isChecked());
141 scopeConfig.writeEntry("realtime", m_aRealtime->isChecked());
145 QString AbstractScopeWidget::configName()
147 return "Scope_" + m_widgetName;
150 void AbstractScopeWidget::prodHUDThread()
152 if (this->visibleRegion().isEmpty()) {
154 qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating HUD.";
157 if (m_semaphoreHUD.tryAcquire(1)) {
158 Q_ASSERT(!m_threadHUD.isRunning());
160 m_newHUDFrames.fetchAndStoreRelaxed(0);
161 m_newHUDUpdates.fetchAndStoreRelaxed(0);
162 m_threadHUD = QtConcurrent::run(this, &AbstractScopeWidget::renderHUD, m_accelFactorHUD);
164 qDebug() << "HUD thread started in " << m_widgetName;
170 qDebug() << "HUD semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadHUD.isRunning();
176 void AbstractScopeWidget::prodScopeThread()
178 // Only start a new thread if the scope is actually visible
179 // and not hidden by another widget on the stack and if user want the scope to update.
180 if (this->visibleRegion().isEmpty() || (!m_aAutoRefresh->isChecked() && !m_requestForcedUpdate)) {
182 qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating scope.";
185 // Try to acquire the semaphore. This must only succeed if m_threadScope is not running
186 // anymore. Therefore the semaphore must NOT be released before m_threadScope ends.
187 // If acquiring the semaphore fails, the thread is still running.
188 if (m_semaphoreScope.tryAcquire(1)) {
189 Q_ASSERT(!m_threadScope.isRunning());
191 m_newScopeFrames.fetchAndStoreRelaxed(0);
192 m_newScopeUpdates.fetchAndStoreRelaxed(0);
194 Q_ASSERT(m_accelFactorScope > 0);
196 // See http://doc.qt.nokia.com/latest/qtconcurrentrun.html#run about
197 // running member functions in a thread
198 m_threadScope = QtConcurrent::run(this, &AbstractScopeWidget::renderScope, m_accelFactorScope);
199 m_requestForcedUpdate = false;
202 qDebug() << "Scope thread started in " << m_widgetName;
207 qDebug() << "Scope semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadScope.isRunning();
212 void AbstractScopeWidget::prodBackgroundThread()
214 if (this->visibleRegion().isEmpty()) {
216 qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating background.";
219 if (m_semaphoreBackground.tryAcquire(1)) {
220 Q_ASSERT(!m_threadBackground.isRunning());
222 m_newBackgroundFrames.fetchAndStoreRelaxed(0);
223 m_newBackgroundUpdates.fetchAndStoreRelaxed(0);
224 m_threadBackground = QtConcurrent::run(this, &AbstractScopeWidget::renderBackground, m_accelFactorBackground);
227 qDebug() << "Background thread started in " << m_widgetName;
232 qDebug() << "Background semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadBackground.isRunning();
238 void AbstractScopeWidget::forceUpdate(bool doUpdate)
241 qDebug() << "Forced update called in " << widgetName() << ". Arg: " << doUpdate;
247 m_requestForcedUpdate = true;
248 m_newHUDUpdates.fetchAndAddRelaxed(1);
249 m_newScopeUpdates.fetchAndAddRelaxed(1);
250 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
253 prodBackgroundThread();
255 void AbstractScopeWidget::forceUpdateHUD()
257 m_newHUDUpdates.fetchAndAddRelaxed(1);
261 void AbstractScopeWidget::forceUpdateScope()
263 m_newScopeUpdates.fetchAndAddRelaxed(1);
264 m_requestForcedUpdate = true;
268 void AbstractScopeWidget::forceUpdateBackground()
270 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
271 prodBackgroundThread();
279 void AbstractScopeWidget::resizeEvent(QResizeEvent *event)
281 // Update the dimension of the available rect for painting
282 m_scopeRect = scopeRect();
285 QWidget::resizeEvent(event);
288 void AbstractScopeWidget::showEvent(QShowEvent *event)
290 QWidget::showEvent(event);
291 m_scopeRect = scopeRect();
294 void AbstractScopeWidget::paintEvent(QPaintEvent *)
296 QPainter davinci(this);
297 davinci.drawImage(m_scopeRect.topLeft(), m_imgBackground);
298 davinci.drawImage(m_scopeRect.topLeft(), m_imgScope);
299 davinci.drawImage(m_scopeRect.topLeft(), m_imgHUD);
302 void AbstractScopeWidget::mousePressEvent(QMouseEvent *event)
304 if (event->button() == Qt::LeftButton) {
305 // Rescaling mode starts
306 m_rescaleActive = true;
307 m_rescalePropertiesLocked = false;
308 m_rescaleFirstRescaleDone = false;
309 m_rescaleStartPoint = event->pos();
310 m_rescaleModifiers = event->modifiers();
313 void AbstractScopeWidget::mouseReleaseEvent(QMouseEvent *event)
315 m_rescaleActive = false;
316 m_rescalePropertiesLocked = false;
318 if (!m_aAutoRefresh->isChecked()) {
319 m_requestForcedUpdate = true;
323 prodBackgroundThread();
324 QWidget::mouseReleaseEvent(event);
326 void AbstractScopeWidget::mouseMoveEvent(QMouseEvent *event)
328 m_mousePos = event->pos();
329 m_mouseWithinWidget = true;
330 emit signalMousePositionChanged();
332 QPoint movement = event->pos()-m_rescaleStartPoint;
334 if (m_rescaleActive) {
335 if (m_rescalePropertiesLocked) {
336 // Direction is known, now adjust parameters
338 // Reset the starting point to make the next moveEvent relative to the current one
339 m_rescaleStartPoint = event->pos();
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
346 if (movement.x() != 0) {
347 movement.setX(movement.x() / abs(movement.x()));
349 if (movement.y() != 0) {
350 movement.setY(movement.y() / abs(movement.y()));
353 m_rescaleFirstRescaleDone = true;
356 handleMouseDrag(movement, m_rescaleDirection, m_rescaleModifiers);
361 // Detect the movement direction here.
362 // This algorithm relies on the aspect ratio of dy/dx (size and signum).
363 if (movement.manhattanLength() > m_rescaleMinDist) {
364 float diff = ((float) movement.y())/movement.x();
366 if (abs(diff) > m_rescaleVerticalThreshold || movement.x() == 0) {
367 m_rescaleDirection = North;
368 } else if (abs(diff) < 1/m_rescaleVerticalThreshold) {
369 m_rescaleDirection = East;
370 } else if (diff < 0) {
371 m_rescaleDirection = Northeast;
373 m_rescaleDirection = Southeast;
376 qDebug() << "Diff is " << diff << "; chose " << directions[m_rescaleDirection] << " as direction";
378 m_rescalePropertiesLocked = true;
384 void AbstractScopeWidget::leaveEvent(QEvent *)
386 m_mouseWithinWidget = false;
387 emit signalMousePositionChanged();
390 void AbstractScopeWidget::customContextMenuRequested(const QPoint &pos)
392 m_menu->exec(this->mapToGlobal(pos));
395 uint AbstractScopeWidget::calculateAccelFactorHUD(uint oldMseconds, uint)
397 return ceil((float)oldMseconds*REALTIME_FPS / 1000);
399 uint AbstractScopeWidget::calculateAccelFactorScope(uint oldMseconds, uint)
401 return ceil((float)oldMseconds*REALTIME_FPS / 1000);
403 uint AbstractScopeWidget::calculateAccelFactorBackground(uint oldMseconds, uint)
405 return ceil((float)oldMseconds*REALTIME_FPS / 1000);
411 void AbstractScopeWidget::slotHUDRenderingFinished(uint mseconds, uint oldFactor)
414 qDebug() << "HUD rendering has finished in " << mseconds << " ms, waiting for termination in " << m_widgetName;
416 m_threadHUD.waitForFinished();
417 m_imgHUD = m_threadHUD.result();
419 m_semaphoreHUD.release(1);
423 if (m_aRealtime->isChecked()) {
424 accel = calculateAccelFactorHUD(mseconds, oldFactor);
425 if (m_accelFactorHUD < 1) {
428 m_accelFactorHUD = accel;
431 if ((m_newHUDFrames > 0 && m_aAutoRefresh->isChecked()) || m_newHUDUpdates > 0) {
433 qDebug() << "Trying to start a new HUD thread for " << m_widgetName
434 << ". New frames/updates: " << m_newHUDFrames << "/" << m_newHUDUpdates;
440 void AbstractScopeWidget::slotScopeRenderingFinished(uint mseconds, uint oldFactor)
442 // The signal can be received before the thread has really finished. So we
443 // need to wait until it has really finished before starting a new thread.
445 qDebug() << "Scope rendering has finished in " << mseconds << " ms, waiting for termination in " << m_widgetName;
447 m_threadScope.waitForFinished();
448 m_imgScope = m_threadScope.result();
450 // The scope thread has finished. Now we can release the semaphore, allowing a new thread.
451 // See prodScopeThread where the semaphore is acquired again.
452 m_semaphoreScope.release(1);
455 // Calculate the acceleration factor hint to get «realtime» updates.
457 if (m_aRealtime->isChecked()) {
458 accel = calculateAccelFactorScope(mseconds, oldFactor);
460 // If mseconds happens to be 0.
463 // Don't directly calculate with m_accelFactorScope as we are dealing with concurrency.
464 // If m_accelFactorScope is set to 0 at the wrong moment, who knows what might happen
465 // then :) Therefore use a local variable.
466 m_accelFactorScope = accel;
469 if ((m_newScopeFrames > 0 && m_aAutoRefresh->isChecked()) || m_newScopeUpdates > 0) {
471 qDebug() << "Trying to start a new scope thread for " << m_widgetName
472 << ". New frames/updates: " << m_newScopeFrames << "/" << m_newScopeUpdates;
478 void AbstractScopeWidget::slotBackgroundRenderingFinished(uint mseconds, uint oldFactor)
481 qDebug() << "Background rendering has finished in " << mseconds << " ms, waiting for termination in " << m_widgetName;
483 m_threadBackground.waitForFinished();
484 m_imgBackground = m_threadBackground.result();
486 m_semaphoreBackground.release(1);
490 if (m_aRealtime->isChecked()) {
491 accel = calculateAccelFactorBackground(mseconds, oldFactor);
492 if (m_accelFactorBackground < 1) {
495 m_accelFactorBackground = accel;
498 if ((m_newBackgroundFrames > 0 && m_aAutoRefresh->isChecked()) || m_newBackgroundUpdates > 0) {
500 qDebug() << "Trying to start a new background thread for " << m_widgetName
501 << ". New frames/updates: " << m_newBackgroundFrames << "/" << m_newBackgroundUpdates;
503 prodBackgroundThread();;
507 void AbstractScopeWidget::slotRenderZoneUpdated()
509 m_newHUDFrames.fetchAndAddRelaxed(1);
510 m_newScopeFrames.fetchAndAddRelaxed(1);
511 m_newBackgroundFrames.fetchAndAddRelaxed(1);
514 qDebug() << "Data incoming at " << widgetName() << ". New frames total HUD/Scope/Background: " << m_newHUDFrames
515 << "/" << m_newScopeFrames << "/" << m_newBackgroundFrames;
518 if (this->visibleRegion().isEmpty()) {
520 qDebug() << "Scope of widget " << m_widgetName << " is not at the top, not rendering.";
523 if (m_aAutoRefresh->isChecked()) {
526 prodBackgroundThread();
531 void AbstractScopeWidget::slotResetRealtimeFactor(bool realtimeChecked)
533 if (!realtimeChecked) {
534 m_accelFactorHUD = 1;
535 m_accelFactorScope = 1;
536 m_accelFactorBackground = 1;
540 bool AbstractScopeWidget::autoRefreshEnabled() const
542 return m_aAutoRefresh->isChecked();
545 void AbstractScopeWidget::slotAutoRefreshToggled(bool autoRefresh)
548 qDebug() << "Auto-refresh switched to " << autoRefresh << " in " << widgetName()
549 << " (Visible: " << isVisible() << "/" << this->visibleRegion().isEmpty() << ")";
552 // Notify listeners whether we accept new frames now
553 emit requestAutoRefresh(autoRefresh);
555 // TODO only if depends on input
558 m_requestForcedUpdate = true;
562 void AbstractScopeWidget::handleMouseDrag(const QPoint &, const RescaleDirection, const Qt::KeyboardModifiers) { }