README

   1 Sections in this file describe:
   2 - Introduction
   3 - Component Overview
   4 - Required platform capabilities
   5 - How to build on different platforms
   6
   7
   8 Introduction
   9 ====================================
  10 In the automotive domain, the most HMI systems are using their own window manager implementation.
  11 Many applications (e.g. navigation, reversing camera) are implemented standalone and
  12 therefore one service is used to composite all applications to the final image on the screen. This Service
  13 is also know as LayerManagement.
  14 This Component provides a common API and a proof-of-concept implementation for the Layer Management Service.
  15 This service should improve the existing vendor-specific layer management implementations
  16 which have the following features :
  17
  18     * Fixed number of hardware layers
  19     * Hardware accelerated compositing
  20     * Platform dependent
  21     * Number of layers not extensible during runtime
  22     * Vendor-specific implementation
  23     * No standardized interface
  24     * Hardware dependent
  25     * No change during runtime possible
  26
  27 The IVI Layer Management have the following enhancements :
  28
  29     * Well-defined interface
  30     * Standardized compositing
  31     * Convenient and consistent access to hardware accelerated modules
  32     * Separation of HMI and Layer Management
  33     * Dynamically Extensions during runtime
  34     * Low integration complexity
  35     * Reduced dependency on hardware
  36
  37 Component Overview
  38 ====================================
  39 The IVI Layer Management consist of three subcomponents.
  40
  41 The LayerManagementService
  42 ===
  43 This is the main component which controls and handles
  44 the different layers with its content. Furthermore he
  45 will execute the commands which are deployed by the corresponding
  46 communicator. The content of the different layers are deployed to the
  47 renderer.
  48
  49 The LayerManagementCommunicator
  50 ===
  51 This subcomponent will handle the LayerManagement API messages. Generally
  52 a communicator will establish the communication between application and the
  53 LayerManagementService. The concept behind the communicator is to abstract
  54 the required ipc mechanism on the target platform.
  55
  56 The LayerManagementRenderer
  57 ===
  58 This subcomponent will handle the rendering of the different layers and its content on the
  59 final used target platform. The concept behind the renderer is to abstract
  60 the required rendering mechanism on the target platform.
  61
  62 Required Platform capabilities
  63 ====================================
  64
  65 Platform with X11 and OpenGL ES 2.0
  66 ===
  67
  68 If you have choosen the X11GLESRenderer as rendering backend, then the following
  69 Extensions have to be supported by the TargetPlatform :
  70
  71 X11 Extensions:
  72
  73 x-composite : This extension should support redirecting of egl Surfaces to x11 pixmaps too.
  74
  75 EGL / OpenGL ES 2.0:
  76
  77 EGL_IMAGE_KHR :
  78 The following functions should be supported by the vendor specific graphic driver
  79 glEGLImageTargetTexture2DOES
  80 eglCreateImageKHR
  81 eglDestroyImageKHR
  82 Furthermore it should be supported to create an egl image from an x11 pixmap.
  83
  84 Platform with X11 and OpenGL
  85 ===
  86
  87 If you have choosen the GLXRenderer as rendering backend, then the following
  88 Extensions have to be supported by the TargetPlatform :
  89
  90 X11 Extensions:
  91
  92 x-composite : This extension should support redirecting of egl Surfaces to x11 pixmaps too.
  93
  94 GLX / OpenGL :
  95
  96 GLX_TEXTURE_FROM_PIXMAP :
  97 The following functions should be supported by the vendor specific graphic driver
  98 Furthermore it should be supported to create an texture from an x11 pixmap.
  99
 100
 101 Beagle board platform
 102 ===
 103
 104 If you have choosen the BeagleRenderer as rendering backend, than the following
 105 kernel module must be available too :
 106
 107 CMEM Module is needed, it can be downloaded from
 108
 109 http://software-dl.ti.com/dsps/dsps_public_sw/sdo_sb/targetcontent/linuxutils/index.html
 110
 111 The EGL implementation on the beagle board should support the following egl config:
 112
 113 EGL_SURFACE_TYPE = EGL_WINDOW_BIT | EGL_PIXMAP_BIT
 114 EGL_RENDERABLE_TYPE = EGL_OPENGL_ES2_BIT,
 115 EGL_RED_SIZE = 8
 116 EGL_ALPHA_SIZE = 8
 117 EGL_BIND_TO_TEXTURE_RGBA = EGL_TRUE
 118
 119 Furthermore the application which should be rendered by the layermanagement, should initialize egl
 120 by the following steps:
 121
 122 1. Get EGL Display
 123 2. Initialize EGL
 124 3. Bind API
 125 4. Choose EGL Config
 126 5. Allocate native pixmap Structure
 127 6. Allocate native pixmap space by CMEM_alloc
 128 7. Get physical address of native pixmap using the CMEM module, and assign the address to the native pixmap structure.
 129 8. Create egl pixmap surface using the allocated native pixmap.
 130 9. Create egl context.
 131 10. Make egl context with the surface as current.
 132
 133
 134 How to build on different platforms
 135 ====================================
 136
 137 These preconditions have to be met in order to build the LayerManager component:
 138
 139 - CMake required (version 2.6 or higher)
 140
 141 Building the LayerManager breaks down to the following steps:
 142
 143 1. Pull the current codebase from the git repository to your target source directory [referred to as <source-dir>]
 144
 145 2. Create a build directory, e.g. IVILayerManagement_build [referred to as <build-dir>]
 146
 147    Example: mkdir IVILayerManagement_build
 148
 149 3. In <build-dir> Generate build system for your platform using CMake.
 150    This step provides some customization options to configure build options.
 151
 152    Example: cd <build-dir>
 153             cmake <source-dir> [optional_build_options]
 154
 155    For a full list of available build options in [optional_build_options] see "Supported Build Options"
 156
 157 4. Start the build.
 158
 159    Example: make
 160
 161 5. Install LayerManager on local system.
 162    Not: This steps will require root rights on most systems.
 163
 164    Example: sudo make install
 165
 166 The LayerManager may now be started call calling "LayerManagerService".
 167
 168
 169 Supported Build Options
 170 ===
 171
 172 - Build configuration:
 173   Option: -DCMAKE_BUILD_TYPE=DEBUG or
 174           -DCMAKE_BUILD_TYPE=RELEASE
 175
 176 - Build for X11 Desktop with GLX Renderer
 177   Option: -DWITH_DESKTOP=ON or
 178           -DWITH_DESKTOP=OFF
 179
 180 - Build for X11 with OpenGL ES 2.0 Renderer
 181   Option: -DWITH_X11_GLES=ON or
 182           -DWITH_X11_GLES=OFF
 183
 184 - Build EGL examples
 185   Option: -DWITH_EGL_EXAMPLE=ON or
 186           -DWITH_EGL_EXAMPLE=OFF
 187
 188 - Build GLX examples
 189   Option: -DWITH_GLX_EXAMPLE=ON or
 190           -DWITH_GLX_EXAMPLE=OFF
 191
 192 - Build available tests
 193   Option: -DWITH_TESTS=ON or
 194           -DWITH_TESTS=OFF
 195
 196   Remark: Test File are currently not upstreamed.
 197