X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fkdenlivedoc.h;h=8acf632842b74486dfb6bbaaae218274b98c9a72;hb=a3eee7be24126f5a3458d488f44cd61c66135e17;hp=6f6bfd3c653942bd10c6d1feb9ed4d456b9fae27;hpb=7d1f818376b25f793ad6e8960b73a24a39605945;p=kdenlive diff --git a/src/kdenlivedoc.h b/src/kdenlivedoc.h index 6f6bfd3c..8acf6328 100644 --- a/src/kdenlivedoc.h +++ b/src/kdenlivedoc.h @@ -21,15 +21,11 @@ #ifndef KDENLIVEDOC_H #define KDENLIVEDOC_H -#include -#include +#include #include #include #include #include -#include -#include -#include #include #include @@ -45,11 +41,19 @@ class DocClipBase; 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, QString profileName, const QPoint tracks, Render *render, MainWindow *parent = 0); + KdenliveDoc(const KUrl &url, const KUrl &projectFolder, QUndoGroup *undoGroup, const QString &profileName, const QMap & properties, const QMap & metadata, const QPoint &tracks, Render *render, KTextEdit *notes, bool *openBackup, QGLWidget *glContext, MainWindow *parent = 0, KProgressDialog *progressDialog = 0); ~KdenliveDoc(); QDomNodeList producersList(); double fps() const; @@ -66,57 +70,106 @@ Q_OBJECT public: 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 + * @param orig the potential + * @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 ids); - /** Inform application of the audio thumbnails generation progress */ + 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); - /** update project profile, returns true if fps was changed */ + 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 guides); + void syncGuides(const QList &guides); void setZoom(int horizontal, int vertical); QPoint zoom() const; - double dar(); + 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 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; int setSceneList(); - void updatePreviewSettings(); - 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 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 &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 metadata() const; + /** @brief Set the document metadata (author, copyright, ...) */ + void setMetadata(const QMap & meta); + private: KUrl m_url; QDomDocument m_document; @@ -125,36 +178,51 @@ private: 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; QMap m_documentProperties; + QMap m_documentMetadata; QList 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); + void moveProjectData(const KUrl &url); bool checkDocumentClips(QDomNodeList infoproducers); + + /** @brief Creates a new project. */ QDomDocument createEmptyDocument(int videotracks, int audiotracks); - QDomDocument createEmptyDocument(QList tracks); + QDomDocument createEmptyDocument(const QList &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 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 fade, const QString &luma_duration, const QString &luma_file, const int softness, QString group, const QString &groupId); + 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 &properties, const 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); - /** Set to true if document needs saving, false otherwise */ + 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(); @@ -164,12 +232,16 @@ signals: 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