krender.h - description
-------------------
begin : Fri Nov 22 2002
- 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)
+
***************************************************************************/
/***************************************************************************
* *
***************************************************************************/
-#ifndef KRENDER_H
-#define KRENDER_H
+/**
+ * @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.
+ */
+
+#ifndef RENDERER_H
+#define RENDERER_H
+
+#include "gentime.h"
+#include "definitions.h"
+#include "mlt/framework/mlt_types.h"
+
+#include <kurl.h>
#include <qdom.h>
#include <qstring.h>
#include <qmap.h>
#include <QList>
-#include <QWidget>
-
-#include <kurl.h>
-
-#include "gentime.h"
-#include "definitions.h"
+#include <QEvent>
-/**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 recieve the return value through the
-relevant signal that get's emitted once the call completes.
- *@author Jason Wood
- */
class Render;
-//class EffectParamDesc;
+
+class QTimer;
class QPixmap;
-namespace Mlt {
+namespace Mlt
+{
class Consumer;
class Playlist;
class Tractor;
+class Transition;
class Frame;
+class Field;
class Producer;
class Filter;
class Profile;
-class Multitrack;
+class Service;
};
+class MltErrorEvent : public QEvent
+{
+public:
+ MltErrorEvent(QString message) : QEvent(QEvent::User), m_message(message) {}
+ QString message() const {
+ return m_message;
+ }
+private:
+ QString m_message;
+};
-class Render: public QObject {
+class Render: public QObject
+{
Q_OBJECT public:
enum FailStates { OK = 0,
APP_NOEXIST
};
+ /** @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);
- Render(const QString & rendererName, int winid, int extid, QWidget *parent = 0);
+ /** @brief Destroy the MLT Renderer. */
~Render();
- /** Seeks the renderer clip to the given time. */
+ /** @brief Seeks the renderer clip to the given time. */
void seek(GenTime time);
+ void seek(int time);
void seekToFrame(int pos);
- bool m_isBlocked;
+ void seekToFrameDiff(int diff);
+ int m_isBlocked;
- //static QPixmap getVideoThumbnail(char *profile, QString file, int frame, int width, int height);
QPixmap getImageThumbnail(KUrl url, int width, int height);
- /** Return thumbnail for color clip */
- //void getImage(int id, QString color, 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);
- // static QPixmap frameThumbnail(Mlt::Frame *frame, int width, int height, bool border = false);
+ /** @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
+ *
+ * Creates the producer from the text playlist. */
+ int setSceneList(QString playlist, int position = 0);
+ int setProducer(Mlt::Producer *producer, int position);
- /** Return thumbnail for image clip */
- //void getImage(KUrl url, QPoint size);
+ /** @brief Get the current MLT producer playlist.
+ * @return A string describing the playlist */
+ const QString sceneList();
+ bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
- /** Requests a particular frame from the given file.
+ /** @brief Tells the renderer to play the scene at the specified speed,
+ * @param speed speed to play the scene to
*
- * 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. */
- void setSceneList(QDomDocument list, int position = 0);
- void setSceneList(QString playlist, int position = 0);
- void setProducer(Mlt::Producer *producer, int position);
- QString sceneList();
- void 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.*/
+ * 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 */
void play(double speed);
void switchPlay();
- /** stop playing */
+ void pause();
+
+ /** @brief Stops playing.
+ * @param startTime time to seek to */
void stop(const GenTime & startTime);
- void setVolume(double volume);
+ int volume() const;
+
+ QImage extractFrame(int frame_position, int width = -1, int height = -1);
- QPixmap extractFrame(int frame_position, int width = -1, int height = -1);
- /** 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);
- /** Returns the name of the renderer. */
+ void saveZone(KUrl url, QString desc, QPoint zone);
+
+ /** @brief Returns the name of the renderer. */
const QString & rendererName() const;
- /** 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. */
double playSpeed();
- /** Returns the current seek position of the renderer. */
+
+ /** @brief Returns the current seek position of the renderer. */
GenTime seekPosition() const;
+ int seekFramePosition() const;
+ void emitFrameUpdated(Mlt::Frame&);
void emitFrameNumber(double position);
void emitConsumerStopped();
- /** Gives the aspect ratio of the consumer */
+ /** @brief Returns the aspect ratio of the consumer. */
double consumerRatio() const;
- void askForRefresh();
void doRefresh();
- /** Save current producer frame as image */
+ /** @brief Saves current producer frame as an image. */
void exportCurrentFrame(KUrl url, bool notify);
- /** Turn on or off on screen display */
+ /** @brief Turns on or off on screen display. */
void refreshDisplay();
- int resetProfile();
- const double fps() const;
- const int renderWidth() const;
- const int renderHeight() const;
- /** get display aspect ratio */
- const double dar() const;
-
- /** Playlist manipulation */
- void mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
- void mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
+ int resetProfile(const QString profileName);
+ double fps() const;
+
+ /** @brief Returns the width of a frame for this profile. */
+ int frameRenderWidth() const;
+ /** @brief Returns the display width of a frame for this profile. */
+ int renderWidth() const;
+ /** @brief Returns the height of a frame for this profile. */
+ int renderHeight() const;
+
+ /** @brief Returns display aspect ratio. */
+ double dar() const;
+ /** @brief Returns sample aspect ratio. */
+ double sar() const;
+
+ /*
+ * Playlist manipulation.
+ */
+ Mlt::Producer *checkSlowMotionProducer(Mlt::Producer *prod, QDomElement element);
+ 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);
+
+ /** @brief Returns the duration/length of @param track as reported by the track producer. */
+ int mltTrackDuration(int track);
+
bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
bool mltResizeClipStart(ItemInfo info, GenTime diff);
- bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart);
- bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart);
+ 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 doRefresh = true);
- bool mltAddEffect(int track, GenTime position, QHash <QString, QString> args, bool doRefresh = true);
- bool mltEditEffect(int track, GenTime position, QHash <QString, QString> args);
+
+ /** @brief Deletes an effect from a clip in MLT's playlist. */
+ bool mltRemoveEffect(int track, GenTime position, QString index, bool updateIndex, bool doRefresh = true);
+ bool mltRemoveTrackEffect(int track, QString index, bool updateIndex);
+
+ /** @brief Adds an effect to a clip in MLT's playlist. */
+ bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
+ 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. */
+ bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
+ bool mltEditTrackEffect(int track, EffectsParameterList params);
+
+ /** @brief Updates the "kdenlive_ix" (index) value of an effect. */
+ void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
+
+ /** @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 mltMoveTrackEffect(int track, int oldPos, int newPos);
+
+ /** @brief Enables/disables audio/video in a track. */
void mltChangeTrackState(int track, bool mute, bool blind);
- void mltMoveTransition(QString type, int startTrack, int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
- void mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
+ 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 mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
- void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
+ void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool force = false);
void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
void mltDeleteTransparency(int pos, int track, int id);
void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
+ void mltInsertTrack(int ix, bool videoTrack);
+ void mltDeleteTrack(int ix);
+ bool mltUpdateClipProducer(int track, int pos, Mlt::Producer *prod);
+ 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 */
- int mltChangeClipSpeed(ItemInfo info, double speed, Mlt::Producer *prod);
-
-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... */
+ /** @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);
+ void showFrame(Mlt::Frame&);
+
+ 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;
+ QList <int> checkTrackSequence(int);
+ void sendFrameUpdate();
+
+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::Producer *m_mltTextProducer;
- Mlt::Filter *m_osdInfo;
Mlt::Profile *m_mltProfile;
double m_framePosition;
double m_fps;
+ bool m_externalConsumer;
- /** true if we are playing a zone (ie the in and out properties have been temporarily changed) */
+ /** @brief True if we are playing a zone.
+ *
+ * It's determined by the "in" and "out" properties being temporarily
+ * changed. */
bool m_isZoneMode;
bool m_isLoopMode;
GenTime m_loopStart;
+ int m_originalOut;
- /** true when monitor is in split view (several tracks at the same time) */
+ /** @brief True when the monitor is in split view. */
bool m_isSplitView;
Mlt::Producer *m_blackClip;
- /** Holds the path to on screen display profile */
- QString m_osdProfile;
+ QString m_activeProfile;
- QTimer *refreshTimer;
- QTimer *osdTimer;
- KUrl m_exportedFile;
+ QTimer *m_osdTimer;
- /** A human-readable description of this renderer. */
+ /** @brief A human-readable description of this renderer. */
int m_winid;
- int m_externalwinid;
- /** Sets the description of this renderer to desc. */
void closeMlt();
- void mltCheckLength(bool reload = true);
+ 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 buildConsumer();
+
+ /** @brief Build the MLT Consumer object with initial settings.
+ * @param profileName The MLT profile to use for the consumer */
+ void buildConsumer(const QString profileName);
void resetZoneMode();
+ void fillSlowMotionProducers();
+
+private slots:
-private slots: // Private slots
- /** refresh monitor display */
+ /** @brief Refreshes the monitor display. */
void refresh();
void slotOsdTimeout();
- void connectPlaylist();
+ int connectPlaylist();
//void initSceneList();
-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 > &);
+signals:
- /** emitted when the renderer recieves a reply to a getImage request. */
- void replyGetImage(const QString & , int, const QPixmap &, int, int);
- void replyGetImage(const QString &, const QPixmap &, int, int);
+ /** @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);
- /** Emitted when the renderer stops, either playing or rendering. */
+ /** @brief The renderer received a reply to a getImage request. */
+ void replyGetImage(const QString &, const QPixmap &);
+
+ /** @brief The renderer stopped, either playing or rendering. */
void stopped();
- /** Emitted when the renderer starts playing. */
+
+ /** @brief The renderer started playing. */
void playing(double);
- /** Emitted when the renderer is rendering. */
+
+ /** @brief The renderer started rendering. */
void rendering(const GenTime &);
- /** Emitted when rendering has finished */
+
+ /** @brief The rendering has finished.
+ @see consumer_frame_show
+ This signal seems to be useless; use renderPosition(int) instead --Granjow */
void renderFinished();
- /** 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 &);
+ /** @brief The clip is not valid, should be removed from project. */
+ void removeInvalidClip(const QString &, bool replaceProducer);
+ /** @brief The proxy is not valid, should be deleted. */
+ void removeInvalidProxy(const QString &);
+ void refreshDocumentProducers();
-public slots: // Public slots
- /** Start Consumer */
+ /** @brief A frame's image has to be shown.
+ *
+ * Used in Mac OS X. */
+ void showImageSignal(QImage);
+ 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);
+
+public slots:
+
+ /** @brief Starts the consumer. */
void start();
- /** Stop Consumer */
+
+ /** @brief Stops the consumer. */
void stop();
- void clear();
int getLength();
- /** If the file is readable by mlt, return true, otherwise false */
+
+ /** @brief Checks if the file is readable by MLT. */
bool isValid(KUrl url);
- /** 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);
+ /** @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);
- static char *decodedString(QString str);
void mltSavePlaylist();
void slotSplitView(bool doit);
+ void slotSwitchFullscreen();
+ void slotSetVolume(int volume);
};
#endif
projects / kdenlive / blobdiff