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"
22 const int REALTIME_FPS = 30;
24 const QColor light(250, 238, 226, 255);
25 const QColor dark ( 40, 40, 39, 255);
26 const QColor dark2( 25, 25, 23, 255);
28 AbstractScopeWidget::AbstractScopeWidget(Monitor *projMonitor, Monitor *clipMonitor, QWidget *parent) :
30 m_projMonitor(projMonitor),
31 m_clipMonitor(clipMonitor),
34 m_accelFactorScope(1),
35 m_accelFactorBackground(1),
38 m_semaphoreBackground(1),
39 initialDimensionUpdateDone(false)
42 m_scopePalette = QPalette();
43 m_scopePalette.setBrush(QPalette::Window, QBrush(dark2));
44 m_scopePalette.setBrush(QPalette::Base, QBrush(dark));
45 m_scopePalette.setBrush(QPalette::Button, QBrush(dark));
46 m_scopePalette.setBrush(QPalette::Text, QBrush(light));
47 m_scopePalette.setBrush(QPalette::WindowText, QBrush(light));
48 m_scopePalette.setBrush(QPalette::ButtonText, QBrush(light));
49 this->setPalette(m_scopePalette);
50 this->setAutoFillBackground(true);
52 m_aAutoRefresh = new QAction(i18n("Auto Refresh"), this);
53 m_aAutoRefresh->setCheckable(true);
54 m_aRealtime = new QAction(i18n("Realtime (with precision loss)"), this);
55 m_aRealtime->setCheckable(true);
57 m_menu = new QMenu(this);
58 m_menu->setPalette(m_scopePalette);
59 m_menu->addAction(m_aAutoRefresh);
60 m_menu->addAction(m_aRealtime);
62 this->setContextMenuPolicy(Qt::CustomContextMenu);
64 m_activeRender = (m_clipMonitor->isActive()) ? m_clipMonitor->render : m_projMonitor->render;
67 b &= connect(this, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(customContextMenuRequested(QPoint)));
69 b &= connect(m_activeRender, SIGNAL(rendererPosition(int)), this, SLOT(slotRenderZoneUpdated()));
70 b &= connect(m_activeRender, SIGNAL(frameUpdated(QImage)), this, SLOT(slotRenderZoneUpdated(QImage)));
72 b &= connect(this, SIGNAL(signalHUDRenderingFinished(uint,uint)), this, SLOT(slotHUDRenderingFinished(uint,uint)));
73 b &= connect(this, SIGNAL(signalScopeRenderingFinished(uint,uint)), this, SLOT(slotScopeRenderingFinished(uint,uint)));
74 b &= connect(this, SIGNAL(signalBackgroundRenderingFinished(uint,uint)), this, SLOT(slotBackgroundRenderingFinished(uint,uint)));
75 b &= connect(m_aRealtime, SIGNAL(toggled(bool)), this, SLOT(slotResetRealtimeFactor(bool)));
76 b &= connect(m_aAutoRefresh, SIGNAL(toggled(bool)), this, SLOT(slotAutoRefreshToggled(bool)));
80 AbstractScopeWidget::~AbstractScopeWidget()
85 delete m_aAutoRefresh;
89 void AbstractScopeWidget::init()
91 m_widgetName = widgetName();
95 void AbstractScopeWidget::readConfig()
97 KSharedConfigPtr config = KGlobal::config();
98 KConfigGroup scopeConfig(config, configName());
99 m_aAutoRefresh->setChecked(scopeConfig.readEntry("autoRefresh", true));
100 m_aRealtime->setChecked(scopeConfig.readEntry("realtime", false));
104 void AbstractScopeWidget::writeConfig()
106 KSharedConfigPtr config = KGlobal::config();
107 KConfigGroup scopeConfig(config, configName());
108 scopeConfig.writeEntry("autoRefresh", m_aAutoRefresh->isChecked());
109 scopeConfig.writeEntry("realtime", m_aRealtime->isChecked());
113 QString AbstractScopeWidget::configName() { return "Scope_" + m_widgetName; }
115 void AbstractScopeWidget::prodHUDThread()
117 if (this->visibleRegion().isEmpty()) {
118 // qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating HUD.";
120 if (m_semaphoreHUD.tryAcquire(1)) {
121 Q_ASSERT(!m_threadHUD.isRunning());
123 m_newHUDFrames.fetchAndStoreRelaxed(0);
124 m_newHUDUpdates.fetchAndStoreRelaxed(0);
125 m_threadHUD = QtConcurrent::run(this, &AbstractScopeWidget::renderHUD, m_accelFactorHUD);
126 // qDebug() << "HUD thread started in " << m_widgetName;
129 // qDebug() << "HUD semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadHUD.isRunning();
134 void AbstractScopeWidget::prodScopeThread()
136 // Only start a new thread if the scope is actually visible
137 // and not hidden by another widget on the stack.
138 if (this->visibleRegion().isEmpty()) {
139 // qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating scope.";
141 // Try to acquire the semaphore. This must only succeed if m_threadScope is not running
142 // anymore. Therefore the semaphore must NOT be released before m_threadScope ends.
143 // If acquiring the semaphore fails, the thread is still running.
144 if (m_semaphoreScope.tryAcquire(1)) {
145 Q_ASSERT(!m_threadScope.isRunning());
147 m_newScopeFrames.fetchAndStoreRelaxed(0);
148 m_newScopeUpdates.fetchAndStoreRelaxed(0);
150 Q_ASSERT(m_accelFactorScope > 0);
152 // See http://doc.qt.nokia.com/latest/qtconcurrentrun.html#run about
153 // running member functions in a thread
154 m_threadScope = QtConcurrent::run(this, &AbstractScopeWidget::renderScope, m_accelFactorScope, m_scopeImage);
156 // qDebug() << "Scope thread started in " << m_widgetName;
159 // qDebug() << "Scope semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadScope.isRunning();
163 void AbstractScopeWidget::prodBackgroundThread()
165 if (this->visibleRegion().isEmpty()) {
166 // qDebug() << "Scope " << m_widgetName << " is not visible. Not calculating background.";
168 if (m_semaphoreBackground.tryAcquire(1)) {
169 Q_ASSERT(!m_threadBackground.isRunning());
171 m_newBackgroundFrames.fetchAndStoreRelaxed(0);
172 m_newBackgroundUpdates.fetchAndStoreRelaxed(0);
173 m_threadBackground = QtConcurrent::run(this, &AbstractScopeWidget::renderBackground, m_accelFactorBackground);
174 // qDebug() << "Background thread started in " << m_widgetName;
177 // qDebug() << "Background semaphore locked, not prodding in " << m_widgetName << ". Thread running: " << m_threadBackground.isRunning();
182 void AbstractScopeWidget::forceUpdate(bool doUpdate)
184 // qDebug() << "Force update called in " << widgetName() << ". Arg: " << doUpdate;
185 if (!doUpdate) { return; }
186 m_newHUDUpdates.fetchAndAddRelaxed(1);
187 m_newScopeUpdates.fetchAndAddRelaxed(1);
188 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
191 prodBackgroundThread();
193 void AbstractScopeWidget::forceUpdateHUD()
195 m_newHUDUpdates.fetchAndAddRelaxed(1);
199 void AbstractScopeWidget::forceUpdateScope()
201 m_newScopeUpdates.fetchAndAddRelaxed(1);
205 void AbstractScopeWidget::forceUpdateBackground()
207 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
208 prodBackgroundThread();
215 void AbstractScopeWidget::mouseReleaseEvent(QMouseEvent *event)
219 prodBackgroundThread();
220 QWidget::mouseReleaseEvent(event);
223 void AbstractScopeWidget::resizeEvent(QResizeEvent *event)
225 // Update the dimension of the available rect for painting
226 m_scopeRect = scopeRect();
230 QWidget::resizeEvent(event);
233 void AbstractScopeWidget::showEvent(QShowEvent *event)
235 QWidget::showEvent(event);
236 m_scopeRect = scopeRect();
239 void AbstractScopeWidget::paintEvent(QPaintEvent *)
241 QPainter davinci(this);
242 davinci.drawImage(m_scopeRect.topLeft(), m_imgBackground);
243 davinci.drawImage(m_scopeRect.topLeft(), m_imgScope);
244 davinci.drawImage(m_scopeRect.topLeft(), m_imgHUD);
247 void AbstractScopeWidget::customContextMenuRequested(const QPoint &pos)
249 m_menu->exec(this->mapToGlobal(pos));
252 uint AbstractScopeWidget::calculateAccelFactorHUD(uint oldMseconds, uint) { return ceil((float)oldMseconds*REALTIME_FPS/1000 ); }
253 uint AbstractScopeWidget::calculateAccelFactorScope(uint oldMseconds, uint) { return ceil((float)oldMseconds*REALTIME_FPS/1000 ); }
254 uint AbstractScopeWidget::calculateAccelFactorBackground(uint oldMseconds, uint) { return ceil((float)oldMseconds*REALTIME_FPS/1000 ); }
259 void AbstractScopeWidget::slotHUDRenderingFinished(uint mseconds, uint oldFactor)
261 // qDebug() << "HUD rendering has finished, waiting for termination in " << m_widgetName;
262 m_threadHUD.waitForFinished();
263 m_imgHUD = m_threadHUD.result();
265 m_semaphoreHUD.release(1);
269 if (m_aRealtime->isChecked()) {
270 accel = calculateAccelFactorHUD(mseconds, oldFactor);
271 if (m_accelFactorHUD < 1) {
274 m_accelFactorHUD = accel;
277 if ( (m_newHUDFrames > 0 && m_aAutoRefresh->isChecked()) || m_newHUDUpdates > 0) {
278 // qDebug() << "Trying to start a new HUD thread for " << m_widgetName
279 // << ". New frames/updates: " << m_newHUDFrames << "/" << m_newHUDUpdates;
284 void AbstractScopeWidget::slotScopeRenderingFinished(uint mseconds, uint oldFactor)
286 // The signal can be received before the thread has really finished. So we
287 // need to wait until it has really finished before starting a new thread.
288 // qDebug() << "Scope rendering has finished, waiting for termination in " << m_widgetName;
289 m_threadScope.waitForFinished();
290 m_imgScope = m_threadScope.result();
292 // The scope thread has finished. Now we can release the semaphore, allowing a new thread.
293 // See prodScopeThread where the semaphore is acquired again.
294 m_semaphoreScope.release(1);
297 // Calculate the acceleration factor hint to get «realtime» updates.
299 if (m_aRealtime->isChecked()) {
300 accel = calculateAccelFactorScope(mseconds, oldFactor);
302 // If mseconds happens to be 0.
305 // Don't directly calculate with m_accelFactorScope as we are dealing with concurrency.
306 // If m_accelFactorScope is set to 0 at the wrong moment, who knows what might happen
307 // then :) Therefore use a local variable.
308 m_accelFactorScope = accel;
311 if ( (m_newScopeFrames > 0 && m_aAutoRefresh->isChecked()) || m_newScopeUpdates > 0) {
312 // qDebug() << "Trying to start a new scope thread for " << m_widgetName
313 // << ". New frames/updates: " << m_newScopeFrames << "/" << m_newScopeUpdates;
318 void AbstractScopeWidget::slotBackgroundRenderingFinished(uint mseconds, uint oldFactor)
320 // qDebug() << "Background rendering has finished, waiting for termination in " << m_widgetName;
321 m_threadBackground.waitForFinished();
322 m_imgBackground = m_threadBackground.result();
324 m_semaphoreBackground.release(1);
328 if (m_aRealtime->isChecked()) {
329 accel = calculateAccelFactorBackground(mseconds, oldFactor);
330 if (m_accelFactorBackground < 1) {
333 m_accelFactorBackground = accel;
336 if ( (m_newBackgroundFrames > 0 && m_aAutoRefresh->isChecked()) || m_newBackgroundUpdates > 0) {
337 // qDebug() << "Trying to start a new background thread for " << m_widgetName
338 // << ". New frames/updates: " << m_newBackgroundFrames << "/" << m_newBackgroundUpdates;
339 prodBackgroundThread();;
343 void AbstractScopeWidget::slotActiveMonitorChanged(bool isClipMonitor)
345 // qDebug() << "Active monitor has changed in " << m_widgetName << ". Is the clip monitor active now? " << isClipMonitor;
347 bool b = m_activeRender->disconnect(this);
350 m_activeRender = (isClipMonitor) ? m_clipMonitor->render : m_projMonitor->render;
352 b &= connect(m_activeRender, SIGNAL(rendererPosition(int)), this, SLOT(slotRenderZoneUpdated()));
353 b &= connect(m_activeRender, SIGNAL(frameUpdated(QImage)), this, SLOT(slotRenderZoneUpdated(QImage)));
356 // Update the scope for the new monitor.
359 prodBackgroundThread();
362 void AbstractScopeWidget::slotRenderZoneUpdated()
364 m_newHUDFrames.fetchAndAddRelaxed(1);
365 m_newScopeFrames.fetchAndAddRelaxed(1);
366 m_newBackgroundFrames.fetchAndAddRelaxed(1);
368 // qDebug() << "Monitor incoming. New frames total HUD/Scope/Background: " << m_newHUDFrames
369 // << "/" << m_newScopeFrames << "/" << m_newBackgroundFrames;
371 if (this->visibleRegion().isEmpty()) {
372 // qDebug() << "Scope of widget " << m_widgetName << " is not at the top, not rendering.";
374 if (m_aAutoRefresh->isChecked()) {
377 prodBackgroundThread();
382 void AbstractScopeWidget::slotRenderZoneUpdated(QImage frame)
384 m_scopeImage = frame;
385 slotRenderZoneUpdated();
388 void AbstractScopeWidget::slotResetRealtimeFactor(bool realtimeChecked)
390 if (!realtimeChecked) {
391 m_accelFactorHUD = 1;
392 m_accelFactorScope = 1;
393 m_accelFactorBackground = 1;
397 void AbstractScopeWidget::slotAutoRefreshToggled(bool autoRefresh)
399 // TODO only if depends on input