You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ovpCBoxAlgorithmP300TactileVisualization.cpp 33KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828
  1. ///-------------------------------------------------------------------------------------------------
  2. ///
  3. /// \file ovpCBoxAlgorithmP300TactileVisualization.cpp
  4. /// \brief Functions of the Class P300TactileVisualization. !!This is a modification of the P300 Speller Visualization Box!!
  5. /// \author Tobias Baumann (TH Nuernberg).
  6. /// \version 1.0.
  7. /// \date Mon Feb 04 12:43:53 2022.
  8. /// \copyright <a href="https://choosealicense.com/licenses/agpl-3.0/">GNU Affero General Public License v3.0</a>
  9. ///
  10. ///-------------------------------------------------------------------------------------------------
  11. //includes
  12. #include "ovpCBoxAlgorithmP300TactileVisualization.h"
  13. #include <tcptagging/IStimulusSender.h>
  14. #include <algorithm>
  15. #include <list>
  16. #include <string>
  17. #include <vector>
  18. namespace OpenViBE {
  19. namespace Plugins {
  20. namespace Tactilebci {
  21. static void ToggleButtonShowHideCB(GtkToggleToolButton* button, gpointer data)
  22. {
  23. if (gtk_toggle_tool_button_get_active(button)) { gtk_widget_show(GTK_WIDGET(data)); }
  24. else { gtk_widget_hide(GTK_WIDGET(data)); }
  25. }
  26. // This callback flushes all accumulated stimulations to the TCP Tagging
  27. // after the rendering has completed.
  28. static gboolean FlushCB(gpointer data)
  29. {
  30. (static_cast<CBoxAlgorithmP300TactileVisualization*>(data))->flushQueue();
  31. return false; // Only run once
  32. }
  33. bool CBoxAlgorithmP300TactileVisualization::initialize()
  34. {
  35. const Kernel::IBox& boxContext = this->getStaticBoxContext();
  36. m_mainWidgetInterface = nullptr;
  37. m_toolbarWidgetInterface = nullptr;
  38. m_flashFontDesc = nullptr;
  39. m_noFlashFontDesc = nullptr;
  40. m_targetFontDesc = nullptr;
  41. m_selectedFontDesc = nullptr;
  42. // ----------------------------------------------------------------------------------------------------------------------------------------------------------
  43. m_interfaceFilename = FSettingValueAutoCast(*this->getBoxAlgorithmContext(), 0);
  44. m_rowStimulationBase = FSettingValueAutoCast(*this->getBoxAlgorithmContext(), 1);
  45. m_columnStimulationBase = FSettingValueAutoCast(*this->getBoxAlgorithmContext(), 2);
  46. m_flashBgColor = CGdkcolorAutoCast(boxContext, this->getConfigurationManager(), 3);
  47. m_flashFgColor = CGdkcolorAutoCast(boxContext, this->getConfigurationManager(), 4);
  48. m_flashFontSize = FSettingValueAutoCast(*this->getBoxAlgorithmContext(), 5);
  49. m_noFlashBgColor = CGdkcolorAutoCast(boxContext, this->getConfigurationManager(), 6);
  50. m_noFlashFgColor = CGdkcolorAutoCast(boxContext, this->getConfigurationManager(), 7);
  51. m_noFlashFontSize = FSettingValueAutoCast(*this->getBoxAlgorithmContext(), 8);
  52. m_targetBgColor = CGdkcolorAutoCast(boxContext, this->getConfigurationManager(), 9);
  53. m_targetFgColor = CGdkcolorAutoCast(boxContext, this->getConfigurationManager(), 10);
  54. m_targetFontSize = FSettingValueAutoCast(*this->getBoxAlgorithmContext(), 11);
  55. m_selectedBgColor = CGdkcolorAutoCast(boxContext, this->getConfigurationManager(), 12);
  56. m_selectedFgColor = CGdkcolorAutoCast(boxContext, this->getConfigurationManager(), 13);
  57. m_selectedFontSize = FSettingValueAutoCast(*this->getBoxAlgorithmContext(), 14);
  58. m_nTactilos = FSettingValueAutoCast(*this->getBoxAlgorithmContext(), 15);
  59. //set m_nTactilos to 2 if lower than 2
  60. if(m_nTactilos < 2)
  61. {
  62. m_nTactilos = 2;
  63. }
  64. //set m_nTactilos to MAX if greater than MAX_TACTILOS
  65. if(m_nTactilos > MAX_TACTILOS)
  66. {
  67. m_nTactilos = MAX_TACTILOS;
  68. }
  69. // ----------------------------------------------------------------------------------------------------------------------------------------------------------
  70. m_sequenceStimulationDecoder = &this->getAlgorithmManager().getAlgorithm(
  71. this->getAlgorithmManager().createAlgorithm(OVP_GD_ClassId_Algorithm_StimulationDecoder));
  72. m_sequenceStimulationDecoder->initialize();
  73. m_targetStimulationDecoder = &this->getAlgorithmManager().getAlgorithm(
  74. this->getAlgorithmManager().createAlgorithm(OVP_GD_ClassId_Algorithm_StimulationDecoder));
  75. m_targetStimulationDecoder->initialize();
  76. m_targetFlaggingStimulationEncoder = &this->getAlgorithmManager().getAlgorithm(
  77. this->getAlgorithmManager().createAlgorithm(OVP_GD_ClassId_Algorithm_StimulationEncoder));
  78. m_targetFlaggingStimulationEncoder->initialize();
  79. m_rowSelectionStimulationDecoder = &this->getAlgorithmManager().getAlgorithm(
  80. this->getAlgorithmManager().createAlgorithm(OVP_GD_ClassId_Algorithm_StimulationDecoder));
  81. m_rowSelectionStimulationDecoder->initialize();
  82. m_columnSelectionStimulationDecoder = &this->getAlgorithmManager().getAlgorithm(
  83. this->getAlgorithmManager().createAlgorithm(OVP_GD_ClassId_Algorithm_StimulationDecoder));
  84. m_columnSelectionStimulationDecoder->initialize();
  85. m_sequenceMemoryBuffer.initialize(
  86. m_sequenceStimulationDecoder->getInputParameter(OVP_GD_Algorithm_StimulationDecoder_InputParameterId_MemoryBufferToDecode));
  87. m_sequenceStimulationSet.initialize(
  88. m_sequenceStimulationDecoder->getOutputParameter(OVP_GD_Algorithm_StimulationDecoder_OutputParameterId_StimulationSet));
  89. m_targetMemoryBuffer.initialize(
  90. m_targetStimulationDecoder->getInputParameter(OVP_GD_Algorithm_StimulationDecoder_InputParameterId_MemoryBufferToDecode));
  91. m_targetStimulationSet.initialize(
  92. m_targetStimulationDecoder->getOutputParameter(OVP_GD_Algorithm_StimulationDecoder_OutputParameterId_StimulationSet));
  93. m_targetFlaggingStimulationSet.initialize(
  94. m_targetFlaggingStimulationEncoder->getInputParameter(OVP_GD_Algorithm_StimulationEncoder_InputParameterId_StimulationSet));
  95. m_targetFlaggingMemoryBuffer.initialize(
  96. m_targetFlaggingStimulationEncoder->getOutputParameter(OVP_GD_Algorithm_StimulationEncoder_OutputParameterId_EncodedMemoryBuffer));
  97. m_lastTime = 0;
  98. m_stimulusSender = nullptr;
  99. m_idleFuncTag = 0;
  100. m_stimuliQueue.clear();
  101. m_mainWidgetInterface = gtk_builder_new(); // glade_xml_new(m_interfaceFilename.toASCIIString(), "p300-speller-main", nullptr);
  102. if (!gtk_builder_add_from_file(m_mainWidgetInterface, m_interfaceFilename.toASCIIString(), nullptr))
  103. {
  104. this->getLogManager() << Kernel::LogLevel_ImportantWarning << "Could not load interface file [" << m_interfaceFilename << "]\n";
  105. this->getLogManager() << Kernel::LogLevel_ImportantWarning <<
  106. "The file may be missing. However, the interface files now use gtk-builder instead of glade. Did you update your files ?\n";
  107. return false;
  108. }
  109. m_toolbarWidgetInterface = gtk_builder_new(); // glade_xml_new(m_interfaceFilename.toASCIIString(), "p300-speller-toolbar", nullptr);
  110. gtk_builder_add_from_file(m_toolbarWidgetInterface, m_interfaceFilename.toASCIIString(), nullptr);
  111. m_mainWindow = GTK_WIDGET(gtk_builder_get_object(m_mainWidgetInterface, "p300-speller-main"));
  112. m_toolbarWidget = GTK_WIDGET(gtk_builder_get_object(m_toolbarWidgetInterface, "p300-speller-toolbar"));
  113. m_table = GTK_TABLE(gtk_builder_get_object(m_mainWidgetInterface, "p300-speller-table"));
  114. m_result = GTK_LABEL(gtk_builder_get_object(m_mainWidgetInterface, "label-result"));
  115. m_target = GTK_LABEL(gtk_builder_get_object(m_mainWidgetInterface, "label-target"));
  116. //Begin Menu Initialization -------------------------------------------------------------------------------------
  117. if(m_nTactilos == 6) //Create Menus for m_nTactilos = 6
  118. {
  119. m_Menu.push_back(TactileMenu(6));
  120. m_Menu[0].set_LabelText(0, "Ja");
  121. m_Menu[0].set_LabelText(1, "Nein");
  122. m_Menu[0].set_LabelText(2, "Pflege");
  123. m_Menu[0].set_LabelText(3, "Hilfe");
  124. m_Menu[0].set_LabelText(4, "Geräte");
  125. m_Menu[0].set_LabelText(5, "Funktionen");
  126. m_Menu.push_back(TactileMenu(6));
  127. m_Menu[1].set_LabelText(0, "Ja");
  128. m_Menu[1].set_LabelText(1, "Nein");
  129. m_Menu[1].set_LabelText(2, "Hunger");
  130. m_Menu[1].set_LabelText(3, "Lage");
  131. m_Menu[1].set_LabelText(4, "Müdigkeit");
  132. m_Menu[1].set_LabelText(5, "Hauptmenü");
  133. m_Menu.push_back(TactileMenu(6));
  134. m_Menu[2].set_LabelText(0, "Ja");
  135. m_Menu[2].set_LabelText(1, "Nein");
  136. m_Menu[2].set_LabelText(2, "Schmerzen");
  137. m_Menu[2].set_LabelText(3, "Atemnot");
  138. m_Menu[2].set_LabelText(4, "Anderes");
  139. m_Menu[2].set_LabelText(5, "Hauptmenü");
  140. m_Menu.push_back(TactileMenu(6));
  141. m_Menu[3].set_LabelText(0, "Ja");
  142. m_Menu[3].set_LabelText(1, "Nein");
  143. m_Menu[3].set_LabelText(2, "Atemgerät");
  144. m_Menu[3].set_LabelText(3, "Rollstuhl");
  145. m_Menu[3].set_LabelText(4, "Computer");
  146. m_Menu[3].set_LabelText(5, "Hauptmenü");
  147. //Set SubMenu ptr
  148. m_Menu[0].set_SubMenu(2, &m_Menu[1]);
  149. m_Menu[0].set_SubMenu(3, &m_Menu[2]);
  150. m_Menu[0].set_SubMenu(4, &m_Menu[3]);
  151. m_Menu[1].set_SubMenu(5, &m_Menu[0]);
  152. m_Menu[2].set_SubMenu(5, &m_Menu[0]);
  153. m_Menu[3].set_SubMenu(5, &m_Menu[0]);
  154. //Set current menu ptr to Mainmenu
  155. m_currMenu = &m_Menu[0];
  156. }
  157. else //Create default menu for m_nTactilos != 6
  158. {
  159. m_Menu.push_back(TactileMenu(m_nTactilos));
  160. m_currMenu = &m_Menu[0];
  161. }
  162. //Init Gtk Labels
  163. for(int i = 0; i < m_nTactilos; i++)
  164. {
  165. std::string label_id = "label-" + std::to_string(i+1);
  166. std::string label_text = m_currMenu->get_LabelText(i);
  167. m_Label.push_back(GTK_LABEL(gtk_builder_get_object(m_mainWidgetInterface, label_id.c_str())));
  168. gtk_label_set_text(m_Label[i], label_text.c_str());
  169. }
  170. //End Menu Initialization ---------------------------------------------------------------------------------------
  171. gtk_builder_connect_signals(m_mainWidgetInterface, nullptr);
  172. gtk_builder_connect_signals(m_toolbarWidgetInterface, nullptr);
  173. g_signal_connect(gtk_builder_get_object(m_toolbarWidgetInterface, "toolbutton-show_target_text"), "toggled", G_CALLBACK(ToggleButtonShowHideCB),
  174. gtk_builder_get_object(m_mainWidgetInterface, "label-target"));
  175. g_signal_connect(gtk_builder_get_object(m_toolbarWidgetInterface, "toolbutton-show_target_text"), "toggled", G_CALLBACK(ToggleButtonShowHideCB),
  176. gtk_builder_get_object(m_mainWidgetInterface, "label-target-title"));
  177. g_signal_connect(gtk_builder_get_object(m_toolbarWidgetInterface, "toolbutton-show_result_text"), "toggled", G_CALLBACK(ToggleButtonShowHideCB),
  178. gtk_builder_get_object(m_mainWidgetInterface, "label-result"));
  179. g_signal_connect(gtk_builder_get_object(m_toolbarWidgetInterface, "toolbutton-show_result_text"), "toggled", G_CALLBACK(ToggleButtonShowHideCB),
  180. gtk_builder_get_object(m_mainWidgetInterface, "label-result-title"));
  181. m_visualizationCtx = dynamic_cast<VisualizationToolkit::IVisualizationContext*>(this->createPluginObject(
  182. OVP_ClassId_Plugin_VisualizationCtx));
  183. m_visualizationCtx->setWidget(*this, m_mainWindow);
  184. m_visualizationCtx->setToolbar(*this, m_toolbarWidget);
  185. guint nRow = 0, nCol = 0;
  186. g_object_get(m_table, "n-rows", &nRow, nullptr);
  187. g_object_get(m_table, "n-columns", &nCol, nullptr);
  188. m_nRow = nRow;
  189. m_nCol = nCol;
  190. PangoFontDescription* maxFontDesc = pango_font_description_copy(pango_context_get_font_description(gtk_widget_get_pango_context(m_mainWindow)));
  191. m_flashFontDesc = pango_font_description_copy(pango_context_get_font_description(gtk_widget_get_pango_context(m_mainWindow)));
  192. m_noFlashFontDesc = pango_font_description_copy(pango_context_get_font_description(gtk_widget_get_pango_context(m_mainWindow)));
  193. m_targetFontDesc = pango_font_description_copy(pango_context_get_font_description(gtk_widget_get_pango_context(m_mainWindow)));
  194. m_selectedFontDesc = pango_font_description_copy(pango_context_get_font_description(gtk_widget_get_pango_context(m_mainWindow)));
  195. uint64_t maxSize = 0;
  196. maxSize = std::max(maxSize, m_flashFontSize);
  197. maxSize = std::max(maxSize, m_noFlashFontSize);
  198. maxSize = std::max(maxSize, m_targetFontSize);
  199. maxSize = std::max(maxSize, m_selectedFontSize);
  200. pango_font_description_set_size(maxFontDesc, gint(maxSize * PANGO_SCALE));
  201. pango_font_description_set_size(m_flashFontDesc, gint(m_flashFontSize * PANGO_SCALE));
  202. pango_font_description_set_size(m_noFlashFontDesc, gint(m_noFlashFontSize * PANGO_SCALE));
  203. pango_font_description_set_size(m_targetFontDesc, gint(m_targetFontSize * PANGO_SCALE));
  204. pango_font_description_set_size(m_selectedFontDesc, gint(m_selectedFontSize * PANGO_SCALE));
  205. this->cacheBuildFromTable(m_table);
  206. this->cacheForEach(&CBoxAlgorithmP300TactileVisualization::cacheChangeBackgroundCB, &m_noFlashBgColor);
  207. this->cacheForEach(&CBoxAlgorithmP300TactileVisualization::cacheChangeForegroundCB, &m_noFlashFgColor);
  208. this->cacheForEach(&CBoxAlgorithmP300TactileVisualization::cacheChangeFontCB, maxFontDesc);
  209. pango_font_description_free(maxFontDesc);
  210. m_lastTargetRow = -1;
  211. m_lastTargetCol = -1;
  212. m_targetRow = -1;
  213. m_targetCol = -1;
  214. m_selectedRow = -1;
  215. m_selectedCol = -1;
  216. m_stimulusSender = TCPTagging::CreateStimulusSender();
  217. if (!m_stimulusSender->connect("localhost", "15361"))
  218. {
  219. this->getLogManager() << Kernel::LogLevel_Warning << "Unable to connect to AS TCP Tagging, stimuli wont be forwarded.\n";
  220. }
  221. m_tableInitialized = false;
  222. return true;
  223. }
  224. bool CBoxAlgorithmP300TactileVisualization::uninitialize()
  225. {
  226. if (m_idleFuncTag)
  227. {
  228. m_stimuliQueue.clear();
  229. g_source_remove(m_idleFuncTag);
  230. m_idleFuncTag = 0;
  231. }
  232. if (m_stimulusSender)
  233. {
  234. delete m_stimulusSender;
  235. m_stimulusSender = nullptr;
  236. }
  237. if (m_selectedFontDesc)
  238. {
  239. pango_font_description_free(m_selectedFontDesc);
  240. m_selectedFontDesc = nullptr;
  241. }
  242. if (m_targetFontDesc)
  243. {
  244. pango_font_description_free(m_targetFontDesc);
  245. m_targetFontDesc = nullptr;
  246. }
  247. if (m_noFlashFontDesc)
  248. {
  249. pango_font_description_free(m_noFlashFontDesc);
  250. m_noFlashFontDesc = nullptr;
  251. }
  252. if (m_flashFontDesc)
  253. {
  254. pango_font_description_free(m_flashFontDesc);
  255. m_flashFontDesc = nullptr;
  256. }
  257. if (m_toolbarWidgetInterface)
  258. {
  259. g_object_unref(m_toolbarWidgetInterface);
  260. m_toolbarWidgetInterface = nullptr;
  261. }
  262. if (m_mainWidgetInterface)
  263. {
  264. g_object_unref(m_mainWidgetInterface);
  265. m_mainWidgetInterface = nullptr;
  266. }
  267. m_targetFlaggingStimulationSet.uninitialize();
  268. m_targetFlaggingMemoryBuffer.uninitialize();
  269. m_targetStimulationSet.uninitialize();
  270. m_targetMemoryBuffer.uninitialize();
  271. m_sequenceStimulationSet.uninitialize();
  272. m_sequenceMemoryBuffer.uninitialize();
  273. if (m_columnSelectionStimulationDecoder)
  274. {
  275. m_columnSelectionStimulationDecoder->uninitialize();
  276. this->getAlgorithmManager().releaseAlgorithm(*m_columnSelectionStimulationDecoder);
  277. m_columnSelectionStimulationDecoder = nullptr;
  278. }
  279. if (m_rowSelectionStimulationDecoder)
  280. {
  281. m_rowSelectionStimulationDecoder->uninitialize();
  282. this->getAlgorithmManager().releaseAlgorithm(*m_rowSelectionStimulationDecoder);
  283. m_rowSelectionStimulationDecoder = nullptr;
  284. }
  285. if (m_targetFlaggingStimulationEncoder)
  286. {
  287. m_targetFlaggingStimulationEncoder->uninitialize();
  288. this->getAlgorithmManager().releaseAlgorithm(*m_targetFlaggingStimulationEncoder);
  289. m_targetFlaggingStimulationEncoder = nullptr;
  290. }
  291. if (m_targetStimulationDecoder)
  292. {
  293. m_targetStimulationDecoder->uninitialize();
  294. this->getAlgorithmManager().releaseAlgorithm(*m_targetStimulationDecoder);
  295. m_targetStimulationDecoder = nullptr;
  296. }
  297. if (m_sequenceStimulationDecoder)
  298. {
  299. m_sequenceStimulationDecoder->uninitialize();
  300. this->getAlgorithmManager().releaseAlgorithm(*m_sequenceStimulationDecoder);
  301. m_sequenceStimulationDecoder = nullptr;
  302. }
  303. if (m_visualizationCtx)
  304. {
  305. this->releasePluginObject(m_visualizationCtx);
  306. m_sequenceStimulationDecoder = nullptr;
  307. }
  308. return true;
  309. }
  310. bool CBoxAlgorithmP300TactileVisualization::processInput(const size_t /*index*/)
  311. {
  312. this->getBoxAlgorithmContext()->markAlgorithmAsReadyToProcess();
  313. if (!m_tableInitialized)
  314. {
  315. this->cacheForEach(&CBoxAlgorithmP300TactileVisualization::cacheChangeBackgroundCB, &m_noFlashBgColor);
  316. this->cacheForEach(&CBoxAlgorithmP300TactileVisualization::cacheChangeForegroundCB, &m_noFlashFgColor);
  317. this->cacheForEach(&CBoxAlgorithmP300TactileVisualization::cacheChangeFontCB, m_noFlashFontDesc);
  318. m_tableInitialized = true;
  319. }
  320. return true;
  321. }
  322. bool CBoxAlgorithmP300TactileVisualization::process()
  323. {
  324. Kernel::IBoxIO& boxContext = this->getDynamicBoxContext();
  325. // --- Sequence stimulations
  326. for (size_t i = 0; i < boxContext.getInputChunkCount(0); ++i)
  327. {
  328. CStimulationSet flaggingStimulationSet;
  329. m_sequenceMemoryBuffer = boxContext.getInputChunk(0, i);
  330. m_targetFlaggingStimulationSet = &flaggingStimulationSet;
  331. m_targetFlaggingMemoryBuffer = boxContext.getOutputChunk(0);
  332. m_sequenceStimulationDecoder->process();
  333. m_lastTime = boxContext.getInputChunkEndTime(0, i);
  334. if (m_sequenceStimulationDecoder->isOutputTriggerActive(OVP_GD_Algorithm_StimulationDecoder_OutputTriggerId_ReceivedHeader))
  335. {
  336. m_targetFlaggingStimulationEncoder->process(OVP_GD_Algorithm_StimulationEncoder_InputTriggerId_EncodeHeader);
  337. }
  338. if (m_sequenceStimulationDecoder->isOutputTriggerActive(OVP_GD_Algorithm_StimulationDecoder_OutputTriggerId_ReceivedBuffer))
  339. {
  340. CStimulationSet* stimulationSet = m_sequenceStimulationSet;
  341. for (size_t j = 0; j < stimulationSet->size(); ++j)
  342. {
  343. uint64_t id = stimulationSet->getId(j);
  344. bool flash = false;
  345. int row = -1;
  346. int col = -1;
  347. bool isTarget = false;
  348. if (id >= m_rowStimulationBase && id < m_rowStimulationBase + m_nRow)
  349. {
  350. row = int(id - m_rowStimulationBase);
  351. flash = true;
  352. isTarget = (row == m_lastTargetRow);
  353. }
  354. if (id >= m_columnStimulationBase && id < m_columnStimulationBase + m_nCol)
  355. {
  356. col = int(id - m_columnStimulationBase);
  357. flash = true;
  358. isTarget = (col == m_lastTargetCol);
  359. }
  360. if (id == OVTK_StimulationId_VisualStimulationStop)
  361. {
  362. this->getLogManager() << Kernel::LogLevel_Debug << "Received OVTK_StimulationId_VisualStimulationStop - resets grid\n";
  363. this->cacheForEach(&CBoxAlgorithmP300TactileVisualization::cacheChangeBackgroundCB, &m_noFlashBgColor);
  364. this->cacheForEach(&CBoxAlgorithmP300TactileVisualization::cacheChangeForegroundCB, &m_noFlashFgColor);
  365. this->cacheForEach(&CBoxAlgorithmP300TactileVisualization::cacheChangeFontCB, m_noFlashFontDesc);
  366. }
  367. if (id == OVTK_StimulationId_Reset)
  368. {
  369. gtk_label_set_text(m_target, "");
  370. gtk_label_set_text(m_result, "");
  371. }
  372. if (flash)
  373. {
  374. this->cacheForEachIf(row, col, &CBoxAlgorithmP300TactileVisualization::cacheChangeBackgroundCB,
  375. &CBoxAlgorithmP300TactileVisualization::cacheChangeBackgroundCB, &m_flashBgColor, &m_noFlashBgColor);
  376. this->cacheForEachIf(row, col, &CBoxAlgorithmP300TactileVisualization::cacheChangeForegroundCB,
  377. &CBoxAlgorithmP300TactileVisualization::cacheChangeForegroundCB, &m_flashFgColor, &m_noFlashFgColor);
  378. this->cacheForEachIf(row, col, &CBoxAlgorithmP300TactileVisualization::cacheChangeFontCB,
  379. &CBoxAlgorithmP300TactileVisualization::cacheChangeFontCB, m_flashFontDesc, m_noFlashFontDesc);
  380. // We now know if this flash corresponds to the current target or not, merge this to the outgoing stimulation stream
  381. if (isTarget)
  382. {
  383. m_stimuliQueue.push_back(OVTK_StimulationId_Target);
  384. flaggingStimulationSet.push_back(OVTK_StimulationId_Target, stimulationSet->getDate(j), 0);
  385. }
  386. else
  387. {
  388. m_stimuliQueue.push_back(OVTK_StimulationId_NonTarget);
  389. flaggingStimulationSet.push_back(OVTK_StimulationId_NonTarget, stimulationSet->getDate(j), 0);
  390. }
  391. }
  392. // Pass the stimulation to the server also as-is. If its a flash, it can be differentiated from a 'target' spec because
  393. // its NOT between OVTK_StimulationId_RestStart and OVTK_StimulationId_RestStop stimuli in the generated P300 timeline.
  394. m_stimuliQueue.push_back(id);
  395. }
  396. m_targetFlaggingStimulationEncoder->process(OVP_GD_Algorithm_StimulationEncoder_InputTriggerId_EncodeBuffer);
  397. }
  398. if (m_sequenceStimulationDecoder->isOutputTriggerActive(OVP_GD_Algorithm_StimulationDecoder_OutputTriggerId_ReceivedEnd))
  399. {
  400. m_targetFlaggingStimulationEncoder->process(OVP_GD_Algorithm_StimulationEncoder_InputTriggerId_EncodeEnd);
  401. }
  402. boxContext.markInputAsDeprecated(0, i);
  403. boxContext.markOutputAsReadyToSend(0, boxContext.getInputChunkStartTime(0, i), boxContext.getInputChunkEndTime(0, i));
  404. }
  405. // --- Target stimulations
  406. for (size_t i = 0; i < boxContext.getInputChunkCount(1); ++i)
  407. {
  408. if (m_lastTime >= boxContext.getInputChunkStartTime(1, i))
  409. {
  410. m_targetMemoryBuffer = boxContext.getInputChunk(1, i);
  411. m_targetStimulationDecoder->process();
  412. if (m_targetStimulationDecoder->isOutputTriggerActive(OVP_GD_Algorithm_StimulationDecoder_OutputTriggerId_ReceivedHeader)) { }
  413. if (m_targetStimulationDecoder->isOutputTriggerActive(OVP_GD_Algorithm_StimulationDecoder_OutputTriggerId_ReceivedBuffer))
  414. {
  415. CStimulationSet* stimulationSet = m_targetStimulationSet;
  416. for (size_t j = 0; j < stimulationSet->size(); ++j)
  417. {
  418. uint64_t id = stimulationSet->getId(j);
  419. bool target = false;
  420. if (id >= m_rowStimulationBase && id < m_rowStimulationBase + m_nRow)
  421. {
  422. this->getLogManager() << Kernel::LogLevel_Debug << "Received Target Row " << id << "\n";
  423. m_targetRow = int(id - m_rowStimulationBase);
  424. target = true;
  425. }
  426. if (id >= m_columnStimulationBase && id < m_columnStimulationBase + m_nCol)
  427. {
  428. this->getLogManager() << Kernel::LogLevel_Debug << "Received Target Column " << id << "\n";
  429. m_targetCol = int(id - m_columnStimulationBase);
  430. target = true;
  431. }
  432. if (target && m_targetRow != -1 && m_targetCol != -1)
  433. {
  434. this->getLogManager() << Kernel::LogLevel_Debug << "Displays Target Cell\n";
  435. this->cacheForEachIf(m_targetRow, m_targetCol, &CBoxAlgorithmP300TactileVisualization::cacheChangeBackgroundCB,
  436. &CBoxAlgorithmP300TactileVisualization::cacheChangeNullCB, &m_targetBgColor, nullptr);
  437. this->cacheForEachIf(m_targetRow, m_targetCol, &CBoxAlgorithmP300TactileVisualization::cacheChangeForegroundCB,
  438. &CBoxAlgorithmP300TactileVisualization::cacheChangeNullCB, &m_targetFgColor, nullptr);
  439. this->cacheForEachIf(m_targetRow, m_targetCol, &CBoxAlgorithmP300TactileVisualization::cacheChangeFontCB,
  440. &CBoxAlgorithmP300TactileVisualization::cacheChangeNullCB, m_targetFontDesc, nullptr);
  441. std::vector<GtkWidget*> widgets;
  442. this->cacheForEachIf(m_targetRow, m_targetCol, &CBoxAlgorithmP300TactileVisualization::cacheCollectChildWidgetCB,
  443. &CBoxAlgorithmP300TactileVisualization::cacheCollectChildWidgetCB, &widgets, nullptr);
  444. // Merge the current target into the stimulation stream. It can be differentiated
  445. // from a 'flash' spec because it IS between OVTK_StimulationId_RestStart and
  446. // OVTK_StimulationId_RestStop stimulations in the P300 timeline.
  447. {
  448. m_stimuliQueue.push_back(m_targetRow + m_rowStimulationBase);
  449. m_stimuliQueue.push_back(m_targetCol + m_columnStimulationBase);
  450. }
  451. if (widgets.size() == 1)
  452. {
  453. if (GTK_IS_LABEL(widgets[0]))
  454. {
  455. std::string label;
  456. label = gtk_label_get_text(m_target);
  457. label += gtk_label_get_text(GTK_LABEL(widgets[0]));
  458. gtk_label_set_text(m_target, label.c_str());
  459. }
  460. else
  461. {
  462. this->getLogManager() << Kernel::LogLevel_Warning << "Expected label class widget... could not find a valid text to append\n";
  463. }
  464. }
  465. else
  466. {
  467. this->getLogManager() << Kernel::LogLevel_Warning << "Did not find a unique widget at row:" << size_t(m_targetRow) << " column:" <<
  468. size_t(m_targetCol) << "\n";
  469. }
  470. m_targetHistory.emplace_back(m_targetRow, m_targetCol);
  471. m_lastTargetRow = m_targetRow;
  472. m_lastTargetCol = m_targetCol;
  473. m_targetRow = -1;
  474. m_targetCol = -1;
  475. }
  476. }
  477. }
  478. if (m_targetStimulationDecoder->isOutputTriggerActive(OVP_GD_Algorithm_StimulationDecoder_OutputTriggerId_ReceivedEnd)) { }
  479. boxContext.markInputAsDeprecated(1, i);
  480. }
  481. }
  482. // --- Selection stimulations
  483. for (size_t k = 2; k < 4; ++k)
  484. {
  485. Kernel::IAlgorithmProxy* decoder = (k == 2 ? m_rowSelectionStimulationDecoder : m_columnSelectionStimulationDecoder);
  486. Kernel::TParameterHandler<const IMemoryBuffer*> selectionMemoryBuffer(
  487. decoder->getInputParameter(OVP_GD_Algorithm_StimulationDecoder_InputParameterId_MemoryBufferToDecode));
  488. Kernel::TParameterHandler<CStimulationSet*> selectionStimulationSet(
  489. decoder->getOutputParameter(OVP_GD_Algorithm_StimulationDecoder_OutputParameterId_StimulationSet));
  490. for (size_t i = 0; i < boxContext.getInputChunkCount(k); ++i)
  491. {
  492. if (m_lastTime >= boxContext.getInputChunkStartTime(k, i))
  493. {
  494. selectionMemoryBuffer = boxContext.getInputChunk(k, i);
  495. decoder->process();
  496. if (decoder->isOutputTriggerActive(OVP_GD_Algorithm_StimulationDecoder_OutputTriggerId_ReceivedHeader)) { }
  497. if (decoder->isOutputTriggerActive(OVP_GD_Algorithm_StimulationDecoder_OutputTriggerId_ReceivedBuffer))
  498. {
  499. CStimulationSet* stimulationSet = selectionStimulationSet;
  500. for (size_t j = 0; j < stimulationSet->size(); ++j)
  501. {
  502. uint64_t id = stimulationSet->getId(j);
  503. bool selected = false;
  504. if (id >= m_rowStimulationBase && id < m_rowStimulationBase + m_nRow)
  505. {
  506. this->getLogManager() << Kernel::LogLevel_Debug << "Received Selected Row " << id << "\n";
  507. m_selectedRow = int(id - m_rowStimulationBase);
  508. selected = true;
  509. }
  510. if (id >= m_columnStimulationBase && id < m_columnStimulationBase + m_nRow)
  511. {
  512. this->getLogManager() << Kernel::LogLevel_Debug << "Received Selected Column " << id << "\n";
  513. m_selectedCol = int(id - m_columnStimulationBase);
  514. selected = true;
  515. }
  516. if (id == OVTK_StimulationId_Label_00)
  517. {
  518. if (k == 2) { m_selectedRow = -2; }
  519. if (k == 3) { m_selectedCol = -2; }
  520. selected = true;
  521. }
  522. if (selected && m_selectedRow != -1 && m_selectedCol != -1)
  523. {
  524. if (m_selectedRow >= 0 && m_selectedCol >= 0)
  525. {
  526. this->getLogManager() << Kernel::LogLevel_Debug << "Displays Selected Cell\n";
  527. this->cacheForEachIf(m_selectedRow, m_selectedCol, &CBoxAlgorithmP300TactileVisualization::cacheChangeBackgroundCB,
  528. &CBoxAlgorithmP300TactileVisualization::cacheChangeNullCB, &m_selectedBgColor, nullptr);
  529. this->cacheForEachIf(m_selectedRow, m_selectedCol, &CBoxAlgorithmP300TactileVisualization::cacheChangeForegroundCB,
  530. &CBoxAlgorithmP300TactileVisualization::cacheChangeNullCB, &m_selectedFgColor, nullptr);
  531. this->cacheForEachIf(m_selectedRow, m_selectedCol, &CBoxAlgorithmP300TactileVisualization::cacheChangeFontCB,
  532. &CBoxAlgorithmP300TactileVisualization::cacheChangeNullCB, m_selectedFontDesc, nullptr);
  533. std::vector<GtkWidget*> widgets;
  534. this->cacheForEachIf(m_selectedRow, m_selectedCol, &CBoxAlgorithmP300TactileVisualization::cacheCollectChildWidgetCB,
  535. &CBoxAlgorithmP300TactileVisualization::cacheCollectChildWidgetCB, &widgets, nullptr);
  536. if (widgets.size() == 1)
  537. {
  538. if (GTK_IS_LABEL(widgets[0]))
  539. {
  540. std::string label;
  541. label = gtk_label_get_text(GTK_LABEL(widgets[0]));
  542. if (!m_targetHistory.empty())
  543. {
  544. auto it = m_targetHistory.begin();
  545. bool correct = (it->first == m_selectedRow && it->second == m_selectedCol);
  546. bool halfCorrect = (it->first == m_selectedRow || it->second == m_selectedCol);
  547. m_targetHistory.pop_front();
  548. std::string tmp;
  549. if (correct) { tmp = "<span color=\"darkgreen\">"; }
  550. else if (halfCorrect) { tmp = "<span color=\"darkorange\">"; }
  551. else { tmp = "<span color=\"darkred\">"; }
  552. label = tmp.append(label).append("</span>");
  553. }
  554. label = std::string(gtk_label_get_label(m_result)).append(label);
  555. gtk_label_set_markup(m_result, label.c_str());
  556. }
  557. else
  558. {
  559. this->getLogManager() << Kernel::LogLevel_Warning <<
  560. "Expected label class widget... could not find a valid text to append\n";
  561. }
  562. }
  563. else
  564. {
  565. this->getLogManager() << Kernel::LogLevel_Warning << "Did not find a unique widget at row : " << size_t(m_selectedRow) <<
  566. " column : " << size_t(m_selectedCol) << "\n";
  567. }
  568. //Switch Menu
  569. if(m_currMenu->get_SubMenu(m_selectedRow) != nullptr)
  570. {
  571. m_currMenu = m_currMenu->get_SubMenu(m_selectedRow);
  572. for(uint64_t i = 0; i < m_nTactilos; i++)
  573. {
  574. std::string label_text = m_currMenu->get_LabelText(i);
  575. gtk_label_set_text(m_Label[i], label_text.c_str());
  576. }
  577. }
  578. }
  579. else
  580. {
  581. this->getLogManager() << Kernel::LogLevel_Trace << "Selection Rejected !\n";
  582. std::string label;
  583. label = gtk_label_get_text(m_result);
  584. label += "*";
  585. gtk_label_set_text(m_result, label.c_str());
  586. }
  587. m_selectedRow = -1;
  588. m_selectedCol = -1;
  589. }
  590. }
  591. }
  592. if (decoder->isOutputTriggerActive(OVP_GD_Algorithm_StimulationDecoder_OutputTriggerId_ReceivedEnd)) { }
  593. boxContext.markInputAsDeprecated(k, i);
  594. }
  595. }
  596. }
  597. // After any possible rendering, we flush the accumulated stimuli. The default idle func is low priority, so it should be run after rendering by gtk.
  598. if (m_idleFuncTag == 0) { m_idleFuncTag = g_idle_add(FlushCB, this); }
  599. return true;
  600. }
  601. // _________________________________________________________________________________________________________________________________________________________
  602. //
  603. void CBoxAlgorithmP300TactileVisualization::cacheBuildFromTable(GtkTable* table)
  604. {
  605. if (table)
  606. {
  607. const GdkColor white = InitGDKColor(65535, 65535, 65535, 65535);
  608. for (GList* list = table->children; list; list = list->next)
  609. {
  610. GtkTableChild* child = static_cast<GtkTableChild*>(list->data);
  611. for (size_t i = child->top_attach; i < child->bottom_attach; ++i)
  612. {
  613. for (size_t j = child->left_attach; j < child->right_attach; ++j)
  614. {
  615. widget_style_t& style = m_cache[i][j];
  616. style.widget = child->widget;
  617. style.childWidget = gtk_bin_get_child(GTK_BIN(child->widget));
  618. style.bgColor = white;
  619. style.fgColor = white;
  620. style.fontDesc = nullptr;
  621. }
  622. }
  623. }
  624. }
  625. }
  626. void CBoxAlgorithmP300TactileVisualization::cacheForEach(const cache_callback callback, void* data)
  627. {
  628. for (auto i = m_cache.begin(); i != m_cache.end(); ++i)
  629. {
  630. for (auto j = i->second.begin(); j != i->second.end(); ++j) { (this->*callback)(j->second, data); }
  631. }
  632. }
  633. void CBoxAlgorithmP300TactileVisualization::cacheForEachIf(const int iLine, const int iColumn, const cache_callback ifCB, const cache_callback elseCB,
  634. void* ifUserData, void* elseUserData)
  635. {
  636. for (auto i = m_cache.begin(); i != m_cache.end(); ++i)
  637. {
  638. for (auto j = i->second.begin(); j != i->second.end(); ++j)
  639. {
  640. const bool line = (iLine != -1);
  641. const bool column = (iColumn != -1);
  642. bool inLine = false;
  643. bool inCol = false;
  644. bool first;
  645. if (line && size_t(iLine) == i->first) { inLine = true; }
  646. if (column && size_t(iColumn) == j->first) { inCol = true; }
  647. if (line && column) { first = inLine && inCol; }
  648. else { first = inLine || inCol; }
  649. if (first) { (this->*ifCB)(j->second, ifUserData); }
  650. else { (this->*elseCB)(j->second, elseUserData); }
  651. }
  652. }
  653. }
  654. void CBoxAlgorithmP300TactileVisualization::cacheChangeNullCB(widget_style_t& /*rWidgetStyle*/, void* /*data*/) { }
  655. void CBoxAlgorithmP300TactileVisualization::cacheChangeBackgroundCB(widget_style_t& style, void* data)
  656. {
  657. GdkColor oColor = *static_cast<GdkColor*>(data);
  658. if (memcmp(&style.bgColor, &oColor, sizeof(GdkColor)) != 0)
  659. {
  660. gtk_widget_modify_bg(style.widget, GTK_STATE_NORMAL, &oColor);
  661. style.bgColor = oColor;
  662. }
  663. }
  664. void CBoxAlgorithmP300TactileVisualization::cacheChangeForegroundCB(widget_style_t& style, void* data)
  665. {
  666. GdkColor oColor = *static_cast<GdkColor*>(data);
  667. if (memcmp(&style.fgColor, &oColor, sizeof(GdkColor)) != 0)
  668. {
  669. gtk_widget_modify_fg(style.childWidget, GTK_STATE_NORMAL, &oColor);
  670. style.fgColor = oColor;
  671. }
  672. }
  673. void CBoxAlgorithmP300TactileVisualization::cacheChangeFontCB(widget_style_t& style, void* data)
  674. {
  675. auto* pFontDescription = static_cast<PangoFontDescription*>(data);
  676. if (style.fontDesc != pFontDescription)
  677. {
  678. gtk_widget_modify_font(style.childWidget, pFontDescription);
  679. style.fontDesc = pFontDescription;
  680. }
  681. }
  682. void CBoxAlgorithmP300TactileVisualization::cacheCollectWidgetCB(widget_style_t& style, void* data)
  683. {
  684. if (data) { (static_cast<std::vector<GtkWidget*>*>(data))->push_back(style.widget); }
  685. }
  686. void CBoxAlgorithmP300TactileVisualization::cacheCollectChildWidgetCB(widget_style_t& style, void* data)
  687. {
  688. if (data) { (static_cast<std::vector<GtkWidget*>*>(data))->push_back(style.childWidget); }
  689. }
  690. // Note that we don't need concurrency control here as gtk callbacks run in the main thread
  691. void CBoxAlgorithmP300TactileVisualization::flushQueue()
  692. {
  693. for (const auto& stimulation : m_stimuliQueue) { m_stimulusSender->sendStimulation(stimulation); }
  694. m_stimuliQueue.clear();
  695. // This function will be automatically removed after completion, so set to 0
  696. m_idleFuncTag = 0;
  697. }
  698. } // namespace Tactilebci
  699. } // namespace Plugins
  700. } // namespace OpenViBE