rmremoteapi.h

1. 8623L平台

/*****************************************
 Copyright  2001-2003  
 Sigma Designs, Inc. All Rights Reserved
 Proprietary and Confidential
 *****************************************/

/**
  @file   rmremote.h
  @brief  

  

  @author Emmanuel Michon
  @date   2002-03-13
*/

#ifndef __RMREMOTEAPI_H__
#define __RMREMOTEAPI_H__

RM_EXTERN_C_BLOCKSTART
typedef enum {
  RM_HW_ON_OFF = 141,
  RM_HW_PROGRAM = 142,
  RM_HW_UP = 143,
  RM_HW_DOWN = 147,
  RM_HW_LEFT = 145,
  RM_HW_RIGHT = 190,
  RM_HW_SELECT = 146,
  RM_HW_MENU = 148,
  RM_HW_TITLE = 149,
  RM_HW_OSD = 150,
  RM_HW_LANGUAGE = 151,
  RM_HW_ANGLE = 152,
  RM_HW_SUB_TITLE = 153,
  RM_HW_PLAY_PAUSE = 154,
  RM_HW_STOP = 155,
  RM_HW_PAUSE_PLAY = 156,
  RM_HW_EJECT = 157,
  RM_HW_FAST_REWIND = 158, 
  RM_HW_FAST_FORWARD = 159,
  RM_HW_PREV_TRACK = 160,
  RM_HW_NEXT_TRACK = 161,
  RM_HW_VOL_PLUS = 162,
  RM_HW_VOL_MINUS = 166,
  RM_HW_MUTE = 171,
  RM_HW_L_R = 37,
  RM_HW_KEY_1 = 163,
  RM_HW_KEY_2 = 164,
  RM_HW_KEY_3 = 172,
  RM_HW_KEY_4 = 167,
  RM_HW_KEY_5 = 168,
  RM_HW_KEY_6 = 165,
  RM_HW_KEY_7 = 13,
  RM_HW_KEY_8 = 17,
  RM_HW_KEY_9 = 169,
  RM_HW_KEY_0 = 25,
  RM_HW_VGA_TV = 21,
  RM_HW_ENT = 33,
  RM_HW_SLOW_REVERSE = 200, 
  RM_HW_SLOW_FORWARD, 
  RM_HW_REPEAT, 
  RM_HW_AB_REPEAT, 
  RM_HW_SETUP,
  RM_HW_CLEAR,
  RM_HW_TVMODE,
  RM_HW_PBC,
  RM_HW_RETURN,
  RM_HW_SHUFFLE,
  RM_HW_SEARCH,
  RM_HW_ZOOM,
#ifdef GUI_REFID_2 
  RM_HW_OPTIONS,
  RM_HW_CHANNEL_UP,
  RM_HW_CHANNEL_DOWN,
  RM_HW_HDD,
  RM_HW_KISS_ONLINE,
  RM_HW_DVD,
  RM_HW_PC_LINK,
#endif
  RM_HW_NUMERIC_INPUT,
  RM_HW_TIMEOUT=-1, // returned when no key was hit.
} RMremoteKey;

typedef struct _RMremote *RMremoteHandle;

typedef RMint32 (*ReadWithTimeoutCallback)(void *fileHandle,void *buf,RMuint32 count,RMint64 timeoutMicroSeconds);
typedef RMint32 (*FlushCallback)(void *fileHandle);
typedef void (*SleepCallback)(RMuint64 microsec);
typedef RMbool (*AvailableCallback)(void *fileHandle);

/// 
/**
   Builds a remote control object; you should provide an opened fileHandle to a serial port
   opened in raw mode at 1200 bauds and the function to read it with timeout matching the
   above prototype.

   @param fileHandle    
   @param rcb   
   @param fcb   
   @param scb   
   @return 
*/
RM_LIBRARY_IMPORT_EXPORT RMremoteHandle RMFremoteOpen(void *fileHandle,
						      ReadWithTimeoutCallback rcb,
						      FlushCallback fcb,
						      SleepCallback scb);

/// 
/**
   Builds a remote control object; you should provide an opened fileHandle to a serial port
   opened in raw mode at 1200 bauds and the function to read it with timeout matching the
   above prototype.

   @param fileHandle    
   @param rcb   
   @param fcb   
   @param scb   
   @param acb
   @return 
*/
RM_LIBRARY_IMPORT_EXPORT RMremoteHandle RMFremoteOpenEx(void *fileHandle,
							ReadWithTimeoutCallback rcb,
							FlushCallback fcb,
							SleepCallback scb,
							AvailableCallback acb);

/// 
/**
   Releases resources associated to the remote control object. You should close your fileHandle afterwards some way.

   @param h     
*/
RM_LIBRARY_IMPORT_EXPORT void RMFremoteRelease(RMremoteHandle h);

/// 
/**
   returns TRUE if a symbol can be read without timeout, FALSE otherwise.

   @param h     
   @return 
*/
RM_LIBRARY_IMPORT_EXPORT RMbool RMFremoteSymbolAvailable(RMremoteHandle h);

/// 
/**
   

   @param h     
   @param timeoutMicroSeconds: 0 makes the call non-blocking, -1 means timeout=infinity
   @return the key hit by the user. RM_HW_TIMEOUT is returned if no key was pressed in the
           given timeout.
*/
RM_LIBRARY_IMPORT_EXPORT RMremoteKey RMFremoteWaitSymbol(RMremoteHandle h,RMint32 timeoutMicroSeconds);

RM_EXTERN_C_BLOCKEND

#endif // __RMREMOTEAPI_H__