sources/includes/gstnvdsmeta.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2019-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 GST_NVDS_META_API_H
#define GST_NVDS_META_API_H
 
#include <gst/gst.h>
#include <gst/video/video.h>
#include <gst/base/gstbasetransform.h>
 
#include "nvdsmeta.h"
#include "nvds_audio_meta.h"
#include "nvds_latency_meta.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
GType nvds_meta_api_get_type (void);
#define NVDS_META_API_TYPE (nvds_meta_api_get_type())
 
const GstMetaInfo *nvds_meta_get_info (void);
 
#define NVDS_META_INFO (nvds_meta_get_info())
 
#define NVDS_META_STRING "nvdsmeta"
 
typedef enum {
  NVDS_GST_INVALID_META=-1,
  /* Specifies information of a formed batch. */
  NVDS_BATCH_GST_META = NVDS_GST_CUSTOM_META + 1,
  NVDS_DECODER_GST_META,
  /* Specifies information of dewarped surfaces. */
  NVDS_DEWARPER_GST_META,
  /* @ref NvDsMetaType for @ref NvDsUserMeta in @NvDsFrameMeta
   * This metadata carries GstMeta objects of all input frames
   * batched by nvstreammux2
   * Note: Please refer to APIs @ref nvds_copy_gst_meta_to_frame_meta
   * and @ref nvds_copy_gst_meta_to_audio_frame_meta for more information.
   */
  NVDS_BUFFER_GST_AS_FRAME_USER_META,
  NVDS_RESERVED_GST_META = NVDS_GST_CUSTOM_META + 4096,
  /* Specifies the first value that may be assigned to a user-defined type. */
  NVDS_GST_META_FORCE32 = 0x7FFFFFFF
} GstNvDsMetaType;
 
 typedef struct _NvDsMeta {
  GstMeta       meta;
 
  gpointer meta_data;
 
  gpointer user_data;
 
  gint meta_type;
 
  NvDsMetaCopyFunc copyfunc;
 
  NvDsMetaReleaseFunc freefunc;
 
  NvDsMetaCopyFunc gst_to_nvds_meta_transform_func;
 
  NvDsMetaReleaseFunc gst_to_nvds_meta_release_func;
 
} NvDsMeta;
 
NvDsMeta *gst_buffer_add_nvds_meta (GstBuffer *buffer, gpointer meta_data,
    gpointer user_data, NvDsMetaCopyFunc copy_func,
    NvDsMetaReleaseFunc release_func);
 
NvDsMeta* gst_buffer_get_nvds_meta (GstBuffer *buffer);
 
NvDsBatchMeta * gst_buffer_get_nvds_batch_meta (GstBuffer *buffer);
 
void nvds_copy_gst_meta_to_frame_meta(GstBuffer* src_gst_buffer, NvDsBatchMeta* batch_meta, NvDsFrameMeta* frame_meta);
 
void nvds_copy_gst_meta_to_audio_frame_meta(GstBuffer* src_gst_buffer, NvDsBatchMeta* batch_meta, NvDsAudioFrameMeta* frame_meta);
 
#ifdef __cplusplus
}
#endif
#endif