Ichthyostega
4ca9eb8d46
Based on the recent work it is now possible to generate reproducible yet randomly distributed data content. A new `TestFrame::reseed()` operation is introduced, which attaches to the `lib::defaultGen` Using the linear-congruential engine for the actual data generation.
123 lines
4.1 KiB
C++
123 lines
4.1 KiB
C++
/*
|
||
TESTFRAME.hpp - test data frame (stub) for checking Render engine functionality
|
||
|
||
Copyright (C)
|
||
2011, Hermann Vosseler <Ichthyostega@web.de>
|
||
|
||
**Lumiera** 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. See the file COPYING for further details.
|
||
|
||
*/
|
||
|
||
/** @file testframe.hpp
|
||
** Unit test helper to generate fake test data frames
|
||
*/
|
||
|
||
|
||
#ifndef STEAM_ENGINE_TESTFRAME_H
|
||
#define STEAM_ENGINE_TESTFRAME_H
|
||
|
||
|
||
#include "lib/integral.hpp"
|
||
#include "lib/hash-value.h"
|
||
|
||
#include <array>
|
||
|
||
|
||
namespace steam {
|
||
namespace engine {
|
||
namespace test {
|
||
|
||
|
||
/**
|
||
* Mock data frame for simulated rendering.
|
||
* A test frame can be created and placed instead of a real data frame.
|
||
* It doesn't depend on any external libraries and will be self-maintaining.
|
||
* Placeholder functions are provided for assignment (simulating the actual
|
||
* calculations); additional diagnostic functions allow to verify the
|
||
* performed operations after-the fact
|
||
*
|
||
* Each TestFrame is automatically filled with pseudo random data;
|
||
* multiple frames are arranged in sequences and channels, causing the random data
|
||
* to be reproducible yet different within each frame. TestFrame's lifecycle is
|
||
* tracked and marked in an embedded state field. Moreover, the contents of the
|
||
* data block can be verified, because the sequence of bytes is reproducible,
|
||
* based on the channel and sequence number of the test frame.
|
||
*
|
||
* @see TestFrame_test
|
||
* @see OutputSlotProtocol_test
|
||
*
|
||
*/
|
||
class TestFrame
|
||
{
|
||
enum StageOfLife {
|
||
CREATED, EMITTED, DISCARDED
|
||
};
|
||
|
||
static constexpr size_t BUFFSIZ = 1024;
|
||
using _Arr = std::array<char,BUFFSIZ>;
|
||
|
||
uint64_t distinction_;
|
||
StageOfLife stage_;
|
||
|
||
/** inline storage buffer for the payload media data */
|
||
alignas(uint64_t)
|
||
std::byte buffer_[sizeof(_Arr)];
|
||
|
||
public:
|
||
/** discard all cached #testData and recalibrate data generation */
|
||
static void reseed();
|
||
|
||
~TestFrame();
|
||
TestFrame (uint seq=0, uint family=0);
|
||
TestFrame (TestFrame const&);
|
||
TestFrame& operator= (TestFrame const&);
|
||
|
||
/** Helper to verify that a given memory location holds
|
||
* an active TestFrame instance (created, not yet destroyed)
|
||
* @return true if the TestFrame datastructure is intact and
|
||
* marked as still alive.
|
||
*/
|
||
static bool isAlive (void* memLocation);
|
||
|
||
/** Helper to verify a given memory location holds
|
||
* an already destroyed TestFrame instance */
|
||
static bool isDead (void* memLocation);
|
||
|
||
bool isAlive() const;
|
||
bool isDead() const;
|
||
bool isSane() const;
|
||
|
||
bool operator== (void* memLocation) const;
|
||
|
||
friend bool operator== (TestFrame const& f1, TestFrame const& f2) { return f1.contentEquals(f2); }
|
||
friend bool operator!= (TestFrame const& f1, TestFrame const& f2) { return !f1.contentEquals(f2); }
|
||
|
||
/** Array-style direct access to the payload data */
|
||
_Arr& data() { return * std::launder (reinterpret_cast<_Arr* > (&buffer_)); }
|
||
_Arr const& data() const { return * std::launder (reinterpret_cast<_Arr const*> (&buffer_)); }
|
||
|
||
private:
|
||
bool contentEquals (TestFrame const& o) const;
|
||
bool verifyData() const;
|
||
void buildData ();
|
||
};
|
||
|
||
|
||
|
||
/** Helper to access a specific frame of test data at a fixed memory location.
|
||
* The series of test frames is generated on demand, but remains in memory thereafter,
|
||
* similar to real data accessible from some kind of source stream. Each of these generated
|
||
* test frames filled with different yet reproducible pseudo random data.
|
||
* Client code is free to access and corrupt this data.
|
||
*/
|
||
TestFrame& testData (uint seqNr);
|
||
|
||
TestFrame& testData (uint chanNr, uint seqNr);
|
||
|
||
|
||
|
||
}}} // namespace steam::engine::test
|
||
#endif
|