From 9719d2e74c7a5f23f353e6af89f4a20306601e64 Mon Sep 17 00:00:00 2001 From: Joao Carreira Date: Sat, 18 Sep 2021 16:26:53 +0100 Subject: [PATCH] Refactor modules ownership --- app/CalypAppModuleIf.cpp | 72 +++++++++++++++-------------- app/CalypAppModuleIf.h | 22 ++++----- app/ModulesHandle.cpp | 52 ++++++++++----------- app/ModulesHandle.h | 1 - app/VideoSubWindow.cpp | 82 +++++++++++++++++++++++----------- app/VideoSubWindow.h | 21 +++++---- app/docks/ModuleHandleDock.cpp | 9 +--- app/docks/ModuleHandleDock.h | 3 +- 8 files changed, 146 insertions(+), 116 deletions(-) diff --git a/app/CalypAppModuleIf.cpp b/app/CalypAppModuleIf.cpp index ec61159..16bd0c8 100644 --- a/app/CalypAppModuleIf.cpp +++ b/app/CalypAppModuleIf.cpp @@ -28,6 +28,7 @@ #include #include +#include "ModuleHandleDock.h" #include "VideoSubWindow.h" #include "lib/CalypFrame.h" #include "lib/CalypStream.h" @@ -36,6 +37,9 @@ CalypAppModuleIf::CalypAppModuleIf( QObject* parent, QAction* action, CalypModul : m_pcModuleAction( action ), m_pcModule( std ::move( module ) ) { setParent( parent ); +#ifdef CALYP_THREADED_MODULES + setObjectName( m_pcModule->m_pchModuleName ); +#endif m_frameList.reserve( m_pcModule->m_uiNumberOfFrames ); m_frameListPtr.reserve( m_pcModule->m_uiNumberOfFrames ); m_pcSubWindow.resize( m_pcModule->m_uiNumberOfFrames, nullptr ); @@ -43,28 +47,29 @@ CalypAppModuleIf::CalypAppModuleIf( QObject* parent, QAction* action, CalypModul CalypAppModuleIf::~CalypAppModuleIf() { - while( m_bIsRunning ) - { - } + QMutexLocker locker( &m_Mutex ); + if( m_pcModuleDock ) + { + auto* ptr = m_pcModuleDock; + m_pcModuleDock = NULL; + ptr->close(); + } + if( m_pcDisplaySubWindow ) + { + auto* ptr = m_pcDisplaySubWindow; + m_pcDisplaySubWindow = NULL; + ptr->closeSubWindow(); + } if( m_pcDockWidget ) { m_pcDockWidget->close(); } - - for( auto& window : m_pcSubWindow ) - { - if( window != nullptr ) - window->disableModule( this ); - window = nullptr; - } if( m_pcModule ) { m_pcModule->destroy(); m_pcModule = nullptr; } - - //assert( m_pcProcessedFrame.use_count() == 1 ); } void CalypAppModuleIf::update( bool isPlaying ) @@ -96,6 +101,11 @@ bool CalypAppModuleIf::isRunning() #endif } +void CalypAppModuleIf::run() +{ + process( true ); +} + bool CalypAppModuleIf::apply( bool isPlaying, bool disableThreads ) { bool bRet = false; @@ -129,7 +139,7 @@ bool CalypAppModuleIf::apply( bool isPlaying, bool disableThreads ) else #endif { - run(); + process( false ); show(); } @@ -146,11 +156,13 @@ bool CalypAppModuleIf::apply( bool isPlaying, bool disableThreads ) return bRet; } -void CalypAppModuleIf::run() +void CalypAppModuleIf::process( bool postEvent ) { - m_bIsRunning = true; m_bSuccess = false; + if( m_frameList.empty() ) + return; + QMutexLocker locker( &m_Mutex ); m_frameListPtr.clear(); @@ -188,13 +200,12 @@ void CalypAppModuleIf::run() { return; } -#ifdef CALYP_THREADED_MODULES - EventData* eventData = new EventData( m_bSuccess, this ); - if( parent() ) - QCoreApplication::postEvent( parent(), eventData ); -#endif m_bSuccess = true; - m_bIsRunning = false; + if( postEvent ) + { + EventData* eventData = new EventData( m_bSuccess, this ); + QCoreApplication::postEvent( parent(), eventData ); + } return; } @@ -220,24 +231,19 @@ void CalypAppModuleIf::show() } } -void CalypAppModuleIf::destroy() +void CalypAppModuleIf::disable() { QApplication::setOverrideCursor( Qt::WaitCursor ); QMutexLocker locker( &m_Mutex ); - QApplication::restoreOverrideCursor(); m_frameList.clear(); m_frameListPtr.clear(); - if( m_pcModuleDock ) + while( m_pcSubWindow.size() > 0 ) { - auto* ptr = m_pcModuleDock; - m_pcModuleDock = NULL; - ptr->close(); - } - if( m_pcDisplaySubWindow ) - { - auto* ptr = m_pcDisplaySubWindow; - m_pcDisplaySubWindow = NULL; - ptr->closeSubWindow(); + auto window = m_pcSubWindow.back(); + m_pcSubWindow.erase( m_pcSubWindow.end() - 1 ); + if( window != nullptr ) + window->disableModule( this ); } + QApplication::restoreOverrideCursor(); } diff --git a/app/CalypAppModuleIf.h b/app/CalypAppModuleIf.h index 801f39c..d0e4c7e 100644 --- a/app/CalypAppModuleIf.h +++ b/app/CalypAppModuleIf.h @@ -26,6 +26,7 @@ #define __CALYPAPPMODULESIF_H__ #include +#include #include #include #include @@ -52,12 +53,13 @@ class CalypFrame; class VideoSubWindow; -class CalypAppModuleIf +class CalypAppModuleIf : std::enable_shared_from_this, #ifdef CALYP_THREADED_MODULES - : public QThread + public QThread #else - : public QObject + public QObject #endif + { friend class ModulesHandle; friend class ModuleHandleDock; @@ -68,13 +70,11 @@ public: { public: EventData( bool success, CalypAppModuleIf* module ) - : QEvent( QEvent::User ) + : QEvent( QEvent::User ), m_bSuccess{ success }, m_pcModule{ module } { - m_bSuccess = success; - m_pcModule = module; } bool m_bSuccess; - CalypAppModuleIf* m_pcModule; + QPointer m_pcModule; }; CalypAppModuleIf( QObject* parent, QAction* action, CalypModulePtr&& module ); @@ -87,16 +87,16 @@ public: ClpString moduleInfo() { return m_pcModule->moduleInfo(); } void update( bool isPlaying ); bool apply( bool isPlaying = false, bool disableThreads = false ); + void process( bool postEvent ); void setPlaying( bool isPlaying ); bool isRunning(); void show(); - void destroy(); + void disable(); protected: virtual void run(); private: - bool m_bIsRunning{ false }; bool m_bSuccess{ false }; QAction* m_pcModuleAction{ nullptr }; @@ -104,8 +104,8 @@ private: std::vector m_pcSubWindow; + // The module owns the related widgets VideoSubWindow* m_pcDisplaySubWindow{ nullptr }; - QDockWidget* m_pcDockWidget{ nullptr }; ModuleHandleDock* m_pcModuleDock{ nullptr }; @@ -118,7 +118,7 @@ private: double m_dMeasurementResult{ 0 }; #ifdef CALYP_THREADED_MODULES - QMutex m_Mutex; + QRecursiveMutex m_Mutex; #endif }; diff --git a/app/ModulesHandle.cpp b/app/ModulesHandle.cpp index 3904a2d..c42eaba 100644 --- a/app/ModulesHandle.cpp +++ b/app/ModulesHandle.cpp @@ -180,7 +180,7 @@ void ModulesHandle::updateMenus() } m_arrayActions[LOAD_EXTERNAL_ACT]->setEnabled( true ); m_arrayActions[FORCE_NEW_WINDOW_ACT]->setEnabled( hasSubWindow ); - m_arrayActions[DISABLE_ALL_ACT]->setEnabled( m_pcCalypAppModuleIfList.size() > 0 ); + m_arrayActions[DISABLE_ALL_ACT]->setEnabled( true ); if( pcSubWindow ) { @@ -276,7 +276,7 @@ void ModulesHandle::activateModule() QString ModuleIfName = pcAction->data().toString(); auto pcCurrModuleIf = CalypModulesFactory::Get()->CreateModule( ModuleIfName.toLocal8Bit().constData() ); - auto pcCurrAppModuleIf = std::make_unique( this, pcAction, std::move( pcCurrModuleIf ) ); + auto pcCurrAppModuleIf = std::make_shared( this, pcAction, std::move( pcCurrModuleIf ) ); QList videoSubWindowList; int numberOfFrames = pcCurrAppModuleIf->m_pcModule->m_uiNumberOfFrames; @@ -377,7 +377,7 @@ void ModulesHandle::activateModule() { if( ( pcCurrAppModuleIf->m_pcModule->m_uiModuleRequirements & CLP_MODULE_REQUIRES_NEW_WINDOW ) || bShowModulesNewWindow ) { - pcModuleSubWindow = new VideoSubWindow( VideoSubWindow::MODULE_SUBWINDOW ); + pcModuleSubWindow = new VideoSubWindow( VideoSubWindow::MODULE_SUBWINDOW, pcCurrAppModuleIf.get() ); windowName.append( QStringLiteral( "Module " ) ); windowName.append( pcCurrAppModuleIf->m_pcModule->m_pchModuleLongName ); pcCurrAppModuleIf->m_pcDisplaySubWindow = pcModuleSubWindow; @@ -406,7 +406,7 @@ void ModulesHandle::activateModule() for( int i = 0; i < videoSubWindowList.size(); i++ ) { - pcCurrAppModuleIf->m_pcSubWindow[i]->associateModule( pcCurrAppModuleIf.get() ); + pcCurrAppModuleIf->m_pcSubWindow[i]->associateModule( pcCurrAppModuleIf ); } // Create Module @@ -453,47 +453,38 @@ void ModulesHandle::activateModule() } // Change ownership of the module - if( !pcCurrAppModuleIf->m_pcDisplaySubWindow && !pcCurrAppModuleIf->m_pcModuleDock ) - { - pcCurrAppModuleIf->m_pcSubWindow[0]->enableModule( std::move( pcCurrAppModuleIf ) ); - } - else if( pcCurrAppModuleIf->m_pcDisplaySubWindow ) - { - pcCurrAppModuleIf->m_pcDisplaySubWindow->enableModule( std::move( pcCurrAppModuleIf ) ); - } - else if( pcCurrAppModuleIf->m_pcModuleDock ) - { - pcCurrAppModuleIf->m_pcModuleDock->enableModule( std::move( pcCurrAppModuleIf ) ); - } + // if( !pcCurrAppModuleIf->m_pcDisplaySubWindow && !pcCurrAppModuleIf->m_pcModuleDock ) + // { + // pcCurrAppModuleIf->m_pcSubWindow[0]->enableModule( pcCurrAppModuleIf ); + // } + // else if( pcCurrAppModuleIf->m_pcDisplaySubWindow ) + // { + // pcCurrAppModuleIf->m_pcDisplaySubWindow->enableModule( pcCurrAppModuleIf ); + // } emit changed(); } -void ModulesHandle::destroyModuleIf( CalypAppModuleIf* pcCurrModuleIf ) -{ - if( pcCurrModuleIf ) - { - pcCurrModuleIf->destroy(); - } -} - void ModulesHandle::destroyWindowModules() { VideoSubWindow* pcVideoSubWindow = qobject_cast( m_pcMainWindowManager->activeSubWindow() ); if( pcVideoSubWindow ) { - pcVideoSubWindow->disableModule(); + pcVideoSubWindow->disableAllModules(); emit changed(); } } void ModulesHandle::destroyAllModulesIf() { - for( int i = 0; i < m_pcCalypAppModuleIfList.size(); i++ ) + bool emit_changed = false; + QList windowsList = m_pcMainWindowManager->findSubWindow( SubWindowAbstract::VIDEO_SUBWINDOW ); + for( auto window : windowsList ) { - destroyModuleIf( m_pcCalypAppModuleIfList.at( i ) ); + emit_changed |= qobject_cast( window )->disableAllModules(); } - emit changed(); + if( emit_changed ) + emit changed(); } void ModulesHandle::applyModuleIf( QList pcCurrModuleIfList, bool isPlaying, bool disableThreads ) @@ -610,9 +601,14 @@ void ModulesHandle::customEvent( QEvent* event ) { return; } + CalypAppModuleIf::EventData* eventData = (CalypAppModuleIf::EventData*)event; if( eventData->m_bSuccess ) { + event->accept(); + // The module could be freed by the time the event is processed + if( eventData->m_pcModule.isNull() ) + return; eventData->m_pcModule->show(); } } diff --git a/app/ModulesHandle.h b/app/ModulesHandle.h index a934c9c..d061d7d 100644 --- a/app/ModulesHandle.h +++ b/app/ModulesHandle.h @@ -55,7 +55,6 @@ public: void readSettings(); void writeSettings(); - static void destroyModuleIf( CalypAppModuleIf* pcCurrModuleIf ); static void applyModuleIf( QList pcCurrModuleIfList, bool isPlaying = false, bool disableThreads = false ); diff --git a/app/VideoSubWindow.cpp b/app/VideoSubWindow.cpp index 7fd8017..c457594 100644 --- a/app/VideoSubWindow.cpp +++ b/app/VideoSubWindow.cpp @@ -106,7 +106,6 @@ public: m_cCenterTextFont.setPointSize( 12 ); m_pcRefreshTimer = new QTimer; m_pcRefreshTimer->setSingleShot( true ); - connect( m_pcRefreshTimer, SIGNAL( timeout() ), this, SLOT( update() ) ); } void setInformationTopLeft( const QStringList& textLines ) { @@ -119,6 +118,7 @@ public: void setBusyWindow( bool bFlag ) { m_bBusyWindow = bFlag; + // Do not show the refresh screen if it takes less than 500 ms m_pcRefreshTimer->start( 500 ); } @@ -136,12 +136,12 @@ protected: topLeftCorner += QPoint( 0, 15 ); } } - if( m_bBusyWindow ) - { - painter.setFont( m_cCenterTextFont ); - painter.drawText( rect(), Qt::AlignHCenter | Qt::AlignVCenter, QStringLiteral( "Refreshing..." ) ); - painter.fillRect( rect(), QBrush( QColor::fromRgb( 255, 255, 255, 50 ), Qt::SolidPattern ) ); - } + // if( m_bBusyWindow && !m_pcRefreshTimer->isActive() ) + // { + // painter.setFont( m_cCenterTextFont ); + // painter.drawText( rect(), Qt::AlignHCenter | Qt::AlignVCenter, QStringLiteral( "Refreshing..." ) ); + // painter.fillRect( rect(), QBrush( QColor::fromRgb( 255, 255, 255, 50 ), Qt::SolidPattern ) ); + // } } }; @@ -194,14 +194,15 @@ VideoSubWindow::VideoSubWindow( enum VideoSubWindowCategories category, QWidget* m_pcVideoInfo = new VideoInformation( this ); } +VideoSubWindow::VideoSubWindow( enum VideoSubWindowCategories category, CalypAppModuleIf* displayModule, QWidget* parent ) + : VideoSubWindow( category, parent ) +{ + m_pcCurrentDisplayModule = displayModule; +} + VideoSubWindow::~VideoSubWindow() { - std::vector tmpModules = m_associatedModules; - m_associatedModules.clear(); - for( auto module : tmpModules ) - { - module->destroy(); - } + m_pcCurrFrameAsset = nullptr; if( m_pcResourceManager ) m_pcResourceManager->removeResource( m_uiResourceId ); delete m_pcUpdateTimer; @@ -214,6 +215,16 @@ VideoSubWindow::~VideoSubWindow() void VideoSubWindow::closeEvent( QCloseEvent* event ) { //stop(); + auto tmpModules = m_associatedModules; + m_associatedModules.clear(); + for( auto module : tmpModules ) + { + module->disable(); + } + if( m_pcCurrentDisplayModule ) + { + m_pcCurrentDisplayModule->disable(); + } SubWindowAbstract::closeEvent( event ); } @@ -648,28 +659,34 @@ void VideoSubWindow::updateSelectedArea( QRect area ) * Functions to enable a module in the * current SubWindow */ -void VideoSubWindow::enableModule( std::unique_ptr&& pcModule ) -{ - auto it = std::find( m_associatedModules.begin(), m_associatedModules.end(), pcModule.get() ); - if( it != m_associatedModules.end() ) - { - m_associatedModules.erase( it ); - } - m_pcCurrentDisplayModule = std::move( pcModule ); - updateVideoWindowInfo(); -} +// void VideoSubWindow::enableModule( std::shared_ptr pcModule ) +// { +// auto it = std::find_if( m_associatedModules.begin(), m_associatedModules.end(), +// [&]( const auto& module ) { return module.get() == pcModule.get(); } ); +// if( it != m_associatedModules.end() ) +// { +// m_associatedModules.erase( it ); +// } +// m_pcCurrentDisplayModule = std::move( pcModule ); +// updateVideoWindowInfo(); +// } void VideoSubWindow::disableModule( CalypAppModuleIf* pcModule ) { bool bRefresh = false; if( pcModule ) { - auto it = std::find( m_associatedModules.begin(), m_associatedModules.end(), pcModule ); + auto it = std::find_if( m_associatedModules.begin(), m_associatedModules.end(), + [&]( const auto& module ) { return module.get() == pcModule; } ); if( it != m_associatedModules.end() ) { m_associatedModules.erase( it ); bRefresh |= true; } + if( pcModule == m_pcCurrentDisplayModule ) + { + m_pcCurrentDisplayModule = nullptr; + } } // if( pcModule ) // { @@ -715,9 +732,22 @@ void VideoSubWindow::disableModule( CalypAppModuleIf* pcModule ) } } -void VideoSubWindow::associateModule( CalypAppModuleIf* pcModule ) +bool VideoSubWindow::disableAllModules() { - m_associatedModules.push_back( pcModule ); + if( m_associatedModules.empty() ) + return false; + // For loop is required as we will invalidate the iterator + while( m_associatedModules.size() > 0 ) + { + auto module = m_associatedModules.back(); + module->disable(); + } + return true; +} + +void VideoSubWindow::associateModule( std::shared_ptr pcModule ) +{ + m_associatedModules.push_back( std::move( pcModule ) ); } bool VideoSubWindow::hasRunningModule() diff --git a/app/VideoSubWindow.h b/app/VideoSubWindow.h index d39da5a..7806e16 100644 --- a/app/VideoSubWindow.h +++ b/app/VideoSubWindow.h @@ -89,8 +89,8 @@ private: //CalypFrame* m_pcCurrFrame; QRect m_cSelectedArea; - std::unique_ptr m_pcCurrentDisplayModule{ nullptr }; - std::vector m_associatedModules; + CalypAppModuleIf* m_pcCurrentDisplayModule{ nullptr }; + std::vector> m_associatedModules; VideoSubWindow* m_pcReferenceSubWindow; @@ -114,6 +114,7 @@ public: MODULE_SUBWINDOW = SubWindowAbstract::MODULE_SUBWINDOW, }; VideoSubWindow( enum VideoSubWindowCategories category, QWidget* parent = 0 ); + VideoSubWindow( enum VideoSubWindowCategories category, CalypAppModuleIf* displayModule, QWidget* parent = 0 ); ~VideoSubWindow(); void setResourceManaget( ResourceHandle* resourceManager ) { m_pcResourceManager = resourceManager; } @@ -161,17 +162,21 @@ public: * Functions to enable a module in the * current SubWindow */ - void enableModule( std::unique_ptr&& pcModule ); - void disableModule( CalypAppModuleIf* pcModule = NULL ); - void associateModule( CalypAppModuleIf* pcModule ); + //void enableModule( std::shared_ptr pcModule ); + void disableModule( CalypAppModuleIf* pcModule ); + bool disableAllModules(); + void associateModule( std::shared_ptr pcModule ); - CalypAppModuleIf* getDisplayModule() { return m_pcCurrentDisplayModule.get(); } + CalypAppModuleIf* getDisplayModule() { return m_pcCurrentDisplayModule; } QVector getModuleArray() { QVector apcModulesArray; if( m_pcCurrentDisplayModule ) - apcModulesArray.append( m_pcCurrentDisplayModule.get() ); - apcModulesArray.append( QVector::fromStdVector( m_associatedModules ) ); + apcModulesArray.append( m_pcCurrentDisplayModule ); + for( const auto& module : m_associatedModules ) + { + apcModulesArray.append( module.get() ); + } return apcModulesArray; } diff --git a/app/docks/ModuleHandleDock.cpp b/app/docks/ModuleHandleDock.cpp index c9c118d..82a1c71 100644 --- a/app/docks/ModuleHandleDock.cpp +++ b/app/docks/ModuleHandleDock.cpp @@ -33,7 +33,7 @@ #include "ModulesHandle.h" ModuleHandleDock::ModuleHandleDock( QWidget* parent, CalypAppModuleIf* moduleIf ) - : QWidget( parent ) + : QWidget( parent ), m_pcCurrModuleIf( moduleIf ) { // ----------------- Dock definition ----------------- @@ -60,11 +60,6 @@ ModuleHandleDock::ModuleHandleDock( QWidget* parent, CalypAppModuleIf* moduleIf ModuleHandleDock::~ModuleHandleDock() = default; -void ModuleHandleDock::enableModule( std::unique_ptr&& module ) -{ - m_pcCurrModuleIf = std::move( module ); -} - void ModuleHandleDock::setModuleReturnValue( double value ) { labelModulueReturnValue->clear(); @@ -76,7 +71,7 @@ void ModuleHandleDock::visibilityChangedSlot( bool visiblity ) { if( !visiblity ) { - m_pcCurrModuleIf = nullptr; + m_pcCurrModuleIf->disable(); } } diff --git a/app/docks/ModuleHandleDock.h b/app/docks/ModuleHandleDock.h index 167470e..b388862 100644 --- a/app/docks/ModuleHandleDock.h +++ b/app/docks/ModuleHandleDock.h @@ -42,13 +42,12 @@ public: ModuleHandleDock( QWidget* parent, CalypAppModuleIf* moduleIf ); ~ModuleHandleDock(); - void enableModule( std::unique_ptr&& module ); void setModuleReturnValue( double value ); QSize sizeHint() const; private: - std::unique_ptr m_pcCurrModuleIf; + CalypAppModuleIf* m_pcCurrModuleIf; bool m_bIsVisible; QLabel* labelModulueValueLabel;