git.maemo.org Git - opencv/blob - interfaces/swig/general/typemaps.i

   1 /*M///////////////////////////////////////////////////////////////////////////////////////
   2 //
   3 //  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
   4 //
   5 //  By downloading, copying, installing or using the software you agree to this license.
   6 //  If you do not agree to this license, do not download, install,
   7 //  copy or use the software.
   8 //
   9 //
  10 //                        Intel License Agreement
  11 //                For Open Source Computer Vision Library
  12 //
  13 // Copyright (C) 2000, Intel Corporation, all rights reserved.
  14 // Third party copyrights are property of their respective owners.
  15 //
  16 // Redistribution and use in source and binary forms, with or without modification,
  17 // are permitted provided that the following conditions are met:
  18 //
  19 //   * Redistribution's of source code must retain the above copyright notice,
  20 //     this list of conditions and the following disclaimer.
  21 //
  22 //   * Redistribution's in binary form must reproduce the above copyright notice,
  23 //     this list of conditions and the following disclaimer in the documentation
  24 //     and/or other materials provided with the distribution.
  25 //
  26 //   * The name of Intel Corporation may not be used to endorse or promote products
  27 //     derived from this software without specific prior written permission.
  28 //
  29 // This software is provided by the copyright holders and contributors "as is" and
  30 // any express or implied warranties, including, but not limited to, the implied
  31 // warranties of merchantability and fitness for a particular purpose are disclaimed.
  32 // In no event shall the Intel Corporation or contributors be liable for any direct,
  33 // indirect, incidental, special, exemplary, or consequential damages
  34 // (including, but not limited to, procurement of substitute goods or services;
  35 // loss of use, data, or profits; or business interruption) however caused
  36 // and on any theory of liability, whether in contract, strict liability,
  37 // or tort (including negligence or otherwise) arising in any way out of
  38 // the use of this software, even if advised of the possibility of such damage.
  39 //
  40 //M*/
  41
  42
  43 // 2004-03-16, Gabriel Schreiber <schreiber@ient.rwth-aachen.de>
  44 //             Mark Asbach       <asbach@ient.rwth-aachen.de>
  45 //             Institute of Communications Engineering, RWTH Aachen University
  46
  47
  48 /**
  49  * We set our own error handling function using cvRedirectError.
  50  * (See also error.h)
  51  * This function throws an error (OpenCV itself never throws) which
  52  * we catch here. The error handling function (SendErrorToPython)
  53  * sets the Python error.
  54  * We need to return 0 here instead of an PyObject to tell Python
  55  * that an error has occured.
  56  */
  57 %exception
  58     {
  59     try { $action }
  60     catch (...)
  61         {
  62           SWIG_fail;
  63         }
  64     }
  65
  66
  67 /* include exception.i, so we can generate exceptions when we found errors */
  68 %include "exception.i"
  69
  70 %include "sizeof.i"
  71
  72 /**
  73  * IplImage has no reference counting of underlying data, which creates problems with double
  74  * frees after accessing subarrays in python -- instead, replace IplImage with CvMat, which
  75  * should be functionally equivalent, but has reference counting.
  76  * The potential shortcomings of this method are
  77  * 1. no ROI
  78  * 2. IplImage fields missing or named something else.
  79  */
  80 %typemap(in) IplImage * (IplImage header){
  81         void * vptr;
  82         int res = SWIG_ConvertPtr($input, (&vptr), $descriptor( CvMat * ), 0);
  83         if ( res == -1 ){
  84                 SWIG_exception( SWIG_TypeError, "%%typemap(in) IplImage * : could not convert to CvMat");
  85                 SWIG_fail;
  86         }
  87         $1 = cvGetImage((CvMat *)vptr, &header);
  88 }
  89
  90 /** For IplImage * return type, there are cases in which the memory should be freed and
  91  * some not.  To avoid leaks and segfaults, deprecate this return type and handle cases
  92  * individually
  93  */
  94 %typemap(out) IplImage * {
  95         SWIG_exception( SWIG_TypeError, "IplImage * return type is deprecated. Please file a bug report at www.sourceforge.net/opencvlibrary if you see this error message.");
  96         SWIG_fail;
  97 }
  98
  99 /** macro to convert IplImage return type to CvMat.  Note that this is only covers the case
 100  *  where the returned IplImage need not be freed.  If the IplImage header needs to be freed,
 101  *  then CvMat must take ownership of underlying data.  Instead, just handle these limited cases
 102  *  with CvMat equivalent.
 103  */
 104 %define %typemap_out_CvMat(func, decl, call)
 105 %rename (func##__Deprecated) func;
 106 %rename (func) func##__CvMat;
 107 %inline %{
 108 CvMat * func##__CvMat##decl{
 109         IplImage * im = func##call;
 110         if(im){
 111                 CvMat * mat = (CvMat *)cvAlloc(sizeof(CvMat));
 112                 mat = cvGetMat(im, mat);
 113                 return mat;
 114         }
 115         return false;
 116 }
 117 %}
 118 %enddef