1 #ifndef DALI_INTERNAL_NATIVE_IMAGE_SOURCE_IMPL_H
2 #define DALI_INTERNAL_NATIVE_IMAGE_SOURCE_IMPL_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/adaptor-framework/native-image-source.h>
23 #include <dali/devel-api/adaptor-framework/bitmap-saver.h>
35 * Dali internal NativeImageSource.
37 class NativeImageSource
41 static constexpr uint32_t DEFAULT_QUALITY = 100;
44 * Create a new NativeImageSource internally.
45 * Depending on hardware the width and height may have to be a power of two.
46 * @param[in] width The width of the image.
47 * @param[in] height The height of the image.
48 * @param[in] depth color depth of the image.
49 * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
50 * @return A smart-pointer to a newly allocated image.
52 static NativeImageSource* New(uint32_t width,
54 Dali::NativeImageSource::ColorDepth depth,
55 Any nativeImageSource);
57 * @copydoc Dali::NativeImageSource::GetNativeImageSource()
59 virtual Any GetNativeImageSource() const = 0;
62 * @copydoc Dali::NativeImageSource::GetPixels()
64 virtual bool GetPixels(std::vector<unsigned char> &pixbuf, uint32_t &width, uint32_t &height, Pixel::Format& pixelFormat ) const = 0;
67 * @copydoc Dali::NativeImageSource::SetSource( Any source )
69 virtual void SetSource( Any source ) = 0;
72 * @copydoc Dali::NativeImageSource::IsColorDepthSupported( ColorDepth colorDepth )
74 virtual bool IsColorDepthSupported( Dali::NativeImageSource::ColorDepth colorDepth ) = 0;
79 virtual ~NativeImageSource() = default;
82 * @copydoc Dali::NativeImageSource::CreateResource()
84 virtual bool CreateResource() = 0;
87 * @copydoc Dali::NativeImageSource::DestroyResource()
89 virtual void DestroyResource() = 0;
92 * @copydoc Dali::NativeImageSource::TargetTexture()
94 virtual uint32_t TargetTexture() = 0;
97 * @copydoc Dali::NativeImageSource::PrepareTexture()
99 virtual void PrepareTexture() = 0;
102 * @copydoc Dali::NativeImageSource::GetWidth()
104 virtual uint32_t GetWidth() const = 0;
107 * @copydoc Dali::NativeImageSource::GetHeight()
109 virtual uint32_t GetHeight() const = 0;
112 * @copydoc Dali::NativeImageSource::RequiresBlending()
114 virtual bool RequiresBlending() const = 0;
117 * @copydoc Dali::NativeImageSource::GetTextureTarget()
119 virtual int GetTextureTarget() const = 0;
122 * @copydoc Dali::NativeImageSource::GetCustomFragmentPrefix()
124 virtual const char* GetCustomFragmentPrefix() const = 0;
127 * @copydoc Dali::NativeImageSource::GetCustomSamplerTypename()
129 virtual const char* GetCustomSamplerTypename() const = 0;
132 * @copydoc Dali::NativeImageSource::GetNativeImageHandle()
134 virtual Any GetNativeImageHandle() const = 0;
137 * @copydoc Dali::NativeImageSource::SourceChanged()
139 virtual bool SourceChanged() const = 0;
142 * @copydoc Dali::NativeImageInterface::GetExtension()
144 virtual NativeImageInterface::Extension* GetNativeImageInterfaceExtension() = 0;
147 * @brief Dali::DevelNativeImageSource::AcquireBuffer()
149 virtual uint8_t* AcquireBuffer( uint16_t& width, uint16_t& height, uint16_t& stride ) = 0;
152 * @brief Dali::DevelNativeImageSource::ReleaseBuffer()
154 virtual bool ReleaseBuffer() = 0;
157 * @copydoc Dali::NativeImageSource::EncodeToFile(const std::string& )
159 inline bool EncodeToFile( const std::string& filename ) const
161 return EncodeToFile( filename, DEFAULT_QUALITY );
165 * @brief Converts the current pixel contents to either a JPEG or PNG format
166 * and write that to the filesystem.
168 * @param[in] filename Identify the filesystem location at which to write the encoded image.
169 * The extension determines the encoding used.
170 * The two valid encoding are (".jpeg"|".jpg") and ".png".
171 * @param[in] quality The quality of encoded jpeg image
172 * @return @c true if the pixels were written, and @c false otherwise
174 inline bool EncodeToFile( const std::string& filename, const uint32_t quality ) const
176 std::vector< uint8_t > pixbuf;
177 uint32_t width( 0 ), height( 0 );
178 Pixel::Format pixelFormat;
180 if( GetPixels( pixbuf, width, height, pixelFormat ) )
182 return Dali::EncodeToFile( &pixbuf[0], filename, pixelFormat, width, height, quality );
188 inline static Internal::Adaptor::NativeImageSource& GetImplementation( Dali::NativeImageSource& image ) { return *image.mImpl; }
191 } // namespace Adaptor
193 } // namespace Internal
197 #endif // DALI_INTERNAL_NATIVE_IMAGE_SOURCE_IMPL_H