2 * Copyright (c) 2018 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>
26 #include <X11/extensions/Xfixes.h> // for damage notify
27 #include <X11/extensions/Xdamage.h> // for damage notify
29 #include <dali/integration-api/gl-abstraction.h>
30 #include <dali/integration-api/debug.h>
31 #include <dali/devel-api/threading/mutex.h>
34 #include <dali/integration-api/thread-synchronization-interface.h>
35 #include <dali/internal/system/common/trigger-event.h>
36 #include <dali/internal/window-system/common/display-connection.h>
37 #include <dali/internal/graphics/gles/egl-graphics.h>
47 #if defined(DEBUG_ENABLED)
48 Debug::Filter* gPixmapRenderSurfaceLogFilter = Debug::Filter::New(Debug::Verbose, false, "LOG_PIXMAP_RENDER_SURFACE_ECORE_X");
53 static const int INITIAL_PRODUCE_BUFFER_INDEX = 0;
54 static const int INITIAL_CONSUME_BUFFER_INDEX = 1;
57 PixmapRenderSurfaceEcoreX::PixmapRenderSurfaceEcoreX( Dali::PositionSize positionSize, Any surface, bool isTransparent )
58 : mGraphics( nullptr ),
59 mDisplayConnection( nullptr ),
60 mPosition( positionSize ),
61 mRenderNotification( NULL ),
62 mColorDepth( isTransparent ? COLOR_DEPTH_32 : COLOR_DEPTH_24 ),
64 mProduceBufferIndex( INITIAL_PRODUCE_BUFFER_INDEX ),
65 mConsumeBufferIndex( INITIAL_CONSUME_BUFFER_INDEX ),
68 mThreadSynchronization( nullptr ),
71 for( int i = 0; i != BUFFER_COUNT; ++i )
77 Initialize( surface );
80 PixmapRenderSurfaceEcoreX::~PixmapRenderSurfaceEcoreX()
82 // release the surface if we own one
85 for (int i = 0; i < BUFFER_COUNT; ++i)
87 Ecore_X_Pixmap pixmap = mX11Pixmaps[i];
89 // if we did create the pixmap, delete the pixmap
90 DALI_LOG_INFO( gPixmapRenderSurfaceLogFilter, Debug::General, "Own pixmap (%x) freed\n", pixmap );
91 ecore_x_pixmap_free( pixmap );
96 void PixmapRenderSurfaceEcoreX::Initialize( Any surface )
98 // see if there is a surface in Any surface
99 unsigned int surfaceId = GetSurfaceId( surface );
101 // if the surface is empty, create a new one.
102 if ( surfaceId == 0 )
104 // we own the surface about to created
110 // XLib should already be initialized so no point in calling XInitThreads
111 UseExistingRenderable( surfaceId );
115 Any PixmapRenderSurfaceEcoreX::GetSurface()
117 Ecore_X_Pixmap pixmap = 0;
119 ConditionalWait::ScopedLock lock( mPixmapCondition );
120 pixmap = mX11Pixmaps[mProduceBufferIndex];
123 return Any( pixmap );
126 void PixmapRenderSurfaceEcoreX::SetRenderNotification(TriggerEventInterface* renderNotification)
128 mRenderNotification = renderNotification;
131 PositionSize PixmapRenderSurfaceEcoreX::GetPositionSize() const
136 void PixmapRenderSurfaceEcoreX::GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical )
141 // 1 inch = 25.4 millimeters
142 xres = ecore_x_dpi_get();
143 yres = ecore_x_dpi_get();
145 dpiHorizontal = int( xres + 0.5f ); // rounding
146 dpiVertical = int( yres + 0.5f );
149 void PixmapRenderSurfaceEcoreX::InitializeGraphics( GraphicsInterface& graphics, Dali::DisplayConnection& displayConnection )
151 mGraphics = &graphics;
152 mDisplayConnection = &displayConnection;
154 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
155 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
156 eglImpl.ChooseConfig(false, mColorDepth);
159 void PixmapRenderSurfaceEcoreX::CreateSurface()
161 DALI_LOG_TRACE_METHOD( gPixmapRenderSurfaceLogFilter );
163 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
164 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
166 for (int i = 0; i < BUFFER_COUNT; ++i)
168 // create the EGL surface
169 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
170 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[i] );
171 mEglSurfaces[i] = eglImpl.CreateSurfacePixmap( EGLNativePixmapType( pixmap ), mColorDepth ); // reinterpret_cast does not compile
175 void PixmapRenderSurfaceEcoreX::DestroySurface()
177 DALI_LOG_TRACE_METHOD( gPixmapRenderSurfaceLogFilter );
179 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
181 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
183 for (int i = 0; i < BUFFER_COUNT; ++i)
185 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
186 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[i] );
187 eglImpl.MakeCurrent( EGLNativePixmapType( pixmap ), mEglSurfaces[i] );
188 eglImpl.DestroySurface();
192 bool PixmapRenderSurfaceEcoreX::ReplaceGraphicsSurface()
194 DALI_LOG_TRACE_METHOD( gPixmapRenderSurfaceLogFilter );
196 bool contextLost = false;
198 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
200 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
202 for (int i = 0; i < BUFFER_COUNT; ++i)
204 // a new surface for the new pixmap
205 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
206 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[i] );
207 contextLost = eglImpl.ReplaceSurfacePixmap( EGLNativePixmapType( pixmap ), mEglSurfaces[i] ); // reinterpret_cast does not compile
210 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
211 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[mProduceBufferIndex] );
212 eglImpl.MakeCurrent( EGLNativePixmapType( pixmap ), mEglSurfaces[mProduceBufferIndex] );
217 void PixmapRenderSurfaceEcoreX::StartRender()
221 bool PixmapRenderSurfaceEcoreX::PreRender( bool )
223 // Nothing to do for pixmaps
227 void PixmapRenderSurfaceEcoreX::PostRender( bool renderToFbo, bool replacingSurface, bool resizingSurface )
229 auto eglGraphics = static_cast<EglGraphics *>(mGraphics);
231 // flush gl instruction queue
232 Integration::GlAbstraction& glAbstraction = eglGraphics->GetGlAbstraction();
233 glAbstraction.Flush();
235 if( mThreadSynchronization )
237 mThreadSynchronization->PostRenderStarted();
241 ConditionalWait::ScopedLock lock( mPixmapCondition );
242 mConsumeBufferIndex = __sync_fetch_and_xor( &mProduceBufferIndex, 1 ); // Swap buffer indexes.
244 Internal::Adaptor::EglImplementation& eglImpl = eglGraphics->GetEglImplementation();
246 // need to cast to X handle as in 64bit system ECore handle is 32 bit whereas EGLnative and XWindow are 64 bit
247 XPixmap pixmap = static_cast<XPixmap>( mX11Pixmaps[mProduceBufferIndex] );
248 eglImpl.MakeCurrent( EGLNativePixmapType( pixmap ), mEglSurfaces[mProduceBufferIndex] );
251 // create damage for client applications which wish to know the update timing
252 if( mRenderNotification )
254 // use notification trigger
255 // Tell the event-thread to render the pixmap
256 mRenderNotification->Trigger();
260 // as a fallback, send damage event.
261 Ecore_X_Drawable drawable = Ecore_X_Drawable( mX11Pixmaps[mProduceBufferIndex] );
266 XserverRegion region;
270 rect.width = mPosition.width;
271 rect.height = mPosition.height;
273 XDisplay* display = AnyCast<XDisplay*>(mDisplayConnection->GetDisplay());
275 // make a fixes region as updated area
276 region = XFixesCreateRegion( display, &rect, 1 );
277 // add damage event to updated drawable
278 Drawable xdrawable( drawable ); // ecore type is unsigned int whereas in 64bit linux Drawable is long unsigned int
279 XDamageAdd( display, xdrawable, region );
280 XFixesDestroyRegion( display, region );
286 if( mThreadSynchronization )
288 mThreadSynchronization->PostRenderWaitForCompletion();
292 void PixmapRenderSurfaceEcoreX::StopRender()
297 void PixmapRenderSurfaceEcoreX::SetThreadSynchronization( ThreadSynchronizationInterface& threadSynchronization )
299 mThreadSynchronization = &threadSynchronization;
302 void PixmapRenderSurfaceEcoreX::ReleaseLock()
304 if( mThreadSynchronization )
306 mThreadSynchronization->PostRenderComplete();
310 RenderSurface::Type PixmapRenderSurfaceEcoreX::GetSurfaceType()
312 return RenderSurface::PIXMAP_RENDER_SURFACE;
315 void PixmapRenderSurfaceEcoreX::CreateRenderable()
317 // check we're creating one with a valid size
318 DALI_ASSERT_ALWAYS( mPosition.width > 0 && mPosition.height > 0 && "Pixmap size is invalid" );
320 for (int i = 0; i < BUFFER_COUNT; ++i)
323 mX11Pixmaps[i] = ecore_x_pixmap_new(0, mPosition.width, mPosition.height, mColorDepth);
326 unsigned int foreground;
329 gc = ecore_x_gc_new( mX11Pixmaps[i],
330 ECORE_X_GC_VALUE_MASK_FOREGROUND,
333 DALI_ASSERT_ALWAYS( gc && "CreateRenderable(): failed to get gc" );
335 ecore_x_drawable_rectangle_fill( mX11Pixmaps[i], gc, 0, 0, mPosition.width, mPosition.height );
337 DALI_ASSERT_ALWAYS( mX11Pixmaps[i] && "Failed to create X pixmap" );
339 // we SHOULD guarantee the xpixmap/x11 window was created in x server.
346 void PixmapRenderSurfaceEcoreX::UseExistingRenderable( unsigned int surfaceId )
350 unsigned int PixmapRenderSurfaceEcoreX::GetSurfaceId( Any surface ) const
352 unsigned int surfaceId = 0;
354 if ( surface.Empty() == false )
356 // check we have a valid type
357 DALI_ASSERT_ALWAYS( ( (surface.GetType() == typeid (XWindow) ) ||
358 (surface.GetType() == typeid (Ecore_X_Window) ) )
359 && "Surface type is invalid" );
361 if ( surface.GetType() == typeid (Ecore_X_Window) )
363 surfaceId = AnyCast<Ecore_X_Window>( surface );
367 surfaceId = AnyCast<XWindow>( surface );
373 } // namespace Adaptor
375 } // namespace internal