git.sesse.net Git - kdenlive/blob - src/abstractscopewidget.h

   1 /***************************************************************************
   2  *   Copyright (C) 2010 by Simon Andreas Eugster (simon.eu@gmail.com)      *
   3  *   This file is part of kdenlive. See www.kdenlive.org.                  *
   4  *                                                                         *
   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  ***************************************************************************/
  10
  11 /**
  12   This abstract widget is a proof that abstract things sometimes *are* useful.
  13
  14   The widget expects three layers which
  15   * Will be painted on top of each other on each update
  16   * Are rendered in a separate thread so that the UI is not blocked
  17   * Are rendered only if necessary (e.g., if a layer does not depend
  18     on input images, it will not be re-rendered for incoming frames)
  19
  20   The layer order is as follows:
  21      _____________________
  22     /                     \
  23    /      HUD Layer        \
  24   /                         \
  25   ---------------------------
  26      _____________________
  27     /                     \
  28    /     Scope Layer       \
  29   /                         \
  30   ---------------------------
  31      _____________________
  32     /                     \
  33    /   Background Layer    \
  34   /                         \
  35   ---------------------------
  36
  37   Colors of Scope Widgets are defined in here (and thus don't need to be
  38   re-defined in the implementation of the widget's .ui file).
  39
  40   The custom context menu already contains entries, like for enabling auto-
  41   refresh. It can certainly be extended in the implementation of the widget.
  42
  43   Note: Widgets deriving from this class should connect slotActiveMonitorChanged
  44   to the appropriate signal.
  45
  46   If you intend to write an own widget inheriting from this one, please read
  47   the comments on the unimplemented methods carefully. They are not only here
  48   for optical amusement, but also contain important information.
  49  */
  50
  51 #ifndef ABSTRACTSCOPEWIDGET_H
  52 #define ABSTRACTSCOPEWIDGET_H
  53
  54 #include <QtCore>
  55 #include <QWidget>
  56
  57 class QMenu;
  58
  59 class Monitor;
  60 class Render;
  61
  62 class AbstractScopeWidget : public QWidget
  63 {
  64     Q_OBJECT
  65
  66 public:
  67     AbstractScopeWidget(Monitor *projMonitor, Monitor *clipMonitor, QWidget *parent = 0);
  68     virtual ~AbstractScopeWidget(); // Must be virtual because of inheritance, to avoid memory leaks
  69     QPalette m_scopePalette;
  70
  71     virtual QString widgetName() const = 0;
  72
  73 protected:
  74     ///// Variables /////
  75
  76     Monitor *m_projMonitor;
  77     Monitor *m_clipMonitor;
  78     Render *m_activeRender;
  79
  80
  81     /** The context menu. Feel free to add new entries in your implementation. */
  82     QMenu *m_menu;
  83
  84     /** Enables auto refreshing of the scope.
  85         This is when a new frame is shown on the active monitor.
  86         Resize events always force a recalculation. */
  87     QAction *m_aAutoRefresh;
  88
  89     /** Realtime rendering. Should be disabled if it is not supported.
  90         Use the accelerationFactor variable passed to the render functions as a hint of
  91         how many times faster the scope should be calculated. */
  92     QAction *m_aRealtime;
  93
  94
  95     /** Offset from the widget's borders */
  96     const uchar offset;
  97
  98     /** The rect on the widget we're painting in. */
  99     QRect m_scopeRect;
 100
 101     /** Images storing the calculated layers. Will be used on repaint events. */
 102     QImage m_imgHUD;
 103     QImage m_imgScope;
 104     QImage m_imgBackground;
 105
 106
 107     ///// Unimplemented Methods /////
 108
 109     /** Where on the widget we can paint in */
 110     virtual QRect scopeRect() = 0;
 111
 112     /** @brief HUD renderer. Must emit signalHUDRenderingFinished(). @see renderScope */
 113     virtual QImage renderHUD(uint accelerationFactor) = 0;
 114     /** @brief Scope renderer. Must emit signalScopeRenderingFinished()
 115         when calculation has finished, to allow multi-threading.
 116         accelerationFactor hints how much faster than usual the calculation should be accomplished, if possible. */
 117     virtual QImage renderScope(uint accelerationFactor) = 0;
 118     /** @brief Background renderer. Must emit signalBackgroundRenderingFinished(). @see renderScope */
 119     virtual QImage renderBackground(uint accelerationFactor) = 0;
 120
 121     /** Must return true if the HUD layer depends on the input monitor.
 122         If it does not, then it does not need to be re-calculated when
 123         a new frame from the monitor is incoming. */
 124     virtual bool isHUDDependingOnInput() const = 0;
 125     /** @see isHUDDependingOnInput() */
 126     virtual bool isScopeDependingOnInput() const = 0;
 127     /** @see isHUDDependingOnInput() */
 128     virtual bool isBackgroundDependingOnInput() const = 0;
 129
 130     ///// Methods /////
 131
 132     void mouseReleaseEvent(QMouseEvent *);
 133     void paintEvent(QPaintEvent *);
 134     void resizeEvent(QResizeEvent *);
 135
 136 signals:
 137     /** mseconds represent the time taken for the calculation,
 138         accelerationFactor the acceleration factor that has been used. */
 139     void signalHUDRenderingFinished(uint mseconds, uint accelerationFactor);
 140     void signalScopeRenderingFinished(uint mseconds, uint accelerationFactor);
 141     void signalBackgroundRenderingFinished(uint mseconds, uint accelerationFactor);
 142
 143 private:
 144
 145     /** Counts the number of frames that have been rendered in the active monitor.
 146       The frame number will be reset when the calculation starts for the current frame. */
 147     QAtomicInt m_newHUDFrames;
 148     QAtomicInt m_newScopeFrames;
 149     QAtomicInt m_newBackgroundFrames;
 150
 151     /** Counts the number of updates that, unlike new frames, force a recalculation
 152       of the scope, like for example a resize event. */
 153     QAtomicInt m_newHUDUpdates;
 154     QAtomicInt m_newScopeUpdates;
 155     QAtomicInt m_newBackgroundUpdates;
 156
 157     /** The semaphores ensure that the QFutures for the HUD/Scope/Background threads cannot
 158       be assigned a new thread while it is still running. (Could cause deadlocks and other
 159       nasty things known from parallelism. */
 160     QSemaphore m_semaphoreHUD;
 161     QSemaphore m_semaphoreScope;
 162     QSemaphore m_semaphoreBackground;
 163
 164     QFuture<QImage> m_threadHUD;
 165     QFuture<QImage> m_threadScope;
 166     QFuture<QImage> m_threadBackground;
 167
 168     int m_accelFactorHUD;
 169     int m_accelFactorScope;
 170     int m_accelFactorBackground;
 171
 172     bool initialDimensionUpdateDone;
 173     void prodHUDThread();
 174     void prodScopeThread();
 175     void prodBackgroundThread();
 176
 177
 178 private slots:
 179     /** @brief Must be called when the active monitor has shown a new frame.
 180       This slot must be connected in the implementing class, it is *not*
 181       done in this abstract class. */
 182     void slotActiveMonitorChanged(bool isClipMonitor);
 183     void customContextMenuRequested(const QPoint &pos);
 184     void slotRenderZoneUpdated();
 185     void slotHUDRenderingFinished(uint mseconds, uint accelerationFactor);
 186     void slotScopeRenderingFinished(uint mseconds, uint accelerationFactor);
 187     void slotBackgroundRenderingFinished(uint mseconds, uint accelerationFactor);
 188
 189     /** Resets the acceleration factors to 1 when realtime rendering is disabled. */
 190     void slotResetRealtimeFactor(bool realtimeChecked);
 191
 192 };
 193
 194 #endif // ABSTRACTSCOPEWIDGET_H