init

2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,66 @@
+/**
+ * \page BoxAlgorithm_SignalMerger Signal Merger
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Description|
+ * This box merges several input streams in a single output stream. For instance,
+ * if this box has two inputs with 8 channels each, the output will contain 16 channels.
+ *
+ * It important to note that the input streams must have the same structure. That is
+ * same sampling rate, same number of samples per buffer, and similar chunks dates.
+ *
+ * The output channel order is as follows :
+ *  - n channels from input 1 (in the same order as in input 1)
+ *  - m channels from input 2
+ *  - ...
+ *  - p channels from input N
+ *
+ * Such box has initially been proposed by Matthieu Goyat and Guillaume Lio but it
+ * has been completely reimplemented in march 2011 because of unpredictable behaviors in
+ * some conditions.
+ * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Inputs|
+ * This box can receive as many inputs as necessary.
+ * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Inputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Input1|
+ * The first input stream.
+ * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Input1|
+
+ * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Input2|
+ * The second input stream.
+ * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Input2|
+__________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Outputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Output1|
+ * The output stream contains all the channels grabbed from the different input streams.
+ * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Output1|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Examples|
+ * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_SignalMerger_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_SignalMerger_Miscellaneous|
+ */
@@ -0,0 +1,64 @@
+/**
+ * \page BoxAlgorithm_StreamedMatrixMultiplexer Streamed matrix multiplexer
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Description|
+ * This box multiplexes streamed matrix stream on a low level basis (at the EBML stream level actually).
+ * This means the box sorts the different buffers received from its inputs and sends all of them
+ * on its output. For correct results, this supposes the inputs have "homogeneous content" in the sense that
+ * they should have e.g. the same number of channels, in the same order, the same number of samples per buffer etc...
+ *
+ * This box is usually used after an epoching related split in the pipeline, when you want to process the signals
+ * in a similar manner for a similar purpose. This actually joins the pipelines in only one, dropping the need
+ * to edit and execute similar boxes.
+ *
+ * \b Warning: this box is usually misused and used in place of a \ref Doc_BoxAlgorithm_SignalMerger box.
+ * Please consider reading this documentation twice, and maybe read the \ref Doc_BoxAlgorithm_SignalMerger
+ * documentation once again as well :)
+ * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Inputs|
+ * You can add as many input as you want.
+ * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Inputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Input1|
+ * The first input stream.
+ * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Input1|
+
+ * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Input2|
+ * The second input stream.
+ * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Input2|
+__________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Outputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Output1|
+ * The output stream takes the header of the first stream and then sends buffers of the
+ * different input streams in a sorted way.
+ * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Output1|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Examples|
+ * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Miscellaneous|
+ */
@@ -0,0 +1,66 @@
+.. _Doc_BoxAlgorithm_SignalMerger:
+
+Signal Merger
+=============
+
+.. container:: attribution
+
+   :Author:
+      Yann Renard
+   :Company:
+      INRIA
+
+.. image:: images/Doc_BoxAlgorithm_SignalMerger.png
+
+This box merges several input streams in a single output stream. For instance,
+if this box has two inputs with 8 channels each, the output will contain 16 channels.
+
+It important to note that the input streams must have the same structure. That is
+same sampling rate, same number of samples per buffer, and similar chunks dates.
+
+The output channel order is as follows :
+
+- n channels from input 1 (in the same order as in input 1)
+- m channels from input 2
+- ...
+- p channels from input N
+
+
+Such box has initially been proposed by Matthieu Goyat and Guillaume Lio but it
+has been completely reimplemented in march 2011 because of unpredictable behaviors in
+some conditions.
+
+Inputs
+------
+
+.. csv-table::
+   :header: "Input Name", "Stream Type"
+
+   "Input 1", "Signal"
+   "Input 2", "Signal"
+
+This box can receive as many inputs as necessary.
+
+Input 1
+~~~~~~~
+
+The first input stream.
+
+Input 2
+~~~~~~~
+
+The second input stream.
+
+Outputs
+-------
+
+.. csv-table::
+   :header: "Output Name", "Stream Type"
+
+   "Merged", "Signal"
+
+Merged
+~~~~~~
+
+The output stream contains all the channels grabbed from the different input streams.
+
@@ -0,0 +1,62 @@
+.. _Doc_BoxAlgorithm_StreamedMatrixMultiplexer:
+
+Streamed matrix multiplexer
+===========================
+
+.. container:: attribution
+
+   :Author:
+      Yann Renard
+   :Company:
+      INRIA/IRISA
+
+.. image:: images/Doc_BoxAlgorithm_StreamedMatrixMultiplexer.png
+
+This box multiplexes streamed matrix stream on a low level basis (at the EBML stream level actually).
+This means the box sorts the different buffers received from its inputs and sends all of them
+on its output. For correct results, this supposes the inputs have "homogeneous content" in the sense that
+they should have e.g. the same number of channels, in the same order, the same number of samples per buffer etc...
+
+This box is usually used after an epoching related split in the pipeline, when you want to process the signals
+in a similar manner for a similar purpose. This actually joins the pipelines in only one, dropping the need
+to edit and execute similar boxes.
+
+**Warning:** this box is usually misused and used in place of a :ref:`Doc_BoxAlgorithm_SignalMerger` box.
+Please consider reading this documentation twice, and maybe read the :ref:`Doc_BoxAlgorithm_SignalMerger`
+documentation once again as well :)
+
+Inputs
+------
+
+.. csv-table::
+   :header: "Input Name", "Stream Type"
+
+   "Input stream 1", "Streamed matrix"
+   "Input stream 2", "Streamed matrix"
+
+You can add as many input as you want.
+
+Input stream 1
+~~~~~~~~~~~~~~
+
+The first input stream.
+
+Input stream 2
+~~~~~~~~~~~~~~
+
+The second input stream.
+
+Outputs
+-------
+
+.. csv-table::
+   :header: "Output Name", "Stream Type"
+
+   "Multiplexed streamed matrix", "Streamed matrix"
+
+Multiplexed streamed matrix
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The output stream takes the header of the first stream and then sends buffers of the
+different input streams in a sorted way.
+