1 /***************************************************************************
2 krender.h - description
4 begin : Fri Nov 22 2002
5 copyright : (C) 2002 by Jason Wood (jasonwood@blueyonder.co.uk)
6 copyright : (C) 2010 by Jean-Baptiste Mardelle (jb@kdenlive.org)
8 ***************************************************************************/
10 /***************************************************************************
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
17 ***************************************************************************/
21 * @brief Client side of the interface to a renderer.
23 * From Kdenlive's point of view, you treat the Render object as the renderer,
24 * and simply use it as if it was local. Calls are asynchronous - you send a
25 * call out, and then receive the return value through the relevant signal that
26 * get's emitted once the call completes.
33 #include "definitions.h"
34 #include "abstractmonitor.h"
36 #include <mlt/framework/mlt_types.h>
68 struct requestClipInfo {
74 bool operator==(const requestClipInfo &a)
76 return clipId == a.clipId;
80 class MltErrorEvent : public QEvent
83 MltErrorEvent(QString message) : QEvent(QEvent::User), m_message(message) {}
84 QString message() const {
93 class Render: public AbstractRender
97 enum FailStates { OK = 0,
100 /** @brief Build a MLT Renderer
101 * @param rendererName A unique identifier for this renderer
102 * @param winid The parent widget identifier (required for SDL display). Set to 0 for OpenGL rendering
103 * @param profile The MLT profile used for the renderer (default one will be used if empty). */
104 Render(Kdenlive::MONITORID rendererName, int winid, QString profile = QString(), QWidget *parent = 0);
106 /** @brief Destroy the MLT Renderer. */
109 /** @brief Seeks the renderer clip to the given time. */
110 void seek(GenTime time);
112 void seekToFrameDiff(int diff);
114 QPixmap getImageThumbnail(KUrl url, int width, int height);
116 /** @brief Sets the current MLT producer playlist.
117 * @param list The xml describing the playlist
118 * @param position (optional) time to seek to */
119 int setSceneList(QDomDocument list, int position = 0);
121 /** @brief Sets the current MLT producer playlist.
122 * @param list new playlist
123 * @param position (optional) time to seek to
124 * @return 0 when it has success, different from 0 otherwise
126 * Creates the producer from the text playlist. */
127 int setSceneList(QString playlist, int position = 0);
128 int setProducer(Mlt::Producer *producer, int position);
130 /** @brief Get the current MLT producer playlist.
131 * @return A string describing the playlist */
132 const QString sceneList();
133 bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
135 /** @brief Tells the renderer to play the scene at the specified speed,
136 * @param speed speed to play the scene to
138 * The speed is relative to normal playback, e.g. 1.0 is normal speed, 0.0
139 * is paused, -1.0 means play backwards. It does not specify start/stop */
140 void play(double speed);
141 void switchPlay(bool play);
144 /** @brief Stops playing.
145 * @param startTime time to seek to */
146 void stop(const GenTime &startTime);
149 QImage extractFrame(int frame_position, QString path = QString(), int width = -1, int height = -1);
151 /** @brief Plays the scene starting from a specific time.
152 * @param startTime time to start playing the scene from */
153 void play(const GenTime & startTime);
154 void playZone(const GenTime & startTime, const GenTime & stopTime);
155 void loopZone(const GenTime & startTime, const GenTime & stopTime);
157 void saveZone(KUrl url, QString desc, QPoint zone);
159 /** @brief Save a clip in timeline to an xml playlist. */
160 bool saveClip(int track, GenTime position, KUrl url, QString desc = QString());
162 /** @brief Return true if we are currently playing */
163 bool isPlaying() const;
165 /** @brief Returns the speed at which the renderer is currently playing.
167 * It returns 0.0 when the renderer is not playing anything. */
168 double playSpeed() const;
170 /** @brief Returns the current seek position of the renderer. */
171 GenTime seekPosition() const;
172 int seekFramePosition() const;
174 void emitFrameUpdated(Mlt::Frame&);
175 void emitFrameNumber();
176 void emitConsumerStopped();
178 /** @brief Returns the aspect ratio of the consumer. */
179 double consumerRatio() const;
181 /** @brief Saves current producer frame as an image. */
182 void exportCurrentFrame(KUrl url, bool notify);
184 /** @brief Change the Mlt PROFILE
185 * @param profileName The MLT profile name
186 * @param dropSceneList If true, the current playlist will be deleted
187 * @return true if the profile was changed
189 int resetProfile(const QString& profileName, bool dropSceneList = false);
190 /** @brief Returns true if the render uses profileName as current profile. */
191 bool hasProfile(const QString& profileName) const;
194 /** @brief Returns the width of a frame for this profile. */
195 int frameRenderWidth() const;
196 /** @brief Returns the display width of a frame for this profile. */
197 int renderWidth() const;
198 /** @brief Returns the height of a frame for this profile. */
199 int renderHeight() const;
201 /** @brief Returns display aspect ratio. */
203 /** @brief Returns sample aspect ratio. */
205 /** @brief If monitor is active, refresh it. */
206 void refreshIfActive();
207 /** @brief Start the MLT monitor consumer. */
208 void startConsumer();
211 * Playlist manipulation.
213 Mlt::Producer *checkSlowMotionProducer(Mlt::Producer *prod, QDomElement element);
214 int mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod, bool overwrite = false, bool push = false);
215 bool mltUpdateClip(Mlt::Tractor *tractor, ItemInfo info, QDomElement element, Mlt::Producer *prod);
216 bool mltCutClip(int track, GenTime position);
217 void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime &duration, const GenTime &timeOffset);
218 int mltGetSpaceLength(const GenTime &pos, int track, bool fromBlankStart);
220 /** @brief Returns the duration/length of @param track as reported by the track producer. */
221 int mltTrackDuration(int track);
223 bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
224 bool mltResizeClipStart(ItemInfo info, GenTime diff);
225 bool mltResizeClipCrop(ItemInfo info, GenTime newCropStart);
226 bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
227 bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
228 bool mltRemoveClip(int track, GenTime position);
230 /** @brief Deletes an effect from a clip in MLT's playlist. */
231 bool mltRemoveEffect(int track, GenTime position, int index, bool updateIndex, bool doRefresh = true);
232 bool mltRemoveTrackEffect(int track, int index, bool updateIndex);
234 /** @brief Adds an effect to a clip in MLT's playlist. */
235 bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
236 bool addFilterToService(Mlt::Service service, EffectsParameterList params, int duration);
237 bool mltAddEffect(Mlt::Service service, EffectsParameterList params, int duration, bool doRefresh);
238 bool mltAddTrackEffect(int track, EffectsParameterList params);
240 /** @brief Enable / disable clip effects.
241 * @param track The track where the clip is
242 * @param position The start position of the clip
243 * @param effectIndexes The list of effect indexes to enable / disable
244 * @param disable True if effects should be disabled, false otherwise */
245 bool mltEnableEffects(int track, GenTime position, QList <int> effectIndexes, bool disable);
246 /** @brief Enable / disable track effects.
247 * @param track The track where the effect is
248 * @param effectIndexes The list of effect indexes to enable / disable
249 * @param disable True if effects should be disabled, false otherwise */
250 bool mltEnableTrackEffects(int track, QList <int> effectIndexes, bool disable);
252 /** @brief Edits an effect parameters in MLT's playlist. */
253 bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
254 bool mltEditTrackEffect(int track, EffectsParameterList params);
256 /** @brief Updates the "kdenlive_ix" (index) value of an effect. */
257 void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
259 /** @brief Changes the order of effects in MLT's playlist.
261 * It switches effects from oldPos and newPos, updating the "kdenlive_ix"
263 void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
264 void mltMoveTrackEffect(int track, int oldPos, int newPos);
266 /** @brief Enables/disables audio/video in a track. */
267 void mltChangeTrackState(int track, bool mute, bool blind);
268 bool mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
269 bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
270 void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
271 void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool force = false);
272 void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
273 void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
274 void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
275 void mltDeleteTransparency(int pos, int track, int id);
276 void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
277 QList <TransitionInfo> mltInsertTrack(int ix, bool videoTrack);
278 void mltDeleteTrack(int ix);
279 bool mltUpdateClipProducer(Mlt::Tractor *tractor, int track, int pos, Mlt::Producer *prod);
280 void mltPlantTransition(Mlt::Field *field, Mlt::Transition &tr, int a_track, int b_track);
281 Mlt::Producer *invalidProducer(const QString &id);
283 /** @brief Changes the speed of a clip in MLT's playlist.
285 * It creates a new "framebuffer" producer, which must have its "resource"
286 * property set to "video.mpg?0.6", where "video.mpg" is the path to the
287 * clip and "0.6" is the speed in percentage. The newly created producer
288 * will have its "id" property set to "slowmotion:parentid:speed", where
289 * "parentid" is the id of the original clip in the ClipManager list and
290 * "speed" is the current speed. */
291 int mltChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, double speed, double oldspeed, int strobe, Mlt::Producer *prod);
293 const QList <Mlt::Producer *> producersList();
294 void updatePreviewSettings();
295 void setDropFrames(bool show);
296 QString updateSceneListFps(double current_fps, double new_fps, QString scene);
297 void showFrame(Mlt::Frame&);
299 void showAudio(Mlt::Frame&);
301 QList <int> checkTrackSequence(int);
302 void sendFrameUpdate();
304 /** @brief Returns a pointer to the main producer. */
305 Mlt::Producer *getProducer();
306 /** @brief Returns the number of clips to process (When requesting clip info). */
307 int processingItems();
308 /** @brief Force processing of clip with selected id. */
309 void forceProcessing(const QString &id);
310 /** @brief Are we currently processing clip with selected id. */
311 bool isProcessing(const QString &id);
313 /** @brief Requests the file properties for the specified URL (will be put in a queue list)
314 @param xml The xml parameters for the clip
315 @param clipId The clip Id string
316 @param imageHeight The height (in pixels) of the returned thumbnail (height of a treewidgetitem in projectlist)
317 @param replaceProducer If true, the MLT producer will be recreated */
318 void getFileProperties(const QDomElement &xml, const QString &clipId, int imageHeight, bool replaceProducer = true);
320 /** @brief Lock the MLT service */
321 Mlt::Tractor *lockService();
322 /** @brief Unlock the MLT service */
323 void unlockService(Mlt::Tractor *tractor);
324 const QString activeClipId();
325 /** @brief Fill a combobox with the found blackmagic devices */
326 static bool getBlackMagicDeviceList(KComboBox *devicelist);
327 static bool getBlackMagicOutputDeviceList(KComboBox *devicelist);
328 /** @brief Frame rendering is handeled by Kdenlive, don't show video through SDL display */
329 void disablePreview(bool disable);
330 int requestedSeekPosition;
334 /** @brief The name of this renderer.
336 * Useful to identify the renderers by what they do - e.g. background
337 * rendering, workspace monitor, etc. */
338 Kdenlive::MONITORID m_name;
339 Mlt::Consumer * m_mltConsumer;
340 Mlt::Producer * m_mltProducer;
341 Mlt::Profile *m_mltProfile;
342 Mlt::Event *m_showFrameEvent;
343 Mlt::Event *m_pauseEvent;
345 bool m_externalConsumer;
347 /** @brief True if we are playing a zone.
349 * It's determined by the "in" and "out" properties being temporarily
356 /** @brief True when the monitor is in split view. */
359 Mlt::Producer *m_blackClip;
360 QString m_activeProfile;
363 QTimer m_refreshTimer;
367 /** @brief A human-readable description of this renderer. */
371 QFuture <void> m_infoThread;
372 QList <requestClipInfo> m_requestList;
376 void mltCheckLength(Mlt::Tractor *tractor);
377 void mltPasteEffects(Mlt::Producer *source, Mlt::Producer *dest);
378 QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
379 QMap<QString, Mlt::Producer *> m_slowmotionProducers;
380 /** @brief The id of the clip that is currently being loaded for info query */
381 QString m_processingClipId;
383 /** @brief Build the MLT Consumer object with initial settings.
384 * @param profileName The MLT profile to use for the consumer */
385 void buildConsumer(const QString& profileName);
386 void resetZoneMode();
387 void fillSlowMotionProducers();
388 /** @brief Get the track number of the lowest audible (non muted) audio track
389 * @param return The track number */
390 int getLowestNonMutedAudioTrack(Mlt::Tractor tractor);
392 /** @brief Make sure our audio mixing transitions are applied to the lowest track */
393 void fixAudioMixing(Mlt::Tractor tractor);
394 /** @brief Make sure we inform MLT if we need a lot of threads for avformat producer */
395 void checkMaxThreads();
399 /** @brief Refreshes the monitor display. */
401 void slotOsdTimeout();
402 /** @brief Process the clip info requests (in a separate thread). */
403 void processFileProperties();
404 /** @brief A clip with multiple video streams was found, ask what to do. */
405 void slotMultiStreamProducerFound(const QString path, QList<int> audio_list, QList<int> video_list, stringMap data);
407 void slotCheckSeeking();
411 /** @brief The renderer received a reply to a getFileProperties request. */
412 void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const stringMap &, const stringMap &, bool replaceProducer);
414 /** @brief The renderer received a reply to a getImage request. */
415 void replyGetImage(const QString &, const QString &, int, int);
416 void replyGetImage(const QString &, const QImage &);
418 /** @brief The renderer stopped, either playing or rendering. */
421 /** @brief The renderer started playing. */
422 void playing(double);
424 /** @brief The renderer started rendering. */
425 void rendering(const GenTime &);
427 /** @brief An error occurred within this renderer. */
428 void error(const QString &, const QString &);
429 void durationChanged(int);
430 void rendererPosition(int);
431 void rendererStopped(int);
432 /** @brief The clip is not valid, should be removed from project. */
433 void removeInvalidClip(const QString &, bool replaceProducer);
434 /** @brief The proxy is not valid, should be deleted.
435 * @param id The original clip's id
436 * @param durationError Should be set to true if the proxy failed because it has not same length as original clip
438 void removeInvalidProxy(const QString &id, bool durationError);
439 void refreshDocumentProducers(bool displayRatioChanged, bool fpsChanged);
440 /** @brief A proxy clip is missing, ask for creation. */
441 void requestProxy(QString);
442 /** @brief A multiple stream clip was found. */
443 void multiStreamFound(const QString &,QList<int>,QList<int>,stringMap data);
446 /** @brief A frame's image has to be shown.
448 * Used in Mac OS X. */
449 void showImageSignal(QImage);
450 void showAudioSignal(const QByteArray &);
451 void addClip(const KUrl &, stringMap);
456 /** @brief Starts the consumer. */
459 /** @brief Stops the consumer. */
463 /** @brief Checks if the file is readable by MLT. */
464 bool isValid(KUrl url);
466 void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
467 void mltSavePlaylist();
468 void slotSplitView(bool doit);
469 void slotSwitchFullscreen();
470 void slotSetVolume(int volume);
471 void seekToFrame(int pos);
472 /** @brief Starts a timer to query for a refresh. */