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 <KLocale>
  28
  29 #include <QTreeWidgetItem>
  30  #include <QtCore/QString>
  31
  32 const int MAXCLIPDURATION = 15000;
  33
  34 namespace Kdenlive {
  35   enum MONITORID { noMonitor, clipMonitor, projectMonitor, recordMonitor, stopmotionMonitor, dvdMonitor };
  36   /*const QString clipMonitor("clipMonitor");
  37   const QString recordMonitor("recordMonitor");
  38   const QString projectMonitor("projectMonitor");
  39   const QString stopmotionMonitor("stopmotionMonitor");*/
  40 }
  41
  42 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};
  43 enum CLIPTYPE { UNKNOWN = 0, AUDIO = 1, VIDEO = 2, AV = 3, COLOR = 4, IMAGE = 5, TEXT = 6, SLIDESHOW = 7, VIRTUAL = 8, PLAYLIST = 9 };
  44
  45 enum PROJECTITEMTYPE { PROJECTCLIPTYPE = QTreeWidgetItem::UserType, PROJECTFOLDERTYPE, PROJECTSUBCLIPTYPE };
  46
  47 enum GRAPHICSRECTITEM { AVWIDGET = 70000 , LABELWIDGET , TRANSITIONWIDGET  , GROUPWIDGET};
  48
  49 enum PROJECTTOOL { SELECTTOOL = 0 , RAZORTOOL = 1 , SPACERTOOL = 2 };
  50
  51 enum TRANSITIONTYPE {
  52     /** TRANSITIONTYPE: between 0-99: video trans, 100-199: video+audio trans, 200-299: audio trans */
  53     LUMA_TRANSITION = 0,
  54     COMPOSITE_TRANSITION = 1,
  55     PIP_TRANSITION = 2,
  56     LUMAFILE_TRANSITION = 3,
  57     MIX_TRANSITION = 200
  58 };
  59
  60 enum MessageType {
  61     DefaultMessage,
  62     OperationCompletedMessage,
  63     InformationMessage,
  64     ErrorMessage,
  65     MltError
  66 };
  67
  68 enum TRACKTYPE { AUDIOTRACK = 0, VIDEOTRACK = 1 };
  69
  70 enum CLIPJOBSTATUS { NOJOB = 0, JOBWAITING = -1, JOBWORKING = -2, JOBDONE = -3, JOBCRASHED = -4, JOBABORTED = -5};
  71
  72 struct TrackInfo {
  73     TRACKTYPE type;
  74     QString trackName;
  75     bool isMute;
  76     bool isBlind;
  77     bool isLocked;
  78     EffectsList effectsList;
  79     int duration;
  80 };
  81
  82 typedef QMap<QString, QString> stringMap;
  83 typedef QMap <int, QMap <int, QByteArray> > audioByteArray;
  84
  85 struct ItemInfo {
  86     /** startPos is the position where the clip starts on the track */
  87     GenTime startPos;
  88     /** endPos is the duration where the clip ends on the track */
  89     GenTime endPos;
  90     /** cropStart is the position where the sub-clip starts, relative to the clip's 0 position */
  91     GenTime cropStart;
  92     /** cropDuration is the duration of the clip */
  93     GenTime cropDuration;
  94     int track;
  95 };
  96
  97 struct MltVideoProfile {
  98     QString path;
  99     QString description;
 100     int frame_rate_num;
 101     int frame_rate_den;
 102     int width;
 103     int height;
 104     bool progressive;
 105     int sample_aspect_num;
 106     int sample_aspect_den;
 107     int display_aspect_num;
 108     int display_aspect_den;
 109     int colorspace;
 110     bool operator==(const MltVideoProfile& point) const
 111     {
 112         if (!description.isEmpty() && point.description  == description) return true;
 113         return      point.frame_rate_num == frame_rate_num &&
 114                     point.frame_rate_den  == frame_rate_den  &&
 115                     point.width == width &&
 116                     point.height == height &&
 117                     point.progressive == progressive &&
 118                     point.sample_aspect_num == sample_aspect_num &&
 119                     point.sample_aspect_den == sample_aspect_den &&
 120                     point.display_aspect_den == display_aspect_den &&
 121                     point.colorspace == colorspace;
 122     }
 123     bool operator!=(const MltVideoProfile &other) const {
 124         return !(*this == other);
 125     }
 126 };
 127
 128 /**)
 129  * @class EffectInfo
 130  * @brief A class holding some meta info for effects widgets, like state (collapsed or not, ...)
 131  * @author Jean-Baptiste Mardelle
 132  */
 133
 134 class EffectInfo
 135 {
 136 public:
 137     EffectInfo() {isCollapsed = false; groupIndex = -1;}
 138     bool isCollapsed;
 139     int groupIndex;
 140     QString groupName;
 141     QString toString() const {
 142         QStringList data;
 143         data << QString::number(isCollapsed) << QString::number(groupIndex) << groupName;
 144         return data.join("/");
 145     }
 146     void fromString(QString value) {
 147         if (value.isEmpty()) return;
 148         QStringList data = value.split("/");
 149         isCollapsed = data.at(0).toInt();
 150         if (data.count() > 1) groupIndex = data.at(1).toInt();
 151         if (data.count() > 2) groupName = data.at(2);
 152     }
 153 };
 154
 155 class EffectParameter
 156 {
 157 public:
 158     EffectParameter(const QString &name, const QString &value): m_name(name), m_value(value) {}
 159     QString name()   const          {
 160         return m_name;
 161     }
 162     QString value() const          {
 163         return m_value;
 164     }
 165     void setValue(const QString &value) {
 166         m_value = value;
 167     }
 168
 169 private:
 170     QString m_name;
 171     QString m_value;
 172 };
 173
 174 /** Use our own list for effect parameters so that they are not sorted in any ways, because
 175     some effects like sox need a precise order
 176 */
 177 class EffectsParameterList: public QList < EffectParameter >
 178 {
 179 public:
 180     EffectsParameterList(): QList < EffectParameter >() {}
 181     bool hasParam(const QString &name) const {
 182         for (int i = 0; i < size(); i++)
 183             if (at(i).name() == name) return true;
 184         return false;
 185     }
 186     QString paramValue(const QString &name, QString defaultValue = QString()) const {
 187         for (int i = 0; i < size(); i++) {
 188             if (at(i).name() == name) return at(i).value();
 189         }
 190         return defaultValue;
 191     }
 192     void addParam(const QString &name, const QString &value) {
 193         if (name.isEmpty()) return;
 194         append(EffectParameter(name, value));
 195     }
 196     void removeParam(const QString &name) {
 197         for (int i = 0; i < size(); i++)
 198             if (at(i).name() == name) {
 199                 removeAt(i);
 200                 break;
 201             }
 202     }
 203 };
 204
 205 class CommentedTime
 206 {
 207 public:
 208     CommentedTime(): t(GenTime(0)) {}
 209     CommentedTime(const GenTime &time, QString comment)
 210         : t(time), c(comment) { }
 211
 212     QString comment()   const          {
 213         return (c.isEmpty() ? i18n("Marker") : c);
 214     }
 215     GenTime time() const          {
 216         return t;
 217     }
 218     void    setComment(QString comm) {
 219         c = comm;
 220     }
 221
 222     /* Implementation of > operator; Works identically as with basic types. */
 223     bool operator>(CommentedTime op) const {
 224         return t > op.time();
 225     }
 226     /* Implementation of < operator; Works identically as with basic types. */
 227     bool operator<(CommentedTime op) const {
 228         return t < op.time();
 229     }
 230     /* Implementation of >= operator; Works identically as with basic types. */
 231     bool operator>=(CommentedTime op) const {
 232         return t >= op.time();
 233     }
 234     /* Implementation of <= operator; Works identically as with basic types. */
 235     bool operator<=(CommentedTime op) const {
 236         return t <= op.time();
 237     }
 238     /* Implementation of == operator; Works identically as with basic types. */
 239     bool operator==(CommentedTime op) const {
 240         return t == op.time();
 241     }
 242     /* Implementation of != operator; Works identically as with basic types. */
 243     bool operator!=(CommentedTime op) const {
 244         return t != op.time();
 245     }
 246
 247 private:
 248     GenTime t;
 249     QString c;
 250
 251
 252 };
 253
 254
 255 #endif