summaryrefslogtreecommitdiff
path: root/im/include/im_format_avi.h
diff options
context:
space:
mode:
authorPixel <pixel@nobis-crew.org>2009-11-04 11:56:41 -0800
committerPixel <pixel@nobis-crew.org>2009-11-04 11:59:33 -0800
commitd577d991b97ae2b5ee1af23641bcffc3f83af5b2 (patch)
tree590639d50205d1bcfaff2a7d2dc6ebf3f373c7ed /im/include/im_format_avi.h
Initial import. Contains the im, cd and iup librairies, and a "working" Makefile for them under linux.
Diffstat (limited to 'im/include/im_format_avi.h')
-rwxr-xr-xim/include/im_format_avi.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/im/include/im_format_avi.h b/im/include/im_format_avi.h
new file mode 100755
index 0000000..535aa37
--- /dev/null
+++ b/im/include/im_format_avi.h
@@ -0,0 +1,88 @@
+/** \file
+ * \brief Register the AVI Format
+ *
+ * See Copyright Notice in im_lib.h
+ */
+
+#ifndef __IM_FORMAT_AVI_H
+#define __IM_FORMAT_AVI_H
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+/** \defgroup avi AVI - Windows Audio-Video Interleaved RIFF
+ * \section Description
+ *
+ * \par
+ * Windows Copyright Microsoft Corporation.
+ * \par
+ * Access to the AVI format uses Windows AVIFile library. Available in Windows Only. \n
+ * When writing a new file you must use an ".avi" extension, or the Windows API will fail. \n
+ * You must link the application with "im_avi.lib"
+ * and you must call the function \ref imFormatRegisterAVI once
+ * to register the format into the IM core library.
+ * In Lua call require"imlua_avi". \n
+ * Depends also on the VFW library (vfw32.lib).
+ * When using the "im_avi.dll" this extra library is not necessary. \n
+ * If using Cygwin or MingW must link with "-lvfw32".
+ * Old versions of Cygwin and MingW use the "-lvfw_ms32" and "-lvfw_avi32".
+ * \par
+ * See \ref im_format_avi.h
+ *
+ * \section Features
+ *
+\verbatim
+ Data Types: Byte
+ Color Spaces: RGB, MAP and Binary (Gray saved as MAP)
+ Compressions (installed in Windows XP by default):
+ NONE - no compression [default]
+ RLE - Microsoft RLE (8bpp only)
+ CINEPACK - Cinepak Codec by Radius
+ MSVC - Microsoft Video 1 (old)
+ M261 - Microsoft H.261 Video Codec
+ M263 - Microsoft H.263 Video Codec
+ I420 - Intel 4:2:0 Video Codec (same as M263)
+ IV32 - Intel Indeo Video Codec 3.2 (old)
+ IV41 - Intel Indeo Video Codec 4.5 (old)
+ IV50 - Intel Indeo Video 5.1
+ IYUV - Intel IYUV Codec
+ MPG4 - Microsoft MPEG-4 Video Codec V1 (not MPEG-4 compliant) (old)
+ MP42 - Microsoft MPEG-4 Video Codec V2 (not MPEG-4 compliant)
+ CUSTOM - (show compression dialog)
+ DIVX - DivX 5.0.4 Codec (DivX must be installed)
+ (others, must be the 4 charaters of the fourfcc code)
+ 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. But are saved always as bottom up.
+ Handle(0) returns NULL. imBinFile is not supported.
+ Handle(1) returns PAVIFILE.
+ Handle(2) returns PAVISTREAM.
+
+ Attributes:
+ FPS IM_FLOAT (1) (should set when writing, default 15)
+ AVIQuality IM_INT (1) [1-10000, default -1] (write only) [unsed if compression=CUSTOM]
+ KeyFrameRate IM_INT (1) (write only) [key frame frequency, if 0 not using key frames, default 15, unsed if compression=CUSTOM]
+ DataRate IM_INT (1) (write only) [kilobits/second, default 2400, unsed if compression=CUSTOM]
+
+ Comments:
+ 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 codecs comparsion and download go to:
+ http://graphics.lcs.mit.edu/~tbuehler/video/codecs/
+ http://www.fourcc.org
+\endverbatim
+ * \ingroup format */
+
+/** Register the AVI Format. \n
+ * In Lua, when using require"imlua_avi" this function will be automatically called.
+ * \ingroup avi */
+void imFormatRegisterAVI(void);
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif