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 #ifndef KRENDER_H
  19 #define KRENDER_H
  20
  21 #include <qdom.h>
  22 #include <qstring.h>
  23 #include <qmap.h>
  24 #include <QList>
  25
  26 #include <kurl.h>
  27
  28 #include "gentime.h"
  29 #include "definitions.h"
  30
  31 /**Render encapsulates the client side of the interface to a renderer.
  32 From Kdenlive's point of view, you treat the Render object as the
  33 renderer, and simply use it as if it was local. Calls are asyncrhonous -
  34 you send a call out, and then recieve the return value through the
  35 relevant signal that get's emitted once the call completes.
  36   *@author Jason Wood
  37   */
  38
  39 class Render;
  40 //class EffectParamDesc;
  41 class QPixmap;
  42
  43 namespace Mlt {
  44 class Consumer;
  45 class Playlist;
  46 class Tractor;
  47 class Frame;
  48 class Producer;
  49 class Filter;
  50 class Profile;
  51 class Multitrack;
  52 };
  53
  54
  55
  56 class Render: public QObject {
  57 Q_OBJECT public:
  58
  59     enum FailStates { OK = 0,
  60                       APP_NOEXIST
  61                     };
  62
  63     Render(const QString & rendererName, int winid, int extid, QWidget *parent = 0);
  64     ~Render();
  65
  66     /** Seeks the renderer clip to the given time. */
  67     void seek(GenTime time);
  68     void seekToFrame(int pos);
  69     bool m_isBlocked;
  70
  71     //static QPixmap getVideoThumbnail(char *profile, QString file, int frame, int width, int height);
  72     QPixmap getImageThumbnail(KUrl url, int width, int height);
  73
  74     /** Return thumbnail for color clip */
  75     //void getImage(int id, QString color, QPoint size);
  76
  77     // static QPixmap frameThumbnail(Mlt::Frame *frame, int width, int height, bool border = false);
  78
  79     /** Return thumbnail for image clip */
  80     //void getImage(KUrl url, QPoint size);
  81
  82     /** Requests a particular frame from the given file.
  83      *
  84      * The pixmap will be returned by emitting the replyGetImage() signal.
  85      * */
  86     //void getImage(KUrl url, int frame, QPoint size);
  87
  88
  89     /** Wraps the VEML command of the same name. Sets the current scene list to
  90     be list. */
  91     void setSceneList(QDomDocument list, int position = 0);
  92     void setSceneList(QString playlist, int position = 0);
  93     void setProducer(Mlt::Producer *producer, int position);
  94     QString sceneList();
  95     void saveSceneList(QString path, QDomElement kdenliveData = QDomElement());
  96
  97     /** Wraps the VEML command of the same name. Tells the renderer to
  98     play the current scene at the speed specified, relative to normal
  99     playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
 100     backwards. Does not specify start/stop times for playback.*/
 101     void play(double speed);
 102     void switchPlay();
 103     void pause();
 104     /** stop playing */
 105     void stop(const GenTime & startTime);
 106     void setVolume(double volume);
 107
 108     QPixmap extractFrame(int frame_position, int width = -1, int height = -1);
 109     /** Wraps the VEML command of the same name. Tells the renderer to
 110     play the current scene at the speed specified, relative to normal
 111     playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
 112     backwards. Specifes the start/stop times for playback.*/
 113     void play(const GenTime & startTime);
 114     void playZone(const GenTime & startTime, const GenTime & stopTime);
 115     void loopZone(const GenTime & startTime, const GenTime & stopTime);
 116
 117     void saveZone(KUrl url, QString desc, QPoint zone);
 118
 119     /** Returns the name of the renderer. */
 120     const QString & rendererName() const;
 121
 122     /** Returns the speed at which the renderer is currently playing, 0.0 if the renderer is
 123     not playing anything. */
 124     double playSpeed();
 125     /** Returns the current seek position of the renderer. */
 126     GenTime seekPosition() const;
 127
 128     void emitFrameNumber(double position);
 129     void emitConsumerStopped();
 130
 131     /** Gives the aspect ratio of the consumer */
 132     double consumerRatio() const;
 133
 134     void askForRefresh();
 135     void doRefresh();
 136
 137     /** Save current producer frame as image */
 138     void exportCurrentFrame(KUrl url, bool notify);
 139
 140     /** Turn on or off on screen display */
 141     void refreshDisplay();
 142     int resetProfile();
 143     const double fps() const;
 144     const int renderWidth() const;
 145     const int renderHeight() const;
 146     /** get display aspect ratio */
 147     const double dar() const;
 148
 149     /** Playlist manipulation */
 150     void mltInsertClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
 151     void mltUpdateClip(ItemInfo info, QDomElement element, Mlt::Producer *prod);
 152     void mltCutClip(int track, GenTime position);
 153     bool mltResizeClipEnd(ItemInfo info, GenTime clipDuration);
 154     bool mltResizeClipStart(ItemInfo info, GenTime diff);
 155     bool mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart, Mlt::Producer *prod);
 156     bool mltMoveClip(int startTrack, int endTrack, int pos, int moveStart, Mlt::Producer *prod);
 157     bool mltRemoveClip(int track, GenTime position);
 158     bool mltRemoveEffect(int track, GenTime position, QString index, bool doRefresh = true);
 159     bool mltAddEffect(int track, GenTime position, QHash <QString, QString> args, bool doRefresh = true);
 160     bool mltEditEffect(int track, GenTime position, QHash <QString, QString> args);
 161     void mltMoveEffect(int track, GenTime position, int oldPos, int newPos);
 162     void mltChangeTrackState(int track, bool mute, bool blind);
 163     void mltMoveTransition(QString type, int startTrack,  int newTrack, int newTransitionTrack, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
 164     void mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
 165     void mltDeleteTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml, bool refresh = true);
 166     void mltUpdateTransition(QString oldTag, QString tag, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
 167     void mltUpdateTransitionParams(QString type, int a_track, int b_track, GenTime in, GenTime out, QDomElement xml);
 168     void mltAddClipTransparency(ItemInfo info, int transitiontrack, int id);
 169     void mltMoveTransparency(int startTime, int endTime, int startTrack, int endTrack, int id);
 170     void mltDeleteTransparency(int pos, int track, int id);
 171     void mltResizeTransparency(int oldStart, int newStart, int newEnd, int track, int id);
 172
 173     /** Change speed of a clip in playlist. To do this, we create a new "framebuffer" producer.
 174     This new producer must have its "resource" param set to: video.mpg?0.6 where video.mpg is the path
 175     to the clip and 0.6 is the speed in percents. The newly created producer will have it's
 176     "id" parameter set to: "slowmotion:parentid:speed", where parentid is the id of the original clip
 177     in the ClipManager list and speed is the current speed */
 178     int mltChangeClipSpeed(ItemInfo info, double speed, double oldspeed, Mlt::Producer *prod);
 179
 180     QList <Mlt::Producer *> producersList();
 181
 182 private:   // Private attributes & methods
 183     /** The name of this renderer - useful to identify the renderes by what they do - e.g. background rendering, workspace monitor, etc... */
 184     QString m_name;
 185     Mlt::Consumer * m_mltConsumer;
 186     Mlt::Producer * m_mltProducer;
 187     Mlt::Producer *m_mltTextProducer;
 188     Mlt::Filter *m_osdInfo;
 189     Mlt::Profile *m_mltProfile;
 190     double m_framePosition;
 191     double m_fps;
 192
 193     /** true if we are playing a zone (ie the in and out properties have been temporarily changed) */
 194     bool m_isZoneMode;
 195     bool m_isLoopMode;
 196     GenTime m_loopStart;
 197
 198     /** true when monitor is in split view (several tracks at the same time) */
 199     bool m_isSplitView;
 200
 201     Mlt::Producer *m_blackClip;
 202     /** Holds the path to on screen display profile */
 203     QString m_osdProfile;
 204
 205     QTimer *refreshTimer;
 206     QTimer *osdTimer;
 207     KUrl m_exportedFile;
 208
 209     /** A human-readable description of this renderer. */
 210     int m_winid;
 211     int m_externalwinid;
 212
 213     /** Sets the description of this renderer to desc. */
 214     void closeMlt();
 215     void mltCheckLength(bool reload = true);
 216     QMap<QString, QString> mltGetTransitionParamsFromXml(QDomElement xml);
 217     QMap<QString, Mlt::Producer *> m_slowmotionProducers;
 218     void buildConsumer();
 219     void resetZoneMode();
 220
 221 private slots:  // Private slots
 222     /** refresh monitor display */
 223     void refresh();
 224     void slotOsdTimeout();
 225     void connectPlaylist();
 226     //void initSceneList();
 227
 228 signals:   // Signals
 229     /** emitted when the renderer recieves a reply to a getFileProperties request. */
 230     void replyGetFileProperties(const QString &clipId, Mlt::Producer*, const QMap < QString, QString > &, const QMap < QString, QString > &);
 231
 232     /** emitted when the renderer recieves a reply to a getImage request. */
 233     void replyGetImage(const QString & , int, const QPixmap &, int, int);
 234     void replyGetImage(const QString &, const QPixmap &, int, int);
 235
 236     /** Emitted when the renderer stops, either playing or rendering. */
 237     void stopped();
 238     /** Emitted when the renderer starts playing. */
 239     void playing(double);
 240     /** Emitted when the renderer is rendering. */
 241     void rendering(const GenTime &);
 242     /** Emitted when rendering has finished */
 243     void renderFinished();
 244     /** Emitted when the current seek position has been changed by the renderer. */
 245 //    void positionChanged(const GenTime &);
 246     /** Emitted when an error occurs within this renderer. */
 247     void error(const QString &, const QString &);
 248     void durationChanged(int);
 249     void rendererPosition(int);
 250     void rendererStopped(int);
 251     void removeInvalidClip(const QString &);
 252
 253 public slots:  // Public slots
 254     /** Start Consumer */
 255     void start();
 256     /** Stop Consumer */
 257     void stop();
 258     void clear();
 259     int getLength();
 260     /** If the file is readable by mlt, return true, otherwise false */
 261     bool isValid(KUrl url);
 262
 263     /** Wraps the VEML command of the same name. Requests the file properties
 264     for the specified url from the renderer. Upon return, the result will be emitted
 265     via replyGetFileProperties(). */
 266     void getFileProperties(const QDomElement &xml, const QString &clipId);
 267
 268     void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
 269     static char *decodedString(QString str);
 270     void mltSavePlaylist();
 271     void slotSplitView(bool doit);
 272 };
 273
 274 #endif