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"
63 class MltErrorEvent : public QEvent
66 MltErrorEvent(QString message) : QEvent(QEvent::User), m_message(message) {}
67 QString message() const {
75 class Render: public QObject
79 enum FailStates { OK = 0,
82 /** @brief Build a MLT Renderer
83 * @param rendererName A unique identifier for this renderer
84 * @param winid The parent widget identifier (required for SDL display). Set to 0 for OpenGL rendering
85 * @param profile The MLT profile used for the renderer (default one will be used if empty). */
86 Render(const QString & rendererName, int winid, QString profile = QString(), QWidget *parent = 0);
88 /** @brief Destroy the MLT Renderer. */
91 /** @brief Seeks the renderer clip to the given time. */
92 void seek(GenTime time);
93 void seekToFrame(int pos);
94 void seekToFrameDiff(int diff);
97 QPixmap getImageThumbnail(KUrl url, int width, int height);
99 /** @brief Sets the current MLT producer playlist.
100 * @param list The xml describing the playlist
101 * @param position (optional) time to seek to */
102 int setSceneList(QDomDocument list, int position = 0);
104 /** @brief Sets the current MLT producer playlist.
105 * @param list new playlist
106 * @param position (optional) time to seek to
107 * @return 0 when it has success, different from 0 otherwise
109 * Creates the producer from the text playlist. */
110 int setSceneList(QString playlist, int position = 0);
111 int setProducer(Mlt::Producer *producer, int position);
113 /** @brief Get the current MLT producer playlist.
114 * @return A string describing the playlist */
115 const QString sceneList();
116 bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
118 /** @brief Tells the renderer to play the scene at the specified speed,
119 * @param speed speed to play the scene to
121 * The speed is relative to normal playback, e.g. 1.0 is normal speed, 0.0
122 * is paused, -1.0 means play backwards. It does not specify start/stop */
123 void play(double speed);
127 /** @brief Stops playing.
128 * @param startTime time to seek to */
129 void stop(const GenTime & startTime);
132 QImage extractFrame(int frame_position, int width = -1, int height = -1);
134 /** @brief Plays the scene starting from a specific time.
135 * @param startTime time to start playing the scene from */
136 void play(const GenTime & startTime);
137 void playZone(const GenTime & startTime, const GenTime & stopTime);
138 void loopZone(const GenTime & startTime, const GenTime & stopTime);
140 void saveZone(KUrl url, QString desc, QPoint zone);
142 /** @brief Returns the name of the renderer. */
143 const QString & rendererName() const;
145 /** @brief Returns the speed at which the renderer is currently playing.
147 * It returns 0.0 when the renderer is not playing anything. */
150 /** @brief Returns the current seek position of the renderer. */
151 GenTime seekPosition() const;
152 int seekFramePosition() const;
154 void emitFrameUpdated(Mlt::Frame&);
155 void emitFrameNumber(double position);
156 void emitConsumerStopped();
158 /** @brief Returns the aspect ratio of the consumer. */
159 double consumerRatio() const;
163 /** @brief Saves current producer frame as an image. */
164 void exportCurrentFrame(KUrl url, bool notify);
166 /** @brief Turns on or off on screen display. */
167 void refreshDisplay();
168 int resetProfile(const QString profileName);
171 /** @brief Returns the width of a frame for this profile. */
172 int frameRenderWidth() const;
173 /** @brief Returns the display width of a frame for this profile. */
174 int renderWidth() const;
175 /** @brief Returns the height of a frame for this profile. */
176 int renderHeight() const;
178 /** @brief Returns display aspect ratio. */
182 * Playlist manipulation.
184 Mlt::Producer *checkSlowMotionProducer(Mlt::Producer *prod, QDomElement element);
185 int mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod, bool overwrite = false, bool push = false);
186 bool mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
187 void mltCutClip(int track, GenTime position);
188 void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime duration, const GenTime timeOffset);
189 int mltGetSpaceLength(const GenTime pos, int track, bool fromBlankStart);
190 int mltTrackDuration(int track);
191 bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
192 bool mltResizeClipStart(ItemInfo info, GenTime diff);
193 bool mltResizeClipCrop(ItemInfo info, GenTime diff);
194 bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
195 bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
196 bool mltRemoveClip(int track, GenTime position);
198 /** @brief Deletes an effect from a clip in MLT's playlist. */
199 bool mltRemoveEffect(int track, GenTime position, QString index, bool updateIndex, bool doRefresh = true);
200 bool mltRemoveTrackEffect(int track, QString index, bool updateIndex);
202 /** @brief Adds an effect to a clip in MLT's playlist. */
203 bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
204 bool mltAddEffect(Mlt::Service service, EffectsParameterList params, int duration, bool doRefresh);
205 bool mltAddTrackEffect(int track, EffectsParameterList params);
207 /** @brief Edits an effect parameters in MLT's playlist. */
208 bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
209 bool mltEditTrackEffect(int track, EffectsParameterList params);
211 /** @brief Updates the "kdenlive_ix" (index) value of an effect. */
212 void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
214 /** @brief Changes the order of effects in MLT's playlist.
216 * It switches effects from oldPos and newPos, updating the "kdenlive_ix"
218 void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
219 void mltMoveTrackEffect(int track, int oldPos, int newPos);
221 /** @brief Enables/disables audio/video in a track. */
222 void mltChangeTrackState(int track, bool mute, bool blind);
223 bool mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
224 bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
225 void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
226 void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool force = false);
227 void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
228 void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
229 void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
230 void mltDeleteTransparency(int pos, int track, int id);
231 void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
232 void mltInsertTrack(int ix, bool videoTrack);
233 void mltDeleteTrack(int ix);
234 bool mltUpdateClipProducer(int track, int pos, Mlt::Producer *prod);
235 void mltPlantTransition(Mlt::Field *field, Mlt::Transition &tr, int a_track, int b_track);
236 Mlt::Producer *invalidProducer(const QString &id);
238 /** @brief Changes the speed of a clip in MLT's playlist.
240 * It creates a new "framebuffer" producer, which must have its "resource"
241 * property set to "video.mpg?0.6", where "video.mpg" is the path to the
242 * clip and "0.6" is the speed in percentage. The newly created producer
243 * will have its "id" property set to "slowmotion:parentid:speed", where
244 * "parentid" is the id of the original clip in the ClipManager list and
245 * "speed" is the current speed. */
246 int mltChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, double speed, double oldspeed, int strobe, Mlt::Producer *prod);
248 const QList <Mlt::Producer *> producersList();
249 void updatePreviewSettings();
250 void setDropFrames(bool show);
251 QString updateSceneListFps(double current_fps, double new_fps, QString scene);
252 void showFrame(Mlt::Frame&);
254 void showAudio(Mlt::Frame&);
255 /** @brief This property is used to decide if the renderer should convert it's frames to QImage for use in other Kdenlive widgets. */
256 bool sendFrameForAnalysis;
257 QList <int> checkTrackSequence(int);
258 void sendFrameUpdate();
262 /** @brief The name of this renderer.
264 * Useful to identify the renderers by what they do - e.g. background
265 * rendering, workspace monitor, etc. */
267 Mlt::Consumer * m_mltConsumer;
268 Mlt::Producer * m_mltProducer;
269 Mlt::Profile *m_mltProfile;
270 double m_framePosition;
273 /** @brief True if we are playing a zone.
275 * It's determined by the "in" and "out" properties being temporarily
282 /** @brief True when the monitor is in split view. */
285 Mlt::Producer *m_blackClip;
286 QString m_activeProfile;
290 /** @brief A human-readable description of this renderer. */
294 void mltCheckLength(Mlt::Tractor *tractor);
295 void mltPasteEffects(Mlt::Producer *source, Mlt::Producer *dest);
296 QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
297 QMap<QString, Mlt::Producer *> m_slowmotionProducers;
299 /** @brief Build the MLT Consumer object with initial settings.
300 * @param profileName The MLT profile to use for the consumer */
301 void buildConsumer(const QString profileName);
302 void resetZoneMode();
303 void fillSlowMotionProducers();
307 /** @brief Refreshes the monitor display. */
309 void slotOsdTimeout();
310 int connectPlaylist();
311 //void initSceneList();
315 /** @brief The renderer received a reply to a getFileProperties request. */
316 void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &, bool);
318 /** @brief The renderer received a reply to a getImage request. */
319 void replyGetImage(const QString &, const QPixmap &);
321 /** @brief The renderer stopped, either playing or rendering. */
324 /** @brief The renderer started playing. */
325 void playing(double);
327 /** @brief The renderer started rendering. */
328 void rendering(const GenTime &);
330 /** @brief The rendering has finished.
331 @see consumer_frame_show
332 This signal seems to be useless; use renderPosition(int) instead --Granjow */
333 void renderFinished();
335 /* @brief The current seek position has been changed by the renderer.
336 void positionChanged(const GenTime &);*/
338 /** @brief An error occurred within this renderer. */
339 void error(const QString &, const QString &);
340 void durationChanged(int);
341 void rendererPosition(int);
342 void rendererStopped(int);
343 void removeInvalidClip(const QString &, bool replaceProducer);
344 void refreshDocumentProducers();
346 /** @brief A frame's image has to be shown.
348 * Used in Mac OS X. */
349 void showImageSignal(QImage);
350 void showAudioSignal(const QByteArray);
351 /** @brief The renderer refreshed the current frame, but no seeking was done. */
352 void frameUpdated(QImage);
356 /** @brief Starts the consumer. */
359 /** @brief Stops the consumer. */
363 /** @brief Checks if the file is readable by MLT. */
364 bool isValid(KUrl url);
366 /** @brief Requests the file properties for the specified URL.
368 * Upon return, the result will be emitted via replyGetFileProperties().
369 * Wraps the VEML command of the same name. */
370 void getFileProperties(const QDomElement xml, const QString &clipId, int imageHeight, bool replaceProducer = true);
372 void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
373 void mltSavePlaylist();
374 void slotSplitView(bool doit);
375 void slotSwitchFullscreen();
376 void slotSetVolume(int volume);