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 "docclipref.h"
31 #include "effectdesc.h"
32 #include "effectparamdescfactory.h"*/
34 #include <mlt++/Mlt.h>
36 /**Render encapsulates the client side of the interface to a renderer.
37 From Kdenlive's point of view, you treat the Render object as the
38 renderer, and simply use it as if it was local. Calls are asyncrhonous -
39 you send a call out, and then recieve the return value through the
40 relevant signal that get's emitted once the call completes.
45 //class EffectParamDesc;
61 class Render: public QObject {
64 enum FailStates { OK = 0,
68 Render(const QString & rendererName, int winid, int extid, QWidget *parent = 0);
71 /** Seeks the renderer clip to the given time. */
72 void seek(GenTime time);
73 void seekToFrame(int pos);
75 static QPixmap getVideoThumbnail(char *profile, QString file, int frame, int width, int height);
76 QPixmap getImageThumbnail(KUrl url, int width, int height);
78 /** Return thumbnail for color clip */
79 //void getImage(int id, QString color, QPoint size);
81 static QPixmap frameThumbnail(Mlt::Frame *frame, int width, int height, bool border = false);
83 /** Return thumbnail for image clip */
84 //void getImage(KUrl url, QPoint size);
86 /** Requests a particular frame from the given file.
88 * The pixmap will be returned by emitting the replyGetImage() signal.
90 //void getImage(KUrl url, int frame, QPoint size);
93 /** Wraps the VEML command of the same name. Sets the current scene list to
95 void setSceneList(QDomDocument list, int position = 0);
96 void setSceneList(QString playlist, int position = 0);
99 /** Wraps the VEML command of the same name. Tells the renderer to
100 play the current scene at the speed specified, relative to normal
101 playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
102 backwards. Does not specify start/stop times for playback.*/
103 void play(double speed);
106 void stop(const GenTime & startTime);
107 void setVolume(double volume);
109 QPixmap extractFrame(int frame_position, int width, int height);
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(double speed, const GenTime & startTime);
115 void play(double speed, const GenTime & startTime,
116 const GenTime & stopTime);
117 /** Wraps the VEML command of the same name - render the currently
118 specified sceneList - set with setSceneList() - to the document
120 void render(const KUrl & url);
122 /** Returns the description of this renderer */
123 QString description();
125 /** Returns the name of the renderer. */
126 const QString & rendererName() const;
128 /** Returns the speed at which the renderer is currently playing, 0.0 if the renderer is
129 not playing anything. */
131 /** Returns the current seek position of the renderer. */
132 const GenTime & seekPosition() const;
134 void emitFrameNumber(double position);
135 void emitConsumerStopped();
137 /** Gives the aspect ratio of the consumer */
138 double consumerRatio() const;
140 void askForRefresh();
143 /** Save current producer frame as image */
144 void exportCurrentFrame(KUrl url, bool notify);
146 /** Turn on or off on screen display */
147 void refreshDisplay();
148 int resetProfile(QString profile);
149 const double fps() const;
151 /** Playlist manipulation */
152 void mltInsertClip(int track, GenTime position, QDomElement element);
153 void mltCutClip(int track, GenTime position);
154 void mltResizeClipEnd(int track, GenTime pos, GenTime in, GenTime out);
155 void mltResizeClipStart(int track, GenTime pos, GenTime moveEnd, GenTime moveStart, GenTime in, GenTime out);
156 void mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart);
157 void mltMoveClip(int startTrack, int endTrack, int pos, int moveStart);
158 void mltRemoveClip(int track, GenTime position);
159 void mltRemoveEffect(int track, GenTime position, QString index, bool doRefresh = true);
160 void mltAddEffect(int track, GenTime position, QMap <QString, QString> args, bool doRefresh = true);
161 void mltEditEffect(int track, GenTime position, QMap <QString, QString> args);
162 void mltChangeTrackState(int track, bool mute, bool blind);
163 void mltMoveTransition(QString type, int startTrack, int trackOffset, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
164 void mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QMap <QString, QString> args);
167 private: // Private attributes & methods
168 /** The name of this renderer - useful to identify the renderes by what they do - e.g. background rendering, workspace monitor, etc... */
170 Mlt::Consumer * m_mltConsumer;
171 Mlt::Producer * m_mltProducer;
172 Mlt::Producer *m_mltTextProducer;
173 Mlt::Filter *m_osdInfo;
174 Mlt::Profile *m_mltProfile;
175 double m_framePosition;
178 bool m_generateScenelist;
181 /** Holds the path to on screen display profile */
182 QString m_osdProfile;
184 QTimer *refreshTimer;
186 QTimer *m_connectTimer;
188 int exportDuration, firstExportFrame, lastExportFrame;
190 /** A human-readable description of this renderer. */
191 QString m_description;
194 /** The actually seek command, private so people can't avoid the buffering of multiple seek commands. */
195 void sendSeekCommand(GenTime time);
197 /** Sets the description of this renderer to desc. */
198 void setDescription(const QString & description);
200 void mltCheckLength();
202 private slots: // Private slots
203 /** refresh monitor display */
205 void slotOsdTimeout();
206 void connectPlaylist();
207 void initSceneList();
210 /** emitted when the renderer recieves a reply to a getFileProperties request. */
211 void replyGetFileProperties(int clipId, const QMap < QString, QString > &, const QMap < QString, QString > &);
213 /** emitted when the renderer recieves a reply to a getImage request. */
214 void replyGetImage(int , int, const QPixmap &, int, int);
215 void replyGetImage(int, const QPixmap &, int, int);
217 /** Emitted when the renderer stops, either playing or rendering. */
219 /** Emitted when the renderer starts playing. */
220 void playing(double);
221 /** Emitted when the renderer is rendering. */
222 void rendering(const GenTime &);
223 /** Emitted when rendering has finished */
224 void renderFinished();
225 /** Emitted when the current seek position has been changed by the renderer. */
226 // void positionChanged(const GenTime &);
227 /** Emitted when an error occurs within this renderer. */
228 void error(const QString &, const QString &);
229 void durationChanged(int);
230 void rendererPosition(int);
231 void rendererStopped(int);
234 public slots: // Public slots
235 /** Start Consumer */
241 /** If the file is readable by mlt, return true, otherwise false */
242 bool isValid(KUrl url);
244 /** Wraps the VEML command of the same name. Requests the file properties
245 for the specified url from the renderer. Upon return, the result will be emitted
246 via replyGetFileProperties(). */
247 void getFileProperties(const QDomElement &xml, int clipId);
249 void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
250 static char *decodedString(QString str);
251 void mltSavePlaylist();