COP_Node_Common.h

Go to the documentation of this file.

#pragma once
#include "COP_API.h"

#include <OP/OP_Error.h>

#include <UT/UT_Array.h>
#include <UT/UT_Rect.h>
#include <UT/UT_Thread.h>

class OP_Context;
class OP_Node;

class IMG_TileOptions;

class TIL_Plane;
class TIL_Raster;
class TIL_TileArray;
class TIL_TileMPlay;
class TIL_Sequence;

class UT_Interrupt;
class UT_StringArray;

typedef void (*UpdateCallback)(float, bool, bool);

class COP_API COP_Node_Common
{
public:

    COP_Node_Common();

    virtual ~COP_Node_Common() { }

    static UpdateCallback getUpdateCallback();
    static void          setUpdateCallback(UpdateCallback updateCallback);
    static bool          isCookAborted();
    static void          resetAbortFlag();
    static void          abortCook();    

    bool         isCookAborted(int thread_index);
    virtual bool isInterrupted(int thread) = 0;

    static UT_Interrupt *getInterrupt();
    static void          setInterrupt(UT_Interrupt *);

    virtual void setInterrupted(int) = 0;

    virtual OP_Node* getOp() = 0;

    // cooks this OP into a file (which should not be open yet). If scope isn't
    // null, only the scoped planes in that sequence will be writen to the file.
    int                  cookToFile(const UT_StringArray &filenames,
                                    const IMG_TileOptions *,
                                    const TIL_Sequence *scope,
                                    const UT_IntArray &image_index,
                                    const UT_StringHolder &ocio_ospace = UT_StringHolder(),
                                    const UT_StringHolder &ocio_look = UT_StringHolder(),
                                    const UT_StringHolder &ocio_display = UT_StringHolder(),
                                    const UT_StringHolder &ocio_view = UT_StringHolder(),
                                    const char *uselut = 0,
                                    float gamma = 1.0F,
                                    UT_InclusiveRect *bounds = 0,
                                    bool single_frame = false,
                                    bool thread_io = false,
                                    bool env_map = false,
                                    bool use_progress_dialog=true);

    int                  cookToFile(const UT_StringArray &filenames,
                                    const IMG_TileOptions *,
                                    OP_Context &context,
                                    const UT_IntArray &image_index,
                                    const char *cplane, const char *aplane = 0,
                                    const UT_StringHolder &ocio_ospace = UT_StringHolder(),
                                    const UT_StringHolder &ocio_look = UT_StringHolder(),
                                    const UT_StringHolder &ocio_display = UT_StringHolder(),
                                    const UT_StringHolder &ocio_view = UT_StringHolder(),
                                    const char *uselut = 0,
                                    float gamma = 1.0F,
                                    UT_InclusiveRect *bounds = 0,
                                    bool single_frame = false,
                                    bool thread_io = false,
                                    bool env_map = false,
                                    bool use_progress_dialog=true);

    // Does a flipbook render. 'info' should contain the planes to render,
    // the frame range and image size.
    int                 cookFlipbook(const TIL_Sequence &info,
                                    int step = 1,
                                    float gamma = 1.0f,
                                    const char *lut = 0,
                                    bool startnew=true,
                                    bool (*updateCallback)(void *) = 0,
                                    void  *updateEntity = 0,
                                    bool write_houdini_frame = true,
                                    const char *session_label = NULL,
                                    const UT_StringHolder &ocio_ospace = UT_StringHolder(),
                                    const UT_StringHolder &ocio_look = UT_StringHolder(),
                                    const UT_StringHolder &ocio_display = UT_StringHolder(),
                                    const UT_StringHolder &ocio_view = UT_StringHolder());

    virtual OP_ERROR open(short& key, int clear_errors = 0) = 0;
    virtual void     close(short key) = 0;

    virtual TIL_Sequence& getSequence() = 0;

    virtual void                 getImageBounds(const TIL_Plane *plane, int array,
                                     float t, int xres, int yres, int thread,
                                     int &x1, int &y1,int &x2, int &y2) = 0;

    virtual void                waitForLastFile() = 0;
    
    virtual void                cleanUpAllRegions() = 0;

    virtual float getPercentageComplete(int num_extra_tiles_cooked) const = 0;
    virtual int getNumThreadsToUse() const = 0;

    virtual void raiseImageTooLargeError() = 0;

    virtual int cookToRaster(UT_ValArray<TIL_Raster *> &rasters,
                             UT_ValArray<OP_Context *> &contexts,
                             UT_ValArray<const TIL_Plane *> &planes,
                             UT_IntArray &array_index,
                             UT_ValArray<const int *> &comp_map,
                             UT_Array<UT_InclusiveRect> &bounds,
                             int subregion = 1, int clear = 1,
                             float black = 0.0F, float white = 1.0F,
                             int compindex = -1,
                             int ignore_bwpoints=0,
                             float gamma = 1.0F,
                             bool interactive = false,
                             UT_ValArray<TIL_Raster *> *tiles = 0,
                             int tile_index = 0, TIL_TileMPlay * =0,
                             bool cleanup_after = true,
                             const UT_StringHolder &ocio_ospace = UT_StringHolder(),
                             const UT_StringHolder &ocio_look = UT_StringHolder(),
                             const UT_StringHolder &ocio_display = UT_StringHolder(),
                             const UT_StringHolder &ocio_view = UT_StringHolder()) = 0;

    static const char   *getColorPlaneName();

    int getThreadIndex() const;

    ut_thread_id_t getThreadID(int thread);

    // These functions setup and reset the table which translates thread
    // process id's into our thread indices (0-TIL_MAX_THREADS).
    static void         setWorkingThreadId(int thread_index);
    static void         clearWorkingThreadId(int thread_index);
};