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 ***************************************************************************/
22 #include "definitions.h"
33 #include "videoglwidget.h"
37 /**Render encapsulates the client side of the interface to a renderer.
38 From Kdenlive's point of view, you treat the Render object as the
39 renderer, and simply use it as if it was local. Calls are asyncrhonous -
40 you send a call out, and then receive the return value through the
41 relevant signal that get's emitted once the call completes.
65 class MltErrorEvent : public QEvent
68 MltErrorEvent(QString message) : QEvent(QEvent::User), m_message(message) {}
69 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 /** 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.
110 //void getImage(KUrl url, int frame, QPoint size);
113 /** Wraps the VEML command of the same name. Sets the current scene list to
115 int setSceneList(QDomDocument list, int position = 0);
116 int setSceneList(QString playlist, int position = 0);
117 int setProducer(Mlt::Producer *producer, int position);
118 const QString sceneList();
119 bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
121 /** Wraps the VEML command of the same name. Tells the renderer to
122 play the current scene at the speed specified, relative to normal
123 playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
124 backwards. Does not specify start/stop times for playback.*/
125 void play(double speed);
129 void stop(const GenTime & startTime);
130 void setVolume(double volume);
132 QImage extractFrame(int frame_position, int width = -1, int height = -1);
133 /** Wraps the VEML command of the same name. Tells the renderer to
134 play the current scene at the speed specified, relative to normal
135 playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
136 backwards. Specifes the start/stop times for playback.*/
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 /** Returns the name of the renderer. */
144 const QString & rendererName() const;
146 /** Returns the speed at which the renderer is currently playing, 0.0 if the renderer is
147 not playing anything. */
149 /** Returns the current seek position of the renderer. */
150 GenTime seekPosition() const;
151 int seekFramePosition() const;
153 void emitFrameNumber(double position);
154 void emitConsumerStopped();
156 /** Gives the aspect ratio of the consumer */
157 double consumerRatio() const;
161 /** Save current producer frame as image */
162 void exportCurrentFrame(KUrl url, bool notify);
164 /** Turn on or off on screen display */
165 void refreshDisplay();
166 int resetProfile(const QString profileName);
168 int renderWidth() const;
169 int renderHeight() const;
170 /** get display aspect ratio */
173 /** Playlist manipulation */
174 int mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod, bool overwrite = false, bool push = false);
175 bool mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
176 void mltCutClip(int track, GenTime position);
177 void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime duration, const GenTime timeOffset);
178 int mltGetSpaceLength(const GenTime pos, int track, bool fromBlankStart);
179 int mltTrackDuration(int track);
180 bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
181 bool mltResizeClipStart(ItemInfo info, GenTime diff);
182 bool mltResizeClipCrop(ItemInfo info, GenTime diff);
183 bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
184 bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
185 bool mltRemoveClip(int track, GenTime position);
186 /** Delete an effect to a clip in MLT's playlist */
187 bool mltRemoveEffect(int track, GenTime position, QString index, bool updateIndex, bool doRefresh = true);
188 /** Add an effect to a clip in MLT's playlist */
189 bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
190 /** Edit an effect parameters in MLT */
191 bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
192 /** This only updates the "kdenlive_ix" (index) value of an effect */
193 void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
194 /** This changes the order of effects in MLT, inverting effects from oldPos and newPos, also updating the kdenlive_ix value */
195 void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
196 /** This changes the state of a track, enabling / disabling audio and video */
197 void mltChangeTrackState(int track, bool mute, bool blind);
198 bool mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
199 bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
200 void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
201 void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool force = false);
202 void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
203 void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
204 void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
205 void mltDeleteTransparency(int pos, int track, int id);
206 void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
207 void mltInsertTrack(int ix, bool videoTrack);
208 void mltDeleteTrack(int ix);
209 bool mltUpdateClipProducer(int track, int pos, Mlt::Producer *prod);
210 void mltPlantTransition(Mlt::Field *field, Mlt::Transition &tr, int a_track, int b_track);
211 Mlt::Producer *invalidProducer(const QString &id);
213 /** Change speed of a clip in playlist. To do this, we create a new "framebuffer" producer.
214 This new producer must have its "resource" param set to: video.mpg?0.6 where video.mpg is the path
215 to the clip and 0.6 is the speed in percents. The newly created producer will have it's
216 "id" parameter set to: "slowmotion:parentid:speed", where parentid is the id of the original clip
217 in the ClipManager list and speed is the current speed */
218 int mltChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, double speed, double oldspeed, int strobe, Mlt::Producer *prod);
220 const QList <Mlt::Producer *> producersList();
221 void updatePreviewSettings();
222 void setDropFrames(bool show);
223 QString updateSceneListFps(double current_fps, double new_fps, QString scene);
225 void showFrame(Mlt::Frame&);
227 QList <int> checkTrackSequence(int);
229 private: // Private attributes & methods
230 /** The name of this renderer - useful to identify the renderes by what they do - e.g. background rendering, workspace monitor, etc... */
232 Mlt::Consumer * m_mltConsumer;
233 Mlt::Producer * m_mltProducer;
234 Mlt::Profile *m_mltProfile;
235 double m_framePosition;
238 /** true if we are playing a zone (ie the in and out properties have been temporarily changed) */
244 /** true when monitor is in split view (several tracks at the same time) */
247 Mlt::Producer *m_blackClip;
248 QString m_activeProfile;
252 /** A human-readable description of this renderer. */
256 VideoGLWidget *m_glWidget;
259 /** Sets the description of this renderer to desc. */
261 void mltCheckLength(Mlt::Tractor *tractor);
262 void mltPasteEffects(Mlt::Producer *source, Mlt::Producer *dest);
263 QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
264 QMap<QString, Mlt::Producer *> m_slowmotionProducers;
265 void buildConsumer(const QString profileName);
266 void resetZoneMode();
267 void fillSlowMotionProducers();
269 private slots: // Private slots
270 /** refresh monitor display */
272 void slotOsdTimeout();
273 int connectPlaylist();
274 //void initSceneList();
277 /** emitted when the renderer recieves a reply to a getFileProperties request. */
278 void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &, bool);
280 /** emitted when the renderer recieves a reply to a getImage request. */
281 void replyGetImage(const QString &, const QPixmap &);
283 /** Emitted when the renderer stops, either playing or rendering. */
285 /** Emitted when the renderer starts playing. */
286 void playing(double);
287 /** Emitted when the renderer is rendering. */
288 void rendering(const GenTime &);
289 /** Emitted when rendering has finished */
290 void renderFinished();
291 /** Emitted when the current seek position has been changed by the renderer. */
292 // void positionChanged(const GenTime &);
293 /** Emitted when an error occurs within this renderer. */
294 void error(const QString &, const QString &);
295 void durationChanged(int);
296 void rendererPosition(int);
297 void rendererStopped(int);
298 void removeInvalidClip(const QString &, bool replaceProducer);
299 void refreshDocumentProducers();
300 /** Used on OS X - emitted when a frame's image is to be shown. */
301 void showImageSignal(QImage);
303 public slots: // Public slots
304 /** Start Consumer */
309 /** If the file is readable by mlt, return true, otherwise false */
310 bool isValid(KUrl url);
312 /** Wraps the VEML command of the same name. Requests the file properties
313 for the specified url from the renderer. Upon return, the result will be emitted
314 via replyGetFileProperties(). */
315 void getFileProperties(const QDomElement xml, const QString &clipId, int imageHeight, bool replaceProducer = true);
317 void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
318 static char *decodedString(QString str);
319 void mltSavePlaylist();
320 void slotSplitView(bool doit);
321 void slotSwitchFullscreen();