timestamp.h

/* ScummVM - Graphic Adventure Engine
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef AUDIO_TIMESTAMP_H
#define AUDIO_TIMESTAMP_H

#include "common/scummsys.h"

namespace Audio {

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

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

    Timestamp convertToFramerate(uint 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(int frames) const;

    Timestamp addMsecs(int msecs) const;


    Timestamp operator-() const;

    Timestamp operator+(const Timestamp &ts) const;

    Timestamp operator-(const Timestamp &ts) const;

    int frameDiff(const Timestamp &ts) const;

    int msecsDiff(const Timestamp &ts) const;

    int msecs() const;

    inline int secs() const {
        return _secs;
    }

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

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

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

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

    void normalize();

    void addIntern(const Timestamp &ts);

protected:
    int _secs;

    int _numFrames;

    uint _framerate;

    uint _framerateFactor;
};

} // End of namespace Audio

#endif