timebase.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef TIMEBASE_H
#define TIMEBASE_H

#include "ajabase/common/public.h"
#include "ajabase/common/videotypes.h"

class AJA_EXPORT AJATimeBase
{
public:

    AJATimeBase();

    AJATimeBase(AJA_FrameRate ajaFrameRate);

    AJATimeBase(int64_t frameTimeScale, int64_t frameDuration);

    AJATimeBase(int64_t frameTimeScale, int64_t frameDuration, int64_t audioRate);

    AJATimeBase(const AJATimeBase &other);

    virtual ~AJATimeBase();

    void SetToDefault(void);

    void SetFrameRate(int64_t frameTimeScale, int64_t frameDuration);

    void SetAJAFrameRate(AJA_FrameRate ajaFrameRate);

    void GetFrameRate(int64_t& frameTimeScale, int64_t& frameDuration) const;

#if !defined(NTV2_DEPRECATE_18_1)
    void GetFrameRate(uint32_t& frameTimeScale, uint32_t& frameDuration) const;
#endif

    int64_t GetFrameTimeScale(void) const;
    
    void SetFrameTimeScale(int64_t timeScale);

    int64_t GetFrameDuration(void) const;

    void SetAudioRate(int64_t rate);

    int64_t GetAudioRate() const;

    AJA_FrameRate GetAJAFrameRate(void) const;

    void SetTickRate(int64_t rate);

    int64_t GetTickRate() const;

    int64_t FramesToSamples(int64_t frames, bool round = false) const;

    int64_t FramesToTicks(int64_t frames, bool round = false) const;

    double FramesToSeconds(int64_t frames) const;

    double ScaleUnitsToSeconds(int64_t num) const;

    int64_t FramesToMicroseconds(int64_t frames, bool round = false) const;

    int64_t FramesToNanoseconds100(int64_t frames, bool round = false) const;

    int64_t SamplesToFrames(int64_t samples, bool round = false) const;

    int64_t SamplesToTicks(int64_t samples, bool round = false) const;

    double SamplesToSeconds(int64_t samples);

    int64_t SamplesToMicroseconds(int64_t samples, bool round = false);

    int64_t TicksToFrames(int64_t ticks, bool round = false);

    int64_t TicksToSamples(int64_t ticks, bool round = false);

    double TicksToSeconds(int64_t ticks);

    int64_t TicksToMicroseconds(int64_t ticks, bool round = false);

    int64_t SecondsToFrames(double seconds, bool round = false);

    int64_t SecondsToSamples(double seconds, bool round = false);

    int64_t SecondsToTicks(double seconds, bool round = false);

    int64_t MicrosecondsToFrames(int64_t microseconds, bool round = false);

    int64_t Nanoseconds100ToFrames(int64_t nanoseconds100, bool round = false);

    int64_t MicrosecondsToSamples(int64_t microseconds, bool round = false);

    int64_t MicrosecondsToTicks(int64_t microseconds, bool round = false);

    int64_t GetSystemTicks();

    bool IsCloseTo(const AJATimeBase &timeBase) const;

    bool IsCloseTo(int64_t frameTimeScale, int64_t frameDuration) const;

    bool IsNonIntegralRatio(void) const;

    float  GetFramesPerSecond(void) const;
    double GetFramesPerSecondDouble(void) const;

    AJATimeBase&   operator=(const AJATimeBase &t); 
    bool operator==(const AJATimeBase &val) const;
    bool operator!=(const AJATimeBase &val) const;

    static int64_t SecondsToMicroseconds(double seconds, bool round = false);

    static double MicrosecondsToSeconds(int64_t microseconds);

    static int64_t Convert(int64_t inValue, int64_t inRate, int64_t outRate, bool round, bool large);
    static int64_t Convert(int64_t inValue, int64_t inScale, int64_t inDuration,
                           int64_t outScale, int64_t outDuration, bool round, bool large);

private:
    void    SetAJAFrameRatePrivate(AJA_FrameRate ajaFrameRate);

    int64_t mFrameTimeScale;
    int64_t mFrameDuration;
    int64_t mAudioRate;
    int64_t mTickRate;
};

#endif