NVIDIA DeepStream SDK API Reference

9.1 Release
sources/includes/ds3d/common/impl/impl_datafilter.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef DS3D_COMMON_IMPL_BASE_DATA_FILTER_H
19 #define DS3D_COMMON_IMPL_BASE_DATA_FILTER_H
20 
21 #include "ds3d/common/hpp/datamap.hpp"
22 #include "ds3d/common/impl/impl_dataprocess.h"
23 
24 namespace ds3d { namespace impl {
25 
38 class BaseImplDataFilter : public BaseImplDataProcessor<abiDataFilter> {
39 public:
41  ~BaseImplDataFilter() override = default;
42 
44  const abiRefDataMap* inputData, const abiOnDataCB* outputDataCb,
45  const abiOnDataCB* inputDataConsumedCb) final
46  {
48  getStateSafe() == State::kRunning, ErrCode::kState, "datafilter is not started");
49 
50  DS_ASSERT(inputData);
51  GuardDataMap inData(*inputData);
52  GuardCB<abiOnDataCB> guardOutputCb(outputDataCb ? outputDataCb->refCopy() : nullptr);
53  OnGuardDataCBImpl outputCbImpl = [gOutputCb = std::move(guardOutputCb), this](
54  ErrCode code, GuardDataMap data) {
55  gOutputCb(code, data.abiRef());
56  };
57 
58  GuardCB<abiOnDataCB> guardConsumedCb(
59  inputDataConsumedCb ? inputDataConsumedCb->refCopy() : nullptr);
60  OnGuardDataCBImpl consumedCbImpl = [gConsumedCb = std::move(guardConsumedCb), this](
61  ErrCode code, GuardDataMap data) {
62  gConsumedCb(code, data.abiRef());
63  };
64  return processImpl(std::move(inData), std::move(outputCbImpl), std::move(consumedCbImpl));
65  }
66 
67 protected:
68  // cplusplus virtual interface, user need to derive from
69  virtual ErrCode processImpl(
70  GuardDataMap datamap, OnGuardDataCBImpl outputDataCb,
71  OnGuardDataCBImpl inputConsumedCb) = 0;
72 };
73 
74 }} // namespace ds3d::impl
75 
76 #endif // DS3D_COMMON_IMPL_BASE_DATA_FILTER_H
ds3d::impl::BaseImplDataFilter::~BaseImplDataFilter
~BaseImplDataFilter() override=default
ds3d::impl::BaseImplDataFilter::processImpl
virtual ErrCode processImpl(GuardDataMap datamap, OnGuardDataCBImpl outputDataCb, OnGuardDataCBImpl inputConsumedCb)=0
DS3D_FAILED_RETURN
#define DS3D_FAILED_RETURN(condition, ret, fmt,...)
Definition: sources/includes/ds3d/common/defines.h:69
ds3d::impl::BaseImplDataFilter::BaseImplDataFilter
BaseImplDataFilter()
Definition: sources/includes/ds3d/common/impl/impl_datafilter.h:40
ds3d::impl::BaseImplDataProcessor< abiDataFilter >::OnGuardDataCBImpl
std::function< void(ErrCode, GuardDataMap)> OnGuardDataCBImpl
Definition: sources/includes/ds3d/common/impl/impl_dataprocess.h:33
ds3d::abiRefT< abiDataMap >
ds3d::impl::BaseImplDataFilter
Any custom datafilter must derive from BaseImplDataFilter,.
Definition: sources/includes/ds3d/common/impl/impl_datafilter.h:38
DS_ASSERT
#define DS_ASSERT(...)
Definition: sources/includes/ds3d/common/defines.h:36
ds3d::ErrCode
ErrCode
Definition: sources/includes/ds3d/common/common.h:47
ds3d::impl::BaseImplDataProcessor< abiDataFilter >::getStateSafe
State getStateSafe() const
Definition: sources/includes/ds3d/common/impl/impl_dataprocess.h:116
ds3d::impl::BaseImplDataProcessor
BaseProcessIF could be abiDataLoader/abiDataRender/abiDataFilter or any others abi interface that der...
Definition: sources/includes/ds3d/common/impl/impl_dataprocess.h:31
ds3d::impl::BaseImplDataFilter::process_i
ErrCode process_i(const abiRefDataMap *inputData, const abiOnDataCB *outputDataCb, const abiOnDataCB *inputDataConsumedCb) final
Definition: sources/includes/ds3d/common/impl/impl_datafilter.h:43
ds3d::GuardDataMap
Definition: sources/includes/ds3d/common/hpp/datamap.hpp:27
ds3d::State::kRunning
@ kRunning
ds3d
Definition: sources/includes/ds3d/common/abi_dataprocess.h:25
ds3d::abiCallBackT
Definition: sources/includes/ds3d/common/abi_obj.h:75
ds3d::ErrCode::kState
@ kState
ds3d::GuardCB
Definition: sources/includes/ds3d/common/hpp/obj.hpp:289