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.

Doc_BoxAlgorithm_StreamedMatrixMultiplexer.dox-part 3.0KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. /**
  2. * \page BoxAlgorithm_StreamedMatrixMultiplexer Streamed matrix multiplexer
  3. __________________________________________________________________
  4. Detailed description
  5. __________________________________________________________________
  6. * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Description|
  7. * This box multiplexes streamed matrix stream on a low level basis (at the EBML stream level actually).
  8. * This means the box sorts the different buffers received from its inputs and sends all of them
  9. * on its output. For correct results, this supposes the inputs have "homogeneous content" in the sense that
  10. * they should have e.g. the same number of channels, in the same order, the same number of samples per buffer etc...
  11. *
  12. * This box is usually used after an epoching related split in the pipeline, when you want to process the signals
  13. * in a similar manner for a similar purpose. This actually joins the pipelines in only one, dropping the need
  14. * to edit and execute similar boxes.
  15. *
  16. * \b Warning: this box is usually misused and used in place of a \ref Doc_BoxAlgorithm_SignalMerger box.
  17. * Please consider reading this documentation twice, and maybe read the \ref Doc_BoxAlgorithm_SignalMerger
  18. * documentation once again as well :)
  19. * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Description|
  20. __________________________________________________________________
  21. Inputs description
  22. __________________________________________________________________
  23. * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Inputs|
  24. * You can add as many input as you want.
  25. * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Inputs|
  26. * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Input1|
  27. * The first input stream.
  28. * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Input1|
  29. * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Input2|
  30. * The second input stream.
  31. * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Input2|
  32. __________________________________________________________________
  33. Outputs description
  34. __________________________________________________________________
  35. * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Outputs|
  36. * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Outputs|
  37. * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Output1|
  38. * The output stream takes the header of the first stream and then sends buffers of the
  39. * different input streams in a sorted way.
  40. * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Output1|
  41. __________________________________________________________________
  42. Examples description
  43. __________________________________________________________________
  44. * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Examples|
  45. * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Examples|
  46. __________________________________________________________________
  47. Miscellaneous description
  48. __________________________________________________________________
  49. * |OVP_DocBegin_BoxAlgorithm_StreamedMatrixMultiplexer_Miscellaneous|
  50. * |OVP_DocEnd_BoxAlgorithm_StreamedMatrixMultiplexer_Miscellaneous|
  51. */