lumiera_documentation/src/lib/time/timecode.cpp
Ichthyostega 0493caac1d first complete implementation of SMPTE timecode
first integration of the various components
developed thus far; design still needs some
improvements, esp. regarding the effectiveFramerate
Note NTSC-drop-frame not yet supported...
2011-01-21 11:42:29 +01:00

274 lines
6.9 KiB
C++

/*
Timecode - implementation of fixed grid aligned time specifications
Copyright (C) Lumiera.org
2010, 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.
* *****************************************************/
#include "lib/lumitime.hpp"
#include "lib/time/timecode.hpp"
#include "lib/time/timevalue.hpp"
#include "lib/time/timequant.hpp"
#include "lib/time/formats.hpp"
#include "lib/time.h"
#include "lib/util.hpp"
#include <tr1/functional>
using std::string;
using util::unConst;
using std::tr1::bind;
using std::tr1::placeholders::_1;
namespace lib {
namespace time {
TCode::~TCode() { } // emit VTable here....
namespace format {
/** build up a frame count
* by quantising the given time value
*/
void
Frames::rebuild (FrameNr& framecnt, QuantR quantiser, TimeValue const& rawTime)
{
framecnt.setValueRaw(quantiser.gridPoint (rawTime));
}
/** calculate the time point denoted by this frame count */
TimeValue
Frames::evaluate (FrameNr const& framecnt, QuantR quantiser)
{
return quantiser.timeOf (framecnt);
}
/** build up a SMPTE timecode
* by quantising the given time value and then splitting it
* into hours, minutes, seconds and frame offset.
*/
void
Smpte::rebuild (SmpteTC& tc, QuantR quantiser, TimeValue const& rawTime)
{
tc.frames = quantiser.gridPoint (rawTime);
// will automatically wrap over to the secs, minutes and hour fields
}
/** calculate the time point denoted by this SMPTE timecode,
* by summing up the timecode's components */
TimeValue
Smpte::evaluate (SmpteTC const& tc, QuantR quantiser)
{
uint frameRate = tc.getFps();
long gridPoint = tc.frames
+ tc.secs * frameRate
+ tc.mins * frameRate * 60
+ tc.hours * frameRate * 60 * 60;
return quantiser.timeOf (gridPoint);
}
/** yield the Framerate in effect at that point.
* Especially Timecode in SMPTE format exposes a "frames" field
* to contain the remainder of frames in addition to the h:m:s value.
* Obviously this value has to be kept below the number of frames for
* a full second and wrap around accordingly.
* @note SMPTE format assumes this framerate to be constant. Actually,
* in this implementation the value returned here neither needs
* to be constant (independent of the given rawTime), nor does
* it need to be the actual framerate used by the quantiser.
* Especially in case of NTSC drop-frame, the timecode
* uses 30fps here, while the quantisation uses 29.97
* @todo this design just doesn't feel quite right...
*/
uint
Smpte::getFramerate (QuantR quantiser_, TimeValue const& rawTime)
{
long refCnt = quantiser_.gridPoint(rawTime);
long newCnt = quantiser_.gridPoint(Time(0.5,1) + rawTime);
long effectiveFrames = newCnt - refCnt;
ENSURE (1000 > effectiveFrames);
ENSURE (0 < effectiveFrames);
return uint(effectiveFrames);
}
}
namespace { // Timecode implementation details
typedef util::IDiv<int> Div;
int
wrapFrames (SmpteTC& thisTC, int rawFrames)
{
Div scaleRelation(rawFrames, thisTC.getFps());
thisTC.secs += scaleRelation.quot;
return scaleRelation.rem;
}
int
wrapSeconds (SmpteTC& thisTC, int rawSecs)
{
Div scaleRelation(rawSecs, 60);
thisTC.mins += scaleRelation.quot;
return scaleRelation.rem;
}
int
wrapMinutes (SmpteTC& thisTC, int rawMins)
{
Div scaleRelation(rawMins, 60);
thisTC.hours += scaleRelation.quot;
return scaleRelation.rem;
}
int
wrapHours (SmpteTC& thisTC, int rawHours)
{
thisTC.sgn = rawHours;
return rawHours;
}
}//(End)implementation details
/** */
FrameNr::FrameNr (QuTime const& quantisedTime)
: TCode(quantisedTime)
, CountVal()
{
quantisedTime.castInto (*this);
}
/** */
SmpteTC::SmpteTC (QuTime const& quantisedTime)
: TCode(quantisedTime)
, effectiveFramerate_(Format::getFramerate (*quantiser_, quantisedTime))
{
// Functors to normalise raw component values
hours.mutator = bind (wrapHours, *this, _1 );
mins.mutator = bind (wrapMinutes, *this, _1 );
secs.mutator = bind (wrapSeconds, *this, _1 );
frames.mutator = bind (wrapFrames, *this, _1 );
quantisedTime.castInto (*this);
}
/** */
HmsTC::HmsTC (QuTime const& quantisedTime)
: TCode(quantisedTime)
// : tpoint_(quantisedTime) /////////////////////////////TODO bullshit
{ }
/** */
Secs::Secs (QuTime const& quantisedTime)
: TCode(quantisedTime)
// : sec_(TimeVar(quantisedTime) / GAVL_TIME_SCALE) /////////////TODO bullshit
{ }
void
SmpteTC::rebuild() const
{
TimeValue point = Format::evaluate (*this, *quantiser_);
Format::rebuild (unConst(*this), *quantiser_, point);
}
uint
SmpteTC::getFps() const
{
return effectiveFramerate_; //////////////////////////////////TODO better design. Shouldn't Format::getFramerate(QuantR, TimeValue) be moved here?
}
string
SmpteTC::show() const
{
rebuild();
string tc;
tc.reserve(15);
tc += sgn.show();
tc += hours.show();
tc += ':';
tc += mins.show();
tc += ':';
tc += secs.show();
tc += ':';
tc += frames.show();
return tc;
}
SmpteTC&
SmpteTC::operator++ ()
{
++frames;
return *this;
}
SmpteTC&
SmpteTC::operator-- ()
{
--frames;
return *this;
}
/** */
int
HmsTC::getSecs() const
{
return lumiera_time_seconds (tpoint_);
}
/** */
int
HmsTC::getMins() const
{
return lumiera_time_minutes (tpoint_);
}
/** */
int
HmsTC::getHours() const
{
return lumiera_time_hours (tpoint_);
}
/** */
double
HmsTC::getMillis() const
{
TODO ("Frame-Quantisation");
return lumiera_time_millis (tpoint_);
}
/** */
}} // lib::time