git.maemo.org Git - opencv/blob - docs/HTML/release_notes.htm

   1 <HTML>
   2   <HEAD>
   3     <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
   4     <META NAME="Generator" CONTENT="Microsoft Word 97">
   5     <META NAME="Template" CONTENT="D:\WIN32APP\msoffice97\Office\html.dot">
   6     <META NAME="GENERATOR" CONTENT="Microsoft FrontPage 4.0">
   7     <META NAME="Author" CONTENT="Gary Bradski">
   8     <META NAME="Description" CONTENT="Header for main functions">
   9     <META NAME="KeyWords" CONTENT="CV.h">
  10     <TITLE>Release Notes</TITLE>
  11     <!-- Formatted and proofed in GNU Emacs by: Michael Chu, 00.06.05 -->
  12   </HEAD>
  13   <BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
  14     <a name="top">
  15
  16     <CENTER><TABLE CELLSPACING=0 CELLPADDING=5 WIDTH="90%" BGCOLOR="#6A9BED" NOSAVE >
  17     <TR NOSAVE>
  18       <TD NOSAVE>
  19         <h1 align="center">
  20         Open Source Computer Vision Libray</h1>
  21         <p align="center">
  22         <i><font size="+4" color="#000000">
  23           Release Notes
  24         </font></i></p>
  25       </TD>
  26     </TR>
  27       </TABLE></CENTER>
  28
  29
  30
  31     </a><h2>Index</h2>
  32     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#Overview">Overview</a></p>
  33     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#Usage model">Usage
  34     Model and Manual</a></p>
  35     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#What's Open">What's
  36     Open What's Not</a></p>
  37     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#System Requirements">System
  38     Requirements</a></p>
  39     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#License">License</a></p>
  40     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#Installation">Installation</a></p>
  41     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#Directory Structure">Directory
  42     Structure</a></p>
  43     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#Known Problems">Known
  44     Problems</a></p>
  45     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#Q&amp;A">Q&amp;A</a></p>
  46     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a href="#Contact Info">Contact
  47     Info</a></p>
  48     <h1><a name="Overview"></a>Overview</h1>
  49     <p><br>
  50
  51 This is a community effort, code and algorithm contribution of new and
  52 existing algorithms are encouraged. The library targets 3 areas of use.</p>
  53
  54     <ul>
  55       <li>Commercial: Performance optimized code for use in commercial applications that are free for use, modification and redistribution (subject to the license);</li>
  56       <li>Research: A common substrate for disseminating new work that, in addition, is largely optimized;</li>
  57       <li>Tutorial: Documented code and algorithms intended to be used for teaching.</li>
  58     </ul>
  59     <p align="left">There are more than 300 functions in OpenCV that are tuned
  60     for faster execution on the latest Intel processors. Significant part of the
  61     library is optimized using MMX and SSE instructions.</p>
  62     <p align="left">The library performance and functionality are improving
  63     quickly.</p>
  64     <p align="left">Read the <a href="../../History.txt">history</a>  file for change history.
  65     The OpenCV API has changed. See the list of changes <a href="../../interface_changes.txt">here</a>.&nbsp;</p>
  66     <h2 style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a name="Usage model"></a>Usage
  67     model, Manual:</h2>
  68     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
  69     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">Write your
  70     code using library functions with reference to our the user manual <a href="../OpenCV%20Reference%20Manual.pdf">OpenCV
  71     Reference Manual.pdf</a>
  72     and the main header file <a href="functPage/functPage.htm">CV.h</a>.</p>
  73     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">Link
  74     against the library files:</p>
  75     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
  76     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">..\lib\cv.lib</p>
  77     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">..\OtherLibs\_Ipl\lib\msvc\ipl.lib</p>
  78     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
  79     <blockquote>
  80     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">depending on
  81     the demo application, you may also need&nbsp;</p>
  82     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">..\lib\HighGUI.lib</p>
  83     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">..\lib\vlgfmts.lib</p>
  84     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">..\OtherLibs\_Mkl\lib\Default\Intel\mkl_c.lib</p>
  85     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">..\DirectShow
  86     libraries</p>
  87     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
  88     </blockquote>
  89     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">The dynamic
  90     link libraries (<b>dll</b>) must be in the system path, or in the directory
  91     that you run your application from.&nbsp; The location of the dynamic link
  92     libraries is:</p>
  93     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
  94     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">..\bin</p>
  95     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">..\<a name="top">OtherLibs\_Ipl\bin </a> </p>
  96     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp; </p>
  97     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">Of course, if
  98     you are making use of DirectShow, you will need it's dll's in the path
  99     ..\DirectShow\bin</p>
 100     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
 101     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">When you run
 102     your application, cv.dll and ipl.dll will <i>automagically</i> look up the
 103     processor type and swap in the correct optimized dll. If it can't find the
 104     correct dll, or if it can't identify the processor type, the optimized C
 105     version will be used.&nbsp; The &quot;code names&quot; for libs and dlls
 106     are:</p>
 107     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
 108     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">cv.dll or
 109     cv.lib&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 110     Dll and import library that can be built from supplied sources (pure C code)</p>
 111     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">OptCVPX.dll
 112     and IppCVPX.dll&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; code, optimized for any
 113     IA32 processor.</p>
 114     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">OptCVM5.dll
 115     and IppCVM5.dll&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Pentium MMX assembly
 116     optimized code.</p>
 117     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">OptCVM6.dll
 118     and IppCVM6.dll&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Pentium II assembly
 119     optimized code.</p>
 120     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">OptCVA6.dll
 121     and IppCVA6.dll&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Pentium III assembly
 122     optimized code.</p>
 123     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">OptCVW7.dll
 124     and IppCVW7.dll&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Pentium 4 assembly
 125     optimized code.</p>
 126     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
 127     <h2 style="line-height: 100%; margin-top: 0; margin-bottom: 0"><a name="What's Open"></a>What's open,
 128     what's not:</h2>
 129     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
 130     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><b>Open</b>:</p>
 131     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
 132     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">All the C++
 133     and C source for the library, DirectShow filters and application demos as
 134     well as the Matlab code.</p>
 135     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">The C++/C
 136     library code compiles to build the cvPX.lib and cvPX.dll.</p>
 137     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
 138     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"><b>Closed</b>:</p>
 139     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
 140     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">The assembly
 141     language optimized versions of the C code for each processor that Intel is
 142     contributing to the code base.&nbsp;&nbsp;</p>
 143     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">The reason
 144     these are not open is that Intel is producing an array of primitive routines
 145     covering virtually all of its optimized libraries. These primitives will be
 146     freely re-distributable, but they will not be part of the open source
 147     computer vision library.&nbsp; For now, we have ship preliminar (though,
 148     stable) versions of these future optimized primitive routines inside the
 149     OptCVXX.dlls and IppCVXX.dlls, but we will
 150     use the actual primitives when they are released in Q3'2000.&nbsp; This
 151     change will not affect the C code.&nbsp;</p>
 152     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;</p>
 153     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"> If you think you have a good reason for needing the assembly source code please contact
 154     us.</p>
 155     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"> &nbsp;</p>
 156     <h2 style="line-height: 100%; margin-top: 0; margin-bottom: 0"> <a name="System Requirements"></a>System Requirements
 157     </h2>
 158     <h2 style="line-height: 100%; margin-top: 0; margin-bottom: 0"> &nbsp;
 159     </h2>
 160     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"> <b>Hardware requirements:</b> A Pentium
 161     MMX, Pentium Pro, Pentium II, Pentium III or Pentium 4 processor-based PC.  Memory should be appropriate for the image sizes needed. <br>
 162     <b>Recommended hardware:</b> Pentium III or Pentium 4 processor-based PC with USB
 163     ports, camera.&nbsp;<br>
 164     <b>Software requirements: </b> Win98, WinNT4.0, or Win2000. Microsoft Visual C++ 6.0.  The applications require
 165     DirectShow to be installed (6.0 for NT4.0 and 7.0+ for Win98, Win2000).  The various filters require
 166     graphedt.exe to be installed.  This may be downloaded with the full (LARGE) DirectShow download from
 167     <a href="http://microsoft.com/directx/homeuser/downloads/default.asp" target="_top">http://microsoft.com/directx/homeuser/downloads/default.asp</a>
 168     ~128MB.
 169     </p>
 170     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"> or
 171     </p>
 172     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"> Linux 2.2.x
 173     or 2.4.x, glibc 2.95. The application VMDemo requires Tcl/Tk 8.3 and <b>img</b>
 174     widget installed.
 175     </p>
 176     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"> <br>
 177     <b>Recommended software:</b> Win2000 (comes with DirectShow (runtime only,
 178     not SDK)) with graphedt.exe installed.
 179     </p>
 180     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"> or
 181     </p>
 182     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0"> Linux
 183     Slackware 7.1 or Linux RedHat 7.0.&nbsp;
 184     </p>
 185       <p style="text-indent: 0; margin: 0">&nbsp;</p>
 186       <p style="text-indent: 0; margin: 0">&nbsp;</p>
 187       <h2 style="text-indent: 0; margin: 0"><a name="License"></a>License Definitions</h2>
 188       <p style="text-indent: 0; margin: 0">&nbsp;</p>
 189       <p style="text-indent: 0; margin: 0">&nbsp;</p>
 190       <p style="text-indent: 0; margin: 0">Please see the license file <a href="../license.txt"> license.txt</a> for the license definitions and restrictions on the library.&nbsp;</p>
 191       <p style="text-indent: 0; margin: 0">&nbsp;</p>
 192       <h2>
 193
 194     <a name="Installation"></a>
 195
 196     Installation
 197     </h2>
 198       <h3>
 199
 200     Under Win32:
 201     </h3>
 202       <p>
 203
 204     The whole OpenCV delivery is broken up into several smaller packages:
 205     </p>
 206     <ul>
 207       <li>The core: CV and helper libraries sources and binaries, documentation
 208         (opencv_core_b1.zip)</li>
 209       <li>Demo appplications, DirectShow filters, scripting environment, tests
 210         for the library (opencv_apps_b1.zip). The package depends on the core
 211         package.</li>
 212       <li>Calibration toolbox for MATLAB (opencv_calib_toolbox.zip).</li>
 213     </ul>
 214       <p>
 215
 216     To install each package download it, uncompress and run setup.exe&nbsp;
 217     </p>
 218       <h3>
 219
 220     Under Linux:
 221     </h3>
 222     <p>There is a single package for Linux: opencv-linux-b1.tar.gz. The package
 223     content is the same as opencv_core_b1.zip, but additionally includes demo
 224     application VMDemo.
 225     </p>
 226     <p>To install it, do the following steps:
 227     </p>
 228     <ol>
 229       <li>To install the libraries, type:<br>
 230     ./configure<br>
 231     make<br>
 232     make install       # as root<br>
 233     ldconfig           # as root<br>
 234       </li>
 235       <li>
 236         <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">To run
 237         demo application VMDemo, you should have TCL/TK 8.3.x and "Img image format extension"
 238         widget installed.<br>
 239         (visit&nbsp; <a href="http://www.scriptics.com" target="_top">http://www.scriptics.com</a> to obtain TCL/TK and<br>
 240         <a href="http://members1.chello.nl/~j.nijtmans/img.html" target="_top">http://members1.chello.nl/~j.nijtmans/img.html
 241         </a> to obtain the widget).<br>
 242       </li>
 243     </ol>
 244       <h2>
 245
 246     <a name="Directory Structure"></a>
 247
 248     Directory Structure
 249     </h2>
 250       <p>
 251
 252     <pre style="line-height: 100%; margin-top: 0; margin-bottom: 0"><b>%Root folder%</b>
 253
 254  |
 255  + <b>_DSW</b>  // Workspace file for Microsoft Visual Studio and a few Perl utilities for statistics
 256  |
 257  + <b>CV</b>    // The library itself
 258  |  + Include   // External library interface
 259  |  + _Include  // Internal library interface
 260  |  + Make      // Project file
 261  |  + Src       // Source files
 262  |
 263  + <b>CVAux</b> // Additional (experimental) stuff.
 264  |
 265  + <b>Docs</b>  // documentation
 266  |  + HTML      // overview documentatation in HTML format
 267  |
 268  + <b>Bin</b>   // all the pre-built binaries
 269  |
 270  + <b>Lib</b>   // pre-built import and static libraries
 271  |
 272  + <b>Apps</b>  // Demo Applications
 273  |  |
 274  |  + CamShiftDemo // Application - Wrapper for CamShift Tracker Filter
 275  |  + VMDemo       // View Morphing demo
 276  |  + LkDemo       // Lucas-Kanade Pyramid-based Point Tracker
 277  |  + HMMDemo      // Hidden Markov Models Face Recognition Demo
 278  |  + StereoGR     // Stereo-based Gesture Recognition App for PointGrey Stereo Cameras
 279  |  + Hawk         // Scripting Environment
 280  |  + Common       // CImage and CCamera classes
 281  |
 282  + <b>Filters</b>  // Direct Show filters
 283  |  + CalibFilter // Camera Calibration filter
 284  |  + CamShift    // CamShift tracker
 285  |  + Condens     // ConDensation based tracker
 286  |  + Kalman      // Kalman filter based tracker
 287  |  + ProxyTrans  // Proxy DirectShow filter
 288  |
 289  + <b>OtherLibs</b>
 290  |   + _Mkl       // Math Kernel Library - used for tests on matrix functions
 291  |   + _IPL       // Image Processing Library - base library for the OpenCV
 292  |   + HighGUI    // Simple GUI library with platform-independed interface
 293  |   + VlGrFmts   // Library for reading/writing raster images
 294  |   + GestRec    // Experimental gesture recognition module
 295  |   + PtGrey     // Interface Module for PointGrey Stereo Camera
 296  |
 297  + <b>Tests</b>// sources for algorithmic tests
 298  </pre>
 299
 300  <h2>
 301      <a name="Known Problems"></a>
 302      Known Problems
 303     </h2>
 304     <ul>
 305       <li>Building of DirectShow-based filters and applications is not easy</li>
 306     </ul>
 307     <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <font size="2" face="Courier New">Look
 308     at </font> <a href="FAQ.htm"> FAQs</a><font size="2" face="Courier New">&nbsp;</font></p>
 309     <ul>
 310       <li>Sometimes demo applications don't detect WebCameras properly.</li>
 311     </ul>
 312     <blockquote>
 313       <p><font face="Courier New" size="2">Try to select another video format
 314       via vidcap utility.</font></p>
 315     </blockquote>
 316       <h2>
 317
 318     <a name="Q&amp;A"></a>
 319
 320     Q&amp;A:
 321     </h2>
 322       <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">
 323
 324     Q: How can I get an answer on my question about OpenCV?
 325     </p>
 326       <p style="line-height: 100%; margin-top: 0; margin-bottom: 0">
 327
 328     A: Look at <a href="FAQ.htm">FAQs</a>.&nbsp;&nbsp;
 329     </p>
 330       <h1>
 331
 332     <a name="Contact Info"></a>
 333
 334     Contact Info
 335     </h1>
 336     <p>
 337
 338     For questions, bug reports, patches and suggestions, send email to <a href="mailto:OpenCV@yahoogroups.com">OpenCV@yahoogroups.com</a>&nbsp;(it
 339     is a mailing list) or to Gary
 340     Bradski at <a href="mailto:gary.bradski@intel.com">gary.bradski@intel.com</a>.&nbsp; Keep in mind that
 341     this is a free library from a research lab when setting your expectations of
 342     support.&nbsp; If you would like to volunteer to become part of the support
 343     infrastructure please do contact us.
 344
 345       <br><Br>
 346     <hr noshade size=2 width=100%>
 347     <H3>
 348       <A NAME="Bottom"></A><A HREF="#Top">Back to Top<IMG SRC="up.gif" BORDER=0 height=26 width=30></A></H3>
 349
 350   </BODY>
 351 </HTML>