- copyright : (C) 2002 by Jason Wood
- email : jasonwood@blueyonder.co.uk
+ copyright : (C) 2002 by Jason Wood (jasonwood@blueyonder.co.uk)
+ copyright : (C) 2010 by Jean-Baptiste Mardelle (jb@kdenlive.org)
+
***************************************************************************/
/***************************************************************************
***************************************************************************/
/***************************************************************************
+/**
+ * @class Render
+ * @brief Client side of the interface to a renderer.
+ *
+ * From Kdenlive's point of view, you treat the Render object as the renderer,
+ * and simply use it as if it was local. Calls are asynchronous - you send a
+ * call out, and then receive the return value through the relevant signal that
+ * get's emitted once the call completes.
+ */
+
-#ifdef Q_WS_MAC
-#include "videoglwidget.h"
-#endif
-
-
-/**Render encapsulates the client side of the interface to a renderer.
-From Kdenlive's point of view, you treat the Render object as the
-renderer, and simply use it as if it was local. Calls are asyncrhonous -
-you send a call out, and then receive the return value through the
-relevant signal that get's emitted once the call completes.
- *@author Jason Wood
- */
+ /** @brief Build a MLT Renderer
+ * @param rendererName A unique identifier for this renderer
+ * @param winid The parent widget identifier (required for SDL display). Set to 0 for OpenGL rendering
+ * @param profile The MLT profile used for the renderer (default one will be used if empty). */
+ Render(const QString & rendererName, int winid, QString profile = QString(), QWidget *parent = 0);
- /** Return thumbnail for color clip */
- //void getImage(int id, QString color, QPoint size);
-
- // static QPixmap frameThumbnail(Mlt::Frame *frame, int width, int height, bool border = false);
-
- /** Return thumbnail for image clip */
- //void getImage(KUrl url, QPoint size);
+ /** @brief Sets the current MLT producer playlist.
+ * @param list The xml describing the playlist
+ * @param position (optional) time to seek to */
+ int setSceneList(QDomDocument list, int position = 0);
- /** Requests a particular frame from the given file.
+ /** @brief Sets the current MLT producer playlist.
+ * @param list new playlist
+ * @param position (optional) time to seek to
+ * @return 0 when it has success, different from 0 otherwise
- * The pixmap will be returned by emitting the replyGetImage() signal.
- * */
- //void getImage(KUrl url, int frame, QPoint size);
-
-
- /** Wraps the VEML command of the same name. Sets the current scene list to
- be list. */
- int setSceneList(QDomDocument list, int position = 0);
+ * Creates the producer from the text playlist. */
int setSceneList(QString playlist, int position = 0);
int setProducer(Mlt::Producer *producer, int position);
int setSceneList(QString playlist, int position = 0);
int setProducer(Mlt::Producer *producer, int position);
const QString sceneList();
bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
const QString sceneList();
bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
- /** Wraps the VEML command of the same name. Tells the renderer to
- play the current scene at the speed specified, relative to normal
- playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
- backwards. Does not specify start/stop times for playback.*/
+ /** @brief Tells the renderer to play the scene at the specified speed,
+ * @param speed speed to play the scene to
+ *
+ * The speed is relative to normal playback, e.g. 1.0 is normal speed, 0.0
+ * is paused, -1.0 means play backwards. It does not specify start/stop */
- /** Wraps the VEML command of the same name. Tells the renderer to
- play the current scene at the speed specified, relative to normal
- playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
- backwards. Specifes the start/stop times for playback.*/
+
+ /** @brief Plays the scene starting from a specific time.
+ * @param startTime time to start playing the scene from */
void play(const GenTime & startTime);
void playZone(const GenTime & startTime, const GenTime & stopTime);
void loopZone(const GenTime & startTime, const GenTime & stopTime);
void saveZone(KUrl url, QString desc, QPoint zone);
void play(const GenTime & startTime);
void playZone(const GenTime & startTime, const GenTime & stopTime);
void loopZone(const GenTime & startTime, const GenTime & stopTime);
void saveZone(KUrl url, QString desc, QPoint zone);
- /** Returns the speed at which the renderer is currently playing, 0.0 if the renderer is
- not playing anything. */
+ /** @brief Returns the speed at which the renderer is currently playing.
+ *
+ * It returns 0.0 when the renderer is not playing anything. */
int mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod, bool overwrite = false, bool push = false);
bool mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
void mltCutClip(int track, GenTime position);
void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime duration, const GenTime timeOffset);
int mltGetSpaceLength(const GenTime pos, int track, bool fromBlankStart);
int mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod, bool overwrite = false, bool push = false);
bool mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
void mltCutClip(int track, GenTime position);
void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime duration, const GenTime timeOffset);
int mltGetSpaceLength(const GenTime pos, int track, bool fromBlankStart);
bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
bool mltResizeClipStart(ItemInfo info, GenTime diff);
bool mltResizeClipCrop(ItemInfo info, GenTime diff);
bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
bool mltRemoveClip(int track, GenTime position);
bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
bool mltResizeClipStart(ItemInfo info, GenTime diff);
bool mltResizeClipCrop(ItemInfo info, GenTime diff);
bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
bool mltRemoveClip(int track, GenTime position);
bool mltRemoveEffect(int track, GenTime position, QString index, bool updateIndex, bool doRefresh = true);
bool mltRemoveEffect(int track, GenTime position, QString index, bool updateIndex, bool doRefresh = true);
bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
- /** Edit an effect parameters in MLT */
+ bool mltAddEffect(Mlt::Service service, EffectsParameterList params, int duration, bool doRefresh);
+ bool mltAddTrackEffect(int track, EffectsParameterList params);
+
+ /** @brief Edits an effect parameters in MLT's playlist. */
void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
- /** This changes the order of effects in MLT, inverting effects from oldPos and newPos, also updating the kdenlive_ix value */
+
+ /** @brief Changes the order of effects in MLT's playlist.
+ *
+ * It switches effects from oldPos and newPos, updating the "kdenlive_ix"
+ * (index) value. */
void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
- /** This changes the state of a track, enabling / disabling audio and video */
+ void mltMoveTrackEffect(int track, int oldPos, int newPos);
+
+ /** @brief Enables/disables audio/video in a track. */
void mltChangeTrackState(int track, bool mute, bool blind);
bool mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
void mltChangeTrackState(int track, bool mute, bool blind);
bool mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
void mltPlantTransition(Mlt::Field *field, Mlt::Transition &tr, int a_track, int b_track);
Mlt::Producer *invalidProducer(const QString &id);
void mltPlantTransition(Mlt::Field *field, Mlt::Transition &tr, int a_track, int b_track);
Mlt::Producer *invalidProducer(const QString &id);
- /** Change speed of a clip in playlist. To do this, we create a new "framebuffer" producer.
- This new producer must have its "resource" param set to: video.mpg?0.6 where video.mpg is the path
- to the clip and 0.6 is the speed in percents. The newly created producer will have it's
- "id" parameter set to: "slowmotion:parentid:speed", where parentid is the id of the original clip
- in the ClipManager list and speed is the current speed */
+ /** @brief Changes the speed of a clip in MLT's playlist.
+ *
+ * It creates a new "framebuffer" producer, which must have its "resource"
+ * property set to "video.mpg?0.6", where "video.mpg" is the path to the
+ * clip and "0.6" is the speed in percentage. The newly created producer
+ * will have its "id" property set to "slowmotion:parentid:speed", where
+ * "parentid" is the id of the original clip in the ClipManager list and
+ * "speed" is the current speed. */
int mltChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, double speed, double oldspeed, int strobe, Mlt::Producer *prod);
const QList <Mlt::Producer *> producersList();
void updatePreviewSettings();
void setDropFrames(bool show);
QString updateSceneListFps(double current_fps, double new_fps, QString scene);
int mltChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, double speed, double oldspeed, int strobe, Mlt::Producer *prod);
const QList <Mlt::Producer *> producersList();
void updatePreviewSettings();
void setDropFrames(bool show);
QString updateSceneListFps(double current_fps, double new_fps, QString scene);
+
+ void showAudio(Mlt::Frame&);
+ /** @brief This property is used to decide if the renderer should send audio data for monitoring. */
+ bool analyseAudio;
+ /** @brief This property is used to decide if the renderer should convert it's frames to QImage for use in other Kdenlive widgets. */
+ bool sendFrameForAnalysis;
-private: // Private attributes & methods
- /** The name of this renderer - useful to identify the renderes by what they do - e.g. background rendering, workspace monitor, etc... */
+private:
+
+ /** @brief The name of this renderer.
+ *
+ * Useful to identify the renderers by what they do - e.g. background
+ * rendering, workspace monitor, etc. */
QString m_name;
Mlt::Consumer * m_mltConsumer;
Mlt::Producer * m_mltProducer;
Mlt::Profile *m_mltProfile;
double m_framePosition;
double m_fps;
QString m_name;
Mlt::Consumer * m_mltConsumer;
Mlt::Producer * m_mltProducer;
Mlt::Profile *m_mltProfile;
double m_framePosition;
double m_fps;
void closeMlt();
void mltCheckLength(Mlt::Tractor *tractor);
void mltPasteEffects(Mlt::Producer *source, Mlt::Producer *dest);
QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
QMap<QString, Mlt::Producer *> m_slowmotionProducers;
void closeMlt();
void mltCheckLength(Mlt::Tractor *tractor);
void mltPasteEffects(Mlt::Producer *source, Mlt::Producer *dest);
QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
QMap<QString, Mlt::Producer *> m_slowmotionProducers;
-signals: // Signals
- /** emitted when the renderer recieves a reply to a getFileProperties request. */
- void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &, bool);
- /** emitted when the renderer recieves a reply to a getImage request. */
+ /** @brief The renderer received a reply to a getFileProperties request. */
+ void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &, bool, bool);
+
+ /** @brief The renderer received a reply to a getImage request. */
- /** Emitted when the current seek position has been changed by the renderer. */
-// void positionChanged(const GenTime &);
- /** Emitted when an error occurs within this renderer. */
+
+ /* @brief The current seek position has been changed by the renderer.
+ void positionChanged(const GenTime &);*/
+
+ /** @brief An error occurred within this renderer. */
void error(const QString &, const QString &);
void durationChanged(int);
void rendererPosition(int);
void rendererStopped(int);
void removeInvalidClip(const QString &, bool replaceProducer);
void refreshDocumentProducers();
void error(const QString &, const QString &);
void durationChanged(int);
void rendererPosition(int);
void rendererStopped(int);
void removeInvalidClip(const QString &, bool replaceProducer);
void refreshDocumentProducers();
+ void showAudioSignal(const QByteArray);
+ /** @brief The renderer refreshed the current frame, but no seeking was done. */
+ void frameUpdated(QImage);
+ /** @brief This signal contains the audio of the current frame. */
+ void audioSamplesSignal(const QVector<int16_t>&, int freq, int num_channels, int num_samples);
- /** Wraps the VEML command of the same name. Requests the file properties
- for the specified url from the renderer. Upon return, the result will be emitted
- via replyGetFileProperties(). */
- void getFileProperties(const QDomElement xml, const QString &clipId, int imageHeight, bool replaceProducer = true);
+ /** @brief Requests the file properties for the specified URL.
+ @param xml The xml parameters for the clip
+ @param clipId The clip Id string
+ @param imageHeight The height (in pixels) of the returned thumbnail (height of a treewidgetitem in projectlist)
+ @param replaceProducer If true, the MLT producer will be recreated
+ @param selectClip If true, clip item will be selected in project view
+ * Upon return, the result will be emitted via replyGetFileProperties().
+ * Wraps the VEML command of the same name. */
+ void getFileProperties(const QDomElement xml, const QString &clipId, int imageHeight, bool replaceProducer = true, bool selectClip = false);
void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);