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 private:
56  void obtainPluginHomeDir();
57  void initCapabilities();
58  void generatePluginDiagnosticEvents();
59 
60 private:
61  nx::sdk::analytics::Plugin* const m_plugin;
62 
63  mutable std::mutex m_pluginDiagnosticEventGenerationLoopMutex;
64  mutable std::condition_variable m_pluginDiagnosticEventGenerationLoopCondition;
65  std::unique_ptr<std::thread> m_pluginDiagnosticEventThread;
66  std::atomic<bool> m_terminated{false};
67  std::atomic<bool> m_needToThrowPluginDiagnosticEvents{false};
68  std::atomic<bool> m_hideStreamSelection{false};
69 
70  std::string m_pluginHomeDir;
71  std::string m_capabilities;
72  std::string m_streamTypeFilter;
73  bool m_needUncompressedVideoFrames = false;
74  PixelFormat m_pixelFormat = PixelFormat::yuv420;
75 };
76 
77 const std::string kGenerateEventsSetting{"generateEvents"};
78 const std::string kMotionVisualizationObjectType{"nx.stub.motionVisualization"};
79 
80 const std::string kGenerateCarsSetting{"generateCars"};
81 const std::string kGenerateTrucksSetting{"generateTrucks"};
82 const std::string kGeneratePedestriansSetting{"generatePedestrians"};
83 const std::string kGenerateHumanFacesSetting{"generateHumanFaces"};
84 const std::string kGenerateBicyclesSetting{"generateBicycles"};
85 const std::string kGenerateStonesSetting{"generateStones"};
86 const std::string kGenerateFixedObjectSetting{"generateFixedObject"};
87 
88 const std::string kBlinkingObjectPeriodMsSetting{"blinkingObjectPeriodMs"};
89 const std::string kBlinkingObjectInDedicatedPacketSetting{"blinkingObjectInDedicatedPacket"};
90 
91 const std::string kGenerateObjectsEveryNFramesSetting{"generateObjectsEveryNFrames"};
92 const std::string kNumberOfObjectsToGenerateSetting{"numberOfObjectsToGenerate"};
93 const std::string kGeneratePreviewPacketSetting{"generatePreviewPacket"};
94 const std::string kGeneratePreviewAfterNFramesSetting("generatePreviewAfterNFrames");
95 const std::string kThrowPluginDiagnosticEventsFromDeviceAgentSetting{
96  "throwPluginDiagnosticEventsFromDeviceAgent"};
97 
98 const std::string kThrowPluginDiagnosticEventsFromEngineSetting{
99  "throwPluginDiagnosticEventsFromDeviceAgent"};
100 const std::string kHideStreamSelectionSetting{"hideStreamSelection"};
101 const std::string kLeakFramesSetting{"leakFrames"};
102 const std::string kAdditionalFrameProcessingDelayMsSetting{"additionalFrameProcessingDelayMs"};
103 const std::string kOverallMetadataDelayMsSetting{"overallMetadataDelayMs"};
104 
105 } // namespace stub
106 } // namespace analytics
107 } // namespace vms_server_plugins
108 } // namespace nx
Definition: ptr.h:18
Definition: uuid.h:21
Definition: i_device_info.h:14
Definition: result.h:47
Definition: apple_utils.h:6
virtual nx::sdk::Result< const nx::sdk::IStringMap * > settingsReceived() override
Definition: engine.cpp:784
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:850
Definition: engine.h:34
Definition: plugin.h:23