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