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)
69 m_scopePalette = QPalette();
70 m_scopePalette.setBrush(QPalette::Window, QBrush(dark2));
71 m_scopePalette.setBrush(QPalette::Base, QBrush(dark));
72 m_scopePalette.setBrush(QPalette::Button, QBrush(dark));
73 m_scopePalette.setBrush(QPalette::Text, QBrush(light));
74 m_scopePalette.setBrush(QPalette::WindowText, QBrush(light));
75 m_scopePalette.setBrush(QPalette::ButtonText, QBrush(light));
76 this->setPalette(m_scopePalette);
77 this->setAutoFillBackground(true);
79 m_aAutoRefresh = new QAction(i18n("Auto Refresh"), this);
80 m_aAutoRefresh->setCheckable(true);
81 m_aRealtime = new QAction(i18n("Realtime (with precision loss)"), this);
82 m_aRealtime->setCheckable(true);
84 m_menu = new QMenu(this);
85 m_menu->setPalette(m_scopePalette);
86 m_menu->addAction(m_aAutoRefresh);
87 m_menu->addAction(m_aRealtime);
89 this->setContextMenuPolicy(Qt::CustomContextMenu);
92 b &= connect(this, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(customContextMenuRequested(QPoint)));
94 b &= connect(this, SIGNAL(signalHUDRenderingFinished(uint, uint)), this, SLOT(slotHUDRenderingFinished(uint, uint)));
95 b &= connect(this, SIGNAL(signalScopeRenderingFinished(uint, uint)), this, SLOT(slotScopeRenderingFinished(uint, uint)));
96 b &= connect(this, SIGNAL(signalBackgroundRenderingFinished(uint, uint)), this, SLOT(slotBackgroundRenderingFinished(uint, uint)));
97 b &= connect(m_aRealtime, SIGNAL(toggled(bool)), this, SLOT(slotResetRealtimeFactor(bool)));
98 b &= connect(m_aAutoRefresh, SIGNAL(toggled(bool)), this, SLOT(slotAutoRefreshToggled(bool)));
101 // Enable mouse tracking if desired.
102 // Causes the mouseMoved signal to be emitted when the mouse moves inside the
103 // widget, even when no mouse button is pressed.
104 this->setMouseTracking(trackMouse);
107 AbstractScopeWidget::~AbstractScopeWidget()
112 delete m_aAutoRefresh;
116 void AbstractScopeWidget::init()
118 m_widgetName = widgetName();
122 void AbstractScopeWidget::readConfig()
124 KSharedConfigPtr config = KGlobal::config();
125 KConfigGroup scopeConfig(config, configName());
126 m_aAutoRefresh->setChecked(scopeConfig.readEntry("autoRefresh", true));
127 m_aRealtime->setChecked(scopeConfig.readEntry("realtime", false));
131 void AbstractScopeWidget::writeConfig()
133 KSharedConfigPtr config = KGlobal::config();
134 KConfigGroup scopeConfig(config, configName());
135 scopeConfig.writeEntry("autoRefresh", m_aAutoRefresh->isChecked());
136 scopeConfig.writeEntry("realtime", m_aRealtime->isChecked());
140 QString AbstractScopeWidget::configName()
142 return "Scope_" + m_widgetName;
145 void AbstractScopeWidget::prodHUDThread()
147 if (this->visibleRegion().isEmpty()) {
149 qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating HUD.";
152 if (m_semaphoreHUD.tryAcquire(1)) {
153 Q_ASSERT(!m_threadHUD.isRunning());
155 m_newHUDFrames.fetchAndStoreRelaxed(0);
156 m_newHUDUpdates.fetchAndStoreRelaxed(0);
157 m_threadHUD = QtConcurrent::run(this, &AbstractScopeWidget::renderHUD, m_accelFactorHUD);
159 qDebug() << "HUD thread started in " << m_widgetName;
165 qDebug() << "HUD semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadHUD.isRunning();
171 void AbstractScopeWidget::prodScopeThread()
173 // Only start a new thread if the scope is actually visible
174 // and not hidden by another widget on the stack and if user want the scope to update.
175 if (this->visibleRegion().isEmpty() || (!m_aAutoRefresh->isChecked() && !m_requestForcedUpdate)) {
177 qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating scope.";
180 // Try to acquire the semaphore. This must only succeed if m_threadScope is not running
181 // anymore. Therefore the semaphore must NOT be released before m_threadScope ends.
182 // If acquiring the semaphore fails, the thread is still running.
183 if (m_semaphoreScope.tryAcquire(1)) {
184 Q_ASSERT(!m_threadScope.isRunning());
186 m_newScopeFrames.fetchAndStoreRelaxed(0);
187 m_newScopeUpdates.fetchAndStoreRelaxed(0);
189 Q_ASSERT(m_accelFactorScope > 0);
191 // See http://doc.qt.nokia.com/latest/qtconcurrentrun.html#run about
192 // running member functions in a thread
193 m_threadScope = QtConcurrent::run(this, &AbstractScopeWidget::renderScope, m_accelFactorScope);
194 m_requestForcedUpdate = false;
197 qDebug() << "Scope thread started in " << m_widgetName;
202 qDebug() << "Scope semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadScope.isRunning();
207 void AbstractScopeWidget::prodBackgroundThread()
209 if (this->visibleRegion().isEmpty()) {
211 qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating background.";
214 if (m_semaphoreBackground.tryAcquire(1)) {
215 Q_ASSERT(!m_threadBackground.isRunning());
217 m_newBackgroundFrames.fetchAndStoreRelaxed(0);
218 m_newBackgroundUpdates.fetchAndStoreRelaxed(0);
219 m_threadBackground = QtConcurrent::run(this, &AbstractScopeWidget::renderBackground, m_accelFactorBackground);
222 qDebug() << "Background thread started in " << m_widgetName;
227 qDebug() << "Background semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadBackground.isRunning();
233 void AbstractScopeWidget::forceUpdate(bool doUpdate)
236 qDebug() << "Forced update called in " << widgetName() << ". Arg: " << doUpdate;
242 m_requestForcedUpdate = true;
243 m_newHUDUpdates.fetchAndAddRelaxed(1);
244 m_newScopeUpdates.fetchAndAddRelaxed(1);
245 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
248 prodBackgroundThread();
250 void AbstractScopeWidget::forceUpdateHUD()
252 m_newHUDUpdates.fetchAndAddRelaxed(1);
256 void AbstractScopeWidget::forceUpdateScope()
258 m_newScopeUpdates.fetchAndAddRelaxed(1);
259 m_requestForcedUpdate = true;
263 void AbstractScopeWidget::forceUpdateBackground()
265 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
266 prodBackgroundThread();
274 void AbstractScopeWidget::resizeEvent(QResizeEvent *event)
276 // Update the dimension of the available rect for painting
277 m_scopeRect = scopeRect();
280 QWidget::resizeEvent(event);
283 void AbstractScopeWidget::showEvent(QShowEvent *event)
285 QWidget::showEvent(event);
286 m_scopeRect = scopeRect();
289 void AbstractScopeWidget::paintEvent(QPaintEvent *)
291 QPainter davinci(this);
292 davinci.drawImage(m_scopeRect.topLeft(), m_imgBackground);
293 davinci.drawImage(m_scopeRect.topLeft(), m_imgScope);
294 davinci.drawImage(m_scopeRect.topLeft(), m_imgHUD);
297 void AbstractScopeWidget::mousePressEvent(QMouseEvent *event)
299 if (event->button() == Qt::LeftButton) {
300 // Rescaling mode starts
301 m_rescaleActive = true;
302 m_rescalePropertiesLocked = false;
303 m_rescaleFirstRescaleDone = false;
304 m_rescaleStartPoint = event->pos();
305 m_rescaleModifiers = event->modifiers();
308 void AbstractScopeWidget::mouseReleaseEvent(QMouseEvent *event)
310 m_rescaleActive = false;
311 m_rescalePropertiesLocked = false;
313 if (!m_aAutoRefresh->isChecked()) {
314 m_requestForcedUpdate = true;
318 prodBackgroundThread();
319 QWidget::mouseReleaseEvent(event);
321 void AbstractScopeWidget::mouseMoveEvent(QMouseEvent *event)
323 m_mousePos = event->pos();
324 m_mouseWithinWidget = true;
325 emit signalMousePositionChanged();
327 QPoint movement = event->pos()-m_rescaleStartPoint;
329 if (m_rescaleActive) {
330 if (m_rescalePropertiesLocked) {
331 // Direction is known, now adjust parameters
333 // Reset the starting point to make the next moveEvent relative to the current one
334 m_rescaleStartPoint = event->pos();
337 if (!m_rescaleFirstRescaleDone) {
338 // We have just learned the desired direction; Normalize the movement to one pixel
339 // to avoid a jump by m_rescaleMinDist
341 if (movement.x() != 0) {
342 movement.setX(movement.x() / abs(movement.x()));
344 if (movement.y() != 0) {
345 movement.setY(movement.y() / abs(movement.y()));
348 m_rescaleFirstRescaleDone = true;
351 handleMouseDrag(movement, m_rescaleDirection, m_rescaleModifiers);
356 // Detect the movement direction here.
357 // This algorithm relies on the aspect ratio of dy/dx (size and signum).
358 if (movement.manhattanLength() > m_rescaleMinDist) {
359 float diff = ((float) movement.y())/movement.x();
361 if (abs(diff) > m_rescaleVerticalThreshold || movement.x() == 0) {
362 m_rescaleDirection = North;
363 } else if (abs(diff) < 1/m_rescaleVerticalThreshold) {
364 m_rescaleDirection = East;
365 } else if (diff < 0) {
366 m_rescaleDirection = Northeast;
368 m_rescaleDirection = Southeast;
371 qDebug() << "Diff is " << diff << "; chose " << directions[m_rescaleDirection] << " as direction";
373 m_rescalePropertiesLocked = true;
379 void AbstractScopeWidget::leaveEvent(QEvent *)
381 m_mouseWithinWidget = false;
382 emit signalMousePositionChanged();
385 void AbstractScopeWidget::customContextMenuRequested(const QPoint &pos)
387 m_menu->exec(this->mapToGlobal(pos));
390 uint AbstractScopeWidget::calculateAccelFactorHUD(uint oldMseconds, uint)
392 return ceil((float)oldMseconds*REALTIME_FPS / 1000);
394 uint AbstractScopeWidget::calculateAccelFactorScope(uint oldMseconds, uint)
396 return ceil((float)oldMseconds*REALTIME_FPS / 1000);
398 uint AbstractScopeWidget::calculateAccelFactorBackground(uint oldMseconds, uint)
400 return ceil((float)oldMseconds*REALTIME_FPS / 1000);
406 void AbstractScopeWidget::slotHUDRenderingFinished(uint mseconds, uint oldFactor)
409 qDebug() << "HUD rendering has finished in " << mseconds << " ms, waiting for termination in " << m_widgetName;
411 m_threadHUD.waitForFinished();
412 m_imgHUD = m_threadHUD.result();
414 m_semaphoreHUD.release(1);
418 if (m_aRealtime->isChecked()) {
419 accel = calculateAccelFactorHUD(mseconds, oldFactor);
420 if (m_accelFactorHUD < 1) {
423 m_accelFactorHUD = accel;
426 if ((m_newHUDFrames > 0 && m_aAutoRefresh->isChecked()) || m_newHUDUpdates > 0) {
428 qDebug() << "Trying to start a new HUD thread for " << m_widgetName
429 << ". New frames/updates: " << m_newHUDFrames << "/" << m_newHUDUpdates;
435 void AbstractScopeWidget::slotScopeRenderingFinished(uint mseconds, uint oldFactor)
437 // The signal can be received before the thread has really finished. So we
438 // need to wait until it has really finished before starting a new thread.
440 qDebug() << "Scope rendering has finished in " << mseconds << " ms, waiting for termination in " << m_widgetName;
442 m_threadScope.waitForFinished();
443 m_imgScope = m_threadScope.result();
445 // The scope thread has finished. Now we can release the semaphore, allowing a new thread.
446 // See prodScopeThread where the semaphore is acquired again.
447 m_semaphoreScope.release(1);
450 // Calculate the acceleration factor hint to get «realtime» updates.
452 if (m_aRealtime->isChecked()) {
453 accel = calculateAccelFactorScope(mseconds, oldFactor);
455 // If mseconds happens to be 0.
458 // Don't directly calculate with m_accelFactorScope as we are dealing with concurrency.
459 // If m_accelFactorScope is set to 0 at the wrong moment, who knows what might happen
460 // then :) Therefore use a local variable.
461 m_accelFactorScope = accel;
464 if ((m_newScopeFrames > 0 && m_aAutoRefresh->isChecked()) || m_newScopeUpdates > 0) {
466 qDebug() << "Trying to start a new scope thread for " << m_widgetName
467 << ". New frames/updates: " << m_newScopeFrames << "/" << m_newScopeUpdates;
473 void AbstractScopeWidget::slotBackgroundRenderingFinished(uint mseconds, uint oldFactor)
476 qDebug() << "Background rendering has finished in " << mseconds << " ms, waiting for termination in " << m_widgetName;
478 m_threadBackground.waitForFinished();
479 m_imgBackground = m_threadBackground.result();
481 m_semaphoreBackground.release(1);
485 if (m_aRealtime->isChecked()) {
486 accel = calculateAccelFactorBackground(mseconds, oldFactor);
487 if (m_accelFactorBackground < 1) {
490 m_accelFactorBackground = accel;
493 if ((m_newBackgroundFrames > 0 && m_aAutoRefresh->isChecked()) || m_newBackgroundUpdates > 0) {
495 qDebug() << "Trying to start a new background thread for " << m_widgetName
496 << ". New frames/updates: " << m_newBackgroundFrames << "/" << m_newBackgroundUpdates;
498 prodBackgroundThread();;
502 void AbstractScopeWidget::slotRenderZoneUpdated()
504 m_newHUDFrames.fetchAndAddRelaxed(1);
505 m_newScopeFrames.fetchAndAddRelaxed(1);
506 m_newBackgroundFrames.fetchAndAddRelaxed(1);
509 qDebug() << "Data incoming at " << widgetName() << ". New frames total HUD/Scope/Background: " << m_newHUDFrames
510 << "/" << m_newScopeFrames << "/" << m_newBackgroundFrames;
513 if (this->visibleRegion().isEmpty()) {
515 qDebug() << "Scope of widget " << m_widgetName << " is not at the top, not rendering.";
518 if (m_aAutoRefresh->isChecked()) {
521 prodBackgroundThread();
526 void AbstractScopeWidget::slotResetRealtimeFactor(bool realtimeChecked)
528 if (!realtimeChecked) {
529 m_accelFactorHUD = 1;
530 m_accelFactorScope = 1;
531 m_accelFactorBackground = 1;
535 bool AbstractScopeWidget::autoRefreshEnabled()
537 return m_aAutoRefresh->isChecked();
540 void AbstractScopeWidget::slotAutoRefreshToggled(bool autoRefresh)
543 qDebug() << "Auto-refresh switched to " << autoRefresh << " in " << widgetName()
544 << " (Visible: " << isVisible() << "/" << this->visibleRegion().isEmpty() << ")";
547 // Notify listeners whether we accept new frames now
548 emit requestAutoRefresh(autoRefresh);
550 // TODO only if depends on input
553 m_requestForcedUpdate = true;
557 void AbstractScopeWidget::handleMouseDrag(const QPoint, const RescaleDirection, const Qt::KeyboardModifiers) { }