From e0d405034f799821a116e6553e628e25d657adb1 Mon Sep 17 00:00:00 2001 From: Johan Date: Wed, 26 Feb 2014 18:10:17 +0100 Subject: [PATCH] Add support for Python 3 Former-commit-id: b6aec954ba0e79ba5697ea8cc305eb9f7d29f332 --- CMakeLists.txt | 4 +- config/hyperion_x86.config.json | 4 +- dependencies/build/getoptPlusPlus/getoptpp.cc | 1 - include/effectengine/EffectEngine.h | 2 +- libsrc/effectengine/Effect.cpp | 86 +++++++++++++++---- libsrc/effectengine/Effect.h | 20 ++++- libsrc/effectengine/EffectEngine.cpp | 3 +- src/hyperion-remote/hyperion-remote.cpp | 18 ++-- 8 files changed, 101 insertions(+), 37 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 34aec49e..6547c450 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -41,8 +41,8 @@ include_directories(${CMAKE_SOURCE_DIR}/include) # Prefer static linking over dynamic #set(CMAKE_FIND_LIBRARY_SUFFIXES ".a;.so") -#set(CMAKE_BUILD_TYPE "Debug") -set(CMAKE_BUILD_TYPE "Release") +set(CMAKE_BUILD_TYPE "Debug") +#set(CMAKE_BUILD_TYPE "Release") # enable C++11 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x -Wall") diff --git a/config/hyperion_x86.config.json b/config/hyperion_x86.config.json index 071713aa..4abd64db 100644 --- a/config/hyperion_x86.config.json +++ b/config/hyperion_x86.config.json @@ -14,7 +14,7 @@ { "name" : "MyPi", "type" : "adalight", - "output" : "/dev/ttyUSB0", + "output" : "/dev/ttyUSB0", "rate" : 115200, "colorOrder" : "rgb" }, @@ -363,7 +363,7 @@ { "paths" : [ - "/opt/hyperion/effects" + "/home/dincs/projects/hyperion/effects" ] }, diff --git a/dependencies/build/getoptPlusPlus/getoptpp.cc b/dependencies/build/getoptPlusPlus/getoptpp.cc index e7b8b420..5444a325 100644 --- a/dependencies/build/getoptPlusPlus/getoptpp.cc +++ b/dependencies/build/getoptPlusPlus/getoptpp.cc @@ -280,7 +280,6 @@ void PresettableUniquelySwitchable::preset() { template<> PODParameter::PODParameter(char shortOption, const char *longOption, const char* description) : CommonParameter(shortOption, longOption, description) { - preset(); } diff --git a/include/effectengine/EffectEngine.h b/include/effectengine/EffectEngine.h index bea45576..c40732a1 100644 --- a/include/effectengine/EffectEngine.h +++ b/include/effectengine/EffectEngine.h @@ -55,5 +55,5 @@ private: std::list _activeEffects; - PyThreadState * _mainThreadState; + PyThreadState * _mainThreadState; }; diff --git a/libsrc/effectengine/Effect.cpp b/libsrc/effectengine/Effect.cpp index e09f8979..b19d40cc 100644 --- a/libsrc/effectengine/Effect.cpp +++ b/libsrc/effectengine/Effect.cpp @@ -19,9 +19,39 @@ PyMethodDef Effect::effectMethods[] = { {NULL, NULL, 0, NULL} }; +#if PY_MAJOR_VERSION >= 3 +// create the hyperion module +struct PyModuleDef Effect::moduleDef = { + PyModuleDef_HEAD_INIT, + "hyperion", /* m_name */ + "Hyperion module", /* m_doc */ + -1, /* m_size */ + Effect::effectMethods, /* m_methods */ + NULL, /* m_reload */ + NULL, /* m_traverse */ + NULL, /* m_clear */ + NULL, /* m_free */ +}; -Effect::Effect(int priority, int timeout, const std::string & script, const Json::Value & args) : +PyObject* Effect::PyInit_hyperion() +{ + return PyModule_Create(&moduleDef); +} +#else +void Effect::PyInit_hyperion() +{ + Py_InitModule("hyperion", effectMethods); +} +#endif + +void Effect::registerHyperionExtensionModule() +{ + PyImport_AppendInittab("hyperion", &PyInit_hyperion); +} + +Effect::Effect(PyThreadState * mainThreadState, int priority, int timeout, const std::string & script, const Json::Value & args) : QThread(), + _mainThreadState(mainThreadState), _priority(priority), _timeout(timeout), _script(script), @@ -44,20 +74,26 @@ Effect::~Effect() void Effect::run() { + // switch to the main thread state and acquire the GIL + PyEval_RestoreThread(_mainThreadState); + // Initialize a new thread state - PyEval_AcquireLock(); // Get the GIL - _interpreterThreadState = Py_NewInterpreter(); + _interpreterThreadState = Py_NewInterpreter(); - // add methods extra builtin methods to the interpreter - PyObject * thisCapsule = PyCapsule_New(this, nullptr, nullptr); - PyObject * module = Py_InitModule4("hyperion", effectMethods, nullptr, thisCapsule, PYTHON_API_VERSION); + // import the buildtin Hyperion module + PyObject * module = PyImport_ImportModule("hyperion"); - // add ledCount variable to the interpreter - PyObject_SetAttrString(module, "ledCount", Py_BuildValue("i", _imageProcessor->getLedCount())); + // add a capsule containing 'this' to the module to be able to retrieve the effect from the callback function + PyObject_SetAttrString(module, "__effectObj", PyCapsule_New(this, nullptr, nullptr)); - // add a args variable to the interpreter - PyObject_SetAttrString(module, "args", json2python(_args)); - //PyObject_SetAttrString(module, "args", Py_BuildValue("s", _args.c_str())); + // add ledCount variable to the interpreter + PyObject_SetAttrString(module, "ledCount", Py_BuildValue("i", _imageProcessor->getLedCount())); + + // add a args variable to the interpreter + PyObject_SetAttrString(module, "args", json2python(_args)); + + // decref the module + Py_XDECREF(module); // Set the end time if applicable if (_timeout > 0) @@ -144,7 +180,7 @@ PyObject *Effect::json2python(const Json::Value &json) const PyObject* Effect::wrapSetColor(PyObject *self, PyObject *args) { // get the effect - Effect * effect = getEffect(self); + Effect * effect = getEffect(); // check if we have aborted already if (effect->_abortRequested) @@ -229,7 +265,7 @@ PyObject* Effect::wrapSetColor(PyObject *self, PyObject *args) PyObject* Effect::wrapSetImage(PyObject *self, PyObject *args) { // get the effect - Effect * effect = getEffect(self); + Effect * effect = getEffect(); // check if we have aborted already if (effect->_abortRequested) @@ -292,7 +328,7 @@ PyObject* Effect::wrapSetImage(PyObject *self, PyObject *args) PyObject* Effect::wrapAbort(PyObject *self, PyObject *) { - Effect * effect = getEffect(self); + Effect * effect = getEffect(); // Test if the effect has reached it end time if (effect->_timeout > 0 && QDateTime::currentMSecsSinceEpoch() > effect->_endTime) @@ -303,8 +339,24 @@ PyObject* Effect::wrapAbort(PyObject *self, PyObject *) return Py_BuildValue("i", effect->_abortRequested ? 1 : 0); } -Effect * Effect::getEffect(PyObject *self) +Effect * Effect::getEffect() { - // Get the effect from the capsule in the self pointer - return reinterpret_cast(PyCapsule_GetPointer(self, nullptr)); + // extract the module from the runtime + PyObject * module = PyObject_GetAttrString(PyImport_AddModule("__main__"), "hyperion"); + + if (PyModule_Check(module)) + { + // retrieve the capsule with the effect + PyObject * effectCapsule = PyObject_GetAttrString(module, "__effectObj"); + + if (PyCapsule_CheckExact(effectCapsule)) + { + // Get the effect from the capsule + return reinterpret_cast(PyCapsule_GetPointer(effectCapsule, nullptr)); + } + } + + // something is wrong + std::cerr << "Unable to retrieve the effect object from the Python runtime" << std::endl; + return nullptr; } diff --git a/libsrc/effectengine/Effect.h b/libsrc/effectengine/Effect.h index 62c2ed75..8540d507 100644 --- a/libsrc/effectengine/Effect.h +++ b/libsrc/effectengine/Effect.h @@ -14,7 +14,7 @@ class Effect : public QThread Q_OBJECT public: - Effect(int priority, int timeout, const std::string & script, const Json::Value & args = Json::Value()); + Effect(PyThreadState * mainThreadState, int priority, int timeout, const std::string & script, const Json::Value & args = Json::Value()); virtual ~Effect(); virtual void run(); @@ -23,6 +23,9 @@ public: bool isAbortRequested() const; + /// This function registers the extension module in Python + static void registerHyperionExtensionModule(); + public slots: void abort(); @@ -38,13 +41,22 @@ private: PyObject * json2python(const Json::Value & json) const; // Wrapper methods for Python interpreter extra buildin methods - static PyMethodDef effectMethods[]; - static PyObject* wrapSetColor(PyObject *self, PyObject *args); + static PyMethodDef effectMethods[]; + static PyObject* wrapSetColor(PyObject *self, PyObject *args); static PyObject* wrapSetImage(PyObject *self, PyObject *args); static PyObject* wrapAbort(PyObject *self, PyObject *args); - static Effect * getEffect(PyObject *self); + static Effect * getEffect(); + +#if PY_MAJOR_VERSION >= 3 + static struct PyModuleDef moduleDef; + static PyObject* PyInit_hyperion(); +#else + static void PyInit_hyperion(); +#endif private: + PyThreadState * _mainThreadState; + const int _priority; const int _timeout; diff --git a/libsrc/effectengine/EffectEngine.cpp b/libsrc/effectengine/EffectEngine.cpp index a343ae4e..f7057e21 100644 --- a/libsrc/effectengine/EffectEngine.cpp +++ b/libsrc/effectengine/EffectEngine.cpp @@ -54,6 +54,7 @@ EffectEngine::EffectEngine(Hyperion * hyperion, const Json::Value & jsonEffectCo // initialize the python interpreter std::cout << "Initializing Python interpreter" << std::endl; + Effect::registerHyperionExtensionModule(); Py_InitializeEx(0); PyEval_InitThreads(); // Create the GIL _mainThreadState = PyEval_SaveThread(); @@ -151,7 +152,7 @@ int EffectEngine::runEffectScript(const std::string &script, const Json::Value & channelCleared(priority); // create the effect - Effect * effect = new Effect(priority, timeout, script, args); + Effect * effect = new Effect(_mainThreadState, priority, timeout, script, args); connect(effect, SIGNAL(setColors(int,std::vector,int,bool)), _hyperion, SLOT(setColors(int,std::vector,int,bool)), Qt::QueuedConnection); connect(effect, SIGNAL(effectFinished(Effect*)), this, SLOT(effectFinished(Effect*))); _activeEffects.push_back(effect); diff --git a/src/hyperion-remote/hyperion-remote.cpp b/src/hyperion-remote/hyperion-remote.cpp index 4fdee922..da9d4b00 100644 --- a/src/hyperion-remote/hyperion-remote.cpp +++ b/src/hyperion-remote/hyperion-remote.cpp @@ -48,8 +48,8 @@ int main(int argc, char * argv[]) IntParameter & argDuration = parameters.add ('d', "duration" , "Specify how long the leds should be switched on in millseconds [default: infinity]"); ColorParameter & argColor = parameters.add ('c', "color" , "Set all leds to a constant color (either RRGGBB hex value or a color name. The color may be repeated multiple time like: RRGGBBRRGGBB)"); ImageParameter & argImage = parameters.add ('i', "image" , "Set the leds to the colors according to the given image file"); - StringParameter & argEffect = parameters.add ('e', "effect" , "Enable the effect with the given name"); - StringParameter & argEffectArgs = parameters.add (0x0, "effectArgs", "Arguments to use in combination with the specified effect. Should be a Json object string."); + StringParameter & argEffect = parameters.add ('e', "effect" , "Enable the effect with the given name"); + StringParameter & argEffectArgs = parameters.add (0x0, "effectArgs", "Arguments to use in combination with the specified effect. Should be a Json object string."); SwitchParameter<> & argServerInfo = parameters.add >('l', "list" , "List server info"); SwitchParameter<> & argClear = parameters.add >('x', "clear" , "Clear data for the priority channel provided by the -p option"); SwitchParameter<> & argClearAll = parameters.add >(0x0, "clearall" , "Clear data for all active priority channels"); @@ -83,13 +83,13 @@ int main(int argc, char * argv[]) bool colorTransform = argSaturation.isSet() || argValue.isSet() || argThreshold.isSet() || argGamma.isSet() || argBlacklevel.isSet() || argWhitelevel.isSet(); // check that exactly one command was given - int commandCount = count({argColor.isSet(), argImage.isSet(), argEffect.isSet(), argServerInfo.isSet(), argClear.isSet(), argClearAll.isSet(), colorTransform}); + int commandCount = count({argColor.isSet(), argImage.isSet(), argEffect.isSet(), argServerInfo.isSet(), argClear.isSet(), argClearAll.isSet(), colorTransform}); if (commandCount != 1) { std::cerr << (commandCount == 0 ? "No command found." : "Multiple commands found.") << " Provide exactly one of the following options:" << std::endl; std::cerr << " " << argColor.usageLine() << std::endl; std::cerr << " " << argImage.usageLine() << std::endl; - std::cerr << " " << argEffect.usageLine() << std::endl; + std::cerr << " " << argEffect.usageLine() << std::endl; std::cerr << " " << argServerInfo.usageLine() << std::endl; std::cerr << " " << argClear.usageLine() << std::endl; std::cerr << " " << argClearAll.usageLine() << std::endl; @@ -116,11 +116,11 @@ int main(int argc, char * argv[]) { connection.setImage(argImage.getValue(), argPriority.getValue(), argDuration.getValue()); } - else if (argEffect.isSet()) - { - connection.setEffect(argEffect.getValue(), argEffectArgs.getValue(), argPriority.getValue(), argDuration.getValue()); - } - else if (argServerInfo.isSet()) + else if (argEffect.isSet()) + { + connection.setEffect(argEffect.getValue(), argEffectArgs.getValue(), argPriority.getValue(), argDuration.getValue()); + } + else if (argServerInfo.isSet()) { QString info = connection.getServerInfo(); std::cout << "Server info:\n" << info.toStdString() << std::endl;