1 #ifndef DALI_ANIMATED_IMAGE_LOADING_H
2 #define DALI_ANIMATED_IMAGE_LOADING_H
5 * Copyright (c) 2022 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/public-api/common/dali-vector.h>
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/math/uint-16-pair.h>
24 #include <dali/public-api/object/base-handle.h>
27 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
28 #include <dali/public-api/dali-adaptor-common.h>
33 typedef Dali::Uint16Pair ImageDimensions;
36 * @addtogroup dali_adaptor_framework
40 namespace Internal DALI_INTERNAL
44 class AnimatedImageLoading;
46 } // namespace DALI_INTERNAL
49 * Class to manage loading frames of an animated image in small chunks. Lazy initializes only when
50 * data is actually needed.
51 * Note, once the Animated Image has loaded, the undecoded data will reside in memory until this object
52 * is released. (This is to speed up frame loads, which would otherwise have to re-acquire the
55 class DALI_ADAPTOR_API AnimatedImageLoading : public BaseHandle
59 * Create a GifLoading with the given url and resourceType.
60 * @param[in] url The url of the animated image to load
61 * @param[in] isLocalResource The true or false whether this is a local resource.
62 * @return A newly created GifLoading.
64 static AnimatedImageLoading New(const std::string& url, bool isLocalResource);
69 AnimatedImageLoading();
72 * @brief Downcast an Object handle to Capture handle.
74 * If handle points to a Capture object the downcast produces valid
75 * handle. If not the returned handle is left uninitialized.
77 * @param[in] handle to An object.
78 * @return handle to a Capture object or an uninitialized handle.
80 static AnimatedImageLoading DownCast(BaseHandle handle);
83 * @brief Copy constructor.
85 * @param[in] copy The AnimatedImageLoading to copy
87 AnimatedImageLoading(const AnimatedImageLoading& copy) = default;
90 * @brief Assignment operator
92 * @param[in] rhs The AnimatedImageLoading to copy
93 * @return A reference to this
95 AnimatedImageLoading& operator=(const AnimatedImageLoading& rhs) = default;
98 * @brief Move constructor.
100 * @param[in] move The AnimatedImageLoading to move
102 AnimatedImageLoading(AnimatedImageLoading&& move) = default;
105 * @brief Move assignment operator
107 * @param[in] rhs The AnimatedImageLoading to move
108 * @return A reference to this
110 AnimatedImageLoading& operator=(AnimatedImageLoading&& rhs) = default;
115 ~AnimatedImageLoading();
118 * @brief Load a frame of the animated image.
120 * @note This function will load the entire animated image into memory if not already loaded.
121 * @param[in] frameIndex The frame index to load.
122 * @return Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
125 Dali::Devel::PixelBuffer LoadFrame(uint32_t frameIndex);
128 * @brief Get the size of a animated image.
130 * @return The width and height in pixels of the animated image.
132 ImageDimensions GetImageSize() const;
135 * @brief Get the number of frames in this animated image.
137 uint32_t GetImageCount() const;
140 * @brief Get the frame interval of the frame index
142 * @note The frame is needed to be loaded before this function is called.
144 * @return The time interval of the frame(microsecond).
146 uint32_t GetFrameInterval(uint32_t frameIndex) const;
149 * @brief Get the animated image file URL
151 * @return The URL string of the animated image file
153 std::string GetUrl() const;
156 * @brief Return whether the animated image loading is succeeded or not.
158 * @return True when the animated image loading is succeeded.
160 bool HasLoadingSucceeded() const;
162 public: // Not intended for application developers
165 * @brief This constructor is used by New() methods.
167 * @param[in] internal A pointer to a newly allocated Dali resource.
169 explicit DALI_INTERNAL AnimatedImageLoading(Internal::Adaptor::AnimatedImageLoading* internal);
175 #endif // DALI_ANIMATED_IMAGE_LOADING_H