/src/nuke/OCIOFileTransform/OCIOFileTransform.h
http://github.com/imageworks/OpenColorIO · C Header · 128 lines · 41 code · 30 blank · 57 comment · 0 complexity · 76eebfe52973542cc020f889f2b1a57b MD5 · raw file
- #ifndef INCLUDED_OCIO_NUKE_FILETRANSFORM_H_
- #define INCLUDED_OCIO_NUKE_FILETRANSFORM_H_
- // Include these early, for Nuke's headers under gcc 4.4.2.
- #include <memory>
- #include <cstdarg>
- #include <DDImage/PixelIop.h>
- #include <DDImage/Row.h>
- #include <DDImage/Knob.h>
- #include <OpenColorIO/OpenColorIO.h>
- namespace OCIO = OCIO_NAMESPACE;
- /*!
- * Iop that uses OpenColorIO to perform colorspace conversions
- */
- class OCIOFileTransform : public DD::Image::PixelIop {
- protected:
- const char* m_file;
- std::string m_cccid;
- /*! Transform direction dropdown index */
- int m_dirindex;
- /*! Interpolation dropdown index */
- int m_interpindex;
- /*! Processor used to apply the FileTransform */
- OCIO::ConstProcessorRcPtr m_processor;
- /*! Holds computed help string */
- mutable std::string m_nodehelp;
- /*! Controlled by hidden "version" knob, incremented to redraw image */
- int m_reload_version;
- public:
- static const char* dirs[];
- static const char* interp[];
- OCIOFileTransform(Node *node);
- virtual ~OCIOFileTransform();
- static const DD::Image::Op::Description description;
- /*! Return the command name that will be stored in Nuke scripts. */
- virtual const char *Class() const;
- /*!
- * Return a name for this class that will be shown to the user. The
- * default implementation returns Class(). You can return a different
- * (ie more user-friendly) name instead here, and there is no need for
- * this to be unique.
- *
- * Nuke currently will remove any trailing digits and underscores from
- * this and add a new number to make a unique name for the new node.
- *
- * \return "OCIOFileTransform"
- */
- virtual const char *displayName() const;
- /*!
- * Return help information for this node. This information is in the
- * pop-up window that the user gets when they hit the [?] button in
- * the lower-left corner of the control panel.
- */
- virtual const char *node_help() const;
- /*!
- * Define the knobs that will be presented in the control panel.
- */
- virtual void knobs(DD::Image::Knob_Callback f);
- /*!
- * Specify the channels required from input n to produce the channels
- * in mask by modifying mask in-place. (At least one channel in the
- * input is assumed.)
- *
- * Since OCIOFileTransform conversions can have channel cross-talk, any rgb
- * output channel requires all its rgb bretheren. (Non-rgb
- * are passed through.)
- */
- virtual void in_channels(int n, DD::Image::ChannelSet& mask) const;
- /*!
- * Calculate the output pixel data.
- * \param rowY vertical line number
- * \param rowX inclusive left bound
- * \param rowXBound exclusive right bound
- * \param outputChannels a subset of out_channels(), the required channels to be produced
- */
- virtual void pixel_engine(
- const DD::Image::Row& in,
- int rowY, int rowX, int rowXBound,
- DD::Image::ChannelMask outputChannels,
- DD::Image::Row& out);
- protected:
- /*!
- * Check that colorspaces are available, and that the transform
- * is not a noop. (As OCIO whether a given transform is a noop, since it
- * can do more analysis than just name matching.)
- */
- virtual void _validate(bool for_real);
- /*!
- * Ensure Node hash is reflects all parameters
- */
- virtual void append(DD::Image::Hash& nodehash);
- /*!
- * Hide and show UI elements based on other parameters.
- Also handles reload button
- */
- virtual int knob_changed(DD::Image::Knob* k);
- };
- static DD::Image::Op* build(Node *node);
- #endif // INCLUDED_OCIO_NUKE_FILETRANSFORM_H_