git.sesse.net Git - kdenlive/blob - src/renderer.h

   1 /***************************************************************************
   2                          krender.h  -  description
   3                             -------------------
   4    begin                : Fri Nov 22 2002
   5    copyright            : (C) 2002 by Jason Wood
   6    email                : jasonwood@blueyonder.co.uk
   7 ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  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.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 /**
  19  * @class Render
  20  * @author Jason Wood
  21  * @brief Client side of the interface to a renderer.
  22  *
  23  * From Kdenlive's point of view, you treat the Render object as the renderer,
  24  * and simply use it as if it was local. Calls are asynchronous - you send a
  25  * call out, and then receive the return value through the relevant signal that
  26  * get's emitted once the call completes.
  27  */
  28
  29 #ifndef RENDERER_H
  30 #define RENDERER_H
  31
  32 #include "gentime.h"
  33 #include "definitions.h"
  34
  35 #include <kurl.h>
  36
  37 #include <qdom.h>
  38 #include <qstring.h>
  39 #include <qmap.h>
  40 #include <QList>
  41 #include <QEvent>
  42
  43 #ifdef Q_WS_MAC
  44 #include "videoglwidget.h"
  45 #endif
  46
  47 class Render;
  48
  49 class QTimer;
  50 class QPixmap;
  51
  52 namespace Mlt
  53 {
  54 class Consumer;
  55 class Playlist;
  56 class Tractor;
  57 class Transition;
  58 class Frame;
  59 class Field;
  60 class Producer;
  61 class Filter;
  62 class Profile;
  63 class Service;
  64 };
  65
  66 class MltErrorEvent : public QEvent
  67 {
  68 public:
  69     MltErrorEvent(QString message) : QEvent(QEvent::User), m_message(message) {}
  70     QString message() const {
  71         return m_message;
  72     }
  73
  74 private:
  75     QString m_message;
  76 };
  77
  78 class Render: public QObject
  79 {
  80 Q_OBJECT public:
  81
  82     enum FailStates { OK = 0,
  83                       APP_NOEXIST
  84                     };
  85
  86     Render(const QString & rendererName, int winid, int extid, QString profile = QString(), QWidget *parent = 0);
  87     ~Render();
  88
  89     /** @brief Seeks the renderer clip to the given time. */
  90     void seek(GenTime time);
  91     void seekToFrame(int pos);
  92     void seekToFrameDiff(int diff);
  93     int m_isBlocked;
  94
  95     //static QPixmap getVideoThumbnail(char *profile, QString file, int frame, int width, int height);
  96     QPixmap getImageThumbnail(KUrl url, int width, int height);
  97
  98     /* Return thumbnail for color clip
  99     void getImage(int id, QString color, QPoint size);*/
 100
 101     // static QPixmap frameThumbnail(Mlt::Frame *frame, int width, int height, bool border = false);
 102
 103     /* Return thumbnail for image clip
 104     void getImage(KUrl url, QPoint size);*/
 105
 106     /* Requests a particular frame from the given file.
 107      *
 108      * The pixmap will be returned by emitting the replyGetImage() signal.
 109     void getImage(KUrl url, int frame, QPoint size);*/
 110
 111     int setSceneList(QDomDocument list, int position = 0);
 112
 113     /** @brief Sets the current scene list.
 114      * @param list new scene list
 115      * @param position (optional) time to seek to
 116      * @return 0 when it has success, different from 0 otherwise
 117      *
 118      * Creates the producer from the MLT XML QDomDocument. Wraps the VEML
 119      * command of the same name. */
 120     int setSceneList(QString playlist, int position = 0);
 121     int setProducer(Mlt::Producer *producer, int position);
 122     const QString sceneList();
 123     bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
 124
 125     /** @brief Tells the renderer to play the scene at the specified speed,
 126      * @param speed speed to play the scene to
 127      *
 128      * The speed is relative to normal playback, e.g. 1.0 is normal speed, 0.0
 129      * is paused, -1.0 means play backwards. It does not specify start/stop
 130      * times for playback. Wraps the VEML command of the same name. */
 131     void play(double speed);
 132     void switchPlay();
 133     void pause();
 134
 135     /** @brief Stops playing.
 136      * @param startTime time to seek to */
 137     void stop(const GenTime & startTime);
 138     void setVolume(double volume);
 139
 140     QImage extractFrame(int frame_position, int width = -1, int height = -1);
 141
 142     /** @brief Plays the scene starting from a specific time.
 143      * @param startTime time to start playing the scene from
 144      *
 145      * Wraps the VEML command of the same name. */
 146     void play(const GenTime & startTime);
 147     void playZone(const GenTime & startTime, const GenTime & stopTime);
 148     void loopZone(const GenTime & startTime, const GenTime & stopTime);
 149
 150     void saveZone(KUrl url, QString desc, QPoint zone);
 151
 152     /** @brief Returns the name of the renderer. */
 153     const QString & rendererName() const;
 154
 155     /** @brief Returns the speed at which the renderer is currently playing.
 156      *
 157      * It returns 0.0 when the renderer is not playing anything. */
 158     double playSpeed();
 159
 160     /** @brief Returns the current seek position of the renderer. */
 161     GenTime seekPosition() const;
 162     int seekFramePosition() const;
 163
 164     void emitFrameUpdated(Mlt::Frame&);
 165     void emitFrameNumber(double position);
 166     void emitConsumerStopped();
 167
 168     /** @brief Returns the aspect ratio of the consumer. */
 169     double consumerRatio() const;
 170
 171     void doRefresh();
 172
 173     /** @brief Saves current producer frame as an image. */
 174     void exportCurrentFrame(KUrl url, bool notify);
 175
 176     /** @brief Turns on or off on screen display. */
 177     void refreshDisplay();
 178     int resetProfile(const QString profileName);
 179     double fps() const;
 180     int renderWidth() const;
 181     int renderHeight() const;
 182
 183     /** @brief Returns display aspect ratio. */
 184     double dar() const;
 185
 186     /*
 187      * Playlist manipulation.
 188      */
 189     Mlt::Producer *checkSlowMotionProducer(Mlt::Producer *prod, QDomElement element);
 190     int mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod, bool overwrite = false, bool push = false);
 191     bool mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
 192     void mltCutClip(int track, GenTime position);
 193     void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime duration, const GenTime timeOffset);
 194     int mltGetSpaceLength(const GenTime pos, int track, bool fromBlankStart);
 195     int mltTrackDuration(int track);
 196     bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
 197     bool mltResizeClipStart(ItemInfo info, GenTime diff);
 198     bool mltResizeClipCrop(ItemInfo info, GenTime diff);
 199     bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
 200     bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
 201     bool mltRemoveClip(int track, GenTime position);
 202
 203     /** @brief Deletes an effect from a clip in MLT's playlist. */
 204     bool mltRemoveEffect(int track, GenTime position, QString index, bool updateIndex, bool doRefresh = true);
 205
 206     /** @brief Adds an effect to a clip in MLT's playlist. */
 207     bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
 208     bool mltAddEffect(Mlt::Service service, EffectsParameterList params, int duration, bool doRefresh);
 209     bool mltAddTrackEffect(int track, EffectsParameterList params);
 210
 211     /** @brief Edits an effect parameters in MLT's playlist. */
 212     bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
 213
 214     /** @brief Updates the "kdenlive_ix" (index) value of an effect. */
 215     void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
 216
 217     /** @brief Changes the order of effects in MLT's playlist.
 218      *
 219      * It switches effects from oldPos and newPos, updating the "kdenlive_ix"
 220      * (index) value. */
 221     void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
 222
 223     /** @brief Enables/disables audio/video in a track. */
 224     void mltChangeTrackState(int track, bool mute, bool blind);
 225     bool mltMoveTransition(QString type, int startTrack,  int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
 226     bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
 227     void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
 228     void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool force = false);
 229     void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
 230     void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
 231     void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
 232     void mltDeleteTransparency(int pos, int track, int id);
 233     void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
 234     void mltInsertTrack(int ix, bool videoTrack);
 235     void mltDeleteTrack(int ix);
 236     bool mltUpdateClipProducer(int track, int pos, Mlt::Producer *prod);
 237     void mltPlantTransition(Mlt::Field *field, Mlt::Transition &tr, int a_track, int b_track);
 238     Mlt::Producer *invalidProducer(const QString &id);
 239
 240     /** @brief Changes the speed of a clip in MLT's playlist.
 241      *
 242      * It creates a new "framebuffer" producer, which must have its "resource"
 243      * property set to "video.mpg?0.6", where "video.mpg" is the path to the
 244      * clip and "0.6" is the speed in percentile. The newly created producer
 245      * will have its "id" property set to "slowmotion:parentid:speed", where
 246      * "parentid" is the id of the original clip in the ClipManager list and
 247      * "speed" is the current speed. */
 248     int mltChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, double speed, double oldspeed, int strobe, Mlt::Producer *prod);
 249
 250     const QList <Mlt::Producer *> producersList();
 251     void updatePreviewSettings();
 252     void setDropFrames(bool show);
 253     QString updateSceneListFps(double current_fps, double new_fps, QString scene);
 254 #ifdef Q_WS_MAC
 255     void showFrame(Mlt::Frame&);
 256 #endif
 257     QList <int> checkTrackSequence(int);
 258
 259 private:
 260
 261     /** @brief The name of this renderer.
 262      *
 263      * Useful to identify the renderers by what they do - e.g. background
 264      * rendering, workspace monitor, etc. */
 265     QString m_name;
 266     Mlt::Consumer * m_mltConsumer;
 267     Mlt::Producer * m_mltProducer;
 268     Mlt::Profile *m_mltProfile;
 269     double m_framePosition;
 270     double m_fps;
 271
 272     /** @brief True if we are playing a zone.
 273      *
 274      * It's determined by the "in" and "out" properties being temporarily
 275      * changed. */
 276     bool m_isZoneMode;
 277     bool m_isLoopMode;
 278     GenTime m_loopStart;
 279     int m_originalOut;
 280
 281     /** @brief True when the monitor is in split view. */
 282     bool m_isSplitView;
 283
 284     Mlt::Producer *m_blackClip;
 285     QString m_activeProfile;
 286
 287     QTimer *m_osdTimer;
 288
 289     /** @brief A human-readable description of this renderer. */
 290     int m_winid;
 291
 292 #ifdef Q_WS_MAC
 293     VideoGLWidget *m_glWidget;
 294 #endif
 295     void closeMlt();
 296     void mltCheckLength(Mlt::Tractor *tractor);
 297     void mltPasteEffects(Mlt::Producer *source, Mlt::Producer *dest);
 298     QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
 299     QMap<QString, Mlt::Producer *> m_slowmotionProducers;
 300     void buildConsumer(const QString profileName);
 301     void resetZoneMode();
 302     void fillSlowMotionProducers();
 303
 304 private slots:
 305
 306     /** @brief Refreshes the monitor display. */
 307     void refresh();
 308     void slotOsdTimeout();
 309     int connectPlaylist();
 310     //void initSceneList();
 311
 312 signals:
 313
 314     /** @brief The renderer received a reply to a getFileProperties request. */
 315     void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &, bool);
 316
 317     /** @brief The renderer received a reply to a getImage request. */
 318     void replyGetImage(const QString &, const QPixmap &);
 319
 320     /** @brief The renderer stopped, either playing or rendering. */
 321     void stopped();
 322
 323     /** @brief The renderer started playing. */
 324     void playing(double);
 325
 326     /** @brief The renderer started rendering. */
 327     void rendering(const GenTime &);
 328
 329     /** @brief The rendering has finished.
 330         @see consumer_frame_show
 331         This signal seems to be useless; use renderPosition(int) instead --Granjow */
 332     void renderFinished();
 333
 334     /* @brief The current seek position has been changed by the renderer.
 335     void positionChanged(const GenTime &);*/
 336
 337     /** @brief An error occurred within this renderer. */
 338     void error(const QString &, const QString &);
 339     void durationChanged(int);
 340     void rendererPosition(int);
 341     void rendererStopped(int);
 342     void removeInvalidClip(const QString &, bool replaceProducer);
 343     void refreshDocumentProducers();
 344
 345     /** @brief A frame's image has to be shown.
 346      *
 347      * Used in Mac OS X. */
 348     void showImageSignal(QImage);
 349     /** @brief The renderer refreshed the current frame, but no seeking was done. */
 350     void frameUpdated(QImage);
 351
 352 public slots:
 353
 354     /** @brief Starts the consumer. */
 355     void start();
 356
 357     /** @brief Stops the consumer. */
 358     void stop();
 359     int getLength();
 360
 361     /** @brief Checks if the file is readable by MLT. */
 362     bool isValid(KUrl url);
 363
 364     /** @brief Requests the file properties for the specified URL.
 365      *
 366      * Upon return, the result will be emitted via replyGetFileProperties().
 367      * Wraps the VEML command of the same name. */
 368     void getFileProperties(const QDomElement xml, const QString &clipId, int imageHeight, bool replaceProducer = true);
 369
 370     void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
 371     static char *decodedString(QString str);
 372     void mltSavePlaylist();
 373     void slotSplitView(bool doit);
 374     void slotSwitchFullscreen();
 375 };
 376
 377 #endif