#define KDENLIVEDOC_H
#include <qdom.h>
-#include <qstring.h>
-#include <qmap.h>
+#include <QString>
+#include <QMap>
#include <QList>
+#include <QDir>
#include <QObject>
+#include <QUndoGroup>
+#include <QUndoStack>
+#include <QTimer>
-#include <KUndoStack>
-#include <kurl.h>
+#include <KUrl>
+#include <kautosavefile.h>
#include "gentime.h"
#include "timecode.h"
-#include "renderer.h"
-#include "clipmanager.h"
#include "definitions.h"
+#include "guide.h"
-class KdenliveDoc: public QObject {
+class Render;
+class ClipManager;
+class DocClipBase;
+class MainWindow;
+class TrackInfo;
+
+class KTextEdit;
+class KProgressDialog;
+
+class KdenliveDoc: public QObject
+{
Q_OBJECT public:
- KdenliveDoc(const KUrl &url, MltVideoProfile profile, QWidget *parent = 0);
+ KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, QString profileName, const QPoint tracks, Render *render, KTextEdit *notes, MainWindow *parent = 0, KProgressDialog *progressDialog = 0);
~KdenliveDoc();
- QString documentName();
QDomNodeList producersList();
- double fps();
- int width();
- int height();
- KUrl url();
- void backupMltPlaylist();
- Timecode timecode();
+ double fps() const;
+ int width() const;
+ int height() const;
+ KUrl url() const;
+ KAutoSaveFile *m_autosave;
+ Timecode timecode() const;
QDomDocument toXml();
- void setRenderer(Render *render);
- KUndoStack *commandStack();
- QString producerName(int id);
- void setProducerDuration(int id, int duration);
- int getProducerDuration(int id);
+ //void setRenderer(Render *render);
+ QUndoStack *commandStack();
+ QString producerName(const QString &id);
Render *renderer();
+ QDomDocument m_guidesXml;
+ QDomElement guidesXml() const;
ClipManager *clipManager();
- void addClip(const QDomElement &elem, const int clipId);
- void slotAddClipFile(const KUrl url, const QString group);
- void slotAddColorClipFile(const QString name, const QString color, QString duration, const QString group);
- void deleteClip(const uint clipId);
+
+ /** @brief Adds a clip to the project tree.
+ * @return false if the user aborted the operation, true otherwise */
+ bool addClip(QDomElement elem, QString clipId, bool createClipItem = true);
+
+ /** @brief Updates information about a clip.
+ * @param elem the <kdenlive_producer />
+ * @param orig the potential <producer />
+ * @param clipId the producer id
+ * @return false if the user aborted the operation (in case the clip wasn't
+ * there yet), true otherwise
+ *
+ * If the clip wasn't added before, it tries to add it to the project. */
+ bool addClipInfo(QDomElement elem, QDomElement orig, QString clipId);
+ void slotAddClipFile(const KUrl url, const QString group, const QString &groupId = QString());
+ void slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId = QString());
+ void deleteClip(const QString &clipId);
int getFramePos(QString duration);
- DocClipBase *getBaseClip(int clipId);
- void updateClip(int id);
- void deleteProjectClip(const uint clipId);
- /** Inform application of the audio thumbnails generation progress */
- void setThumbsProgress(KUrl url, int progress);
- QString profilePath();
+ DocClipBase *getBaseClip(const QString &clipId);
+ void updateClip(const QString id);
+
+ /** @brief Informs Kdenlive of the audio thumbnails generation progress. */
+ void setThumbsProgress(const QString &message, int progress);
+ const QString &profilePath() const;
+ MltVideoProfile mltProfile() const;
+ const QString description() const;
+ void setUrl(KUrl url);
+
+ /** @brief Updates the project profile.
+ * @return true if frame rate was changed */
+ bool setProfilePath(QString path);
+ const QString getFreeClipId();
+
+ /** @brief Defines whether the document needs to be saved. */
+ bool isModified() const;
+
+ /** @brief Returns the project folder, used to store project files. */
+ KUrl projectFolder() const;
+ void syncGuides(QList <Guide *> guides);
+ void setZoom(int horizontal, int vertical);
+ QPoint zoom() const;
+ double dar() const;
+ double projectDuration() const;
+ bool saveSceneList(const QString &path, const QString &scene);
+ int tracksCount() const;
+ TrackInfo trackInfoAt(int ix) const;
+ void insertTrack(int ix, TrackInfo type);
+ void deleteTrack(int ix);
+ void setTrackType(int ix, TrackInfo type);
+ const QList <TrackInfo> tracksList() const;
+ QPoint getTracksCount() const;
+ void switchTrackVideo(int ix, bool hide);
+ void switchTrackAudio(int ix, bool hide);
+ void switchTrackLock(int ix, bool lock);
+ void cachePixmap(const QString &fileId, const QPixmap &pix) const;
+ void setProjectFolder(KUrl url);
+ QString getLadspaFile() const;
+ void setZone(int start, int end);
+ QPoint zone() const;
+ int setSceneList();
+ bool isTrackLocked(int ix) const;
+ void setDocumentProperty(const QString &name, const QString &value);
+ const QString getDocumentProperty(const QString &name) const;
+
+ /** @brief Gets the list of renderer properties saved into the document. */
+ QMap <QString, QString> getRenderProperties() const;
+ void addTrackEffect(int ix, QDomElement effect);
+ void removeTrackEffect(int ix, QDomElement effect);
+ void setTrackEffect(int trackIndex, int effectIndex, QDomElement effect);
+ const EffectsList getTrackEffects(int ix);
+ QDomElement getTrackEffect(int trackIndex, int effectIndex) const;
private:
KUrl m_url;
QDomDocument m_document;
- QString m_projectName;
double m_fps;
int m_width;
int m_height;
Timecode m_timecode;
Render *m_render;
- KUndoStack *m_commandStack;
- QDomDocument generateSceneList();
+ KTextEdit *m_notesWidget;
+ QUndoStack *m_commandStack;
ClipManager *m_clipManager;
MltVideoProfile m_profile;
- QString m_scenelist;
+ QTimer *m_autoSaveTimer;
+ QString m_searchFolder;
+
+ /** @brief Tells whether the current document has been changed after being saved. */
+ bool m_modified;
+
+ /** @brief The project folder, used to store project files (titles, effects...). */
+ KUrl m_projectFolder;
+ QMap <QString, QString> m_documentProperties;
+
+ QList <TrackInfo> m_tracksList;
+ void setNewClipResource(const QString &id, const QString &path);
+ QString searchFileRecursively(const QDir &dir, const QString &matchSize, const QString &matchHash) const;
+ void moveProjectData(KUrl url);
+ bool checkDocumentClips(QDomNodeList infoproducers);
+
+ /** @brief Creates a new project. */
+ QDomDocument createEmptyDocument(int videotracks, int audiotracks);
+ QDomDocument createEmptyDocument(QList <TrackInfo> tracks);
+ /** @brief Saves effects embedded in project file.
+ * @return True if effects were imported. */
+ bool saveCustomEffects(QDomNodeList customeffects);
+
+ /** @brief Updates the project folder location entry in the kdenlive file dialogs to point to the current project folder. */
+ void updateProjectFolderPlacesEntry();
public slots:
+ void slotCreateXmlClip(const QString &name, const QDomElement xml, QString group, const QString &groupId);
+ void slotCreateColorClip(const QString &name, const QString &color, const QString &duration, QString group, const QString &groupId);
+ void slotCreateSlideshowClipFile(const QString name, const QString path,
+ int count, const QString duration,
+ const bool loop, const bool crop,
+ const bool fade, const QString &luma_duration,
+ const QString &luma_file, const int softness,
+ const QString &animation, QString group,
+ const QString &groupId);
+ void slotCreateTextClip(QString group, const QString &groupId, const QString &templatePath = QString());
+ void slotCreateTextTemplateClip(QString group, const QString &groupId, KUrl path);
+
+ /** @brief Sets the document as modified or up to date.
+ * @param mod (optional) true if the document has to be saved */
+ void setModified(bool mod = true);
+ void checkProjectClips();
+
+private slots:
+ void slotAutoSave();
signals:
- void addProjectClip(DocClipBase *);
- void signalDeleteProjectClip(int);
- void updateClipDisplay(int);
- void deletTimelineClip(int);
- void thumbsProgress(KUrl, int);
+ void resetProjectList();
+ void addProjectClip(DocClipBase *, bool getInfo = true);
+ void signalDeleteProjectClip(const QString &);
+ void updateClipDisplay(const QString&);
+ void deleteTimelineClip(const QString&);
+ void progressInfo(const QString &, int);
+
+ /** @brief Informs that the document status has been changed.
+ *
+ * If the document has been modified, it's called with true as an argument. */
+ void docModified(bool);
+ void selectLastAddedClip(const QString &);
+ void guidesUpdated();
};
#endif