#ifndef KDENLIVEDOC_H
#define KDENLIVEDOC_H
-#include <qdom.h>
-#include <QString>
+#include <QtXml/qdom.h>
#include <QMap>
#include <QList>
#include <QDir>
#include <QObject>
-#include <QUndoGroup>
-#include <QUndoStack>
-#include <QTimer>
#include <KUrl>
#include <kautosavefile.h>
class MainWindow;
class TrackInfo;
+class KTextEdit;
+class KProgressDialog;
+class QGLWidget;
+class QUndoGroup;
+class QTimer;
+class QUndoStack;
+
class KdenliveDoc: public QObject
{
-Q_OBJECT public:
+ Q_OBJECT
+public:
- KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, const QString &profileName, const QPoint tracks, Render *render, MainWindow *parent = 0);
+ KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, const QString &profileName, const QMap <QString, QString>& properties, const QMap <QString, QString>& metadata, const QPoint &tracks, Render *render, KTextEdit *notes, bool *openBackup, QGLWidget *glContext, MainWindow *parent = 0, KProgressDialog *progressDialog = 0);
~KdenliveDoc();
QDomNodeList producersList();
double fps() const;
QDomDocument m_guidesXml;
QDomElement guidesXml() const;
ClipManager *clipManager();
- void addClip(QDomElement elem, QString clipId, bool createClipItem = true);
- void 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());
+
+ /** @brief Adds a clip to the project tree.
+ * @return false if the user aborted the operation, true otherwise */
+ bool addClip(QDomElement elem, const 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, const QString &clipId);
+ void slotAddClipList(const KUrl::List &urls, const stringMap &data = stringMap());
void deleteClip(const QString &clipId);
- int getFramePos(QString duration);
+ int getFramePos(const QString &duration);
DocClipBase *getBaseClip(const QString &clipId);
void updateClip(const QString &id);
- void deleteProjectClip(QList <QString> ids);
- /** Inform application of the audio thumbnails generation progress */
+
+ /** @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);
- void setProfilePath(QString path);
+ void setUrl(const KUrl &url);
+
+ /** @brief Updates the project profile.
+ * @return true if frame rate was changed */
+ bool setProfilePath(QString path);
const QString getFreeClipId();
- /** does the document need saving */
+
+ /** @brief Defines whether the document needs to be saved. */
bool isModified() const;
- /** Returns project folder, used to store project files (titles, effects,...) */
+
+ /** @brief Returns the project folder, used to store project files. */
KUrl projectFolder() const;
- /** Used to inform main app of the current document loading progress */
- void loadingProgressed();
- void syncGuides(QList <Guide *> guides);
- void setZoom(int factor);
- int zoom() const;
- double dar();
+ void syncGuides(const 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);
+ /** @brief Returns the project file xml. */
+ QDomDocument xmlSceneList(const QString &scene, const QStringList &expandedFolders);
+ /** @brief Saves the project file xml to a file. */
+ bool saveSceneList(const QString &path, const QString &scene, const QStringList &expandedFolders, bool autosave = false);
int tracksCount() const;
TrackInfo trackInfoAt(int ix) const;
- void insertTrack(int ix, TrackInfo type);
+ void insertTrack(int ix, const TrackInfo &type);
void deleteTrack(int ix);
- void setTrackType(int ix, TrackInfo type);
+ void setTrackType(int ix, const TrackInfo &type);
const QList <TrackInfo> tracksList() const;
+
+ /** @brief Gets the number of audio and video tracks and returns them as a QPoint with x = video, y = audio. */
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;
+ bool isTrackLocked(int ix) const;
+
+ /** @brief Sets the duration of track @param ix to @param duration.
+ * This does not! influence the actual track but only the value in its TrackInfo. */
+ void setTrackDuration(int ix, int duration);
+
+ /** @brief Returns the duration of track @param ix.
+ *
+ * The returned duration might differ from the actual track duration!
+ * It is the one stored in the track's TrackInfo. */
+ int trackDuration(int ix);
+ void cacheImage(const QString &fileId, const QImage &img) const;
void setProjectFolder(KUrl url);
- QString getLadspaFile() const;
void setZone(int start, int end);
QPoint zone() const;
- void setSceneList();
- void updatePreviewSettings();
- bool isTrackLocked(int ix) const;
-
+ int setSceneList();
+ 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, const QDomElement &effect);
+ void setTrackEffect(int trackIndex, int effectIndex, QDomElement effect);
+ const EffectsList getTrackEffects(int ix);
+ /** @brief Enable / disable an effect in Kdenlive's xml list. */
+ void enableTrackEffects(int trackIndex, const QList<int> &effectIndexes, bool disable);
+ QDomElement getTrackEffect(int trackIndex, int effectIndex) const;
+ /** @brief Check if a track already contains a specific effect. */
+ int hasTrackEffect(int trackIndex, const QString &tag, const QString &id) const;
+ /** @brief Get a list of folder id's that were opened on last save. */
+ QStringList getExpandedFolders();
+ /** @brief Read the display ratio from an xml project file. */
+ static double getDisplayRatio(const QString &path);
+ /** @brief Backup the project file */
+ void backupLastSavedVersion(const QString &path);
+ /** @brief Returns the document metadata (author, copyright, ...) */
+ const QMap <QString, QString> metadata() const;
+ /** @brief Set the document metadata (author, copyright, ...) */
+ void setMetadata(const QMap <QString, QString>& meta);
+
private:
KUrl m_url;
QDomDocument m_document;
double m_fps;
- int m_zoom;
- /** Cursor position at document opening */
- int m_startPos;
int m_width;
int m_height;
Timecode m_timecode;
Render *m_render;
+ KTextEdit *m_notesWidget;
QUndoStack *m_commandStack;
ClipManager *m_clipManager;
MltVideoProfile m_profile;
QTimer *m_autoSaveTimer;
QString m_searchFolder;
- /** tells whether current doc has been changed since last save event */
+
+ /** @brief Tells whether the current document has been changed after being saved. */
bool m_modified;
- /** Project folder, used to store project files (titles, effects,...) */
+
+ /** @brief The project folder, used to store project files (titles, effects...). */
KUrl m_projectFolder;
- double m_documentLoadingStep;
- double m_documentLoadingProgress;
- bool m_abortLoading;
- int m_zoneStart;
- int m_zoneEnd;
+ QMap <QString, QString> m_documentProperties;
+ QMap <QString, QString> m_documentMetadata;
QList <TrackInfo> m_tracksList;
-
- bool convertDocument(double version);
- QDomDocument createEmptyDocument(const int videotracks, const int audiotracks);
- QString colorToString(const QColor& c);
-
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();
+ void moveProjectData(const KUrl &url);
+ bool checkDocumentClips(QDomNodeList infoproducers);
+
+ /** @brief Creates a new project. */
+ QDomDocument createEmptyDocument(int videotracks, int audiotracks);
+ QDomDocument createEmptyDocument(const QList<TrackInfo> &tracks);
+ /** @brief Saves effects embedded in project file.
+ * @return True if effects were imported. */
+ bool saveCustomEffects(const QDomNodeList &customeffects);
+
+ /** @brief Updates the project folder location entry in the kdenlive file dialogs to point to the current project folder. */
+ void updateProjectFolderPlacesEntry();
+ /** @brief Only keep some backup files, delete some */
+ void cleanupBackupFiles();
public slots:
- void slotCreateTextClip(QString group, const QString &groupId);
- /** Set to true if document needs saving, false otherwise */
+ void slotCreateXmlClip(const QString &name, const QDomElement &xml, const QString &group, const QString &groupId);
+ void slotCreateColorClip(const QString &name, const QString &color, const QString &duration, const QString &group, const QString &groupId);
+ void slotCreateSlideshowClipFile(const QMap<QString, QString> &properties, const QString &group, const QString &groupId);
+ void slotCreateTextClip(QString group, const QString &groupId, const QString &templatePath = QString());
+ void slotCreateTextTemplateClip(const 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();
+ void checkProjectClips(bool displayRatioChanged = false, bool fpsChanged = false);
+ void slotAddClipFile(const KUrl &url, const stringMap &data);
private slots:
void slotAutoSave();
void addProjectClip(DocClipBase *, bool getInfo = true);
void signalDeleteProjectClip(const QString &);
void updateClipDisplay(const QString&);
- void deleteTimelineClip(const QString&);
void progressInfo(const QString &, int);
- /** emitted when the document state has been modified (= needs saving or not) */
+
+ /** @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();
+ /** @brief When creating a backup file, also save a thumbnail of current timeline */
+ void saveTimelinePreview(const QString &path);
};
#endif
projects / kdenlive / blobdiff