nx_metadata_sdk  1.0
Metadata SDK
device_agent.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 <thread>
6 #include <atomic>
7 #include <memory>
8 #include <condition_variable>
9 #include <vector>
10 #include <string>
11 #include <deque>
12 
13 #include <nx/sdk/analytics/helpers/consuming_device_agent.h>
14 #include <nx/sdk/analytics/helpers/pixel_format.h>
15 #include <nx/sdk/analytics/helpers/object_metadata_packet.h>
16 
17 #include "engine.h"
18 #include "objects/random.h"
19 #include "stub_analytics_plugin_ini.h"
20 
21 namespace nx {
22 namespace vms_server_plugins {
23 namespace analytics {
24 namespace stub {
25 
27 {
28 public:
29  DeviceAgent(Engine* engine, const nx::sdk::IDeviceInfo* deviceInfo);
30  virtual ~DeviceAgent() override;
31 
32 protected:
33  virtual void getPluginSideSettings(
34  nx::sdk::Result<const nx::sdk::ISettingsResponse*>* outResult) const override;
35 
36  virtual void doSetNeededMetadataTypes(
37  nx::sdk::Result<void>* outValue,
38  const nx::sdk::analytics::IMetadataTypes* neededMetadataTypes) override;
39 
40  virtual std::string manifestString() const override;
41 
43 
44  virtual bool pushCompressedVideoFrame(
45  const nx::sdk::analytics::ICompressedVideoPacket* videoFrame) override;
46 
47  virtual bool pushUncompressedVideoFrame(
48  const nx::sdk::analytics::IUncompressedVideoFrame* videoFrame) override;
49 
50  virtual bool pushCustomMetadataPacket(
51  const nx::sdk::analytics::ICustomMetadataPacket* customMetadataPacket) override;
52 
53  virtual bool pullMetadataPackets(
54  std::vector<nx::sdk::analytics::IMetadataPacket*>* metadataPackets) override;
55 
56 private:
57  nx::sdk::analytics::IMetadataPacket* cookSomeEvents();
58 
59  std::vector<nx::sdk::analytics::IMetadataPacket*> cookSomeObjects();
60 
61  nx::sdk::Ptr<nx::sdk::analytics::IObjectMetadata> cookBlinkingObjectIfNeeded(
62  int64_t metadataTimestampUs);
63 
64  void addBlinkingObjectIfNeeded(
65  int64_t metadataTimestampUs,
66  std::vector<nx::sdk::analytics::IMetadataPacket*>* metadataPackets,
68 
69  void addFixedObjectIfNeeded(
71 
72  int64_t usSinceEpoch() const;
73 
74  void processVideoFrame(const nx::sdk::analytics::IDataPacket* videoFrame, const char* func);
75 
76  void processCustomMetadataPacket(
77  const nx::sdk::analytics::ICustomMetadataPacket* customMetadataPacket,
78  const char* func);
79 
80  bool checkVideoFrame(const nx::sdk::analytics::IUncompressedVideoFrame* frame) const;
81 
82  bool checkVideoFramePlane(
84  const nx::sdk::analytics::PixelFormatDescriptor* pixelFormatDescriptor,
85  int plane) const;
86 
87  void dumpSomeFrameBytes(
89  int plane) const;
90 
91  void startFetchingMetadata(const nx::sdk::analytics::IMetadataTypes* metadataTypes);
92 
93  void stopFetchingMetadata();
94 
95  void processEvents();
96 
97  void processPluginDiagnosticEvents();
98 
99  void setObjectCount(int objectCount);
100 
101  void cleanUpTimestampQueue();
102 
103  void parseSettings();
104 
105  template<typename ObjectType>
106  void setIsObjectTypeGenerationNeeded(bool isObjectTypeGenerationNeeded)
107  {
108  if (isObjectTypeGenerationNeeded)
109  {
110  m_objectGenerator.registerObjectFactory<ObjectType>(
111  []() { return std::make_unique<ObjectType>(); });
112  }
113  else
114  {
115  m_objectGenerator.unregisterObjectFactory<ObjectType>();
116  }
117  }
118 
119  void updateObjectGenerationParameters();
120 
121  void updateEventGenerationParameters();
122 
123  void processFrameMotion(
125 
126  std::string capabilities() const;
127 
128 private:
129  Engine* const m_engine;
130 
131  std::atomic<bool> m_terminated{false};
132 
133  std::unique_ptr<std::thread> m_pluginDiagnosticEventThread;
134  std::mutex m_pluginDiagnosticEventGenerationLoopMutex;
135  std::condition_variable m_pluginDiagnosticEventGenerationLoopCondition;
136  std::atomic<bool> m_needToThrowPluginDiagnosticEvents{false};
137 
138  std::unique_ptr<std::thread> m_eventThread;
139  std::mutex m_eventGenerationLoopMutex;
140  std::condition_variable m_eventGenerationLoopCondition;
141  std::atomic<bool> m_eventsNeeded{false};
142 
143  int m_frameCounter = 0;
144  std::string m_eventTypeId;
145 
146  std::deque<int64_t> m_frameTimestampUsQueue;
147  int64_t m_lastVideoFrameTimestampUs = 0;
148  int64_t m_lastBlinkingObjectTimestampUs = 0;
149 
150  struct DeviceAgentSettings
151  {
152  bool needToGenerateObjects() const
153  {
154  return !ini().visualizeMotion
155  && (generateCars
156  || generateTrucks
157  || generatePedestrians
158  || generateHumanFaces
159  || generateBicycles
160  || generateStones
161  || generateFixedObject
162  || blinkingObjectPeriodMs.load() != std::chrono::milliseconds::zero());
163  }
164 
165  std::atomic<bool> generateEvents{true};
166  std::atomic<bool> generateCars{true};
167  std::atomic<bool> generateTrucks{true};
168  std::atomic<bool> generatePedestrians{true};
169  std::atomic<bool> generateHumanFaces{true};
170  std::atomic<bool> generateBicycles{true};
171  std::atomic<bool> generateStones{false};
172  std::atomic<bool> generateFixedObject{false};
173 
174  std::atomic<std::chrono::milliseconds> blinkingObjectPeriodMs{
175  std::chrono::milliseconds::zero()};
176 
177  std::atomic<bool> blinkingObjectInDedicatedPacket{false};
178 
179  std::atomic<int> numberOfObjectsToGenerate{1};
180  std::atomic<int> generateObjectsEveryNFrames{1};
181 
182  std::atomic<bool> generatePreviews{true};
183 
184  std::atomic<bool> throwPluginDiagnosticEvents{false};
185  std::atomic<bool> leakFrames{false};
186 
187  std::atomic<std::chrono::milliseconds> additionalFrameProcessingDelayMs{
188  std::chrono::milliseconds::zero()};
189 
190  std::atomic<std::chrono::milliseconds> overallMetadataDelayMs{
191  std::chrono::milliseconds::zero()};
192 
193  std::atomic<int> numberOfFramesBeforePreviewGeneration{30};
194  };
195 
196  DeviceAgentSettings m_deviceAgentSettings;
197 
198  struct EventContext
199  {
200  int currentEventTypeIndex = 0;
201  bool isCurrentEventActive = false;
202  };
203 
204  EventContext m_eventContext;
205 
206  struct ObjectContext
207  {
208  ObjectContext() = default;
209  ObjectContext(std::unique_ptr<AbstractObject> object): object(std::move(object)) {}
210 
211  ObjectContext& operator=(std::unique_ptr<AbstractObject>&& otherObject)
212  {
213  reset();
214  object = std::move(otherObject);
215  return *this;
216  }
217 
218  void reset()
219  {
220  object.reset();
221  isPreviewGenerated = false;
222  frameCounter = 0;
223  }
224 
225  bool operator!() const { return !object; }
226 
227  std::unique_ptr<AbstractObject> object;
228  bool isPreviewGenerated = false;
229  int frameCounter = 0;
230  };
231 
232  std::mutex m_objectGenerationMutex;
233  RandomObjectGenerator m_objectGenerator;
234  std::vector<ObjectContext> m_objectContexts;
235 };
236 
237 const std::string kLineCrossingEventType = "nx.stub.lineCrossing";
238 const std::string kObjectInTheAreaEventType = "nx.stub.objectInTheArea";
239 const std::string kLoiteringEventType = "nx.stub.loitering";
240 const std::string kIntrusionEventType = "nx.stub.intrusion";
241 const std::string kGunshotEventType = "nx.stub.gunshot";
242 const std::string kSuspiciousNoiseEventType = "nx.stub.suspiciousNoise";
243 const std::string kSoundRelatedEventGroup = "nx.stub.soundRelatedEvent";
244 const std::string kBlinkingObjectType = "nx.stub.blinkingObject";
245 const std::string kFixedObjectType = "nx.stub.fixedObject";
246 
247 } // namespace stub
248 } // namespace analytics
249 } // namespace vms_server_plugins
250 } // namespace nx
virtual bool pushCompressedVideoFrame(const nx::sdk::analytics::ICompressedVideoPacket *videoFrame) override
Definition: device_agent.cpp:276
virtual nx::sdk::Result< const nx::sdk::IStringMap * > settingsReceived() override
Definition: device_agent.cpp:225
Definition: i_metadata_packet.h:16
virtual bool pushUncompressedVideoFrame(const nx::sdk::analytics::IUncompressedVideoFrame *videoFrame) override
Definition: device_agent.cpp:292
Definition: i_compressed_video_packet.h:35
Definition: ptr.h:18
virtual bool pushCustomMetadataPacket(const nx::sdk::analytics::ICustomMetadataPacket *customMetadataPacket) override
Definition: device_agent.cpp:308
virtual std::string manifestString() const override
Definition: device_agent.cpp:139
Definition: consuming_device_agent.h:38
Definition: i_metadata_types.h:13
Definition: result.h:81
Definition: i_device_info.h:14
Definition: result.h:47
Definition: apple_utils.h:6
Definition: i_custom_metadata_packet.h:17
Definition: pixel_format.h:26
Definition: i_uncompressed_video_frame.h:71
Definition: i_data_packet.h:16
Definition: i_list.h:9