sources/libs/nvds_rest_server/nvds_rest_metrics.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef _NVDS_REST_METRICS_H_
#define _NVDS_REST_METRICS_H_
 
#include <glib.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MAX_COMPONENT_LEN 64
 
// -----------------------------------------------------------------------------
// Data Structures
// -----------------------------------------------------------------------------
 
typedef struct _NvDsMetricsFrameLatency {
  guint source_id;            // Source ID, e.g., camera ID
  guint frame_num;            // Frame number for which latency is measured
  gdouble comp_in_timestamp;  // System timestamp when buffer arrives at the first component
  gdouble latency;            // Latency of the frame in milliseconds
} NvDsMetricsFrameLatency;
 
typedef struct _NvDsMetricsCompLatency {
  gchar component_name[MAX_COMPONENT_LEN]; // Component name
  gdouble in_system_timestamp;             // Timestamp when buffer arrives at component input
  gdouble out_system_timestamp;            // Timestamp when buffer is sent downstream
  guint source_id;                          // Source ID, e.g., camera ID
  guint frame_num;                          // Frame number
  guint pad_index;                          // Pad index for the frame in the batch
  guint num_sub_comps;                      // Number of subcomponents
  gdouble latency;                          // Latency in milliseconds
} NvDsMetricsCompLatency;
 
typedef struct {
  guint source_id;
  gdouble fps_val;
  gchar source_name[256];
} NvDsMetricsFpsData;
 
typedef struct {
  NvDsMetricsFrameLatency* frame_latency_data;
  NvDsMetricsFpsData* fps_data;
 
  guint frame_latency_count;
  guint fps_count;
 
  gboolean frame_latency_available;
  gboolean fps_data_available;
 
  GMutex mutex;                // Global lock
  GMutex frame_metrics_mutex;  // Additional lock for frame metrics
  void* user_data;
} NvDsFrameLatencySharedData;
 
typedef struct {
  NvDsMetricsCompLatency* comp_latency_data;
  guint comp_latency_count;
 
  gboolean comp_latency_available;
 
  GMutex mutex;                 // Global lock
  GMutex comp_metrics_mutex;    // Additional lock for component metrics
  void* user_data;
} NvDsCompLatencySharedData;
 
// -----------------------------------------------------------------------------
// Global Instances
// -----------------------------------------------------------------------------
extern NvDsFrameLatencySharedData g_shared_frame_latency_data;
extern NvDsCompLatencySharedData g_shared_comp_latency_data;
 
// -----------------------------------------------------------------------------
// API Functions
// -----------------------------------------------------------------------------
 
// Frame Latency APIs
void nvds_init_shared_frame_latency_data(void);
void nvds_cleanup_shared_frame_latency_data(void);
void nvds_update_shared_frame_latency_data(NvDsMetricsFrameLatency* latency_data, guint count);
NvDsMetricsFrameLatency* nvds_get_shared_frame_latency_data(guint* count);
 
// Component Latency APIs
void nvds_init_shared_comp_latency_data(void);
void nvds_cleanup_shared_comp_latency_data(void);
void nvds_update_shared_comp_latency_data(NvDsMetricsCompLatency* latency_data, guint count);
NvDsMetricsCompLatency* nvds_get_shared_comp_latency_data(guint* count);
 
// FPS APIs
void nvds_update_shared_fps_data(NvDsMetricsFpsData* data, guint count);
NvDsMetricsFpsData* nvds_get_shared_fps_data(guint* count);
 
#ifdef __cplusplus
}
#endif
 
#endif // _NVDS_REST_METRICS_H_