1 /***************************************************************************
2 * Copyright (C) 2007 by Jean-Baptiste Mardelle (jb@kdenlive.org) *
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. *
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. *
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 ***************************************************************************/
24 #include <QDockWidget>
27 #include <QProgressBar>
32 #include <KXmlGuiWindow>
34 #include <KListWidget>
37 #include <KRecentFilesAction>
39 #include <kautosavefile.h>
41 #include "effectslist.h"
43 #include "definitions.h"
44 #include "statusbarmessagelabel.h"
45 #include "dvdwizard.h"
51 class EffectsListView;
52 class EffectStackView;
53 class TransitionSettings;
56 class CustomTrackView;
60 #endif /* NO_JOGSHUTTLE */
68 class KActionCollection;
71 class MainWindow : public KXmlGuiWindow
74 Q_CLASSINFO("D-Bus Interface", "org.kdenlive.MainWindow")
78 /** @brief Initialises the main window.
79 * @param MltPath (optional) path to MLT environment
80 * @param Url (optional) file to open
81 * @param clipsToLoad (optional) a comma separated list of clips to import in project
83 * If Url is present, it will be opened, otherwhise, if openlastproject is
84 * set, latest project will be opened. If no file is open after trying this,
85 * a default new file will be created. */
86 explicit MainWindow(const QString &MltPath = QString(),
87 const KUrl &Url = KUrl(), const QString & clipsToLoad = QString(), QWidget *parent = 0);
88 virtual ~MainWindow();
90 /** @brief Locates the MLT environment.
91 * @param mltPath (optional) path to MLT environment
93 * It tries to set the paths of the MLT profiles and renderer, using
94 * mltPath, MLT_PREFIX, searching for the binary `melt`, or asking to the
95 * user. It doesn't fill any list of profiles, while its name suggests so. */
96 void parseProfiles(const QString &mltPath = QString());
98 static EffectsList videoEffects;
99 static EffectsList audioEffects;
100 static EffectsList customEffects;
101 static EffectsList transitions;
104 /** @brief Closes the window.
105 * @return false if the user presses "Cancel" on a confirmation dialog or
106 * the operation requested (starting waiting jobs or saving file) fails,
108 virtual bool queryClose();
110 /** @brief Reports a message in the status bar when an error occurs. */
111 virtual void customEvent(QEvent *e);
113 /** @brief Enables live search in the timeline. */
114 virtual void keyPressEvent(QKeyEvent *ke);
116 /** @brief Stops the active monitor when the window gets hidden. */
117 virtual void hideEvent(QHideEvent *e);
119 /** @brief Filters key events to the live search. */
120 bool eventFilter(QObject *obj, QEvent *ev);
122 /** @brief Saves the file and the window properties when saving the session. */
123 virtual void saveProperties(KConfigGroup &config);
125 /** @brief Restores the window and the file when a session is loaded. */
126 virtual void readProperties(const KConfigGroup &config);
129 KTabWidget* m_timelineArea;
130 QProgressBar *m_statusProgressBar;
132 /** @brief Sets up all the actions and attaches them to the collection. */
134 KdenliveDoc *m_activeDocument;
135 TrackView *m_activeTimeline;
136 MonitorManager *m_monitorManager;
138 QDockWidget *m_projectListDock;
139 ProjectList *m_projectList;
141 QDockWidget *m_effectListDock;
142 EffectsListView *m_effectList;
143 //KListWidget *m_effectList;
145 QDockWidget *m_effectStackDock;
146 EffectStackView *m_effectStack;
148 QDockWidget *m_transitionConfigDock;
149 TransitionSettings *m_transitionConfig;
151 QDockWidget *m_clipMonitorDock;
152 Monitor *m_clipMonitor;
154 QDockWidget *m_projectMonitorDock;
155 Monitor *m_projectMonitor;
157 QDockWidget *m_recMonitorDock;
158 RecMonitor *m_recMonitor;
160 QDockWidget *m_vectorscopeDock;
161 Vectorscope *m_vectorscope;
163 QDockWidget *m_waveformDock;
164 Waveform *m_waveform;
166 QDockWidget *m_RGBParadeDock;
167 RGBParade *m_RGBParade;
169 QDockWidget *m_histogramDock;
170 Histogram *m_histogram;
172 QDockWidget *m_undoViewDock;
173 QUndoView *m_undoView;
174 QUndoGroup *m_commandStack;
176 KComboBox *m_timecodeFormat;
178 /** This list holds all the scopes used in Kdenlive, allowing to manage some global settings */
179 QList <QDockWidget *> m_scopesList;
181 QMenu *m_videoEffectsMenu;
182 QMenu *m_audioEffectsMenu;
183 QMenu *m_customEffectsMenu;
184 QMenu *m_transitionsMenu;
185 QMenu *m_timelineContextMenu;
186 QMenu *m_timelineContextClipMenu;
187 QMenu *m_timelineContextTransitionMenu;
190 /** @brief Shortcut to remove the focus from any element.
192 * It allows to get out of e.g. text input fields and to press another
194 QShortcut* m_shortcutRemoveFocus;
196 RenderWidget *m_renderWidget;
198 #ifndef NO_JOGSHUTTLE
199 JogShuttle *m_jogProcess;
200 #endif /* NO_JOGSHUTTLE */
202 KRecentFilesAction *m_fileOpenRecent;
203 KAction *m_fileRevert;
204 KAction *m_projectSearch;
205 KAction *m_projectSearchNext;
207 KAction **m_videoEffects;
208 KAction **m_audioEffects;
209 KAction **m_customEffects;
210 KAction **m_transitions;
211 KAction *m_buttonAudioThumbs;
212 KAction *m_buttonVideoThumbs;
213 KAction *m_buttonShowMarkers;
214 KAction *m_buttonFitZoom;
215 KAction *m_buttonAutomaticSplitAudio;
216 KAction *m_normalEditTool;
217 KAction *m_overwriteEditTool;
218 KAction *m_insertEditTool;
219 KAction *m_buttonSelectTool;
220 KAction *m_buttonRazorTool;
221 KAction *m_buttonSpacerTool;
222 KAction *m_buttonSnap;
223 KAction *m_saveAction;
224 KAction *m_closeAction;
225 QSlider *m_zoomSlider;
230 StatusBarMessageLabel *m_messageLabel;
231 QActionGroup *m_clipTypeGroup;
232 KActionCollection *m_effectsActionCollection;
234 bool m_findActivated;
235 QString m_findString;
240 #ifndef NO_JOGSHUTTLE
241 void activateShuttleDevice();
242 void slotShuttleAction(int code);
243 #endif /* NO_JOGSHUTTLE */
244 void connectDocumentInfo(KdenliveDoc *doc);
246 void doOpenFile(const KUrl &url, KAutoSaveFile *stale);
247 void recoverFiles(QList<KAutoSaveFile *> staleFiles);
249 /** @brief Loads static and dynamic plugins.
251 * It scans static plugins as well as the filesystem: it doesn't load more
252 * than one plugin per file name, to avoid duplication due to conflicting
255 void populateMenus(QObject *plugin);
256 void addToMenu(QObject *plugin, const QStringList &texts,
257 QMenu *menu, const char *member,
258 QActionGroup *actionGroup);
261 /** @brief Instantiates a "Get Hot New Stuff" dialog.
262 * @param configFile configuration file for KNewStuff
263 * @return number of installed items */
264 int getNewStuff(const QString &configFile = QString());
265 QStringList m_pluginFileNames;
266 QByteArray m_timelineState;
267 void loadTranscoders();
268 QPixmap createSchemePreviewIcon(const KSharedConfigPtr &config);
270 /** @brief Checks that the Kdenlive mime type is correctly installed.
271 * @return The mimetype */
272 QString getMimeType();
274 /** @brief Populates the "load layout" menu. */
278 /** @brief Prepares opening @param url.
280 * Checks if already open and whether backup exists */
281 void openFile(const KUrl &url);
282 void slotGotProgressInfo(const QString &message, int progress);
283 Q_SCRIPTABLE void setRenderingProgress(const QString &url, int progress);
284 Q_SCRIPTABLE void setRenderingFinished(const QString &url, int status, const QString &error);
288 void newFile(bool showProjectSettings = true, bool force = false);
290 void activateDocument();
291 void connectDocument(TrackView*, KdenliveDoc*);
293 /** @brief Shows file open dialog. */
297 /** @brief Checks whether a URL is available to save to.
298 * @return Whether the file was saved. */
301 /** @brief Shows a save file dialog for saving the project.
302 * @return Whether the file was saved. */
305 /** @brief Set properties to match outputFileName and save the document.
306 * @param outputFileName The URL to save to / The document's URL.
307 * @return Whether we had success. */
308 bool saveFileAs(const QString &outputFileName);
310 /** @brief Shows the shortcut dialog. */
312 void slotPreferences(int page = -1, int option = -1);
314 /** @brief Reflects setting changes to the GUI. */
315 void updateConfiguration();
316 void slotConnectMonitors();
317 void slotRaiseMonitor(bool clipMonitor);
318 void slotUpdateClip(const QString &id);
319 void slotUpdateMousePosition(int pos);
320 void slotAddEffect(const QDomElement effect);
321 void slotEditProfiles();
322 void slotDetectAudioDriver();
323 void slotEditProjectSettings();
324 void slotDisplayActionMessage(QAction *a);
326 /** @brief Turns automatic splitting of audio and video on/off. */
327 void slotSwitchSplitAudio();
328 void slotSwitchVideoThumbs();
329 void slotSwitchAudioThumbs();
330 void slotSwitchMarkersComments();
331 void slotSwitchSnap();
332 void slotRenderProject();
333 void slotFullScreen();
334 void slotUpdateDocumentState(bool modified);
336 /** @brief Sets the timeline zoom slider to @param value.
338 * Also disables zoomIn and zoomOut actions if they cannot be used at the moment. */
339 void slotSetZoom(int value);
340 /** @brief Decreases the timeline zoom level by 1. */
342 /** @brief Increases the timeline zoom level by 1. */
344 /** @brief Makes the timeline zoom level fit the timeline content. */
346 /** @brief Updates the zoom slider tooltip to fit @param zoomlevel. */
347 void slotUpdateZoomSliderToolTip(int zoomlevel);
349 /** @brief Displays the zoom slider tooltip.
350 * @param zoomlevel (optional) The zoom level to show in the tooltip.
352 * Adopted from Dolphin (src/statusbar/dolphinstatusbar.cpp) */
353 void slotShowZoomSliderToolTip(int zoomlevel = -1);
354 /** @brief Close currently opened document. Returns false if something went wrong (cannot save modifications, ...). */
355 bool closeCurrentDocument(bool saveChanges = true);
356 /** @brief Deletes item in timeline, project tree or effect stack depending on focus. */
357 void slotDeleteItem();
358 void slotAddClipMarker();
359 void slotDeleteClipMarker();
360 void slotDeleteAllClipMarkers();
361 void slotEditClipMarker();
362 void slotCutTimelineClip();
363 void slotInsertClipOverwrite();
364 void slotSelectTimelineClip();
365 void slotSelectTimelineTransition();
366 void slotDeselectTimelineClip();
367 void slotDeselectTimelineTransition();
368 void slotSelectAddTimelineClip();
369 void slotSelectAddTimelineTransition();
370 void slotAddVideoEffect(QAction *result);
371 void slotAddAudioEffect(QAction *result);
372 void slotAddCustomEffect(QAction *result);
373 void slotAddTransition(QAction *result);
374 void slotAddProjectClip(KUrl url);
375 #ifndef NO_JOGSHUTTLE
376 void slotShuttleButton(int code);
377 #endif /* NO_JOGSHUTTLE */
378 void slotShowClipProperties(DocClipBase *clip);
379 void slotShowClipProperties(QList <DocClipBase *>cliplist, QMap<QString, QString> commonproperties);
380 void slotActivateEffectStackView();
381 void slotActivateTransitionView(Transition *);
382 void slotChangeTool(QAction * action);
383 void slotChangeEdit(QAction * action);
384 void slotSetTool(PROJECTTOOL tool);
385 void slotSnapForward();
386 void slotSnapRewind();
387 void slotClipStart();
389 void slotZoneStart();
394 void slotSelectClipInTimeline();
395 void slotClipInTimeline(const QString &clipId);
397 void slotInsertSpace();
398 void slotRemoveSpace();
400 void slotEditGuide();
401 void slotDeleteGuide();
402 void slotDeleteAllGuides();
403 void slotGuidesUpdated();
407 void slotPasteEffects();
408 void slotReloadEffects();
410 void slotAdjustClipMonitor();
411 void slotAdjustProjectMonitor();
412 void slotSaveZone(Render *render, QPoint zone);
414 void slotSetInPoint();
415 void slotSetOutPoint();
416 void slotResizeItemStart();
417 void slotResizeItemEnd();
418 void configureNotifications();
419 void slotInsertTrack(int ix = 0);
420 void slotDeleteTrack(int ix = 0);
421 /** @brief Shows the configure tracks dialog and updates transitions afterwards. */
422 void slotConfigTrack(int ix = -1);
423 void slotGetNewLumaStuff();
424 void slotGetNewTitleStuff();
425 void slotGetNewRenderStuff();
426 void slotGetNewMltProfileStuff();
427 void slotAutoTransition();
428 void slotRunWizard();
429 /** @brief Lets the sampleplugin create a generator. */
431 void slotZoneMoved(int start, int end);
432 void slotUpdatePreviewSettings();
433 void slotDvdWizard(const QString &url = QString(), const QString &profile = "dv_pal");
434 void slotGroupClips();
435 void slotUnGroupClips();
436 void slotEditItemDuration();
437 void slotClipInProjectTree();
438 //void slotClipToProjectTree();
439 void slotSplitAudio();
440 void slotUpdateClipType(QAction *action);
441 void slotShowTimeline(bool show);
442 void slotMaximizeCurrent(bool show);
443 void slotTranscode(KUrl::List urls = KUrl::List());
444 void slotTranscodeClip();
445 void slotSetDocumentRenderProfile(QMap <QString, QString> props);
446 void slotPrepareRendering(bool scriptExport, bool zoneOnly, const QString &chapterFile);
448 /** @brief Switches between displaying frames or timecode.
449 * @param ix 0 = display timecode, 1 = display frames. */
450 void slotUpdateTimecodeFormat(int ix);
452 /** @brief Removes the focus of anything. */
453 void slotRemoveFocus();
454 void slotCleanProject();
455 void slotUpdateClipMarkers(DocClipBase *clip);
458 void slotUpdateTrackInfo();
460 /** @brief Changes the color scheme. */
461 void slotChangePalette(QAction *action, const QString &themename = QString());
462 void slotSwitchMonitors();
463 void slotCheckRenderStatus();
464 void slotInsertZoneToTree();
465 void slotInsertZoneToTimeline();
467 /** @brief Deletes items from timeline and document.
468 * @param ids The ids of the clips to delete.
469 * @param folderids The names and ids of the folders to delete. */
470 void slotDeleteProjectClips(QStringList ids, QMap<QString, QString> folderids);
471 void slotShowTitleBars(bool show);
472 void slotSwitchTitles();
474 /** @brief Saves the widgets layout */
475 void slotSaveLayout(QAction*);
476 void slotLoadLayout(QAction*);
478 /** @brief The monitor informs that it needs (or not) to have frames sent by the renderer. */
479 void slotMonitorRequestRenderFrame(bool request);
480 /** @brief Check if someone needs the render frame sent. */
481 void slotUpdateScopeFrameRequest();
482 /** @brief Check if someone needs the render frame sent. */
483 void slotDoUpdateScopeFrameRequest();
484 /** @brief When switching between monitors, update the visible scopes. */
485 void slotUpdateColorScopes();
488 Q_SCRIPTABLE void abortRenderJob(const QString &url);