doc/sdk/_pv_compression_filter_8h_source.html

 // *****************************************************************************

 //

 //     Copyright (c) 2023, Pleora Technologies Inc., All rights reserved.

 //

 // *****************************************************************************


 #ifndef __PVCOMPRESSIONFILTER_H__

 #define __PVCOMPRESSIONFILTER_H__


 #include <IPvFilter.h>

 #include <PvEncoding.h>


 namespace PvBufferLib

 {

     class PTCEncoder;

 }


 class PV_BUFFER_API PvCompressionFilter : public IPvFilter

 {

 public:


     PvCompressionFilter();


     virtual ~PvCompressionFilter();


     PvResult Execute( const PvBuffer *aIn, PvBuffer *aOut );


     PvResult SetThreadCount( uint32_t aCount );


     uint32_t GetThreadCount() const;


     PvResult GetThreadsPriority( uint32_t &aPriority ) const;


     PvResult SetThreadsPriority( uint32_t aPriority );


     PvResult SetEncoding( PvEncodingEnum aValue );


     PvEncodingEnum GetEncoding() const;


 protected:


 private:


     // Not implemented

     PvCompressionFilter( const PvCompressionFilter & );

     const PvCompressionFilter &operator=( const PvCompressionFilter & );


     PvBufferLib::PTCEncoder *mThis;


 };


 #endif // __PVCOMPRESSIONFILTER_H__


PvEncoding.h

PvEncodingEnum
PvEncodingEnum
The PvEncodingEnum enumeration indicates the coding used by the PvCompressionFilter.
Definition: PvEncoding.h:30

IPvFilter
Definition: IPvFilter.h:19

IPvFilter::Execute
virtual PvResult Execute(const PvBuffer *aIn, PvBuffer *aOut)=0
Executes the filter: performs processing on aIn, writing into aOut.

IPvFilter::GetThreadCount
virtual uint32_t GetThreadCount() const =0
Gets the maximum number of threads the filter can use.

IPvFilter::SetThreadCount
virtual PvResult SetThreadCount(uint32_t aCount)=0
Sets the thread count to be used by the filter.

IPvFilter::GetThreadsPriority
virtual PvResult GetThreadsPriority(uint32_t &aPriority) const =0
Gets the thread priority of the filter's worker threads.

IPvFilter::SetThreadsPriority
virtual PvResult SetThreadsPriority(uint32_t aPriority)=0
Sets the thread priority of the filter's worker threads.

PvBuffer
Represents a block of GigE Vision or USB3 Vision data in memory.
Definition: PvBuffer.h:97

PvCompressionFilter
Definition: PvCompressionFilter.h:26

PvResult
Result information.
Definition: PvResult.h:30