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 ***************************************************************************/
29 #include "definitions.h"
31 /**Render encapsulates the client side of the interface to a renderer.
32 From Kdenlive's point of view, you treat the Render object as the
33 renderer, and simply use it as if it was local. Calls are asyncrhonous -
34 you send a call out, and then receive the return value through the
35 relevant signal that get's emitted once the call completes.
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);
95 const QString sceneList();
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);
106 void stop(const GenTime & startTime);
107 void setVolume(double volume);
109 QPixmap extractFrame(int frame_position, int width = -1, int height = -1);
110 /** Wraps the VEML command of the same name. Tells the renderer to
111 play the current scene at the speed specified, relative to normal
112 playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
113 backwards. Specifes the start/stop times for playback.*/
114 void play(const GenTime & startTime);
115 void playZone(const GenTime & startTime, const GenTime & stopTime);
116 void loopZone(const GenTime & startTime, const GenTime & stopTime);
118 void saveZone(KUrl url, QString desc, QPoint zone);
120 /** Returns the name of the renderer. */
121 const QString & rendererName() const;
123 /** Returns the speed at which the renderer is currently playing, 0.0 if the renderer is
124 not playing anything. */
126 /** Returns the current seek position of the renderer. */
127 GenTime seekPosition() const;
129 void emitFrameNumber(double position);
130 void emitConsumerStopped();
132 /** Gives the aspect ratio of the consumer */
133 double consumerRatio() const;
135 void askForRefresh();
138 /** Save current producer frame as image */
139 void exportCurrentFrame(KUrl url, bool notify);
141 /** Turn on or off on screen display */
142 void refreshDisplay();
144 const double fps() const;
145 const int renderWidth() const;
146 const int renderHeight() const;
147 /** get display aspect ratio */
148 const double dar() const;
150 /** Playlist manipulation */
151 void mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
152 void mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
153 void mltCutClip(int track, GenTime position);
154 void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime duration, const GenTime timeOffset);
155 int mltGetSpaceLength(const GenTime pos, int track, bool fromBlankStart);
156 bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
157 bool mltResizeClipStart(ItemInfo info, GenTime diff);
158 bool mltResizeClipCrop(ItemInfo info, GenTime diff);
159 bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod);
160 bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod);
161 bool mltRemoveClip(int track, GenTime position);
162 bool mltRemoveEffect(int track, GenTime position, QString index, bool updateIndex, bool doRefresh = true);
163 bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
164 bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
165 void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
166 void mltChangeTrackState(int track, bool mute, bool blind);
167 bool mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
168 bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
169 void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
170 void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
171 void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
172 void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
173 void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
174 void mltDeleteTransparency(int pos, int track, int id);
175 void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
176 void mltInsertTrack(int ix, bool videoTrack);
177 void mltDeleteTrack(int ix);
178 void mltUpdateClipProducer(int track, int pos, Mlt::Producer *prod);
180 /** Change speed of a clip in playlist. To do this, we create a new "framebuffer" producer.
181 This new producer must have its "resource" param set to: video.mpg?0.6 where video.mpg is the path
182 to the clip and 0.6 is the speed in percents. The newly created producer will have it's
183 "id" parameter set to: "slowmotion:parentid:speed", where parentid is the id of the original clip
184 in the ClipManager list and speed is the current speed */
185 int mltChangeClipSpeed(ItemInfo info, double speed, double oldspeed, Mlt::Producer *prod);
187 QList <Mlt::Producer *> producersList();
188 void updatePreviewSettings();
190 private: // Private attributes & methods
191 /** The name of this renderer - useful to identify the renderes by what they do - e.g. background rendering, workspace monitor, etc... */
193 Mlt::Consumer * m_mltConsumer;
194 Mlt::Producer * m_mltProducer;
195 Mlt::Producer *m_mltTextProducer;
196 Mlt::Filter *m_osdInfo;
197 Mlt::Profile *m_mltProfile;
198 double m_framePosition;
201 /** true if we are playing a zone (ie the in and out properties have been temporarily changed) */
207 /** true when monitor is in split view (several tracks at the same time) */
210 Mlt::Producer *m_blackClip;
211 /** Holds the path to on screen display profile */
212 QString m_osdProfile;
213 QString m_activeProfile;
215 QTimer *refreshTimer;
219 /** A human-readable description of this renderer. */
223 /** Sets the description of this renderer to desc. */
225 void mltCheckLength();
226 QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
227 QMap<QString, Mlt::Producer *> m_slowmotionProducers;
228 void buildConsumer();
229 void resetZoneMode();
230 void fillSlowMotionProducers();
232 private slots: // Private slots
233 /** refresh monitor display */
235 void slotOsdTimeout();
236 void connectPlaylist();
237 //void initSceneList();
240 /** emitted when the renderer recieves a reply to a getFileProperties request. */
241 void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &, bool);
243 /** emitted when the renderer recieves a reply to a getImage request. */
244 void replyGetImage(const QString &, const QPixmap &);
246 /** Emitted when the renderer stops, either playing or rendering. */
248 /** Emitted when the renderer starts playing. */
249 void playing(double);
250 /** Emitted when the renderer is rendering. */
251 void rendering(const GenTime &);
252 /** Emitted when rendering has finished */
253 void renderFinished();
254 /** Emitted when the current seek position has been changed by the renderer. */
255 // void positionChanged(const GenTime &);
256 /** Emitted when an error occurs within this renderer. */
257 void error(const QString &, const QString &);
258 void durationChanged(int);
259 void rendererPosition(int);
260 void rendererStopped(int);
261 void removeInvalidClip(const QString &);
263 public slots: // Public slots
264 /** Start Consumer */
270 /** If the file is readable by mlt, return true, otherwise false */
271 bool isValid(KUrl url);
273 /** Wraps the VEML command of the same name. Requests the file properties
274 for the specified url from the renderer. Upon return, the result will be emitted
275 via replyGetFileProperties(). */
276 void getFileProperties(const QDomElement &xml, const QString &clipId, bool replaceProducer = true);
278 void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
279 static char *decodedString(QString str);
280 void mltSavePlaylist();
281 void slotSplitView(bool doit);