1 #ifndef DALI_INTERNAL_CAPTURE_H
2 #define DALI_INTERNAL_CAPTURE_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.
24 #include <dali/public-api/object/ref-object.h>
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/public-api/render-tasks/render-task.h>
27 #include <dali/public-api/rendering/texture.h>
28 #include <dali/public-api/rendering/frame-buffer.h>
31 #include <dali/public-api/dali-adaptor-common.h>
32 #include <dali/public-api/capture/capture.h>
33 #include <dali/public-api/adaptor-framework/native-image-source.h>
34 #include <dali/public-api/adaptor-framework/timer.h>
46 typedef IntrusivePtr<Capture> CapturePtr;
48 class Capture : public BaseObject, public ConnectionTracker
52 static constexpr uint32_t DEFAULT_QUALITY = 100;
59 Capture( Dali::CameraActor cameraActor );
62 * @copydoc Dali::Capture::New
64 static CapturePtr New();
67 * @copydoc Dali::Capture::New
69 static CapturePtr New( Dali::CameraActor cameraActor );
72 * @copydoc Dali::Capture::Start
74 void Start( Dali::Actor source, const Dali::Vector2& position, const Dali::Vector2& size, const std::string &path, const Dali::Vector4& clearColor, const uint32_t quality );
77 * @copydoc Dali::Capture::Start
79 void Start( Dali::Actor source, const Dali::Vector2& position, const Dali::Vector2& size, const std::string &path, const Dali::Vector4& clearColor );
82 * @copydoc Dali::Capture::SetImageQuality
84 void SetImageQuality( uint32_t quality );
87 * @copydoc Dali::Capture::GetNativeImageSource
89 Dali::NativeImageSourcePtr GetNativeImageSource() const;
92 * @copydoc Dali::Capture::FinishedSignal
94 Dali::Capture::CaptureFinishedSignalType& FinishedSignal();
99 * @brief A reference counted object may only be deleted by calling Unreference()
105 * @brief Create native image source.
107 void CreateNativeImageSource( const Dali::Vector2& size );
110 * @brief Delete native image source.
112 void DeleteNativeImageSource();
115 * @brief Query whether native image source is created or not.
117 * @return True is native image source is created.
119 bool IsNativeImageSourceCreated();
122 * @brief Create frame buffer.
124 void CreateFrameBuffer();
127 * @brief Delete frame buffer.
129 void DeleteFrameBuffer();
132 * @brief Query whether frame buffer is created or not.
134 * @return True is frame buffer is created.
136 bool IsFrameBufferCreated();
139 * @brief Setup render task.
141 * @param[in] position top-left position of area to be captured
142 * this position is defined in the window.
143 * @param[in] size two dimensional size of area to be captured
144 * @param[in] source sub-scene tree to be captured.
145 * @param[in] clearColor background color
147 void SetupRenderTask( const Dali::Vector2& position, const Dali::Vector2& size, Dali::Actor source, const Dali::Vector4& clearColor );
150 * @brief Unset render task.
152 void UnsetRenderTask();
155 * @brief Query whether render task is setup or not.
157 * @return True is render task is setup.
159 bool IsRenderTaskSetup();
162 * @brief Setup resources for capture.
164 * @param[in] position top-left position of area to be captured
165 * this position is defined in the window.
166 * @param[in] size two dimensional size of area to be captured
167 * @param[in] clearColor color to clear background surface.
168 * @param[in] source sub-scene tree to be captured.
170 void SetupResources( const Dali::Vector2& position, const Dali::Vector2& size, const Dali::Vector4& clearColor, Dali::Actor source );
173 * @brief Unset resources for capture.
175 void UnsetResources();
178 * @brief Callback when render is finished.
180 * @param[in] task is used for capture.
182 void OnRenderFinished( Dali::RenderTask& task );
185 * @brief Callback when timer is finished.
187 * @return True is timer start again.
192 * @brief Save framebuffer.
194 * @return True is success to save, false is fail.
201 Capture( const Capture& );
204 Capture& operator=( const Capture& rhs );
208 Dali::Texture mNativeTexture;
209 Dali::FrameBuffer mFrameBuffer;
210 Dali::RenderTask mRenderTask;
212 Dali::CameraActor mCameraActor;
213 Dali::Timer mTimer; ///< For timeout.
214 Dali::Capture::CaptureFinishedSignalType mFinishedSignal;
216 Dali::NativeImageSourcePtr mNativeImageSourcePtr; ///< pointer to surface image
220 } // End of namespace Adaptor
221 } // End of namespace Internal
223 // Helpers for public-api forwarding methods
225 inline Internal::Adaptor::Capture& GetImpl( Dali::Capture& captureWorker)
227 DALI_ASSERT_ALWAYS( captureWorker && "Capture handle is empty" );
229 BaseObject& handle = captureWorker.GetBaseObject();
231 return static_cast< Internal::Adaptor::Capture& >( handle );
234 inline const Internal::Adaptor::Capture& GetImpl( const Dali::Capture& captureWorker )
236 DALI_ASSERT_ALWAYS( captureWorker && "Capture handle is empty" );
238 const BaseObject& handle = captureWorker.GetBaseObject();
240 return static_cast< const Internal::Adaptor::Capture& >( handle );
243 } // End of namespace Dali
245 #endif // DALI_INTERNAL_CAPTURE_H