由C++的泛型句柄类思考OpenCV的Ptr模板类

本文转自：http://www.cnblogs.com/liu-jun/archive/2013/03/24/2979648.html

OpenCV（计算机视觉库）2.4.4版本已经发布了，OpenCV发展到现在，由最初的C接口变成现在的C++接口，让开发者写程序越来越简单，接口越来越合理，也不用担心内存释放问题。但要理解内部的一些实现机制，还真要费点功夫，这对开发者的C++基础要求越来越高。本文就是笔者在做项目过程中的一点感悟，由C++泛型句柄类思考OpenCV的Ptr模板类的实现。

1、C++泛型句柄

类 

我们知道在包含指针成员的类中，需要特别注意类的复制控制，因为复制指针时只复制指针中的地址，而不会复制指针指向的对象。这将导致当两个指针同时指向同一对象时，很可能一个指针删除了一对象，另一指针的用户还认为基础对象仍然存在，此时就出现了悬垂指针。

当类中有指针成员时，一般有两种方式来管理指针成员：一是采用值型的方式管理，每个类对象都保留一份指针指向的对象的拷贝；另一种更好的方式是使用智能指针，从而实现指针指向的对象的共享。（可参看《C++ Primer第四版》P419）

 

智能指针(smart pointer)的一种通用实现技术是使用引用计数(reference count)。智能指针类将一个计数器与类指向的对象相关联，引用计数跟踪该类有多少个对象共享同一指针。

每次创建类的新对象时，初始化指针并将引用计数置为1；当对象作为另一对象的父本而创建时，拷贝构造函数拷贝指针并增加与之相应的引用计数；对一个对象进行赋值时，赋值操作符减少左操作数所指对象的引用计数（如果引用计数为减至0，则删除对象），并增加右操作数所指对象的引用计数；调用析构函数时，析构函数减少引用计数（如果引用计数减至0，则删除基础对象）。

 

智能指针实现引用计数有两种经典策略：一是引入辅助类（包含引用计数型），二是使用句柄类（分离引用计数型）。

• 辅助类的解决方案是，定义一个单独的具体类来封装指针和相应的引用计数。可参考我之前写的一个博客：http://www.cnblogs.com/liu-jun/archive/2013/03/01/2939396.html

辅助类实现智能指针代码如下，参考《C++沉思录》，利用UPoint类作为辅助类封装了指针Point*和引用计数，从而代替指针Point*。这个技术的主要思想是当多个Handle类的对象在堆上共享同一个Point*指向的内存区时，我们在这个内存区上多分配一点空间存放引用计数，那么我们就可以知道有多少个Handle类的对象在共享Point*指向的内存区，当引用计数为0时，我们就可以很放心的释放掉这块内存区，而不会出现悬垂指针了。

//辅助类UPoint
class UPoint{  
    private:  
        friend class Handle;  
        int u;  
        Point p;  
        UPoint(const Point& pp):u(1),p(pp)  
        {                
        }  
        UPoint(int xx,int yy):p(xx,yy),u(1)  
        {            
        }  
        UPoint():u(1)  
        {           
        }  
};  
  
class Handle{  
    public:  
        Handle():up(new UPoint)  
        {  
          
        }  
        Handle(int x,int y):up(new UPoint(x,y))  
        {  
          
        }  
        Handle(const Point& up):up(new UPoint(up))
        {  
          
        }  
       //复制构造函数
        Handle(const Handle& other):up(other.up)  
        {  
            ++up->u;  
        } 
        //赋值操作符
        Handle& operator=(const Handle& other)  
        {  
            ++other.up->u;  
            if(--up->u==0){  
                delete up;  
            }  
            up = other.up;  
            return *this;  
        }  
        ~Handle()  
        {  
            if(--up->u == 0){  
                delete up;  
            }  
        }               
    private:  
            UPoint *up;  
};

基于辅助类的智能指针实现方式需要创建一个依赖于Point类的新类，这样做对于特定的类而言是很好，但却让我们很难将句柄绑定到Point类派生的新类对象上。因此，就有了分离引用计数型的句柄类实现了。可参看《C++ 沉思录》P69页，OpenCV中的智能指针模板类Ptr就是基于这种计数实现。
下面是采用模板的方式实现的一个泛型句柄类（分离引用计数型），参考《C++ Primer第四版》P561。从下面可以看出辅助类消失了，在这个句柄类中，我们用指向类型T的指针（共享对象，类似于上面的Point类型）和指向一个int的指针表示引用计数。使用T*很重要，因为正是T*使我们不仅能够将一个Handle绑定到一个T类型的对象，还能将其绑定到一个继承自T的类的对象。

这个类模板的数据成员有两个：指向某个实际需要管理的类型的数据的指针以及它的引用计数。它定义了复制构造函数、赋值操作符以及解引、成员访问操作符。其中解引操作符返回的是实际需要管理的数据，而箭头操作符返回的是这个指针。这两个操作符使得我们操作Handle<T>的对象就跟操作T的对象一样。

#ifndef HANDLE_H
#define HANDLE_H

template <class T> class Handle
{
public:
    //构造函数：空指针
    Handle(T *p = 0):ptr(p),use(new size_t(1)){}
    //重载解引和箭头操作符
    T& operator*();
    T* operator->();
    const T& operator*()const;
    const T* operator->()const;
    //复制构造函数
    Handle(const Handle& h):ptr(h.ptr),use(h.use){++*use;}
    //重载赋值操作符
    Handle& operator=(const Handle&);
    //析构函数
    ~Handle(){rem_ref();};
private:
    //共享的对象
    T *ptr;
    //引用计数
    size_t *use;
    //删除指针的具体函数
    void rem_ref()
    {
        if(--*use == 0)
        {
            delete ptr;
            delete use;
        }
    }
};

template<class T>
inline Handle<T>& Handle<T>::operator=(const Handle &rhs)
{
    //右操作数引用计数+1
    ++*rhs.use;
    //删除左操作数
    rem_ref();
    //具体对象的赋值
    ptr = rhs.ptr;
    use = rhs.use;
    return *this;
}

template <class T> inline T& Handle<T>::operator*()
{
    if(ptr)
        return *ptr;
    //空指针时抛出异常
    throw std::runtime_error("dereference of unbound Handle");
}

template <class T> inline T* Handle<T>::operator->()
{
    if(ptr)
        return ptr;
    //空指针时抛出异常
    throw std::runtime_error("access through unbound Handle");
}

template <class T> inline const T& Handle<T>::operator*()const
{
    if(ptr)
        return *ptr;
    throw std::runtime_error("dereference of unbound Handle");
}

template <class T> inline const T* Handle<T>::operator->()const
{
    if(ptr)
        return ptr;
    throw std::runtime_error("access through unbound Handle");    
}

#endif

2、OpenCV中的智能指针模板类

Ptr                                                                                                                                                                                   

以上了解了C++中的泛型句柄类实现后，我们来看看OpenCV中怎么利用泛型句柄类来管理OpenCV中的资源。

在OpenCV2.4.2后，添加了FaceRecognizer这个人脸识别类。其中实现了人脸识别中的三种算法：Eigenface、FisherFace和基于LBP特征的算法。这三种算法也分别封装成三个类：Eigenfaces、Fisherfaces、LBPH类，这三个类均派生自FaceRecognizer类，而FaceRecognizer类则派生自Algorithm类。FaceRecognizer类是一个抽象基类，它的头文件在contrib.hpp中（以OpenCV2.4.4为例），下面是它的头文件。

class CV_EXPORTS_W FaceRecognizer : public Algorithm
    {
    public:
        //! virtual destructor
        virtual ~FaceRecognizer() {}

        // Trains a FaceRecognizer.
        CV_WRAP virtual void train(InputArrayOfArrays src, InputArray labels) = 0;

        // Updates a FaceRecognizer.
        CV_WRAP void update(InputArrayOfArrays src, InputArray labels);

        // Gets a prediction from a FaceRecognizer.
        virtual int predict(InputArray src) const = 0;

        // Predicts the label and confidence for a given sample.
        CV_WRAP virtual void predict(InputArray src, CV_OUT int &label, CV_OUT double &confidence) const = 0;

        // Serializes this object to a given filename.
        CV_WRAP virtual void save(const string& filename) const;

        // Deserializes this object from a given filename.
        CV_WRAP virtual void load(const string& filename);

        // Serializes this object to a given cv::FileStorage.
        virtual void save(FileStorage& fs) const = 0;

        // Deserializes this object from a given cv::FileStorage.
        virtual void load(const FileStorage& fs) = 0;

    };

以人脸识别FaceRecognizer类为例，OpenCV就是采用一个泛型句柄类Ptr管理FaceRecognizer类的对象。先来看看OpenCV中的Ptr类是怎么实现的。OpenCV中的Ptr模板类头文件在core.hpp（以OpenCV2.4.4为例），源文件则在operations.hpp（以OpenCV2.4.4为例）。

Ptr模板类头文件：

template<typename _Tp> class CV_EXPORTS Ptr
{
public:
    //! empty constructor
    Ptr();
    //! take ownership of the pointer. The associated reference counter is allocated and set to 1
    Ptr(_Tp* _obj);
    //! calls release()
    ~Ptr();
    //! copy constructor. Copies the members and calls addref()
    Ptr(const Ptr& ptr);
    template<typename _Tp2> Ptr(const Ptr<_Tp2>& ptr);
    //! copy operator. Calls ptr.addref() and release() before copying the members
    Ptr& operator = (const Ptr& ptr);
    //! increments the reference counter
    void addref();
    //! decrements the reference counter. If it reaches 0, delete_obj() is called
    void release();
    //! deletes the object. Override if needed
    void delete_obj();
    //! returns true iff obj==NULL
    bool empty() const;

    //! cast pointer to another type
    template<typename _Tp2> Ptr<_Tp2> ptr();
    template<typename _Tp2> const Ptr<_Tp2> ptr() const;

    //! helper operators making "Ptr<T> ptr" use very similar to "T* ptr".
    _Tp* operator -> ();
    const _Tp* operator -> () const;

    operator _Tp* ();
    operator const _Tp*() const;

    _Tp* obj; //< the object pointer.
    int* refcount; //< the associated reference counter
};

Ptr模板类源文件：

/// Ptr 


template<typename _Tp> inline Ptr<_Tp>::Ptr() : obj(0), refcount(0) {}
template<typename _Tp> inline Ptr<_Tp>::Ptr(_Tp* _obj) : obj(_obj)
{
    if(obj)
    {
        refcount = (int*)fastMalloc(sizeof(*refcount));
        *refcount = 1;
    }
    else
        refcount = 0;
}

template<typename _Tp> inline void Ptr<_Tp>::addref()
{ if( refcount ) CV_XADD(refcount, 1); }


template<typename _Tp> inline void Ptr<_Tp>::release()
{
    if( refcount && CV_XADD(refcount, -1) == 1 )
    {
        delete_obj();
        fastFree(refcount);
    }
    refcount = 0;
    obj = 0;
}

template<typename _Tp> inline void Ptr<_Tp>::delete_obj()
{
    if( obj ) delete obj;
}

template<typename _Tp> inline Ptr<_Tp>::~Ptr() { release(); }


template<typename _Tp> inline Ptr<_Tp>::Ptr(const Ptr<_Tp>& _ptr)
{
    obj = _ptr.obj;
    refcount = _ptr.refcount;
    addref();
}

template<typename _Tp> inline Ptr<_Tp>& Ptr<_Tp>::operator = (const Ptr<_Tp>& _ptr)
{
    int* _refcount = _ptr.refcount;
    if( _refcount )
        CV_XADD(_refcount, 1);
    release();
    obj = _ptr.obj;
    refcount = _refcount;
    return *this;
}

template<typename _Tp> inline _Tp* Ptr<_Tp>::operator -> () { return obj; }
template<typename _Tp> inline const _Tp* Ptr<_Tp>::operator -> () const { return obj; }

template<typename _Tp> inline Ptr<_Tp>::operator _Tp* () { return obj; }
template<typename _Tp> inline Ptr<_Tp>::operator const _Tp*() const { return obj; }

template<typename _Tp> inline bool Ptr<_Tp>::empty() const { return obj == 0; }

template<typename _Tp> template<typename _Tp2> Ptr<_Tp>::Ptr(const Ptr<_Tp2>& p)
    : obj(0), refcount(0)
{
    if (p.empty())
        return;

    _Tp* p_casted = dynamic_cast<_Tp*>(p.obj);
    if (!p_casted)
        return;

    obj = p_casted;
    refcount = p.refcount;
    addref();
}

template<typename _Tp> template<typename _Tp2> inline Ptr<_Tp2> Ptr<_Tp>::ptr()
{
    Ptr<_Tp2> p;
    if( !obj )
        return p;

    _Tp2* obj_casted = dynamic_cast<_Tp2*>(obj);
    if (!obj_casted)
        return p;

    if( refcount )
        CV_XADD(refcount, 1);

    p.obj = obj_casted;
    p.refcount = refcount;
    return p;
}

template<typename _Tp> template<typename _Tp2> inline const Ptr<_Tp2> Ptr<_Tp>::ptr() const
{
    Ptr<_Tp2> p;
    if( !obj )
        return p;

    _Tp2* obj_casted = dynamic_cast<_Tp2*>(obj);
    if (!obj_casted)
        return p;

    if( refcount )
        CV_XADD(refcount, 1);

    p.obj = obj_casted;
    p.refcount = refcount;
    return p;
}

 specializied implementations of Ptr::delete_obj() for classic OpenCV types

template<> CV_EXPORTS void Ptr<CvMat>::delete_obj();
template<> CV_EXPORTS void Ptr<IplImage>::delete_obj();
template<> CV_EXPORTS void Ptr<CvMatND>::delete_obj();
template<> CV_EXPORTS void Ptr<CvSparseMat>::delete_obj();
template<> CV_EXPORTS void Ptr<CvMemStorage>::delete_obj();
template<> CV_EXPORTS void Ptr<CvFileStorage>::delete_obj();

可以看出，OpenCV中的智能指针Ptr模板类就是采用分离引用计数型的句柄类实现技术。

下面来看看在OpenCV中怎么应用Ptr模板类来管理OpenCV的资源对象，以人脸识别FaceRecognizer类为例。

当创建一个FaceRecognizer的派生类Eigenfaces的对象时，我们把这个Eigenfaces对象放进Ptr<FaceRecognizer>对象内，就可以依赖句柄类Ptr<FaceRecognizer>确保Eigenfaces对象自动被释放。

// Let's say we want to keep 10 Eigenfaces and have a threshold value of 10.0
int num_components = 10;
double threshold = 10.0;
// Then if you want to have a cv::FaceRecognizer with a confidence threshold,
// create the concrete implementation with the appropiate parameters:
Ptr<FaceRecognizer> model = createEigenFaceRecognizer(num_components, threshold);

第6行的createEigenFaceRecognizer函数的源码在facerec.cpp中，如下所示。

Ptr<FaceRecognizer> createEigenFaceRecognizer(int num_components, double threshold)
 {
     return new Eigenfaces(num_components, threshold);
 }

 我们来分析下上面两段代码，其中Ptr<FaceRecognizer>model= createEigenFaceRecognizer(num_components,threshold);
当利用createEigenFaceRecognizer动态创建一个Eigenfaces的对象后，立即把它放进Ptr<FaceRecognizer>中进行管理。这和《Effective C++:55 Specific Ways to Improve Your Programs and Designe 3rd Edition》中的条款13不谋而合，即获得资源后立即放进管理对象，管理对象运用析构函数确保资源被释放。

我们注意到在createEigenFaceRecognizer实现源码中，返回了动态创建地Eigenfaces对象，并且隐式的转换成Ptr<FaceRecognizer>。（注意：这里的隐式转换依赖于Ptr<FaceRecognizer>的构造函数，相关知识可参考《C++ Primer第四版》P394页）

这个返回智能指针的设计非常好，在《Effective C++:55 Specific Ways to Improve Your Programs and Designe 3rd Edition》中条款18中提到：任何接口如果要求客户必须记得某些事情，就有着“不正确使用”的倾向，因为客户可能会忘记做那件事。

这里也一样，万一客户（即使用OpenCV库的开发者）忘记使用智能指针Ptr类怎么办？因此，许多时候，较佳接口的设计原则采用先发制人，这里就是令createEigenFaceRecognizer返回一个智能指针Ptr<FaceRecognizer>。

这样，开发者就必须采用这样的方式来创建Eigenfaces对象：Ptr<FaceRecognizer>model= createEigenFaceRecognizer(num_components,threshold);