timestamp.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

/* Based on ScummVM (<http://scummvm.org>) code, which is released
 * under the terms of version 2 or later of the GNU General Public
 * License.
 *
 * The original copyright note in ScummVM reads as follows:
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef COMMON_TIMESTAMP_H
#define COMMON_TIMESTAMP_H

#include "src/common/types.h"

namespace Common {

class Rational;

class Timestamp {
public:
    Timestamp(uint64 msecs = 0, uint64 framerate = 1);

    Timestamp(uint64 secs, uint64 frames, uint64 framerate);

    Timestamp(uint64 secs, uint64 frames, const Rational &framerate);

    Timestamp convertToFramerate(uint64 newFramerate) const;

    bool operator==(const Timestamp &ts) const;
    bool operator!=(const Timestamp &ts) const;
    bool operator<(const Timestamp &ts) const;
    bool operator<=(const Timestamp &ts) const;
    bool operator>(const Timestamp &ts) const;
    bool operator>=(const Timestamp &ts) const;

    Timestamp addFrames(int64 frames) const;

    Timestamp addMsecs(int64 msecs) const;


    // unary minus
    Timestamp operator-() const;

    Timestamp operator+(const Timestamp &ts) const;

    Timestamp operator-(const Timestamp &ts) const;

    int64 frameDiff(const Timestamp &ts) const;

    int64 msecsDiff(const Timestamp &ts) const;

    int64 msecs() const;

    inline int64 secs() const {
        return _secs;
    }

    inline int64 totalNumberOfFrames() const {
        return _numFrames / (int64)_framerateFactor + _secs * (int64)(_framerate / _framerateFactor);
    }

    inline int64 numberOfFrames() const {
        return _numFrames / (int64)_framerateFactor;
    }

    inline uint64 framerate() const { return _framerate / _framerateFactor; }

protected:
    int64 cmp(const Timestamp &ts) const;

    void normalize();

    void addIntern(const Timestamp &ts);

protected:
    int64 _secs;

    int64 _numFrames;

    uint64 _framerate;

    uint64 _framerateFactor;
};


} // End of namespace Common

#endif