LUMIERA.clone/tests/core/steam/play/output-slot-protocol-test.cpp
Ichthyostega 806db414dd Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00

131 lines
4.4 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
OutputSlotProtocol(Test) - covering the basic usage cycle of an output slot
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 output-slot-protocol-test.cpp
** unit test \ref OutputSlotProtocol_test
*/
#include "lib/test/run.hpp"
#include "steam/play/diagnostic-output-slot.hpp"
#include "steam/engine/buffhandle.hpp"
#include "steam/engine/buffhandle-attach.hpp"
#include "steam/engine/testframe.hpp"
namespace steam {
namespace play {
namespace test {
using steam::engine::BuffHandle;
using steam::engine::test::testData;
using steam::engine::test::TestFrame;
/***************************************************************//**
* @test verify the OutputSlot interface and base implementation
* by performing full data exchange cycle. This is a
* kind of "dry run" for documentation purposes,
* both the actual OutputSlot implementation
* as the client using this slot are Mocks.
*/
class OutputSlotProtocol_test : public Test
{
virtual void
run (Arg)
{
verifyStandardCase();
}
void
verifyStandardCase()
{
// Create Test fixture.
// In real usage, the OutputSlot will be preconfigured
// (Media format, number of channels, physical connections)
// and then registered with / retrieved from an OutputManager
OutputSlot& oSlot = DiagnosticOutputSlot::build();
// Client claims the OutputSlot
// and opens it for exclusive use.
OutputSlot::Allocation& alloc = oSlot.allocate();
// Now the client is able to prepare
// "calculation streams" for the individual
// Channels to be output through this slot.
OutputSlot::OpenedSinks sinks = alloc.getOpenedSinks();
DataSink sink1 = *sinks;
DataSink sink2 = *++sinks;
// within the frame-calculation "loop"
// we perform a data exchange cycle
FrameCnt frameNr = 123;
BuffHandle buff00 = sink1.lockBufferFor (frameNr);
BuffHandle buff10 = sink2.lockBufferFor (frameNr);
// rendering process calculates content....
buff00.accessAs<TestFrame>() = testData(0,0);
// while further frames might be processed in parallel
BuffHandle buff11 = sink2.lockBufferFor (++frameNr);
buff11.accessAs<TestFrame>() = testData(1,1);
buff10.accessAs<TestFrame>() = testData(1,0);
// Now it's time to emit the output
sink2.emit (frameNr-1, buff10);
sink2.emit (frameNr , buff11);
sink1.emit (frameNr-1, buff00);
// that's all for the client
// Verify sane operation....
DiagnosticOutputSlot& checker = DiagnosticOutputSlot::access(oSlot);
CHECK ( checker.frame_was_allocated (0,123));
CHECK (!checker.frame_was_allocated (0,124));
CHECK ( checker.frame_was_allocated (1,123));
CHECK ( checker.frame_was_allocated (1,124));
CHECK (checker.output_was_closed (0,0));
CHECK (checker.output_was_closed (1,0));
CHECK (checker.output_was_closed (1,1));
CHECK ( checker.output_was_emitted (0,0));
CHECK (!checker.output_was_emitted (0,1));
CHECK ( checker.output_was_emitted (1,0));
CHECK ( checker.output_was_emitted (1,1));
DiagnosticOutputSlot::OutFrames stream0 = checker.getChannel(0);
DiagnosticOutputSlot::OutFrames stream1 = checker.getChannel(1);
CHECK ( stream0);
CHECK (*stream0 == testData(0,0)); ++stream0;
CHECK (!stream0);
CHECK ( stream1);
CHECK (*stream1 == testData(1,0)); ++stream1;
CHECK (*stream1 == testData(1,1)); ++stream1;
CHECK (!stream1);
}
};
/** Register this test class... */
LAUNCHER (OutputSlotProtocol_test, "unit play");
}}} // namespace steam::play::test