frame_data.hpp

Go to the documentation of this file.

/// \file
/// \addtogroup Types
/// @{
///
// AUTOGENERATED FILE - DO NOT MODIFY!
// This file was generated by Djinni from types.djinni
 
#pragma once
 
#include <bnb/types/full_image.hpp>
#include <bnb/utils/defs.hpp>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <vector>
 
namespace bnb { namespace interfaces {
 
class frx_recognition_result;
enum class face_data_source;
enum class feature_id;
struct action_units_data;
struct brows_mask;
struct depth_map;
struct detected_face;
struct external_face_data;
struct eyes_mask;
struct eyes_state;
struct feature_parameter;
struct full_image_format;
struct lips_shine_mask;
struct transformed_mask_byte;
struct transformed_mask_gpu;
 
/**
 * getters throw exceptions when data are not available
 * android NNs usually output gpu masks
 */
class BNB_EXPORT frame_data {
public:
    virtual ~frame_data() {}
 
    /** Creates empty `FrameData`. Use `add*` function to fill it.  */
    static std::shared_ptr<frame_data> create();
 
    virtual full_image_format get_full_img_format() = 0;
 
    virtual std::vector<float> get_full_img_transform() = 0;
 
    /** Get frx_recognition_result or null if not exists */
    virtual std::shared_ptr<frx_recognition_result> get_frx_recognition_result() = 0;
 
    virtual void set_frx_recognition_result(const std::shared_ptr<frx_recognition_result> & result) = 0;
 
    /**
     * Face detector is an input for face recognizer. It gives only position of 
     * the face. Even if the face is present on the frame it doesn't mean that 
     * face detector can track it. 
     */
    virtual std::vector<detected_face> get_face_detector_result() = 0;
 
    virtual action_units_data get_action_units() = 0;
 
    /** *DEPRECATED*. Use `getFrxRecognitionResult().getFaces()` instead. */
    virtual bool get_is_smile() = 0;
 
    /** *DEPRECATED*. Use `getFrxRecognitionResult().getFaces()` instead. */
    virtual bool get_is_mouth_open() = 0;
 
    /** *DEPRECATED*. Use `getFrxRecognitionResult().getFaces()` instead. */
    virtual bool get_are_brows_raised() = 0;
 
    /** *DEPRECATED*. Use `getFrxRecognitionResult().getFaces()` instead. */
    virtual bool get_are_brows_shifted() = 0;
 
    /** *DEPRECATED*. Use `getFrxRecognitionResult().getFaces()` instead. */
    virtual bool get_is_wear_glasses() = 0;
 
    virtual float get_ruler() = 0;
 
    /** *DEPRECATED*. Use `getFrxRecognitionResult().getFaces()` instead. */
    virtual eyes_state get_eyes_state() = 0;
 
    virtual float get_light_correction() = 0;
 
    virtual transformed_mask_byte get_background() = 0;
 
    virtual transformed_mask_gpu get_background_gpu() = 0;
 
    virtual transformed_mask_byte get_hair() = 0;
 
    virtual transformed_mask_gpu get_hair_gpu() = 0;
 
    virtual transformed_mask_byte get_skin() = 0;
 
    virtual transformed_mask_gpu get_skin_gpu() = 0;
 
    virtual transformed_mask_byte get_lips() = 0;
 
    virtual transformed_mask_gpu get_lips_gpu() = 0;
 
    virtual transformed_mask_byte get_teeth() = 0;
 
    virtual transformed_mask_byte get_body() = 0;
 
    virtual lips_shine_mask get_lips_shine() = 0;
 
    virtual brows_mask get_brows() = 0;
 
    virtual eyes_mask get_eyes() = 0;
 
    virtual transformed_mask_byte get_face() = 0;
 
    virtual transformed_mask_byte get_face_skin() = 0;
 
    virtual std::optional<std::string> get_face_attributes() = 0;
 
    /**
     * Return value: 0 -- 'Undefined', 1 -- 'Heart', 2 -- 'Oblong', 3 -- 'Oval', 
     * 4 -- 'Round', 5 -- 'Square'.
     */
    virtual int32_t get_face_shape() = 0;
 
    /** Pupillary distance in mm */
    virtual float get_pupillary_distance() = 0;
 
    /**
     * list[0] and list[1] - x and y coordinates of the thermal temperature of the light source
     * list[2] - the brightness of the frame
     */
    virtual std::vector<float> get_light_source_params() = 0;
 
    /** Teeth color in Lab color space */
    virtual std::vector<int32_t> get_teeth_color() = 0;
 
    /** Eyeglasses frame color in RGB space */
    virtual std::vector<float> get_glasses_frame_color() = 0;
 
    virtual void add_full_img(::bnb::full_image_t img) = 0;
 
    virtual void replace_full_img(::bnb::full_image_t img) = 0;
 
    virtual ::bnb::full_image_t get_full_img() = 0;
 
    virtual void add_background(const transformed_mask_byte & mask) = 0;
 
    virtual void add_external_face_data(face_data_source source, const std::vector<external_face_data> & data) = 0;
 
    virtual void add_depth_map(const depth_map & depth_map) = 0;
 
    virtual void add_frame_number(int64_t frame_number) = 0;
 
    virtual void add_action_units_data(const action_units_data & action_units) = 0;
 
    /**
     * Extra parameters during in-CPU feature calculations.
     * Reference feature documentation. 
     */
    virtual void add_feature_parameters(const std::unordered_map<feature_id, std::vector<feature_parameter>> & params) = 0;
 
    /**add frame timestamp in microseconds */
    virtual void add_timestamp_us(double timestamp_us) = 0;
 
    virtual std::vector<float> get_chromakey_color() = 0;
};
 
} }  // namespace bnb::interfaces
/// @}