annotate align/TransformAligner.h @ 752:32654e402f8b pitch-align

Pull out ExternalProgramAligner and TransformAligner from Align - currently duplicating the code, the pulled-out classes are not yet in use

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    Sonic Visualiser
    An audio file viewer and annotation editor.
    Centre for Digital Music, Queen Mary, University of London.
    
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef SV_TRANSFORM_ALIGNER_H
#define SV_TRANSFORM_ALIGNER_H

#include <QString>

#include "data/model/Model.h"

class AlignmentModel;
class Document;

class TransformAligner : public QObject
{
    Q_OBJECT

public:
    TransformAligner(Document *doc,
                     ModelId reference,
                     ModelId toAlign);

    // Destroy the aligner, cleanly cancelling any ongoing alignment
    ~TransformAligner();

    bool begin(QString &error);

    static bool isAvailable();

signals:
    /**
     * Emitted when alignment is successfully completed. The reference
     * and toAlign models can be queried from the alignment model.
     */
    void complete(ModelId alignmentModel); // an AlignmentModel

private slots:
    void alignmentCompletionChanged(ModelId);
    void tuningDifferenceCompletionChanged(ModelId);

private:
    static QString getAlignmentTransformName();
    static QString getTuningDifferenceTransformName();

    bool beginAlignmentPhase();
    
    Document *m_document;
    ModelId m_reference;
    ModelId m_toAlign;
    ModelId m_aggregateModel; // an AggregateWaveModel
    ModelId m_alignmentModel; // an AlignmentModel
    ModelId m_tuningDiffProgressModel; // SparseTimeValueModel, unreg'd with doc
    ModelId m_tuningDiffOutputModel; // SparseTimeValueModel, unreg'd with doc
    ModelId m_pathOutputModel; // SparseTimeValueModel, unreg'd with doc
    float m_tuningFrequency;
    bool m_incomplete;
};

#endif