FrameSource.hpp

Go to the documentation of this file.

/*
# Copyright (c) 2014-2016, NVIDIA CORPORATION. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#  * Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  * Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#  * Neither the name of NVIDIA CORPORATION nor the names of its
#    contributors may be used to endorse or promote products derived
#    from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef NVXIO_FRAMESOURCE_HPP
#define NVXIO_FRAMESOURCE_HPP

#include <memory>
#include <string>

#include <VX/vx.h>
#include <NVXIO/Export.hpp>

namespace nvxio
{
class NVXIO_EXPORT FrameSource
{
public:
    struct Parameters
    {
        vx_uint32 frameWidth; 
        vx_uint32 frameHeight; 
        vx_df_image format; 
        vx_uint32 fps; 
        Parameters():
            frameWidth(-1),
            frameHeight(-1),
            format(VX_DF_IMAGE_VIRT),
            fps(-1)
        {}
    };

    enum SourceType
    {
        UNKNOWN_SOURCE, 
        SINGLE_IMAGE_SOURCE, 
        IMAGE_SEQUENCE_SOURCE, 
        VIDEO_SOURCE, 
        CAMERA_SOURCE 
    };

    enum FrameStatus
    {
        OK, 
        TIMEOUT, 
        CLOSED 
    };

    virtual bool open() = 0;

    virtual FrameSource::FrameStatus fetch(vx_image image, vx_uint32 timeout = 5 /*milliseconds*/) = 0;

    virtual FrameSource::Parameters getConfiguration() = 0;

    virtual bool setConfiguration(const FrameSource::Parameters& params) = 0;

    virtual void close() = 0;

    virtual ~FrameSource()
    {}

    FrameSource::SourceType getSourceType() const
    {
        return sourceType;
    }

    std::string getSourceName() const
    {
        return sourceName;
    }

protected:
    FrameSource(FrameSource::SourceType type = FrameSource::UNKNOWN_SOURCE, const std::string & name = "Undefined"):
        sourceType(type),
        sourceName(name)
    {}

    const FrameSource::SourceType  sourceType;
    const std::string sourceName;
};

NVXIO_EXPORT std::unique_ptr<FrameSource> createDefaultFrameSource(vx_context context, const std::string& uri);

NVXIO_EXPORT vx_image loadImageFromFile(vx_context context, const std::string& fileName, vx_df_image format = VX_DF_IMAGE_RGB);

}

#endif // NVXIO_FRAMESOURCE_HPP