PInputVideoStream.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015-2018 Digital Barriers. All rights reserved.
 * Contact: http://www.digitalbarriers.com/
 *
 * This file is part of the Papillon SDK.
 *
 * You can't use, modify or distribute any part of this file without
 * the explicit written agreements of Digital Barriers.
 */

#pragma once
#include <PPluginInstance.h>

PAPILLON_BEGIN_NAMESPACE

class PFrame;
class PPlugin;
class PSizei;
class PUri;

class PAPILLON_API_CORE PInputVideoStream : public PPluginInstance
{
public:
    static const PString C_DEFAULT_RSTP_PLUGIN;          
    static const PString C_DEFAULT_FILE_PLUGIN;          
    static const PString C_DEFAULT_EDGEVIS_PLUGIN;       

    static const PString C_PROPERTY_INT32_STREAM_WIDTH ; 
    static const PString C_PROPERTY_INT32_STREAM_HEIGHT; 
    static const PString C_PROPERTY_DOUBLE_STREAM_FPS  ; 
    static const PString C_PROPERTY_INT32_GO_TO_FRAME  ; 
    static const PString C_PROPERTY_INT32_FRAME_COUNT  ; 
    static const PString C_PROPERTY_INT32_FRAME_NUMBER ; 

public:
    static PResult Open(const PString& uri, PInputVideoStream& inputVideoStream);

    static PResult Open(const PPlugin& plugin, const PUri& uri, PInputVideoStream& inputVideoStream);

    PInputVideoStream();

    PInputVideoStream(const PInputVideoStream& other);

    virtual ~PInputVideoStream();

    PInputVideoStream& operator=(const PInputVideoStream& other);

    bool IsEmpty() const;

    bool IsOpened() const;

    PUri GetUri() const;

    PResult OpenVideoStream();

    PResult Close();

    PResult GetFrame(PFrame& frame, papillon::int32 timeOutMs = 10000);

    void SetCheckPeriod(papillon::int32 timeMs);

    bool IsFrozen() const;

    bool CanSeek() const;

    PResult GoToFrame(papillon::int32 frameNumber);

    PSizei GetResolution() const;

    double GetFrameratePerSecond() const;

    papillon::int32 GetCurrentFrameNumber() const;

    papillon::int32 GetNumberOfFrames() const;
};

PAPILLON_END_NAMESPACE