svlBufferMemory.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*
  
  Author(s):  Balazs Vagvolgyi
  Created on: 2010

  (C) Copyright 2006-2010 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---

*/

#ifndef _svlBufferMemory_h
#define _svlBufferMemory_h

#include <cisstVector/vctDynamicMatrixTypes.h>
#include <cisstOSAbstraction/osaThreadSignal.h>
#include <cisstOSAbstraction/osaCriticalSection.h>

#if (CISST_OS == CISST_WINDOWS)
#include <windows.h>
#endif 

// Always include last!
#include <cisstStereoVision/svlExport.h>


class CISST_EXPORT svlBufferMemory
{
public:
    svlBufferMemory(unsigned int max_size);

    unsigned int GetMaxSize();

    unsigned char* GetPushBuffer();
    void Push(unsigned int used);

    bool Push(unsigned char* buffer, unsigned int used);

    unsigned char* Pull(unsigned int& used, double timeout);

private:
    svlBufferMemory();

#if (CISST_OS == CISST_WINDOWS)
    LONG Next, Latest, Locked;
#else
    unsigned int Next, Latest, Locked;
#endif
    osaThreadSignal NewFrameEvent;
    vctDynamicMatrix<unsigned char> Buffer;
    vctDynamicVector<unsigned int>  Used;

#if (CISST_OS == CISST_LINUX_RTAI) || (CISST_OS == CISST_LINUX) || (CISST_OS == CISST_DARWIN) || (CISST_OS == CISST_SOLARIS)
    osaCriticalSection CS;
#endif
};

#endif // _svlBufferMemory_h