ProgressTimer.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ACSDKAUDIOPLAYER_PROGRESSTIMER_H_
#define ACSDKAUDIOPLAYER_PROGRESSTIMER_H_

#include <chrono>
#include <condition_variable>
#include <cstdint>
#include <memory>
#include <mutex>
#include <thread>

namespace alexaClientSDK {
namespace acsdkAudioPlayer {

class ProgressTimer {
public:
    class ContextInterface {
    public:
        virtual void requestProgress() = 0;

        virtual void onProgressReportDelayElapsed() = 0;

        virtual void onProgressReportIntervalElapsed() = 0;

        virtual void onProgressReportIntervalUpdated() = 0;

        virtual ~ContextInterface() = default;
    };

    static std::chrono::milliseconds getNoDelay() {
        return std::chrono::milliseconds::max();
    }

    static std::chrono::milliseconds getNoInterval() {
        return std::chrono::milliseconds::max();
    }

    ProgressTimer();

    virtual ~ProgressTimer();

    void init(
        const std::shared_ptr<ContextInterface>& context,
        std::chrono::milliseconds delay,
        std::chrono::milliseconds interval,
        std::chrono::milliseconds offset = std::chrono::milliseconds::zero());

    void start();

    void pause();

    void resume();

    void stop();

    void updateInterval(const std::chrono::milliseconds& newInterval);

    void onProgress(std::chrono::milliseconds progress);

private:
    enum class State {
        IDLE,
        INITIALIZED,
        RUNNING,
        PAUSED,
        STOPPING,
    };

    friend std::ostream& operator<<(std::ostream& stream, ProgressTimer::State state);

    bool setState(State newState);

    void startThread();

    void mainLoop();

    bool updateTargetLocked();

    void pauseLocked();

    void resumeLocked();

    std::mutex m_callMutex;

    std::mutex m_stateMutex;

    State m_state;

    std::shared_ptr<ContextInterface> m_context;

    std::chrono::milliseconds m_delay;

    std::chrono::milliseconds m_interval;

    std::chrono::milliseconds m_offset;

    std::chrono::milliseconds m_target;

    bool m_gotProgress;

    std::chrono::milliseconds m_progress;

    std::condition_variable m_wake;

    std::thread m_thread;
};

}  // namespace acsdkAudioPlayer
}  // namespace alexaClientSDK

#endif  // ACSDKAUDIOPLAYER_PROGRESSTIMER_H_