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

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  18  ***************************************************************************/
  19
  20
  21 #ifndef DEFINITIONS_H
  22 #define DEFINITIONS_H
  23
  24 #include "gentime.h"
  25 #include "effectslist.h"
  26
  27 #include <QTreeWidgetItem>
  28 #include <KLocale>
  29
  30 const int FRAME_SIZE = 90;
  31 const int MAXCLIPDURATION = 15000;
  32
  33 enum OPERATIONTYPE { NONE = 0, MOVE = 1, RESIZESTART = 2, RESIZEEND = 3, FADEIN = 4, FADEOUT = 5, TRANSITIONSTART = 6, TRANSITIONEND = 7, MOVEGUIDE = 8, KEYFRAME = 9, SEEK = 10, SPACER = 11, RUBBERSELECTION = 12};
  34 enum CLIPTYPE { UNKNOWN = 0, AUDIO = 1, VIDEO = 2, AV = 3, COLOR = 4, IMAGE = 5, TEXT = 6, SLIDESHOW = 7, VIRTUAL = 8, PLAYLIST = 9 };
  35
  36 enum PROJECTITEMTYPE { PROJECTCLIPTYPE = QTreeWidgetItem::UserType, PROJECTFOLDERTYPE, PROJECTSUBCLIPTYPE };
  37
  38 enum GRAPHICSRECTITEM { AVWIDGET = 70000 , LABELWIDGET , TRANSITIONWIDGET  , GROUPWIDGET};
  39
  40 enum PROJECTTOOL { SELECTTOOL = 0 , RAZORTOOL = 1 , SPACERTOOL = 2 };
  41
  42 enum TRANSITIONTYPE {
  43     /** TRANSITIONTYPE: between 0-99: video trans, 100-199: video+audio trans, 200-299: audio trans */
  44     LUMA_TRANSITION = 0,
  45     COMPOSITE_TRANSITION = 1,
  46     PIP_TRANSITION = 2,
  47     LUMAFILE_TRANSITION = 3,
  48     MIX_TRANSITION = 200
  49 };
  50
  51 enum MessageType {
  52     DefaultMessage,
  53     OperationCompletedMessage,
  54     InformationMessage,
  55     ErrorMessage,
  56     MltError
  57 };
  58
  59 enum TRACKTYPE { AUDIOTRACK = 0, VIDEOTRACK = 1 };
  60
  61 struct TrackInfo {
  62     TRACKTYPE type;
  63     QString trackName;
  64     bool isMute;
  65     bool isBlind;
  66     bool isLocked;
  67     EffectsList effectsList;
  68     int duration;
  69 };
  70
  71 struct ItemInfo {
  72     /** startPos is the position where the clip starts on the track */
  73     GenTime startPos;
  74     /** endPos is the duration where the clip ends on the track */
  75     GenTime endPos;
  76     /** cropStart is the position where the sub-clip starts, relative to the clip's 0 position */
  77     GenTime cropStart;
  78     /** cropDuration is the duration of the clip */
  79     GenTime cropDuration;
  80     int track;
  81 };
  82
  83 struct MltVideoProfile {
  84     QString path;
  85     QString description;
  86     int frame_rate_num;
  87     int frame_rate_den;
  88     int width;
  89     int height;
  90     bool progressive;
  91     int sample_aspect_num;
  92     int sample_aspect_den;
  93     int display_aspect_num;
  94     int display_aspect_den;
  95     int colorspace;
  96 };
  97
  98
  99 class EffectParameter
 100 {
 101 public:
 102     EffectParameter(const QString name, const QString value): m_name(name), m_value(value) {}
 103     QString name()   const          {
 104         return m_name;
 105     }
 106     QString value() const          {
 107         return m_value;
 108     }
 109     void setValue(const QString value) {
 110         m_value = value;
 111     }
 112
 113 private:
 114     QString m_name;
 115     QString m_value;
 116 };
 117
 118 /** Use our own list for effect parameters so that they are not sorted in any ways, because
 119     some effects like sox need a precise order
 120 */
 121 class EffectsParameterList: public QList < EffectParameter >
 122 {
 123 public:
 124     EffectsParameterList(): QList < EffectParameter >() {}
 125     bool hasParam(const QString name) const {
 126         for (int i = 0; i < size(); i++)
 127             if (at(i).name() == name) return true;
 128         return false;
 129     }
 130     QString paramValue(const QString name, QString defaultValue = QString()) const {
 131         for (int i = 0; i < size(); i++) {
 132             if (at(i).name() == name) return at(i).value();
 133         }
 134         return defaultValue;
 135     }
 136     void addParam(const QString &name, const QString &value) {
 137         if (name.isEmpty()) return;
 138         append(EffectParameter(name, value));
 139     }
 140     void removeParam(const QString name) {
 141         for (int i = 0; i < size(); i++)
 142             if (at(i).name() == name) {
 143                 removeAt(i);
 144                 break;
 145             }
 146     }
 147 };
 148
 149 class CommentedTime
 150 {
 151 public:
 152     CommentedTime(): t(GenTime(0)) {}
 153     CommentedTime(const GenTime time, QString comment)
 154         : t(time), c(comment) { }
 155
 156     QString comment()   const          {
 157         return (c.isEmpty() ? i18n("Marker") : c);
 158     }
 159     GenTime time() const          {
 160         return t;
 161     }
 162     void    setComment(QString comm) {
 163         c = comm;
 164     }
 165
 166     /* Implementation of > operator; Works identically as with basic types. */
 167     bool operator>(CommentedTime op) const {
 168         return t > op.time();
 169     }
 170     /* Implementation of < operator; Works identically as with basic types. */
 171     bool operator<(CommentedTime op) const {
 172         return t < op.time();
 173     }
 174     /* Implementation of >= operator; Works identically as with basic types. */
 175     bool operator>=(CommentedTime op) const {
 176         return t >= op.time();
 177     }
 178     /* Implementation of <= operator; Works identically as with basic types. */
 179     bool operator<=(CommentedTime op) const {
 180         return t <= op.time();
 181     }
 182     /* Implementation of == operator; Works identically as with basic types. */
 183     bool operator==(CommentedTime op) const {
 184         return t == op.time();
 185     }
 186     /* Implementation of != operator; Works identically as with basic types. */
 187     bool operator!=(CommentedTime op) const {
 188         return t != op.time();
 189     }
 190
 191 private:
 192     GenTime t;
 193     QString c;
 194
 195
 196 };
 197
 198
 199 #endif