LUMIERA.clone/tests/core/steam/engine/test-rand-ontology.hpp

/*
  TEST-RAND-ONTOLOGY.hpp  -  placeholder for a domain-ontology working on dummy data frames

  Copyright (C)         Lumiera.org
    2024,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

/** @file test-rand-ontology.hpp
 ** A faked »media calculation« environment to validate the render node network.
 */


#ifndef STEAM_ENGINE_TEST_RAND_ONTOLOGY_H
#define STEAM_ENGINE_TEST_RAND_ONTOLOGY_H


#include "lib/error.hpp"
#include "lib/depend.hpp"
#include "steam/engine/testframe.hpp"

#include <array>
#include <string>


namespace steam {
namespace engine{
namespace test  {
  
  using std::string;
  
  /** produce sequences of frames with (reproducible) random data */
  void generateFrame (TestFrame* buff, size_t frameNr, uint flavour);
  
  /** produce planar multi channel output of random data frames */
  void generateMultichan (uint chanCnt, TestFrame* buffArry, size_t frameNr, uint flavour);
  
  /** »process« random frame date by multiply-wrapping with a parameter */
  void manipulateFrame (TestFrame* out, TestFrame* in, int param);
  
  /** mix two random data frames by a parameter-controlled proportion */
  void combineFrames (TestFrame* out, TestFrame* srcA, TestFrame* srcB, int mix);
  


/////////////////////////////////////////////////////////////////////////////////////////////////////////////TICKET #1367 : Dummy / Placeholder
  using NoArg   = std::array<char*, 0>;
  using SoloArg = std::array<char*, 1>;
  
  extern const string DUMMY_FUN_ID;
  
  /** @todo a placeholder operation to wire a prototypical render node
   */
  inline void
  dummyOp (NoArg in, SoloArg out)
  {
    UNIMPLEMENTED ("a sincerely nonsensical operation");
  }
/////////////////////////////////////////////////////////////////////////////////////////////////////////////TICKET #1367 : Dummy / Placeholder
  /**
   * A fake _Domain Ontology_ to describe mocked »render operations« on
   * dummy data frames filled with random numbers.
   * 
   * @see TestFrame_test
   * @see NodeDevel_test
   * @see NodeLinkage_test
   * 
   */
  class TestRandOntology
    {
      
    public:
     ~TestRandOntology()  = default;
      TestRandOntology()  = default;
      
    private:
    };
  
  
  
  /** */
  
  
  
}}} // namespace steam::engine::test
#endif