git.sesse.net Git - kdenlive/blob - src/rotoscoping/rotowidget.h

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Till Theato (root@ttill.de)                     *
   3  *   This file is part of Kdenlive (www.kdenlive.org).                     *
   4  *                                                                         *
   5  *   Kdenlive 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  *   Kdenlive is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with Kdenlive.  If not, see <http://www.gnu.org/licenses/>.     *
  17  ***************************************************************************/
  18
  19 #ifndef ROTOWIDGET_H
  20 #define ROTOWIDGET_H
  21
  22 #include "bpoint.h"
  23 #include "timecode.h"
  24
  25 #include <QWidget>
  26
  27 class Monitor;
  28 class MonitorScene;
  29 class SplineItem;
  30 class SimpleKeyframeWidget;
  31
  32 class RotoWidget : public QWidget
  33 {
  34     Q_OBJECT
  35
  36 public:
  37     RotoWidget(QString data, Monitor *monitor, int in, int out, Timecode t, QWidget* parent = 0);
  38     virtual ~RotoWidget();
  39
  40     /** @brief Returns the spline(s) in the JSON format used by filter_rotoscoping (MLT). */
  41     QString getSpline();
  42
  43     /** @brief Passed on to the keyframe timeline. Switches between frames and hh:mm:ss:ff timecode. */
  44     void updateTimecodeFormat();
  45
  46 public slots:
  47     /** @brief Switches from normal monitor to monitor scene according to @param show. */
  48     void slotShowScene(bool show = true);
  49     /** @brief Updates the on-monitor item.  */
  50     void slotSyncPosition(int relTimelinePos);
  51
  52 signals:
  53     void valueChanged();
  54     void checkMonitorPosition(int);
  55     void seekToPos(int pos);
  56
  57
  58 private:
  59     SimpleKeyframeWidget *m_keyframeWidget;
  60     Monitor *m_monitor;
  61     MonitorScene *m_scene;
  62     bool m_showScene;
  63     QVariant m_data;
  64     SplineItem *m_item;
  65     int m_in;
  66     int m_out;
  67
  68     /** @brief Returns the list of cubic Bézier points that form the spline at position @param keyframe.
  69      * The points are brought from the range [0, 1] into project resolution space.
  70      * This function does not do any interpolation and therfore will only return a list when a keyframe at the given postion exists.
  71      * Set @param keyframe to -1 if only one keyframe currently exists. */
  72     QList <BPoint> getPoints(int keyframe);
  73
  74 private slots:
  75     /** @brief Makes sure the monitor effect scene is only visible if the clip this geometry belongs to is visible.
  76     * @param renderPos Postion of the Monitor / Timeline cursor */
  77     void slotCheckMonitorPosition(int renderPos);
  78
  79     /** @brief Updates/Creates the spline at @param pos based on the on-monitor items. */
  80     void slotUpdateData(int pos = -1, bool editing = false);
  81     /** @brief Updates/Creates the spline at the current timeline position based on the on-monitor items. */
  82     void slotUpdateData(bool editing);
  83
  84     /** @brief Updates the on-monitor items to fit the spline at position @param pos. */
  85     void slotPositionChanged(int pos, bool seek = true);
  86
  87     void slotAddKeyframe(int pos = -1);
  88     void slotRemoveKeyframe(int pos = -1);
  89     void slotMoveKeyframe(int oldPos, int newPos);
  90 };
  91
  92 #endif