git.sesse.net Git - kdenlive/blob - src/kdenlivedoc.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 KDENLIVEDOC_H
  22 #define KDENLIVEDOC_H
  23
  24 #include <qdom.h>
  25 #include <QString>
  26 #include <QMap>
  27 #include <QList>
  28 #include <QDir>
  29 #include <QObject>
  30 #include <QUndoGroup>
  31 #include <QUndoStack>
  32 #include <QTimer>
  33
  34 #include <KUrl>
  35 #include <kautosavefile.h>
  36
  37 #include "gentime.h"
  38 #include "timecode.h"
  39 #include "definitions.h"
  40 #include "guide.h"
  41
  42 class Render;
  43 class ClipManager;
  44 class DocClipBase;
  45 class MainWindow;
  46 class TrackInfo;
  47
  48 class KTextEdit;
  49 class KProgressDialog;
  50
  51 class KdenliveDoc: public QObject
  52 {
  53 Q_OBJECT public:
  54
  55     KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, QString profileName, QMap <QString, QString> properties, QMap <QString, QString> metadata, const QPoint &tracks, Render *render, KTextEdit *notes, bool *openBackup, MainWindow *parent = 0, KProgressDialog *progressDialog = 0);
  56     ~KdenliveDoc();
  57     QDomNodeList producersList();
  58     double fps() const;
  59     int width() const;
  60     int height() const;
  61     KUrl url() const;
  62     KAutoSaveFile *m_autosave;
  63     Timecode timecode() const;
  64     QDomDocument toXml();
  65     //void setRenderer(Render *render);
  66     QUndoStack *commandStack();
  67     QString producerName(const QString &id);
  68     Render *renderer();
  69     QDomDocument m_guidesXml;
  70     QDomElement guidesXml() const;
  71     ClipManager *clipManager();
  72
  73     /** @brief Adds a clip to the project tree.
  74      * @return false if the user aborted the operation, true otherwise */
  75     bool addClip(QDomElement elem, QString clipId, bool createClipItem = true);
  76
  77     /** @brief Updates information about a clip.
  78      * @param elem the <kdenlive_producer />
  79      * @param orig the potential <producer />
  80      * @param clipId the producer id
  81      * @return false if the user aborted the operation (in case the clip wasn't
  82      *     there yet), true otherwise
  83      *
  84      * If the clip wasn't added before, it tries to add it to the project. */
  85     bool addClipInfo(QDomElement elem, QDomElement orig, QString clipId);
  86     void slotAddClipFile(const KUrl &url, const QString &group = QString(), const QString &groupId = QString(), const QString &comment = QString());
  87     void slotAddClipList(const KUrl::List urls, const QString &group = QString(), const QString &groupId = QString());
  88     void deleteClip(const QString &clipId);
  89     int getFramePos(QString duration);
  90     DocClipBase *getBaseClip(const QString &clipId);
  91     void updateClip(const QString &id);
  92
  93     /** @brief Informs Kdenlive of the audio thumbnails generation progress. */
  94     void setThumbsProgress(const QString &message, int progress);
  95     const QString &profilePath() const;
  96     MltVideoProfile mltProfile() const;
  97     const QString description() const;
  98     void setUrl(KUrl url);
  99
 100     /** @brief Updates the project profile.
 101      * @return true if frame rate was changed */
 102     bool setProfilePath(QString path);
 103     const QString getFreeClipId();
 104
 105     /** @brief Defines whether the document needs to be saved. */
 106     bool isModified() const;
 107
 108     /** @brief Returns the project folder, used to store project files. */
 109     KUrl projectFolder() const;
 110     void syncGuides(QList <Guide *> guides);
 111     void setZoom(int horizontal, int vertical);
 112     QPoint zoom() const;
 113     double dar() const;
 114     double projectDuration() const;
 115     /** @brief Returns the project file xml. */
 116     QDomDocument xmlSceneList(const QString &scene, const QStringList &expandedFolders);
 117     /** @brief Saves the project file xml to a file. */
 118     bool saveSceneList(const QString &path, const QString &scene, const QStringList &expandedFolders, bool autosave = false);
 119     int tracksCount() const;
 120     TrackInfo trackInfoAt(int ix) const;
 121     void insertTrack(int ix, TrackInfo type);
 122     void deleteTrack(int ix);
 123     void setTrackType(int ix, TrackInfo type);
 124     const QList <TrackInfo> tracksList() const;
 125
 126     /** @brief Gets the number of audio and video tracks and returns them as a QPoint with x = video, y = audio. */
 127     QPoint getTracksCount() const;
 128
 129     void switchTrackVideo(int ix, bool hide);
 130     void switchTrackAudio(int ix, bool hide);
 131     void switchTrackLock(int ix, bool lock);
 132     bool isTrackLocked(int ix) const;
 133
 134     /** @brief Sets the duration of track @param ix to @param duration.
 135      * This does not! influence the actual track but only the value in its TrackInfo. */
 136     void setTrackDuration(int ix, int duration);
 137
 138     /** @brief Returns the duration of track @param ix.
 139      *
 140      * The returned duration might differ from the actual track duration!
 141      * It is the one stored in the track's TrackInfo. */
 142     int trackDuration(int ix);
 143     void cacheImage(const QString &fileId, const QImage &img) const;
 144     void setProjectFolder(KUrl url);
 145     void setZone(int start, int end);
 146     QPoint zone() const;
 147     int setSceneList();
 148     void setDocumentProperty(const QString &name, const QString &value);
 149     const QString getDocumentProperty(const QString &name) const;
 150
 151     /** @brief Gets the list of renderer properties saved into the document. */
 152     QMap <QString, QString> getRenderProperties() const;
 153     void addTrackEffect(int ix, QDomElement effect);
 154     void removeTrackEffect(int ix, QDomElement effect);
 155     void setTrackEffect(int trackIndex, int effectIndex, QDomElement effect);
 156     const EffectsList getTrackEffects(int ix);
 157     QDomElement getTrackEffect(int trackIndex, int effectIndex) const;
 158     /** @brief Get a list of folder id's that were opened on last save. */
 159     QStringList getExpandedFolders();
 160     /** @brief Read the display ratio from an xml project file. */
 161     static double getDisplayRatio(const QString &path);
 162     /** @brief Backup the project file */
 163     void backupLastSavedVersion(const QString &path);
 164     /** @brief Returns the document metadata (author, copyright, ...) */
 165     const QMap <QString, QString> metadata() const;
 166     /** @brief Set the document metadata (author, copyright, ...) */
 167     void setMetadata(const QMap <QString, QString> meta);
 168
 169 private:
 170     KUrl m_url;
 171     QDomDocument m_document;
 172     double m_fps;
 173     int m_width;
 174     int m_height;
 175     Timecode m_timecode;
 176     Render *m_render;
 177     KTextEdit *m_notesWidget;
 178     QUndoStack *m_commandStack;
 179     ClipManager *m_clipManager;
 180     MltVideoProfile m_profile;
 181     QTimer *m_autoSaveTimer;
 182     QString m_searchFolder;
 183
 184     /** @brief Tells whether the current document has been changed after being saved. */
 185     bool m_modified;
 186
 187     /** @brief The project folder, used to store project files (titles, effects...). */
 188     KUrl m_projectFolder;
 189     QMap <QString, QString> m_documentProperties;
 190     QMap <QString, QString> m_documentMetadata;
 191
 192     QList <TrackInfo> m_tracksList;
 193     void setNewClipResource(const QString &id, const QString &path);
 194     QString searchFileRecursively(const QDir &dir, const QString &matchSize, const QString &matchHash) const;
 195     void moveProjectData(KUrl url);
 196     bool checkDocumentClips(QDomNodeList infoproducers);
 197
 198     /** @brief Creates a new project. */
 199     QDomDocument createEmptyDocument(int videotracks, int audiotracks);
 200     QDomDocument createEmptyDocument(QList <TrackInfo> tracks);
 201     /** @brief Saves effects embedded in project file.
 202     *   @return True if effects were imported.  */
 203     bool saveCustomEffects(QDomNodeList customeffects);
 204
 205     /** @brief Updates the project folder location entry in the kdenlive file dialogs to point to the current project folder. */
 206     void updateProjectFolderPlacesEntry();
 207     /** @brief Only keep some backup files, delete some */
 208     void cleanupBackupFiles();
 209
 210 public slots:
 211     void slotCreateXmlClip(const QString &name, const QDomElement xml, QString group, const QString &groupId);
 212     void slotCreateColorClip(const QString &name, const QString &color, const QString &duration, QString group, const QString &groupId);
 213     void slotCreateSlideshowClipFile(QMap <QString, QString> properties, QString group, const QString &groupId);
 214     void slotCreateTextClip(QString group, const QString &groupId, const QString &templatePath = QString());
 215     void slotCreateTextTemplateClip(QString group, const QString &groupId, KUrl path);
 216
 217     /** @brief Sets the document as modified or up to date.
 218      * @param mod (optional) true if the document has to be saved */
 219     void setModified(bool mod = true);
 220     void checkProjectClips(bool displayRatioChanged = false, bool fpsChanged = false);
 221
 222 private slots:
 223     void slotAutoSave();
 224
 225 signals:
 226     void resetProjectList();
 227     void addProjectClip(DocClipBase *, bool getInfo = true);
 228     void signalDeleteProjectClip(const QString &);
 229     void updateClipDisplay(const QString&);
 230     void progressInfo(const QString &, int);
 231
 232     /** @brief Informs that the document status has been changed.
 233      *
 234      * If the document has been modified, it's called with true as an argument. */
 235     void docModified(bool);
 236     void selectLastAddedClip(const QString &);
 237     void guidesUpdated();
 238     /** @brief When creating a backup file, also save a thumbnail of current timeline */
 239     void saveTimelinePreview(const QString &path);
 240 };
 241
 242 #endif