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