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 const int REALTIME_FPS = 30;
25 const QColor light(250, 238, 226, 255);
26 const QColor dark(40, 40, 39, 255);
27 const QColor dark2(25, 25, 23, 255);
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::penLightDots(QBrush(QColor(200, 200, 250, 150)), 1, Qt::DotLine);
33 const QPen AbstractScopeWidget::penDark(QBrush(QColor(0, 0, 20, 250)), 1, Qt::SolidLine);
34 const QPen AbstractScopeWidget::penDarkDots(QBrush(QColor(0, 0, 20, 250)), 1, Qt::DotLine);
36 AbstractScopeWidget::AbstractScopeWidget(bool trackMouse, QWidget *parent) :
39 m_mouseWithinWidget(false),
42 m_accelFactorScope(1),
43 m_accelFactorBackground(1),
46 m_semaphoreBackground(1),
47 initialDimensionUpdateDone(false),
48 m_requestForcedUpdate(false)
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);
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);
66 m_menu = new QMenu(this);
67 m_menu->setPalette(m_scopePalette);
68 m_menu->addAction(m_aAutoRefresh);
69 m_menu->addAction(m_aRealtime);
71 this->setContextMenuPolicy(Qt::CustomContextMenu);
74 b &= connect(this, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(customContextMenuRequested(QPoint)));
76 b &= connect(this, SIGNAL(signalHUDRenderingFinished(uint, uint)), this, SLOT(slotHUDRenderingFinished(uint, uint)));
77 b &= connect(this, SIGNAL(signalScopeRenderingFinished(uint, uint)), this, SLOT(slotScopeRenderingFinished(uint, uint)));
78 b &= connect(this, SIGNAL(signalBackgroundRenderingFinished(uint, uint)), this, SLOT(slotBackgroundRenderingFinished(uint, uint)));
79 b &= connect(m_aRealtime, SIGNAL(toggled(bool)), this, SLOT(slotResetRealtimeFactor(bool)));
80 b &= connect(m_aAutoRefresh, SIGNAL(toggled(bool)), this, SLOT(slotAutoRefreshToggled(bool)));
83 // Enable mouse tracking if desired.
84 // Causes the mouseMoved signal to be emitted when the mouse moves inside the
85 // widget, even when no mouse button is pressed.
86 this->setMouseTracking(trackMouse);
89 AbstractScopeWidget::~AbstractScopeWidget()
94 delete m_aAutoRefresh;
98 void AbstractScopeWidget::init()
100 m_widgetName = widgetName();
104 void AbstractScopeWidget::readConfig()
106 KSharedConfigPtr config = KGlobal::config();
107 KConfigGroup scopeConfig(config, configName());
108 m_aAutoRefresh->setChecked(scopeConfig.readEntry("autoRefresh", true));
109 m_aRealtime->setChecked(scopeConfig.readEntry("realtime", false));
113 void AbstractScopeWidget::writeConfig()
115 KSharedConfigPtr config = KGlobal::config();
116 KConfigGroup scopeConfig(config, configName());
117 scopeConfig.writeEntry("autoRefresh", m_aAutoRefresh->isChecked());
118 scopeConfig.writeEntry("realtime", m_aRealtime->isChecked());
122 QString AbstractScopeWidget::configName()
124 return "Scope_" + m_widgetName;
127 void AbstractScopeWidget::prodHUDThread()
129 if (this->visibleRegion().isEmpty()) {
130 // qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating HUD.";
132 if (m_semaphoreHUD.tryAcquire(1)) {
133 Q_ASSERT(!m_threadHUD.isRunning());
135 m_newHUDFrames.fetchAndStoreRelaxed(0);
136 m_newHUDUpdates.fetchAndStoreRelaxed(0);
137 m_threadHUD = QtConcurrent::run(this, &AbstractScopeWidget::renderHUD, m_accelFactorHUD);
138 // qDebug() << "HUD thread started in " << m_widgetName;
141 // qDebug() << "HUD semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadHUD.isRunning();
146 void AbstractScopeWidget::prodScopeThread()
148 // Only start a new thread if the scope is actually visible
149 // and not hidden by another widget on the stack and if user want the scope to update.
150 if (this->visibleRegion().isEmpty() || (!m_aAutoRefresh->isChecked() && !m_requestForcedUpdate)) {
151 // qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating scope.";
153 // Try to acquire the semaphore. This must only succeed if m_threadScope is not running
154 // anymore. Therefore the semaphore must NOT be released before m_threadScope ends.
155 // If acquiring the semaphore fails, the thread is still running.
156 if (m_semaphoreScope.tryAcquire(1)) {
157 Q_ASSERT(!m_threadScope.isRunning());
159 m_newScopeFrames.fetchAndStoreRelaxed(0);
160 m_newScopeUpdates.fetchAndStoreRelaxed(0);
162 Q_ASSERT(m_accelFactorScope > 0);
164 // See http://doc.qt.nokia.com/latest/qtconcurrentrun.html#run about
165 // running member functions in a thread
166 m_threadScope = QtConcurrent::run(this, &AbstractScopeWidget::renderScope, m_accelFactorScope);
167 m_requestForcedUpdate = false;
169 // qDebug() << "Scope thread started in " << m_widgetName;
172 // qDebug() << "Scope semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadScope.isRunning();
176 void AbstractScopeWidget::prodBackgroundThread()
178 if (this->visibleRegion().isEmpty()) {
179 // qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating background.";
181 if (m_semaphoreBackground.tryAcquire(1)) {
182 Q_ASSERT(!m_threadBackground.isRunning());
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;
190 // qDebug() << "Background semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadBackground.isRunning();
195 void AbstractScopeWidget::forceUpdate(bool doUpdate)
197 // qDebug() << "Force update called in " << widgetName() << ". Arg: " << doUpdate;
201 m_requestForcedUpdate = true;
202 m_newHUDUpdates.fetchAndAddRelaxed(1);
203 m_newScopeUpdates.fetchAndAddRelaxed(1);
204 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
207 prodBackgroundThread();
209 void AbstractScopeWidget::forceUpdateHUD()
211 m_newHUDUpdates.fetchAndAddRelaxed(1);
215 void AbstractScopeWidget::forceUpdateScope()
217 m_newScopeUpdates.fetchAndAddRelaxed(1);
218 m_requestForcedUpdate = true;
222 void AbstractScopeWidget::forceUpdateBackground()
224 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
225 prodBackgroundThread();
232 void AbstractScopeWidget::mouseReleaseEvent(QMouseEvent *event)
234 if (!m_aAutoRefresh->isChecked()) {
235 m_requestForcedUpdate = true;
239 prodBackgroundThread();
240 QWidget::mouseReleaseEvent(event);
243 void AbstractScopeWidget::resizeEvent(QResizeEvent *event)
245 // Update the dimension of the available rect for painting
246 m_scopeRect = scopeRect();
249 QWidget::resizeEvent(event);
252 void AbstractScopeWidget::showEvent(QShowEvent *event)
254 QWidget::showEvent(event);
255 m_scopeRect = scopeRect();
258 void AbstractScopeWidget::paintEvent(QPaintEvent *)
260 QPainter davinci(this);
261 davinci.drawImage(m_scopeRect.topLeft(), m_imgBackground);
262 davinci.drawImage(m_scopeRect.topLeft(), m_imgScope);
263 davinci.drawImage(m_scopeRect.topLeft(), m_imgHUD);
266 void AbstractScopeWidget::mouseMoveEvent(QMouseEvent *event)
268 m_mousePos = event->pos();
269 m_mouseWithinWidget = true;
270 emit signalMousePositionChanged();
272 void AbstractScopeWidget::leaveEvent(QEvent *)
274 m_mouseWithinWidget = false;
275 emit signalMousePositionChanged();
278 void AbstractScopeWidget::customContextMenuRequested(const QPoint &pos)
280 m_menu->exec(this->mapToGlobal(pos));
283 uint AbstractScopeWidget::calculateAccelFactorHUD(uint oldMseconds, uint)
285 return ceil((float)oldMseconds*REALTIME_FPS / 1000);
287 uint AbstractScopeWidget::calculateAccelFactorScope(uint oldMseconds, uint)
289 return ceil((float)oldMseconds*REALTIME_FPS / 1000);
291 uint AbstractScopeWidget::calculateAccelFactorBackground(uint oldMseconds, uint)
293 return ceil((float)oldMseconds*REALTIME_FPS / 1000);
299 void AbstractScopeWidget::slotHUDRenderingFinished(uint mseconds, uint oldFactor)
301 // qDebug() << "HUD rendering has finished, waiting for termination in " << m_widgetName;
302 m_threadHUD.waitForFinished();
303 m_imgHUD = m_threadHUD.result();
305 m_semaphoreHUD.release(1);
309 if (m_aRealtime->isChecked()) {
310 accel = calculateAccelFactorHUD(mseconds, oldFactor);
311 if (m_accelFactorHUD < 1) {
314 m_accelFactorHUD = accel;
317 if ((m_newHUDFrames > 0 && m_aAutoRefresh->isChecked()) || m_newHUDUpdates > 0) {
318 // qDebug() << "Trying to start a new HUD thread for " << m_widgetName
319 // << ". New frames/updates: " << m_newHUDFrames << "/" << m_newHUDUpdates;
324 void AbstractScopeWidget::slotScopeRenderingFinished(uint mseconds, uint oldFactor)
326 // The signal can be received before the thread has really finished. So we
327 // need to wait until it has really finished before starting a new thread.
328 // qDebug() << "Scope rendering has finished, waiting for termination in " << m_widgetName;
329 m_threadScope.waitForFinished();
330 m_imgScope = m_threadScope.result();
332 // The scope thread has finished. Now we can release the semaphore, allowing a new thread.
333 // See prodScopeThread where the semaphore is acquired again.
334 m_semaphoreScope.release(1);
337 // Calculate the acceleration factor hint to get «realtime» updates.
339 if (m_aRealtime->isChecked()) {
340 accel = calculateAccelFactorScope(mseconds, oldFactor);
342 // If mseconds happens to be 0.
345 // Don't directly calculate with m_accelFactorScope as we are dealing with concurrency.
346 // If m_accelFactorScope is set to 0 at the wrong moment, who knows what might happen
347 // then :) Therefore use a local variable.
348 m_accelFactorScope = accel;
351 if ((m_newScopeFrames > 0 && m_aAutoRefresh->isChecked()) || m_newScopeUpdates > 0) {
352 // qDebug() << "Trying to start a new scope thread for " << m_widgetName
353 // << ". New frames/updates: " << m_newScopeFrames << "/" << m_newScopeUpdates;
358 void AbstractScopeWidget::slotBackgroundRenderingFinished(uint mseconds, uint oldFactor)
360 // qDebug() << "Background rendering has finished, waiting for termination in " << m_widgetName;
361 m_threadBackground.waitForFinished();
362 m_imgBackground = m_threadBackground.result();
364 m_semaphoreBackground.release(1);
368 if (m_aRealtime->isChecked()) {
369 accel = calculateAccelFactorBackground(mseconds, oldFactor);
370 if (m_accelFactorBackground < 1) {
373 m_accelFactorBackground = accel;
376 if ((m_newBackgroundFrames > 0 && m_aAutoRefresh->isChecked()) || m_newBackgroundUpdates > 0) {
377 // qDebug() << "Trying to start a new background thread for " << m_widgetName
378 // << ". New frames/updates: " << m_newBackgroundFrames << "/" << m_newBackgroundUpdates;
379 prodBackgroundThread();;
383 void AbstractScopeWidget::slotRenderZoneUpdated()
385 m_newHUDFrames.fetchAndAddRelaxed(1);
386 m_newScopeFrames.fetchAndAddRelaxed(1);
387 m_newBackgroundFrames.fetchAndAddRelaxed(1);
389 // qDebug() << "Monitor incoming. New frames total HUD/Scope/Background: " << m_newHUDFrames
390 // << "/" << m_newScopeFrames << "/" << m_newBackgroundFrames;
392 if (this->visibleRegion().isEmpty()) {
393 // qDebug() << "Scope of widget " << m_widgetName << " is not at the top, not rendering.";
395 if (m_aAutoRefresh->isChecked()) {
398 prodBackgroundThread();
403 void AbstractScopeWidget::slotRenderZoneUpdated(QImage frame)
405 m_scopeImage = frame;
406 slotRenderZoneUpdated();
409 void AbstractScopeWidget::slotResetRealtimeFactor(bool realtimeChecked)
411 if (!realtimeChecked) {
412 m_accelFactorHUD = 1;
413 m_accelFactorScope = 1;
414 m_accelFactorBackground = 1;
418 bool AbstractScopeWidget::autoRefreshEnabled()
420 return m_aAutoRefresh->isChecked();
423 void AbstractScopeWidget::slotAutoRefreshToggled(bool autoRefresh)
426 emit requestAutoRefresh(autoRefresh);
428 // TODO only if depends on input
431 m_requestForcedUpdate = true;