lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam.
lbajardsilogic@0:    
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _TRANSFORM_H_
lbajardsilogic@0: #define _TRANSFORM_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include "base/Thread.h"
lbajardsilogic@0: 
lbajardsilogic@0: #include "data/model/Model.h"
lbajardsilogic@0: 
lbajardsilogic@0: typedef QString TransformId;
lbajardsilogic@0: 
lbajardsilogic@0: /**
lbajardsilogic@0:  * A Transform turns one data model into another.
lbajardsilogic@0:  *
lbajardsilogic@0:  * Typically in this application, a Transform might have a
lbajardsilogic@0:  * DenseTimeValueModel as its input (e.g. an audio waveform) and a
lbajardsilogic@0:  * SparseOneDimensionalModel (e.g. detected beats) as its output.
lbajardsilogic@0:  *
lbajardsilogic@0:  * The Transform typically runs in the background, as a separate
lbajardsilogic@0:  * thread populating the output model.  The model is available to the
lbajardsilogic@0:  * user of the Transform immediately, but may be initially empty until
lbajardsilogic@0:  * the background thread has populated it.
lbajardsilogic@0:  */
lbajardsilogic@0: 
lbajardsilogic@0: class Transform : public Thread
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     virtual ~Transform();
lbajardsilogic@0: 
lbajardsilogic@0:     // Just a hint to the processing thread that it should give up.
lbajardsilogic@0:     // Caller should still wait() and/or delete the transform before
lbajardsilogic@0:     // assuming its input and output models are no longer required.
lbajardsilogic@0:     void abandon() { m_abandoned = true; }
lbajardsilogic@0: 
lbajardsilogic@0:     Model *getInputModel()  { return m_input; }
lbajardsilogic@0:     Model *getOutputModel() { return m_output; }
lbajardsilogic@0:     Model *detachOutputModel() { m_detached = true; return m_output; }
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     Transform(Model *m);
lbajardsilogic@0: 
lbajardsilogic@0:     Model *m_input; // I don't own this
lbajardsilogic@0:     Model *m_output; // I own this, unless...
lbajardsilogic@0:     bool m_detached; // ... this is true.
lbajardsilogic@0:     bool m_abandoned;
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif