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 Q_OBJECT public:
  50
  51     KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, const QString &profileName, const QPoint tracks, MainWindow *parent = 0);
  52     ~KdenliveDoc();
  53     QDomNodeList producersList();
  54     double fps() const;
  55     int width() const;
  56     int height() const;
  57     KUrl url() const;
  58     KAutoSaveFile *m_autosave;
  59     void backupMltPlaylist();
  60     Timecode timecode() const;
  61     QDomDocument toXml() const;
  62     void setRenderer(Render *render);
  63     QUndoStack *commandStack();
  64     QString producerName(const QString &id);
  65     void setProducerDuration(const QString &id, int duration);
  66     int getProducerDuration(const QString &id);
  67     Render *renderer();
  68     QDomElement m_guidesXml;
  69     QDomElement guidesXml() const;
  70     ClipManager *clipManager();
  71     void addClip(QDomElement elem, QString clipId, bool createClipItem = true);
  72     void addClipInfo(QDomElement elem, QString clipId);
  73     void addFolder(const QString foldername, const QString &clipId, bool edit);
  74     void deleteFolder(const QString foldername, const QString &clipId);
  75     void slotAddClipFile(const KUrl url, const QString group, const QString &groupId = QString());
  76     void slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId = QString());
  77     void slotAddFolder(const QString folderName);
  78     void slotDeleteFolder(const QString folderName, const QString &id);
  79     void slotEditFolder(const QString folderName, const QString oldfolderName, const QString &clipId);
  80     void slotAddColorClipFile(const QString name, const QString color, QString duration, const QString group, const QString &groupId = QString());
  81     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());
  82     void deleteClip(const QString &clipId);
  83     int getFramePos(QString duration);
  84     DocClipBase *getBaseClip(const QString &clipId);
  85     void updateClip(const QString &id);
  86     void deleteProjectClip(QList <QString> ids);
  87     void deleteProjectFolder(QMap <QString, QString> map);
  88     /** Inform application of the audio thumbnails generation progress */
  89     void setThumbsProgress(const QString &message, int progress);
  90     QString profilePath() const;
  91     MltVideoProfile mltProfile() const;
  92     QString description() const;
  93     void setUrl(KUrl url);
  94     void setProfilePath(QString path);
  95     const QString&getFreeClipId();
  96     /** does the document need saving */
  97     bool isModified() const;
  98     /** Returns project folder, used to store project files (titles, effects,...) */
  99     KUrl projectFolder() const;
 100     /** Used to inform main app of the current document loading progress */
 101     void loadingProgressed();
 102     void syncGuides(QList <Guide *> guides);
 103     void setZoom(int factor);
 104     int zoom() const;
 105     const double dar();
 106     double projectDuration() const;
 107     bool saveSceneList(const QString &path, QDomDocument sceneList);
 108     int tracksCount() const;
 109     TrackInfo trackInfoAt(int ix) const;
 110     void insertTrack(int ix, TrackInfo type);
 111     void deleteTrack(int ix);
 112     const QList <TrackInfo> tracksList() const;
 113     QPoint getTracksCount() const;
 114     QString getTracksInfo() const;
 115     void switchTrackVideo(int ix, bool hide);
 116     void switchTrackAudio(int ix, bool hide);
 117
 118 private:
 119     KUrl m_url;
 120     QDomDocument m_document;
 121     QString m_projectName;
 122     double m_fps;
 123     int m_zoom;
 124     /** Cursor position at document opening */
 125     int m_startPos;
 126     int m_width;
 127     int m_height;
 128     Timecode m_timecode;
 129     Render *m_render;
 130     QUndoStack *m_commandStack;
 131     QDomDocument generateSceneList();
 132     ClipManager *m_clipManager;
 133     MltVideoProfile m_profile;
 134     QString m_scenelist;
 135     QTimer *m_autoSaveTimer;
 136     QString m_searchFolder;
 137     /** tells whether current doc has been changed since last save event */
 138     bool m_modified;
 139     /** Project folder, used to store project files (titles, effects,...) */
 140     KUrl m_projectFolder;
 141     double m_documentLoadingStep;
 142     double m_documentLoadingProgress;
 143
 144     QList <TrackInfo> m_tracksList;
 145
 146     void convertDocument(double version);
 147     QDomDocument createEmptyDocument(const int videotracks, const int audiotracks);
 148     QString colorToString(const QColor& c);
 149     void checkProjectClips();
 150     void setNewClipResource(const QString &id, const QString &path);
 151     QString searchFileRecursively(const QDir &dir, const QString &matchSize, const QString &matchHash) const;
 152
 153 public slots:
 154     void slotCreateTextClip(QString group, const QString &groupId);
 155     /** Set to true if document needs saving, false otherwise */
 156     void setModified(bool mod = true);
 157
 158 private slots:
 159     void slotAutoSave();
 160
 161 signals:
 162     void addProjectClip(DocClipBase *);
 163     void addProjectFolder(const QString, const QString &, bool, bool edit = false);
 164     void signalDeleteProjectClip(const QString &);
 165     void updateClipDisplay(const QString&);
 166     void deleteTimelineClip(const QString&);
 167     void progressInfo(const QString &, int);
 168     /** emited when the document state has been modified (= needs saving or not) */
 169     void docModified(bool);
 170     void selectLastAddedClip(const QString &);
 171     void guidesUpdated();
 172 };
 173
 174 #endif