iimagecodec.h

Go to the documentation of this file.

/*
* Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
*/

 
#ifndef IIMAGECODEC_H
#define IIMAGECODEC_H
 
#include <edl/edlfwd.h>
#include <edl/idomcolorspace.h>
#include <edl/isession.h>
#include <edl/edlstream.h>
#include <edl/edlgeom.h>
#include <edl/iedlobject.h>
#include <edl/idomresources.h>
#include <edl/edlsimplebuffer.h>
 
_BEGIN_EDL_NAMESPACE
 

typedef enum
{
    eIECNone,               
    eIECAlpha,              
    eIECPremultipliedAlpha, 
    eIECMask,               
    eIECNoisyMask           
} eImageExtraChannelType;

class IImageFrame : public IEDLObject
{
  public:
    virtual ~IImageFrame ()
    {}

    virtual uint32 getWidth () const = 0;

    virtual uint32 getHeight () const = 0;

    virtual uint8 getBPS () const = 0;
 

    virtual IDOMColorSpacePtr getColorSpace () const = 0;
 

    virtual eImageExtraChannelType getExtraChannelType () const = 0;
 

    virtual uint8 getNumExtraChannels () const
    {
        eImageExtraChannelType channelType = getExtraChannelType ();
 
        return (channelType == eIECNone) ? 0 : 1;
    }
 

    virtual uint8 getNumChannels () const
    {
        return getNumExtraChannels () + getColorSpace()->getNumComponents();
    }
 

 
    virtual bool  getHasAlphaChannel () const
    {
        return (getExtraChannelType () == eIECAlpha ||
                getExtraChannelType () == eIECPremultipliedAlpha);
    }
 
 
#ifdef SWIG
    %apply bool &OUTPUT { bool &isNoisy };
#endif
    virtual bool getHasMask (bool &isNoisy) const
    {
        isNoisy = false;
        switch (getExtraChannelType())
        {
            case eIECNoisyMask:
                isNoisy = true;
                return true;
            case eIECMask:
                return true;
            default:
                return false;
        }
    }
#ifdef SWIG
    %clear bool &isNoisy;
#endif
 

    virtual double getXResolution () const = 0;

    virtual double getYResolution () const = 0;

    virtual uint32 getRawBytesPerRow () const = 0;
 
#ifdef SWIG
#if SWIGCSHARP
    %apply char *ARRAY_OUTPUT_SIZEINDEX_1 { void *pRow };
#endif
#if SWIGJAVA
    %apply signed char *INOUT {void *pRow};
#endif
#if SWIGPYTHON
    %apply char INOUT[] {void *pRow};
#endif
#endif
    virtual void readScanLine (void *pRow, size_t bufferSize) = 0;
#ifdef SWIG
    %clear void *pRow;
#endif

    virtual void skipScanLines (uint32 skipCount)
    {
        CEDLSimpleBuffer scanlineBuffer(getRawBytesPerRow());
        for (uint32 r = 0; r < skipCount; r++)
        {
            readScanLine(&scanlineBuffer[0], scanlineBuffer.size());
        }
    }

    virtual bool getEfficientlySkippable() const = 0;
};
DECL_SMART_PTR(IImageFrame);
#define edlobj2IImageFrame(src) edl_cast((IDOM *)NULL, src)
 

class IImageFrameWriter : public IImageFrame
{
  public:
    IImageFrameWriter ()
    {
    }

    virtual ~IImageFrameWriter ()
    {}
  public:
 
#ifdef SWIG
#if SWIGCSHARP
    %apply unsigned char INPUT[] {const void *pScanLine};
#endif
#if SWIGJAVA
    %apply signed char *INOUT {const void *pScanLine};
#endif
#if SWIGPYTHON
    %apply char INPUT[] {const void *pScanLine};
#endif
#endif
    virtual void writeScanLine (const void *pScanLine) = 0;
#ifdef SWIG
    %clear const void *pScanLine;
#endif

    virtual void setWidth (uint32 width) = 0;

    virtual void setHeight (uint32 height) = 0;

    virtual void setBPS (uint8 bps) = 0;

    virtual void setImageExtraChannelType (eImageExtraChannelType extraChannelType) = 0;

    virtual void setXResolution (double xRes) = 0;

    virtual void setYResolution (double yRes) = 0;

    virtual void setColorSpace (const IDOMColorSpacePtr &colorSpace) = 0;
 
#ifdef SWIG
#if SWIGCSHARP
    %apply char *ARRAY_OUTPUT_SIZEINDEX_1 { void *pRow };
#endif
#if SWIGJAVA
    %apply signed char *INOUT {void *pRow};
#endif
#if SWIGPYTHON
    %apply char INOUT[] {void *pRow};
#endif
#endif
    virtual void readScanLine (void *pRow, size_t bufferSize) { throwEDLError(JM_ERR_UNSUPPORTED); }
 
    #ifdef SWIG
    %clear void *pRow;
#endif
 
    /* @brief    Prepare the imageframe for receiving scanline data.
     *           All the other parameters must have been set already before calling
     *           this, and no calls to writeScanLine() can be made before this has
     *           occurred.
     */
    virtual void prepareForData () = 0;

    virtual void flushData () = 0;

    virtual bool getEfficientlySkippable() const
    {
        return false;
    }
};
DECL_SMART_PTR(IImageFrameWriter);
 

class IImageDecoder : public IEDLObject
{
  public:
    IImageDecoder()
    {
    }

    virtual ~IImageDecoder()
    {}
 
  public:

    virtual uint32 getNumFrames () { return 0; }

    virtual IImageFramePtr getFrame (uint32 frameNo = 0) = 0;
};
DECL_SMART_PTR(IImageDecoder);

class IImageEncoder : public IEDLObject
{
  public:
    IImageEncoder()
    {
    }

    virtual ~IImageEncoder()
    {}
 
  public:

    virtual IImageFrameWriterPtr createFrame () = 0;
};
DECL_SMART_PTR(IImageEncoder);
 
_END_EDL_NAMESPACE
 
 
#endif //IIMAGECODEC_H