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
  26 #include <KLocale>
  27
  28 const int FRAME_SIZE = 90;
  29 const int MAXCLIPDURATION = 15000;
  30
  31 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};
  32 enum CLIPTYPE { UNKNOWN = 0, AUDIO = 1, VIDEO = 2, AV = 3, COLOR = 4, IMAGE = 5, TEXT = 6, SLIDESHOW = 7, VIRTUAL = 8, PLAYLIST = 9, FOLDER = 10};
  33 enum GRAPHICSRECTITEM { AVWIDGET = 70000 , LABELWIDGET , TRANSITIONWIDGET  , GROUPWIDGET};
  34
  35 enum PROJECTTOOL { SELECTTOOL = 0 , RAZORTOOL = 1 , SPACERTOOL = 2 };
  36
  37 enum TRANSITIONTYPE {
  38     /** TRANSITIONTYPE: between 0-99: video trans, 100-199: video+audio trans, 200-299: audio trans */
  39     LUMA_TRANSITION = 0,
  40     COMPOSITE_TRANSITION = 1,
  41     PIP_TRANSITION = 2,
  42     LUMAFILE_TRANSITION = 3,
  43     MIX_TRANSITION = 200
  44 };
  45
  46 enum MessageType {
  47     DefaultMessage,
  48     OperationCompletedMessage,
  49     InformationMessage,
  50     ErrorMessage,
  51     MltError
  52 };
  53
  54 enum TRACKTYPE { AUDIOTRACK = 0, VIDEOTRACK = 1 };
  55
  56 struct TrackInfo {
  57     TRACKTYPE type;
  58     QString trackName;
  59     bool isMute;
  60     bool isBlind;
  61     bool isLocked;
  62 };
  63
  64 struct ItemInfo {
  65     /** startPos is the position where the clip starts on the track */
  66     GenTime startPos;
  67     /** endPos is the duration where the clip ends on the track */
  68     GenTime endPos;
  69     /** cropStart is the position where the sub-clip starts, relative to the clip's 0 position. Doe not depend on speed */
  70     GenTime originalcropStart;
  71     /** adjustedCropStart is the position where the sub-clip starts, depend on effects (speed,...) */
  72     GenTime cropStart;
  73     /** cropDuration is the position where the sub-clip ends, relative to the clip's 0 position. Doe not depend on speed */
  74     GenTime cropDuration;
  75     int track;
  76 };
  77
  78 struct MltVideoProfile {
  79     QString path;
  80     QString description;
  81     int frame_rate_num;
  82     int frame_rate_den;
  83     int width;
  84     int height;
  85     bool progressive;
  86     int sample_aspect_num;
  87     int sample_aspect_den;
  88     int display_aspect_num;
  89     int display_aspect_den;
  90 };
  91
  92
  93 class EffectParameter
  94 {
  95 public:
  96     EffectParameter(const QString name, const QString value): m_name(name), m_value(value) {}
  97     QString name()   const          {
  98         return m_name;
  99     }
 100     QString value() const          {
 101         return m_value;
 102     }
 103     void setValue(const QString value) {
 104         m_value = value;
 105     }
 106
 107 private:
 108     QString m_name;
 109     QString m_value;
 110 };
 111
 112 /** Use our own list for effect parameters so that they are not sorted in any ways, because
 113     some effects like sox need a precise order
 114 */
 115 class EffectsParameterList: public QList < EffectParameter >
 116 {
 117 public:
 118     EffectsParameterList(): QList < EffectParameter >() {}
 119     bool hasParam(const QString name) const {
 120         for (int i = 0; i < size(); i++)
 121             if (at(i).name() == name) return true;
 122         return false;
 123     }
 124     QString paramValue(const QString name, QString defaultValue = QString()) const {
 125         for (int i = 0; i < size(); i++) {
 126             if (at(i).name() == name) return at(i).value();
 127         }
 128         return defaultValue;
 129     }
 130     void addParam(const QString &name, const QString &value) {
 131         if (name.isEmpty()) return;
 132         append(EffectParameter(name, value));
 133     }
 134     void removeParam(const QString name) {
 135         for (int i = 0; i < size(); i++)
 136             if (at(i).name() == name) {
 137                 removeAt(i);
 138                 break;
 139             }
 140     }
 141 };
 142
 143 class CommentedTime
 144 {
 145 public:
 146     CommentedTime(): t(GenTime(0)) {}
 147     CommentedTime(const GenTime time, QString comment)
 148             : t(time), c(comment) { }
 149
 150     QString comment()   const          {
 151         return (c.isEmpty() ? i18n("Marker") : c);
 152     }
 153     GenTime time() const          {
 154         return t;
 155     }
 156     void    setComment(QString comm) {
 157         c = comm;
 158     }
 159
 160     /* Implementation of > operator; Works identically as with basic types. */
 161     bool operator>(CommentedTime op) const {
 162         return t > op.time();
 163     }
 164     /* Implementation of < operator; Works identically as with basic types. */
 165     bool operator<(CommentedTime op) const {
 166         return t < op.time();
 167     }
 168     /* Implementation of >= operator; Works identically as with basic types. */
 169     bool operator>=(CommentedTime op) const {
 170         return t >= op.time();
 171     }
 172     /* Implementation of <= operator; Works identically as with basic types. */
 173     bool operator<=(CommentedTime op) const {
 174         return t <= op.time();
 175     }
 176     /* Implementation of == operator; Works identically as with basic types. */
 177     bool operator==(CommentedTime op) const {
 178         return t == op.time();
 179     }
 180     /* Implementation of != operator; Works identically as with basic types. */
 181     bool operator!=(CommentedTime op) const {
 182         return t != op.time();
 183     }
 184
 185 private:
 186     GenTime t;
 187     QString c;
 188
 189
 190 };
 191
 192
 193 #endif