1 /***************************************************************************
2 krender.h - description
4 begin : Fri Nov 22 2002
5 copyright : (C) 2002 by Jason Wood
6 email : jasonwood@blueyonder.co.uk
7 ***************************************************************************/
9 /***************************************************************************
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 ***************************************************************************/
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"
44 #include "videoglwidget.h"
66 class MltErrorEvent : public QEvent
69 MltErrorEvent(QString message) : QEvent(QEvent::User), m_message(message) {}
70 QString message() const {
78 class Render: public QObject
82 enum FailStates { OK = 0,
86 Render(const QString & rendererName, int winid, int extid, QString profile = QString(), QWidget *parent = 0);
89 /** @brief Seeks the renderer clip to the given time. */
90 void seek(GenTime time);
91 void seekToFrame(int pos);
92 void seekToFrameDiff(int diff);
95 //static QPixmap getVideoThumbnail(char *profile, QString file, int frame, int width, int height);
96 QPixmap getImageThumbnail(KUrl url, int width, int height);
98 /* Return thumbnail for color clip
99 void getImage(int id, QString color, QPoint size);*/
101 // static QPixmap frameThumbnail(Mlt::Frame *frame, int width, int height, bool border = false);
103 /* Return thumbnail for image clip
104 void getImage(KUrl url, QPoint size);*/
106 /* Requests a particular frame from the given file.
108 * The pixmap will be returned by emitting the replyGetImage() signal.
109 void getImage(KUrl url, int frame, QPoint size);*/
111 int setSceneList(QDomDocument list, int position = 0);
113 /** @brief Sets the current scene list.
114 * @param list new scene list
115 * @param position (optional) time to seek to
116 * @return 0 when it has success, different from 0 otherwise
118 * Creates the producer from the MLT XML QDomDocument. Wraps the VEML
119 * command of the same name. */
120 int setSceneList(QString playlist, int position = 0);
121 int setProducer(Mlt::Producer *producer, int position);
122 const QString sceneList();
123 bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
125 /** @brief Tells the renderer to play the scene at the specified speed,
126 * @param speed speed to play the scene to
128 * The speed is relative to normal playback, e.g. 1.0 is normal speed, 0.0
129 * is paused, -1.0 means play backwards. It does not specify start/stop
130 * times for playback. Wraps the VEML command of the same name. */
131 void play(double speed);
135 /** @brief Stops playing.
136 * @param startTime time to seek to */
137 void stop(const GenTime & startTime);
138 void setVolume(double volume);
140 QImage extractFrame(int frame_position, int width = -1, int height = -1);
142 /** @brief Plays the scene starting from a specific time.
143 * @param startTime time to start playing the scene from
145 * Wraps the VEML command of the same name. */
146 void play(const GenTime & startTime);
147 void playZone(const GenTime & startTime, const GenTime & stopTime);
148 void loopZone(const GenTime & startTime, const GenTime & stopTime);
150 void saveZone(KUrl url, QString desc, QPoint zone);
152 /** @brief Returns the name of the renderer. */
153 const QString & rendererName() const;
155 /** @brief Returns the speed at which the renderer is currently playing.
157 * It returns 0.0 when the renderer is not playing anything. */
160 /** @brief Returns the current seek position of the renderer. */
161 GenTime seekPosition() const;
162 int seekFramePosition() const;
164 void emitFrameUpdated(Mlt::Frame&);
165 void emitFrameNumber(double position);
166 void emitConsumerStopped();
168 /** @brief Returns the aspect ratio of the consumer. */
169 double consumerRatio() const;
173 /** @brief Saves current producer frame as an image. */
174 void exportCurrentFrame(KUrl url, bool notify);
176 /** @brief Turns on or off on screen display. */
177 void refreshDisplay();
178 int resetProfile(const QString profileName);
181 /** @brief Returns the width of a frame for this profile. */
182 int frameRenderWidth() const;
183 /** @brief Returns the display width of a frame for this profile. */
184 int renderWidth() const;
185 /** @brief Returns the height of a frame for this profile. */
186 int renderHeight() const;
188 /** @brief Returns display aspect ratio. */
192 * Playlist manipulation.
194 Mlt::Producer *checkSlowMotionProducer(Mlt::Producer *prod, QDomElement element);
195 int mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod, bool overwrite = false, bool push = false);
196 bool mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
197 void mltCutClip(int track, GenTime position);
198 void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime duration, const GenTime timeOffset);
199 int mltGetSpaceLength(const GenTime pos, int track, bool fromBlankStart);
200 int mltTrackDuration(int track);
201 bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
202 bool mltResizeClipStart(ItemInfo info, GenTime diff);
203 bool mltResizeClipCrop(ItemInfo info, GenTime diff);
204 bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
205 bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
206 bool mltRemoveClip(int track, GenTime position);
208 /** @brief Deletes an effect from a clip in MLT's playlist. */
209 bool mltRemoveEffect(int track, GenTime position, QString index, bool updateIndex, bool doRefresh = true);
210 bool mltRemoveTrackEffect(int track, QString index, bool updateIndex);
212 /** @brief Adds an effect to a clip in MLT's playlist. */
213 bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
214 bool mltAddEffect(Mlt::Service service, EffectsParameterList params, int duration, bool doRefresh);
215 bool mltAddTrackEffect(int track, EffectsParameterList params);
217 /** @brief Edits an effect parameters in MLT's playlist. */
218 bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
219 bool mltEditTrackEffect(int track, EffectsParameterList params);
221 /** @brief Updates the "kdenlive_ix" (index) value of an effect. */
222 void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
224 /** @brief Changes the order of effects in MLT's playlist.
226 * It switches effects from oldPos and newPos, updating the "kdenlive_ix"
228 void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
229 void mltMoveTrackEffect(int track, int oldPos, int newPos);
231 /** @brief Enables/disables audio/video in a track. */
232 void mltChangeTrackState(int track, bool mute, bool blind);
233 bool mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
234 bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
235 void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
236 void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool force = false);
237 void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
238 void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
239 void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
240 void mltDeleteTransparency(int pos, int track, int id);
241 void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
242 void mltInsertTrack(int ix, bool videoTrack);
243 void mltDeleteTrack(int ix);
244 bool mltUpdateClipProducer(int track, int pos, Mlt::Producer *prod);
245 void mltPlantTransition(Mlt::Field *field, Mlt::Transition &tr, int a_track, int b_track);
246 Mlt::Producer *invalidProducer(const QString &id);
248 /** @brief Changes the speed of a clip in MLT's playlist.
250 * It creates a new "framebuffer" producer, which must have its "resource"
251 * property set to "video.mpg?0.6", where "video.mpg" is the path to the
252 * clip and "0.6" is the speed in percentage. The newly created producer
253 * will have its "id" property set to "slowmotion:parentid:speed", where
254 * "parentid" is the id of the original clip in the ClipManager list and
255 * "speed" is the current speed. */
256 int mltChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, double speed, double oldspeed, int strobe, Mlt::Producer *prod);
258 const QList <Mlt::Producer *> producersList();
259 void updatePreviewSettings();
260 void setDropFrames(bool show);
261 QString updateSceneListFps(double current_fps, double new_fps, QString scene);
263 void showFrame(Mlt::Frame&);
265 void showAudio(Mlt::Frame&);
266 /** @brief This property is used to decide if the renderer should convert it's frames to QImage for use in other Kdenlive widgets. */
267 bool sendFrameForAnalysis;
268 QList <int> checkTrackSequence(int);
269 void sendFrameUpdate();
273 /** @brief The name of this renderer.
275 * Useful to identify the renderers by what they do - e.g. background
276 * rendering, workspace monitor, etc. */
278 Mlt::Consumer * m_mltConsumer;
279 Mlt::Producer * m_mltProducer;
280 Mlt::Profile *m_mltProfile;
281 double m_framePosition;
284 /** @brief True if we are playing a zone.
286 * It's determined by the "in" and "out" properties being temporarily
293 /** @brief True when the monitor is in split view. */
296 Mlt::Producer *m_blackClip;
297 QString m_activeProfile;
301 /** @brief A human-readable description of this renderer. */
305 VideoGLWidget *m_glWidget;
308 void mltCheckLength(Mlt::Tractor *tractor);
309 void mltPasteEffects(Mlt::Producer *source, Mlt::Producer *dest);
310 QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
311 QMap<QString, Mlt::Producer *> m_slowmotionProducers;
312 void buildConsumer(const QString profileName);
313 void resetZoneMode();
314 void fillSlowMotionProducers();
318 /** @brief Refreshes the monitor display. */
320 void slotOsdTimeout();
321 int connectPlaylist();
322 //void initSceneList();
326 /** @brief The renderer received a reply to a getFileProperties request. */
327 void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &, bool);
329 /** @brief The renderer received a reply to a getImage request. */
330 void replyGetImage(const QString &, const QPixmap &);
332 /** @brief The renderer stopped, either playing or rendering. */
335 /** @brief The renderer started playing. */
336 void playing(double);
338 /** @brief The renderer started rendering. */
339 void rendering(const GenTime &);
341 /** @brief The rendering has finished.
342 @see consumer_frame_show
343 This signal seems to be useless; use renderPosition(int) instead --Granjow */
344 void renderFinished();
346 /* @brief The current seek position has been changed by the renderer.
347 void positionChanged(const GenTime &);*/
349 /** @brief An error occurred within this renderer. */
350 void error(const QString &, const QString &);
351 void durationChanged(int);
352 void rendererPosition(int);
353 void rendererStopped(int);
354 void removeInvalidClip(const QString &, bool replaceProducer);
355 void refreshDocumentProducers();
357 /** @brief A frame's image has to be shown.
359 * Used in Mac OS X. */
360 void showImageSignal(QImage);
361 void showAudioSignal(QByteArray);
362 /** @brief The renderer refreshed the current frame, but no seeking was done. */
363 void frameUpdated(QImage);
367 /** @brief Starts the consumer. */
370 /** @brief Stops the consumer. */
374 /** @brief Checks if the file is readable by MLT. */
375 bool isValid(KUrl url);
377 /** @brief Requests the file properties for the specified URL.
379 * Upon return, the result will be emitted via replyGetFileProperties().
380 * Wraps the VEML command of the same name. */
381 void getFileProperties(const QDomElement xml, const QString &clipId, int imageHeight, bool replaceProducer = true);
383 void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
384 void mltSavePlaylist();
385 void slotSplitView(bool doit);
386 void slotSwitchFullscreen();