i_engine.h

// Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/

#pragma once

#include <camera/camera_plugin.h>
#include <nx/sdk/i_device_info.h>
#include <nx/sdk/i_list.h>
#include <nx/sdk/i_integration.h>
#include <nx/sdk/interface.h>
#include <nx/sdk/ptr.h>
#include <nx/sdk/result.h>

#include "i_device_agent.h"

namespace nx::sdk::cloud_storage {

enum class MetadataType
{
    motion,
    analytics,
    bookmark,
};

struct StorageSpace
{
    int64_t totalSpace = -1;
    int64_t freeSpace = -1;
};

enum class TrackImageType
{
    bestShot,
    title,
};

class IEngine: public Interface<IEngine>
{
public:
    static auto interfaceId() { return makeId("nx::sdk::archive::IEngine"); }

    protected: virtual void doObtainDeviceAgent(
        Result<IDeviceAgent*>* outResult, const IDeviceInfo* deviceInfo) = 0;

    public: virtual Result<IDeviceAgent*> obtainDeviceAgent(const IDeviceInfo* deviceInfo)
    {
        Result<IDeviceAgent*> result;
        doObtainDeviceAgent(&result, deviceInfo);
        return result;
    }

    protected: virtual void doQueryBookmarks(const char* filter, Result<IString*>* outResult) = 0;

    public: Result<IString*> queryBookmarks(const char* filter)
    {
        Result<IString*> result;
        doQueryBookmarks(filter, &result);
        return result;
    }

    public: virtual ErrorCode deleteBookmark(const char* bookmarkId) = 0;

    protected: virtual void doQueryMotionTimePeriods(
        const char* filter, Result<IString*>* outResult) = 0;

    public: Result<IString*> queryMotionTimePeriods(const char* filter)
    {
        Result<IString*> result;
        doQueryMotionTimePeriods(filter, &result);
        return result;
    }

    protected: virtual void doQueryAnalytics(const char* filter, Result<IString*>* outResult) = 0;

    public: Result<IString*> queryAnalytics(const char* filter)
    {
        Result<IString*> result;
        doQueryAnalytics(filter, &result);
        return result;
    }

    protected: virtual void doQueryAnalyticsTimePeriods(
        const char* filter, Result<IString*>* outResult) = 0;

    public: Result<IString*> queryAnalyticsTimePeriods(const char* filter)
    {
        Result<IString*> result;
        doQueryAnalyticsTimePeriods(filter, &result);
        return result;
    }

    public: virtual ErrorCode saveMetadata(
        const char* deviceId, MetadataType type, const char* data) = 0;

    public: virtual void flushMetadata(MetadataType type) = 0;

    public: Result<IString*> fetchTrackImage(const char* objectTrackId, TrackImageType type) const
    {
        Result<IString*> result;
        doFetchTrackImage(objectTrackId, type, &result);
        return result;
    }

    protected: virtual void doFetchTrackImage(
        const char* objectTrackId, TrackImageType type, Result<IString*>* outResult) const = 0;

    public: virtual void startAsyncTasks(const char* lastSequenceId) = 0;

    public: virtual void stopAsyncTasks() = 0;

    public: virtual bool isOnline() const = 0;

    public: virtual ErrorCode storageSpace(StorageSpace* storageSpace) const = 0;
};

} // namespace nx::sdk::cloud_storage