/*
 * Copyright © Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 2 or 3,
 * as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef MIR_PLATFORM_KMS_DRM_EVENT_HANDLER_H_
#define MIR_PLATFORM_KMS_DRM_EVENT_HANDLER_H_

#include <functional>
#include <future>

namespace mir
{
namespace graphics
{
namespace kms
{
class DRMEventHandler
{
public:
    DRMEventHandler() = default;
    virtual ~DRMEventHandler() = default;

    DRMEventHandler(DRMEventHandler const&) = delete;
    DRMEventHandler& operator=(DRMEventHandler const&) = delete;

    virtual void const* drm_event_data() const = 0;

    using KMSCrtcId = uint32_t;
    virtual std::future<void> expect_flip_event(
        KMSCrtcId id,
        std::function<void(unsigned int frame_number, std::chrono::milliseconds frame_time)> on_flip) = 0;

    /**
     * Cancel any pending flip events on this CRTC
     *
     * This is useful when we know that we're not going to get the flip event we requested,
     * such as when a VT switch has occurred.
     *
     * This marks all pending flip futures as completed.
     */
    virtual void cancel_flip_events(KMSCrtcId id) = 0;
};
}
}
}

#endif //MIR_PLATFORM_KMS_DRM_EVENT_HANDLER_H_
