init

2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,76 @@
+/**
+ * \page BoxAlgorithm_HelloBidirectionnalGames Hello Bidirectionnal Games
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloBidirectionnalGames_Description|
+This box forwards the signals and stimulations it gets to two corresponding LabStreamingLayer (LSL) streams and receive back The size of cube in game and a Beep Stimulation from the Unity Game. 
+
+This stream can be read by the Unity Games Hello Bidirectionnal here : https://gitlab.inria.fr/openvibe/unity-games/hello-bidirectionnal
+
+Remarks : It is recommanded to run the Unity App Before to avoid "too big" lag in OpenViBE with continuous search of stream. Unity can support that easily.
+
+ * |OVP_DocEnd_BoxAlgorithm_HelloBidirectionnalGames_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloBidirectionnalGames_Inputs|
+ * |OVP_DocEnd_BoxAlgorithm_HelloBidirectionnalGames_Inputs|
+ *
+ * |OVP_DocBegin_BoxAlgorithm_HelloBidirectionnalGames_Input1|
+The signal input stream.
+ * |OVP_DocEnd_BoxAlgorithm_HelloBidirectionnalGames_Input1|
+ 
+ * |OVP_DocBegin_BoxAlgorithm_HelloBidirectionnalGames_Input2|
+The stimulation input stream.
+ * |OVP_DocEnd_BoxAlgorithm_HelloBidirectionnalGames_Input2|
+ __________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Outputs|
+ *
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Output1|
+The size of the Cube in Unity App.
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Output1|
+ 
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Output2|
+The Beep stimulation from the Unity App.
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Output2|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloBidirectionnalGames_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_HelloBidirectionnalGames_Settings|
+ *
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloBidirectionnalGames_Examples|
+Easiest way to test the box is to use a time signal box with a simple DSP sin(x) and a Clock Stimulation with stimulation `OVTK_StimulationId_Label_00` for inputs and just a display matrix and a stimulation listener for output.  
+Run the Game, next run the Scenario.
+ * |OVP_DocEnd_BoxAlgorithm_HelloBidirectionnalGames_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloBidirectionnalGames_Miscellaneous|
+The box creates each LSL stream at the beginning of the playback, after it has received its corresponding OpenViBE stream header information. Hence, if either signal or stimulus socket 
+of the box is not connected or does not receive a header, the box will not create the corresponding LSL stream.
+The reception LSL streams are searched during each process to create inlet when stream are available. 
+
+Stream formats: The signal stream is continuous float. The stimulation stream is noncontinuous int, and each 64bit OpenViBE stimulation is truncated to an int marker.
+
+ * |OVP_DocEnd_BoxAlgorithm_HelloBidirectionnalGames_Miscellaneous|
+ */
@@ -0,0 +1,62 @@
+/**
+ * \page BoxAlgorithm_HelloSenderGames Hello Sender Games
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Description|
+This box receives the signals and stimulations it gets from two corresponding LabStreamingLayer (LSL) streams. 
+
+These streams can be read by the Unity Games Hello Sender here : https://gitlab.inria.fr/openvibe/unity-games/hello-sender
+
+Remarks : It is currently impossible to send and receive information by LSL in the same scenario. 
+Indeed, the LSL library waits to receive its flow (or gives up) before moving on. In addition, OpenViBE is not multi-process. 
+It blocks until it has received its flow (or gives up).
+It is therefore advisable to launch the transmitter before the receiver or plan for a shorter but repeated stream search after launch in the event of a startup failure.
+
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Description|
+__________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Outputs|
+ *
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Output1|
+The matrix output stream.
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Output1|
+ 
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Output2|
+The stimulation output stream.
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Output2|
+ 
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Settings|
+ *
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Examples|
+Run the Game, next run the Scenario.
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloSenderGames_Miscellaneous|
+The box creates each LSL stream at the beginning of the playback, the Process is stopped until available stream are found.
+
+Stream formats: The matrix stream is noncontinuous float. The stimulation stream is noncontinuous int.
+
+ * |OVP_DocEnd_BoxAlgorithm_HelloSenderGames_Miscellaneous|
+ */
@@ -0,0 +1,64 @@
+/**
+ * \page BoxAlgorithm_HelloWorldGames Hello World Games
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Description|
+This box forwards the signals and stimulations it gets to two corresponding LabStreamingLayer (LSL) streams. 
+
+This stream can be read by the Unity Games Hello World here : https://gitlab.inria.fr/openvibe/unity-games/hello-world
+
+Remarks : It is currently impossible to send and receive information by LSL in the same scenario. 
+Indeed, the LSL library waits to receive its flow (or gives up) before moving on. In addition, OpenViBE is not multi-process. 
+It blocks until it has received its flow (or gives up).
+It is therefore advisable to launch the transmitter before the receiver.
+Or plan for a shorter but repeated stream search after launch in the event of a startup failure.
+
+ * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Inputs|
+ * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Inputs|
+ *
+ * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Input1|
+The signal input stream.
+ * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Input1|
+ 
+ * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Input2|
+The stimulation input stream.
+ * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Input2|
+ 
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Settings|
+ *
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Examples|
+Easiest way to test the box is to use a time signal box with a simple DSP sin(x) and a Clock Stimulation with stimulation `OVTK_StimulationId_Label_00`. Run the Scenario, next run the Game.
+ * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Miscellaneous|
+The box creates each LSL stream at the beginning of the playback, after it has received its corresponding OpenViBE stream header information. Hence, if either signal or stimulus socket 
+of the box is not connected or does not receive a header, the box will not create the corresponding LSL stream.
+
+Stream formats: The signal stream is continuous float. The stimulation stream is noncontinuous int, and each 64bit OpenViBE stimulation is truncated to an int marker.
+
+ * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Miscellaneous|
+ */