buffer_probe.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
#ifndef NVIDIA_DEEPSTREAM_BUFFER_PROBE
#define NVIDIA_DEEPSTREAM_BUFFER_PROBE
 
#include "custom_object.hpp"
#include "factory_metadata.h"
#include "metadata.hpp"
#include "buffer.hpp"
#include "pad.hpp"
 
namespace deepstream {
 
class Element;
 
enum class probeReturn {
  Probe_Ok,
  Probe_Drop
};
 
class BufferProbe : public CustomObject {
public:
  class IHandler {
   public:
    virtual ~IHandler() {}
  };
 
  class IMetadataHandler : public IHandler {
   public:
    virtual ~IMetadataHandler() {}
  };
 
  class IBufferHandler : public IHandler {
   public:
    virtual ~IBufferHandler() {}
  };
 
  class IBufferObserver : public IBufferHandler {
   public:
    virtual probeReturn handleBuffer(BufferProbe& probe, const Buffer&) = 0;
  };
 
  class IBufferOperator : public IBufferHandler {
   public:
    virtual probeReturn handleBuffer(BufferProbe& probe, Buffer&) = 0;
  };
 
  class IBatchMetadataObserver : public IMetadataHandler {
   public:
    virtual probeReturn handleData(BufferProbe& probe, const BatchMetadata& data) = 0;
  };
 
  class IBatchMetadataOperator : public IMetadataHandler {
   public:
    virtual probeReturn handleData(BufferProbe& probe, BatchMetadata& data) = 0;
  };
 
  BufferProbe(const std::string& name, IHandler* handler);
 
  BufferProbe(const std::string& name, const char* factory, IHandler* handler);
 
  virtual ~BufferProbe();
 
  static unsigned long type();
 
  BufferProbe& attach(Element* target, Pad pad);
 
  Element* getTarget() { return target_; }
 
  const Pad& getPad() { return pad_; }
 
  template<typename T>
  bool query(T*& interface) const {
    auto ptr = metadata_handler_.get();
    interface = dynamic_cast<T*>(ptr);
    return interface != nullptr;
  }
 
protected:
  std::unique_ptr<IHandler> metadata_handler_;
  Pad pad_;
  Element* target_;
};
 
}
 
 
#endif