cnstream/easydk/dist/include/video_postproc.hpp

/*************************************************************************
 * Copyright (C) [2021] by Cambricon, Inc. All rights reserved
 *
 *  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
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *************************************************************************/

#ifndef MODULES_INFERENCE2_INCLUDE_VIDEO_POSTPROC_HPP_
#define MODULES_INFERENCE2_INCLUDE_VIDEO_POSTPROC_HPP_

/**
 *  \file video_postproc.hpp
 *
 *  This file contains a declaration of class VideoPostproc
 */

#include <memory>
#include <string>
#include <vector>

#include "cnis/infer_server.h"
#include "cnis/processor.h"
#include "cnstream_frame.hpp"
#include "cnstream_frame_va.hpp"
#include "reflex_object.h"

namespace cnstream {
/*!
 * @class VideoPostproc
 *
 * @brief VideoPostproc is the base class of post processing classes for Inference2.
 */
class VideoPostproc : virtual public ReflexObjectEx<VideoPostproc> {
 public:
  /**
   * @brief Destructs an object.
   *
   * @return No return value.
   */
  virtual ~VideoPostproc() = 0;
  /**
   * @brief Creates a postprocess object with the given postprocess's class name.
   *
   * @param[in] proc_name The postprocess class name.
   *
   * @return Returns the pointer to postprocess object.
   */
  static VideoPostproc* Create(const std::string& proc_name);
  /**
   * @brief Sets threshold.
   *
   * @param[in] threshold The value between 0 and 1.
   *
   * @return No return value.
   */
  void SetThreshold(const float threshold);

  /**
   * @brief Executes postprocessing on the model's output data.
   *
   * @param[out] output_data The postprocessing result. The result of postprocessing should be set to it.
   *                     You could set any type of data to this parameter and get it in UserProcess function.
   * @param[in] model_output The neural network origin output data.
   * @param[in] model_info The model information, such as input/output number and shape.
   *
   * @return Returns true if successful, otherwise returns false.
   *
   * @note This function is executed by infer server postproc processor. You could override it to develop custom
   *       postprocessing.
   *       To set any type of data to output_data, use this statement,
   *       e.g., `int example_var = 1; output_data->Set(example_var);`
   *
   */
  virtual bool Execute(infer_server::InferData* output_data, const infer_server::ModelIO& model_output,
                       const infer_server::ModelInfo& model_info) = 0;

 protected:
  float threshold_ = 0;
};  // class VideoPostproc

}  // namespace cnstream

#endif  // MODULES_INFERENCE2_INCLUDE_VIDEO_POSTPROC_HPP_