2 * Copyright (c) 2021 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>
23 #include <X11/Xutil.h>
24 #include <dali/integration-api/debug.h>
25 #include <dali/internal/system/linux/dali-ecore-x.h>
28 #include <dali/integration-api/adaptor-framework/render-surface-interface.h>
29 #include <dali/internal/adaptor/common/adaptor-impl.h>
30 #include <dali/internal/graphics/common/egl-image-extensions.h>
31 #include <dali/internal/graphics/gles/egl-graphics.h>
39 using Dali::Integration::PixelBuffer;
41 // Pieces needed to save compressed images (temporary location while plumbing):
45 * Free an allocated XImage on destruction.
49 XImageJanitor(XImage* const pXImage)
52 DALI_ASSERT_DEBUG(pXImage != 0 && "Null pointer to XImage.");
59 if(!XDestroyImage(mXImage))
61 DALI_LOG_ERROR("XImage deallocation failure");
65 XImage* const mXImage;
68 XImageJanitor(const XImageJanitor& rhs);
69 XImageJanitor& operator=(const XImageJanitor& rhs);
73 NativeImageSourceX* NativeImageSourceX::New(uint32_t width, uint32_t height, Dali::NativeImageSource::ColorDepth depth, Any nativeImageSource)
75 NativeImageSourceX* image = new NativeImageSourceX(width, height, depth, nativeImageSource);
76 DALI_ASSERT_DEBUG(image && "NativeImageSource allocation failed.");
78 // 2nd phase construction
79 if(image) //< Defensive in case we ever compile without exceptions.
87 NativeImageSourceX::NativeImageSourceX(uint32_t width, uint32_t height, Dali::NativeImageSource::ColorDepth depth, Any nativeImageSource)
92 mBlendingRequired(false),
95 mEglImageExtensions(NULL),
96 mResourceDestructionCallback()
98 DALI_ASSERT_ALWAYS(Adaptor::IsAvailable());
100 GraphicsInterface* graphics = &(Adaptor::GetImplementation(Adaptor::Get()).GetGraphicsInterface());
101 auto eglGraphics = static_cast<EglGraphics*>(graphics);
103 mEglImageExtensions = eglGraphics->GetImageExtensions();
105 DALI_ASSERT_DEBUG(mEglImageExtensions);
108 mPixmap = GetPixmapFromAny(nativeImageSource);
111 void NativeImageSourceX::Initialize()
113 // if pixmap has been created outside of X11 Image we can return
116 // we don't own the pixmap
119 // find out the pixmap width / height and color depth
124 // get the pixel depth
125 int depth = GetPixelDepth(mColorDepth);
127 // set whether blending is required according to pixel format based on the depth
128 /* default pixel format is RGB888
129 If depth = 8, Pixel::A8;
130 If depth = 16, Pixel::RGB565;
131 If depth = 32, Pixel::RGBA8888 */
132 mBlendingRequired = (depth == 32 || depth == 8);
134 mPixmap = ecore_x_pixmap_new(0, mWidth, mHeight, depth);
138 NativeImageSourceX::~NativeImageSourceX()
140 if(mOwnPixmap && mPixmap)
142 // Temporarily disable this as this causes a crash with EFL Version 1.24.0
143 //ecore_x_pixmap_free(mPixmap);
147 Any NativeImageSourceX::GetNativeImageSource() const
149 // return ecore x11 type
153 bool NativeImageSourceX::GetPixels(std::vector<unsigned char>& pixbuf, unsigned& width, unsigned& height, Pixel::Format& pixelFormat) const
155 DALI_ASSERT_DEBUG(sizeof(unsigned) == 4);
156 bool success = false;
160 // Open a display connection
161 Display* displayConnection = XOpenDisplay(0);
163 XImageJanitor xImageJanitor(XGetImage(displayConnection,
166 0, // x,y of subregion to extract.
168 height, // of subregion to extract.
171 XImage* const pXImage = xImageJanitor.mXImage;
172 DALI_ASSERT_DEBUG(pXImage && "XImage (from pixmap) could not be retrieved from the server");
175 DALI_LOG_ERROR("Could not retrieve Ximage.\n");
179 switch(pXImage->depth)
181 // Note, depth is a logical value. On target the framebuffer is still 32bpp
182 // (see pXImage->bits_per_pixel) so we go through XGetPixel() and swizzle.
183 // Note, this could be the default, fallback case for all depths if *pXImage
184 // didn't have blank RGB masks (X bug), but we have to hardcode the masks and
188 pixelFormat = Pixel::RGB888;
189 pixbuf.resize(width * height * 3);
190 unsigned char* bufPtr = &pixbuf[0];
192 for(unsigned y = 0; y < height; ++y)
194 for(unsigned x = 0; x < width; ++x, bufPtr += 3)
196 const unsigned pixel = XGetPixel(pXImage, x, y);
199 const unsigned blue = pixel & 0xFFU;
200 const unsigned green = (pixel >> 8) & 0xFFU;
201 const unsigned red = (pixel >> 16) & 0xFFU;
204 *(bufPtr + 1) = green;
205 *(bufPtr + 2) = blue;
215 // Sweep through the image, doing a vertical flip, but handling each scanline as
216 // an inlined intrinsic/builtin memcpy (should be fast):
217 pixbuf.resize(width * height * 4);
218 unsigned* bufPtr = reinterpret_cast<unsigned*>(&pixbuf[0]);
219 const unsigned xDataLineSkip = pXImage->bytes_per_line;
220 const size_t copy_count = static_cast<size_t>(width) * 4;
221 pixelFormat = Pixel::BGRA8888;
223 for(unsigned y = 0; y < height; ++y, bufPtr += width)
225 const char* const in = pXImage->data + xDataLineSkip * y;
227 // Copy a whole scanline at a time:
228 DALI_ASSERT_DEBUG(size_t(bufPtr) >= size_t(&pixbuf[0]));
229 DALI_ASSERT_DEBUG(reinterpret_cast<size_t>(bufPtr) + copy_count <= reinterpret_cast<size_t>(&pixbuf[pixbuf.size()]));
230 DALI_ASSERT_DEBUG(in >= pXImage->data);
231 DALI_ASSERT_DEBUG(in + copy_count <= pXImage->data + xDataLineSkip * height);
232 __builtin_memcpy(bufPtr, in, copy_count);
238 DALI_LOG_ERROR("XImage has null data pointer.\n");
242 // Make a case for 16 bit modes especially to remember that the only reason we don't support them is a bug in X:
245 DALI_ASSERT_DEBUG(pXImage->red_mask && pXImage->green_mask && pXImage->blue_mask && "No image masks mean 16 bit modes are not possible.");
246 ///! If the above assert doesn't fail in a debug build, the X bug may have been fixed, so revisit this function.
247 ///! No break, fall through to the general unsupported format warning below.
251 DALI_LOG_WARNING("Pixmap has unsupported bit-depth for getting pixels: %u\n", pXImage->depth);
257 DALI_LOG_ERROR("Failed to get pixels from NativeImageSource.\n");
263 // Close the display connection
264 XCloseDisplay(displayConnection);
269 void NativeImageSourceX::SetSource(Any source)
271 mPixmap = GetPixmapFromAny(source);
275 // we don't own the pixmap
278 // find out the pixmap width / height and color depth
283 bool NativeImageSourceX::IsColorDepthSupported(Dali::NativeImageSource::ColorDepth colorDepth)
288 bool NativeImageSourceX::CreateResource()
290 // if the image existed previously delete it.
291 if(mEglImageKHR != NULL)
296 // casting from an unsigned int to a void *, which should then be cast back
297 // to an unsigned int in the driver.
298 EGLClientBuffer eglBuffer = reinterpret_cast<EGLClientBuffer>(mPixmap);
300 mEglImageKHR = mEglImageExtensions->CreateImageKHR(eglBuffer);
302 return mEglImageKHR != NULL;
305 void NativeImageSourceX::DestroyResource()
307 mEglImageExtensions->DestroyImageKHR(mEglImageKHR);
311 if(mResourceDestructionCallback)
313 mResourceDestructionCallback->Trigger();
317 uint32_t NativeImageSourceX::TargetTexture()
319 mEglImageExtensions->TargetTextureKHR(mEglImageKHR);
324 void NativeImageSourceX::PrepareTexture()
328 int NativeImageSourceX::GetPixelDepth(Dali::NativeImageSource::ColorDepth depth) const
332 case Dali::NativeImageSource::COLOR_DEPTH_DEFAULT:
334 // Get the default screen depth
335 return ecore_x_default_depth_get(ecore_x_display_get(), ecore_x_default_screen_get());
337 case Dali::NativeImageSource::COLOR_DEPTH_8:
341 case Dali::NativeImageSource::COLOR_DEPTH_16:
345 case Dali::NativeImageSource::COLOR_DEPTH_24:
349 case Dali::NativeImageSource::COLOR_DEPTH_32:
355 DALI_ASSERT_DEBUG(0 && "unknown color enum");
361 int NativeImageSourceX::GetTextureTarget() const
363 return GL_TEXTURE_2D;
366 bool NativeImageSourceX::ApplyNativeFragmentShader(std::string& shader)
371 const char* NativeImageSourceX::GetCustomSamplerTypename() const
376 Any NativeImageSourceX::GetNativeImageHandle() const
381 bool NativeImageSourceX::SourceChanged() const
386 Ecore_X_Pixmap NativeImageSourceX::GetPixmapFromAny(Any pixmap) const
393 // see if it is of type x11 pixmap
394 if(pixmap.GetType() == typeid(Pixmap))
396 // get the x pixmap type
397 Pixmap xpixmap = AnyCast<Pixmap>(pixmap);
399 // cast it to a ecore pixmap type
400 return static_cast<Ecore_X_Pixmap>(xpixmap);
404 return AnyCast<Ecore_X_Pixmap>(pixmap);
408 void NativeImageSourceX::GetPixmapDetails()
412 // get the width, height and depth
413 ecore_x_pixmap_geometry_get(mPixmap, &x, &y, reinterpret_cast<int*>(&mWidth), reinterpret_cast<int*>(&mHeight));
415 // set whether blending is required according to pixel format based on the depth
416 /* default pixel format is RGB888
417 If depth = 8, Pixel::A8;
418 If depth = 16, Pixel::RGB565;
419 If depth = 32, Pixel::RGBA8888 */
420 int depth = ecore_x_pixmap_depth_get(mPixmap);
421 mBlendingRequired = (depth == 32 || depth == 8);
424 uint8_t* NativeImageSourceX::AcquireBuffer(uint16_t& width, uint16_t& height, uint16_t& stride)
429 bool NativeImageSourceX::ReleaseBuffer()
434 void NativeImageSourceX::SetResourceDestructionCallback(EventThreadCallback* callback)
436 mResourceDestructionCallback = std::unique_ptr<EventThreadCallback>(callback);
439 } // namespace Adaptor
441 } // namespace Internal