ImageIO.h

Go to the documentation of this file.

// YP  28/01/2005  \Yves120\Include\ImageIO.h

#define __IMAGEIO_H

#ifndef __HBITMAP_H
#include "SDK/HBitmap.h"
#endif

#include "DLLPlugi.h"

#define IMAGEIODLLVERSION 1


class PLUGINEXPORT HOutputInfo {
public:
   int         GetTime();
   int         GetStartTime();
   int         GetEndTime();
   int         GetStep();
   int         GetFPS();
   BOOL        GetIsAudioStereo();
   int         GetAudioFrequency();
   BOOL        GetIsAlpha();        // User requested that the alpha channel be saved in the file
   int         GetGammaPreset();    // One of the Gamma presets, the most characteristic being sRGB (or NTSC)
   float       GetOutputGamma();    // Gamma value for image data correction prior to storing to file.
   float       GetViewGamma();      // Gamma value of the user display setting
   String      GetUser();           // A string containing the user name to store as metadata in output files.
   String      GetOrganization();   // A string containing the user organisation (company, institution, etc).
   String      GetURL();            // A string containing the user URL (web page).
   String      GetEmail();          // A string containing the user email address.
   String      GetApplicationID();  // A string containing "Hash Animation:Master vn" where vn is the A:M version number.
};


class ImageIOInfo {
public:
   union {
      ULONG m_flags;
      struct {                               // This plugin can :
         BOOL  m_candomultiframes      : 1;  // - process (read-write) multiple frames in one single file. QuickTime and AVI can do that. But Gif can too.
         BOOL  m_canwrite              : 1;  // - write to file. All plugins must have read from file capability but may not write to file
         BOOL  m_haswriteoptions       : 1;  // - Provides a callable Save Options dialog box. Most common are compression settings
         BOOL  m_canstorealpha         : 1;  // - store alpha channels with the image data
         BOOL  m_canstoresound         : 1;  // - store sound data. Either in same file as images or on separate file.
         BOOL  m_canstoremultibuffers  : 1;  // - store multiple buffers. OpenEXR and Jpeg2000 can do that.
         BOOL  m_closewrite         : 1;  // - needs to close animation file after saving frames
      };
   };
   String   m_openfilter;     // OpenFile dialog file filter. The format is "|Display string|filter string|Macintosh filetype||"
   String   m_savefilter;     // Save dialog file filter. The format is "|Display string|filter string|Macintosh filetype||"
   String   m_suffix;         // The prefered or most common file extension. Do not include the dot.
   String   m_localizedname;  // The name of the supported file type as displayed in the Render Option drop down list.
   String   m_matchname;      // A unique name used to identify the plugin. This name must be unique among plugins and does not contain spaces
   String   m_documentation;  // A HTML string describing the plugin and its usage.
};

// NOTE: A GammaType of GAMMA_NTSC is equivalent to 2.2 but ideally should follow the CIE Rec 709 with a slope of 4.5 below 0.018 and power 0.45 above 0.018
enum GammaType { GAMMA_NONE, GAMMA_MONITOR, GAMMA_NTSC, GAMMA_CRT, GAMMA_CUSTOM };

class ImageIO : public DLLPlugin {
public:
   BOOL m_isopened;
   ImageIO() {m_isopened = FALSE;}
   ImageIO(HTreeObject *htreeobject) : DLLPlugin(htreeobject) {m_isopened = FALSE;}
   
   //ImageIO users should call this write and closewrite when done
   inline int  Write( HBitmapNode *bn, HOutputInfo *outputinfoconst, const String &filename, short *wavedata, BOOL hasaudio);
   inline void CloseWrite(BOOL hasaudio);

   //ImageIO developers should write these
   //virtual BOOL Load( BitmapNode &bn, const String &filename ) { return FALSE; }
// virtual char *GetHandleFileType() { return NULL; }
   virtual BOOL CanLoadImage( const String &filename ) { return FALSE; }
   virtual void GetFilesStartEndFrame( const String &filename, int &start, int &end) { start = -1; end = -2; }
   virtual BOOL SetSaveOptions(CWnd *parent, const String &extension, float fps) { return FALSE; }
   virtual BOOL GetImageIOInfo(ImageIOInfo &iioinfo) { return FALSE; }
   virtual int  OpenWriteFrame( String filename, HBitmapNode *bn, HOutputInfo *outputinfo, BOOL hasaudio ) { return 0; }
   virtual int  WriteFrame( HBitmapNode *bn, HOutputInfo *outputinfo, const String &filename, short *wavedata, BOOL hasaudio) {return HBitmapNode::WRITE_NORESULT;}
   virtual void CloseWriteFrame( BOOL hasaudio) {}
   virtual int  LoadFrame( HBitmapNode *bn, const String &filename, int frame=-1, UINT flags = 0 ) { return HBitmapNode::LOAD_FAILED; }
   virtual int  IsFileOpen() { return FALSE; }
   /*
   virtual BOOL Save( const String &filename, const BitmapNode &bn ) { return FALSE; }
   virtual BOOL Save( const String &filename, const BitmapBuffer &buffer ) { return FALSE; }
   virtual BOOL SaveAs( const BitmapNode &bn ) { return FALSE; }
   virtual BOOL SaveAs( const BitmapBuffer &buffer ) { return FALSE; }
   */
};

int ImageIO::Write( HBitmapNode *bn, HOutputInfo *outputinfo, const String &filename, short *wavedata, BOOL hasaudio)
{
   //always call this one so it calls OpenWriteFrame
   int rvalue;
   try {
      if (!m_isopened) {
         rvalue = OpenWriteFrame( filename, bn, outputinfo, hasaudio );
         if (rvalue == HBitmapNode::WRITE_ERROR)
            return rvalue;
         m_isopened = TRUE;
      }
      return WriteFrame( bn, outputinfo, filename, wavedata, hasaudio);
   }
#ifndef _DEBUG
   catch (...) {
      /*String err = "Unhandled exception in the \"%1\" image io plugin.";
      //err.Replace("%1", GetClassName());
      MessageRequest(err);*/
      CString err;
      err.Format("Unhandled exception in the \"%s\" image io plugin.", GetClassName());
      AfxMessageBox( err, MB_OK );
#ifdef DEBUG
      throw;
#endif
   }
#else
   catch (ImageIO e){} //an exception that won't be thrown to help find errors when debugging
#endif
   return HBitmapNode::WRITE_ERROR;
}

void ImageIO::CloseWrite(BOOL hasaudio)
{
   if (m_isopened)
      CloseWriteFrame(hasaudio);
   m_isopened = FALSE;
}

---