2 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/internal/window-system/ubuntu-x11/pixmap-render-surface-ecore-x.h>
22 #include <X11/Xatom.h>
24 #include <X11/Xutil.h>
25 #include <X11/extensions/Xfixes.h> // for damage notify
26 #include <X11/extensions/Xdamage.h> // for damage notify
27 #include <dali/integration-api/gl-abstraction.h>
28 #include <dali/integration-api/debug.h>
29 #include <dali/devel-api/threading/mutex.h>
32 #include <dali/integration-api/adaptor-framework/thread-synchronization-interface.h>
33 #include <dali/internal/adaptor/common/adaptor-impl.h>
34 #include <dali/internal/adaptor/common/adaptor-internal-services.h>
35 #include <dali/internal/graphics/gles/egl-graphics.h>
36 #include <dali/internal/system/common/trigger-event.h>
37 #include <dali/internal/window-system/common/display-connection.h>
46 #if defined(DEBUG_ENABLED)
47 Debug::Filter* gPixmapRenderSurfaceLogFilter = Debug::Filter::New(Debug::Verbose, false, "LOG_PIXMAP_RENDER_SURFACE_ECORE_X");
52 static const int INITIAL_PRODUCE_BUFFER_INDEX = 0;
53 static const int INITIAL_CONSUME_BUFFER_INDEX = 1;
56 PixmapRenderSurfaceEcoreX::PixmapRenderSurfaceEcoreX( Dali::PositionSize positionSize, Any surface, bool isTransparent )
57 : mGraphics( nullptr ),
58 mDisplayConnection( nullptr ),
59 mPosition( positionSize ),
60 mRenderNotification( NULL ),
61 mColorDepth( isTransparent ? COLOR_DEPTH_32 : COLOR_DEPTH_24 ),
63 mProduceBufferIndex( INITIAL_PRODUCE_BUFFER_INDEX ),
64 mConsumeBufferIndex( INITIAL_CONSUME_BUFFER_INDEX ),
67 mThreadSynchronization( nullptr ),
70 for( int i = 0; i != BUFFER_COUNT; ++i )
76 Initialize( surface );
79 PixmapRenderSurfaceEcoreX::~PixmapRenderSurfaceEcoreX()
83 // release the surface if we own one
86 for (int i = 0; i < BUFFER_COUNT; ++i)
88 Ecore_X_Pixmap pixmap = mX11Pixmaps[i];
90 // if we did create the pixmap, delete the pixmap
91 DALI_LOG_INFO( gPixmapRenderSurfaceLogFilter, Debug::General, "Own pixmap (%x) freed\n", pixmap );
92 ecore_x_pixmap_free( pixmap );
97 void PixmapRenderSurfaceEcoreX::Initialize( Any surface )
99 // see if there is a surface in Any surface
100 unsigned int surfaceId = GetSurfaceId( surface );
102 // if the surface is empty, create a new one.
103 if ( surfaceId == 0 )
105 // we own the surface about to created
111 // XLib should already be initialized so no point in calling XInitThreads
112 UseExistingRenderable( surfaceId );
116 Any PixmapRenderSurfaceEcoreX::GetSurface()
118 Ecore_X_Pixmap pixmap = 0;
120 ConditionalWait::ScopedLock lock( mPixmapCondition );
121 pixmap = mX11Pixmaps[mProduceBufferIndex];
124 return Any( pixmap );
127 void PixmapRenderSurfaceEcoreX::SetRenderNotification(TriggerEventInterface* renderNotification)
129 mRenderNotification = renderNotification;
132 PositionSize PixmapRenderSurfaceEcoreX::GetPositionSize() const
137 void PixmapRenderSurfaceEcoreX::GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical )
142 // 1 inch = 25.4 millimeters
143 xres = ecore_x_dpi_get();
144 yres = ecore_x_dpi_get();
146 dpiHorizontal = int( xres + 0.5f ); // rounding
147 dpiVertical = int( yres + 0.5f );
150 void PixmapRenderSurfaceEcoreX::InitializeGraphics()
152 mGraphics = &mAdaptor->GetGraphicsInterface();
153 mDisplayConnection = &mAdaptor->GetDisplayConnectionInterface();
156 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
157 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
158 eglImpl.ChooseConfig(false, mColorDepth);
161 void PixmapRenderSurfaceEcoreX::CreateSurface()
163 DALI_LOG_TRACE_METHOD( gPixmapRenderSurfaceLogFilter );
165 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
166 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
168 for (int i = 0; i < BUFFER_COUNT; ++i)
170 // create the EGL surface
171 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
172 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[i] );
173 mEglSurfaces[i] = eglImpl.CreateSurfacePixmap( EGLNativePixmapType( pixmap ), mColorDepth ); // reinterpret_cast does not compile
177 void PixmapRenderSurfaceEcoreX::DestroySurface()
179 DALI_LOG_TRACE_METHOD( gPixmapRenderSurfaceLogFilter );
181 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
183 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
185 for (int i = 0; i < BUFFER_COUNT; ++i)
187 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
188 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[i] );
189 eglImpl.MakeCurrent( EGLNativePixmapType( pixmap ), mEglSurfaces[i] );
190 eglImpl.DestroySurface( mEglSurfaces[i] );
194 bool PixmapRenderSurfaceEcoreX::ReplaceGraphicsSurface()
196 DALI_LOG_TRACE_METHOD( gPixmapRenderSurfaceLogFilter );
198 bool contextLost = false;
200 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
202 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
204 for (int i = 0; i < BUFFER_COUNT; ++i)
206 // a new surface for the new pixmap
207 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
208 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[i] );
209 contextLost = eglImpl.ReplaceSurfacePixmap( EGLNativePixmapType( pixmap ), mEglSurfaces[i] ); // reinterpret_cast does not compile
212 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
213 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[mProduceBufferIndex] );
214 eglImpl.MakeCurrent( EGLNativePixmapType( pixmap ), mEglSurfaces[mProduceBufferIndex] );
219 void PixmapRenderSurfaceEcoreX::StartRender()
223 bool PixmapRenderSurfaceEcoreX::PreRender( bool )
225 // Nothing to do for pixmaps
229 void PixmapRenderSurfaceEcoreX::PostRender( bool renderToFbo, bool replacingSurface, bool resizingSurface )
231 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
233 // flush gl instruction queue
234 Integration::GlAbstraction& glAbstraction = eglGraphics->GetGlAbstraction();
235 glAbstraction.Flush();
237 if( mThreadSynchronization )
239 mThreadSynchronization->PostRenderStarted();
243 ConditionalWait::ScopedLock lock( mPixmapCondition );
244 mConsumeBufferIndex = __sync_fetch_and_xor( &mProduceBufferIndex, 1 ); // Swap buffer indexes.
246 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
248 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
249 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[mProduceBufferIndex] );
250 eglImpl.MakeCurrent( EGLNativePixmapType( pixmap ), mEglSurfaces[mProduceBufferIndex] );
253 // create damage for client applications which wish to know the update timing
254 if( mRenderNotification )
256 // use notification trigger
257 // Tell the event-thread to render the pixmap
258 mRenderNotification->Trigger();
262 // as a fallback, send damage event.
263 Ecore_X_Drawable drawable = Ecore_X_Drawable( mX11Pixmaps[mProduceBufferIndex] );
268 XserverRegion region;
272 rect.width = mPosition.width;
273 rect.height = mPosition.height;
275 XDisplay* display = AnyCast<XDisplay*>(mDisplayConnection->GetDisplay());
277 // make a fixes region as updated area
278 region = XFixesCreateRegion( display, &rect, 1 );
279 // add damage event to updated drawable
280 Drawable xdrawable( drawable ); // ecore type is unsigned int whereas in 64bit linux Drawable is long unsigned int
281 XDamageAdd( display, xdrawable, region );
282 XFixesDestroyRegion( display, region );
288 if( mThreadSynchronization )
290 mThreadSynchronization->PostRenderWaitForCompletion();
294 void PixmapRenderSurfaceEcoreX::StopRender()
299 void PixmapRenderSurfaceEcoreX::SetThreadSynchronization( ThreadSynchronizationInterface& threadSynchronization )
301 mThreadSynchronization = &threadSynchronization;
304 void PixmapRenderSurfaceEcoreX::ReleaseLock()
306 if( mThreadSynchronization )
308 mThreadSynchronization->PostRenderComplete();
312 Dali::RenderSurfaceInterface::Type PixmapRenderSurfaceEcoreX::GetSurfaceType()
314 return Dali::RenderSurfaceInterface::PIXMAP_RENDER_SURFACE;
317 void PixmapRenderSurfaceEcoreX::MakeContextCurrent()
321 void PixmapRenderSurfaceEcoreX::CreateRenderable()
323 // check we're creating one with a valid size
324 DALI_ASSERT_ALWAYS( mPosition.width > 0 && mPosition.height > 0 && "Pixmap size is invalid" );
326 for (int i = 0; i < BUFFER_COUNT; ++i)
329 mX11Pixmaps[i] = ecore_x_pixmap_new(0, mPosition.width, mPosition.height, mColorDepth);
332 unsigned int foreground;
335 gc = ecore_x_gc_new( mX11Pixmaps[i],
336 ECORE_X_GC_VALUE_MASK_FOREGROUND,
339 DALI_ASSERT_ALWAYS( gc && "CreateRenderable(): failed to get gc" );
341 ecore_x_drawable_rectangle_fill( mX11Pixmaps[i], gc, 0, 0, mPosition.width, mPosition.height );
343 DALI_ASSERT_ALWAYS( mX11Pixmaps[i] && "Failed to create X pixmap" );
345 // we SHOULD guarantee the xpixmap/x11 window was created in x server.
352 void PixmapRenderSurfaceEcoreX::UseExistingRenderable( unsigned int surfaceId )
356 unsigned int PixmapRenderSurfaceEcoreX::GetSurfaceId( Any surface ) const
358 unsigned int surfaceId = 0;
360 if ( surface.Empty() == false )
362 // check we have a valid type
363 DALI_ASSERT_ALWAYS( ( (surface.GetType() == typeid (XWindow) ) ||
364 (surface.GetType() == typeid (Ecore_X_Window) ) )
365 && "Surface type is invalid" );
367 if ( surface.GetType() == typeid (Ecore_X_Window) )
369 surfaceId = AnyCast<Ecore_X_Window>( surface );
373 surfaceId = AnyCast<XWindow>( surface );
379 } // namespace Adaptor
381 } // namespace internal