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 KdenliveDoc: public QObject
  49 {
  50 Q_OBJECT public:
  51
  52     KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, QString profileName, const QPoint tracks, Render *render, MainWindow *parent = 0);
  53     ~KdenliveDoc();
  54     QDomNodeList producersList();
  55     double fps() const;
  56     int width() const;
  57     int height() const;
  58     KUrl url() const;
  59     KAutoSaveFile *m_autosave;
  60     Timecode timecode() const;
  61     QDomDocument toXml();
  62     //void setRenderer(Render *render);
  63     QUndoStack *commandStack();
  64     QString producerName(const QString &id);
  65     Render *renderer();
  66     QDomDocument m_guidesXml;
  67     QDomElement guidesXml() const;
  68     ClipManager *clipManager();
  69     /** @brief Add a clip to the project tree */
  70     void addClip(QDomElement elem, QString clipId, bool createClipItem = true);
  71     void addClipInfo(QDomElement elem, QDomElement orig, QString clipId);
  72     void slotAddClipFile(const KUrl url, const QString group, const QString &groupId = QString());
  73     void slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId = QString());
  74     void deleteClip(const QString &clipId);
  75     int getFramePos(QString duration);
  76     DocClipBase *getBaseClip(const QString &clipId);
  77     void updateClip(const QString id);
  78     /** Inform application of the audio thumbnails generation progress */
  79     void setThumbsProgress(const QString &message, int progress);
  80     const QString &profilePath() const;
  81     MltVideoProfile mltProfile() const;
  82     const QString description() const;
  83     void setUrl(KUrl url);
  84     /** update project profile, returns true if fps was changed */
  85     bool setProfilePath(QString path);
  86     const QString getFreeClipId();
  87     /** does the document need saving */
  88     bool isModified() const;
  89     /** Returns project folder, used to store project files (titles, effects,...) */
  90     KUrl projectFolder() const;
  91     void syncGuides(QList <Guide *> guides);
  92     void setZoom(int horizontal, int vertical);
  93     QPoint zoom() const;
  94     double dar();
  95     double projectDuration() const;
  96     bool saveSceneList(const QString &path, const QString &scene);
  97     int tracksCount() const;
  98     TrackInfo trackInfoAt(int ix) const;
  99     void insertTrack(int ix, TrackInfo type);
 100     void deleteTrack(int ix);
 101     void setTrackType(int ix, TrackInfo type);
 102     const QList <TrackInfo> tracksList() const;
 103     QPoint getTracksCount() const;
 104     void switchTrackVideo(int ix, bool hide);
 105     void switchTrackAudio(int ix, bool hide);
 106     void switchTrackLock(int ix, bool lock);
 107     void cachePixmap(const QString &fileId, const QPixmap &pix) const;
 108     void setProjectFolder(KUrl url);
 109     QString getLadspaFile() const;
 110     void setZone(int start, int end);
 111     QPoint zone() const;
 112     int setSceneList();
 113     void updatePreviewSettings();
 114     bool isTrackLocked(int ix) const;
 115     void setDocumentProperty(const QString &name, const QString &value);
 116     const QString getDocumentProperty(const QString &name) const;
 117
 118 private:
 119     KUrl m_url;
 120     QDomDocument m_document;
 121     double m_fps;
 122     int m_width;
 123     int m_height;
 124     Timecode m_timecode;
 125     Render *m_render;
 126     QUndoStack *m_commandStack;
 127     ClipManager *m_clipManager;
 128     MltVideoProfile m_profile;
 129     QTimer *m_autoSaveTimer;
 130     QString m_searchFolder;
 131     /** tells whether current doc has been changed since last save event */
 132     bool m_modified;
 133     /** Project folder, used to store project files (titles, effects,...) */
 134     KUrl m_projectFolder;
 135     bool m_abortLoading;
 136     QMap <QString, QString> m_documentProperties;
 137
 138     QList <TrackInfo> m_tracksList;
 139     void setNewClipResource(const QString &id, const QString &path);
 140     QString searchFileRecursively(const QDir &dir, const QString &matchSize, const QString &matchHash) const;
 141     void moveProjectData(KUrl url);
 142     bool checkDocumentClips(QDomNodeList infoproducers);
 143     /** Creates a new project */
 144     QDomDocument createEmptyDocument(int videotracks, int audiotracks);
 145     QDomDocument createEmptyDocument(QList <TrackInfo> tracks);
 146
 147 public slots:
 148     void slotCreateXmlClip(const QString &name, const QDomElement xml, QString group, const QString &groupId);
 149     void slotCreateColorClip(const QString &name, const QString &color, const QString &duration, QString group, const QString &groupId);
 150     void slotCreateSlideshowClipFile(const QString name, const QString path, int count, const QString duration, const bool loop, const bool fade, const QString &luma_duration, const QString &luma_file, const int softness, QString group, const QString &groupId);
 151     void slotCreateTextClip(QString group, const QString &groupId, const QString &templatePath = QString());
 152     void slotCreateTextTemplateClip(QString group, const QString &groupId, KUrl path);
 153     /** Set to true if document needs saving, false otherwise */
 154     void setModified(bool mod = true);
 155     void checkProjectClips();
 156
 157 private slots:
 158     void slotAutoSave();
 159
 160 signals:
 161     void resetProjectList();
 162     void addProjectClip(DocClipBase *, bool getInfo = true);
 163     void signalDeleteProjectClip(const QString &);
 164     void updateClipDisplay(const QString&);
 165     void deleteTimelineClip(const QString&);
 166     void progressInfo(const QString &, int);
 167     /** emitted when the document state has been modified (= needs saving or not) */
 168     void docModified(bool);
 169     void selectLastAddedClip(const QString &);
 170     void guidesUpdated();
 171 };
 172
 173 #endif