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"
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 AbstractScopeWidget::AbstractScopeWidget(Monitor *projMonitor, Monitor *clipMonitor, QWidget *parent) :
31 m_projMonitor(projMonitor),
32 m_clipMonitor(clipMonitor),
35 m_accelFactorScope(1),
36 m_accelFactorBackground(1),
39 m_semaphoreBackground(1),
40 initialDimensionUpdateDone(false)
43 m_scopePalette = QPalette();
44 m_scopePalette.setBrush(QPalette::Window, QBrush(dark2));
45 m_scopePalette.setBrush(QPalette::Base, QBrush(dark));
46 m_scopePalette.setBrush(QPalette::Button, QBrush(dark));
47 m_scopePalette.setBrush(QPalette::Text, QBrush(light));
48 m_scopePalette.setBrush(QPalette::WindowText, QBrush(light));
49 m_scopePalette.setBrush(QPalette::ButtonText, QBrush(light));
50 this->setPalette(m_scopePalette);
51 this->setAutoFillBackground(true);
53 m_aAutoRefresh = new QAction(i18n("Auto Refresh"), this);
54 m_aAutoRefresh->setCheckable(true);
55 m_aRealtime = new QAction(i18n("Realtime (with precision loss)"), this);
56 m_aRealtime->setCheckable(true);
58 m_menu = new QMenu(this);
59 m_menu->setPalette(m_scopePalette);
60 m_menu->addAction(m_aAutoRefresh);
61 m_menu->addAction(m_aRealtime);
63 this->setContextMenuPolicy(Qt::CustomContextMenu);
65 m_activeRender = (m_clipMonitor->isActive()) ? m_clipMonitor->render : m_projMonitor->render;
68 b &= connect(this, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(customContextMenuRequested(QPoint)));
70 b &= connect(m_activeRender, SIGNAL(rendererPosition(int)), this, SLOT(slotRenderZoneUpdated()));
71 b &= connect(m_activeRender, SIGNAL(frameUpdated(int)), this, SLOT(slotRenderZoneUpdated()));
73 b &= connect(this, SIGNAL(signalHUDRenderingFinished(uint,uint)), this, SLOT(slotHUDRenderingFinished(uint,uint)));
74 b &= connect(this, SIGNAL(signalScopeRenderingFinished(uint,uint)), this, SLOT(slotScopeRenderingFinished(uint,uint)));
75 b &= connect(this, SIGNAL(signalBackgroundRenderingFinished(uint,uint)), this, SLOT(slotBackgroundRenderingFinished(uint,uint)));
76 b &= connect(m_aRealtime, SIGNAL(toggled(bool)), this, SLOT(slotResetRealtimeFactor(bool)));
77 b &= connect(m_aAutoRefresh, SIGNAL(toggled(bool)), this, SLOT(slotAutoRefreshToggled(bool)));
81 AbstractScopeWidget::~AbstractScopeWidget()
84 delete m_aAutoRefresh;
88 void AbstractScopeWidget::prodHUDThread()
90 if (this->visibleRegion().isEmpty()) {
91 qDebug() << "Scope " << widgetName() << " is not visible. Not calculating HUD.";
93 if (m_semaphoreHUD.tryAcquire(1)) {
94 Q_ASSERT(!m_threadHUD.isRunning());
96 m_newHUDFrames.fetchAndStoreRelaxed(0);
97 m_newHUDUpdates.fetchAndStoreRelaxed(0);
98 m_threadHUD = QtConcurrent::run(this, &AbstractScopeWidget::renderHUD, m_accelFactorHUD);
99 qDebug() << "HUD thread started in " << widgetName();
102 qDebug() << "HUD semaphore locked, not prodding in " << widgetName() << ". Thread running: " << m_threadHUD.isRunning();
106 void AbstractScopeWidget::prodScopeThread()
108 // Only start a new thread if the scope is actually visible
109 // and not hidden by another widget on the stack.
110 if (this->visibleRegion().isEmpty()) {
111 qDebug() << "Scope " << widgetName() << " is not visible. Not calculating scope.";
113 // Try to acquire the semaphore. This must only succeed if m_threadScope is not running
114 // anymore. Therefore the semaphore must NOT be released before m_threadScope ends.
115 // If acquiring the semaphore fails, the thread is still running.
116 if (m_semaphoreScope.tryAcquire(1)) {
117 Q_ASSERT(!m_threadScope.isRunning());
119 m_newScopeFrames.fetchAndStoreRelaxed(0);
120 m_newScopeUpdates.fetchAndStoreRelaxed(0);
122 // See http://doc.qt.nokia.com/latest/qtconcurrentrun.html#run about
123 // running member functions in a thread
124 m_threadScope = QtConcurrent::run(this, &AbstractScopeWidget::renderScope, m_accelFactorScope);
126 qDebug() << "Scope thread started in " << widgetName();
129 qDebug() << "Scope semaphore locked, not prodding in " << widgetName() << ". Thread running: " << m_threadScope.isRunning();
132 void AbstractScopeWidget::prodBackgroundThread()
134 if (this->visibleRegion().isEmpty()) {
135 qDebug() << "Scope " << widgetName() << " is not visible. Not calculating background.";
137 if (m_semaphoreBackground.tryAcquire(1)) {
138 Q_ASSERT(!m_threadBackground.isRunning());
140 m_newBackgroundFrames.fetchAndStoreRelaxed(0);
141 m_newBackgroundUpdates.fetchAndStoreRelaxed(0);
142 m_threadBackground = QtConcurrent::run(this, &AbstractScopeWidget::renderBackground, m_accelFactorBackground);
143 qDebug() << "Background thread started in " << widgetName();
146 qDebug() << "Background semaphore locked, not prodding in " << widgetName() << ". Thread running: " << m_threadBackground.isRunning();
150 void AbstractScopeWidget::forceUpdate()
152 m_newHUDUpdates.fetchAndAddRelaxed(1);
153 m_newScopeUpdates.fetchAndAddRelaxed(1);
154 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
157 prodBackgroundThread();
159 void AbstractScopeWidget::forceUpdateHUD()
161 m_newHUDUpdates.fetchAndAddRelaxed(1);
165 void AbstractScopeWidget::forceUpdateScope()
167 m_newScopeUpdates.fetchAndAddRelaxed(1);
171 void AbstractScopeWidget::forceUpdateBackground()
173 m_newBackgroundUpdates.fetchAndAddRelaxed(1);
174 prodBackgroundThread();
181 void AbstractScopeWidget::mouseReleaseEvent(QMouseEvent *event)
185 prodBackgroundThread();
186 QWidget::mouseReleaseEvent(event);
189 void AbstractScopeWidget::resizeEvent(QResizeEvent *event)
191 // Update the dimension of the available rect for painting
192 m_scopeRect = scopeRect();
196 QWidget::resizeEvent(event);
199 void AbstractScopeWidget::raise()
201 // Widget has been brought to the top of a widget stack,
202 // layers need to be updated.
207 void AbstractScopeWidget::paintEvent(QPaintEvent *)
209 // qDebug() << "Painting now on scope " << widgetName();
210 if (!initialDimensionUpdateDone) {
211 // This is a workaround.
212 // When updating the dimensions in the constructor, the size
213 // of the control items at the top are simply ignored! So do
215 m_scopeRect = scopeRect();
216 initialDimensionUpdateDone = true;
219 qDebug() << "Drawing top/left at " << m_scopeRect.topLeft().x() << "/" << m_scopeRect.topLeft().y();
221 QPainter davinci(this);
222 davinci.drawImage(m_scopeRect.topLeft(), m_imgBackground);
223 davinci.drawImage(m_scopeRect.topLeft(), m_imgScope);
224 davinci.drawImage(m_scopeRect.topLeft(), m_imgHUD);
227 void AbstractScopeWidget::customContextMenuRequested(const QPoint &pos)
229 m_menu->exec(this->mapToGlobal(pos));
232 uint AbstractScopeWidget::calculateAccelFactorHUD(uint oldMseconds, uint) { return ceil((float)oldMseconds*REALTIME_FPS/1000 ); }
233 uint AbstractScopeWidget::calculateAccelFactorScope(uint oldMseconds, uint) { return ceil((float)oldMseconds*REALTIME_FPS/1000 ); }
234 uint AbstractScopeWidget::calculateAccelFactorBackground(uint oldMseconds, uint) { return ceil((float)oldMseconds*REALTIME_FPS/1000 ); }
239 void AbstractScopeWidget::slotHUDRenderingFinished(uint mseconds, uint oldFactor)
241 qDebug() << "HUD rendering has finished, waiting for termination in " << widgetName();
242 m_threadHUD.waitForFinished();
243 m_imgHUD = m_threadHUD.result();
245 m_semaphoreHUD.release(1);
249 if (m_aRealtime->isChecked()) {
250 accel = calculateAccelFactorHUD(mseconds, oldFactor);
251 if (m_accelFactorHUD < 1) {
254 m_accelFactorHUD = accel;
257 if ( (m_newHUDFrames > 0 && m_aAutoRefresh->isChecked()) || m_newHUDUpdates > 0) {
258 qDebug() << "Trying to start a new HUD thread for " << widgetName()
259 << ". New frames/updates: " << m_newHUDFrames << "/" << m_newHUDUpdates;
264 void AbstractScopeWidget::slotScopeRenderingFinished(uint mseconds, uint oldFactor)
266 // The signal can be received before the thread has really finished. So we
267 // need to wait until it has really finished before starting a new thread.
268 qDebug() << "Scope rendering has finished, waiting for termination in " << widgetName();
269 m_threadScope.waitForFinished();
270 m_imgScope = m_threadScope.result();
272 // The scope thread has finished. Now we can release the semaphore, allowing a new thread.
273 // See prodScopeThread where the semaphore is acquired again.
274 m_semaphoreScope.release(1);
277 // Calculate the acceleration factor hint to get «realtime» updates.
279 if (m_aRealtime->isChecked()) {
280 accel = calculateAccelFactorScope(mseconds, oldFactor);
281 if (m_accelFactorScope < 1) {
282 // If mseconds happens to be 0.
285 // Don't directly calculate with m_accelFactorScope as we are dealing with concurrency.
286 // If m_accelFactorScope is set to 0 at the wrong moment, who knows what might happen
287 // then :) Therefore use a local variable.
288 m_accelFactorScope = accel;
291 if ( (m_newScopeFrames > 0 && m_aAutoRefresh->isChecked()) || m_newScopeUpdates > 0) {
292 qDebug() << "Trying to start a new scope thread for " << widgetName()
293 << ". New frames/updates: " << m_newScopeFrames << "/" << m_newScopeUpdates;
298 void AbstractScopeWidget::slotBackgroundRenderingFinished(uint mseconds, uint oldFactor)
300 qDebug() << "Background rendering has finished, waiting for termination in " << widgetName();
301 m_threadBackground.waitForFinished();
302 m_imgBackground = m_threadBackground.result();
304 m_semaphoreBackground.release(1);
308 if (m_aRealtime->isChecked()) {
309 accel = calculateAccelFactorBackground(mseconds, oldFactor);
310 if (m_accelFactorBackground < 1) {
313 m_accelFactorBackground = accel;
316 if ( (m_newBackgroundFrames > 0 && m_aAutoRefresh->isChecked()) || m_newBackgroundUpdates > 0) {
317 qDebug() << "Trying to start a new background thread for " << widgetName()
318 << ". New frames/updates: " << m_newBackgroundFrames << "/" << m_newBackgroundUpdates;
319 prodBackgroundThread();;
323 void AbstractScopeWidget::slotActiveMonitorChanged(bool isClipMonitor)
325 qDebug() << "Active monitor has changed in " << widgetName() << ". Is the clip monitor active now? " << isClipMonitor;
327 bool disconnected = m_activeRender->disconnect(this);
328 Q_ASSERT(disconnected);
330 m_activeRender = (isClipMonitor) ? m_clipMonitor->render : m_projMonitor->render;
333 b &= connect(m_activeRender, SIGNAL(rendererPosition(int)), this, SLOT(slotRenderZoneUpdated()));
334 b &= connect(m_activeRender, SIGNAL(frameUpdated(int)), this, SLOT(slotRenderZoneUpdated()));
337 // Update the scope for the new monitor.
340 prodBackgroundThread();
343 void AbstractScopeWidget::slotRenderZoneUpdated()
345 m_newHUDFrames.fetchAndAddRelaxed(1);
346 m_newScopeFrames.fetchAndAddRelaxed(1);
347 m_newBackgroundFrames.fetchAndAddRelaxed(1);
349 qDebug() << "Monitor incoming. New frames total HUD/Scope/Background: " << m_newHUDFrames
350 << "/" << m_newScopeFrames << "/" << m_newBackgroundFrames;
352 if (this->visibleRegion().isEmpty()) {
353 qDebug() << "Scope of widget " << widgetName() << " is not at the top, not rendering.";
355 if (m_aAutoRefresh->isChecked()) {
358 prodBackgroundThread();
363 void AbstractScopeWidget::slotResetRealtimeFactor(bool realtimeChecked)
365 if (!realtimeChecked) {
366 m_accelFactorHUD = 1;
367 m_accelFactorScope = 1;
368 m_accelFactorBackground = 1;
372 void AbstractScopeWidget::slotAutoRefreshToggled(bool autoRefresh)
374 // TODO only if depends on input