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/imaging/ubuntu-x11/native-image-source-impl-x.h>
22 #include <dali/internal/system/linux/dali-ecore-x.h>
23 #include <X11/Xutil.h>
25 #include <dali/integration-api/debug.h>
28 #include <dali/internal/graphics/common/egl-image-extensions.h>
29 #include <dali/internal/graphics/gles/egl-graphics.h>
30 #include <dali/internal/adaptor/common/adaptor-impl.h>
31 #include <dali/integration-api/adaptor-framework/render-surface-interface.h>
41 using Dali::Integration::PixelBuffer;
43 // Pieces needed to save compressed images (temporary location while plumbing):
48 * Free an allocated XImage on destruction.
52 XImageJanitor( XImage* const pXImage ) : mXImage( pXImage )
54 DALI_ASSERT_DEBUG(pXImage != 0 && "Null pointer to XImage.");
61 if( !XDestroyImage(mXImage) )
63 DALI_LOG_ERROR("XImage deallocation failure");
67 XImage* const mXImage;
69 XImageJanitor( const XImageJanitor& rhs );
70 XImageJanitor& operator = ( const XImageJanitor& rhs );
74 NativeImageSourceX* NativeImageSourceX::New( uint32_t width, uint32_t height, Dali::NativeImageSource::ColorDepth depth, Any nativeImageSource )
76 NativeImageSourceX* image = new NativeImageSourceX( width, height, depth, nativeImageSource );
77 DALI_ASSERT_DEBUG( image && "NativeImageSource allocation failed." );
79 // 2nd phase construction
80 if(image) //< Defensive in case we ever compile without exceptions.
88 NativeImageSourceX::NativeImageSourceX( uint32_t width, uint32_t height, Dali::NativeImageSource::ColorDepth depth, Any nativeImageSource )
93 mBlendingRequired( false ),
96 mEglImageExtensions( NULL ),
97 mResourceDestructionCallback()
99 DALI_ASSERT_ALWAYS( Adaptor::IsAvailable() );
101 GraphicsInterface* graphics = &( Adaptor::GetImplementation( Adaptor::Get() ).GetGraphicsInterface() );
102 auto eglGraphics = static_cast<EglGraphics *>(graphics);
104 mEglImageExtensions = eglGraphics->GetImageExtensions();
106 DALI_ASSERT_DEBUG( mEglImageExtensions );
109 mPixmap = GetPixmapFromAny(nativeImageSource);
112 void NativeImageSourceX::Initialize()
114 // if pixmap has been created outside of X11 Image we can return
117 // we don't own the pixmap
120 // find out the pixmap width / height and color depth
125 // get the pixel depth
126 int depth = GetPixelDepth(mColorDepth);
128 // set whether blending is required according to pixel format based on the depth
129 /* default pixel format is RGB888
130 If depth = 8, Pixel::A8;
131 If depth = 16, Pixel::RGB565;
132 If depth = 32, Pixel::RGBA8888 */
133 mBlendingRequired = ( depth == 32 || depth == 8 );
135 mPixmap = ecore_x_pixmap_new( 0, mWidth, mHeight, depth );
139 NativeImageSourceX::~NativeImageSourceX()
141 if (mOwnPixmap && mPixmap)
143 // Temporarily disable this as this causes a crash with EFL Version 1.24.0
144 //ecore_x_pixmap_free(mPixmap);
148 Any NativeImageSourceX::GetNativeImageSource() const
150 // return ecore x11 type
154 bool NativeImageSourceX::GetPixels(std::vector<unsigned char>& pixbuf, unsigned& width, unsigned& height, Pixel::Format& pixelFormat) const
156 DALI_ASSERT_DEBUG(sizeof(unsigned) == 4);
157 bool success = false;
161 // Open a display connection
162 Display* displayConnection = XOpenDisplay( 0 );
164 XImageJanitor xImageJanitor( XGetImage( displayConnection,
166 0, 0, // x,y of subregion to extract.
167 width, height, // of subregion to extract.
170 XImage* const pXImage = xImageJanitor.mXImage;
171 DALI_ASSERT_DEBUG(pXImage && "XImage (from pixmap) could not be retrieved from the server");
174 DALI_LOG_ERROR("Could not retrieve Ximage.\n");
178 switch(pXImage->depth)
180 // Note, depth is a logical value. On target the framebuffer is still 32bpp
181 // (see pXImage->bits_per_pixel) so we go through XGetPixel() and swizzle.
182 // Note, this could be the default, fallback case for all depths if *pXImage
183 // didn't have blank RGB masks (X bug), but we have to hardcode the masks and
187 pixelFormat = Pixel::RGB888;
188 pixbuf.resize(width*height*3);
189 unsigned char* bufPtr = &pixbuf[0];
191 for(unsigned y = height-1; y < height; --y)
193 for(unsigned x = 0; x < width; ++x, bufPtr+=3)
195 const unsigned pixel = XGetPixel(pXImage,x,y);
198 const unsigned blue = pixel & 0xFFU;
199 const unsigned green = (pixel >> 8) & 0xFFU;
200 const unsigned red = (pixel >> 16) & 0xFFU;
214 // Sweep through the image, doing a vertical flip, but handling each scanline as
215 // an inlined intrinsic/builtin memcpy (should be fast):
216 pixbuf.resize(width*height*4);
217 unsigned * bufPtr = reinterpret_cast<unsigned *>(&pixbuf[0]);
218 const unsigned xDataLineSkip = pXImage->bytes_per_line;
219 const size_t copy_count = static_cast< size_t >( width ) * 4;
220 pixelFormat = Pixel::BGRA8888;
222 for(unsigned y = height-1; y < height; --y, bufPtr += width)
224 const char * const in = pXImage->data + xDataLineSkip * y;
226 // Copy a whole scanline at a time:
227 DALI_ASSERT_DEBUG( size_t( bufPtr ) >= size_t( &pixbuf[0] ));
228 DALI_ASSERT_DEBUG( reinterpret_cast<size_t>( bufPtr ) + copy_count <= reinterpret_cast<size_t>( &pixbuf[pixbuf.size()] ) );
229 DALI_ASSERT_DEBUG( in >= pXImage->data );
230 DALI_ASSERT_DEBUG( in + copy_count <= pXImage->data + xDataLineSkip * height );
231 __builtin_memcpy( bufPtr, in, copy_count );
237 DALI_LOG_ERROR("XImage has null data pointer.\n");
241 // Make a case for 16 bit modes especially to remember that the only reason we don't support them is a bug in X:
244 DALI_ASSERT_DEBUG(pXImage->red_mask && pXImage->green_mask && pXImage->blue_mask && "No image masks mean 16 bit modes are not possible.");
245 ///! If the above assert doesn't fail in a debug build, the X bug may have been fixed, so revisit this function.
246 ///! No break, fall through to the general unsupported format warning below.
250 DALI_LOG_WARNING("Pixmap has unsupported bit-depth for getting pixels: %u\n", pXImage->depth);
256 DALI_LOG_ERROR("Failed to get pixels from NativeImageSource.\n");
262 // Close the display connection
263 XCloseDisplay( displayConnection );
268 void NativeImageSourceX::SetSource( Any source )
270 mPixmap = GetPixmapFromAny( source );
274 // we don't own the pixmap
277 // find out the pixmap width / height and color depth
282 bool NativeImageSourceX::IsColorDepthSupported( Dali::NativeImageSource::ColorDepth colorDepth )
287 bool NativeImageSourceX::CreateResource()
289 // if the image existed previously delete it.
290 if (mEglImageKHR != NULL)
295 // casting from an unsigned int to a void *, which should then be cast back
296 // to an unsigned int in the driver.
297 EGLClientBuffer eglBuffer = reinterpret_cast< EGLClientBuffer > (mPixmap);
299 mEglImageKHR = mEglImageExtensions->CreateImageKHR( eglBuffer );
301 return mEglImageKHR != NULL;
304 void NativeImageSourceX::DestroyResource()
306 mEglImageExtensions->DestroyImageKHR(mEglImageKHR);
311 uint32_t NativeImageSourceX::TargetTexture()
313 mEglImageExtensions->TargetTextureKHR(mEglImageKHR);
318 void NativeImageSourceX::PrepareTexture()
322 int NativeImageSourceX::GetPixelDepth(Dali::NativeImageSource::ColorDepth depth) const
326 case Dali::NativeImageSource::COLOR_DEPTH_DEFAULT:
328 // Get the default screen depth
329 return ecore_x_default_depth_get(ecore_x_display_get(), ecore_x_default_screen_get());
331 case Dali::NativeImageSource::COLOR_DEPTH_8:
335 case Dali::NativeImageSource::COLOR_DEPTH_16:
339 case Dali::NativeImageSource::COLOR_DEPTH_24:
343 case Dali::NativeImageSource::COLOR_DEPTH_32:
349 DALI_ASSERT_DEBUG(0 && "unknown color enum");
355 int NativeImageSourceX::GetTextureTarget() const
357 return GL_TEXTURE_2D;
360 const char* NativeImageSourceX::GetCustomFragmentPrefix() const
365 const char* NativeImageSourceX::GetCustomSamplerTypename() const
370 Any NativeImageSourceX::GetNativeImageHandle() const
375 bool NativeImageSourceX::SourceChanged() const
380 Ecore_X_Pixmap NativeImageSourceX::GetPixmapFromAny(Any pixmap) const
387 // see if it is of type x11 pixmap
388 if (pixmap.GetType() == typeid (Pixmap))
390 // get the x pixmap type
391 Pixmap xpixmap = AnyCast<Pixmap>(pixmap);
393 // cast it to a ecore pixmap type
394 return static_cast<Ecore_X_Pixmap>(xpixmap);
398 return AnyCast<Ecore_X_Pixmap>(pixmap);
402 void NativeImageSourceX::GetPixmapDetails()
406 // get the width, height and depth
407 ecore_x_pixmap_geometry_get( mPixmap, &x, &y, reinterpret_cast< int* >( &mWidth ), reinterpret_cast< int* >( &mHeight ) );
409 // set whether blending is required according to pixel format based on the depth
410 /* default pixel format is RGB888
411 If depth = 8, Pixel::A8;
412 If depth = 16, Pixel::RGB565;
413 If depth = 32, Pixel::RGBA8888 */
414 int depth = ecore_x_pixmap_depth_get(mPixmap);
415 mBlendingRequired = ( depth == 32 || depth == 8 );
418 uint8_t* NativeImageSourceX::AcquireBuffer( uint16_t& width, uint16_t& height, uint16_t& stride )
424 bool NativeImageSourceX::ReleaseBuffer()
429 void NativeImageSourceX::SetResourceDestructionCallback(EventThreadCallback* callback)
431 mResourceDestructionCallback = std::unique_ptr<EventThreadCallback>(callback);
434 } // namespace Adaptor
436 } // namespace internal