383 lines
14 KiB
C++
383 lines
14 KiB
C++
/*
|
||
MObjectRef(Test) - validating basic properties of the external MObject reference tag
|
||
|
||
Copyright (C)
|
||
2009, 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 mobject-ref-test.cpp
|
||
** unit test \ref MObjectRef_test
|
||
*/
|
||
|
||
|
||
#include "lib/test/run.hpp"
|
||
#include "steam/asset/media.hpp"
|
||
#include "steam/mobject/mobject.hpp"
|
||
#include "steam/mobject/mobject-ref.hpp"
|
||
#include "steam/mobject/placement.hpp"
|
||
#include "steam/mobject/placement-ref.hpp"
|
||
#include "steam/mobject/session/placement-index.hpp"
|
||
#include "steam/mobject/session/session-service-mock-index.hpp"
|
||
#include "steam/mobject/session/clip.hpp"
|
||
#include "steam/mobject/explicitplacement.hpp"
|
||
#include "steam/mobject/test-dummy-mobject.hpp"
|
||
#include "vault/media-access-mock.hpp"
|
||
#include "lib/depend-inject.hpp"
|
||
#include "lib/test/test-helper.hpp"
|
||
#include "lib/time/timevalue.hpp"
|
||
#include "lib/format-cout.hpp"
|
||
#include "lib/util.hpp"
|
||
|
||
#include <string>
|
||
|
||
using lib::test::showSizeof;
|
||
using lib::time::Duration;
|
||
using lib::time::FSecs;
|
||
using lib::time::Time;
|
||
using util::isnil;
|
||
using std::string;
|
||
|
||
|
||
namespace steam {
|
||
namespace mobject {
|
||
namespace test {
|
||
|
||
namespace { // shortcut for checking use-counts
|
||
|
||
bool
|
||
checkUseCount (size_t cnt, uint additional=0)
|
||
{
|
||
static uint base_count=0;
|
||
if (!additional) // called for init
|
||
base_count = cnt;
|
||
|
||
return cnt == base_count + additional;
|
||
}
|
||
|
||
template<class REF>
|
||
bool
|
||
checkUseCount (REF const& ref, uint additional)
|
||
{
|
||
return checkUseCount(ref.use_count(), additional);
|
||
}
|
||
}
|
||
|
||
|
||
using LERR_(INVALID_PLACEMENTREF);
|
||
using LERR_(BOTTOM_MOBJECTREF);
|
||
|
||
using session::Clip;
|
||
using session::PMedia;
|
||
|
||
using session::SessionServiceMockIndex;
|
||
using session::PPIdx;
|
||
|
||
using MediaAccessMock = lib::DependInject<vault::MediaAccessFacade>
|
||
::Local<vault::test::MediaAccessMock>;
|
||
|
||
|
||
|
||
/***********************************************************************//**
|
||
* @test properties and behaviour of the external reference-mechanism for
|
||
* MObjects placed into the session. We create a simple, simulated
|
||
* "session" (no real session datastructure) and a mock PlacementIndex.
|
||
* Then we add two Placements, which can be used then to build
|
||
* MObjectRef instances to validate their behaviour.
|
||
* @see mobject::Placement
|
||
* @see mobject::MObject
|
||
* @see mobject::PlacementRef_test
|
||
*/
|
||
class MObjectRef_test : public Test
|
||
{
|
||
|
||
typedef Placement<MObject> PMObj;
|
||
typedef Placement<Clip> PClip;
|
||
typedef TestPlacement<TestSubMO1> PSub1;
|
||
|
||
|
||
virtual void
|
||
run (Arg)
|
||
{
|
||
MediaAccessMock useMockMedia;
|
||
|
||
|
||
// create data simulating a "Session"
|
||
PMObj testClip1 = asset::Media::create("test-1", asset::VIDEO)->createClip();
|
||
PMObj testClip2 = asset::Media::create("test-2", asset::VIDEO)->createClip();
|
||
|
||
// set up a tie to fixed start positions (i.e. "properties of placement")
|
||
testClip1.chain (Time(FSecs(10)));
|
||
testClip2.chain (Time(FSecs(20)));
|
||
|
||
CHECK (testClip1->isValid());
|
||
CHECK (testClip2->isValid());
|
||
CHECK (2 == testClip1.use_count()); // one by the placement and one by the clip-Asset
|
||
CHECK (2 == testClip2.use_count());
|
||
|
||
|
||
// Prepare an (test)Index
|
||
PPIdx index = SessionServiceMockIndex::install();
|
||
PMO& root = index->getRoot();
|
||
|
||
// Add the Clips to "session" (here: dummy index)
|
||
PMObj::ID clip1ID = index->insert (testClip1, root);
|
||
PMObj::ID clip2ID = index->insert (testClip2, root);
|
||
CHECK (2 == index->size());
|
||
|
||
// use the IDs returned on insertion to fetch
|
||
// language references to the placement instance within the index
|
||
// we'll use these language refs as base to create MObejctRef handles.
|
||
PMObj& pClip1 = index->find(clip1ID);
|
||
PMObj& pClip2 = index->find(clip2ID);
|
||
|
||
CHECK (3 == pClip1.use_count()); // clip-Asset, original placement, new placement in index
|
||
CHECK (3 == pClip2.use_count());
|
||
checkUseCount(pClip1.use_count()); // set ref point for later checks
|
||
|
||
// extract various kinds of IDs and refs
|
||
PMObj & rP1 (pClip1);
|
||
PMObj const& rP2 (pClip2);
|
||
PMObj::ID id1 = pClip1.getID();
|
||
PMObj::Id<Clip> id2 = pClip2.recastID<Clip>(); // explicit unchecked re-declaration of target type
|
||
LumieraUid luid = id1.get();
|
||
///////////////////////////////////////////TODO: check the C-API representation here
|
||
PlacementRef<Clip> ref1 (id1);
|
||
PlacementRef<MObject> ref2 (pClip2);
|
||
|
||
|
||
// -----Tests------------------
|
||
checkBuildMObjectRef (rP1, &pClip1);
|
||
checkBuildMObjectRef (rP2, &pClip2);
|
||
checkBuildMObjectRef (id1, &pClip1);
|
||
checkBuildMObjectRef (id2, &pClip2);
|
||
checkBuildMObjectRef (luid, &pClip1);
|
||
///////////////////////////////////////////TODO: check the C-API representation here
|
||
checkBuildMObjectRef (ref1, &pClip1);
|
||
checkBuildMObjectRef (ref2, &pClip2);
|
||
|
||
checkComparison(rP1,rP2);
|
||
checkLifecycle (rP1,rP2);
|
||
checkTypeHandling (luid);
|
||
// -----Tests------------------
|
||
|
||
// verify clean state
|
||
index->remove (pClip1);
|
||
index->remove (pClip2); // note: this invalidates pClip1 and pClip2;
|
||
CHECK (!ref1);
|
||
CHECK (!ref2);
|
||
CHECK (0 == index->size());
|
||
CHECK (1 == index.use_count());
|
||
CHECK (2 == testClip1.use_count());
|
||
CHECK (2 == testClip2.use_count());
|
||
index.reset();
|
||
}
|
||
|
||
|
||
|
||
template<typename REF>
|
||
void
|
||
checkBuildMObjectRef (REF& refObj, void* placementAdr)
|
||
{
|
||
MORef<Clip> rMO;
|
||
CHECK (!rMO); // still empty (not bound)
|
||
CHECK (0==rMO.use_count());
|
||
cout << rMO << endl; /////////////////////TICKET #527
|
||
cout << showSizeof(rMO) << endl;
|
||
|
||
// activate by binding to provided ref
|
||
rMO.activate(refObj);
|
||
CHECK (rMO); // now bound
|
||
cout << rMO << endl; /////////////////////TICKET #527
|
||
|
||
// access MObject (Clip API)
|
||
// cout << rMO->operator string() << endl; /////////////////////TICKET #428
|
||
PMedia media = rMO->getMedia();
|
||
cout << media << endl; /////////////////////TICKET #520
|
||
Duration mediaLength = media->getLength();
|
||
CHECK (!isnil (mediaLength));
|
||
CHECK (rMO->isValid());
|
||
|
||
// access the Placement-API
|
||
CHECK (checkUseCount(rMO, 1)); // now rMO shares ownership with the Placement --> use-count += 1
|
||
CHECK (Time::ZERO < rMO.getStartTime()); // (internally, this resolves to an ExplicitPlacement) /////////TICKET #332
|
||
CHECK ( rMO.isCompatible<MObject>());
|
||
CHECK ( rMO.isCompatible<Clip>());
|
||
CHECK (!rMO.isCompatible<TestSubMO1>());
|
||
Time start = rMO.getStartTime();
|
||
|
||
// re-link to the Placement (note we get the Clip API!)
|
||
Placement<Clip> & refP = rMO.getPlacement();
|
||
CHECK (refP.isValid());
|
||
CHECK (refP.use_count() == rMO.use_count());
|
||
CHECK (checkUseCount(refP, 1)); // use count not changed
|
||
CHECK (&refP == placementAdr); // actually denotes the address of the original Placement in the "session"
|
||
cout << refP << endl;
|
||
|
||
ExplicitPlacement exPla = refP.resolve();
|
||
CHECK (exPla.time == start); // recovered Placement resolves to the same time as provided by the proxied API
|
||
CHECK (checkUseCount(refP, 2)); // but now we've indeed created an additional owner (exPla)
|
||
CHECK (checkUseCount(rMO, 2));
|
||
}
|
||
|
||
|
||
void
|
||
checkComparison (PMO const& p1, PMO const& p2)
|
||
{
|
||
PlacementRef<Clip> pRef1 (p1);
|
||
PlacementRef<MObject> pRef2 (p2);
|
||
|
||
MORef<MObject> rM;
|
||
MORef<Clip> rC;
|
||
|
||
rM.activate (p1);
|
||
rC.activate (p2);
|
||
CHECK (rM and rC);
|
||
CHECK (!(rM == rC) and !(rC == rM));
|
||
CHECK ( (rM != rC) and (rC != rM));
|
||
|
||
// mixed comparisons
|
||
CHECK ( (rM == pRef1) and (pRef1 == rM));
|
||
CHECK ( (rC == pRef2) and (pRef2 == rC));
|
||
CHECK (!(rM != pRef1) and !(pRef1 != rM));
|
||
CHECK (!(rC != pRef2) and !(pRef2 != rC));
|
||
CHECK ( (rM != pRef2) and (pRef2 != rM));
|
||
CHECK ( (rC != pRef1) and (pRef1 != rC));
|
||
CHECK (!(rM == pRef2) and !(pRef2 == rM));
|
||
CHECK (!(rC == pRef1) and !(pRef1 == rC));
|
||
|
||
CHECK ( (rM == p1.getID()) );
|
||
CHECK ( (rC == p2.getID()) );
|
||
CHECK (!(rM != p1.getID()) );
|
||
CHECK (!(rC != p2.getID()) );
|
||
CHECK ( (rM != p2.getID()) );
|
||
CHECK ( (rC != p1.getID()) );
|
||
CHECK (!(rM == p2.getID()) );
|
||
CHECK (!(rC == p1.getID()) );
|
||
|
||
|
||
rC.activate (pRef1);
|
||
CHECK ( (rM == rC) and (rC == rM));
|
||
CHECK (!(rM != rC) and !(rC != rM));
|
||
|
||
CHECK ( (rC == pRef1) and (pRef1 == rC));
|
||
CHECK (!(rC != pRef1) and !(pRef1 != rC));
|
||
CHECK ( (rC != pRef2) and (pRef2 != rC));
|
||
CHECK (!(rC == pRef2) and !(pRef2 == rC));
|
||
|
||
CHECK ( (rC == p1.getID()) );
|
||
CHECK (!(rC != p1.getID()) );
|
||
CHECK ( (rC != p2.getID()) );
|
||
CHECK (!(rC == p2.getID()) );
|
||
|
||
|
||
rM.close();
|
||
CHECK (!rM);
|
||
CHECK (!(rM == rC) and !(rC == rM));
|
||
CHECK ( (rM != rC) and (rC != rM));
|
||
|
||
CHECK (!(rM == pRef1) and !(pRef1 == rM));
|
||
CHECK ( (rM != pRef1) and (pRef1 != rM));
|
||
CHECK ( (rM != pRef2) and (pRef2 != rM));
|
||
CHECK (!(rM == pRef2) and !(pRef2 == rM));
|
||
|
||
CHECK (!(rM == p1.getID()) );
|
||
CHECK ( (rM != p1.getID()) );
|
||
CHECK ( (rM != p2.getID()) );
|
||
CHECK (!(rM == p2.getID()) );
|
||
}
|
||
|
||
|
||
void
|
||
checkLifecycle (PMObj const& p1, PMObj const& p2)
|
||
{
|
||
CHECK (checkUseCount(p1, 0));
|
||
CHECK (checkUseCount(p2, 0));
|
||
|
||
MORef<Clip> rMO;
|
||
CHECK (!rMO);
|
||
CHECK (0 == rMO.use_count());
|
||
|
||
rMO.activate(p1);
|
||
CHECK (rMO);
|
||
CHECK (rMO->getMedia()->getFilename() == "test-1");
|
||
CHECK (checkUseCount(rMO, 1));
|
||
CHECK (checkUseCount(p1, 1)); // sharing ownership
|
||
CHECK (checkUseCount(p2, 0));
|
||
|
||
rMO.activate(p2);
|
||
CHECK (rMO);
|
||
CHECK (rMO->getMedia()->getFilename() == "test-2");
|
||
CHECK (checkUseCount(rMO, 1));
|
||
CHECK (checkUseCount(p1, 0)); // detached, use count dropped to previous value
|
||
CHECK (checkUseCount(p2, 1)); // sharing ownership
|
||
|
||
rMO.activate(p2);
|
||
CHECK (checkUseCount(rMO, 1)); // no change
|
||
|
||
rMO.close();
|
||
CHECK (!rMO);
|
||
CHECK (checkUseCount(p1, 0));
|
||
CHECK (checkUseCount(p2, 0));
|
||
|
||
VERIFY_ERROR (BOTTOM_MOBJECTREF, rMO.getPlacement() );
|
||
VERIFY_ERROR (BOTTOM_MOBJECTREF, rMO->getMedia() );
|
||
}
|
||
|
||
void
|
||
checkTypeHandling (LumieraUid luid)
|
||
{
|
||
MObjectRef rMObj;
|
||
MORef<Clip> rClip;
|
||
MORef<TestSubMO1> rSub1;
|
||
|
||
CHECK (not rMObj.use_count());
|
||
CHECK (not rClip.use_count());
|
||
CHECK (not rSub1.use_count());
|
||
|
||
rMObj.activate(luid);
|
||
CHECK (checkUseCount(rMObj, 1));
|
||
CHECK (not rClip.use_count());
|
||
CHECK (not rSub1.use_count());
|
||
|
||
rClip.activate(rMObj); // attach on existing MObjectRef
|
||
CHECK (checkUseCount(rMObj, 2));
|
||
CHECK (checkUseCount(rClip, 2));
|
||
CHECK (not rSub1.use_count());
|
||
|
||
// impossible, because Clip isn't a subclass of TestSubMO1:
|
||
VERIFY_ERROR (INVALID_PLACEMENTREF, rSub1.activate(luid) );
|
||
VERIFY_ERROR (INVALID_PLACEMENTREF, rSub1 = rMObj );
|
||
|
||
CHECK (rMObj->isValid());
|
||
CHECK (rClip->isValid());
|
||
CHECK (rMObj.getPlacement().getID() == rClip.getPlacement().getID());
|
||
|
||
// doesn't compile, because the function isn't on MObject API:
|
||
// rMObj->getMedia();
|
||
|
||
rClip.close();
|
||
CHECK (checkUseCount(rMObj, 1));
|
||
CHECK (not rClip.use_count());
|
||
|
||
// can assign, because the actual type is checked:
|
||
rClip = rMObj;
|
||
CHECK (checkUseCount(rMObj, 2));
|
||
CHECK (checkUseCount(rClip, 2));
|
||
|
||
cout << rClip << endl; //////////TICKET #527
|
||
cout << rClip->getMedia()->ident << endl; //////////TICKET #520
|
||
}
|
||
};
|
||
|
||
|
||
/** Register this test class... */
|
||
LAUNCHER (MObjectRef_test, "unit session");
|
||
|
||
|
||
}}} // namespace steam::mobject::test
|