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_notesDock;
146 KTextEdit *m_notesWidget;
148 QDockWidget *m_effectStackDock;
149 EffectStackView *m_effectStack;
151 QDockWidget *m_transitionConfigDock;
152 TransitionSettings *m_transitionConfig;
154 QDockWidget *m_clipMonitorDock;
155 Monitor *m_clipMonitor;
157 QDockWidget *m_projectMonitorDock;
158 Monitor *m_projectMonitor;
160 QDockWidget *m_recMonitorDock;
161 RecMonitor *m_recMonitor;
163 QDockWidget *m_vectorscopeDock;
164 Vectorscope *m_vectorscope;
166 QDockWidget *m_waveformDock;
167 Waveform *m_waveform;
169 QDockWidget *m_RGBParadeDock;
170 RGBParade *m_RGBParade;
172 QDockWidget *m_histogramDock;
173 Histogram *m_histogram;
175 QDockWidget *m_audiosignalDock;
176 AudioSignal *m_audiosignal;
178 QDockWidget *m_undoViewDock;
179 QUndoView *m_undoView;
180 QUndoGroup *m_commandStack;
182 KComboBox *m_timecodeFormat;
184 /** This list holds all the scopes used in Kdenlive, allowing to manage some global settings */
185 QList <QDockWidget *> m_scopesList;
187 QMenu *m_videoEffectsMenu;
188 QMenu *m_audioEffectsMenu;
189 QMenu *m_customEffectsMenu;
190 QMenu *m_transitionsMenu;
191 QMenu *m_timelineContextMenu;
192 QMenu *m_timelineContextClipMenu;
193 QMenu *m_timelineContextTransitionMenu;
196 /** @brief Shortcut to remove the focus from any element.
198 * It allows to get out of e.g. text input fields and to press another
200 QShortcut* m_shortcutRemoveFocus;
202 RenderWidget *m_renderWidget;
204 #ifndef NO_JOGSHUTTLE
205 JogShuttle *m_jogProcess;
206 #endif /* NO_JOGSHUTTLE */
208 KRecentFilesAction *m_fileOpenRecent;
209 KAction *m_fileRevert;
210 KAction *m_projectSearch;
211 KAction *m_projectSearchNext;
213 KAction **m_videoEffects;
214 KAction **m_audioEffects;
215 KAction **m_customEffects;
216 KAction **m_transitions;
217 KAction *m_buttonAudioThumbs;
218 KAction *m_buttonVideoThumbs;
219 KAction *m_buttonShowMarkers;
220 KAction *m_buttonFitZoom;
221 KAction *m_buttonAutomaticSplitAudio;
222 KAction *m_normalEditTool;
223 KAction *m_overwriteEditTool;
224 KAction *m_insertEditTool;
225 KAction *m_buttonSelectTool;
226 KAction *m_buttonRazorTool;
227 KAction *m_buttonSpacerTool;
228 KAction *m_buttonSnap;
229 KAction *m_saveAction;
230 KAction *m_closeAction;
231 QSlider *m_zoomSlider;
237 StatusBarMessageLabel *m_messageLabel;
238 QActionGroup *m_clipTypeGroup;
239 KActionCollection *m_effectsActionCollection;
241 bool m_findActivated;
242 QString m_findString;
247 #ifndef NO_JOGSHUTTLE
248 void activateShuttleDevice();
249 void slotShuttleAction(int code);
250 #endif /* NO_JOGSHUTTLE */
251 void connectDocumentInfo(KdenliveDoc *doc);
253 void doOpenFile(const KUrl &url, KAutoSaveFile *stale);
254 void recoverFiles(QList<KAutoSaveFile *> staleFiles);
256 /** @brief Loads static and dynamic plugins.
258 * It scans static plugins as well as the filesystem: it doesn't load more
259 * than one plugin per file name, to avoid duplication due to conflicting
262 void populateMenus(QObject *plugin);
263 void addToMenu(QObject *plugin, const QStringList &texts,
264 QMenu *menu, const char *member,
265 QActionGroup *actionGroup);
268 /** @brief Instantiates a "Get Hot New Stuff" dialog.
269 * @param configFile configuration file for KNewStuff
270 * @return number of installed items */
271 int getNewStuff(const QString &configFile = QString());
272 QStringList m_pluginFileNames;
273 QByteArray m_timelineState;
274 void loadTranscoders();
275 QPixmap createSchemePreviewIcon(const KSharedConfigPtr &config);
277 /** @brief Checks that the Kdenlive mime type is correctly installed.
278 * @return The mimetype */
279 QString getMimeType();
281 /** @brief Populates the "load layout" menu. */
285 /** @brief Prepares opening @param url.
287 * Checks if already open and whether backup exists */
288 void openFile(const KUrl &url);
289 void slotGotProgressInfo(const QString &message, int progress);
290 void slotReloadEffects();
291 Q_SCRIPTABLE void setRenderingProgress(const QString &url, int progress);
292 Q_SCRIPTABLE void setRenderingFinished(const QString &url, int status, const QString &error);
296 void newFile(bool showProjectSettings = true, bool force = false);
298 void activateDocument();
299 void connectDocument(TrackView*, KdenliveDoc*);
301 /** @brief Shows file open dialog. */
305 /** @brief Checks whether a URL is available to save to.
306 * @return Whether the file was saved. */
309 /** @brief Shows a save file dialog for saving the project.
310 * @return Whether the file was saved. */
313 /** @brief Set properties to match outputFileName and save the document.
314 * @param outputFileName The URL to save to / The document's URL.
315 * @return Whether we had success. */
316 bool saveFileAs(const QString &outputFileName);
318 /** @brief Shows the shortcut dialog. */
320 void slotPreferences(int page = -1, int option = -1);
322 /** @brief Reflects setting changes to the GUI. */
323 void updateConfiguration();
324 void slotConnectMonitors();
325 void slotRaiseMonitor(bool clipMonitor);
326 void slotUpdateClip(const QString &id);
327 void slotUpdateMousePosition(int pos);
328 void slotAddEffect(const QDomElement effect);
329 void slotEditProfiles();
330 void slotDetectAudioDriver();
331 void slotEditProjectSettings();
332 /** @brief Change current document MLT profile. */
333 void slotUpdateProjectProfile(const QString &profile);
334 void slotDisplayActionMessage(QAction *a);
336 /** @brief Turns automatic splitting of audio and video on/off. */
337 void slotSwitchSplitAudio();
338 void slotSwitchVideoThumbs();
339 void slotSwitchAudioThumbs();
340 void slotSwitchMarkersComments();
341 void slotSwitchSnap();
342 void slotRenderProject();
343 void slotFullScreen();
344 void slotUpdateDocumentState(bool modified);
346 /** @brief Sets the timeline zoom slider to @param value.
348 * Also disables zoomIn and zoomOut actions if they cannot be used at the moment. */
349 void slotSetZoom(int value);
350 /** @brief Decreases the timeline zoom level by 1. */
352 /** @brief Increases the timeline zoom level by 1. */
354 /** @brief Makes the timeline zoom level fit the timeline content. */
356 /** @brief Updates the zoom slider tooltip to fit @param zoomlevel. */
357 void slotUpdateZoomSliderToolTip(int zoomlevel);
359 /** @brief Displays the zoom slider tooltip.
360 * @param zoomlevel (optional) The zoom level to show in the tooltip.
362 * Adopted from Dolphin (src/statusbar/dolphinstatusbar.cpp) */
363 void slotShowZoomSliderToolTip(int zoomlevel = -1);
364 /** @brief Close currently opened document. Returns false if something went wrong (cannot save modifications, ...). */
365 bool closeCurrentDocument(bool saveChanges = true);
366 /** @brief Deletes item in timeline, project tree or effect stack depending on focus. */
367 void slotDeleteItem();
368 void slotAddClipMarker();
369 void slotDeleteClipMarker();
370 void slotDeleteAllClipMarkers();
371 void slotEditClipMarker();
373 /** @brief Adds marker or auide at the current position without showing the marker dialog.
375 * Adds a marker if clip monitor is active, otherwise a guide.
376 * The comment is set to the current position (therefore not dialog).
377 * This can be useful to mark something during playback. */
378 void slotAddMarkerGuideQuickly();
379 void slotCutTimelineClip();
380 void slotInsertClipOverwrite();
381 void slotSelectTimelineClip();
382 void slotSelectTimelineTransition();
383 void slotDeselectTimelineClip();
384 void slotDeselectTimelineTransition();
385 void slotSelectAddTimelineClip();
386 void slotSelectAddTimelineTransition();
387 void slotAddVideoEffect(QAction *result);
388 void slotAddAudioEffect(QAction *result);
389 void slotAddCustomEffect(QAction *result);
390 void slotAddTransition(QAction *result);
391 void slotAddProjectClip(KUrl url);
392 #ifndef NO_JOGSHUTTLE
393 void slotShuttleButton(int code);
394 #endif /* NO_JOGSHUTTLE */
395 void slotShowClipProperties(DocClipBase *clip);
396 void slotShowClipProperties(QList <DocClipBase *>cliplist, QMap<QString, QString> commonproperties);
397 void slotActivateEffectStackView();
398 void slotActivateTransitionView(Transition *);
399 void slotChangeTool(QAction * action);
400 void slotChangeEdit(QAction * action);
401 void slotSetTool(PROJECTTOOL tool);
402 void slotSnapForward();
403 void slotSnapRewind();
404 void slotClipStart();
406 void slotZoneStart();
411 void slotSelectClipInTimeline();
412 void slotClipInTimeline(const QString &clipId);
414 void slotInsertSpace();
415 void slotRemoveSpace();
417 void slotEditGuide();
418 void slotDeleteGuide();
419 void slotDeleteAllGuides();
420 void slotGuidesUpdated();
424 void slotPasteEffects();
426 void slotAdjustClipMonitor();
427 void slotAdjustProjectMonitor();
428 void slotSaveZone(Render *render, QPoint zone);
430 void slotSetInPoint();
431 void slotSetOutPoint();
432 void slotResizeItemStart();
433 void slotResizeItemEnd();
434 void configureNotifications();
435 void slotInsertTrack(int ix = 0);
436 void slotDeleteTrack(int ix = 0);
437 /** @brief Shows the configure tracks dialog and updates transitions afterwards. */
438 void slotConfigTrack(int ix = -1);
439 void slotGetNewLumaStuff();
440 void slotGetNewTitleStuff();
441 void slotGetNewRenderStuff();
442 void slotGetNewMltProfileStuff();
443 void slotAutoTransition();
444 void slotRunWizard();
445 /** @brief Lets the sampleplugin create a generator. */
447 void slotZoneMoved(int start, int end);
448 void slotUpdatePreviewSettings();
449 void slotDvdWizard(const QString &url = QString(), const QString &profile = "dv_pal");
450 void slotGroupClips();
451 void slotUnGroupClips();
452 void slotEditItemDuration();
453 void slotClipInProjectTree();
454 //void slotClipToProjectTree();
455 void slotSplitAudio();
456 void slotUpdateClipType(QAction *action);
457 void slotShowTimeline(bool show);
458 void slotMaximizeCurrent(bool show);
459 void slotTranscode(KUrl::List urls = KUrl::List());
460 void slotTranscodeClip();
461 void slotSetDocumentRenderProfile(QMap <QString, QString> props);
462 void slotPrepareRendering(bool scriptExport, bool zoneOnly, const QString &chapterFile);
464 /** @brief Switches between displaying frames or timecode.
465 * @param ix 0 = display timecode, 1 = display frames. */
466 void slotUpdateTimecodeFormat(int ix);
468 /** @brief Removes the focus of anything. */
469 void slotRemoveFocus();
470 void slotCleanProject();
471 void slotUpdateClipMarkers(DocClipBase *clip);
474 void slotUpdateTrackInfo();
476 /** @brief Changes the color scheme. */
477 void slotChangePalette(QAction *action, const QString &themename = QString());
478 void slotSwitchMonitors();
479 void slotCheckRenderStatus();
480 void slotInsertZoneToTree();
481 void slotInsertZoneToTimeline();
483 /** @brief Deletes items from timeline and document.
484 * @param ids The ids of the clips to delete.
485 * @param folderids The names and ids of the folders to delete. */
486 void slotDeleteProjectClips(QStringList ids, QMap<QString, QString> folderids);
487 void slotShowTitleBars(bool show);
488 void slotSwitchTitles();
489 /** @brief Update the capture folder if user asked a change. */
490 void slotUpdateCaptureFolder();
492 /** @brief Saves the widgets layout */
493 void slotSaveLayout(QAction*);
494 void slotLoadLayout(QAction*);
496 /** @brief The monitor informs that it needs (or not) to have frames sent by the renderer. */
497 void slotMonitorRequestRenderFrame(bool request);
498 /** @brief Check if someone needs the render frame sent. */
499 void slotUpdateScopeFrameRequest();
500 /** @brief Check if someone needs the render frame sent. */
501 void slotDoUpdateScopeFrameRequest();
502 /** @brief When switching between monitors, update the visible scopes. */
503 void slotUpdateColorScopes();
506 Q_SCRIPTABLE void abortRenderJob(const QString &url);