Chris@420: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@420: 
Chris@420: /*
Chris@420:     Sonic Visualiser
Chris@420:     An audio file viewer and annotation editor.
Chris@420:     Centre for Digital Music, Queen Mary, University of London.
Chris@420:     
Chris@420:     This program is free software; you can redistribute it and/or
Chris@420:     modify it under the terms of the GNU General Public License as
Chris@420:     published by the Free Software Foundation; either version 2 of the
Chris@420:     License, or (at your option) any later version.  See the file
Chris@420:     COPYING included with this distribution for more information.
Chris@420: */
Chris@420: 
Chris@754: #ifndef SV_ALIGN_H
Chris@754: #define SV_ALIGN_H
Chris@420: 
Chris@420: #include <QString>
Chris@423: #include <QObject>
Chris@423: #include <QProcess>
Chris@670: #include <QMutex>
Chris@423: #include <set>
Chris@420: 
Chris@753: #include "Aligner.h"
Chris@683: 
Chris@423: class AlignmentModel;
Chris@664: class Document;
Chris@420: 
Chris@423: class Align : public QObject
Chris@420: {
Chris@423:     Q_OBJECT
Chris@423:     
Chris@420: public:
Chris@670:     Align() { }
Chris@420: 
Chris@423:     /**
Chris@423:      * Align the "other" model to the reference, attaching an
Chris@423:      * AlignmentModel to it. Alignment is carried out by the method
Chris@423:      * configured in the user preferences (either a plugin transform
Chris@423:      * or an external process) and is done asynchronously. 
Chris@423:      *
Chris@761:      * Any errors are reported by firing the alignmentFailed
Chris@761:      * signal. Note that the signal may be fired during the call to
Chris@761:      * this function, if the aligner fails to start at all.
Chris@761:      *
Chris@761:      * If alignment starts successfully, then an AlignmentModel has
Chris@670:      * been constructed and attached to the toAlign model, and you can
Chris@670:      * query that model to discover the alignment progress, eventual
Chris@761:      * outcome, and also (separately from the alignmentFailed signal
Chris@761:      * here) any error message generated during alignment.
Chris@670:      *
Chris@423:      * A single Align object may carry out many simultanous alignment
Chris@423:      * calls -- you do not need to create a new Align object each
Chris@423:      * time, nor to wait for an alignment to be complete before
Chris@423:      * starting a new one.
Chris@423:      * 
Chris@423:      * The Align object must survive after this call, for at least as
Chris@428:      * long as the alignment takes. The usual expectation is that the
Chris@428:      * Align object will simply share the process or document
Chris@428:      * lifespan.
Chris@423:      */
Chris@761:     void alignModel(Document *doc,
Chris@683:                     ModelId reference,
Chris@761:                     ModelId toAlign);
Chris@420: 
Chris@428:     /**
Chris@761:      * As alignModel, except that the alignment does not begin
Chris@761:      * immediately, but is instead placed behind an event callback
Chris@761:      * with a small delay. Useful to avoid an unresponsive GUI when
Chris@761:      * firing off alignments while doing something else as well. Any
Chris@761:      * error is reported by firing the alignmentFailed signal.
Chris@761:      *
Chris@761:      * Scheduled alignments are not queued or serialised - many could
Chris@761:      * happen at once. They are just delayed a little for UI
Chris@761:      * responsiveness.
Chris@761:      */
Chris@761:     void scheduleAlignment(Document *doc,
Chris@761:                            ModelId reference,
Chris@761:                            ModelId toAlign);
Chris@761:     
Chris@761:     /**
Chris@428:      * Return true if the alignment facility is available (relevant
Chris@428:      * plugin installed, etc).
Chris@428:      */
Chris@428:     static bool canAlign();
Chris@428: 
Chris@428: signals:
Chris@428:     /**
Chris@428:      * Emitted when an alignment is successfully completed. The
Chris@428:      * reference and other models can be queried from the alignment
Chris@428:      * model.
Chris@428:      */
Chris@683:     void alignmentComplete(ModelId alignmentModel); // an AlignmentModel
Chris@428: 
Chris@761:     /**
Chris@761:      * Emitted when an alignment fails. The model is the toAlign model
Chris@761:      * that was passed to the call to alignModel or scheduleAlignment.
Chris@761:      */
Chris@761:     void alignmentFailed(ModelId toAlign, QString errorText);
Chris@761: 
Chris@423: private slots:
Chris@753:     void alignerComplete(ModelId alignmentModel); // an AlignmentModel
Chris@761:     void alignerFailed(ModelId toAlign, QString errorText);
Chris@423:     
Chris@420: private:
Chris@670:     QMutex m_mutex;
Chris@671: 
Chris@753:     // maps toAlign -> aligner for ongoing alignment - note that
Chris@753:     // although we can calculate alignments with different references,
Chris@753:     // we can only have one alignment on any given toAlign model, so
Chris@753:     // we don't key this on the whole (reference, toAlign) pair
Chris@753:     std::map<ModelId, std::shared_ptr<Aligner>> m_aligners;
Chris@671: 
Chris@761:     void addAligner(Document *doc, ModelId reference, ModelId toAlign);
Chris@761:     void removeAligner(QObject *);
Chris@761: 
Chris@756:     static void getAlignerPreference(bool &useProgram, QString &program);
Chris@420: };
Chris@420: 
Chris@420: #endif
Chris@420: