nx_metadata_sdk  1.0
Metadata SDK
engine.h
1 // Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/
2 
3 #pragma once
4 
5 #include <atomic>
6 #include <thread>
7 #include <memory>
8 #include <mutex>
9 #include <condition_variable>
10 
11 #include <nx/sdk/uuid.h>
12 #include <nx/sdk/analytics/helpers/plugin.h>
13 #include <nx/sdk/analytics/helpers/engine.h>
14 #include <nx/sdk/analytics/i_uncompressed_video_frame.h>
15 
16 namespace nx {
17 namespace vms_server_plugins {
18 namespace analytics {
19 namespace stub {
20 
22 {
23 public:
24  using PixelFormat = nx::sdk::analytics::IUncompressedVideoFrame::PixelFormat;
25 
27 
28  virtual ~Engine() override;
29 
30  // Capabilities.
31  bool needUncompressedVideoFrames() const { return m_needUncompressedVideoFrames; }
32 
33  PixelFormat pixelFormat() const { return m_pixelFormat; }
34 
35  std::string capabilities() const;
36 
37 protected:
38  virtual std::string manifestString() const override;
39 
41 
42 protected:
43  virtual void doObtainDeviceAgent(
45  const nx::sdk::IDeviceInfo* deviceInfo) override;
46 
48  const std::string& actionId,
49  nx::sdk::Uuid trackId,
50  nx::sdk::Uuid deviceId,
51  int64_t timestampUs,
53  const std::map<std::string, std::string>& params) override;
54 
55  virtual void getPluginSideSettings(
56  nx::sdk::Result<const nx::sdk::ISettingsResponse*>* outResult) const override;
57 
58 private:
59  void obtainServerSdkVersion();
60  void obtainPluginHomeDir();
61  void initCapabilities();
62  void generatePluginDiagnosticEvents();
63 
64 private:
65  nx::sdk::analytics::Plugin* const m_plugin;
66 
67  mutable std::mutex m_pluginDiagnosticEventGenerationLoopMutex;
68  mutable std::condition_variable m_pluginDiagnosticEventGenerationLoopCondition;
69  std::unique_ptr<std::thread> m_pluginDiagnosticEventThread;
70  std::atomic<bool> m_terminated{false};
71  std::atomic<bool> m_needToThrowPluginDiagnosticEvents{false};
72  std::atomic<bool> m_disableStreamSelection{false};
73 
74  std::string m_pluginHomeDir;
75  std::string m_capabilities;
76  std::string m_streamTypeFilter;
77  bool m_needUncompressedVideoFrames = false;
78  PixelFormat m_pixelFormat = PixelFormat::yuv420;
79 };
80 
81 } // namespace stub
82 } // namespace analytics
83 } // namespace vms_server_plugins
84 } // namespace nx
Definition: ptr.h:18
virtual nx::sdk::Result< const nx::sdk::ISettingsResponse * > settingsReceived() override
Definition: engine.cpp:298
Definition: uuid.h:22
Definition: i_device_info.h:14
Definition: result.h:47
Definition: apple_utils.h:6
virtual nx::sdk::Result< sdk::analytics::IAction::Result > executeAction(const std::string &actionId, nx::sdk::Uuid trackId, nx::sdk::Uuid deviceId, int64_t timestampUs, nx::sdk::Ptr< nx::sdk::analytics::IObjectTrackInfo > objectTrackInfo, const std::map< std::string, std::string > &params) override
Definition: engine.cpp:367
Definition: engine.h:34
Definition: plugin.h:23