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