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