9.1/service-maker/includes/plugin.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2024-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 _DEEPSTREAM_PLUGIN_H_
#define _DEEPSTREAM_PLUGIN_H_
 
#define DS_CUSTOM_PLUGIN_DEFINE(name, description, version, license)                                     \
  extern "C" void *ds_stub_define_custom_plugin(const char *, const char *, const char *, const char *); \
  extern "C" void *gst_plugin_##name##_get_desc(void);                                                   \
  extern "C" void *gst_plugin_##name##_get_desc(void)                                                    \
  {                                                                                                      \
    return ds_stub_define_custom_plugin(#name, description, version, license);                           \
  }
 
#define DS_CUSTOM_FACTORY_DEFINE_PARAMS_BEGIN(param_spec)  static const char* param_spec = "["
#define DS_CUSTOM_FACTORY_DEFINE_PARAM(name, type, brief, description, default_value) \
"{name: "#name", type: "#type", brief: "#brief", description: "#description", default_value: "#default_value"},"
#define DS_CUSTOM_FACTORY_DEFINE_PARAMS_END "]";
 
#define DS_CUSTOM_FACTORY_DEFINE_FULL(factory_name, long_name, klass, description, author, signals, param_spec, \
 object_class, ...) \
class object_class##Factory : public deepstream::CustomFactory { \
public: \
  object_class##Factory() : \
    CustomFactory(factory_name, gst_custom_factory_get_type(factory_name)) {} \
  deepstream::CustomObject* createObject(const std::string& name) { \
    return new object_class(name, factory_name, __VA_ARGS__); \
  } \
}; \
extern "C" const FactoryMetadata get_custom_factory_info(void); \
extern "C" const FactoryMetadata get_custom_factory_info(void) { \
  return {factory_name, long_name, klass, description, author, object_class::type(), signals}; \
} \
extern "C" const char* get_custom_factory_product_param_spec(); \
extern "C" const char* get_custom_factory_product_param_spec() { return param_spec; } \
extern "C" void register_component_factory(const char *name);  \
extern "C" void register_component_factory(const char* name) { \
  deepstream::CommonFactory& factory = \
      deepstream::CommonFactory::getInstance();  \
  factory.addCustomFactory(new object_class##Factory(), name); \
}
 
#define DS_CUSTOM_FACTORY_DEFINE_WITH_PARAMS(factory_name, long_name, klass, description, author, signals, param_spec, \
  object_class, implementation) \
  DS_CUSTOM_FACTORY_DEFINE_FULL(factory_name, long_name, klass, description, author, signals, param_spec, object_class, new implementation)
 
#define DS_CUSTOM_FACTORY_DEFINE_WITH_SIGNALS(factory_name, long_name, klass, description, author, signals, \
  object_class, implementation) \
  static const char* param_spec = ""; \
  DS_CUSTOM_FACTORY_DEFINE_FULL(factory_name, long_name, klass, description, author, signals, param_spec, object_class, new implementation)
 
#define DS_CUSTOM_FACTORY_DEFINE(factory_name, long_name, klass, description, author, \
  object_class, implementation) \
  static const char* param_spec = ""; \
  DS_CUSTOM_FACTORY_DEFINE_FULL(factory_name, long_name, klass, description, author, "", param_spec, object_class, new implementation)
 
#endif