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 ***************************************************************************/
30 #include "definitions.h"
32 /**Render encapsulates the client side of the interface to a renderer.
33 From Kdenlive's point of view, you treat the Render object as the
34 renderer, and simply use it as if it was local. Calls are asyncrhonous -
35 you send a call out, and then recieve the return value through the
36 relevant signal that get's emitted once the call completes.
41 //class EffectParamDesc;
57 class Render: public QObject {
60 enum FailStates { OK = 0,
64 Render(const QString & rendererName, int winid, int extid, QWidget *parent = 0);
67 /** Seeks the renderer clip to the given time. */
68 void seek(GenTime time);
69 void seekToFrame(int pos);
72 //static QPixmap getVideoThumbnail(char *profile, QString file, int frame, int width, int height);
73 QPixmap getImageThumbnail(KUrl url, int width, int height);
75 /** Return thumbnail for color clip */
76 //void getImage(int id, QString color, QPoint size);
78 // static QPixmap frameThumbnail(Mlt::Frame *frame, int width, int height, bool border = false);
80 /** Return thumbnail for image clip */
81 //void getImage(KUrl url, QPoint size);
83 /** Requests a particular frame from the given file.
85 * The pixmap will be returned by emitting the replyGetImage() signal.
87 //void getImage(KUrl url, int frame, QPoint size);
90 /** Wraps the VEML command of the same name. Sets the current scene list to
92 void setSceneList(QDomDocument list, int position = 0);
93 void setSceneList(QString playlist, int position = 0);
94 void setProducer(Mlt::Producer *producer, int position);
96 void saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
98 /** Wraps the VEML command of the same name. Tells the renderer to
99 play the current scene at the speed specified, relative to normal
100 playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
101 backwards. Does not specify start/stop times for playback.*/
102 void play(double speed);
105 void stop(const GenTime & startTime);
106 void setVolume(double volume);
108 QPixmap extractFrame(int frame_position, int width = -1, int height = -1);
109 /** Wraps the VEML command of the same name. Tells the renderer to
110 play the current scene at the speed specified, relative to normal
111 playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
112 backwards. Specifes the start/stop times for playback.*/
113 void play(const GenTime & startTime);
114 void playZone(const GenTime & startTime, const GenTime & stopTime);
115 void loopZone(const GenTime & startTime, const GenTime & stopTime);
117 void saveZone(KUrl url, QString desc, QPoint zone);
119 /** Returns the name of the renderer. */
120 const QString & rendererName() const;
122 /** Returns the speed at which the renderer is currently playing, 0.0 if the renderer is
123 not playing anything. */
125 /** Returns the current seek position of the renderer. */
126 GenTime seekPosition() const;
128 void emitFrameNumber(double position);
129 void emitConsumerStopped();
131 /** Gives the aspect ratio of the consumer */
132 double consumerRatio() const;
134 void askForRefresh();
137 /** Save current producer frame as image */
138 void exportCurrentFrame(KUrl url, bool notify);
140 /** Turn on or off on screen display */
141 void refreshDisplay();
143 const double fps() const;
144 const int renderWidth() const;
145 const int renderHeight() const;
146 /** get display aspect ratio */
147 const double dar() const;
149 /** Playlist manipulation */
150 void mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
151 void mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
152 void mltCutClip(int track, GenTime position);
153 bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
154 bool mltResizeClipStart(ItemInfo info, GenTime diff);
155 bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart);
156 bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart);
157 bool mltRemoveClip(int track, GenTime position);
158 bool mltRemoveEffect(int track, GenTime position, QString index, bool doRefresh = true);
159 bool mltAddEffect(int track, GenTime position, QHash <QString, QString> args, bool doRefresh = true);
160 bool mltEditEffect(int track, GenTime position, QHash <QString, QString> args);
161 void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
162 void mltChangeTrackState(int track, bool mute, bool blind);
163 void mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
164 void mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
165 void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
166 void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
167 void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
168 void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
169 void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
170 void mltDeleteTransparency(int pos, int track, int id);
171 void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
173 /** Change speed of a clip in playlist. To do this, we create a new "framebuffer" producer.
174 This new producer must have its "resource" param set to: video.mpg?0.6 where video.mpg is the path
175 to the clip and 0.6 is the speed in percents. The newly created producer will have it's
176 "id" parameter set to: "slowmotion:parentid:speed", where parentid is the id of the original clip
177 in the ClipManager list and speed is the current speed */
178 int mltChangeClipSpeed(ItemInfo info, double speed, Mlt::Producer *prod);
180 QList <Mlt::Producer *> producersList();
182 private: // Private attributes & methods
183 /** The name of this renderer - useful to identify the renderes by what they do - e.g. background rendering, workspace monitor, etc... */
185 Mlt::Consumer * m_mltConsumer;
186 Mlt::Producer * m_mltProducer;
187 Mlt::Producer *m_mltTextProducer;
188 Mlt::Filter *m_osdInfo;
189 Mlt::Profile *m_mltProfile;
190 double m_framePosition;
193 /** true if we are playing a zone (ie the in and out properties have been temporarily changed) */
198 /** true when monitor is in split view (several tracks at the same time) */
201 Mlt::Producer *m_blackClip;
202 /** Holds the path to on screen display profile */
203 QString m_osdProfile;
205 QTimer *refreshTimer;
209 /** A human-readable description of this renderer. */
213 /** Sets the description of this renderer to desc. */
215 void mltCheckLength(bool reload = true);
216 QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
217 QMap<QString, Mlt::Producer *> m_slowmotionProducers;
218 void buildConsumer();
219 void resetZoneMode();
221 private slots: // Private slots
222 /** refresh monitor display */
224 void slotOsdTimeout();
225 void connectPlaylist();
226 //void initSceneList();
229 /** emitted when the renderer recieves a reply to a getFileProperties request. */
230 void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &);
232 /** emitted when the renderer recieves a reply to a getImage request. */
233 void replyGetImage(const QString & , int, const QPixmap &, int, int);
234 void replyGetImage(const QString &, const QPixmap &, int, int);
236 /** Emitted when the renderer stops, either playing or rendering. */
238 /** Emitted when the renderer starts playing. */
239 void playing(double);
240 /** Emitted when the renderer is rendering. */
241 void rendering(const GenTime &);
242 /** Emitted when rendering has finished */
243 void renderFinished();
244 /** Emitted when the current seek position has been changed by the renderer. */
245 // void positionChanged(const GenTime &);
246 /** Emitted when an error occurs within this renderer. */
247 void error(const QString &, const QString &);
248 void durationChanged(int);
249 void rendererPosition(int);
250 void rendererStopped(int);
251 void removeInvalidClip(const QString &);
253 public slots: // Public slots
254 /** Start Consumer */
260 /** If the file is readable by mlt, return true, otherwise false */
261 bool isValid(KUrl url);
263 /** Wraps the VEML command of the same name. Requests the file properties
264 for the specified url from the renderer. Upon return, the result will be emitted
265 via replyGetFileProperties(). */
266 void getFileProperties(const QDomElement &xml, const QString &clipId);
268 void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
269 static char *decodedString(QString str);
270 void mltSavePlaylist();
271 void slotSplitView(bool doit);