#include <libmythui/devices/AppleRemote.h>

Inheritance diagram for AppleRemote:

Collaboration diagram for AppleRemote:

Classes
class	Listener

Public Types
enum	Event { Up = 0 , Down , Menu , Select , Right , Left , RightHold , LeftHold , MenuHold , PlayHold , ControlSwitched , PlayPause , Undefined }

Public Member Functions
	~AppleRemote ()

bool	isListeningToRemote ()

void	setListener (Listener *listener)

Listener *	listener ()

void	setOpenInExclusiveMode (bool in)

bool	isOpenInExclusiveMode ()

void	startListening ()

void	stopListening ()

void	run () override
	Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead. More...

Public Member Functions inherited from MThread
	MThread (const QString &objectName)
	Standard constructor. More...

	MThread (const QString &objectName, QRunnable *runnable)
	Use this constructor if you want the default run() method to run the QRunnable's run() method instead of entering the Qt event loop. More...

virtual	~MThread ()

	MThread (const MThread &)=delete

MThread &	operator= (const MThread &)=delete

void	RunProlog (void)
	Sets up a thread, call this if you reimplement run(). More...

void	RunEpilog (void)
	Cleans up a thread's resources, call this if you reimplement run(). More...

QThread *	qthread (void)
	Returns the thread, this will always return the same pointer no matter how often you restart the thread. More...

void	setObjectName (const QString &name)

QString	objectName (void) const

void	setPriority (QThread::Priority priority)

QThread::Priority	priority (void) const

bool	isFinished (void) const

bool	isRunning (void) const

void	setStackSize (uint stackSize)

uint	stackSize (void) const

void	exit (int retcode=0)
	Use this to exit from the thread if you are using a Qt event loop. More...

void	start (QThread::Priority p=QThread::InheritPriority)
	Tell MThread to start running the thread in the near future. More...

void	terminate (void)
	Kill a thread unsafely. More...

void	quit (void)
	calls exit(0) More...

bool	wait (std::chrono::milliseconds time=std::chrono::milliseconds::max())
	Wait for the MThread to exit, with a maximum timeout. More...

Static Public Member Functions
static AppleRemote *	Get ()

Static Public Member Functions inherited from MThread
static void	ThreadSetup (const QString &name)
	This is to be called on startup in those few threads that haven't been ported to MThread. More...

static void	ThreadCleanup (void)
	This is to be called on exit in those few threads that haven't been ported to MThread. More...

static void	Cleanup (void)
	This will print out all the running threads, call exit(1) on each and then wait up to 5 seconds total for all the threads to exit. More...

static void	GetAllThreadNames (QStringList &list)

static void	GetAllRunningThreadNames (QStringList &list)

Protected Member Functions
	AppleRemote ()

Protected Member Functions inherited from MThread
virtual void	run (void)
	Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead. More...

int	exec (void)
	Enters the qt event loop. call exit or quit to exit thread. More...

Static Protected Attributes
static AppleRemote *	_instance = nullptr

Private Member Functions
void	_initCookieMap ()
	Apple keeps changing the "interface" between the remote and the OS. More...

bool	_initCookies ()

bool	_createDeviceInterface (io_object_t hidDevice)

bool	_openDevice ()

void	_queueCallbackFunction (IOReturn result, void refcon, void sender)

void	_handleEventWithCookieString (std::string cookieString, SInt32 sumOfValues)

Static Private Member Functions
static void	QueueCallbackFunction (void target, IOReturn result, void refcon, void *sender)

Private Attributes
bool	openInExclusiveMode {true}

IOHIDDeviceInterface **	hidDeviceInterface {nullptr}

IOHIDQueueInterface **	queue {nullptr}

std::vector< int >	cookies

std::map< std::string, Event >	cookieToButtonMapping

int	remoteId {0}

Listener *	_listener {nullptr}

AppleRemote::Event	mLastEvent {AppleRemote::Undefined}

int	mEventCount {0}

bool	mKeyIsDown {false}

QTimer *	mCallbackTimer {nullptr}

Additional Inherited Members
Static Protected Member Functions inherited from MThread
static void	setTerminationEnabled (bool enabled=true)

static void	usleep (std::chrono::microseconds time)

template<typename R , typename P >
static std::enable_if_t< std::chrono::treat_as_floating_point< R >::value, void >	usleep (std::chrono::duration< R, P > time)

Protected Attributes inherited from MThread
MThreadInternal *	m_thread {nullptr}

QRunnable *	m_runnable {nullptr}

bool	m_prologExecuted {true}

bool	m_epilogExecuted {true}

Detailed Description

Definition at line 20 of file AppleRemote.h.

Member Enumeration Documentation

◆ Event

enum AppleRemote::Event

Enumerator
Up
Down
Menu
Select
Right
Left
RightHold
LeftHold
MenuHold
PlayHold
ControlSwitched
PlayPause
Undefined

Definition at line 24 of file AppleRemote.h.

Constructor & Destructor Documentation

◆ ~AppleRemote()

AppleRemote::~AppleRemote ( )

Definition at line 50 of file AppleRemote.cpp.

◆ AppleRemote()

AppleRemote::AppleRemote ( )

protected

Definition at line 126 of file AppleRemote.cpp.

Referenced by Get().

Member Function Documentation

◆ _createDeviceInterface()

bool AppleRemote::_createDeviceInterface ( io_object_t hidDevice )

private

Definition at line 253 of file AppleRemote.cpp.

Referenced by startListening().

◆ _handleEventWithCookieString()

void AppleRemote::_handleEventWithCookieString	(	std::string	cookieString,
		SInt32	sumOfValues
	)

private

Definition at line 380 of file AppleRemote.cpp.

Referenced by _queueCallbackFunction().

◆ _initCookieMap()

void AppleRemote::_initCookieMap ( )

private

Apple keeps changing the "interface" between the remote and the OS.

This initialises a table that stores those mappings.

The white plastic remote has a Play+Pause button in the middle of the navigation ring, but for menu navigation, we send an "enter" event instead. Ideally we would remap that for TV/videos, but MythTV can't easily do that.

The new Aluminium remote has separate Select and Play+Pause buttons.

Definition at line 140 of file AppleRemote.cpp.

Referenced by AppleRemote().

◆ _initCookies()

bool AppleRemote::_initCookies ( )

private

Definition at line 213 of file AppleRemote.cpp.

Referenced by startListening().

◆ _openDevice()

bool AppleRemote::_openDevice ( )

private

Definition at line 282 of file AppleRemote.cpp.

Referenced by startListening().

◆ _queueCallbackFunction()

void AppleRemote::_queueCallbackFunction	(	IOReturn	result,
		void *	refcon,
		void *	sender
	)

private

Definition at line 350 of file AppleRemote.cpp.

Referenced by QueueCallbackFunction().

◆ Get()

AppleRemote * AppleRemote::Get ( void )

static

Definition at line 42 of file AppleRemote.cpp.

Referenced by MythInputDeviceHandler::Start().

◆ isListeningToRemote()

bool AppleRemote::isListeningToRemote ( )

Definition at line 64 of file AppleRemote.cpp.

◆ isOpenInExclusiveMode()

bool AppleRemote::isOpenInExclusiveMode ( )

inline

Definition at line 55 of file AppleRemote.h.

◆ listener()

Listener * AppleRemote::listener ( )

inline

Definition at line 53 of file AppleRemote.h.

Referenced by setListener().

◆ QueueCallbackFunction()

void AppleRemote::QueueCallbackFunction	(	void *	target,
		IOReturn	result,
		void *	refcon,
		void *	sender
	)

staticprivate

Definition at line 342 of file AppleRemote.cpp.

Referenced by _openDevice().

◆ run()

void AppleRemote::run ( void )

overridevirtual

Runs the Qt event loop unless we have a QRunnable, in which case we run the runnable run instead.

Note: If you override this method you must call RunProlog before you do any work and RunEpilog before you exit the run method.

Reimplemented from MThread.

Definition at line 117 of file AppleRemote.cpp.

◆ setListener()

void AppleRemote::setListener ( AppleRemote::Listener * listener )

Definition at line 69 of file AppleRemote.cpp.

◆ setOpenInExclusiveMode()

void AppleRemote::setOpenInExclusiveMode ( bool in )

inline

Definition at line 54 of file AppleRemote.h.

◆ startListening()

void AppleRemote::startListening ( )

Definition at line 74 of file AppleRemote.cpp.

◆ stopListening()

void AppleRemote::stopListening ( )

Definition at line 96 of file AppleRemote.cpp.

Referenced by startListening(), and ~AppleRemote().

Member Data Documentation

◆ _instance

AppleRemote * AppleRemote::_instance = nullptr

staticprotected

Definition at line 63 of file AppleRemote.h.

Referenced by Get(), and ~AppleRemote().

◆ _listener

Listener* AppleRemote::_listener {nullptr}

private

Definition at line 73 of file AppleRemote.h.

Referenced by _handleEventWithCookieString(), listener(), and setListener().

◆ cookies

std::vector<int> AppleRemote::cookies

private

Definition at line 70 of file AppleRemote.h.

Referenced by _initCookies(), _openDevice(), isListeningToRemote(), and stopListening().

◆ cookieToButtonMapping

std::map< std::string, Event > AppleRemote::cookieToButtonMapping

private

Definition at line 71 of file AppleRemote.h.

Referenced by _handleEventWithCookieString(), and _initCookieMap().

◆ hidDeviceInterface

IOHIDDeviceInterface** AppleRemote::hidDeviceInterface {nullptr}

private

Definition at line 68 of file AppleRemote.h.

Referenced by _createDeviceInterface(), _initCookies(), _openDevice(), isListeningToRemote(), and stopListening().

◆ mCallbackTimer

QTimer* AppleRemote::mCallbackTimer {nullptr}

private

Definition at line 78 of file AppleRemote.h.

◆ mEventCount

int AppleRemote::mEventCount {0}

private

Definition at line 76 of file AppleRemote.h.

◆ mKeyIsDown

bool AppleRemote::mKeyIsDown {false}

private

Definition at line 77 of file AppleRemote.h.

◆ mLastEvent

AppleRemote::Event AppleRemote::mLastEvent {AppleRemote::Undefined}

private

Definition at line 75 of file AppleRemote.h.

◆ openInExclusiveMode

bool AppleRemote::openInExclusiveMode {true}

private

Definition at line 67 of file AppleRemote.h.

Referenced by _openDevice(), isOpenInExclusiveMode(), and setOpenInExclusiveMode().

◆ queue

IOHIDQueueInterface** AppleRemote::queue {nullptr}

private

Definition at line 69 of file AppleRemote.h.

Referenced by _openDevice(), _queueCallbackFunction(), isListeningToRemote(), startListening(), and stopListening().

◆ remoteId

int AppleRemote::remoteId {0}

private

Definition at line 72 of file AppleRemote.h.

Referenced by _queueCallbackFunction().

The documentation for this class was generated from the following files:

mythtv/libs/libmythui/devices/AppleRemote.h
mythtv/libs/libmythui/devices/AppleRemote.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Event

Constructor & Destructor Documentation

◆ ~AppleRemote()

◆ AppleRemote()

Member Function Documentation

◆ _createDeviceInterface()

◆ _handleEventWithCookieString()

◆ _initCookieMap()

◆ _initCookies()

◆ _openDevice()

◆ _queueCallbackFunction()

◆ Get()

◆ isListeningToRemote()

◆ isOpenInExclusiveMode()

◆ listener()

◆ QueueCallbackFunction()

◆ run()

◆ setListener()

◆ setOpenInExclusiveMode()

◆ startListening()

◆ stopListening()

Member Data Documentation

◆ _instance

◆ _listener

◆ cookies

◆ cookieToButtonMapping

◆ hidDeviceInterface

◆ mCallbackTimer

◆ mEventCount

◆ mKeyIsDown

◆ mLastEvent

◆ openInExclusiveMode

◆ queue

◆ remoteId