NVIDIA DeepStream SDK API Reference
8.0 Release
Public Member Functions | Protected Member Functions
nvdsinferserver::BaseBatchBuffer Class Referenceabstract

Detailed Description

The base class for batch buffers.

Definition at line 34 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

Inheritance diagram for nvdsinferserver::BaseBatchBuffer:
Inheritance graph
[legend]
Collaboration diagram for nvdsinferserver::BaseBatchBuffer:
Collaboration graph
[legend]

Public Member Functions

 ~BaseBatchBuffer () override=default
 
const InferBufferDescription & getBufDesc () const final
 
uint32_t getBatchSize () const final
 
uint64_t getTotalBytes () const override
 
void setBufDesc (const InferBufferDescription &desc)
 
InferBufferDescription & mutableBufDesc ()
 
virtual void setBatchSize (uint32_t size)
 
const SharedCuEvent & cuEvent () const
 
void setCuEvent (SharedCuEvent e)
 
void setSyncObj (NvBufSurfTransformSyncObj_t SyncObj)
 
NvBufSurfTransformSyncObj_t & getSyncObj ()
 
void waitForSyncObj ()
 
void attach (SharedBatchBuf buf)
 
void detach ()
 
bool hasAttachedBufs () const
 
const std::vector< SharedBatchBuf > & attachedBufs () const
 
std::vector< SharedBatchBuf > & mutableAttachedBufs ()
 
bool hasAttachLoop () const
 
void setBufId (uint64_t id)
 
uint64_t bufId () const
 
size_t getBufOffset (uint32_t batchIdx) const override
 Get the offset from start of the memory allocation to the buffer pointer. More...
 
 ~BaseBatchBuffer () override=default
 
const InferBufferDescription & getBufDesc () const final
 
uint32_t getBatchSize () const final
 
uint64_t getTotalBytes () const override
 
void setBufDesc (const InferBufferDescription &desc)
 
InferBufferDescription & mutableBufDesc ()
 
virtual void setBatchSize (uint32_t size)
 
const SharedCuEvent & cuEvent () const
 
void setCuEvent (SharedCuEvent e)
 
void setSyncObj (NvBufSurfTransformSyncObj_t SyncObj)
 
NvBufSurfTransformSyncObj_t & getSyncObj ()
 
void waitForSyncObj ()
 
void attach (SharedBatchBuf buf)
 
void detach ()
 
bool hasAttachedBufs () const
 
const std::vector< SharedBatchBuf > & attachedBufs () const
 
std::vector< SharedBatchBuf > & mutableAttachedBufs ()
 
bool hasAttachLoop () const
 
void setBufId (uint64_t id)
 
uint64_t bufId () const
 
size_t getBufOffset (uint32_t batchIdx) const override
 Get the offset from start of the memory allocation to the buffer pointer. More...
 
virtual void * getBufPtr (uint32_t batchIdx) const =0
 
virtual void * getBufPtr (uint32_t batchIdx) const =0
 

Protected Member Functions

 BaseBatchBuffer (uint32_t batchSize)
 
 BaseBatchBuffer (uint32_t batchSize)
 

Constructor & Destructor Documentation

◆ BaseBatchBuffer() [1/2]

nvdsinferserver::BaseBatchBuffer::BaseBatchBuffer ( uint32_t  batchSize)
inlineexplicitprotected

Definition at line 36 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ ~BaseBatchBuffer() [1/2]

nvdsinferserver::BaseBatchBuffer::~BaseBatchBuffer ( )
overridedefault

◆ BaseBatchBuffer() [2/2]

nvdsinferserver::BaseBatchBuffer::BaseBatchBuffer ( uint32_t  batchSize)
inlineexplicitprotected

Definition at line 36 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ ~BaseBatchBuffer() [2/2]

nvdsinferserver::BaseBatchBuffer::~BaseBatchBuffer ( )
overridedefault

Member Function Documentation

◆ attach() [1/2]

void nvdsinferserver::BaseBatchBuffer::attach ( SharedBatchBuf  buf)
inline

Definition at line 67 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ attach() [2/2]

void nvdsinferserver::BaseBatchBuffer::attach ( SharedBatchBuf  buf)
inline

Definition at line 67 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ attachedBufs() [1/2]

const std::vector<SharedBatchBuf>& nvdsinferserver::BaseBatchBuffer::attachedBufs ( ) const
inline

Definition at line 74 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ attachedBufs() [2/2]

const std::vector<SharedBatchBuf>& nvdsinferserver::BaseBatchBuffer::attachedBufs ( ) const
inline

Definition at line 74 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ bufId() [1/2]

uint64_t nvdsinferserver::BaseBatchBuffer::bufId ( ) const
inline

Definition at line 93 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ bufId() [2/2]

uint64_t nvdsinferserver::BaseBatchBuffer::bufId ( ) const
inline

Definition at line 93 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ cuEvent() [1/2]

const SharedCuEvent& nvdsinferserver::BaseBatchBuffer::cuEvent ( ) const
inline

Definition at line 52 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ cuEvent() [2/2]

const SharedCuEvent& nvdsinferserver::BaseBatchBuffer::cuEvent ( ) const
inline

Definition at line 52 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ detach() [1/2]

void nvdsinferserver::BaseBatchBuffer::detach ( )
inline

Definition at line 72 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ detach() [2/2]

void nvdsinferserver::BaseBatchBuffer::detach ( )
inline

Definition at line 72 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

Referenced by nvdsinferserver::CudaTensorBuf::reuse().

◆ getBatchSize() [1/2]

uint32_t nvdsinferserver::BaseBatchBuffer::getBatchSize ( ) const
inlinefinalvirtual

Implements nvdsinferserver::IBatchBuffer.

Definition at line 41 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ getBatchSize() [2/2]

uint32_t nvdsinferserver::BaseBatchBuffer::getBatchSize ( ) const
inlinefinalvirtual

Implements nvdsinferserver::IBatchBuffer.

Definition at line 41 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

Referenced by nvdsinferserver::SurfaceBuffer::getBufOffset(), and nvdsinferserver::SurfaceBuffer::getBufPtr().

◆ getBufDesc() [1/2]

const InferBufferDescription& nvdsinferserver::BaseBatchBuffer::getBufDesc ( ) const
inlinefinalvirtual

Implements nvdsinferserver::IBatchBuffer.

Definition at line 40 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ getBufDesc() [2/2]

const InferBufferDescription& nvdsinferserver::BaseBatchBuffer::getBufDesc ( ) const
inlinefinalvirtual

Implements nvdsinferserver::IBatchBuffer.

Definition at line 40 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ getBufOffset() [1/2]

size_t nvdsinferserver::BaseBatchBuffer::getBufOffset ( uint32_t  batchIdx) const
inlineoverridevirtual

Get the offset from start of the memory allocation to the buffer pointer.

Needed for sharing CUDA memory with Triton server.

Implements nvdsinferserver::IBatchBuffer.

Reimplemented in nvdsinferserver::RefBatchBuffer, nvdsinferserver::RefBatchBuffer, nvdsinferserver::BatchSurfaceBuffer, nvdsinferserver::BatchSurfaceBuffer, nvdsinferserver::SurfaceBuffer, and nvdsinferserver::SurfaceBuffer.

Definition at line 100 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ getBufOffset() [2/2]

size_t nvdsinferserver::BaseBatchBuffer::getBufOffset ( uint32_t  batchIdx) const
inlineoverridevirtual

Get the offset from start of the memory allocation to the buffer pointer.

Needed for sharing CUDA memory with Triton server.

Implements nvdsinferserver::IBatchBuffer.

Reimplemented in nvdsinferserver::RefBatchBuffer, nvdsinferserver::BatchSurfaceBuffer, and nvdsinferserver::SurfaceBuffer.

Definition at line 100 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ getBufPtr() [1/2]

virtual void* nvdsinferserver::IBatchBuffer::getBufPtr ( uint32_t  batchIdx) const
pure virtualinherited

Implemented in nvdsinferserver::RefBatchBuffer, nvdsinferserver::RefBatchBuffer, nvdsinferserver::SegmentationOutput, nvdsinferserver::SegmentationOutput, nvdsinferserver::BatchSurfaceBuffer, nvdsinferserver::BatchSurfaceBuffer, nvdsinferserver::ClassificationOutput, nvdsinferserver::ClassificationOutput, nvdsinferserver::DetectionOutput, nvdsinferserver::DetectionOutput, nvdsinferserver::SurfaceBuffer, nvdsinferserver::SurfaceBuffer, nvdsinferserver::WrapCBatchBuffer, nvdsinferserver::WrapCBatchBuffer, nvdsinferserver::CudaTensorBuf, and nvdsinferserver::CudaTensorBuf.

◆ getBufPtr() [2/2]

virtual void* nvdsinferserver::IBatchBuffer::getBufPtr ( uint32_t  batchIdx) const
pure virtualinherited

Implemented in nvdsinferserver::RefBatchBuffer, nvdsinferserver::RefBatchBuffer, nvdsinferserver::SegmentationOutput, nvdsinferserver::SegmentationOutput, nvdsinferserver::BatchSurfaceBuffer, nvdsinferserver::BatchSurfaceBuffer, nvdsinferserver::ClassificationOutput, nvdsinferserver::ClassificationOutput, nvdsinferserver::DetectionOutput, nvdsinferserver::DetectionOutput, nvdsinferserver::SurfaceBuffer, nvdsinferserver::SurfaceBuffer, nvdsinferserver::WrapCBatchBuffer, nvdsinferserver::WrapCBatchBuffer, nvdsinferserver::CudaTensorBuf, and nvdsinferserver::CudaTensorBuf.

◆ getSyncObj() [1/2]

NvBufSurfTransformSyncObj_t& nvdsinferserver::BaseBatchBuffer::getSyncObj ( )
inline

Definition at line 55 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ getSyncObj() [2/2]

NvBufSurfTransformSyncObj_t& nvdsinferserver::BaseBatchBuffer::getSyncObj ( )
inline

Definition at line 55 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ getTotalBytes() [1/2]

uint64_t nvdsinferserver::BaseBatchBuffer::getTotalBytes ( ) const
inlineoverridevirtual

Implements nvdsinferserver::IBatchBuffer.

Reimplemented in nvdsinferserver::RefBatchBuffer.

Definition at line 42 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

References nvdsinferserver::kNone.

◆ getTotalBytes() [2/2]

uint64_t nvdsinferserver::BaseBatchBuffer::getTotalBytes ( ) const
inlineoverridevirtual

Implements nvdsinferserver::IBatchBuffer.

Reimplemented in nvdsinferserver::RefBatchBuffer, and nvdsinferserver::RefBatchBuffer.

Definition at line 42 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

References nvdsinferserver::kNone.

◆ hasAttachedBufs() [1/2]

bool nvdsinferserver::BaseBatchBuffer::hasAttachedBufs ( ) const
inline

Definition at line 73 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ hasAttachedBufs() [2/2]

bool nvdsinferserver::BaseBatchBuffer::hasAttachedBufs ( ) const
inline

Definition at line 73 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ hasAttachLoop() [1/2]

bool nvdsinferserver::BaseBatchBuffer::hasAttachLoop ( ) const
inline

Definition at line 79 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ hasAttachLoop() [2/2]

bool nvdsinferserver::BaseBatchBuffer::hasAttachLoop ( ) const
inline

Definition at line 79 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ mutableAttachedBufs() [1/2]

std::vector<SharedBatchBuf>& nvdsinferserver::BaseBatchBuffer::mutableAttachedBufs ( )
inline

Definition at line 78 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ mutableAttachedBufs() [2/2]

std::vector<SharedBatchBuf>& nvdsinferserver::BaseBatchBuffer::mutableAttachedBufs ( )
inline

Definition at line 78 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ mutableBufDesc() [1/2]

InferBufferDescription& nvdsinferserver::BaseBatchBuffer::mutableBufDesc ( )
inline

Definition at line 50 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ mutableBufDesc() [2/2]

InferBufferDescription& nvdsinferserver::BaseBatchBuffer::mutableBufDesc ( )
inline

Definition at line 50 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

Referenced by nvdsinferserver::CudaTensorBuf::setName().

◆ setBatchSize() [1/2]

virtual void nvdsinferserver::BaseBatchBuffer::setBatchSize ( uint32_t  size)
inlinevirtual

Reimplemented in nvdsinferserver::CudaTensorBuf, and nvdsinferserver::CudaTensorBuf.

Definition at line 51 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ setBatchSize() [2/2]

virtual void nvdsinferserver::BaseBatchBuffer::setBatchSize ( uint32_t  size)
inlinevirtual

Reimplemented in nvdsinferserver::CudaTensorBuf, and nvdsinferserver::CudaTensorBuf.

Definition at line 51 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

Referenced by nvdsinferserver::SurfaceBuffer::reuse(), nvdsinferserver::CudaTensorBuf::setBatchSize(), and nvdsinferserver::DetectionOutput::swapObjects().

◆ setBufDesc() [1/2]

void nvdsinferserver::BaseBatchBuffer::setBufDesc ( const InferBufferDescription &  desc)
inline

Definition at line 49 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

Referenced by nvdsinferserver::ClassificationOutput::ClassificationOutput(), nvdsinferserver::DetectionOutput::DetectionOutput(), and nvdsinferserver::SegmentationOutput::SegmentationOutput().

◆ setBufDesc() [2/2]

void nvdsinferserver::BaseBatchBuffer::setBufDesc ( const InferBufferDescription &  desc)
inline

Definition at line 49 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ setBufId() [1/2]

void nvdsinferserver::BaseBatchBuffer::setBufId ( uint64_t  id)
inline

Definition at line 92 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ setBufId() [2/2]

void nvdsinferserver::BaseBatchBuffer::setBufId ( uint64_t  id)
inline

Definition at line 92 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ setCuEvent() [1/2]

void nvdsinferserver::BaseBatchBuffer::setCuEvent ( SharedCuEvent  e)
inline

Definition at line 53 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ setCuEvent() [2/2]

void nvdsinferserver::BaseBatchBuffer::setCuEvent ( SharedCuEvent  e)
inline

Definition at line 53 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ setSyncObj() [1/2]

void nvdsinferserver::BaseBatchBuffer::setSyncObj ( NvBufSurfTransformSyncObj_t  SyncObj)
inline

Definition at line 54 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ setSyncObj() [2/2]

void nvdsinferserver::BaseBatchBuffer::setSyncObj ( NvBufSurfTransformSyncObj_t  SyncObj)
inline

Definition at line 54 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

◆ waitForSyncObj() [1/2]

void nvdsinferserver::BaseBatchBuffer::waitForSyncObj ( )
inline

Definition at line 56 of file 9.0/sources/libs/nvdsinferserver/infer_batch_buffer.h.

References NvBufSurfTransformSyncObjDestroy(), and NvBufSurfTransformSyncObjWait().

◆ waitForSyncObj() [2/2]

void nvdsinferserver::BaseBatchBuffer::waitForSyncObj ( )
inline

Definition at line 56 of file sources/libs/nvdsinferserver/infer_batch_buffer.h.

References NvBufSurfTransformSyncObjDestroy(), and NvBufSurfTransformSyncObjWait().

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