MythTV  master
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 | List of all members
AppleRemote Class Reference

#include <AppleRemote.h>

Inheritance diagram for AppleRemote:
Inheritance graph
[legend]
Collaboration diagram for AppleRemote:
Collaboration graph
[legend]

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)
 
Listenerlistener ()
 
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
 
MThreadoperator= (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 AppleRemoteGet ()
 
- 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
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, EventcookieToButtonMapping
 
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
MThreadInternalm_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

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 49 of file AppleRemote.cpp.

◆ AppleRemote()

AppleRemote::AppleRemote ( )
protected

Definition at line 125 of file AppleRemote.cpp.

Referenced by Get().

Member Function Documentation

◆ Get()

AppleRemote * AppleRemote::Get ( )
static

Definition at line 41 of file AppleRemote.cpp.

Referenced by MythInputDeviceHandler::Start().

◆ isListeningToRemote()

bool AppleRemote::isListeningToRemote ( )

Definition at line 63 of file AppleRemote.cpp.

Referenced by MythInputDeviceHandler::Start().

◆ setListener()

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

Definition at line 68 of file AppleRemote.cpp.

Referenced by MythInputDeviceHandler::Start().

◆ listener()

Listener* AppleRemote::listener ( )
inline

Definition at line 53 of file AppleRemote.h.

Referenced by setListener().

◆ setOpenInExclusiveMode()

void AppleRemote::setOpenInExclusiveMode ( bool  in)
inline

Definition at line 54 of file AppleRemote.h.

◆ isOpenInExclusiveMode()

bool AppleRemote::isOpenInExclusiveMode ( )
inline

Definition at line 55 of file AppleRemote.h.

◆ startListening()

void AppleRemote::startListening ( )

Definition at line 73 of file AppleRemote.cpp.

Referenced by MythInputDeviceHandler::Event(), and MythInputDeviceHandler::Start().

◆ stopListening()

void AppleRemote::stopListening ( )

Definition at line 95 of file AppleRemote.cpp.

Referenced by MythInputDeviceHandler::Event(), startListening(), and ~AppleRemote().

◆ run()

void AppleRemote::run ( )
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 116 of file AppleRemote.cpp.

◆ _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 139 of file AppleRemote.cpp.

Referenced by AppleRemote().

◆ _initCookies()

bool AppleRemote::_initCookies ( )
private

Definition at line 212 of file AppleRemote.cpp.

Referenced by startListening().

◆ _createDeviceInterface()

bool AppleRemote::_createDeviceInterface ( io_object_t  hidDevice)
private

Definition at line 252 of file AppleRemote.cpp.

Referenced by startListening().

◆ _openDevice()

bool AppleRemote::_openDevice ( )
private

Definition at line 281 of file AppleRemote.cpp.

Referenced by startListening().

◆ QueueCallbackFunction()

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

Definition at line 341 of file AppleRemote.cpp.

Referenced by _openDevice().

◆ _queueCallbackFunction()

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

Definition at line 349 of file AppleRemote.cpp.

Referenced by QueueCallbackFunction().

◆ _handleEventWithCookieString()

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

Definition at line 379 of file AppleRemote.cpp.

Referenced by _queueCallbackFunction().

Member Data Documentation

◆ _instance

AppleRemote * AppleRemote::_instance = nullptr
staticprotected

Definition at line 63 of file AppleRemote.h.

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

◆ openInExclusiveMode

bool AppleRemote::openInExclusiveMode {true}
private

Definition at line 67 of file AppleRemote.h.

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

◆ hidDeviceInterface

IOHIDDeviceInterface** AppleRemote::hidDeviceInterface {nullptr}
private

◆ queue

IOHIDQueueInterface** AppleRemote::queue {nullptr}
private

◆ 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().

◆ remoteId

int AppleRemote::remoteId {0}
private

Definition at line 72 of file AppleRemote.h.

Referenced by _queueCallbackFunction().

◆ _listener

Listener* AppleRemote::_listener {nullptr}
private

Definition at line 73 of file AppleRemote.h.

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

◆ mLastEvent

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

Definition at line 75 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.

◆ mCallbackTimer

QTimer* AppleRemote::mCallbackTimer {nullptr}
private

Definition at line 78 of file AppleRemote.h.


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