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 <QObject>
  29 #include <QUndoGroup>
  30 #include <QUndoStack>
  31 #include <QTimer>
  32
  33 #include <KUrl>
  34 #include <kautosavefile.h>
  35
  36 #include "gentime.h"
  37 #include "timecode.h"
  38 #include "definitions.h"
  39 #include "guide.h"
  40
  41 class Render;
  42 class ClipManager;
  43 class DocClipBase;
  44 class MainWindow;
  45
  46 class KdenliveDoc: public QObject {
  47 Q_OBJECT public:
  48
  49     KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, const QString &profileName, MainWindow *parent = 0);
  50     ~KdenliveDoc();
  51     QDomNodeList producersList();
  52     double fps() const;
  53     int width() const;
  54     int height() const;
  55     KUrl url() const;
  56     KAutoSaveFile *m_autosave;
  57     void backupMltPlaylist();
  58     Timecode timecode() const;
  59     QDomDocument toXml() const;
  60     void setRenderer(Render *render);
  61     QUndoStack *commandStack();
  62     QString producerName(const QString &id);
  63     void setProducerDuration(const QString &id, int duration);
  64     int getProducerDuration(const QString &id);
  65     Render *renderer();
  66     QDomElement m_guidesXml;
  67     ClipManager *clipManager();
  68     void addClip(const QDomElement &elem, const QString &clipId);
  69     void addFolder(const QString foldername, const QString &clipId, bool edit);
  70     void deleteFolder(const QString foldername, const QString &clipId);
  71     void slotAddClipFile(const KUrl url, const QString group, const QString &groupId = QString());
  72     void slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId = QString());
  73     void slotAddTextClipFile(const QString path, const QString xml, const QString group, const QString &groupId = QString());
  74     void editTextClip(QString path, const QString &id);
  75     void slotAddFolder(const QString folderName);
  76     void slotDeleteFolder(const QString folderName, const QString &id);
  77     void slotEditFolder(const QString folderName, const QString oldfolderName, const QString &clipId);
  78     void slotAddColorClipFile(const QString name, const QString color, QString duration, const QString group, const QString &groupId = QString());
  79     void slotAddSlideshowClipFile(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, const QString group, const QString &groupId = QString());
  80     void deleteClip(const QString &clipId);
  81     int getFramePos(QString duration);
  82     DocClipBase *getBaseClip(const QString &clipId);
  83     void updateClip(const QString &id);
  84     void deleteProjectClip(QList <QString> ids);
  85     void deleteProjectFolder(QMap <QString, QString> map);
  86     /** Inform application of the audio thumbnails generation progress */
  87     void setThumbsProgress(const QString &message, int progress);
  88     QString profilePath() const;
  89     QString description() const;
  90     /** Returns the document format: PAL or NTSC */
  91     QString getDocumentStandard();
  92     void setUrl(KUrl url);
  93     QDomElement documentInfoXml();
  94     void setProfilePath(QString path);
  95     /** Set to true if document needs saving, false otherwise */
  96     void setModified(bool mod);
  97     const QString&getFreeClipId();
  98     /** does the document need saving */
  99     bool isModified() const;
 100     /** Returns project folder, used to store project files (titles, effects,...) */
 101     KUrl projectFolder() const;
 102     /** Used to inform main app of the current document loading progress */
 103     void loadingProgressed();
 104     void updateAllProjectClips();
 105     void syncGuides(QList <Guide *> guides);
 106     void setZoom(int factor);
 107     int zoom() const;
 108     const double dar();
 109
 110 private:
 111     KUrl m_url;
 112     QDomDocument m_document;
 113     QString m_projectName;
 114     double m_fps;
 115     int m_zoom;
 116     /** Cursor position at document opening */
 117     int m_startPos;
 118     int m_width;
 119     int m_height;
 120     Timecode m_timecode;
 121     Render *m_render;
 122     QUndoStack *m_commandStack;
 123     QDomDocument generateSceneList();
 124     ClipManager *m_clipManager;
 125     MltVideoProfile m_profile;
 126     QString m_scenelist;
 127     QTimer *m_autoSaveTimer;
 128     /** tells whether current doc has been changed since last save event */
 129     bool m_modified;
 130     /** Project folder, used to store project files (titles, effects,...) */
 131     KUrl m_projectFolder;
 132     double m_documentLoadingStep;
 133     double m_documentLoadingProgress;
 134     void convertDocument(double version);
 135     QDomDocument createEmptyDocument();
 136
 137 public slots:
 138     void slotCreateTextClip(QString group, const QString &groupId);
 139
 140 private slots:
 141     void slotAutoSave();
 142
 143 signals:
 144     void addProjectClip(DocClipBase *);
 145     void addProjectFolder(const QString, const QString &, bool, bool edit = false);
 146     void signalDeleteProjectClip(const QString &);
 147     void updateClipDisplay(const QString&);
 148     void deleteTimelineClip(const QString&);
 149     void progressInfo(const QString &, int);
 150     /** emited when the document state has been modified (= needs saving or not) */
 151     void docModified(bool);
 152     void refreshClipThumbnail(const QString &);
 153     void selectLastAddedClip(const QString &);
 154 };
 155
 156 #endif