2014-10-22 02:40:54 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
|
|
|
|
#ifndef mozilla_widget_VsyncDispatcher_h
|
|
|
|
#define mozilla_widget_VsyncDispatcher_h
|
|
|
|
|
2014-10-24 05:50:31 +04:00
|
|
|
#include "base/message_loop.h"
|
|
|
|
#include "mozilla/Mutex.h"
|
2014-10-22 02:40:54 +04:00
|
|
|
#include "nsISupportsImpl.h"
|
2014-10-24 05:50:31 +04:00
|
|
|
#include "nsTArray.h"
|
|
|
|
#include "ThreadSafeRefcountingWithMainThreadDestruction.h"
|
|
|
|
|
|
|
|
class MessageLoop;
|
2014-10-22 02:40:54 +04:00
|
|
|
|
|
|
|
namespace mozilla {
|
|
|
|
class TimeStamp;
|
|
|
|
|
2014-10-24 05:50:31 +04:00
|
|
|
namespace layers {
|
|
|
|
class CompositorVsyncObserver;
|
|
|
|
}
|
|
|
|
|
2014-11-19 00:28:42 +03:00
|
|
|
// Controls how and when to enable/disable vsync.
|
|
|
|
class VsyncSource
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
NS_INLINE_DECL_THREADSAFE_REFCOUNTING(VsyncSource)
|
|
|
|
virtual void EnableVsync() = 0;
|
|
|
|
virtual void DisableVsync() = 0;
|
|
|
|
virtual bool IsVsyncEnabled() = 0;
|
|
|
|
|
|
|
|
protected:
|
|
|
|
virtual ~VsyncSource() {}
|
|
|
|
}; // VsyncSource
|
|
|
|
|
2014-10-22 02:40:54 +04:00
|
|
|
class VsyncObserver
|
|
|
|
{
|
2014-10-24 05:50:31 +04:00
|
|
|
// Must be destroyed on main thread since the compositor is as well
|
|
|
|
NS_INLINE_DECL_THREADSAFE_REFCOUNTING_WITH_MAIN_THREAD_DESTRUCTION(VsyncObserver)
|
|
|
|
|
2014-10-22 02:40:54 +04:00
|
|
|
public:
|
|
|
|
// The method called when a vsync occurs. Return true if some work was done.
|
|
|
|
// Vsync notifications will occur on the hardware vsync thread
|
|
|
|
virtual bool NotifyVsync(TimeStamp aVsyncTimestamp) = 0;
|
|
|
|
|
|
|
|
protected:
|
2014-10-24 05:50:31 +04:00
|
|
|
VsyncObserver() {}
|
|
|
|
virtual ~VsyncObserver() {}
|
2014-11-19 00:28:42 +03:00
|
|
|
}; // VsyncObserver
|
2014-10-22 02:40:54 +04:00
|
|
|
|
|
|
|
// VsyncDispatcher is used to dispatch vsync events to the registered observers.
|
|
|
|
class VsyncDispatcher
|
|
|
|
{
|
|
|
|
NS_INLINE_DECL_THREADSAFE_REFCOUNTING(VsyncDispatcher)
|
|
|
|
|
|
|
|
public:
|
|
|
|
static VsyncDispatcher* GetInstance();
|
2014-10-24 05:50:31 +04:00
|
|
|
// Called on the vsync thread when a hardware vsync occurs
|
2014-11-19 00:28:42 +03:00
|
|
|
// The aVsyncTimestamp can mean different things depending on the platform:
|
|
|
|
// b2g - The vsync timestamp of the previous frame that was just displayed
|
|
|
|
// OSX - The vsync timestamp of the upcoming frame
|
|
|
|
// TODO: Windows / Linux. DOCUMENT THIS WHEN IMPLEMENTING ON THOSE PLATFORMS
|
|
|
|
// Android: TODO
|
2014-10-29 23:37:06 +03:00
|
|
|
void NotifyVsync(TimeStamp aVsyncTimestamp);
|
2014-11-19 00:28:42 +03:00
|
|
|
void SetVsyncSource(VsyncSource* aVsyncSource);
|
2014-10-22 02:40:54 +04:00
|
|
|
|
|
|
|
// Compositor vsync observers must be added/removed on the compositor thread
|
|
|
|
void AddCompositorVsyncObserver(VsyncObserver* aVsyncObserver);
|
|
|
|
void RemoveCompositorVsyncObserver(VsyncObserver* aVsyncObserver);
|
|
|
|
|
|
|
|
private:
|
|
|
|
VsyncDispatcher();
|
|
|
|
virtual ~VsyncDispatcher();
|
2014-10-29 23:37:06 +03:00
|
|
|
void DispatchTouchEvents(bool aNotifiedCompositors, TimeStamp aVsyncTime);
|
2014-10-24 05:50:31 +04:00
|
|
|
|
|
|
|
// Called on the vsync thread. Returns true if observers were notified
|
|
|
|
bool NotifyVsyncObservers(TimeStamp aVsyncTimestamp, nsTArray<nsRefPtr<VsyncObserver>>& aObservers);
|
|
|
|
|
|
|
|
// Can have multiple compositors. On desktop, this is 1 compositor per window
|
|
|
|
Mutex mCompositorObserverLock;
|
|
|
|
nsTArray<nsRefPtr<VsyncObserver>> mCompositorObservers;
|
2014-11-19 00:28:42 +03:00
|
|
|
nsRefPtr<VsyncSource> mVsyncSource;
|
|
|
|
}; // VsyncDispatcher
|
2014-10-22 02:40:54 +04:00
|
|
|
|
|
|
|
} // namespace mozilla
|
|
|
|
|
|
|
|
#endif // __mozilla_widget_VsyncDispatcher_h
|