NVIDIA DeepStream SDK API Reference
9.2 Release
Public Member Functions | Data Fields | Protected Attributes | Friends
SinkPad Class Reference

Detailed Description

Definition at line 172 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

Inheritance diagram for SinkPad:
Inheritance graph
[legend]

Public Member Functions

 SinkPad (unsigned int id, void *pad)
 
virtual ~SinkPad ()
 
void release ()
 
void wait_till_empty ()
 
bool check_queue_empty ()
 
void queue_entry (std::shared_ptr< QueueEntry >)
 
void push_events (SourcePad *src_pad)
 
virtual void push_event (SourcePad *src_pad, QueueEntry *)
 
unsigned int get_available ()
 
void adjust_event_indices (unsigned int, bool is_event)
 
void update_frame_count (unsigned int count)
 
unsigned long get_frame_count ()
 
void reset_frame_count ()
 
void reset ()
 
void clear_frames ()
 
void set_switched_to_idle (bool val)
 
void set_switched_to_active (bool val)
 
bool get_switched_to_idle ()
 
bool get_switched_to_active ()
 
void set_mime_type (PAD_MIME_TYPE n_mime_type)
 
PAD_MIME_TYPE get_mime_type ()
 
void set_eos (bool aEos)
 
bool get_eos ()
 
void push_buffer_done ()
 
void wait_if_queue_full ()
 always call after queue_entry() for type=ENTRY_BUFFER More...
 
void pop_buffer_done ()
 
void set_max_buffer_count (unsigned int max_buffer_c)
 
unsigned int get_max_buffer_count ()
 
void set_debug_interface (INvStreammuxDebug *a_debug_iface)
 
 SinkPad (unsigned int id, void *pad)
 
virtual ~SinkPad ()
 
void release ()
 
void wait_till_empty ()
 
bool check_queue_empty ()
 
void queue_entry (std::shared_ptr< QueueEntry >)
 
void push_events (SourcePad *src_pad)
 
virtual void push_event (SourcePad *src_pad, QueueEntry *)
 
unsigned int get_available ()
 
void adjust_event_indices (unsigned int, bool is_event)
 
void update_frame_count (unsigned int count)
 
unsigned long get_frame_count ()
 
void reset_frame_count ()
 
void reset ()
 
void clear_frames ()
 
void set_switched_to_idle (bool val)
 
void set_switched_to_active (bool val)
 
bool get_switched_to_idle ()
 
bool get_switched_to_active ()
 
void set_mime_type (PAD_MIME_TYPE n_mime_type)
 
PAD_MIME_TYPE get_mime_type ()
 
void set_eos (bool aEos)
 
bool get_eos ()
 
void push_buffer_done ()
 
void wait_if_queue_full ()
 always call after queue_entry() for type=ENTRY_BUFFER More...
 
void pop_buffer_done ()
 
void set_max_buffer_count (unsigned int max_buffer_c)
 
unsigned int get_max_buffer_count ()
 
void set_debug_interface (INvStreammuxDebug *a_debug_iface)
 

Data Fields

SOURCE_STATE state
 
std::vector< std::shared_ptr< QueueEntry > > queue
 
std::vector< unsigned int > event_indices
 
unsigned int id
 
void * wrapped
 
std::mutex mutex
 
std::mutex mutex_buffer_count
 
unsigned int top_event_index
 
unsigned int source_id
 

Protected Attributes

std::condition_variable cv
 cv which shall be notified when we have input buffer in queue More...
 
std::condition_variable cv_input_full
 cv which shall be notified when we have space left in queue More...
 
unsigned long frame_count
 
unsigned long buffer_count
 
unsigned long max_buffer_count
 

Friends

class SourcePad
 

Constructor & Destructor Documentation

◆ SinkPad() [1/2]

SinkPad::SinkPad ( unsigned int  id,
void *  pad 
)
inline

Definition at line 176 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

References buffer_count, frame_count, max_buffer_count, PAD_MIME_TYPE_VIDEO, SOURCE_STATE_IDLE, and state.

◆ ~SinkPad() [1/2]

virtual SinkPad::~SinkPad ( )
inlinevirtual

Definition at line 189 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ SinkPad() [2/2]

SinkPad::SinkPad ( unsigned int  id,
void *  pad 
)
inline

Definition at line 176 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

References buffer_count, frame_count, max_buffer_count, PAD_MIME_TYPE_VIDEO, SOURCE_STATE_IDLE, and state.

◆ ~SinkPad() [2/2]

virtual SinkPad::~SinkPad ( )
inlinevirtual

Definition at line 189 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

Member Function Documentation

◆ adjust_event_indices() [1/2]

void SinkPad::adjust_event_indices ( unsigned int  ,
bool  is_event 
)

◆ adjust_event_indices() [2/2]

void SinkPad::adjust_event_indices ( unsigned int  ,
bool  is_event 
)

◆ check_queue_empty() [1/2]

bool SinkPad::check_queue_empty ( )

◆ check_queue_empty() [2/2]

bool SinkPad::check_queue_empty ( )

◆ clear_frames() [1/2]

void SinkPad::clear_frames ( )

◆ clear_frames() [2/2]

void SinkPad::clear_frames ( )

◆ get_available() [1/2]

unsigned int SinkPad::get_available ( )

◆ get_available() [2/2]

unsigned int SinkPad::get_available ( )

◆ get_eos() [1/2]

bool SinkPad::get_eos ( )
inline

Definition at line 272 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ get_eos() [2/2]

bool SinkPad::get_eos ( )
inline

Definition at line 272 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ get_frame_count() [1/2]

unsigned long SinkPad::get_frame_count ( )

◆ get_frame_count() [2/2]

unsigned long SinkPad::get_frame_count ( )

◆ get_max_buffer_count() [1/2]

unsigned int SinkPad::get_max_buffer_count ( )
inline

Definition at line 300 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

References max_buffer_count, and mutex_buffer_count.

◆ get_max_buffer_count() [2/2]

unsigned int SinkPad::get_max_buffer_count ( )
inline

Definition at line 300 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

References max_buffer_count, and mutex_buffer_count.

◆ get_mime_type() [1/2]

PAD_MIME_TYPE SinkPad::get_mime_type ( )
inline

Definition at line 262 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ get_mime_type() [2/2]

PAD_MIME_TYPE SinkPad::get_mime_type ( )
inline

Definition at line 262 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ get_switched_to_active() [1/2]

bool SinkPad::get_switched_to_active ( )
inline

Definition at line 252 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ get_switched_to_active() [2/2]

bool SinkPad::get_switched_to_active ( )
inline

Definition at line 252 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ get_switched_to_idle() [1/2]

bool SinkPad::get_switched_to_idle ( )
inline

Definition at line 247 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ get_switched_to_idle() [2/2]

bool SinkPad::get_switched_to_idle ( )
inline

Definition at line 247 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ pop_buffer_done() [1/2]

void SinkPad::pop_buffer_done ( )
inline

Definition at line 286 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

References buffer_count, cv_input_full, max_buffer_count, and mutex_buffer_count.

◆ pop_buffer_done() [2/2]

void SinkPad::pop_buffer_done ( )
inline

Definition at line 286 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

References buffer_count, cv_input_full, max_buffer_count, and mutex_buffer_count.

◆ push_buffer_done() [1/2]

void SinkPad::push_buffer_done ( )
inline

Definition at line 277 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

References buffer_count, and mutex_buffer_count.

◆ push_buffer_done() [2/2]

void SinkPad::push_buffer_done ( )
inline

Definition at line 277 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

References buffer_count, and mutex_buffer_count.

◆ push_event() [1/2]

virtual void SinkPad::push_event ( SourcePad *  src_pad,
QueueEntry *   
)
inlinevirtual

Reimplemented in GstSinkPad, and GstSinkPad.

Definition at line 220 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ push_event() [2/2]

virtual void SinkPad::push_event ( SourcePad *  src_pad,
QueueEntry *   
)
inlinevirtual

Reimplemented in GstSinkPad, and GstSinkPad.

Definition at line 220 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ push_events() [1/2]

void SinkPad::push_events ( SourcePad *  src_pad)

◆ push_events() [2/2]

void SinkPad::push_events ( SourcePad *  src_pad)

◆ queue_entry() [1/2]

void SinkPad::queue_entry ( std::shared_ptr< QueueEntry >  )

◆ queue_entry() [2/2]

void SinkPad::queue_entry ( std::shared_ptr< QueueEntry >  )

◆ release() [1/2]

void SinkPad::release ( )

◆ release() [2/2]

void SinkPad::release ( )

◆ reset() [1/2]

void SinkPad::reset ( )

◆ reset() [2/2]

void SinkPad::reset ( )

◆ reset_frame_count() [1/2]

void SinkPad::reset_frame_count ( )
inline

Definition at line 231 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

References frame_count.

◆ reset_frame_count() [2/2]

void SinkPad::reset_frame_count ( )
inline

Definition at line 231 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

References frame_count.

◆ set_debug_interface() [1/2]

void SinkPad::set_debug_interface ( INvStreammuxDebug *  a_debug_iface)
inline

Definition at line 306 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ set_debug_interface() [2/2]

void SinkPad::set_debug_interface ( INvStreammuxDebug *  a_debug_iface)
inline

Definition at line 306 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ set_eos() [1/2]

void SinkPad::set_eos ( bool  aEos)
inline

Definition at line 267 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ set_eos() [2/2]

void SinkPad::set_eos ( bool  aEos)
inline

Definition at line 267 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ set_max_buffer_count() [1/2]

void SinkPad::set_max_buffer_count ( unsigned int  max_buffer_c)
inline

Definition at line 294 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

References max_buffer_count, and mutex_buffer_count.

◆ set_max_buffer_count() [2/2]

void SinkPad::set_max_buffer_count ( unsigned int  max_buffer_c)
inline

Definition at line 294 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

References max_buffer_count, and mutex_buffer_count.

◆ set_mime_type() [1/2]

void SinkPad::set_mime_type ( PAD_MIME_TYPE  n_mime_type)
inline

Definition at line 257 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ set_mime_type() [2/2]

void SinkPad::set_mime_type ( PAD_MIME_TYPE  n_mime_type)
inline

Definition at line 257 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ set_switched_to_active() [1/2]

void SinkPad::set_switched_to_active ( bool  val)
inline

Definition at line 242 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

References val.

◆ set_switched_to_active() [2/2]

void SinkPad::set_switched_to_active ( bool  val)
inline

Definition at line 242 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

References val.

◆ set_switched_to_idle() [1/2]

void SinkPad::set_switched_to_idle ( bool  val)
inline

Definition at line 237 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

References val.

◆ set_switched_to_idle() [2/2]

void SinkPad::set_switched_to_idle ( bool  val)
inline

Definition at line 237 of file 9.2/sources/libs/nvstreammux/include/nvstreammux_pads.h.

References val.

◆ update_frame_count() [1/2]

void SinkPad::update_frame_count ( unsigned int  count)

◆ update_frame_count() [2/2]

void SinkPad::update_frame_count ( unsigned int  count)

◆ wait_if_queue_full() [1/2]

void SinkPad::wait_if_queue_full ( )

always call after queue_entry() for type=ENTRY_BUFFER

◆ wait_if_queue_full() [2/2]

void SinkPad::wait_if_queue_full ( )

always call after queue_entry() for type=ENTRY_BUFFER

◆ wait_till_empty() [1/2]

void SinkPad::wait_till_empty ( )

◆ wait_till_empty() [2/2]

void SinkPad::wait_till_empty ( )

Friends And Related Function Documentation

◆ SourcePad

SourcePad
friend

Definition at line 336 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

Field Documentation

◆ buffer_count

unsigned long SinkPad::buffer_count
protected

Definition at line 342 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

Referenced by pop_buffer_done(), push_buffer_done(), and SinkPad().

◆ cv

std::condition_variable SinkPad::cv
protected

cv which shall be notified when we have input buffer in queue

Definition at line 338 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ cv_input_full

std::condition_variable SinkPad::cv_input_full
protected

cv which shall be notified when we have space left in queue

Definition at line 340 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

Referenced by pop_buffer_done().

◆ event_indices

std::vector< unsigned int > SinkPad::event_indices

Definition at line 315 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ frame_count

unsigned long SinkPad::frame_count
protected

Definition at line 341 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

Referenced by reset_frame_count(), and SinkPad().

◆ id

unsigned int SinkPad::id

Definition at line 317 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ max_buffer_count

unsigned long SinkPad::max_buffer_count
protected

Definition at line 343 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

Referenced by get_max_buffer_count(), pop_buffer_done(), set_max_buffer_count(), and SinkPad().

◆ mutex

std::mutex SinkPad::mutex

Definition at line 319 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ mutex_buffer_count

std::mutex SinkPad::mutex_buffer_count

Definition at line 320 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

Referenced by get_max_buffer_count(), pop_buffer_done(), push_buffer_done(), and set_max_buffer_count().

◆ queue

std::vector< std::shared_ptr< QueueEntry > > SinkPad::queue

Definition at line 314 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ source_id

unsigned int SinkPad::source_id

Definition at line 322 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ state

SOURCE_STATE SinkPad::state

Definition at line 311 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

Referenced by SinkPad().

◆ top_event_index

unsigned int SinkPad::top_event_index

Definition at line 321 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

◆ wrapped

void * SinkPad::wrapped

Definition at line 318 of file sources/libs/nvstreammux/include/nvstreammux_pads.h.

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