service-maker/includes/buffer_probe.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#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