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)
+
***************************************************************************/
/***************************************************************************
/**
* @class Render
- * @author Jason Wood
* @brief Client side of the interface to a renderer.
*
* From Kdenlive's point of view, you treat the Render object as the renderer,
#include "gentime.h"
#include "definitions.h"
+#include "abstractmonitor.h"
+
+#include <mlt/framework/mlt_types.h>
#include <kurl.h>
#include <qmap.h>
#include <QList>
#include <QEvent>
-
-#ifdef Q_WS_MAC
-#include "videoglwidget.h"
-#endif
-
-class Render;
+#include <QMutex>
+#include <QFuture>
class QTimer;
class QPixmap;
+class KComboBox;
+
namespace Mlt
{
class Consumer;
class Filter;
class Profile;
class Service;
+class Event;
+};
+
+struct requestClipInfo {
+ QDomElement xml;
+ QString clipId;
+ int imageHeight;
+ bool replaceProducer;
+
+bool operator==(const requestClipInfo &a)
+{
+ return clipId == a.clipId;
+}
};
class MltErrorEvent : public QEvent
QString m_message;
};
-class Render: public QObject
+
+class Render: public AbstractRender
{
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(Kdenlive::MONITORID rendererName, int winid, QString profile = QString(), QWidget *parent = 0);
- Render(const QString & rendererName, int winid, int extid, QString profile = QString(), QWidget *parent = 0);
- ~Render();
+ /** @brief Destroy the MLT Renderer. */
+ virtual ~Render();
/** @brief Seeks the renderer clip to the given time. */
void seek(GenTime time);
- void seekToFrame(int pos);
+ void seek(int time);
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);*/
-
- // static QPixmap frameThumbnail(Mlt::Frame *frame, int width, int height, bool border = false);
-
- /* Return thumbnail for image clip
- void getImage(KUrl url, QPoint size);*/
-
- /* Requests a particular frame from the given file.
- *
- * The pixmap will be returned by emitting the replyGetImage() signal.
- void getImage(KUrl url, int frame, 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);
- /** @brief Sets the current scene list.
- * @param list new scene list
+ /** @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 MLT XML QDomDocument. Wraps the VEML
- * command of the same name. */
+ * Creates the producer from the text playlist. */
int setSceneList(QString playlist, int position = 0);
int setProducer(Mlt::Producer *producer, int position);
+
+ /** @brief Get the current MLT producer playlist.
+ * @return A string describing the playlist */
const QString sceneList();
bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
* @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
- * times for playback. Wraps the VEML command of the same name. */
+ * is paused, -1.0 means play backwards. It does not specify start/stop */
void play(double speed);
- void switchPlay();
+ void switchPlay(bool play);
void pause();
/** @brief Stops playing.
* @param startTime time to seek to */
- void stop(const GenTime & startTime);
- void setVolume(double volume);
+ void stop(const GenTime &startTime);
+ int volume() const;
- QImage extractFrame(int frame_position, int width = -1, int height = -1);
+ QImage extractFrame(int frame_position, QString path = QString(), int width = -1, int height = -1);
/** @brief Plays the scene starting from a specific time.
- * @param startTime time to start playing the scene from
- *
- * Wraps the VEML command of the same name. */
+ * @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);
-
- /** @brief Returns the name of the renderer. */
- const QString & rendererName() const;
+
+ /** @brief Save a clip in timeline to an xml playlist. */
+ bool saveClip(int track, GenTime position, KUrl url, QString desc = QString());
/** @brief Returns the speed at which the renderer is currently playing.
*
* It returns 0.0 when the renderer is not playing anything. */
- double playSpeed();
+ double playSpeed() const;
/** @brief Returns the current seek position of the renderer. */
GenTime seekPosition() const;
int seekFramePosition() const;
void emitFrameUpdated(Mlt::Frame&);
- void emitFrameNumber(double position);
+ void emitFrameNumber();
void emitConsumerStopped();
/** @brief Returns the aspect ratio of the consumer. */
double consumerRatio() const;
- void doRefresh();
-
/** @brief Saves current producer frame as an image. */
void exportCurrentFrame(KUrl url, bool notify);
- /** @brief Turns on or off on screen display. */
- void refreshDisplay();
- int resetProfile(const QString profileName);
+ /** @brief Change the Mlt PROFILE
+ * @param profileName The MLT profile name
+ * @param dropSceneList If true, the current playlist will be deleted
+ * @return true if the profile was changed
+ * . */
+ int resetProfile(const QString& profileName, bool dropSceneList = false);
+ /** @brief Returns true if the render uses profileName as current profile. */
+ bool hasProfile(const QString& profileName) const;
double fps() const;
/** @brief Returns the width of a frame for this profile. */
/** @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);
+ bool mltUpdateClip(Mlt::Tractor *tractor, 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);
+ 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 mltResizeClipCrop(ItemInfo info, GenTime diff);
+ bool mltResizeClipCrop(ItemInfo info, GenTime newCropStart);
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);
/** @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);
+ bool mltRemoveEffect(int track, GenTime position, int index, bool updateIndex, bool doRefresh = true);
+ bool mltRemoveTrackEffect(int track, int 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 addFilterToService(Mlt::Service service, EffectsParameterList params, int duration);
bool mltAddEffect(Mlt::Service service, EffectsParameterList params, int duration, bool doRefresh);
bool mltAddTrackEffect(int track, EffectsParameterList params);
+
+ /** @brief Enable / disable clip effects.
+ * @param track The track where the clip is
+ * @param position The start position of the clip
+ * @param effectIndexes The list of effect indexes to enable / disable
+ * @param disable True if effects should be disabled, false otherwise */
+ bool mltEnableEffects(int track, GenTime position, QList <int> effectIndexes, bool disable);
+ /** @brief Enable / disable track effects.
+ * @param track The track where the effect is
+ * @param effectIndexes The list of effect indexes to enable / disable
+ * @param disable True if effects should be disabled, false otherwise */
+ bool mltEnableTrackEffects(int track, QList <int> effectIndexes, bool disable);
/** @brief Edits an effect parameters in MLT's playlist. */
bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
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);
+ QList <TransitionInfo> mltInsertTrack(int ix, bool videoTrack);
void mltDeleteTrack(int ix);
- bool mltUpdateClipProducer(int track, int pos, Mlt::Producer *prod);
+ bool mltUpdateClipProducer(Mlt::Tractor *tractor, 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);
void updatePreviewSettings();
void setDropFrames(bool show);
QString updateSceneListFps(double current_fps, double new_fps, QString scene);
-#ifdef Q_WS_MAC
void showFrame(Mlt::Frame&);
-#endif
- /** @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;
+
+ void showAudio(Mlt::Frame&);
+
QList <int> checkTrackSequence(int);
void sendFrameUpdate();
+ /** @brief Returns a pointer to the main producer. */
+ Mlt::Producer *getProducer();
+ /** @brief Returns the number of clips to process (When requesting clip info). */
+ int processingItems();
+ /** @brief Force processing of clip with selected id. */
+ void forceProcessing(const QString &id);
+ /** @brief Are we currently processing clip with selected id. */
+ bool isProcessing(const QString &id);
+
+ /** @brief Requests the file properties for the specified URL (will be put in a queue list)
+ @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 */
+ void getFileProperties(const QDomElement &xml, const QString &clipId, int imageHeight, bool replaceProducer = true);
+
+ /** @brief Lock the MLT service */
+ Mlt::Tractor *lockService();
+ /** @brief Unlock the MLT service */
+ void unlockService(Mlt::Tractor *tractor);
+ const QString activeClipId();
+ /** @brief Fill a combobox with the found blackmagic devices */
+ static bool getBlackMagicDeviceList(KComboBox *devicelist);
+ static bool getBlackMagicOutputDeviceList(KComboBox *devicelist);
+ /** @brief Frame rendering is handeled by Kdenlive, don't show video through SDL display */
+ void disablePreview(bool disable);
+
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;
+ Kdenlive::MONITORID m_name;
Mlt::Consumer * m_mltConsumer;
Mlt::Producer * m_mltProducer;
Mlt::Profile *m_mltProfile;
- double m_framePosition;
+ Mlt::Event *m_showFrameEvent;
+ Mlt::Event *m_pauseEvent;
double m_fps;
+ bool m_externalConsumer;
/** @brief True if we are playing a zone.
*
QString m_activeProfile;
QTimer *m_osdTimer;
+ QTimer m_refreshTimer;
+ QMutex m_mutex;
+ QMutex m_infoMutex;
/** @brief A human-readable description of this renderer. */
int m_winid;
-#ifdef Q_WS_MAC
- VideoGLWidget *m_glWidget;
-#endif
+ QLocale m_locale;
+ QFuture <void> m_infoThread;
+ QList <requestClipInfo> m_requestList;
+
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 buildConsumer(const QString profileName);
+ /** @brief The id of the clip that is currently being loaded for info query */
+ QString m_processingClipId;
+
+ /** @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();
+ /** @brief Get the track number of the lowest audible (non muted) audio track
+ * @param return The track number */
+ int getLowestNonMutedAudioTrack(Mlt::Tractor tractor);
+
+ /** @brief Make sure our audio mixing transitions are applied to the lowest track */
+ void fixAudioMixing(Mlt::Tractor tractor);
+ /** @brief Make sure we inform MLT if we need a lot of threads for avformat producer */
+ void checkMaxThreads();
private slots:
/** @brief Refreshes the monitor display. */
void refresh();
void slotOsdTimeout();
- int connectPlaylist();
- //void initSceneList();
+ /** @brief Process the clip info requests (in a separate thread). */
+ void processFileProperties();
signals:
/** @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);
+ void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const stringMap &, const stringMap &, bool replaceProducer);
/** @brief The renderer received a reply to a getImage request. */
- void replyGetImage(const QString &, const QPixmap &);
+ void replyGetImage(const QString &, const QString &, int, int);
+ void replyGetImage(const QString &, const QImage &);
/** @brief The renderer stopped, either playing or rendering. */
void stopped();
/** @brief The renderer started rendering. */
void rendering(const GenTime &);
- /** @brief The rendering has finished.
- @see consumer_frame_show
- This signal seems to be useless; use renderPosition(int) instead --Granjow */
- void renderFinished();
-
- /* @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);
+ /** @brief The clip is not valid, should be removed from project. */
void removeInvalidClip(const QString &, bool replaceProducer);
- void refreshDocumentProducers();
+ /** @brief The proxy is not valid, should be deleted.
+ * @param id The original clip's id
+ * @param durationError Should be set to true if the proxy failed because it has not same length as original clip
+ */
+ void removeInvalidProxy(const QString &id, bool durationError);
+ void refreshDocumentProducers(bool displayRatioChanged, bool fpsChanged);
+ /** @brief A proxy clip is missing, ask for creation. */
+ void requestProxy(QString);
+
/** @brief A frame's image has to be shown.
*
* Used in Mac OS X. */
void showImageSignal(QImage);
- /** @brief The renderer refreshed the current frame, but no seeking was done. */
- void frameUpdated(QImage);
+ void showAudioSignal(const QByteArray &);
public slots:
/** @brief Checks if the file is readable by MLT. */
bool isValid(KUrl url);
- /** @brief Requests the file properties for the specified URL.
- *
- * 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);
-
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);
+ void seekToFrame(int pos);
+ /** @brief Starts a timer to query for a refresh. */
+ void doRefresh();
};
#endif