NVIDIA DeepStream SDK API Reference

9.0 Release
ds3d::impl::BaseImplDataLoader Class Referenceabstract

Detailed Description

Any custom dataloader must derive from BaseImplDataLoader, For convenience, If dataloader is in sync mode, user can also derive from SyncImplDataLoader.

For custom lib implementation, user need to implement the following virtual functions: startImpl(), // user also need setCaps(port) in startImpl stopImpl(), // stop all resources for dataloader readDataImpl(), // read data in sync mode, return kEndOfStream if end of stream. readDataAsyncImpl(dataReadyCb), // read data in async mode. Once data is ready, need call dataReadyCb(datamap) to notify application flushImpl(), // flush data in process

Definition at line 36 of file sources/includes/ds3d/common/impl/impl_dataloader.h.

Inheritance diagram for ds3d::impl::BaseImplDataLoader:
Collaboration diagram for ds3d::impl::BaseImplDataLoader:

Public Types

using OnGuardDataCBImpl = std::function< void(ErrCode, GuardDataMap)>
 
using OnGuardDataCBImpl = std::function< void(ErrCode, GuardDataMap)>
 
using OnGuardBridgeDataCBImpl = std::function< void(ErrCode, const struct VideoBridge2dInput *)>
 
using OnGuardBridgeDataCBImpl = std::function< void(ErrCode, const struct VideoBridge2dInput *)>
 
using ImplMutex = std::recursive_mutex
 
using ImplMutex = std::recursive_mutex
 

Public Member Functions

 BaseImplDataLoader ()
 
 ~BaseImplDataLoader () override=default
 
ErrCode readData_i (abiRefDataMap *&datamap) final
 
ErrCode readDataAsync_i (const abiOnDataCB *dataReadyCb) final
 
 BaseImplDataLoader ()
 
 ~BaseImplDataLoader () override=default
 
ErrCode readData_i (abiRefDataMap *&datamap) final
 
ErrCode readDataAsync_i (const abiOnDataCB *dataReadyCb) final
 
void setUserData_i (const abiRefAny *userdata) final
 
void setUserData_i (const abiRefAny *userdata) final
 
const abiRefAnygetUserData_i () const final
 
const abiRefAnygetUserData_i () const final
 
virtual const abiRefAnygetUserData_i () const =0
 
void setErrorCallback_i (const abiErrorCB &cb) final
 
void setErrorCallback_i (const abiErrorCB &cb) final
 
ErrCode start_i (const char *configStr, uint32_t strLen, const char *path) override
 
ErrCode start_i (const char *configStr, uint32_t strLen, const char *path) override
 
const char * getCaps_i (CapsPort p) const final
 
const char * getCaps_i (CapsPort p) const final
 
ErrCode flush_i () override
 
ErrCode flush_i () override
 
ErrCode stop_i () override
 
ErrCode stop_i () override
 
State state_i () const final
 
State state_i () const final
 
virtual State state_i () const =0
 

Protected Member Functions

virtual ErrCode readDataImpl (GuardDataMap &datamap)=0
 
virtual ErrCode readDataAsyncImpl (OnGuardDataCBImpl dataReadCB)=0
 
virtual ErrCode readDataImpl (GuardDataMap &datamap)=0
 
virtual ErrCode readDataAsyncImpl (OnGuardDataCBImpl dataReadCB)=0
 
virtual ErrCode startImpl (const std::string &content, const std::string &path)=0
 
virtual ErrCode startImpl (const std::string &content, const std::string &path)=0
 
virtual ErrCode stopImpl ()=0
 
virtual ErrCode stopImpl ()=0
 
virtual ErrCode flushImpl ()=0
 
virtual ErrCode flushImpl ()=0
 
void setOutputCaps (const std::string &caps)
 
void setOutputCaps (const std::string &caps)
 
void setInputCaps (const std::string &caps)
 
void setInputCaps (const std::string &caps)
 
void emitError (ErrCode code, const std::string &msg)
 
void emitError (ErrCode code, const std::string &msg)
 
State getStateSafe () const
 
State getStateSafe () const
 
void setStateSafe (State flag)
 
void setStateSafe (State flag)
 
ImplMutexmutex () const
 
ImplMutexmutex () const
 

Member Typedef Documentation

◆ ImplMutex [1/2]

using ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::ImplMutex = std::recursive_mutex
inherited

◆ ImplMutex [2/2]

using ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::ImplMutex = std::recursive_mutex
inherited

◆ OnGuardBridgeDataCBImpl [1/2]

◆ OnGuardBridgeDataCBImpl [2/2]

◆ OnGuardDataCBImpl [1/2]

◆ OnGuardDataCBImpl [2/2]

Constructor & Destructor Documentation

◆ BaseImplDataLoader() [1/2]

ds3d::impl::BaseImplDataLoader::BaseImplDataLoader ( )
inline

◆ ~BaseImplDataLoader() [1/2]

ds3d::impl::BaseImplDataLoader::~BaseImplDataLoader ( )
overridedefault

◆ BaseImplDataLoader() [2/2]

ds3d::impl::BaseImplDataLoader::BaseImplDataLoader ( )
inline

◆ ~BaseImplDataLoader() [2/2]

ds3d::impl::BaseImplDataLoader::~BaseImplDataLoader ( )
overridedefault

Member Function Documentation

◆ emitError() [1/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::emitError ( ErrCode  code,
const std::string &  msg 
)
inlineprotectedinherited

◆ emitError() [2/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::emitError ( ErrCode  code,
const std::string &  msg 
)
inlineprotectedinherited

◆ flush_i() [1/2]

ErrCode ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::flush_i
inlineoverridevirtualinherited

◆ flush_i() [2/2]

ErrCode ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::flush_i
inlineoverridevirtualinherited

◆ flushImpl() [1/2]

◆ flushImpl() [2/2]

◆ getCaps_i() [1/2]

const char* ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::getCaps_i ( CapsPort  p) const
inlinefinalvirtualinherited

◆ getCaps_i() [2/2]

const char* ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::getCaps_i ( CapsPort  p) const
inlinefinalvirtualinherited

◆ getStateSafe() [1/2]

State ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::getStateSafe
inlineprotectedinherited

◆ getStateSafe() [2/2]

State ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::getStateSafe
inlineprotectedinherited

◆ getUserData_i() [1/3]

virtual const abiRefAny* ds3d::abiProcess::getUserData_i ( ) const
pure virtualinherited

◆ getUserData_i() [2/3]

const abiRefAny* ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::getUserData_i
inlinefinalinherited

◆ getUserData_i() [3/3]

const abiRefAny* ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::getUserData_i
inlinefinalinherited

◆ mutex() [1/2]

◆ mutex() [2/2]

◆ readData_i() [1/2]

◆ readData_i() [2/2]

◆ readDataAsync_i() [1/2]

ErrCode ds3d::impl::BaseImplDataLoader::readDataAsync_i ( const abiOnDataCB dataReadyCb)
inlinefinalvirtual

◆ readDataAsync_i() [2/2]

ErrCode ds3d::impl::BaseImplDataLoader::readDataAsync_i ( const abiOnDataCB dataReadyCb)
inlinefinalvirtual

◆ readDataAsyncImpl() [1/2]

virtual ErrCode ds3d::impl::BaseImplDataLoader::readDataAsyncImpl ( OnGuardDataCBImpl  dataReadCB)
protectedpure virtual

◆ readDataAsyncImpl() [2/2]

virtual ErrCode ds3d::impl::BaseImplDataLoader::readDataAsyncImpl ( OnGuardDataCBImpl  dataReadCB)
protectedpure virtual

◆ readDataImpl() [1/2]

virtual ErrCode ds3d::impl::BaseImplDataLoader::readDataImpl ( GuardDataMap datamap)
protectedpure virtual

◆ readDataImpl() [2/2]

virtual ErrCode ds3d::impl::BaseImplDataLoader::readDataImpl ( GuardDataMap datamap)
protectedpure virtual

◆ setErrorCallback_i() [1/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setErrorCallback_i ( const abiErrorCB cb)
inlinefinalvirtualinherited

◆ setErrorCallback_i() [2/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setErrorCallback_i ( const abiErrorCB cb)
inlinefinalvirtualinherited

◆ setInputCaps() [1/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setInputCaps ( const std::string &  caps)
inlineprotectedinherited

◆ setInputCaps() [2/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setInputCaps ( const std::string &  caps)
inlineprotectedinherited

◆ setOutputCaps() [1/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setOutputCaps ( const std::string &  caps)
inlineprotectedinherited

◆ setOutputCaps() [2/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setOutputCaps ( const std::string &  caps)
inlineprotectedinherited

◆ setStateSafe() [1/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setStateSafe ( State  flag)
inlineprotectedinherited

◆ setStateSafe() [2/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setStateSafe ( State  flag)
inlineprotectedinherited

◆ setUserData_i() [1/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setUserData_i ( const abiRefAny userdata)
inlinefinalvirtualinherited

◆ setUserData_i() [2/2]

void ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::setUserData_i ( const abiRefAny userdata)
inlinefinalvirtualinherited

◆ start_i() [1/2]

ErrCode ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::start_i ( const char *  configStr,
uint32_t  strLen,
const char *  path 
)
inlineoverridevirtualinherited

◆ start_i() [2/2]

ErrCode ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::start_i ( const char *  configStr,
uint32_t  strLen,
const char *  path 
)
inlineoverridevirtualinherited

◆ startImpl() [1/2]

virtual ErrCode ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::startImpl ( const std::string &  content,
const std::string &  path 
)
protectedpure virtualinherited

◆ startImpl() [2/2]

virtual ErrCode ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::startImpl ( const std::string &  content,
const std::string &  path 
)
protectedpure virtualinherited

◆ state_i() [1/3]

virtual State ds3d::abiProcess::state_i ( ) const
pure virtualinherited

◆ state_i() [2/3]

◆ state_i() [3/3]

◆ stop_i() [1/2]

ErrCode ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::stop_i
inlineoverridevirtualinherited

◆ stop_i() [2/2]

ErrCode ds3d::impl::BaseImplDataProcessor< abiDataLoader , >::stop_i
inlineoverridevirtualinherited

◆ stopImpl() [1/2]

◆ stopImpl() [2/2]


The documentation for this class was generated from the following file: