COP2_ImageSource.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.
 *
 * NAME:        COP2_Cop2ImageSource.h (COP2 library, C++)
 *
 * COMMENTS:
 *      This is the derived class for a cop2 image source for TIL.
 */
#ifndef COP2_IMAGESOURCE_H
#define COP2_IMAGESOURCE_H

#include "COP2_API.h"
#include <TIL/TIL_ImageSource.h>
#include "COP2_Node.h"

class COP2_API COP2_ImageSource : public TIL_ImageSource
{
public:
                                 COP2_ImageSource(COP2_Node *);
  
    // global stuff...
    fpreal                       getGlobalTime() override;
    fpreal                       getSampleRate() override;
    fpreal                       getStartTime() override;
    fpreal                       getEndTime() override;

    //
    const char                  *getName() override;
    void                         getFrameName(
                                        int frame,
                                        UT_String &name) override;
    void                         getFullName(UT_String &name) override;
    bool                         doesImageExist(
                                        int frame,
                                        bool adjust = true) override;
    
    bool                         equals(const TIL_ImageSource *) const override;

    bool                         open(short &key,
                                      int reset = 0,
                                      fpreal t = TIL_GLOBAL_TIME) override;
    void                         close(short key) override;

    bool                         isNetwork() override;

    bool                         isConstantSequence() const override
                                    { return true; }
    const TIL_Sequence          *getSourceSequence(
                                        fpreal t,
                                        const UT_Options &options) override;

    int                  getID() const override { return myID; }
    UT_TokenString              *getID(fpreal t, int xres, int yres,
                                       const TIL_Plane &plane,
                                       int array_index,
                                       const UT_Options &options) override;

    void                         getSourceImageBounds(
                                        const TIL_Plane &plane,
                                        int array_index,
                                        fpreal t, int xres, int yres,
                                        const UT_Options &options,
                                        int &x1, int &y1,
                                        int &x2, int &y2) override;
    
    void                         getCookRegions(
                                        TIL_CookRegionList &regions) override
                                 {}

    int                          getSourceImage(
                                        TIL_Raster *image,
                                        fpreal t, int xres, int yres,
                                        const TIL_Plane &plane,
                                        int array_index,
                                        int xstart, int ystart,
                                        int xend, int yend, float gamma,
                                        const UT_Options &,
                                        bool include_alpha =false,
                                        bool is_interactive=false,
                                        int fxres = 0, int fyres = 0) override;

    void                         getInfo(UT_WorkBuffer &infotext) override;

    int                          writeImage(const char *filename,
                                            const IMG_TileOptions *finfo,
                                            const TIL_Sequence *, int step,
                                            const ColorSpace &cspace,
                                            void (*info)(void*, const char*),
                                            void *data,
                                            bool suppress_summary_dialog,
                                            bool overwrite) override;
    
    int                          writeImage(const char *filename,
                                            const IMG_TileOptions *finfo,
                                            int xres, int yres,
                                            const char *color,
                                            const char *alpha,
                                            int start, int end, int step,
                                            const ColorSpace &cspace,
                                            void (*info)(void*, const char*),
                                            void *data,
                                            bool suppress_summary_dialog,
                                            bool overwrite) override;

    size_t                       getVersion() override;
    bool                         isFrameLocked(fpreal t) const override;
    bool                         isAnythingLocked() const override;
    bool                         isPlaneLocked(
                                        const TIL_Plane *,
                                        fpreal t) const override;
    const TIL_Plane             *getPreviewPlane(int index) override;
    

    virtual bool                 canModifyImage() { return true; }
    virtual bool                 useHandles() { return true; }

    COP2_Node                   *getCop2() const { return isValid()?myCop2:0; }
    COP2_Node                   *getCop2()      { return isValid()?myCop2:0; }
    
    bool                         isSlowOperation() const override
                         { return isValid() ? myCop2->isSlowOperation():false; }
    
    fpreal                       getFrameTime(
                                        fpreal t, bool shift_only=false,
                                        const TIL_Sequence *ref = 0) override;
    int                          getFrameShift(
                                        int fr, bool shift_only=false,
                                        const TIL_Sequence *ref = 0) override;
    
    bool                         getColorCurves(const char *planename,
                                                int array, fpreal t,
                                                TIL_ColorCurves &curves,
                                                UT_String &first,
                                                bool allnodes, int comp=-1,
                                                bool natural_range = true,
                                                float start = 0.0f,
                                                float end   = 1.0f,
                                                int evalpoints = 0) override;
    
    bool                         allowUserSelection() const override
                                    { return false; }
    
    TIL_ImageSource             *selectParentSource(int px, int py,
                                                    const char *planename,
                                                    int array_index) override;

    bool                         getPreferredViewingPlane(
                                        UT_WorkBuffer &buf) const override;
    
    int64                        getMemoryUsage(bool inclusive) const override;

    const IMG_Metadata  *getMetadata(int frame) const override;

    OP_Node* getOp() const override
    { return myCop2; }

protected:    
                                ~COP2_ImageSource() override;
private:
    
    COP2_Node                   *myCop2;
    int                          myID;
    UT_TokenString              *myLastToken;
};


#endif