]> git.sesse.net Git - kdenlive/blob - src/kdenlivedoc.h
[PATCH by Ray Lehtiniemi] Do not return references to temporaries.
[kdenlive] / 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, Render *render, 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     Timecode timecode() const;
60     QDomDocument toXml();
61     //void setRenderer(Render *render);
62     QUndoStack *commandStack();
63     QString producerName(const QString &id);
64     void setProducerDuration(const QString &id, int duration);
65     int getProducerDuration(const QString &id);
66     Render *renderer();
67     QDomElement m_guidesXml;
68     QDomElement guidesXml() const;
69     ClipManager *clipManager();
70     void addClip(QDomElement elem, QString clipId, bool createClipItem = true);
71     void addClipInfo(QDomElement elem, QDomElement orig, QString clipId);
72     void slotAddClipFile(const KUrl url, const QString group, const QString &groupId = QString());
73     void slotAddClipList(const KUrl::List urls, const QString group, const QString &groupId = QString());
74     void deleteClip(const QString &clipId);
75     int getFramePos(QString duration);
76     DocClipBase *getBaseClip(const QString &clipId);
77     void updateClip(const QString &id);
78     void deleteProjectClip(QList <QString> ids);
79     /** Inform application of the audio thumbnails generation progress */
80     void setThumbsProgress(const QString &message, int progress);
81     const QString &profilePath() const;
82     MltVideoProfile mltProfile() const;
83     const QString description() const;
84     void setUrl(KUrl url);
85     void setProfilePath(QString path);
86     const QString getFreeClipId();
87     /** does the document need saving */
88     bool isModified() const;
89     /** Returns project folder, used to store project files (titles, effects,...) */
90     KUrl projectFolder() const;
91     /** Used to inform main app of the current document loading progress */
92     void loadingProgressed();
93     void syncGuides(QList <Guide *> guides);
94     void setZoom(int factor);
95     int zoom() const;
96     const double dar();
97     double projectDuration() const;
98     bool saveSceneList(const QString &path, const QString &scene);
99     int tracksCount() const;
100     TrackInfo trackInfoAt(int ix) const;
101     void insertTrack(int ix, TrackInfo type);
102     void deleteTrack(int ix);
103     void setTrackType(int ix, TrackInfo type);
104     const QList <TrackInfo> tracksList() const;
105     QPoint getTracksCount() const;
106     void switchTrackVideo(int ix, bool hide);
107     void switchTrackAudio(int ix, bool hide);
108     void switchTrackLock(int ix, bool lock);
109     void cachePixmap(const QString &fileId, const QPixmap &pix) const;
110     void setProjectFolder(KUrl url);
111     QString getLadspaFile() const;
112     void setZone(int start, int end);
113     QPoint zone() const;
114     void setSceneList();
115     void updatePreviewSettings();
116     bool isTrackLocked(int ix) const;
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     QTimer *m_autoSaveTimer;
135     QString m_searchFolder;
136     /** tells whether current doc has been changed since last save event */
137     bool m_modified;
138     /** Project folder, used to store project files (titles, effects,...) */
139     KUrl m_projectFolder;
140     double m_documentLoadingStep;
141     double m_documentLoadingProgress;
142     bool m_abortLoading;
143     int m_zoneStart;
144     int m_zoneEnd;
145
146     QList <TrackInfo> m_tracksList;
147
148     bool convertDocument(double version);
149     QDomDocument createEmptyDocument(const int videotracks, const int audiotracks);
150     QString colorToString(const QColor& c);
151     void checkProjectClips();
152     void setNewClipResource(const QString &id, const QString &path);
153     QString searchFileRecursively(const QDir &dir, const QString &matchSize, const QString &matchHash) const;
154     void moveProjectData(KUrl url);
155
156 public slots:
157     void slotCreateTextClip(QString group, const QString &groupId);
158     /** Set to true if document needs saving, false otherwise */
159     void setModified(bool mod = true);
160
161 private slots:
162     void slotAutoSave();
163
164 signals:
165     void resetProjectList();
166     void addProjectClip(DocClipBase *, bool getInfo = true);
167     void signalDeleteProjectClip(const QString &);
168     void updateClipDisplay(const QString&);
169     void deleteTimelineClip(const QString&);
170     void progressInfo(const QString &, int);
171     /** emitted when the document state has been modified (= needs saving or not) */
172     void docModified(bool);
173     void selectLastAddedClip(const QString &);
174     void guidesUpdated();
175 };
176
177 #endif