9.1/sources/includes/gst-nvdssr.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 NVDSSR_H_
#define NVDSSR_H_
 
#include <gst/gst.h>
 
#define _DS_DEPRECATED_(STR) __attribute__ ((deprecated (STR)))
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct NvDsSRRecordingInfo NvDsSRRecordingInfo;
 
typedef gpointer (*NvDsSRCallbackFunc) (NvDsSRRecordingInfo *info, gpointer userData);
 
typedef guint32 NvDsSRSessionId;
 
typedef enum {
  NVDSSR_CONTAINER_MP4,
  NVDSSR_CONTAINER_MKV
} NvDsSRContainerType;
 
typedef enum {
  NVDSSR_STATUS_OK,
  NVDSSR_STATUS_INVALID_VAL,
  NVDSSR_STATUS_INVALID_OP,
  NVDSSR_STATUS_ERROR,
 
  NVDSSR_STATUS_CUSTOM1 = 100,
  NVDSSR_STATUS_CUSTOM2 = 101,
  NVDSSR_STATUS_CUSTOM3 = 102
} NvDsSRStatus;
 
typedef struct NvDsSRInitParams
{
  NvDsSRCallbackFunc callback;
  NvDsSRContainerType containerType;
  guint width;
  guint height;
  gchar *fileNamePrefix;
  gchar *dirpath;
  guint defaultDuration;
  union {
    guint videoCacheSize _DS_DEPRECATED_("videoCacheSize is deprecated. Use cacheSize instead");
    guint cacheSize;
  };
} NvDsSRInitParams;
 
typedef struct NvDsSRContext
{
  GstElement *recordbin;
  GstElement *recordQue;
  GstElement *encodebin;
  GstElement *filesink;
  gboolean gotKeyFrame;
  gboolean recordOn;
  gboolean resetDone;
  gboolean isPlaying;
  NvDsSRInitParams initParams;
  GMutex flowLock;
  GThread *resetThread;
  gpointer uData;
  gpointer privData;
} NvDsSRContext;
 
typedef struct NvDsSRRecordingInfo
{
  NvDsSRContext *ctx;
  NvDsSRSessionId sessionId;
  gchar *filename;
  gchar *dirpath;
  guint64 duration;
  NvDsSRContainerType containerType;
  guint width;
  guint height;
  gboolean containsVideo;
  guint channels;
  guint samplingRate;
  gboolean containsAudio;
} NvDsSRRecordingInfo;
 
NvDsSRStatus NvDsSRCreate (NvDsSRContext **ctx, NvDsSRInitParams *params);
 
NvDsSRStatus NvDsSRStart (NvDsSRContext *ctx, NvDsSRSessionId *sessionId,
                          guint startTime, guint duration, gpointer userData);
 
NvDsSRStatus NvDsSRStop (NvDsSRContext *ctx, NvDsSRSessionId sessionId);
 
NvDsSRStatus NvDsSRDestroy (NvDsSRContext *ctx);
 
#ifdef __cplusplus
}
#endif
#endif /* NVDSSR_H_ */