HOM_Clip.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 */

#ifndef __HOM_Clip_h__
#define __HOM_Clip_h__

#include "HOM_API.h"

#include "HOM_ElemPtr.h"
#include "HOM_Module.h"
#include "HOM_PtrOrNull.h"
#include "HOM_Track.h"

#include <string>
#include <vector>

class HOM_ChopNode;

SWIGOUT(%rename(Clip) HOM_Clip;)
// Force SWIG to output an __init__ method even though it determines this
// class is abstract.
SWIGOUT(%feature("notabstract") HOM_Clip;)

class HOM_API HOM_Clip
{
public:

#ifdef SWIG
%extend
{
    HOM_Clip()
    { return HOM().newClip(); }
}
#else
    HOM_Clip() { HOM_CONSTRUCT_OBJECT(this); }
    HOM_Clip(const HOM_Clip &) { HOM_CONSTRUCT_OBJECT(this); }
#endif
    virtual ~HOM_Clip() { HOM_DESTRUCT_OBJECT(this) }

    virtual bool operator==(HOM_PtrOrNull<HOM_Clip> clip) const = 0;
    bool operator!=(HOM_PtrOrNull<HOM_Clip> clip) const
        { return !operator==(clip); }

    virtual std::string __repr__() const = 0;

    SWIGOUT(%newobject chopNode;)
    virtual HOM_ChopNode *chopNode() const = 0;
    virtual int chopNodeOutputIndex() const = 0;

    virtual std::vector<HOM_ElemPtr<HOM_Track> > tracks() const = 0;

    SWIGOUT(%newobject track;)
    virtual HOM_Track *track(const char *track_name) const = 0;

    virtual double sampleRate() const = 0;
    virtual std::pair<double, double> sampleRange() const = 0;
    virtual int numSamples() const = 0;

    virtual double frameToSamples(double frame) const = 0;
    virtual double samplesToFrame(double samples) const = 0;

    virtual double timeToSamples(double time) const = 0;
    virtual double samplesToTime(double samples) const = 0;

    virtual void loadFromFile(const char *filename) = 0;
    virtual void saveToFile(const char *filename) const = 0;
};

#endif