class dlstreamer::BaseContext

Overview

#include <context.h>

class BaseContext: public dlstreamer::Context {
public:
    // structs

    struct key;

    // construction

    BaseContext(MemoryType memory_type);

    // methods

    virtual MemoryType memory_type() const;
    virtual handle_t handle(std::string_view key) const;
    virtual std::vector<std::string> keys() const;

    virtual MemoryMapperPtr get_mapper(
        const ContextPtr& input_context,
        const ContextPtr& output_context
    );

    virtual ContextPtr derive_context(MemoryType memory_type);
    virtual ContextPtr parent();
    void set_parent(ContextPtr parent);
    void set_memory_type(MemoryType memory_type);
    void attach_mapper(MemoryMapperPtr mapper);
    void remove_mapper(MemoryMapperPtr mapper);
};

// direct descendants

class CPUContext;
class DMAContext;
class FFmpegContext;
class GSTContext;
class GSTContextQuery;
class LevelZeroContext;
class OpenCLContext;
class OpenCVContext;
class OpenCVUMatContext;
class OpenVINOContext;
class VAAPIContext;

Inherited Members

public:
    // typedefs

    typedef void* handle_t;

    // methods

    virtual MemoryType memory_type() const = 0;
    virtual handle_t handle(std::string_view key = {}) const = 0;

    virtual MemoryMapperPtr get_mapper(
        const ContextPtr& input_context,
        const ContextPtr& output_context
    ) = 0;

    virtual ContextPtr derive_context(MemoryType memory_type) = 0;
    virtual ContextPtr parent() = 0;

Detailed Documentation

Methods

virtual MemoryType memory_type() const

Returns memory type of this context.

virtual handle_t handle(std::string_view key) const

Returns a handle by key. If empty key, returns default handle. If no handle with the specified key, returns 0.

Parameters:

key	the key of the handle to find

virtual MemoryMapperPtr get_mapper(
    const ContextPtr& input_context,
    const ContextPtr& output_context
)

Returns an object for memory mapping between two contexts. Function typically expects one of contexts to be this context. If one of contexts has memory type CPU or context reference is nullptr, function returns object for mapping to or from system memory. If creating memory mapping object failed, exception is thrown.

Parameters:

input_context	Context of input memory
output_context	Context of output memory

virtual ContextPtr derive_context(MemoryType memory_type)

Create another context of specified memory type. New context belongs to same device (if multiple GPUs) as original context, and parent() returns reference to original context. If creating new context failed, function returns nullptr.

Parameters:

memory_type

Memory type of new context

virtual ContextPtr parent()

Returns parent context if this context was created from another context via derive_context(), nullptr otherwise.