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 #include <QWidget>
  26
  27 #include <kurl.h>
  28
  29 #include "gentime.h"
  30 /*#include "docclipref.h"
  31 #include "effectdesc.h"
  32 #include "effectparamdescfactory.h"*/
  33
  34 /**Render encapsulates the client side of the interface to a renderer.
  35 From Kdenlive's point of view, you treat the Render object as the
  36 renderer, and simply use it as if it was local. Calls are asyncrhonous -
  37 you send a call out, and then recieve the return value through the
  38 relevant signal that get's emitted once the call completes.
  39   *@author Jason Wood
  40   */
  41
  42 class Render;
  43 //class EffectParamDesc;
  44 class QPixmap;
  45
  46 namespace Mlt {
  47     class Consumer;
  48     class Playlist;
  49     class Tractor;
  50     class Frame;
  51     class Producer;
  52     class Filter;
  53
  54     class Multitrack;
  55 };
  56
  57
  58
  59 class Render:public QObject {
  60   Q_OBJECT public:
  61
  62     enum FailStates { OK = 0,
  63         APP_NOEXIST
  64     };
  65
  66      Render(const QString & rendererName, QWidget *parent = 0);
  67     ~Render();
  68
  69         /** Wraps the VEML command of the same name; requests that the renderer
  70         should create a video window. If show is true, then the window should be
  71         displayed, otherwise it should be hidden. Render will emit the signal
  72         replyCreateVideoXWindow() once the renderer has replied. */
  73     void createVideoXWindow(WId winid, WId externalMonitor);
  74         /** Seeks the renderer clip to the given time. */
  75     void seek(GenTime time);
  76
  77     static QPixmap getVideoThumbnail(QString file, int frame, int width, int height);
  78     QPixmap getImageThumbnail(KUrl url, int width, int height);
  79
  80         /** Return thumbnail for color clip */
  81     void getImage(int id, QString color, QPoint size);
  82
  83     static QPixmap frameThumbnail(Mlt::Frame *frame, int width, int height, bool border = false);
  84
  85     /** Return thumbnail for image clip */
  86     void getImage(KUrl url, QPoint size);
  87
  88         /** Requests a particular frame from the given file.
  89          *
  90          * The pixmap will be returned by emitting the replyGetImage() signal.
  91          * */
  92     void getImage(KUrl url, int frame, QPoint size);
  93
  94         /** Wraps the VEML command of the same name. Sets the current scene list to
  95         be list. */
  96     void setSceneList(QDomDocument list, int position = 0);
  97
  98         /** Wraps the VEML command of the same name. Tells the renderer to
  99         play the current scene at the speed specified, relative to normal
 100         playback. e.g. 1.0 is normal speed, 0.0 is paused, -1.0 means play
 101         backwards. Does not specify start/stop times for playback.*/
 102     void play(double speed);
 103     void switchPlay();
 104         /** stop playing */
 105     void stop(const GenTime & startTime);
 106     void setVolume(double volume);
 107
 108     QPixmap extractFrame(int frame_position, int width, int height);
 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(double speed, const GenTime & startTime);
 114     void play(double speed, const GenTime & startTime,
 115         const GenTime & stopTime);
 116         /** Wraps the VEML command of the same name - render the currently
 117         specified sceneList - set with setSceneList() - to the document
 118         name specified. */
 119     void render(const KUrl & url);
 120
 121         /** Returns the description of this renderer */
 122     QString description();
 123
 124         /** Returns the name of the renderer. */
 125     const QString & rendererName() const;
 126
 127         /** Returns the speed at which the renderer is currently playing, 0.0 if the renderer is
 128         not playing anything. */
 129     double playSpeed();
 130         /** Returns the current seek position of the renderer. */
 131     const GenTime & seekPosition() const;
 132
 133     void emitFrameNumber(double position);
 134     void emitConsumerStopped();
 135
 136     /** Gives the aspect ratio of the consumer */
 137     double consumerRatio() const;
 138
 139     /** Gives the aspect ratio of the consumer */
 140     void askForRefresh();
 141
 142     /** Save current producer frame as image */
 143     void exportCurrentFrame(KUrl url, bool notify);
 144
 145     /** Turn on or off on screen display */
 146     void refreshDisplay();
 147     /** returns the current scenelist */
 148     QDomDocument sceneList() const;
 149     int resetRendererProfile(char * profile);
 150     bool isBlocked;
 151
 152     /** Playlist manipulation */
 153     void mltInsertClip(int track, GenTime position, QString resource);
 154     void mltCutClip(int track, GenTime position);
 155     void mltResizeClipEnd(int track, GenTime pos, GenTime in, GenTime out);
 156     void mltResizeClipStart(int track, GenTime pos, GenTime moveEnd, GenTime moveStart, GenTime in, GenTime out);
 157     void mltMoveClip(int startTrack, int endTrack, GenTime pos, GenTime moveStart);
 158     void mltMoveClip(int startTrack, int endTrack, int pos, int moveStart);
 159     void mltRemoveClip(int track, GenTime position);
 160     void mltRemoveEffect(int track, GenTime position, QString id, QString tag, int index);
 161     void mltAddEffect(int track, GenTime position, QString id, QString tag, QMap <QString, QString> args);
 162     void mltEditEffect(int track, GenTime position, int index, QString id, QString tag, QMap <QString, QString> args);
 163     void mltChangeTrackState(int track, bool mute, bool blind);
 164     void mltMoveTransition(QString type, int startTrack, int trackOffset, GenTime oldIn, GenTime oldOut, GenTime newIn, GenTime newOut);
 165     void mltAddTransition(QString tag, int a_track, int b_track, GenTime in, GenTime out, QMap <QString, QString> args);
 166
 167
 168   private:                      // Private attributes & methods
 169         /** The name of this renderer - useful to identify the renderes by what they do - e.g. background rendering, workspace monitor, etc... */
 170      QString m_name;
 171      Mlt::Consumer * m_mltConsumer;
 172      Mlt::Producer * m_mltProducer;
 173      Mlt::Producer *m_mltTextProducer;
 174      Mlt::Filter *m_osdInfo;
 175      double m_framePosition;
 176      double m_fps;
 177      uint m_monitorId;
 178      bool m_generateScenelist;
 179
 180         /** Holds the path to on screen display profile */
 181      QString m_osdProfile;
 182
 183      QTimer *refreshTimer;
 184      QTimer *osdTimer;
 185      QTimer *m_connectTimer;
 186      KUrl m_exportedFile;
 187      int exportDuration, firstExportFrame, lastExportFrame;
 188
 189         /** Holds the scenelist to be sent, if pending. */
 190     QDomDocument m_sceneList;
 191
 192         /** A human-readable description of this renderer. */
 193     QString m_description;
 194     int m_winid;
 195     int m_externalwinid;
 196         /** The actually seek command, private so people can't avoid the buffering of multiple seek commands. */
 197     void sendSeekCommand(GenTime time);
 198
 199         /** Sets the description of this renderer to desc. */
 200     void setDescription(const QString & description);
 201     void closeMlt();
 202     void mltCheckLength();
 203
 204     private slots:              // Private slots
 205         /** refresh monitor display */
 206         void refresh();
 207         void slotOsdTimeout();
 208         void restartConsumer();
 209         void connectPlaylist();
 210         void initSceneList();
 211
 212      signals:                   // Signals
 213         /** This signal is emitted once a reply to createVideoXWidow() has been recieved. */
 214     void replyCreateVideoXWindow(WId);
 215         /** emitted when the renderer recieves a reply to a getFileProperties request. */
 216     void replyGetFileProperties(const QMap < QString, QString > &, const QMap < QString, QString > &);
 217
 218         /** emitted when the renderer recieves a reply to a getImage request. */
 219     void replyGetImage(const KUrl &, int, const QPixmap &, int, int);
 220     void replyGetImage(int, const QPixmap &, int, int);
 221
 222         /** Emitted when the renderer stops, either playing or rendering. */
 223     void stopped();
 224         /** Emitted when the renderer starts playing. */
 225     void playing(double);
 226         /** Emitted when the renderer is rendering. */
 227     void rendering(const GenTime &);
 228         /** Emitted when rendering has finished */
 229     void renderFinished();
 230         /** Emitted when the current seek position has been changed by the renderer. */
 231 //    void positionChanged(const GenTime &);
 232         /** Emitted when an error occurs within this renderer. */
 233     void error(const QString &, const QString &);
 234     void durationChanged();
 235
 236
 237     public slots:               // Public slots
 238         /** Start Consumer */
 239     void start();
 240         /** Stop Consumer */
 241     void stop();
 242     void clear();
 243     int getLength();
 244         /** If the file is readable by mlt, return true, otherwise false */
 245     bool isValid(KUrl url);
 246
 247         /** Wraps the VEML command of the same name. Requests the file properties
 248     for the specified url from the renderer. Upon return, the result will be emitted
 249     via replyGetFileProperties(). */
 250     void getFileProperties(const KUrl &url, uint framenb = 0);
 251
 252     void exportFileToFirewire(QString srcFileName, int port, GenTime startTime, GenTime endTime);
 253     static char *decodedString(QString str);
 254     void mltSavePlaylist();
 255 };
 256
 257 #endif