im.format_avi source code

1 /** \file
2  * \brief Register the AVI Format
3  *
4  * See Copyright Notice in im_lib.d
5  */
6 
7 module im.format_avi;
8 
9 extern (C) @safe nothrow:
10 
11 /** \defgroup avi AVI - Windows Audio-Video Interleaved RIFF
12  * \section Description
13  *
14  * \par
15  * Windows Copyright Microsoft Corporation.
16  * \par
17  * Access to the AVI format uses Windows AVIFile library. Available in Windows Only. \n
18  * When writing a new file you must use an ".avi" extension, or the Windows API will fail. \n
19  * You must link the application with "im_avi.lib"
20  * and you must call the function \ref imFormatRegisterAVI once
21  * to register the format into the IM core library.
22  * In Lua call require"imlua_avi". \n
23  * Depends also on the VFW library (vfw32.lib).
24  * When using the "im_avi.dll" this extra library is not necessary. \n
25  * If using Cygwin or MingW must link with "-lvfw32".
26  * Old versions of Cygwin and MingW use the "-lvfw_ms32" and "-lvfw_avi32".
27  * \par
28  * See \ref im_format_avi.h
29  *
30  * \section Features
31  *
32 \verbatim
33     Data Types: Byte
34     Color Spaces: RGB, MAP and Binary (Gray saved as MAP)
35     Compressions (installed in Windows XP by default):
36       NONE     - no compression [default]
37       RLE      - Microsoft RLE (8bpp only)
38       CINEPACK - Cinepak Codec by Radius
39       MSVC     - Microsoft Video 1 (old)  (8bpp and 16bpp only)
40       M261     - Microsoft H.261 Video Codec
41       M263     - Microsoft H.263 Video Codec
42       I420     - Intel 4:2:0 Video Codec (same as M263)
43       IV32     - Intel Indeo Video Codec 3.2 (old)
44       IV41     - Intel Indeo Video Codec 4.5 (old)
45       IV50     - Intel Indeo Video 5.1
46       IYUV     - Intel IYUV Codec
47       MPG4     - Microsoft MPEG-4 Video Codec V1 (not MPEG-4 compliant) (old)
48       MP42     - Microsoft MPEG-4 Video Codec V2 (not MPEG-4 compliant)
49       CUSTOM   - (show compression dialog)
50       DIVX     - DivX 5.0.4 Codec (DivX must be installed)
51       (others, must be the 4 charaters of the fourfcc code)
52     Can have more than one image.
53     Can have an alpha channel (only for RGB)
54     Internally the components are always packed.
55     Lines arranged from top down to bottom or bottom up to top. But are saved always as bottom up.
56     Handle(0) returns NULL. imBinFile is not supported.
57     Handle(1) returns PAVIFILE.
58     Handle(2) returns PAVISTREAM.
59 
60     Attributes:
61       FPS IM_FLOAT (1) (should set when writing, default 15)
62       AVIQuality IM_INT (1) [1-10000, default -1] (write only) [unsed if compression=CUSTOM]
63       KeyFrameRate IM_INT (1) (write only) [key frame frequency, if 0 not using key frames, default 15, unsed if compression=CUSTOM]
64       DataRate IM_INT (1) (write only) [kilobits/second, default 2400, unsed if compression=CUSTOM]
65 
66     Comments:
67       Reads only the first video stream. Other streams are ignored.
68       All the images have the same size, you must call imFileReadImageInfo/imFileWriteImageInfo
69         at least once.
70       For codecs comparsion and download go to:
71         http://graphics.lcs.mit.edu/~tbuehler/video/codecs/
72         http://www.fourcc.org
73 \endverbatim
74  * \ingroup format */
75 
76 /** Register the AVI Format. \n
77  * In Lua, when using require"imlua_avi" this function will be automatically called.
78  * \ingroup avi */
79 void imFormatRegisterAVI();