213 lines
8.4 KiB
C
213 lines
8.4 KiB
C
/****************************************************************************
|
|
* include/nuttx/video/vnc.h
|
|
*
|
|
* Copyright (C) 2016 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <gnutt@nuttx.org>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_VIDEO_VNC_H
|
|
#define __INCLUDE_NUTTX_VIDEO_VNC_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <nuttx/nx/nxglib.h>
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/* These are the types of the function pointers used to support callouts when
|
|
* mouse or keyboard inputs are received by the local VNC server from the
|
|
* remove VNC client. Notice that these callouts have arguments that match
|
|
* the inputs to nx_kbdin() and nx_mousein().
|
|
*/
|
|
|
|
typedef CODE void (*vnc_mouseout_t)(FAR void *arg, nxgl_coord_t x,
|
|
nxgl_coord_t y, uint8_t buttons);
|
|
typedef CODE void (*vnc_kbdout_t)(FAR void *arg, uint8_t nch,
|
|
FAR const uint8_t *ch);
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: vnc_fbinitialize
|
|
*
|
|
* Description:
|
|
* Initialize the VNC frame buffer driver. The VNC frame buffer driver
|
|
* supports two initialization interfaces: The standard up_fbinitialize()
|
|
* that will be called from the graphics layer and this speical
|
|
* initialization function that can be used only by VNC aware OS logic.
|
|
*
|
|
* The two initialization functions may be called separated or together in
|
|
* either order. The difference is that standard up_fbinitialize(), if
|
|
* used by itself, will not have any remote mouse or keyboard inputs that
|
|
* are reported to the VNC framebuffer driver from the remote VNC client.
|
|
*
|
|
* In the standard graphics architecture, the keyboard/mouse inputs are
|
|
* received by some appliation/board specific logic at the highest level
|
|
* in the architecture via input drivers. The received keyboard/mouse
|
|
* input data must then be "injected" into NX where it can they can be
|
|
* assigned to the window that has focus. They will eventually be
|
|
* received by the Window instances via NX callback methods.
|
|
*
|
|
* NX is a middleware layer in the architecture, below the
|
|
* application/board specific logic but above the driver level logic. The
|
|
* frame buffer driver, on the other hand lies at the very lowest level in
|
|
* the graphics architecture. It cannot call upward into the application
|
|
* nor can it call upward into NX. So, some other logic.
|
|
*
|
|
* vnc_fbinitialize() provides an optional, alternative initialization
|
|
* function. It is optional becuase it need not be called. If it is not
|
|
* called, however, keyboard/mouse inputs from the remote VNC client will
|
|
* be lost. By calling vnc_fbinitialize(), you can provide callout
|
|
* functions that can be received by logic higher in the architure. This
|
|
* higher level level callouts can then call nx_kbdin() or nx_mousein() on
|
|
* behalf of the VNC server.
|
|
*
|
|
* See also vnc_default_fbinitialize() below.
|
|
*
|
|
* Parameters:
|
|
* display - In the case of hardware with multiple displays, this
|
|
* specifies the display. Normally this is zero.
|
|
* kbdout - If non-NULL, then the pointed-to function will be called to
|
|
* handle all keyboard input as it is received. This may be either raw,
|
|
* ASCII keypress input or encoded keyboard input as determined by
|
|
* CONFIG_VNCSERVER_KBDENCODE. See include/nuttx/input/kbd_codec.h.
|
|
* mouseout - If non-NULL, then the pointed-to function will be called to
|
|
* handle all mouse input as it is received.
|
|
* arg - An opaque user provided argument that will be provided when the
|
|
* callouts are performed.
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) is returned on success. Otherwise, a negated errno value is
|
|
* returned to indicate the nature of the failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int vnc_fbinitialize(int display, vnc_kbdout_t kbdout,
|
|
vnc_mouseout_t mouseout, FAR void *arg);
|
|
|
|
/****************************************************************************
|
|
* Name: vnc_mouse and vnc_kbdout
|
|
*
|
|
* Description:
|
|
* These are the default keyboard/mouse callout functions. They are
|
|
* simply wrappers around nx_mousein() and nx_kdbout(), respectively. When
|
|
* configured using vnc_fbinitialize(), the 'arg' must be the correct
|
|
* NXHANDLE value.
|
|
*
|
|
* See also vnc_default_fbinitialize() below.
|
|
*
|
|
* Parameters:
|
|
* See vnc_mouseout_t and vnc_kbdout_t typde definitions above. These
|
|
* callouts have arguments that match the inputs to nx_kbdin() and
|
|
* nx_mousein() (if arg is really of type NXHANDLE).
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NX_KBD
|
|
void vnc_kbdout(FAR void *arg, uint8_t nch, FAR const uint8_t *ch);
|
|
#endif
|
|
|
|
#ifdef CONFIG_NX_XYINPUT
|
|
void vnc_mouseout(FAR void *arg, nxgl_coord_t x, nxgl_coord_t y,
|
|
uint8_t buttons);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: vnc_default_fbinitialize
|
|
*
|
|
* Description:
|
|
* This is just a wrapper around vnc_fbinitialize() that will establish
|
|
* the default mouse and keyboard callout functions.
|
|
*
|
|
* Parameters:
|
|
* display - In the case of hardware with multiple displays, this
|
|
* specifies the display. Normally this is zero.
|
|
* handle - And instance of NXHANDLE returned from initialization of the
|
|
* NX graphics system for that display.
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) is returned on success. Otherwise, a negated errno value is
|
|
* returned to indicate the nature of the failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
/* int vnc_default_fbinitialize(int display, NXHANDLE handle); */
|
|
|
|
#if defined(CONFIG_NX_KBD) && defined(CONFIG_NX_XYINPUT)
|
|
|
|
#define vnc_default_fbinitialize(d,h) \
|
|
vnc_fbinitialize((d), vnc_kbdout, vnc_mouseout, (FAR void *)(h))
|
|
|
|
#elif defined(CONFIG_NX_KBD)
|
|
|
|
#define vnc_default_fbinitialize(d,h) \
|
|
vnc_fbinitialize((d), vnc_kbdout, NULL, (FAR void *)(h))
|
|
|
|
#elif defined(CONFIG_NX_XYINPUT)
|
|
|
|
#define vnc_default_fbinitialize(d,h) \
|
|
vnc_fbinitialize((d), NULL, vnc_mouseout, (FAR void *)(h))
|
|
|
|
#else
|
|
|
|
#define vnc_default_fbinitialize(d,h) \
|
|
vnc_fbinitialize((d), NULL, NULL, NULL)
|
|
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __INCLUDE_NUTTX_VIDEO_VNC_H */
|