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 "mlt/framework/mlt_types.h"
64 class MltErrorEvent : public QEvent
67 MltErrorEvent(QString message) : QEvent(QEvent::User), m_message(message) {}
68 QString message() const {
76 class Render: public QObject
80 enum FailStates { OK = 0,
83 /** @brief Build a MLT Renderer
84 * @param rendererName A unique identifier for this renderer
85 * @param winid The parent widget identifier (required for SDL display). Set to 0 for OpenGL rendering
86 * @param profile The MLT profile used for the renderer (default one will be used if empty). */
87 Render(const QString & rendererName, int winid, QString profile = QString(), QWidget *parent = 0);
89 /** @brief Destroy the MLT Renderer. */
92 /** @brief Seeks the renderer clip to the given time. */
93 void seek(GenTime time);
95 void seekToFrameDiff(int diff);
98 QPixmap getImageThumbnail(KUrl url, int width, int height);
100 /** @brief Sets the current MLT producer playlist.
101 * @param list The xml describing the playlist
102 * @param position (optional) time to seek to */
103 int setSceneList(QDomDocument list, int position = 0);
105 /** @brief Sets the current MLT producer playlist.
106 * @param list new playlist
107 * @param position (optional) time to seek to
108 * @return 0 when it has success, different from 0 otherwise
110 * Creates the producer from the text playlist. */
111 int setSceneList(QString playlist, int position = 0);
112 int setProducer(Mlt::Producer *producer, int position);
114 /** @brief Get the current MLT producer playlist.
115 * @return A string describing the playlist */
116 const QString sceneList();
117 bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
119 /** @brief Tells the renderer to play the scene at the specified speed,
120 * @param speed speed to play the scene to
122 * The speed is relative to normal playback, e.g. 1.0 is normal speed, 0.0
123 * is paused, -1.0 means play backwards. It does not specify start/stop */
124 void play(double speed);
128 /** @brief Stops playing.
129 * @param startTime time to seek to */
130 void stop(const GenTime & startTime);
133 QImage extractFrame(int frame_position, QString path = QString(), int width = -1, int height = -1);
135 /** @brief Plays the scene starting from a specific time.
136 * @param startTime time to start playing the scene from */
137 void play(const GenTime & startTime);
138 void playZone(const GenTime & startTime, const GenTime & stopTime);
139 void loopZone(const GenTime & startTime, const GenTime & stopTime);
141 void saveZone(KUrl url, QString desc, QPoint zone);
143 /** @brief Returns the name of the renderer. */
144 const QString & rendererName() const;
146 /** @brief Returns the speed at which the renderer is currently playing.
148 * It returns 0.0 when the renderer is not playing anything. */
151 /** @brief Returns the current seek position of the renderer. */
152 GenTime seekPosition() const;
153 int seekFramePosition() const;
155 void emitFrameUpdated(Mlt::Frame&);
156 void emitFrameNumber(double position);
157 void emitConsumerStopped();
159 /** @brief Returns the aspect ratio of the consumer. */
160 double consumerRatio() const;
164 /** @brief Saves current producer frame as an image. */
165 void exportCurrentFrame(KUrl url, bool notify);
167 /** @brief Turns on or off on screen display. */
168 void refreshDisplay();
169 int resetProfile(const QString profileName);
172 /** @brief Returns the width of a frame for this profile. */
173 int frameRenderWidth() const;
174 /** @brief Returns the display width of a frame for this profile. */
175 int renderWidth() const;
176 /** @brief Returns the height of a frame for this profile. */
177 int renderHeight() const;
179 /** @brief Returns display aspect ratio. */
181 /** @brief Returns sample aspect ratio. */
185 * Playlist manipulation.
187 Mlt::Producer *checkSlowMotionProducer(Mlt::Producer *prod, QDomElement element);
188 int mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod, bool overwrite = false, bool push = false);
189 bool mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
190 void mltCutClip(int track, GenTime position);
191 void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime duration, const GenTime timeOffset);
192 int mltGetSpaceLength(const GenTime pos, int track, bool fromBlankStart);
194 /** @brief Returns the duration/length of @param track as reported by the track producer. */
195 int mltTrackDuration(int track);
197 bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
198 bool mltResizeClipStart(ItemInfo info, GenTime diff);
199 bool mltResizeClipCrop(ItemInfo info, GenTime diff);
200 bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
201 bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
202 bool mltRemoveClip(int track, GenTime position);
204 /** @brief Deletes an effect from a clip in MLT's playlist. */
205 bool mltRemoveEffect(int track, GenTime position, QString index, bool updateIndex, bool doRefresh = true);
206 bool mltRemoveTrackEffect(int track, QString index, bool updateIndex);
208 /** @brief Adds an effect to a clip in MLT's playlist. */
209 bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
210 bool mltAddEffect(Mlt::Service service, EffectsParameterList params, int duration, bool doRefresh);
211 bool mltAddTrackEffect(int track, EffectsParameterList params);
213 /** @brief Edits an effect parameters in MLT's playlist. */
214 bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
215 bool mltEditTrackEffect(int track, EffectsParameterList params);
217 /** @brief Updates the "kdenlive_ix" (index) value of an effect. */
218 void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
220 /** @brief Changes the order of effects in MLT's playlist.
222 * It switches effects from oldPos and newPos, updating the "kdenlive_ix"
224 void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
225 void mltMoveTrackEffect(int track, int oldPos, int newPos);
227 /** @brief Enables/disables audio/video in a track. */
228 void mltChangeTrackState(int track, bool mute, bool blind);
229 bool mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
230 bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
231 void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
232 void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool force = false);
233 void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
234 void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
235 void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
236 void mltDeleteTransparency(int pos, int track, int id);
237 void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
238 void mltInsertTrack(int ix, bool videoTrack);
239 void mltDeleteTrack(int ix);
240 bool mltUpdateClipProducer(int track, int pos, Mlt::Producer *prod);
241 void mltPlantTransition(Mlt::Field *field, Mlt::Transition &tr, int a_track, int b_track);
242 Mlt::Producer *invalidProducer(const QString &id);
244 /** @brief Changes the speed of a clip in MLT's playlist.
246 * It creates a new "framebuffer" producer, which must have its "resource"
247 * property set to "video.mpg?0.6", where "video.mpg" is the path to the
248 * clip and "0.6" is the speed in percentage. The newly created producer
249 * will have its "id" property set to "slowmotion:parentid:speed", where
250 * "parentid" is the id of the original clip in the ClipManager list and
251 * "speed" is the current speed. */
252 int mltChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, double speed, double oldspeed, int strobe, Mlt::Producer *prod);
254 const QList <Mlt::Producer *> producersList();
255 void updatePreviewSettings();
256 void setDropFrames(bool show);
257 QString updateSceneListFps(double current_fps, double new_fps, QString scene);
258 void showFrame(Mlt::Frame&);
260 void showAudio(Mlt::Frame&);
261 /** @brief This property is used to decide if the renderer should send audio data for monitoring. */
263 /** @brief This property is used to decide if the renderer should convert it's frames to QImage for use in other Kdenlive widgets. */
264 bool sendFrameForAnalysis;
265 QList <int> checkTrackSequence(int);
266 void sendFrameUpdate();
268 /** @brief Returns a pointer to the main producer. */
269 Mlt::Producer *getProducer();
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;
283 bool m_externalConsumer;
285 /** @brief True if we are playing a zone.
287 * It's determined by the "in" and "out" properties being temporarily
294 /** @brief True when the monitor is in split view. */
297 Mlt::Producer *m_blackClip;
298 QString m_activeProfile;
302 /** @brief A human-readable description of this renderer. */
306 void mltCheckLength(Mlt::Tractor *tractor);
307 void mltPasteEffects(Mlt::Producer *source, Mlt::Producer *dest);
308 QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
309 QMap<QString, Mlt::Producer *> m_slowmotionProducers;
311 /** @brief Build the MLT Consumer object with initial settings.
312 * @param profileName The MLT profile to use for the consumer */
313 void buildConsumer(const QString profileName);
314 void resetZoneMode();
315 void fillSlowMotionProducers();
316 /** @brief Get the track number of the lowest audible (non muted) audio track
317 * @param return The track number */
318 int getLowestNonMutedAudioTrack(Mlt::Tractor tractor);
320 /** @brief Make sure our audio mixing transitions are applied to the lowest track */
321 void fixAudioMixing(Mlt::Tractor tractor);
325 /** @brief Refreshes the monitor display. */
327 void slotOsdTimeout();
328 int connectPlaylist();
329 //void initSceneList();
333 /** @brief The renderer received a reply to a getFileProperties request. */
334 void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &, bool, bool);
336 /** @brief The renderer received a reply to a getImage request. */
337 void replyGetImage(const QString &, const QPixmap &);
339 /** @brief The renderer stopped, either playing or rendering. */
342 /** @brief The renderer started playing. */
343 void playing(double);
345 /** @brief The renderer started rendering. */
346 void rendering(const GenTime &);
348 /** @brief An error occurred within this renderer. */
349 void error(const QString &, const QString &);
350 void durationChanged(int);
351 void rendererPosition(int);
352 void rendererStopped(int);
353 /** @brief The clip is not valid, should be removed from project. */
354 void removeInvalidClip(const QString &, bool replaceProducer);
355 /** @brief The proxy is not valid, should be deleted.
356 * @param id The original clip's id
357 * @param durationError Should be set to true if the proxy failed because it has not same length as original clip
359 void removeInvalidProxy(const QString &id, bool durationError);
360 void refreshDocumentProducers();
362 /** @brief A frame's image has to be shown.
364 * Used in Mac OS X. */
365 void showImageSignal(QImage);
366 void showAudioSignal(const QByteArray);
367 /** @brief The renderer refreshed the current frame, but no seeking was done. */
368 void frameUpdated(QImage);
369 /** @brief This signal contains the audio of the current frame. */
370 void audioSamplesSignal(const QVector<int16_t>&, int freq, int num_channels, int num_samples);
374 /** @brief Starts the consumer. */
377 /** @brief Stops the consumer. */
381 /** @brief Checks if the file is readable by MLT. */
382 bool isValid(KUrl url);
384 /** @brief Requests the file properties for the specified URL.
385 @param xml The xml parameters for the clip
386 @param clipId The clip Id string
387 @param imageHeight The height (in pixels) of the returned thumbnail (height of a treewidgetitem in projectlist)
388 @param replaceProducer If true, the MLT producer will be recreated
389 @param selectClip If true, clip item will be selected in project view
390 * Upon return, the result will be emitted via replyGetFileProperties().
391 * Wraps the VEML command of the same name. */
392 void getFileProperties(const QDomElement xml, const QString &clipId, int imageHeight, bool replaceProducer = true, bool selectClip = false);
394 void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
395 void mltSavePlaylist();
396 void slotSplitView(bool doit);
397 void slotSwitchFullscreen();
398 void slotSetVolume(int volume);
399 void seekToFrame(int pos);