1 #ifndef DALI_TOOLKIT_VECTOR_IMAGE_RASTERIZE_THREAD_H
2 #define DALI_TOOLKIT_VECTOR_IMAGE_RASTERIZE_THREAD_H
5 * Copyright (c) 2018 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.
21 #include <dali/devel-api/adaptor-framework/event-thread-callback.h>
22 #include <dali/devel-api/adaptor-framework/vector-animation-renderer.h>
23 #include <dali/devel-api/threading/conditional-wait.h>
24 #include <dali/devel-api/threading/mutex.h>
25 #include <dali/devel-api/threading/thread.h>
26 #include <dali/integration-api/adaptors/log-factory-interface.h>
31 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
43 * The worker thread for vector image rasterization.
45 class VectorRasterizeThread : public Thread
52 * @param[in] url The url of the vector animation file
54 VectorRasterizeThread( const std::string& url );
59 virtual ~VectorRasterizeThread();
62 * @brief Sets the renderer used to display the result image.
64 * @param[in] renderer The renderer used to display the result image
66 void SetRenderer( Renderer renderer );
69 * @brief Sets the target image size.
71 * @param[in] width The target image width
72 * @param[in] height The target image height
74 void SetSize( uint32_t width, uint32_t height );
77 * @brief Play the vector animation.
82 * @brief Stop the vector animation.
87 * @brief Pause the vector animation.
89 void PauseAnimation();
92 * @brief Render one frame. The current frame number will be increased.
97 * @brief This callback is called after the first frame is ready.
98 * @param[in] callback The resource ready callback
100 void SetResourceReadyCallback( EventThreadCallback* callback );
103 * @brief This callback is called after the animation is finished.
104 * @param[in] callback The animation finished callback
106 void SetAnimationFinishedCallback( EventThreadCallback* callback );
109 * @brief Enable looping for 'count' repeats. -1 means to repeat forever.
110 * @param[in] count The number of times to loop
112 void SetLoopCount( int32_t count );
115 * @brief Gets the loop count. -1 means to repeat forever.
116 * @return The number of times to loop
118 int32_t GetLoopCount() const;
121 * @brief Set the playing range.
122 * @param[in] range Two values between [0,1] to specify minimum and maximum progress.
123 * The animation will play between those values.
125 void SetPlayRange( Vector2 range );
128 * @brief Gets the playing range.
129 * @return The play range defined for the animation
131 Vector2 GetPlayRange() const;
134 * @brief Get the play state
135 * @return The play state
137 DevelImageVisual::PlayState GetPlayState() const;
140 * @brief Queries whether the resource is ready.
141 * @return true if ready, false otherwise
143 bool IsResourceReady() const;
146 * @brief Sets the progress of the animation.
147 * @param[in] progress The new progress as a normalized value between [0,1] or between the play range if specified.
149 void SetCurrentProgress( float progress );
152 * @brief Retrieves the current progress of the animation.
153 * @return The current progress as a normalized value between [0,1]
155 float GetCurrentProgress() const;
160 * @brief The entry function of the worker thread.
161 * It rasterizes the vector image.
168 * @brief Called by the rasterize thread which ensures a wait if required.
169 * @return false if the thread should stop.
171 bool IsThreadReady();
174 * @brief Start rendering
179 * @brief Rasterize the current frame.
184 VectorRasterizeThread( const VectorRasterizeThread& thread ) = delete;
187 VectorRasterizeThread& operator=( const VectorRasterizeThread& thread ) = delete;
192 VectorAnimationRenderer mVectorRenderer;
193 ConditionalWait mConditionalWait;
195 std::unique_ptr< EventThreadCallback > mResourceReadyTrigger;
196 std::unique_ptr< EventThreadCallback > mAnimationFinishedTrigger;
198 DevelImageVisual::PlayState mPlayState;
199 int64_t mFrameDurationNanoSeconds;
202 uint32_t mCurrentFrame;
203 uint32_t mTotalFrame;
204 uint32_t mStartFrame;
209 int32_t mCurrentLoop;
211 bool mDestroyThread; ///< Whether the thread be destroyed
213 const Dali::LogFactoryInterface& mLogFactory; ///< The log factory
217 } // namespace Internal
219 } // namespace Toolkit
223 #endif // DALI_TOOLKIT_VECTOR_IMAGE_RASTERIZE_THREAD_H