SDK-eBUS/Ubuntu-LTS/eBUS_SDK_JAI_Ubuntu-24.04-x86_64-7.0.1-7536.zip

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

//

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

//

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


#pragma once


#include <PvPipeline.h>

#include <PvDevice.h>

#include <PvStream.h>

#include <PvBufferConverter.h>

#include <list>

#include <vector>

#ifdef OPENCV_PRESENT

#include <opencv2/opencv.hpp>

#endif


typedef std::list<PvBuffer *> PvBufferList;


class PvDSSource;

class IVideoInfoHeader;


typedef std::vector<std::pair<int, int>> ResolutionList;


namespace PtUtilsLib

{

    class Logger;

}


class PvDSStream :

    public CSourceStream,

    public IAMStreamConfig,

    public IKsPropertySet

{

public:


    // IUnknown

    STDMETHODIMP QueryInterface( REFIID riid, void **ppv );

    STDMETHODIMP_(ULONG) AddRef() { return GetOwner()->AddRef(); }

    STDMETHODIMP_(ULONG) Release() { return GetOwner()->Release(); }


    // IQualityControl

    STDMETHODIMP Notify( IBaseFilter * pSender, Quality q );


    // IAMStreamConfig

    HRESULT STDMETHODCALLTYPE SetFormat( AM_MEDIA_TYPE *pmt );

    HRESULT STDMETHODCALLTYPE GetFormat( AM_MEDIA_TYPE **ppmt );

    HRESULT STDMETHODCALLTYPE GetNumberOfCapabilities( int *piCount, int *piSize );

    HRESULT STDMETHODCALLTYPE GetStreamCaps( int iIndex, AM_MEDIA_TYPE **pmt, BYTE *pSCC );


    // IKsPropertySet

    HRESULT STDMETHODCALLTYPE Set( REFGUID guidPropSet, DWORD dwID, void *pInstanceData, DWORD cbInstanceData, void *pPropData, DWORD cbPropData );

    HRESULT STDMETHODCALLTYPE Get( REFGUID guidPropSet, DWORD dwPropID, void *pInstanceData,DWORD cbInstanceData, void *pPropData, DWORD cbPropData, DWORD *pcbReturned );

    HRESULT STDMETHODCALLTYPE QuerySupported( REFGUID guidPropSet, DWORD dwPropID, DWORD *pTypeSupport );


    // CSourceStream

    PvDSStream( HRESULT *phr, PvDSSource *pParent, LPCWSTR pPinName );

    ~PvDSStream();


    HRESULT FillBuffer( IMediaSample *pms );

    HRESULT DecideBufferSize( IMemAllocator *pIMemAlloc, ALLOCATOR_PROPERTIES *pProperties );

    HRESULT CheckMediaType( const CMediaType *pMediaType );

    HRESULT GetMediaType( int iPosition, CMediaType *pMediaType );

    HRESULT SetMediaType( const CMediaType *pmt );


    HRESULT OnThreadCreate( void );

    HRESULT OnThreadDestroy(void);

    HRESULT OnThreadStartPlay(void);


    HRESULT StartAcquisition();

    HRESULT StopAcquisition();


    HRESULT Save( PvString &aContent, bool aBasic = false );

    HRESULT Load( const PvString &aContent, bool aBasic = false );

    HRESULT LoadDefault();


    void SyncFormat();

    PvGenParameterArray *GetSelectedParameters();

    void CopyImageYUV( PvBuffer *aBuffer, BYTE *pData, bool aIsYUYV );

    void CopyImageRGB( PvBuffer *aBuffer, BYTE *pData, bool aEnableAdvanced );

    void DrawText( BYTE *pData, const std::wstring &aText );

    void OutputDiagnostics( BYTE *pData );


    IVideoInfoHeader *AllocPVIFrom( const CMediaType *aMediaType );


    HRESULT GetRole( int &aValue ) const { aValue = mRole; return NOERROR; }

    HRESULT SetRole( int aValue ) { mRole = aValue; return NOERROR; }

    HRESULT GetUnicastPort( int &aValue ) const { aValue = mUnicastPort; return NOERROR; }

    HRESULT SetUnicastPort( int aValue ) { mUnicastPort = aValue; return NOERROR; }

    HRESULT GetMulticastIP( std::wstring &aValue ) const { aValue = mMulticastIP; return NOERROR; }

    HRESULT SetMulticastIP( const std::wstring &aValue ) { mMulticastIP = aValue; return NOERROR; }

    HRESULT GetMulticastPort( int &aValue ) const { aValue = mMulticastPort; return NOERROR; }

    HRESULT SetMulticastPort( int aValue ) { mMulticastPort = aValue; return NOERROR; }

    HRESULT DisconnectDevice();

    HRESULT ConnectIfNeeded();


    HRESULT GetDiagnosticEnabled( bool &aValue ) const { aValue = mDiagnosticEnabled; return NOERROR; }

    HRESULT SetDiagnosticEnabled( bool aValue );


    HRESULT GetDeviceID( std::wstring &aValue ) const { aValue = mDeviceID; return NOERROR; }

    HRESULT SetDeviceID( const std::wstring &aValue );

    HRESULT GetSourceCount( int &aValue );

    HRESULT GetSourceName( int aIndex, std::wstring &aValue );

    HRESULT GetSource( std::wstring &aValue ) const { aValue = mSource; return NOERROR; }

    HRESULT SetSource( const std::wstring &aValue );

    HRESULT GetChannel( int &aValue ) const { aValue = mChannel; return NOERROR; }

    HRESULT SetChannel( int aValue ) { mChannel = aValue; return NOERROR; }


    HRESULT GetBufferCount( int &aValue ) const { aValue = mBufferCount; return NOERROR; }

    HRESULT SetBufferCount( int aValue ) { mBufferCount = aValue; return NOERROR; }

    HRESULT GetDefaultBufferSize( int &aValue ) const { aValue = mDefaultBufferSize; return NOERROR; }

    HRESULT SetDefaultBufferSize( int aValue ) { mDefaultBufferSize = aValue; return NOERROR; }

    HRESULT GetDropThreshold( int &aValue ) const { aValue = mDropThreshold; return NOERROR; }

    HRESULT SetDropThreshold( int aValue ) { mDropThreshold = aValue; return NOERROR; }

    HRESULT GetWidth( int &aValue ) const { aValue = mDeviceWidth; return NOERROR; }

    HRESULT SetWidth( int aValue );

    HRESULT GetHeight( int &aValue ) const { aValue = mDeviceHeight; return NOERROR; }

    HRESULT SetHeight( int aValue );


    HRESULT GetParametersSelector( int &aValue ) const { aValue = mParameterSelector; return NOERROR; }

    HRESULT SetParametersSelector( int aValue );

    HRESULT GetParametersAvailable( bool &aValue ) const;

    HRESULT GetParameterCount( int &aValue );

    HRESULT GetParameterName( int aIndex, std::wstring &aValue );

    HRESULT GetParameterCategory( const std::wstring &aName, std::wstring &aValue );

    HRESULT GetParameterValue( const std::wstring &aName, std::wstring &aValue );

    HRESULT SetParameterValue( const std::wstring &aName, const std::wstring &aValue, std::wstring &aMessage );

    HRESULT GetParameterType( const std::wstring &aName, std::wstring &aType );

    HRESULT GetParameterAccess( const std::wstring &aName, bool &aAvailable, bool &aReadable, bool &aWritable );

    HRESULT ParameterExecute( const std::wstring &aName, std::wstring &aMessage );

    HRESULT GetParameterPossibleValueCount( const std::wstring &aName, int &aCount );

    HRESULT GetParameterPossibleValue( const std::wstring &aName, int aIndex, std::wstring &aValue );

    HRESULT GetParameterVisibility( const std::wstring &aName, int &aVisibility );


    LONGLONG GetImageCount() const { return mImageCount; }

    LONGLONG GetImageDroppedCount() const { return mImageDroppedCount; }

    int GetLastImageSize() const { return mLastImageSize; }


    HRESULT MakeDefault();

    HRESULT ResetDefault();

    HRESULT GetDefaultSummary( std::wstring &aSummary ) { aSummary = mDefaultSummary; return NOERROR; }


    HRESULT GetOutputPixelType( int &aValue ) const { aValue = mOutputPixelTypeIndex; return NOERROR; }

    HRESULT SetOutputPixelType( int aValue );


    HRESULT GetKernelSize( int &aValue ) const { aValue = mKernelSize; return NOERROR; }

    HRESULT SetKernelSize( int aValue );


    HRESULT GetZoomValue( int &aZoomValue ) const { aZoomValue = mZoomValue; return NOERROR; }

    HRESULT SetZoomValue( int aZoomValue );


    HRESULT GetOutputResolution( int &aWidth, int &aHeight ) const;

    HRESULT SetOutputResolution( int aWidth, int aHeight );


    void CalculateResolutionsForZoom();

#ifdef OPENCV_PRESENT

    void EnableHotPixelDiagnostic( cv::Mat aMat );

#endif


private:


    PvDSSource *m_pParent;


    PvDevice *mDevice;

    PvStream *mStream;

    PvPipeline *mPipeline;


    std::wstring mActiveDeviceID;

    std::wstring mActiveSource;

    int mActiveChannel;

    int mActiveUnicastPort;

    std::wstring mActiveMulticastIP;

    int mActiveMulticastPort;


    int mDeviceWidth;

    int mDeviceHeight;

    int mOutputWidth;

    int mOutputHeight;

    int mWidth;

    int mHeight;

    int mLastImageWidth;

    int mLastImageHeight;

    int mLastImageSize;

    int mOutputPixelTypeIndex; // 0 for RGB, 1 for YUV

    int mKernelSize;

    int mPixelVariationScore;

    int mZoomValue;


    REFERENCE_TIME mReferenceTime;

    REFERENCE_TIME mLastTime;

    LONGLONG mImageCount;

    LONGLONG mImageDroppedCount;


    HANDLE mMutex;

    BOOL mStreaming;


    PvResult mLastConnect;

    PvResult mLastOpen;

    std::wstring mLastWarning;


    int mRole;

    int mUnicastPort;

    std::wstring mMulticastIP;

    int mMulticastPort;

    bool mDiagnosticEnabled;

    std::wstring mDeviceID;

    std::wstring mSource;

    int mChannel;

    int mBufferCount;

    int mDefaultBufferSize;

    int mDropThreshold;

    std::wstring mDefaultSummary;


    int mParameterSelector;


    PvBufferConverter mConverter;


    ULONG_PTR mGdiplusToken;


    IReferenceClock *mClock;


    bool mClearOutputFlag;


    ResolutionList mResolutions;

};


PvBufferConverter.h

PvBufferConverter
Used to convert a PvBuffer to another pixel type.
Definition PvBufferConverter.h:67

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

PvDSSource
Definition PvDSSource.h:18

PvDSStream
Definition PvDSStream.h:37

PvDSStream::GetOutputResolution
HRESULT GetOutputResolution(int &aWidth, int &aHeight) const
If zoom factor is greater than 1, get the output resolution.
Definition PvDSStream.cpp:2145

PvDSStream::GetParameterCount
HRESULT GetParameterCount(int &aValue)
Returns the parameter count for the currently selected parameter array.
Definition PvDSStream.cpp:1678

PvDSStream::SetParameterValue
HRESULT SetParameterValue(const std::wstring &aName, const std::wstring &aValue, std::wstring &aMessage)
Tries changing the value of the parameter at aIndex in the currently selected parameter array.
Definition PvDSStream.cpp:1771

PvDSStream::SetDeviceID
HRESULT SetDeviceID(const std::wstring &aValue)
Sets the device ID.
Definition PvDSStream.cpp:1531

PvDSStream::DecideBufferSize
HRESULT DecideBufferSize(IMemAllocator *pIMemAlloc, ALLOCATOR_PROPERTIES *pProperties)
This method is called after the pins are connected to allocate buffers to stream data.
Definition PvDSStream.cpp:858

PvDSStream::QueryInterface
STDMETHODIMP QueryInterface(REFIID riid, void **ppv)
QueryInterface.
Definition PvDSStream.cpp:246

PvDSStream::GetMediaType
HRESULT GetMediaType(int iPosition, CMediaType *pMediaType)
See Directshow help topic for IAMStreamConfig for details on this method.
Definition PvDSStream.cpp:730

PvDSStream::GetSelectedParameters
PvGenParameterArray * GetSelectedParameters()
Returns the currently selected parameters, if available.
Definition PvDSStream.cpp:1643

PvDSStream::GetParameterName
HRESULT GetParameterName(int aIndex, std::wstring &aValue)
Returns the name of the parameter at aIndex in the currently selected parameter array.
Definition PvDSStream.cpp:1696

PvDSStream::CopyImageYUV
void CopyImageYUV(PvBuffer *aBuffer, BYTE *pData, bool aIsYUYV)
Copies an image into the DirectShow buffer.
Definition PvDSStream.cpp:609

PvDSStream::Notify
STDMETHODIMP Notify(IBaseFilter *pSender, Quality q)
Notify. Ignore quality management messages sent from the downstream filter.
Definition PvDSStream.cpp:704

PvDSStream::SetWidth
HRESULT SetWidth(int aValue)
Changes the filter width.
Definition PvDSStream.cpp:2043

PvDSStream::~PvDSStream
~PvDSStream()
Destructor.
Definition PvDSStream.cpp:231

PvDSStream::GetParameterAccess
HRESULT GetParameterAccess(const std::wstring &aName, bool &aAvailable, bool &aReadable, bool &aWritable)
Returns the current access mode for a feature.
Definition PvDSStream.cpp:1872

PvDSStream::GetNumberOfCapabilities
HRESULT STDMETHODCALLTYPE GetNumberOfCapabilities(int *piCount, int *piSize)
GetNumberOfCapabilities.
Definition PvDSStream.cpp:968

PvDSStream::SetDiagnosticEnabled
HRESULT SetDiagnosticEnabled(bool aValue)
Sets whether diagnostic output on received images is enabled or not.
Definition PvDSStream.cpp:1354

PvDSStream::DisconnectDevice
HRESULT DisconnectDevice()
Disconnects device, stream.
Definition PvDSStream.cpp:1151

PvDSStream::Get
HRESULT STDMETHODCALLTYPE Get(REFGUID guidPropSet, DWORD dwPropID, void *pInstanceData, DWORD cbInstanceData, void *pPropData, DWORD cbPropData, DWORD *pcbReturned)
Get: Return the pin category (our only property).
Definition PvDSStream.cpp:1076

PvDSStream::LoadDefault
HRESULT LoadDefault()
Loads the default configuration from Registry.
Definition PvDSStream.cpp:2248

PvDSStream::GetParameterValue
HRESULT GetParameterValue(const std::wstring &aName, std::wstring &aValue)
Returns the value of the parameter at aIndex in the currently selected parameter array.
Definition PvDSStream.cpp:1747

PvDSStream::SetFormat
HRESULT STDMETHODCALLTYPE SetFormat(AM_MEDIA_TYPE *pmt)
SetFormat.
Definition PvDSStream.cpp:937

PvDSStream::SetKernelSize
HRESULT SetKernelSize(int aValue)
Sets the kernel size for hot pixel correction.
Definition PvDSStream.cpp:2111

PvDSStream::FillBuffer
HRESULT FillBuffer(IMediaSample *pms)
Diagnostic for Hot pixel corrections.
Definition PvDSStream.cpp:352

PvDSStream::SetHeight
HRESULT SetHeight(int aValue)
Changes the filter height.
Definition PvDSStream.cpp:2061

PvDSStream::SyncFormat
void SyncFormat()
Attempts to sync the device image size with the filter/graph configuration.
Definition PvDSStream.cpp:1436

PvDSStream::CopyImageRGB
void CopyImageRGB(PvBuffer *aBuffer, BYTE *pData, bool aEnableAdvanced)
Copies an image into the DirectShow buffer.
Definition PvDSStream.cpp:499

PvDSStream::MakeDefault
HRESULT MakeDefault()
Makes the current basic configuration (mostly camera selection) default.
Definition PvDSStream.cpp:2180

PvDSStream::SetParametersSelector
HRESULT SetParametersSelector(int aValue)
Sets the current parameters selector.
Definition PvDSStream.cpp:1601

PvDSStream::GetParameterType
HRESULT GetParameterType(const std::wstring &aName, std::wstring &aType)
Returns a string representing the type of the parameter.
Definition PvDSStream.cpp:1809

PvDSStream::GetSourceCount
HRESULT GetSourceCount(int &aValue)
Returns the number of source available on the device.
Definition PvDSStream.cpp:1542

PvDSStream::Set
HRESULT STDMETHODCALLTYPE Set(REFGUID guidPropSet, DWORD dwID, void *pInstanceData, DWORD cbInstanceData, void *pPropData, DWORD cbPropData)
Set.
Definition PvDSStream.cpp:1065

PvDSStream::OutputDiagnostics
void OutputDiagnostics(BYTE *pData)
Writes diagnostics output on the buffer.
Definition PvDSStream.cpp:2328

PvDSStream::ConnectIfNeeded
HRESULT ConnectIfNeeded()
Connects to a GEV or U3V device (if needed)
Definition PvDSStream.cpp:1203

PvDSStream::GetParameterCategory
HRESULT GetParameterCategory(const std::wstring &aName, std::wstring &aValue)
Returns the category of the parameter at aIndex in the currently selected parameter array.
Definition PvDSStream.cpp:1720

PvDSStream::ResetDefault
HRESULT ResetDefault()
Clears the default basic configuration.
Definition PvDSStream.cpp:2304

PvDSStream::StopAcquisition
HRESULT StopAcquisition()
Stops image acquisition.
Definition PvDSStream.cpp:1415

PvDSStream::SetOutputResolution
HRESULT SetOutputResolution(int aWidth, int aHeight)
Sets the output resolution.
Definition PvDSStream.cpp:2158

PvDSStream::SetZoomValue
HRESULT SetZoomValue(int aZoomValue)
Sets the zoom value.
Definition PvDSStream.cpp:2129

PvDSStream::OnThreadDestroy
HRESULT OnThreadDestroy(void)
Called when a graph is stopped.
Definition PvDSStream.cpp:904

PvDSStream::CheckMediaType
HRESULT CheckMediaType(const CMediaType *pMediaType)
This method is called to see if a given output format is supported.
Definition PvDSStream.cpp:810

PvDSStream::ParameterExecute
HRESULT ParameterExecute(const std::wstring &aName, std::wstring &aMessage)
Executes a parameter of the currently selected parameter array.
Definition PvDSStream.cpp:1898

PvDSStream::SetMediaType
HRESULT SetMediaType(const CMediaType *pmt)
This is called when the output format has been negotiated.
Definition PvDSStream.cpp:714

PvDSStream::SetOutputPixelType
HRESULT SetOutputPixelType(int aValue)
Sets the output pixel type.
Definition PvDSStream.cpp:2079

PvDSStream::OnThreadStartPlay
HRESULT OnThreadStartPlay(void)
Called when a graph starts playing.
Definition PvDSStream.cpp:920

PvDSStream::StartAcquisition
HRESULT StartAcquisition()
Starts image acquisition.
Definition PvDSStream.cpp:1377

PvDSStream::GetSourceName
HRESULT GetSourceName(int aIndex, std::wstring &aValue)
Returns the name of a source.
Definition PvDSStream.cpp:1564

PvDSStream::GetParametersAvailable
HRESULT GetParametersAvailable(bool &aValue) const
Returns if a specific parameter array is available.
Definition PvDSStream.cpp:1617

PvDSStream::AllocPVIFrom
IVideoInfoHeader * AllocPVIFrom(const CMediaType *aMediaType)
Allocs a PVI from a specific media type.
Definition PvDSStream.cpp:2698

PvDSStream::GetParameterPossibleValue
HRESULT GetParameterPossibleValue(const std::wstring &aName, int aIndex, std::wstring &aValue)
For a parameter of the currently selected parameter array, returns one of the possible values (if app...
Definition PvDSStream.cpp:1960

PvDSStream::CalculateResolutionsForZoom
void CalculateResolutionsForZoom()
Calculate the resolutions to support zoom.
Definition PvDSStream.cpp:272

PvDSStream::QuerySupported
HRESULT STDMETHODCALLTYPE QuerySupported(REFGUID guidPropSet, DWORD dwPropID, DWORD *pTypeSupport)
QuerySupported: Query whether the pin supports the specified property.
Definition PvDSStream.cpp:1125

PvDSStream::GetParameterPossibleValueCount
HRESULT GetParameterPossibleValueCount(const std::wstring &aName, int &aCount)
For a parameter of the currently selected parameter array, returns how many possible values there are...
Definition PvDSStream.cpp:1927

PvDSStream::Load
HRESULT Load(const PvString &aContent, bool aBasic=false)
Loads and applies the filter persistence data.
Definition PvDSStream.cpp:2643

PvDSStream::SetSource
HRESULT SetSource(const std::wstring &aValue)
Sets the source.
Definition PvDSStream.cpp:1590

PvDSStream::DrawText
void DrawText(BYTE *pData, const std::wstring &aText)
Draws some text on the output buffer.
Definition PvDSStream.cpp:2504

PvDSStream::GetFormat
HRESULT STDMETHODCALLTYPE GetFormat(AM_MEDIA_TYPE **ppmt)
GetFormat.
Definition PvDSStream.cpp:956

PvDSStream::GetStreamCaps
HRESULT STDMETHODCALLTYPE GetStreamCaps(int iIndex, AM_MEDIA_TYPE **pmt, BYTE *pSCC)
GetStreamCaps.
Definition PvDSStream.cpp:981

PvDSStream::OnThreadCreate
HRESULT OnThreadCreate(void)
Called when graph is run.
Definition PvDSStream.cpp:893

PvDSStream::Save
HRESULT Save(PvString &aContent, bool aBasic=false)
Saves the filter persistence data.
Definition PvDSStream.cpp:2591

PvDSStream::GetParameterVisibility
HRESULT GetParameterVisibility(const std::wstring &aName, int &aVisibility)
Returns the visibility of a GenICam parameter.
Definition PvDSStream.cpp:2015

PvDevice
Connect, configure and control a GigE Vision or USB3 Vision device.
Definition PvDevice.h:42

PvGenParameterArray
GenICam feature array.
Definition PvGenParameterArray.h:73

PvPipeline
Helper class for receiving data from a GigE Vision or USB3 Vision transmitter.
Definition PvPipeline.h:33

PvResult
Result information.
Definition PvResult.h:30

PvStream
Receive data from a GigE Vision or USB3 Vision transmitter.
Definition PvStream.h:51

PvString
String class.
Definition PvString.h:26