* @see http://github.com/nnstreamer/nnstreamer
* @author Dongju Chae <dongju.chae@samsung.com>
* @bug No known bugs except for NYI items
- * @todo This would be better if this inherits tensor_filter_subplugin class.
*/
/**
#pragma GCC diagnostic ignored "-Wformat"
#endif
-#define NO_ANONYMOUS_NESTED_STRUCT
-#include <nnstreamer_plugin_api_filter.h>
-#undef NO_ANONYMOUS_NESTED_STRUCT
+/* nnstreamer plugin api headers */
#include <map>
#include <nnstreamer_conf.h>
+#include <nnstreamer_cppplugin_api_filter.hh>
+#include <nnstreamer_log.h>
#include <nnstreamer_util.h>
#include "nnstreamer_python3_helper.h"
#define DBG FALSE
#endif
-static const gchar *python_accl_support[] = { NULL };
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+void init_filter_py (void) __attribute__ ((constructor));
+void fini_filter_py (void) __attribute__ ((destructor));
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+namespace nnstreamer
+{
+namespace tensorfilter_python3
+{
/** @brief Callback type for custom filter */
-typedef enum _cb_type {
+enum class cb_type {
CB_SETDIM = 0,
CB_GETDIM,
CB_END,
-} cb_type;
+};
/**
* @brief Python embedding core structure
}
};
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-void init_filter_py (void) __attribute__ ((constructor));
-void fini_filter_py (void) __attribute__ ((destructor));
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
-
/**
* @brief PYCore creator
* @param _script_path : the logical path to '{script_name}.py' file
gst_tensors_info_init (&inputTensorMeta);
gst_tensors_info_init (&outputTensorMeta);
- callback_type = CB_END;
+ callback_type = cb_type::CB_END;
core_obj = NULL;
configured = false;
shape_cls = NULL;
/** check whther either setInputDim or getInputDim/getOutputDim are
* defined */
if (PyObject_HasAttrString (core_obj, (char *) "setInputDim"))
- callback_type = CB_SETDIM;
+ callback_type = cb_type::CB_SETDIM;
else if (PyObject_HasAttrString (core_obj, (char *) "getInputDim")
&& PyObject_HasAttrString (core_obj, (char *) "getOutputDim"))
- callback_type = CB_GETDIM;
+ callback_type = cb_type::CB_GETDIM;
else
- callback_type = CB_END;
+ callback_type = cb_type::CB_END;
} else {
Py_ERRMSG ("Fail to create an instance 'CustomFilter'\n");
ret = -3;
PyList_SetItem (param, i, input_array);
}
-
result = PyObject_CallMethod (core_obj, (char *) "invoke", (char *) "(O)", param);
if (result) {
}
/**
- * @brief The mandatory callback for GstTensorFilterFramework
- * @param prop: property of tensor_filter instance
- * @param private_data : python plugin's private data
- * @param input : The array of input tensors
- * @param output : The array of output tensors
+ * @brief Class for Python3 subplugin
*/
-static int
-py_run (const GstTensorFilterProperties *prop, void **private_data,
- const GstTensorMemory *input, GstTensorMemory *output)
+class TensorFilterPython : public tensor_filter_subplugin
{
- PYCore *core = static_cast<PYCore *> (*private_data);
- UNUSED (prop);
+ public:
+ TensorFilterPython ();
+ ~TensorFilterPython ();
- g_return_val_if_fail (core, -EINVAL);
- g_return_val_if_fail (input, -EINVAL);
- g_return_val_if_fail (output, -EINVAL);
+ /* mandatory methods */
+ tensor_filter_subplugin &getEmptyInstance ();
+ void configure_instance (const GstTensorFilterProperties *prop);
+ void invoke (const GstTensorMemory *input, GstTensorMemory *output);
+ void getFrameworkInfo (GstTensorFilterFrameworkInfo &info);
+ int getModelInfo (model_info_ops ops, GstTensorsInfo &in_info, GstTensorsInfo &out_info);
+ int eventHandler (event_ops ops, GstTensorFilterFrameworkEventData &data);
- PyGILState_STATE gstate = PyGILState_Ensure ();
- int ret = core->run (input, output);
- PyGILState_Release (gstate);
- return ret;
-}
+ /* static methods */
+ static void init_filter_py ();
+ static void fini_filter_py ();
-/**
- * @brief The optional callback for GstTensorFilterFramework
- * @param data : The data element.
- * @param private_data : python plugin's private data
- */
-static void
-py_destroyNotify (void **private_data, void *data)
-{
- PYCore *core = static_cast<PYCore *> (*private_data);
-
- if (core) {
- PyGILState_STATE gstate = PyGILState_Ensure ();
- core->freeOutputTensors (data);
- PyGILState_Release (gstate);
- }
-}
+ private:
+ PYCore *core;
-/**
- * @brief The optional callback for GstTensorFilterFramework
- * @param[in] prop read-only property values
- * @param[in/out] private_data python plugin's private data
- * @param[in] in_info structure of input tensor info
- * @param[out] out_info structure of output tensor info
- */
-static int
-py_setInputDim (const GstTensorFilterProperties *prop, void **private_data,
- const GstTensorsInfo *in_info, GstTensorsInfo *out_info)
-{
- PYCore *core = static_cast<PYCore *> (*private_data);
- UNUSED (prop);
- g_return_val_if_fail (core && in_info && out_info, -EINVAL);
+ static TensorFilterPython *registered;
+ static const char *name;
+ static const accl_hw hw_list[];
+ static const int num_hw;
+};
- if (core->getCbType () != CB_SETDIM) {
- return -ENOENT;
- }
+void init_filter_py (void) __attribute__ ((constructor));
+void fini_filter_py (void) __attribute__ ((destructor));
- PyGILState_STATE gstate = PyGILState_Ensure ();
- int ret = core->setInputTensorDim (in_info, out_info);
- PyGILState_Release (gstate);
- return ret;
-}
+TensorFilterPython *TensorFilterPython::registered = nullptr;
+const char *TensorFilterPython::name = "python3";
+const accl_hw TensorFilterPython::hw_list[] = {};
+const int TensorFilterPython::num_hw = 0;
/**
- * @brief The optional callback for GstTensorFilterFramework
- * @param prop: property of tensor_filter instance
- * @param private_data : python plugin's private data
- * @param[out] info The dimesions and types of input tensors
+ * @brief Construct a new Python subplugin instance
*/
-static int
-py_getInputDim (const GstTensorFilterProperties *prop, void **private_data, GstTensorsInfo *info)
+TensorFilterPython::TensorFilterPython () : core (nullptr)
{
- PYCore *core = static_cast<PYCore *> (*private_data);
- UNUSED (prop);
- g_return_val_if_fail (core && info, -EINVAL);
-
- if (core->getCbType () != CB_GETDIM) {
- return -ENOENT;
- }
-
- PyGILState_STATE gstate = PyGILState_Ensure ();
- int ret = core->getInputTensorDim (info);
- PyGILState_Release (gstate);
- return ret;
+ if (!Py_IsInitialized ())
+ throw std::runtime_error ("Python is not initialize.");
}
/**
- * @brief The optional callback for GstTensorFilterFramework
- * @param prop: property of tensor_filter instance
- * @param private_data : python plugin's private data
- * @param[out] info The dimesions and types of output tensors
+ * @brief Destructor of TensorFilterPython
*/
-static int
-py_getOutputDim (const GstTensorFilterProperties *prop, void **private_data,
- GstTensorsInfo *info)
+TensorFilterPython::~TensorFilterPython ()
{
- PYCore *core = static_cast<PYCore *> (*private_data);
- UNUSED (prop);
- g_return_val_if_fail (core && info, -EINVAL);
-
- if (core->getCbType () != CB_GETDIM) {
- return -ENOENT;
+ if (core != nullptr) {
+ PyGILState_STATE gstate = PyGILState_Ensure ();
+ delete core;
+ PyGILState_Release (gstate);
}
-
- PyGILState_STATE gstate = PyGILState_Ensure ();
- int ret = core->getOutputTensorDim (info);
- PyGILState_Release (gstate);
- return ret;
}
/**
- * @brief Free privateData and move on.
+ * @brief Method to get an empty object
*/
-static void
-py_close (const GstTensorFilterProperties *prop, void **private_data)
+tensor_filter_subplugin &
+TensorFilterPython::getEmptyInstance ()
{
- PYCore *core = static_cast<PYCore *> (*private_data);
- UNUSED (prop);
-
- g_return_if_fail (core != NULL);
- PyGILState_STATE gstate = PyGILState_Ensure ();
- delete core;
- PyGILState_Release (gstate);
-
- *private_data = NULL;
+ return *(new TensorFilterPython ());
}
/**
- * @brief Load python model
- * @param prop: property of tensor_filter instance
- * @param private_data : python plugin's private data
- * @return 0 if successfully loaded. 1 if skipped (already loaded).
- * -1 if the object construction is failed.
- * -2 if the object initialization if failed
+ * @brief Configure Python instance
*/
-static int
-py_loadScriptFile (const GstTensorFilterProperties *prop, void **private_data)
+void
+TensorFilterPython::configure_instance (const GstTensorFilterProperties *prop)
{
- PYCore *core;
const gchar *script_path;
if (prop->num_models != 1)
- return -1;
+ return;
/**
* prop->model_files[0] contains the path of a python script
* prop->custom contains its arguments seperated by ' '
*/
- core = static_cast<PYCore *> (*private_data);
script_path = prop->model_files[0];
- if (core != NULL) {
- if (g_strcmp0 (script_path, core->getScriptPath ()) == 0)
- return 1; /* skipped */
+ if (core != nullptr) {
+ if (g_strcmp0 (script_path, core->getScriptPath ()) == 0) {
+ return; /* skipped */
+ }
- py_close (prop, private_data);
+ PyGILState_STATE gstate = PyGILState_Ensure ();
+ delete core;
+ PyGILState_Release (gstate);
}
- /* init null */
- *private_data = NULL;
-
PyGILState_STATE gstate = PyGILState_Ensure ();
core = new PYCore (script_path, prop->custom_properties);
- if (core == NULL) {
+ if (core == nullptr) {
g_printerr ("Failed to allocate memory for filter subplugin: Python\n");
- PyGILState_Release (gstate);
- return -1;
+ goto done;
}
if (core->init (prop) != 0) {
delete core;
g_printerr ("failed to initailize the object: Python\n");
PyGILState_Release (gstate);
- return -2;
+ throw std::runtime_error ("Python is not initialize");
}
/** check methods in python script */
- if (core->getCbType () != CB_SETDIM && core->getCbType () != CB_GETDIM) {
+ if (core->getCbType () != cb_type::CB_SETDIM && core->getCbType () != cb_type::CB_GETDIM) {
delete core;
g_printerr ("Wrong callback type\n");
- PyGILState_Release (gstate);
- return -2;
+ goto done;
}
- PyGILState_Release (gstate);
- *private_data = core;
-
- return 0;
+done:
+ PyGILState_Release (gstate);
}
/**
- * @brief The open callback for GstTensorFilterFramework. Called before anything else
- * @param prop: property of tensor_filter instance
- * @param private_data : python plugin's private data
+ * @brief Invoke Python using input tensors
*/
-static int
-py_open (const GstTensorFilterProperties *prop, void **private_data)
+void
+TensorFilterPython::invoke (const GstTensorMemory *input, GstTensorMemory *output)
{
- if (!Py_IsInitialized ())
- throw std::runtime_error ("Python is not initialize.");
- /* Do not acquire GIL. py_loadScriptFile will do it */
- int status = py_loadScriptFile (prop, private_data);
+ PyGILState_STATE gstate = PyGILState_Ensure ();
+ core->run (input, output);
+ PyGILState_Release (gstate);
+}
- return status;
+/**
+ * @brief Get Python framework info.
+ */
+void
+TensorFilterPython::getFrameworkInfo (GstTensorFilterFrameworkInfo &info)
+{
+ info.name = name;
+ info.allow_in_place = FALSE;
+ /** @todo: support this to optimize performance later. */
+ info.allocate_in_invoke = TRUE;
+ info.run_without_model = FALSE;
+ info.verify_model_path = TRUE;
+ info.hw_list = hw_list;
+ info.num_hw = num_hw;
+ info.statistics = nullptr;
}
/**
- * @brief Check support of the backend
- * @param hw: backend to check support of
+ * @brief Get Python model info.
*/
-static int
-py_checkAvailability (accl_hw hw)
+int
+TensorFilterPython::getModelInfo (
+ model_info_ops ops, GstTensorsInfo &in_info, GstTensorsInfo &out_info)
{
- if (g_strv_contains (python_accl_support, get_accl_hw_str (hw)))
- return 0;
+ UNUSED (ops);
+ int ret = 0;
+ if (core->getCbType () == cb_type::CB_END) {
+ ml_loge ("cb type wrong");
+ return -ENOENT;
+ }
+
+ PyGILState_STATE gstate = PyGILState_Ensure ();
+
+ if (core->getCbType () == cb_type::CB_GETDIM) {
+ ret = core->getInputTensorDim (&in_info);
+ if (!ret)
+ ret = core->getOutputTensorDim (&out_info);
+ } else if (core->getCbType () == cb_type::CB_SETDIM) {
+ ret = core->setInputTensorDim (&in_info, &out_info);
+ }
- return -ENOENT;
+ PyGILState_Release (gstate);
+ return ret;
}
-static gchar filter_subplugin_python[] = "python3";
-
-static GstTensorFilterFramework NNS_support_python = { .version = GST_TENSOR_FILTER_FRAMEWORK_V0,
- .open = py_open,
- .close = py_close,
- { .v0 = {
- .name = filter_subplugin_python,
- .allow_in_place = FALSE, /** @todo: support this to optimize performance later. */
- .allocate_in_invoke = TRUE,
- .run_without_model = FALSE,
- .verify_model_path = TRUE,
- .statistics = nullptr,
- .invoke_NN = py_run,
- /** dimension-related callbacks are dynamically updated */
- .getInputDimension = py_getInputDim,
- .getOutputDimension = py_getOutputDim,
- .setInputDimension = py_setInputDim,
- .destroyNotify = py_destroyNotify,
- .reloadModel = nullptr,
- .handleEvent = nullptr,
- .checkAvailability = py_checkAvailability,
- .allocateInInvoke = nullptr,
- } } };
+/**
+ * @brief Method to handle the event
+ */
+int
+TensorFilterPython::eventHandler (event_ops ops, GstTensorFilterFrameworkEventData &data)
+{
+ if (ops == DESTROY_NOTIFY) {
+ if (core) {
+ PyGILState_STATE gstate = PyGILState_Ensure ();
+ core->freeOutputTensors (data.data);
+ PyGILState_Release (gstate);
+ }
+ }
+ return 0;
+}
/** @brief Initialize this object for tensor_filter subplugin runtime register */
void
-init_filter_py (void)
+TensorFilterPython::init_filter_py ()
{
/** Python should be initialized and finalized only once */
nnstreamer_python_init_refcnt ();
- nnstreamer_filter_probe (&NNS_support_python);
- nnstreamer_filter_set_custom_property_desc (filter_subplugin_python, "${GENERAL_STRING}",
- "There is no key-value pair defined by python3 subplugin. "
- "Provide arguments for the given python3 script.",
- NULL);
+ registered = tensor_filter_subplugin::register_subplugin<TensorFilterPython> ();
}
/** @brief Destruct the subplugin */
void
-fini_filter_py (void)
+TensorFilterPython::fini_filter_py ()
{
nnstreamer_python_status_check ();
nnstreamer_python_fini_refcnt ();
- nnstreamer_filter_exit (NNS_support_python.v0.name);
+
+ /* internal logic error */
+ assert (registered != nullptr);
+ tensor_filter_subplugin::unregister_subplugin (registered);
/**
* @todo Remove below lines after this issue is addressed.
*/
#if 0
/** Python should be initialized and finalized only once */
- if (Py_IsInitialized ())
- Py_Finalize ();
+ if (Py_IsInitialized ())
+ Py_Finalize ();
#endif
}
+
+/**
+ * @brief Subplugin initializer
+ */
+void
+init_filter_py ()
+{
+ TensorFilterPython::init_filter_py ();
+}
+
+/**
+ * @brief Subplugin finalizer
+ */
+void
+fini_filter_py ()
+{
+ TensorFilterPython::fini_filter_py ();
+}
+} /* namespace tensorfilter_python3 */
+} /* namespace nnstreamer */
projects / platform / upstream / nnstreamer.git / commitdiff