ruby-iup 0.0.2 → 0.1.0

data/ext/iup-linux/include/im_format_raw.h

@@ -1,64 +1,74 @@
-/** \file
- * \brief Initialize the RAW Format Driver
- * Header for internal use only.
- *
- * See Copyright Notice in im_lib.h
- */
-
-#ifndef __IM_FORMAT_RAW_H
-#define __IM_FORMAT_RAW_H
-
-#if	defined(__cplusplus)
-extern "C" {
-#endif
-
-/** \defgroup raw RAW - RAW File
- * 
- * \par
- * The file must be open/created with the functions \ref imFileOpenRaw and \ref imFileNewRaw.
- * 
- * \section Description
- * 
- * \par
- * Internal Implementation.
- * \par
- * Supports RAW binary images. You must know image parameters a priori. \n
- * You must set the IM_INT attributes "Width", "Height", "ColorMode", "DataType" before the imFileReadImageInfo/imFileWriteImageInfo functions.
- * \par
- * The data must be in binary form, but can start in an arbitrary offset from the begining of the file, use attribute "StartOffset".
- * The default is at 0 offset. 
- * \par
- * Integer sign and double precision can be converted using attribute "SwitchType". \n
- * The conversions will be BYTE<->CHAR, USHORT<->SHORT, INT<->UINT, FLOAT<->DOUBLE.
- * \par
- * Byte Order can be Little Endian (Intel=1) or Big Endian (Motorola=0), use the attribute "ByteOrder", the default is the current CPU.
- * \par
- * The lines can be aligned to a BYTE (1), WORD (2) or DWORD (4) boundaries, ue attribute "Padding" with the respective value.
- * \par
- * See \ref im_raw.h
- * 
- * \section Features
- *
-\verbatim
-    Data Types: <all>
-    Color Spaces: all, except MAP.
-    Compressions: 
-      NONE - no compression 
-    Can have more than one image, depends on "StartOffset" attribute.
-    Can have an alpha channel.
-    Components can be packed or not.
-    Lines arranged from top down to bottom or bottom up to top.
-
-    Attributes:
-      Width, Height, ColorMode, DataType IM_INT (1)
-      StartOffset, SwitchType, ByteOrder, Padding  IM_INT (1)
-\endverbatim
- * \ingroup format */
-imFormat* imFormatInitRAW(void);
-
-
-#if defined(__cplusplus)
-}
-#endif
-
-#endif
+/** \file
+ * \brief Initialize the RAW Format Driver
+ * Header for internal use only.
+ *
+ * See Copyright Notice in im_lib.h
+ */
+
+#ifndef __IM_FORMAT_RAW_H
+#define __IM_FORMAT_RAW_H
+
+#if	defined(__cplusplus)
+extern "C" {
+#endif
+
+/** \defgroup raw RAW - RAW File
+ * 
+ * \par
+ * The file must be open/created with the functions \ref imFileOpenRaw and \ref imFileNewRaw.
+ * 
+ * \section Description
+ * 
+ * \par
+ * Internal Implementation.
+ * \par
+ * Supports RAW binary images. This is an unstructured and uncompressed binary data. 
+ * It is NOT a Camera RAW file generated in many professional digital cameras. \n
+ * You must know image parameters a priori and must set the IM_INT attributes "Width", "Height", "ColorMode", "DataType" 
+ * before the imFileReadImageInfo/imFileWriteImageInfo functions.
+ * \par
+ * The data must be in binary form, but can start in an arbitrary offset from the begining of the file, use attribute "StartOffset".
+ * The default is at 0 offset. 
+ * \par
+ * Integer sign and double precision can be converted using attribute "SwitchType". \n
+ * The conversions will be BYTE<->CHAR, USHORT<->SHORT, INT<->UINT, FLOAT<->DOUBLE.
+ * \par
+ * Byte Order can be Little Endian (Intel=1) or Big Endian (Motorola=0), use the attribute "ByteOrder", the default is the current CPU.
+ * \par
+ * The lines can be aligned to a BYTE (1), WORD (2) or DWORD (4) boundaries, ue attribute "Padding" with the respective value.
+ * \par
+ * If the compression is ASCII the data is stored in textual format, instead of binary. 
+ * In this case SwitchType and ByteOrder are ignored, and Padding should be 0.
+ * \par
+ * See \ref im_raw.h
+ * 
+ * \section Features
+ *
+\verbatim
+    Data Types: <all>
+    Color Spaces: all, except MAP.
+    Compressions: 
+      NONE - no compression [default] 
+      ASCII (textual data)
+    Can have more than one image, depends on "StartOffset" attribute.
+    Can have an alpha channel.
+    Components can be packed or not.
+    Lines arranged from top down to bottom or bottom up to top.
+
+    Attributes:
+      Width, Height, ColorMode, DataType IM_INT (1)
+      ImageCount[1], StartOffset[0], SwitchType[FALSE], ByteOrder[IM_LITTLEENDIAN], Padding[0]  IM_INT (1)
+
+    Comments:
+      In fact ASCII is an expansion, not a compression, because the file will be larger than binary data.
+\endverbatim
+ * \ingroup format */
+imFormat* imFormatInitRAW(void);
+
+void imFormatFinishRAW(void);
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif

data/ext/iup-linux/include/im_format_wmv.h

@@ -1,100 +1,101 @@
-/** \file
- * \brief Register the WMF Format
- *
- * See Copyright Notice in im_lib.h
- */
-
-#ifndef __IM_FORMAT_WMV_H
-#define __IM_FORMAT_WMV_H
-
-#if	defined(__cplusplus)
-extern "C" {
-#endif
-
-/** \defgroup wmv WMV - Windows Media Video Format
- * \section Description
- * 
- * \par
- * Advanced Systems Format (ASF) \n
- * Windows Copyright Microsoft Corporation.
- * \par
- * Access to the WMV format uses Windows Media SDK. Available in Windows Only. \n
- * You must link the application with "im_wmv.lib" 
- * and you must call the function \ref imFormatRegisterWMV once 
- * to register the format into the IM core library. \n
- * Depends also on the WMF SDK (wmvcore.lib).
- * When using the "im_wmv.dll" this extra library is not necessary.
- * \par
- * The application users should have the WMV codec 9 installed:
- * http://www.microsoft.com/windows/windowsmedia/format/codecdownload.aspx
- * \par
- * You must agree with the WMF SDK EULA to use the SDK. \n
- * http://wmlicense.smdisp.net/v9sdk/
- * \par
- * For more information: \n
- * http://www.microsoft.com/windows/windowsmedia/9series/sdk.aspx \n
- * http://msdn.microsoft.com/library/en-us/wmform/htm/introducingwindowsmediaformat.asp 
- * \par
- * See \ref im_format_wmv.h
- * 
- * \section Features
- *
-\verbatim
-    Data Types: Byte
-    Color Spaces: RGB and MAP (Gray and Binary saved as MAP)
-    Compressions (installed in Windows XP by default):
-      NONE       - no compression
-      MPEG-4v3   - Windows Media MPEG-4 Video V3
-      MPEG-4v1   - ISO MPEG-4 Video V1
-      WMV7       - Windows Media Video  V7
-      WMV7Screen - Windows Media Screen V7
-      WMV8       - Windows Media Video  V8
-      WMV9Screen - Windows Media Video 9 Screen
-      WMV9       - Windows Media Video 9 [default]
-      Unknown    - Others
-    Can have more than one image. 
-    Can have an alpha channel (only for RGB) ?
-    Internally the components are always packed.
-    Lines arranged from top down to bottom or bottom up to top.
-    Handle(0) return NULL. imBinFile is not supported.
-    Handle(1) returns IWMSyncReader* when reading, IWMWriter* when writing.
- 
-    Attributes:
-      FPS IM_FLOAT (1) (should set when writing, default 15)
-      WMFQuality IM_INT (1) [0-100, default 50] (write only)
-      MaxKeyFrameTime IM_INT (1) (write only) [maximum key frame interval in miliseconds, default 5 seconds]
-      DataRate IM_INT (1) (write only) [kilobits/second, default 2400]
-      VBR IM_INT (1) [0, 1] (write only) [0 - Constant Bit Rate (default), 1 - Variable Bit Rate (Quality-Based)]
-      (and several others from the file-level attributes) For ex:
-        Title, Author, Copyright, Description (string)
-        Duration IM_INT [100-nanosecond units]
-        Seekable, HasAudio, HasVideo, Is_Protected, Is_Trusted, IsVBR IM_INT (1) [0, 1]
-        NumberOfFrames IM_INT (1)
-
-    Comments:
-      IMPORTANT - The "image_count" and the "FPS" attribute may not be available from the file,
-        we try to estimate from the duration and from the average time between frames, or using the default value.
-      We do not handle DRM protected files (Digital Rights Management).
-      Reads only the first video stream. Other streams are ignored.
-      All the images have the same size, you must call imFileReadImageInfo/imFileWriteImageInfo 
-        at least once.
-      For optimal random reading, the file should be indexed previously.
-      If not indexed by frame, random positioning may not be precise.
-      Sequencial reading will always be precise.
-      When writing we use a custom profile and time indexing only.
-      We do not support multipass encoding.  
-      Since the driver uses COM, CoInitialize(NULL) and CoUninitialize() are called every Open/Close.
-\endverbatim
- * \ingroup format */
- 
-/** Register the WMF Format. \n
- * In Lua, when using require"imlua_wmv" this function will be automatically called.
- * \ingroup wmv */
-void imFormatRegisterWMV(void);
-               
-               
-#if defined(__cplusplus)
-}
-#endif
-
-#endif
+/** \file
+ * \brief Register the WMF Format
+ *
+ * See Copyright Notice in im_lib.h
+ */
+
+#ifndef __IM_FORMAT_WMV_H
+#define __IM_FORMAT_WMV_H
+
+#if	defined(__cplusplus)
+extern "C" {
+#endif
+
+/** \defgroup wmv WMV - Windows Media Video Format
+ * \section Description
+ * 
+ * \par
+ * Advanced Systems Format (ASF) \n
+ * Windows Copyright Microsoft Corporation.
+ * \par
+ * Access to the WMV format uses Windows Media SDK. Available in Windows Only. \n
+ * You must link the application with "im_wmv.lib" 
+ * and you must call the function \ref imFormatRegisterWMV once 
+ * to register the format into the IM core library. 
+ * In Lua call require"imlua_wmv". \n
+ * Depends also on the WMF SDK (wmvcore.lib).
+ * When using the "im_wmv.dll" this extra library is not necessary.
+ * \par
+ * The application users should have the WMV codec 9 installed:
+ * http://www.microsoft.com/windows/windowsmedia/format/codecdownload.aspx
+ * \par
+ * You must agree with the WMF SDK EULA to use the SDK. \n
+ * http://wmlicense.smdisp.net/v9sdk/
+ * \par
+ * For more information: \n
+ * http://www.microsoft.com/windows/windowsmedia/9series/sdk.aspx \n
+ * http://msdn.microsoft.com/library/en-us/wmform/htm/introducingwindowsmediaformat.asp 
+ * \par
+ * See \ref im_format_wmv.h
+ * 
+ * \section Features
+ *
+\verbatim
+    Data Types: Byte
+    Color Spaces: RGB and MAP (Gray and Binary saved as MAP)
+    Compressions (installed in Windows XP by default):
+      NONE       - no compression
+      MPEG-4v3   - Windows Media MPEG-4 Video V3
+      MPEG-4v1   - ISO MPEG-4 Video V1
+      WMV7       - Windows Media Video  V7
+      WMV7Screen - Windows Media Screen V7
+      WMV8       - Windows Media Video  V8
+      WMV9Screen - Windows Media Video 9 Screen
+      WMV9       - Windows Media Video 9 [default]
+      Unknown    - Others
+    Can have more than one image. 
+    Can have an alpha channel (only for RGB) ?
+    Internally the components are always packed.
+    Lines arranged from top down to bottom or bottom up to top.
+    Handle(0) return NULL. imBinFile is not supported.
+    Handle(1) returns IWMSyncReader* when reading, IWMWriter* when writing.
+ 
+    Attributes:
+      FPS IM_FLOAT (1) (should set when writing, default 15)
+      WMFQuality IM_INT (1) [0-100, default 50] (write only)
+      MaxKeyFrameTime IM_INT (1) (write only) [maximum key frame interval in miliseconds, default 5 seconds]
+      DataRate IM_INT (1) (write only) [kilobits/second, default 2400]
+      VBR IM_INT (1) [0, 1] (write only) [0 - Constant Bit Rate (default), 1 - Variable Bit Rate (Quality-Based)]
+      (and several others from the file-level attributes) For ex:
+        Title, Author, Copyright, Description (string)
+        Duration IM_INT [100-nanosecond units]
+        Seekable, HasAudio, HasVideo, Is_Protected, Is_Trusted, IsVBR IM_INT (1) [0, 1]
+        NumberOfFrames IM_INT (1)
+
+    Comments:
+      IMPORTANT - The "image_count" and the "FPS" attribute may not be available from the file,
+        we try to estimate from the duration and from the average time between frames, or using the default value.
+      We do not handle DRM protected files (Digital Rights Management).
+      Reads only the first video stream. Other streams are ignored.
+      All the images have the same size, you must call imFileReadImageInfo/imFileWriteImageInfo 
+        at least once.
+      For optimal random reading, the file should be indexed previously.
+      If not indexed by frame, random positioning may not be precise.
+      Sequencial reading will always be precise.
+      When writing we use a custom profile and time indexing only.
+      We do not support multipass encoding.  
+      Since the driver uses COM, CoInitialize(NULL) and CoUninitialize() are called every Open/Close.
+\endverbatim
+ * \ingroup format */
+ 
+/** Register the WMF Format. \n
+ * In Lua, when using require"imlua_wmv" this function will be automatically called.
+ * \ingroup wmv */
+void imFormatRegisterWMV(void);
+               
+               
+#if defined(__cplusplus)
+}
+#endif
+
+#endif

data/ext/iup-linux/include/im_image.h

@@ -1,403 +1,425 @@
-/** \file
- * \brief Image Manipulation
- *
- * See Copyright Notice in im_lib.h
- */
-
-#ifndef __IM_IMAGE_H
-#define __IM_IMAGE_H
-
-#if	defined(__cplusplus)
-extern "C" {
-#endif
-
-
-/** \defgroup imgclass imImage 
- *
- * \par
- *  Base definitions and functions for image representation. \n
- * Only the image processing operations depends on these definitions, 
- * Image Storage and Image Capture are completely independent.
- * \par
- * You can also initialize a structure with your own memory buffer, see \ref imImageInit.
- * To release the structure without releasing the buffer, 
- * set "data[0]" to NULL before calling imImageDestroy.
- * \par
- * See \ref im_image.h
- * \ingroup imagerep */
-
-
-
-/** \brief imImage Structure Definition.  
- *
- * \par
- * An image representation than supports all the color spaces, 
- * but planes are always unpacked and the orientation is always bottom up.
- * \ingroup imgclass */
-typedef struct _imImage
-{
-  /* main parameters */
-  int width;          /**< Number of columns. image:Width() -> width: number [in Lua 5]. */
-  int height;         /**< Number of lines. image:Height() -> height: number [in Lua 5]. */
-  int color_space;    /**< Color space descriptor. See also \ref imColorSpace. image:ColorSpace() -> color_space: number [in Lua 5]. */
-  int data_type;      /**< Data type descriptor. See also \ref imDataType. image:DataType() -> data_type: number [in Lua 5]. */
-  int has_alpha;      /**< Indicates that there is an extra channel with alpha. image:HasAlpha() -> has_alpha: number [in Lua 5]. \n
-                           It will not affect the secondary parameters, i.e. the number of planes will be in fact depth+1. \n
-                           It is always 0 unless imImageAddAlpha is called, this is done in image load functions. */
-
-  /* secondary parameters */
-  int depth;          /**< Number of planes                      (ColorSpaceDepth)         */
-  int line_size;      /**< Number of bytes per line in one plane (width * DataTypeSize)    */
-  int plane_size;     /**< Number of bytes per plane.            (line_size * height)      */
-  int size;           /**< Number of bytes occupied by the image (plane_size * depth)      */
-  int count;          /**< Number of pixels                      (width * height)          */
-
-  /* image data */
-  void** data;        /**< Image data organized as a 2D matrix with several planes.   \n
-                           But plane 0 is also a pointer to the full data.            \n
-                           The remaining planes are: data[i] = data[0] + i*plane_size \n
-                           In Lua, data indexing is possible using: image[plane][row][column] */
-
-  /* image attributes */
-  long *palette;      /**< Color palette. image:GetPalette() -> palette: imPalette [in Lua 5]. \n
-                           Used when depth=1. Otherwise is NULL. */
-  int palette_count;  /**< The palette is always 256 colors allocated, but can have less colors used. */
-
-  void* attrib_table; /**< in fact is an imAttribTable, but we hide this here */
-} imImage;
-
-
-/** Creates a new image.
- * See also \ref imDataType and \ref imColorSpace. \n
- * In Lua the IM image metatable name is "imImage".
- * When converted to a string will return "imImage(%p) [width=%d,height=%d,color_space=%s,data_type=%s,depth=%d]" where %p is replaced by the userdata address,
- * and other values are replaced by the respective attributes.
- * If the image is already destroyed by im.ImageDestroy, then it will return also the suffix "-destroyed".
- *
- * \verbatim im.ImageCreate(width: number, height: number, color_space: number, data_type: number) -> image: imImage [in Lua 5] \endverbatim
- * \ingroup imgclass */
-imImage* imImageCreate(int width, int height, int color_space, int data_type);
-
-/** Initializes the image structure but does not allocates image data.
- * See also \ref imDataType and \ref imColorSpace.
- * \ingroup imgclass */
-imImage* imImageInit(int width, int height, int color_space, int data_type, void* data_buffer, long* palette, int palette_count);
-
-/** Creates a new image based on an existing one. \n
- * If the addicional parameters are -1, the given image parameters are used. \n
- * The image atributes always are copied.
- * See also \ref imDataType and \ref imColorSpace.
- *
- * \verbatim im.ImageCreateBased(image: imImage, [width: number], [height: number], [color_space: number], [data_type: number]) -> image: imImage [in Lua 5] \endverbatim
- * The addicional parameters in Lua can be nil, 
- * and they can also be functions with the based image as a parameter to return the respective value.
- * \ingroup imgclass */
-imImage* imImageCreateBased(const imImage* image, int width, int height, int color_space, int data_type);
-
-/** Destroys the image and frees the memory used.
- * image data is destroyed only if its data[0] is not NULL. \n
- * In Lua if this function is not called, the image is destroyed by the garbage collector.
- *
- * \verbatim im.ImageDestroy(image: imImage) [in Lua 5] \endverbatim
- * \verbatim image:Destroy() [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageDestroy(imImage* image);
-
-/** Adds an alpha channel plane.
- *
- * \verbatim image:AddAlpha() [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageAddAlpha(imImage* image);
-
-/** Changes the buffer size. Reallocate internal buffers if the new size is larger than the original.
- *
- * \verbatim image:Reshape(width: number, height: number) [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageReshape(imImage* image, int width, int height);
-
-/** Copy image data and attributes from one image to another. \n
- * Images must have the same size and type.
- *
- * \verbatim image:Copy(dst_image: imImage) [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageCopy(const imImage* src_image, imImage* dst_image);
-
-/** Copy image data only fom one image to another. \n
- * Images must have the same size and type.
- *
- * \verbatim image:CopyData(dst_image: imImage) [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageCopyData(const imImage* src_image, imImage* dst_image);
-
-/** Creates a copy of the image.
- *
- * \verbatim image:Duplicate() -> new_image: imImage [in Lua 5] \endverbatim
- * \ingroup imgclass */
-imImage* imImageDuplicate(const imImage* image);
-
-/** Creates a clone of the image. i.e. same attributes but ignore contents.
- *
- * \verbatim image:Clone() -> new_image: imImage [in Lua 5] \endverbatim
- * \ingroup imgclass */
-imImage* imImageClone(const imImage* image);
-
-/** Changes an extended attribute. \n
- * The data will be internally duplicated. \n
- * If data is NULL the attribute is removed. \n
- * If count is -1 and data_type is IM_BYTE then data is zero terminated.
- * See also \ref imDataType.
- *
- * \verbatim image:SetAttribute(attrib: string, data_type: number, data: table of numbers or string) [in Lua 5] \endverbatim
- * If data_type is IM_BYTE, as_string can be used as data.
- * \ingroup imgclass */
-void imImageSetAttribute(imImage* image, const char* attrib, int data_type, int count, const void* data);
-
-/** Returns an extended attribute. \n
- * Returns NULL if not found.
- * See also \ref imDataType.
- *
- * \verbatim image:GetAttribute(attrib: string, [as_string: boolean]) -> data: table of numbers or string, data_type: number [in Lua 5] \endverbatim
- * If data_type is IM_BYTE, as_string can be used to return a string instead of a table.
- * \ingroup imgclass */
-const void* imImageGetAttribute(const imImage* image, const char* attrib, int *data_type, int *count);
-
-/** Returns a list of the attribute names. \n
- * "attrib" must contain room enough for "attrib_count" names. Use "attrib=NULL" to return only the count.
- *
- * \verbatim image:GetAttributeList() -> data: table of strings [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageGetAttributeList(const imImage* image, char** attrib, int *attrib_count);
-
-/** Sets all image data to zero.
- *
- * \verbatim image:Clear() [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageClear(imImage* image);
-
-/** Indicates that the image can be viewed in common graphic devices.     
- * Data type must be IM_BYTE. Color mode can be IM_RGB, IM_MAP, IM_GRAY or IM_BINARY.
- *
- * \verbatim image:IsBitmap() -> is_bitmap: boolean [in Lua 5] \endverbatim
- * \ingroup imgclass */
-int imImageIsBitmap(const imImage* image);
-
-/** Changes the image palette.
- * This will destroy the existing palette and replace it with the given palette buffer.
- *
- * \verbatim image:SetPalette(palette: imPalette) [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageSetPalette(imImage* image, long* palette, int palette_count);
-
-/** Copies the image attributes from src to dst.
- *
- * \verbatim image:CopyAttributes(dst_image: imImage) [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageCopyAttributes(const imImage* src_image, imImage* dst_image);
-
-/** Returns 1 if the images match width and height. Returns 0 otherwise.
- *
- * \verbatim image:MatchSize(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
- * \ingroup imgclass */
-int imImageMatchSize(const imImage* image1, const imImage* image2);
-
-/** Returns 1 if the images match color mode and data type. Returns 0 otherwise.
- *
- * \verbatim image:MatchColor(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
- * \ingroup imgclass */
-int imImageMatchColor(const imImage* image1, const imImage* image2);
-
-/** Returns 1 if the images match width, height and data type. Returns 0 otherwise.
- *
- * \verbatim image:MatchDataType(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
- * \ingroup imgclass */
-int imImageMatchDataType(const imImage* image1, const imImage* image2);
-
-/** Returns 1 if the images match width, height and color space. Returns 0 otherwise.
- *
- * \verbatim image:MatchColorSpace(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
- * \ingroup imgclass */
-int imImageMatchColorSpace(const imImage* image1, const imImage* image2);
-
-/** Returns 1 if the images match in width, height, data type and color space. Returns 0 otherwise.
- *
- * \verbatim image:Match(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
- * \ingroup imgclass */
-int imImageMatch(const imImage* image1, const imImage* image2);
-
-/** Changes the image space from gray to binary by just changing color_space and the palette.
- *
- * \verbatim image:SetBinary() [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageSetBinary(imImage* image);
-
-/** Changes a gray data into a binary data, done in-place.
- *
- * \verbatim image:MakeBinary() [in Lua 5] \endverbatim
- * \ingroup imgclass */
-void imImageMakeBinary(imImage *image);
-
-
-
-/** \defgroup imgfile imImage Storage
- *
- * \par
- *  Functions to simplify the process of reading and writting imImage structures. 
- *  Will also load and save the alpha planes when possible.
- * \par
- * See \ref im_image.h
- * \ingroup file */
-
-
-/** Loads an image from an already open file. Returns NULL if failed. \n
- * This will call \ref imFileReadImageInfo and \ref imFileReadImageData. \n
- * index specifies the image number between 0 and image_count-1. \n
- * The returned image will be of the same color_space and data_type of the image in the file. \n
- * Attributes from the file will be stored at the image.
- * See also \ref imErrorCodes.
- *
- * \verbatim ifile:LoadImage([index: number]) -> image: imImage, error: number [in Lua 5] \endverbatim
- * Default index is 0.
- * \ingroup imgfile */
-imImage* imFileLoadImage(imFile* ifile, int index, int *error);
-
-/** Loads an image from an already open file. Returns NULL if failed. \n
- * This function assumes that the image in the file has the same parameters as the given image. \n
- * This will call \ref imFileReadImageInfo and \ref imFileReadImageData. \n
- * index specifies the image number between 0 and image_count-1. \n
- * The returned image will be of the same color_space and data_type of the image in the file. \n
- * Attributes from the file will be stored at the image.
- * See also \ref imErrorCodes.
- *
- * \verbatim ifile:LoadImageFrame(index: number, image: imImage) -> error: number [in Lua 5] \endverbatim
- * Default index is 0.
- * \ingroup imgfile */
-void imFileLoadImageFrame(imFile* ifile, int index, imImage* image, int *error);
-
-/** Loads an image from an already open file, but forces the image to be a bitmap.\n
- * The returned imagem will be always a Bitmap image, with color_space RGB, MAP, GRAY or BINARY, and data_type IM_BYTE. \n
- * index specifies the image number between 0 and image_count-1. \n
- * Returns NULL if failed.
- * Attributes from the file will be stored at the image.
- * See also \ref imErrorCodes.
- *
- * \verbatim ifile:LoadBitmap([index: number]) -> image: imImage, error: number [in Lua 5] \endverbatim
- * Default index is 0.
- * \ingroup imgfile */
-imImage* imFileLoadBitmap(imFile* ifile, int index, int *error);
-
-/** Loads an image region from an already open file. Returns NULL if failed. \n
- * This will call \ref imFileReadImageInfo and \ref imFileReadImageData. \n
- * index specifies the image number between 0 and image_count-1. \n
- * The returned image will be of the same color_space and data_type of the image in the file, 
- * or will be a Bitmap image. \n
- * Attributes from the file will be stored at the image.
- * See also \ref imErrorCodes. \n
- * For now works only for ECW file format.
- *
- * \verbatim ifile:LoadRegion(index, bitmap, xmin, xmax, ymin, ymax, width, height: number) -> image: imImage, error: number [in Lua 5] \endverbatim
- * Default index is 0.
- * \ingroup imgfile */
-imImage* imFileLoadImageRegion(imFile* ifile, int index, int bitmap, int *error, 
-                               int xmin, int xmax, int ymin, int ymax, int width, int height);
-
-/** Loads an image from an already open file, but forces the image to be a bitmap.\n
- * This function assumes that the image in the file has the same parameters as the given image. \n
- * The imagem must be a Bitmap image, with color_space RGB, MAP, GRAY or BINARY, and data_type IM_BYTE. \n
- * index specifies the image number between 0 and image_count-1. \n
- * Returns NULL if failed.
- * Attributes from the file will be stored at the image.
- * See also \ref imErrorCodes.
- *
- * \verbatim ifile:LoadBitmapFrame(index: number, image: imImage) -> error: number [in Lua 5] \endverbatim
- * Default index is 0.
- * \ingroup imgfile */
-void imFileLoadBitmapFrame(imFile* ifile, int index, imImage* image, int *error);
-
-/** Saves the image to an already open file. \n
- * This will call \ref imFileWriteImageInfo and \ref imFileWriteImageData. \n
- * Attributes from the image will be stored at the file.
- * Returns error code.
- *
- * \verbatim ifile:SaveImage(image: imImage) -> error: number [in Lua 5] \endverbatim
- * \ingroup imgfile */
-int imFileSaveImage(imFile* ifile, const imImage* image);
-
-/** Loads an image from file. Open, loads and closes the file. \n
- * index specifies the image number between 0 and image_count-1. \n
- * Returns NULL if failed.
- * Attributes from the file will be stored at the image.
- * See also \ref imErrorCodes.
- *
- * \verbatim im.FileImageLoad(file_name: string, [index: number]) -> image: imImage, error: number [in Lua 5] \endverbatim
- * Default index is 0.
- * \ingroup imgfile */
-imImage* imFileImageLoad(const char* file_name, int index, int *error);
-
-/** Loads an image from file, but forces the image to be a bitmap. Open, loads and closes the file. \n
- * index specifies the image number between 0 and image_count-1. \n
- * Returns NULL if failed.
- * Attributes from the file will be stored at the image.
- * See also \ref imErrorCodes.
- *
- * \verbatim im.FileImageLoadBitmap(file_name: string, [index: number]) -> image: imImage, error: number [in Lua 5] \endverbatim
- * Default index is 0.
- * \ingroup imgfile */
-imImage* imFileImageLoadBitmap(const char* file_name, int index, int *error);
-
-/** Loads an image region from file. Open, loads and closes the file. \n
- * index specifies the image number between 0 and image_count-1. \n
- * Returns NULL if failed.
- * Attributes from the file will be stored at the image.
- * See also \ref imErrorCodes. \n
- * For now works only for ECW file format.
- *
- * \verbatim im.FileImageLoadRegion(file_name: string, index, bitmap, xmin, xmax, ymin, ymax, width, height: number, ) -> image: imImage, error: number [in Lua 5] \endverbatim
- * Default index is 0.
- * \ingroup imgfile */
-imImage* imFileImageLoadRegion(const char* file_name, int index, int bitmap, int *error, 
-                               int xmin, int xmax, int ymin, int ymax, int width, int height);
-
-/** Saves the image to file. Open, saves and closes the file. \n
- * Returns error code. \n
- * Attributes from the image will be stored at the file.
- *
- * \verbatim im.FileImageSave(file_name: string, format: string, image: imImage) -> error: number [in Lua 5] \endverbatim
- * \verbatim image:Save(file_name: string, format: string) -> error: number [in Lua 5] \endverbatim
- * \ingroup imgfile */
-int imFileImageSave(const char* file_name, const char* format, const imImage* image);
-
-
-
-/** Utility macro to draw the image in a CD library canvas.
- * Works only for data_type IM_BYTE, and color spaces: IM_RGB, IM_MAP, IMGRAY and IM_BINARY.
- * \ingroup imgclass */
-#define imcdCanvasPutImage(_canvas, _image, _x, _y, _w, _h, _xmin, _xmax, _ymin, _ymax)     \
-  {                                                                         \
-    if (_image->color_space == IM_RGB)                                      \
-    {                                                                       \
-      if (_image->has_alpha)                                                \
-        cdCanvasPutImageRectRGBA(_canvas, _image->width, _image->height,    \
-                          (unsigned char*)_image->data[0],                  \
-                          (unsigned char*)_image->data[1],                  \
-                          (unsigned char*)_image->data[2],                  \
-                          (unsigned char*)_image->data[3],                  \
-                          _x, _y, _w, _h, _xmin, _xmax, _ymin, _ymax);      \
-      else                                                                  \
-        cdCanvasPutImageRectRGB(_canvas, _image->width, _image->height,     \
-                          (unsigned char*)_image->data[0],                  \
-                          (unsigned char*)_image->data[1],                  \
-                          (unsigned char*)_image->data[2],                  \
-                          _x, _y, _w, _h, _xmin, _xmax, _ymin, _ymax);      \
-    }                                                                       \
-    else                                                                    \
-      cdCanvasPutImageRectMap(_canvas, _image->width, _image->height,       \
-                        (unsigned char*)_image->data[0], _image->palette,   \
-                        _x, _y, _w, _h, _xmin, _xmax, _ymin, _ymax);        \
-  }                                                                               
-
-
-#if	defined(__cplusplus)
-}
-#endif
-
-#endif
+/** \file
+ * \brief Image Manipulation
+ *
+ * See Copyright Notice in im_lib.h
+ */
+
+#ifndef __IM_IMAGE_H
+#define __IM_IMAGE_H
+
+#if	defined(__cplusplus)
+extern "C" {
+#endif
+
+
+/** \defgroup imgclass imImage 
+ *
+ * \par
+ *  Base definitions and functions for image representation. \n
+ * Only the image processing operations depends on these definitions, 
+ * Image Storage and Image Capture are completely independent.
+ * \par
+ * You can also initialize a structure with your own memory buffer, see \ref imImageInit.
+ * To release the structure without releasing the buffer, 
+ * set "data[0]" to NULL before calling imImageDestroy.
+ * \par
+ * See \ref im_image.h
+ * \ingroup imagerep */
+
+
+
+/** \brief imImage Structure Definition.  
+ *
+ * \par
+ * An image representation than supports all the color spaces, 
+ * but planes are always unpacked and the orientation is always bottom up.
+ * \ingroup imgclass */
+typedef struct _imImage
+{
+  /* main parameters */
+  int width;          /**< Number of columns. image:Width() -> width: number [in Lua 5]. */
+  int height;         /**< Number of lines. image:Height() -> height: number [in Lua 5]. */
+  int color_space;    /**< Color space descriptor. See also \ref imColorSpace. image:ColorSpace() -> color_space: number [in Lua 5]. */
+  int data_type;      /**< Data type descriptor. See also \ref imDataType. image:DataType() -> data_type: number [in Lua 5]. */
+  int has_alpha;      /**< Indicates that there is an extra channel with alpha. image:HasAlpha() -> has_alpha: number [in Lua 5]. \n
+                           It will not affect the secondary parameters, i.e. the number of planes will be in fact depth+1. \n
+                           It is always 0 unless imImageAddAlpha is called, this is done in image load functions. */
+
+  /* secondary parameters */
+  int depth;          /**< Number of planes                      (ColorSpaceDepth)         */
+  int line_size;      /**< Number of bytes per line in one plane (width * DataTypeSize)    */
+  int plane_size;     /**< Number of bytes per plane.            (line_size * height)      */
+  int size;           /**< Number of bytes occupied by the image (plane_size * depth)      */
+  int count;          /**< Number of pixels                      (width * height)          */
+
+  /* image data */
+  void** data;        /**< Image data organized as a 2D matrix with several planes.   \n
+                           But plane 0 is also a pointer to the full data.            \n
+                           The remaining planes are: data[i] = data[0] + i*plane_size \n
+                           In Lua, data indexing is possible using: image[plane][row][column] */
+
+  /* image attributes */
+  long *palette;      /**< Color palette. image:GetPalette() -> palette: imPalette [in Lua 5]. \n
+                           Used when depth=1. Otherwise is NULL. */
+  int palette_count;  /**< The palette is always 256 colors allocated, but can have less colors used. */
+
+  void* attrib_table; /**< in fact is an imAttribTable, but we hide this here */
+} imImage;
+
+
+/** Creates a new image.
+ * See also \ref imDataType and \ref imColorSpace. Image data is cleared as \ref imImageClear. \n
+ * In Lua the IM image metatable name is "imImage".
+ * When converted to a string will return "imImage(%p) [width=%d,height=%d,color_space=%s,data_type=%s,depth=%d]" where %p is replaced by the userdata address,
+ * and other values are replaced by the respective attributes.
+ * If the image is already destroyed by im.ImageDestroy, then it will return also the suffix "-destroyed".
+ *
+ * \verbatim im.ImageCreate(width: number, height: number, color_space: number, data_type: number) -> image: imImage [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+imImage* imImageCreate(int width, int height, int color_space, int data_type);
+
+/** Initializes the image structure but does not allocates image data.
+ * See also \ref imDataType and \ref imColorSpace.
+ * \ingroup imgclass */
+imImage* imImageInit(int width, int height, int color_space, int data_type, void* data_buffer, long* palette, int palette_count);
+
+/** Creates a new image based on an existing one. \n
+ * If the addicional parameters are -1, the given image parameters are used. \n
+ * The image atributes always are copied. HasAlpha is copied.
+ * See also \ref imDataType and \ref imColorSpace.
+ *
+ * \verbatim im.ImageCreateBased(image: imImage, [width: number], [height: number], [color_space: number], [data_type: number]) -> image: imImage [in Lua 5] \endverbatim
+ * The addicional parameters in Lua can be nil, 
+ * and they can also be functions with the based image as a parameter to return the respective value.
+ * \ingroup imgclass */
+imImage* imImageCreateBased(const imImage* image, int width, int height, int color_space, int data_type);
+
+/** Destroys the image and frees the memory used.
+ * image data is destroyed only if its data[0] is not NULL. \n
+ * In Lua if this function is not called, the image is destroyed by the garbage collector.
+ *
+ * \verbatim im.ImageDestroy(image: imImage) [in Lua 5] \endverbatim
+ * \verbatim image:Destroy() [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageDestroy(imImage* image);
+
+/** Adds an alpha channel plane and sets its value to 0 (transparent).
+ *
+ * \verbatim image:AddAlpha() [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageAddAlpha(imImage* image);
+
+/** Sets the alpha channel plane to a constant.
+ *
+ * \verbatim image:SetAlpha() [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageSetAlpha(imImage* image, float alpha);
+
+/** Changes the buffer size. Reallocate internal buffers if the new size is larger than the original.
+ *
+ * \verbatim image:Reshape(width: number, height: number) [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageReshape(imImage* image, int width, int height);
+
+/** Copy image data and attributes from one image to another. \n
+ * Images must have the same size and type.
+ *
+ * \verbatim image:Copy(dst_image: imImage) [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageCopy(const imImage* src_image, imImage* dst_image);
+
+/** Copy image data only fom one image to another. \n
+ * Images must have the same size and type.
+ *
+ * \verbatim image:CopyData(dst_image: imImage) [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageCopyData(const imImage* src_image, imImage* dst_image);
+
+/** Copies the image attributes from src to dst.
+ * Includes the pallete when a MAP or GRAY image.
+ *
+ * \verbatim image:CopyAttributes(dst_image: imImage) [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageCopyAttributes(const imImage* src_image, imImage* dst_image);
+
+/** Copy one image plane fom one image to another. \n
+ * Images must have the same size and type.
+ *
+ * \verbatim image:CopyPlane(src_plane: number, dst_image: imImage, dst_plane: number) [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageCopyPlane(const imImage* src_image, int src_plane, imImage* dst_image, int dst_plane);
+
+/** Creates a copy of the image.
+ *
+ * \verbatim image:Duplicate() -> new_image: imImage [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+imImage* imImageDuplicate(const imImage* image);
+
+/** Creates a clone of the image. i.e. same attributes but ignore contents.
+ *
+ * \verbatim image:Clone() -> new_image: imImage [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+imImage* imImageClone(const imImage* image);
+
+/** Changes an extended attribute. \n
+ * The data will be internally duplicated. \n
+ * If data is NULL and count==0 the attribute is removed. \n
+ * If count is -1 and data_type is IM_BYTE then data is zero terminated.
+ * See also \ref imDataType.
+ *
+ * \verbatim image:SetAttribute(attrib: string, data_type: number, data: table of numbers or string) [in Lua 5] \endverbatim
+ * If data_type is IM_BYTE, as_string can be used as data.
+ * \ingroup imgclass */
+void imImageSetAttribute(const imImage* image, const char* attrib, int data_type, int count, const void* data);
+
+/** Returns an extended attribute. \n
+ * Returns NULL if not found.
+ * See also \ref imDataType.
+ *
+ * \verbatim image:GetAttribute(attrib: string, [as_string: boolean]) -> data: table of numbers or string, data_type: number [in Lua 5] \endverbatim
+ * If data_type is IM_BYTE, as_string can be used to return a string instead of a table.
+ * \ingroup imgclass */
+const void* imImageGetAttribute(const imImage* image, const char* attrib, int *data_type, int *count);
+
+/** Returns a list of the attribute names. \n
+ * "attrib" must contain room enough for "attrib_count" names. Use "attrib=NULL" to return only the count.
+ *
+ * \verbatim image:GetAttributeList() -> data: table of strings [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageGetAttributeList(const imImage* image, char** attrib, int *attrib_count);
+
+/** Sets all image data to zero. But if color space is YCBCR, LAB or LUV, and data type is BYTE or USHORT, then
+ * data is initialized with 128 or 32768 accordingly. Alpha is initialized as transparent (0).
+ *
+ * \verbatim image:Clear() [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageClear(imImage* image);
+
+/** Indicates that the image can be viewed in common graphic devices.     
+ * Data type must be IM_BYTE. Color mode can be IM_RGB, IM_MAP, IM_GRAY or IM_BINARY.
+ *
+ * \verbatim image:IsBitmap() -> is_bitmap: boolean [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+int imImageIsBitmap(const imImage* image);
+
+/** Changes the image palette.
+ * This will destroy the existing palette and replace it with the given palette pointer.
+ * Only the pointer is stored, so the palette should be a new palette and it can not be a static array.
+ *
+ * \verbatim image:SetPalette(palette: imPalette) [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageSetPalette(imImage* image, long* palette, int palette_count);
+
+/** Returns 1 if the images match width and height. Returns 0 otherwise.
+ *
+ * \verbatim image:MatchSize(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+int imImageMatchSize(const imImage* image1, const imImage* image2);
+
+/** Returns 1 if the images match color mode and data type. Returns 0 otherwise.
+ *
+ * \verbatim image:MatchColor(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+int imImageMatchColor(const imImage* image1, const imImage* image2);
+
+/** Returns 1 if the images match width, height and data type. Returns 0 otherwise.
+ *
+ * \verbatim image:MatchDataType(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+int imImageMatchDataType(const imImage* image1, const imImage* image2);
+
+/** Returns 1 if the images match width, height and color space. Returns 0 otherwise.
+ *
+ * \verbatim image:MatchColorSpace(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+int imImageMatchColorSpace(const imImage* image1, const imImage* image2);
+
+/** Returns 1 if the images match in width, height, data type and color space. Returns 0 otherwise.
+ *
+ * \verbatim image:Match(image2: imImage) -> match: boolean [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+int imImageMatch(const imImage* image1, const imImage* image2);
+
+/** Changes the image color space from gray to binary by just changing color_space and the palette.
+ *
+ * \verbatim image:SetBinary() [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageSetBinary(imImage* image);
+
+/** Changes a gray BYTE data (0,255) into a binary data (0,1), done in-place. Color space is not changed.
+ *
+ * \verbatim image:MakeBinary() [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageMakeBinary(imImage *image);
+
+/** Changes a binary data (0,1) into a gray BYTE data (0,255), done in-place. Color space is not changed.
+ *
+ * \verbatim image:MakeGray() [in Lua 5] \endverbatim
+ * \ingroup imgclass */
+void imImageMakeGray(imImage *image);
+
+
+
+/** \defgroup imgfile imImage Storage
+ *
+ * \par
+ *  Functions to simplify the process of reading and writting imImage structures. 
+ *  Will also load and save the alpha planes when possible.
+ * \par
+ * See \ref im_image.h
+ * \ingroup file */
+
+
+/** Loads an image from an already open file. Returns NULL if failed. \n
+ * This will call \ref imFileReadImageInfo and \ref imFileReadImageData. \n
+ * index specifies the image number between 0 and image_count-1. \n
+ * The returned image will be of the same color_space and data_type of the image in the file. \n
+ * Attributes from the file will be stored at the image.
+ * See also \ref imErrorCodes.
+ *
+ * \verbatim ifile:LoadImage([index: number]) -> image: imImage, error: number [in Lua 5] \endverbatim
+ * Default index is 0.
+ * \ingroup imgfile */
+imImage* imFileLoadImage(imFile* ifile, int index, int *error);
+
+/** Loads an image from an already open file. Returns NULL if failed. \n
+ * This function assumes that the image in the file has the same parameters as the given image. \n
+ * This will call \ref imFileReadImageInfo and \ref imFileReadImageData. \n
+ * index specifies the image number between 0 and image_count-1. \n
+ * The returned image will be of the same color_space and data_type of the image in the file. \n
+ * Attributes from the file will be stored at the image.
+ * See also \ref imErrorCodes.
+ *
+ * \verbatim ifile:LoadImageFrame(index: number, image: imImage) -> error: number [in Lua 5] \endverbatim
+ * Default index is 0.
+ * \ingroup imgfile */
+void imFileLoadImageFrame(imFile* ifile, int index, imImage* image, int *error);
+
+/** Loads an image from an already open file, but forces the image to be a bitmap.\n
+ * The returned imagem will be always a Bitmap image, with color_space RGB, MAP, GRAY or BINARY, and data_type IM_BYTE. \n
+ * index specifies the image number between 0 and image_count-1. \n
+ * Returns NULL if failed.
+ * Attributes from the file will be stored at the image.
+ * See also \ref imErrorCodes.
+ *
+ * \verbatim ifile:LoadBitmap([index: number]) -> image: imImage, error: number [in Lua 5] \endverbatim
+ * Default index is 0.
+ * \ingroup imgfile */
+imImage* imFileLoadBitmap(imFile* ifile, int index, int *error);
+
+/** Loads an image region from an already open file. Returns NULL if failed. \n
+ * This will call \ref imFileReadImageInfo and \ref imFileReadImageData. \n
+ * index specifies the image number between 0 and image_count-1. \n
+ * The returned image will be of the same color_space and data_type of the image in the file, 
+ * or will be a Bitmap image. \n
+ * Attributes from the file will be stored at the image.
+ * See also \ref imErrorCodes. \n
+ * For now, it works only for the ECW file format.
+ *
+ * \verbatim ifile:LoadRegion(index, bitmap, xmin, xmax, ymin, ymax, width, height: number) -> image: imImage, error: number [in Lua 5] \endverbatim
+ * Default index is 0.
+ * \ingroup imgfile */
+imImage* imFileLoadImageRegion(imFile* ifile, int index, int bitmap, int *error, 
+                               int xmin, int xmax, int ymin, int ymax, int width, int height);
+
+/** Loads an image from an already open file, but forces the image to be a bitmap.\n
+ * This function assumes that the image in the file has the same parameters as the given image. \n
+ * The imagem must be a Bitmap image, with color_space RGB, MAP, GRAY or BINARY, and data_type IM_BYTE. \n
+ * index specifies the image number between 0 and image_count-1. \n
+ * Returns NULL if failed.
+ * Attributes from the file will be stored at the image.
+ * See also \ref imErrorCodes.
+ *
+ * \verbatim ifile:LoadBitmapFrame(index: number, image: imImage) -> error: number [in Lua 5] \endverbatim
+ * Default index is 0.
+ * \ingroup imgfile */
+void imFileLoadBitmapFrame(imFile* ifile, int index, imImage* image, int *error);
+
+/** Saves the image to an already open file. \n
+ * This will call \ref imFileWriteImageInfo and \ref imFileWriteImageData. \n
+ * Attributes from the image will be stored at the file.
+ * Returns error code.
+ *
+ * \verbatim ifile:SaveImage(image: imImage) -> error: number [in Lua 5] \endverbatim
+ * \ingroup imgfile */
+int imFileSaveImage(imFile* ifile, const imImage* image);
+
+/** Loads an image from file. Open, loads and closes the file. \n
+ * index specifies the image number between 0 and image_count-1. \n
+ * Returns NULL if failed.
+ * Attributes from the file will be stored at the image.
+ * See also \ref imErrorCodes.
+ *
+ * \verbatim im.FileImageLoad(file_name: string, [index: number]) -> image: imImage, error: number [in Lua 5] \endverbatim
+ * Default index is 0.
+ * \ingroup imgfile */
+imImage* imFileImageLoad(const char* file_name, int index, int *error);
+
+/** Loads an image from file, but forces the image to be a bitmap. Open, loads and closes the file. \n
+ * index specifies the image number between 0 and image_count-1. \n
+ * Returns NULL if failed.
+ * Attributes from the file will be stored at the image.
+ * See also \ref imErrorCodes.
+ *
+ * \verbatim im.FileImageLoadBitmap(file_name: string, [index: number]) -> image: imImage, error: number [in Lua 5] \endverbatim
+ * Default index is 0.
+ * \ingroup imgfile */
+imImage* imFileImageLoadBitmap(const char* file_name, int index, int *error);
+
+/** Loads an image region from file. Open, loads and closes the file. \n
+ * index specifies the image number between 0 and image_count-1. \n
+ * Returns NULL if failed.
+ * Attributes from the file will be stored at the image.
+ * See also \ref imErrorCodes. \n
+ * For now, it works only for the ECW file format.
+ *
+ * \verbatim im.FileImageLoadRegion(file_name: string, index, bitmap, xmin, xmax, ymin, ymax, width, height: number, ) -> image: imImage, error: number [in Lua 5] \endverbatim
+ * Default index is 0.
+ * \ingroup imgfile */
+imImage* imFileImageLoadRegion(const char* file_name, int index, int bitmap, int *error, 
+                               int xmin, int xmax, int ymin, int ymax, int width, int height);
+
+/** Saves the image to file. Open, saves and closes the file. \n
+ * Returns error code. \n
+ * Attributes from the image will be stored at the file.
+ *
+ * \verbatim im.FileImageSave(file_name: string, format: string, image: imImage) -> error: number [in Lua 5] \endverbatim
+ * \verbatim image:Save(file_name: string, format: string) -> error: number [in Lua 5] \endverbatim
+ * \ingroup imgfile */
+int imFileImageSave(const char* file_name, const char* format, const imImage* image);
+
+
+
+/** Utility macro to draw the image in a CD library canvas.
+ * Works only for data_type IM_BYTE, and color spaces: IM_RGB, IM_MAP, IMGRAY and IM_BINARY.
+ * \ingroup imgclass */
+#define imcdCanvasPutImage(_canvas, _image, _x, _y, _w, _h, _xmin, _xmax, _ymin, _ymax)     \
+  {                                                                         \
+    if (_image->color_space == IM_RGB)                                      \
+    {                                                                       \
+      if (_image->has_alpha)                                                \
+        cdCanvasPutImageRectRGBA(_canvas, _image->width, _image->height,    \
+                          (unsigned char*)_image->data[0],                  \
+                          (unsigned char*)_image->data[1],                  \
+                          (unsigned char*)_image->data[2],                  \
+                          (unsigned char*)_image->data[3],                  \
+                          _x, _y, _w, _h, _xmin, _xmax, _ymin, _ymax);      \
+      else                                                                  \
+        cdCanvasPutImageRectRGB(_canvas, _image->width, _image->height,     \
+                          (unsigned char*)_image->data[0],                  \
+                          (unsigned char*)_image->data[1],                  \
+                          (unsigned char*)_image->data[2],                  \
+                          _x, _y, _w, _h, _xmin, _xmax, _ymin, _ymax);      \
+    }                                                                       \
+    else                                                                    \
+      cdCanvasPutImageRectMap(_canvas, _image->width, _image->height,       \
+                        (unsigned char*)_image->data[0], _image->palette,   \
+                        _x, _y, _w, _h, _xmin, _xmax, _ymin, _ymax);        \
+  }                                                                               
+
+
+#if	defined(__cplusplus)
+}
+#endif
+
+#endif