init

2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,143 @@
+#pragma once
+
+#if defined TARGET_HAS_ThirdPartyPython3
+
+#include <Python.h>
+
+#if defined(PY_MAJOR_VERSION) && (PY_MAJOR_VERSION == 3)
+
+#include "../ovp_defines.h"
+#include <openvibe/ov_all.h>
+#include <toolkit/ovtk_all.h>
+
+#include <string>
+#include <vector>
+//#include <map>
+
+namespace OpenViBE {
+namespace Plugins {
+namespace Python {
+class CBoxAlgorithmPython3 final : virtual public Toolkit::TBoxAlgorithm<IBoxAlgorithm>
+{
+public:
+	void release() override { delete this; }
+
+	uint64_t getClockFrequency() override { return m_clockFrequency << 32; }
+	bool initialize() override;
+	bool uninitialize() override;
+	bool processClock(Kernel::CMessageClock& msg) override;
+	bool processInput(const size_t index) override;
+	bool process() override;
+
+	_IsDerivedFromClass_Final_(Toolkit::TBoxAlgorithm<IBoxAlgorithm>, OVP_ClassId_BoxAlgorithm_Python3)
+
+protected:
+
+	uint64_t m_clockFrequency = 0;
+	CString m_scriptFilename;
+
+	std::vector<Toolkit::TDecoder<CBoxAlgorithmPython3>*> m_decoders;
+	std::vector<Toolkit::TEncoder<CBoxAlgorithmPython3>*> m_encoders;
+
+	//std::map<char,PyObject *> m_PyObjectMap;
+	PyObject *m_box            = nullptr, *m_boxInput      = nullptr, *m_boxOutput  = nullptr, *m_boxSetting      = nullptr,
+			 *m_boxCurrentTime = nullptr, *m_boxInitialize = nullptr, *m_boxProcess = nullptr, *m_boxUninitialize = nullptr;
+	bool m_initializeSucceeded = false;
+
+
+	bool logSysStd(const bool out);
+	bool logSysStdout() { return logSysStd(true); }
+	bool logSysStderr() { return logSysStd(false); }
+	void buildPythonSettings();
+
+	bool initializePythonSafely();
+	//bool clearPyObjectMap();
+	bool transferStreamedMatrixInputChunksToPython(const size_t index);
+	bool transferStreamedMatrixOutputChunksFromPython(const size_t index);
+	bool transferSignalInputChunksToPython(const size_t index);
+	bool transferSignalOutputChunksFromPython(const size_t index);
+	bool transferStimulationInputChunksToPython(const size_t index);
+	bool transferStimulationOutputChunksFromPython(const size_t index);
+
+	static bool m_isPythonInitialized;
+
+	// These are all borrowed references in python v3.7. Do not free them.
+	static PyObject *m_mainModule, *m_mainDictionnary;
+	static PyObject *m_matrixHeader, *m_matrixBuffer, *m_matrixEnd;
+	static PyObject *m_signalHeader, *m_signalBuffer, *m_signalEnd;
+	static PyObject *m_stimulationHeader, *m_stimulation, *m_stimulationSet, *m_stimulationEnd;
+	static PyObject* m_buffer;
+	static PyObject* m_execFileFunction;
+	static PyObject *m_stdout, *m_stderr;
+};
+
+class CBoxAlgorithmPython3Listener final : public Toolkit::TBoxListener<IBoxListener>
+{
+public:
+	bool onInputAdded(Kernel::IBox& box, const size_t index) override
+	{
+		box.setInputType(index, OV_TypeId_StreamedMatrix);
+		return true;
+	}
+
+	bool onOutputAdded(Kernel::IBox& box, const size_t index) override
+	{
+		box.setOutputType(index, OV_TypeId_StreamedMatrix);
+		return true;
+	}
+
+	_IsDerivedFromClass_Final_(Toolkit::TBoxListener<IBoxListener>, CIdentifier::undefined())
+};
+
+class CBoxAlgorithmPython3Desc final : virtual public IBoxAlgorithmDesc
+{
+public:
+
+	void release() override { }
+
+	CString getName() const override { return CString("Python 3 scripting"); }
+	CString getAuthorName() const override { return CString("Aurelien Van Langhenhove and Laurent George"); }
+	CString getAuthorCompanyName() const override { return CString("CICIT Garches, Inria"); }
+	CString getShortDescription() const override { return CString("This box executes a python script."); }
+	CString getDetailedDescription() const override { return CString(""); }
+	CString getCategory() const override { return CString("Scripting"); }
+	CString getVersion() const override { return CString("0.1"); }
+	CString getStockItemName() const override { return CString("gtk-convert"); }
+
+	CIdentifier getCreatedClass() const override { return OVP_ClassId_BoxAlgorithm_Python3; }
+	IPluginObject* create() override { return new CBoxAlgorithmPython3; }
+	IBoxListener* createBoxListener() const override { return new CBoxAlgorithmPython3Listener; }
+	void releaseBoxListener(IBoxListener* listener) const override { delete listener; }
+
+	bool getBoxPrototype(Kernel::IBoxProto& prototype) const override
+	{
+		prototype.addSetting("Clock frequency (Hz)", OV_TypeId_Integer, "64");
+		prototype.addSetting("Script", OV_TypeId_Script, "");
+
+		prototype.addFlag(Kernel::BoxFlag_CanAddInput);
+		prototype.addFlag(Kernel::BoxFlag_CanModifyInput);
+		prototype.addFlag(Kernel::BoxFlag_CanAddOutput);
+		prototype.addFlag(Kernel::BoxFlag_CanModifyOutput);
+		prototype.addFlag(Kernel::BoxFlag_CanAddSetting);
+		prototype.addFlag(Kernel::BoxFlag_CanModifySetting);
+
+		prototype.addInputSupport(OV_TypeId_Signal);
+		prototype.addInputSupport(OV_TypeId_Stimulations);
+		prototype.addInputSupport(OV_TypeId_StreamedMatrix);
+
+		prototype.addOutputSupport(OV_TypeId_Signal);
+		prototype.addOutputSupport(OV_TypeId_Stimulations);
+		prototype.addOutputSupport(OV_TypeId_StreamedMatrix);
+
+		return true;
+	}
+
+	_IsDerivedFromClass_Final_(IBoxAlgorithmDesc, OVP_ClassId_BoxAlgorithm_Python3Desc)
+};
+}  // namespace Python
+}  // namespace Plugins
+}  // namespace OpenViBE
+
+#endif // #if defined(PY_MAJOR_VERSION) && (PY_MAJOR_VERSION == 3)
+
+#endif // TARGET_HAS_ThirdPartyPython3
@@ -0,0 +1,6 @@
+#pragma once
+
+// Boxes
+//---------------------------------------------------------------------------------------------------
+#define OVP_ClassId_BoxAlgorithm_Python3        			OpenViBE::CIdentifier(0x5DC4F669, 0xD3FD4D63)
+#define OVP_ClassId_BoxAlgorithm_Python3Desc    			OpenViBE::CIdentifier(0x404B6FFD, 0x12BDD423)
@@ -0,0 +1,106 @@
+#if defined TARGET_HAS_ThirdPartyPython3 && !(defined(WIN32) && defined(TARGET_BUILDTYPE_Debug))
+// Windows debug build doesn't typically link as most people don't have the python debug library.
+
+#include "box-algorithms/ovpCBoxAlgorithmPython3.h"
+
+#if defined(PY_MAJOR_VERSION) && (PY_MAJOR_VERSION == 3)
+
+#ifdef TARGET_OS_Windows
+#include "windows.h"
+#endif
+
+#include <string>
+#include <iostream>
+
+//-------------------------------------------------------------------------------------------------
+class CPython3Initializer
+{
+public:
+	CPython3Initializer();
+	~CPython3Initializer();
+	bool isPython3Available() const { return m_pythonAvailable; }
+private:
+#ifdef TARGET_OS_Windows
+	static bool checkPython3Path();
+#endif
+	// PyThreadState *m_pMainPyThreadState;
+	bool m_pythonAvailable;
+};
+
+#ifdef TARGET_OS_Windows
+bool CPython3Initializer::checkPython3Path()
+{
+	std::wstring ws(Py_GetPath());
+	std::string path(ws.begin(), ws.end());
+
+	size_t found = path.find_first_of(';');
+	while (found != std::string::npos)
+	{
+		if (found > 0)
+		{
+			std::string filename = path.substr(0, found);
+			const bool exists    = (_access(filename.c_str(), 0) == 0);
+			if (exists) { return true; }
+		}
+		path  = path.substr(found + 1);
+		found = path.find_first_of(';');
+	}
+
+	std::cout << "Python directory not found. You probably have a corrupted python installation!" << std::endl;
+	std::cout << "The tried path from Py_GetPath() was [" << Py_GetPath() << "]\n";
+
+	return false;
+}
+#endif
+
+CPython3Initializer::CPython3Initializer() : m_pythonAvailable(false)
+{
+#ifdef TARGET_OS_Windows
+	__try
+	{
+		// We do not care about the last file, since it is the OpenViBE runtime path
+		if (!Py_IsInitialized() && checkPython3Path())
+		{
+			Py_Initialize();
+			m_pythonAvailable = true;
+		}
+	}
+	__except (EXCEPTION_EXECUTE_HANDLER) { }
+#else
+		if (!Py_IsInitialized())
+		{
+			Py_Initialize();
+			m_pythonAvailable = true;
+		}
+#endif
+}
+
+CPython3Initializer::~CPython3Initializer()
+{
+	if (m_pythonAvailable)
+	{
+		m_pythonAvailable = false;
+		Py_Finalize();
+	}
+}
+//-------------------------------------------------------------------------------------------------
+
+//-------------------------------------------------------------------------------------------------
+namespace OpenViBE {
+namespace Plugins {
+namespace Python {
+
+OVP_Declare_Begin()
+	static CPython3Initializer python3Init;
+	if (python3Init.isPython3Available()) { OVP_Declare_New(CBoxAlgorithmPython3Desc); }
+OVP_Declare_End()
+
+}  // namespace Python
+}  // namespace Plugins
+}  // namespace OpenViBE
+//-------------------------------------------------------------------------------------------------
+
+#else
+#pragma message ("WARNING: Python 3.x headers are required to build the Python plugin, different includes found, skipped")
+#endif // #if defined(PY_MAJOR_VERSION) && (PY_MAJOR_VERSION == 2)
+#endif // TARGET_HAS_ThirdPartyPython3