include/fsdk/IFaceLandmarksDetector.h

#pragma once

#include <fsdk/FSDKError.h>
#include <fsdk/IObject.h>
#include <fsdk/Types.h>
#include <fsdk/IFaceLandmarksBatch.h>

#include <fsdk/vlc/future.h>

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IFaceLandmarksDetector);
#endif

    struct IFaceLandmarksDetector : IRefCounted {

        virtual ResultValue<FSDKError, Ref<IFaceLandmarksBatch>>
        detectLandmarks5(Span<const Image> images, Span<Span<const Detection>> detections) const noexcept = 0;

        virtual ResultValue<FSDKError, Ref<IFaceLandmarksBatch>>
        detectLandmarks68(Span<const Image> images, Span<Span<const Detection>> detections) const noexcept = 0;

        virtual Result<FSDKError> validate(
            Span<const Image> images,
            Span<Span<const Detection>> detections,
            Span<Span<Result<FSDKError>>> errors) const noexcept = 0;

        virtual Result<FSDKError> detectLandmarks5(
            const Image& image,
            Span<const Detection> detections,
            Span<Landmarks5> landmarks) const noexcept = 0;

        virtual Result<FSDKError> detectLandmarks68(
            const Image& image,
            Span<const Detection> detections,
            Span<Landmarks68> landmarks) const noexcept = 0;

        virtual Result<FSDKError> validate(
            const Image& images,
            Span<const Detection> detections,
            Span<Result<FSDKError>> errors) const noexcept = 0;

        virtual Result<FSDKError> validate(
            Span<const Image> images,
            Span<Span<const Detection>> detections,
            DetectionType detectionType,
            Span<Span<Result<FSDKError>>> errors) const noexcept = 0;

        using FaceLandmarksBatchFuture = vlc::future<IFaceLandmarksBatchPtr>;

        virtual FaceLandmarksBatchFuture detectLandmarksAsync(
            Span<const Image> images,
            Span<Span<const Detection>> detections,
            DetectionType detectionType) const = 0;
    };

} // namespace fsdk