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 (jasonwood@blueyonder.co.uk)
   6    copyright            : (C) 2010 by Jean-Baptiste Mardelle (jb@kdenlive.org)
   7
   8 ***************************************************************************/
   9
  10 /***************************************************************************
  11  *                                                                         *
  12  *   This program is free software; you can redistribute it and/or modify  *
  13  *   it under the terms of the GNU General Public License as published by  *
  14  *   the Free Software Foundation; either version 2 of the License, or     *
  15  *   (at your option) any later version.                                   *
  16  *                                                                         *
  17  ***************************************************************************/
  18
  19 /**
  20  * @class Render
  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 #include "abstractmonitor.h"
  35
  36 #include <mlt/framework/mlt_types.h>
  37
  38 #include <kurl.h>
  39
  40 #include <qdom.h>
  41 #include <qstring.h>
  42 #include <qmap.h>
  43 #include <QList>
  44 #include <QEvent>
  45 #include <QMutex>
  46 #include <QFuture>
  47
  48 class QTimer;
  49 class QPixmap;
  50
  51 class KComboBox;
  52
  53 namespace Mlt
  54 {
  55 class Consumer;
  56 class Playlist;
  57 class Tractor;
  58 class Transition;
  59 class Frame;
  60 class Field;
  61 class Producer;
  62 class Filter;
  63 class Profile;
  64 class Service;
  65 class Event;
  66 };
  67
  68 struct requestClipInfo {
  69     QDomElement xml;
  70     QString clipId;
  71     int imageHeight;
  72     bool replaceProducer;
  73
  74 bool operator==(const requestClipInfo &a)
  75 {
  76     return clipId == a.clipId;
  77 }
  78 };
  79
  80 class MltErrorEvent : public QEvent
  81 {
  82 public:
  83     MltErrorEvent(QString message) : QEvent(QEvent::User), m_message(message) {}
  84     QString message() const {
  85         return m_message;
  86     }
  87
  88 private:
  89     QString m_message;
  90 };
  91
  92
  93 class Render: public AbstractRender
  94 {
  95 Q_OBJECT public:
  96
  97     enum FailStates { OK = 0,
  98                       APP_NOEXIST
  99                     };
 100     /** @brief Build a MLT Renderer
 101      *  @param rendererName A unique identifier for this renderer
 102      *  @param winid The parent widget identifier (required for SDL display). Set to 0 for OpenGL rendering
 103      *  @param profile The MLT profile used for the renderer (default one will be used if empty). */
 104     Render(Kdenlive::MONITORID rendererName, int winid, QString profile = QString(), QWidget *parent = 0);
 105
 106     /** @brief Destroy the MLT Renderer. */
 107     virtual ~Render();
 108
 109     /** @brief Seeks the renderer clip to the given time. */
 110     void seek(GenTime time);
 111     void seek(int time);
 112     void seekToFrameDiff(int diff);
 113
 114     QPixmap getImageThumbnail(KUrl url, int width, int height);
 115
 116     /** @brief Sets the current MLT producer playlist.
 117      * @param list The xml describing the playlist
 118      * @param position (optional) time to seek to */
 119     int setSceneList(QDomDocument list, int position = 0);
 120
 121     /** @brief Sets the current MLT producer playlist.
 122      * @param list new playlist
 123      * @param position (optional) time to seek to
 124      * @return 0 when it has success, different from 0 otherwise
 125      *
 126      * Creates the producer from the text playlist. */
 127     int setSceneList(QString playlist, int position = 0);
 128     int setProducer(Mlt::Producer *producer, int position);
 129
 130     /** @brief Get the current MLT producer playlist.
 131      * @return A string describing the playlist */
 132     const QString sceneList();
 133     bool saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
 134
 135     /** @brief Tells the renderer to play the scene at the specified speed,
 136      * @param speed speed to play the scene to
 137      *
 138      * The speed is relative to normal playback, e.g. 1.0 is normal speed, 0.0
 139      * is paused, -1.0 means play backwards. It does not specify start/stop */
 140     void play(double speed);
 141     void switchPlay(bool play);
 142     void pause();
 143
 144     /** @brief Stops playing.
 145      * @param startTime time to seek to */
 146     void stop(const GenTime &startTime);
 147     int volume() const;
 148
 149     QImage extractFrame(int frame_position, QString path = QString(), int width = -1, int height = -1);
 150
 151     /** @brief Plays the scene starting from a specific time.
 152      * @param startTime time to start playing the scene from */
 153     void play(const GenTime & startTime);
 154     void playZone(const GenTime & startTime, const GenTime & stopTime);
 155     void loopZone(const GenTime & startTime, const GenTime & stopTime);
 156
 157     void saveZone(KUrl url, QString desc, QPoint zone);
 158
 159     /** @brief Save a clip in timeline to an xml playlist. */
 160     bool saveClip(int track, GenTime position, KUrl url, QString desc = QString());
 161
 162     /** @brief Returns the speed at which the renderer is currently playing.
 163      *
 164      * It returns 0.0 when the renderer is not playing anything. */
 165     double playSpeed() const;
 166
 167     /** @brief Returns the current seek position of the renderer. */
 168     GenTime seekPosition() const;
 169     int seekFramePosition() const;
 170
 171     void emitFrameUpdated(Mlt::Frame&);
 172     void emitFrameNumber();
 173     void emitConsumerStopped();
 174
 175     /** @brief Returns the aspect ratio of the consumer. */
 176     double consumerRatio() const;
 177
 178     /** @brief Saves current producer frame as an image. */
 179     void exportCurrentFrame(KUrl url, bool notify);
 180
 181     /** @brief Change the Mlt PROFILE
 182      * @param profileName The MLT profile name
 183      * @param dropSceneList If true, the current playlist will be deleted
 184      * @return true if the profile was changed
 185      * . */
 186     int resetProfile(const QString& profileName, bool dropSceneList = false);
 187     /** @brief Returns true if the render uses profileName as current profile. */
 188     bool hasProfile(const QString& profileName) const;
 189     double fps() const;
 190
 191     /** @brief Returns the width of a frame for this profile. */
 192     int frameRenderWidth() const;
 193     /** @brief Returns the display width of a frame for this profile. */
 194     int renderWidth() const;
 195     /** @brief Returns the height of a frame for this profile. */
 196     int renderHeight() const;
 197
 198     /** @brief Returns display aspect ratio. */
 199     double dar() const;
 200     /** @brief Returns sample aspect ratio. */
 201     double sar() const;
 202
 203     /*
 204      * Playlist manipulation.
 205      */
 206     Mlt::Producer *checkSlowMotionProducer(Mlt::Producer *prod, QDomElement element);
 207     int mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod, bool overwrite = false, bool push = false);
 208     bool mltUpdateClip(Mlt::Tractor *tractor, ItemInfo info, QDomElement element, Mlt::Producer *prod);
 209     void mltCutClip(int track, GenTime position);
 210     void mltInsertSpace(QMap <int, int> trackClipStartList, QMap <int, int> trackTransitionStartList, int track, const GenTime &duration, const GenTime &timeOffset);
 211     int mltGetSpaceLength(const GenTime &pos, int track, bool fromBlankStart);
 212
 213     /** @brief Returns the duration/length of @param track as reported by the track producer. */
 214     int mltTrackDuration(int track);
 215
 216     bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
 217     bool mltResizeClipStart(ItemInfo info, GenTime diff);
 218     bool mltResizeClipCrop(ItemInfo info, GenTime newCropStart);
 219     bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
 220     bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod, bool overwrite = false, bool insert = false);
 221     bool mltRemoveClip(int track, GenTime position);
 222
 223     /** @brief Deletes an effect from a clip in MLT's playlist. */
 224     bool mltRemoveEffect(int track, GenTime position, int index, bool updateIndex, bool doRefresh = true);
 225     bool mltRemoveTrackEffect(int track, int index, bool updateIndex);
 226
 227     /** @brief Adds an effect to a clip in MLT's playlist. */
 228     bool mltAddEffect(int track, GenTime position, EffectsParameterList params, bool doRefresh = true);
 229     bool addFilterToService(Mlt::Service service, EffectsParameterList params, int duration);
 230     bool mltAddEffect(Mlt::Service service, EffectsParameterList params, int duration, bool doRefresh);
 231     bool mltAddTrackEffect(int track, EffectsParameterList params);
 232
 233     /** @brief Enable / disable clip effects.
 234      * @param track The track where the clip is
 235      * @param position The start position of the clip
 236      * @param effectIndexes The list of effect indexes to enable / disable
 237      * @param disable True if effects should be disabled, false otherwise */
 238     bool mltEnableEffects(int track, GenTime position, QList <int> effectIndexes, bool disable);
 239     /** @brief Enable / disable track effects.
 240      * @param track The track where the effect is
 241      * @param effectIndexes The list of effect indexes to enable / disable
 242      * @param disable True if effects should be disabled, false otherwise */
 243     bool mltEnableTrackEffects(int track, QList <int> effectIndexes, bool disable);
 244
 245     /** @brief Edits an effect parameters in MLT's playlist. */
 246     bool mltEditEffect(int track, GenTime position, EffectsParameterList params);
 247     bool mltEditTrackEffect(int track, EffectsParameterList params);
 248
 249     /** @brief Updates the "kdenlive_ix" (index) value of an effect. */
 250     void mltUpdateEffectPosition(int track, GenTime position, int oldPos, int newPos);
 251
 252     /** @brief Changes the order of effects in MLT's playlist.
 253      *
 254      * It switches effects from oldPos and newPos, updating the "kdenlive_ix"
 255      * (index) value. */
 256     void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
 257     void mltMoveTrackEffect(int track, int oldPos, int newPos);
 258
 259     /** @brief Enables/disables audio/video in a track. */
 260     void mltChangeTrackState(int track, bool mute, bool blind);
 261     bool mltMoveTransition(QString type, int startTrack,  int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
 262     bool mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
 263     void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
 264     void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool force = false);
 265     void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
 266     void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
 267     void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
 268     void mltDeleteTransparency(int pos, int track, int id);
 269     void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
 270     QList <TransitionInfo> mltInsertTrack(int ix, bool videoTrack);
 271     void mltDeleteTrack(int ix);
 272     bool mltUpdateClipProducer(Mlt::Tractor *tractor, int track, int pos, Mlt::Producer *prod);
 273     void mltPlantTransition(Mlt::Field *field, Mlt::Transition &tr, int a_track, int b_track);
 274     Mlt::Producer *invalidProducer(const QString &id);
 275
 276     /** @brief Changes the speed of a clip in MLT's playlist.
 277      *
 278      * It creates a new "framebuffer" producer, which must have its "resource"
 279      * property set to "video.mpg?0.6", where "video.mpg" is the path to the
 280      * clip and "0.6" is the speed in percentage. The newly created producer
 281      * will have its "id" property set to "slowmotion:parentid:speed", where
 282      * "parentid" is the id of the original clip in the ClipManager list and
 283      * "speed" is the current speed. */
 284     int mltChangeClipSpeed(ItemInfo info, ItemInfo speedIndependantInfo, double speed, double oldspeed, int strobe, Mlt::Producer *prod);
 285
 286     const QList <Mlt::Producer *> producersList();
 287     void updatePreviewSettings();
 288     void setDropFrames(bool show);
 289     QString updateSceneListFps(double current_fps, double new_fps, QString scene);
 290     void showFrame(Mlt::Frame&);
 291
 292     void showAudio(Mlt::Frame&);
 293
 294     QList <int> checkTrackSequence(int);
 295     void sendFrameUpdate();
 296
 297     /** @brief Returns a pointer to the main producer. */
 298     Mlt::Producer *getProducer();
 299     /** @brief Returns the number of clips to process (When requesting clip info). */
 300     int processingItems();
 301     /** @brief Force processing of clip with selected id. */
 302     void forceProcessing(const QString &id);
 303     /** @brief Are we currently processing clip with selected id. */
 304     bool isProcessing(const QString &id);
 305
 306     /** @brief Requests the file properties for the specified URL (will be put in a queue list)
 307         @param xml The xml parameters for the clip
 308         @param clipId The clip Id string
 309         @param imageHeight The height (in pixels) of the returned thumbnail (height of a treewidgetitem in projectlist)
 310         @param replaceProducer If true, the MLT producer will be recreated */
 311     void getFileProperties(const QDomElement &xml, const QString &clipId, int imageHeight, bool replaceProducer = true);
 312
 313     /** @brief Lock the MLT service */
 314     Mlt::Tractor *lockService();
 315     /** @brief Unlock the MLT service */
 316     void unlockService(Mlt::Tractor *tractor);
 317     const QString activeClipId();
 318     /** @brief Fill a combobox with the found blackmagic devices */
 319     static bool getBlackMagicDeviceList(KComboBox *devicelist);
 320     static bool getBlackMagicOutputDeviceList(KComboBox *devicelist);
 321     /** @brief Frame rendering is handeled by Kdenlive, don't show video through SDL display */
 322     void disablePreview(bool disable);
 323
 324 private:
 325
 326     /** @brief The name of this renderer.
 327      *
 328      * Useful to identify the renderers by what they do - e.g. background
 329      * rendering, workspace monitor, etc. */
 330     Kdenlive::MONITORID m_name;
 331     Mlt::Consumer * m_mltConsumer;
 332     Mlt::Producer * m_mltProducer;
 333     Mlt::Profile *m_mltProfile;
 334     Mlt::Event *m_showFrameEvent;
 335     Mlt::Event *m_pauseEvent;
 336     double m_fps;
 337     bool m_externalConsumer;
 338
 339     /** @brief True if we are playing a zone.
 340      *
 341      * It's determined by the "in" and "out" properties being temporarily
 342      * changed. */
 343     bool m_isZoneMode;
 344     bool m_isLoopMode;
 345     GenTime m_loopStart;
 346     int m_originalOut;
 347
 348     /** @brief True when the monitor is in split view. */
 349     bool m_isSplitView;
 350
 351     Mlt::Producer *m_blackClip;
 352     QString m_activeProfile;
 353
 354     QTimer *m_osdTimer;
 355     QTimer m_refreshTimer;
 356     QMutex m_mutex;
 357     QMutex m_infoMutex;
 358
 359     /** @brief A human-readable description of this renderer. */
 360     int m_winid;
 361
 362     QLocale m_locale;
 363     QFuture <void> m_infoThread;
 364     QList <requestClipInfo> m_requestList;
 365
 366     void closeMlt();
 367     void mltCheckLength(Mlt::Tractor *tractor);
 368     void mltPasteEffects(Mlt::Producer *source, Mlt::Producer *dest);
 369     QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
 370     QMap<QString, Mlt::Producer *> m_slowmotionProducers;
 371     /** @brief The id of the clip that is currently being loaded for info query */
 372     QString m_processingClipId;
 373
 374     /** @brief Build the MLT Consumer object with initial settings.
 375      *  @param profileName The MLT profile to use for the consumer */
 376     void buildConsumer(const QString& profileName);
 377     void resetZoneMode();
 378     void fillSlowMotionProducers();
 379     /** @brief Get the track number of the lowest audible (non muted) audio track
 380      *  @param return The track number */
 381     int getLowestNonMutedAudioTrack(Mlt::Tractor tractor);
 382
 383     /** @brief Make sure our audio mixing transitions are applied to the lowest track */
 384     void fixAudioMixing(Mlt::Tractor tractor);
 385     /** @brief Make sure we inform MLT if we need a lot of threads for avformat producer */
 386     void checkMaxThreads();
 387
 388 private slots:
 389
 390     /** @brief Refreshes the monitor display. */
 391     void refresh();
 392     void slotOsdTimeout();
 393     /** @brief Process the clip info requests (in a separate thread). */
 394     void processFileProperties();
 395
 396 signals:
 397
 398     /** @brief The renderer received a reply to a getFileProperties request. */
 399     void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const stringMap &, const stringMap &, bool replaceProducer);
 400
 401     /** @brief The renderer received a reply to a getImage request. */
 402     void replyGetImage(const QString &, const QString &, int, int);
 403     void replyGetImage(const QString &, const QImage &);
 404
 405     /** @brief The renderer stopped, either playing or rendering. */
 406     void stopped();
 407
 408     /** @brief The renderer started playing. */
 409     void playing(double);
 410
 411     /** @brief The renderer started rendering. */
 412     void rendering(const GenTime &);
 413
 414     /** @brief An error occurred within this renderer. */
 415     void error(const QString &, const QString &);
 416     void durationChanged(int);
 417     void rendererPosition(int);
 418     void rendererStopped(int);
 419     /** @brief The clip is not valid, should be removed from project. */
 420     void removeInvalidClip(const QString &, bool replaceProducer);
 421     /** @brief The proxy is not valid, should be deleted.
 422      *  @param id The original clip's id
 423      *  @param durationError Should be set to true if the proxy failed because it has not same length as original clip
 424      */
 425     void removeInvalidProxy(const QString &id, bool durationError);
 426     void refreshDocumentProducers(bool displayRatioChanged, bool fpsChanged);
 427     /** @brief A proxy clip is missing, ask for creation. */
 428     void requestProxy(QString);
 429
 430
 431     /** @brief A frame's image has to be shown.
 432      *
 433      * Used in Mac OS X. */
 434     void showImageSignal(QImage);
 435     void showAudioSignal(const QByteArray &);
 436
 437 public slots:
 438
 439     /** @brief Starts the consumer. */
 440     void start();
 441
 442     /** @brief Stops the consumer. */
 443     void stop();
 444     int getLength();
 445
 446     /** @brief Checks if the file is readable by MLT. */
 447     bool isValid(KUrl url);
 448
 449     void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
 450     void mltSavePlaylist();
 451     void slotSplitView(bool doit);
 452     void slotSwitchFullscreen();
 453     void slotSetVolume(int volume);
 454     void seekToFrame(int pos);
 455     /** @brief Starts a timer to query for a refresh. */
 456     void doRefresh();
 457 };
 458
 459 #endif