1 #ifndef DALI_INTERNAL_WEBP_LOADING_H
2 #define DALI_INTERNAL_WEBP_LOADING_H
5 * Copyright (c) 2021 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/rect.h>
24 #include <dali/public-api/math/uint-16-pair.h>
29 #include <dali/internal/imaging/common/animated-image-loading-impl.h>
30 #include <dali/public-api/dali-adaptor-common.h>
35 typedef Dali::Uint16Pair ImageDimensions;
42 * Class to manage loading frames of an animated webp in small chunks. Lazy initializes only when
43 * data is actually needed.
44 * Note, once the WEBP has loaded, the undecoded data will reside in memory until this object
45 * is released. (This is to speed up frame loads, which would otherwise have to re-acquire the
48 class WebPLoading : public Internal::Adaptor::AnimatedImageLoading
52 * Create a WebPLoading with the given url and resourceType.
53 * @param[in] url The url of the webp image to load
54 * @param[in] isLocalResource The true or false whether this is a local resource.
55 * @return A newly created WebPLoading.
57 static AnimatedImageLoadingPtr New(const std::string& url, bool isLocalResource);
62 * Construct a Loader with the given URL
63 * @param[in] url The url of the webp image to load
64 * @param[in] isLocalResource The true or false whether this is a local resource.
66 WebPLoading(const std::string& url, bool isLocalResource);
71 ~WebPLoading() override;
74 * @brief Load the next N Frames of the webp.
76 * @note This function will load the entire webp into memory if not already loaded.
77 * @param[in] frameStartIndex The frame counter to start from. Will usually be the next frame
78 * after the previous invocation of this method, or 0 to start.
79 * @param[in] count The number of frames to load
80 * @param[out] pixelData The vector in which to return the frame data
81 * @return True if the frame data was successfully loaded
83 bool LoadNextNFrames(uint32_t frameStartIndex, int count, std::vector<Dali::PixelData>& pixelData) override;
86 * @brief Load the next Frame of the animated image.
88 * @note This function will load the entire animated image into memory if not already loaded.
89 * @param[in] frameIndex The frame counter to load. Will usually be the next frame.
90 * @return Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
92 Dali::Devel::PixelBuffer LoadFrame(uint32_t frameIndex) override;
95 * @brief Get the size of a webp image.
97 * @return The width and height in pixels of the webp image.
99 ImageDimensions GetImageSize() const override;
102 * @brief Get the number of frames in this webp.
104 uint32_t GetImageCount() const override;
107 * @brief Get the frame interval of the frame index
109 * @note The frame is needed to be loaded before this function is called.
111 * @return The time interval between frameIndex and frameIndex + 1(microsecond).
113 uint32_t GetFrameInterval(uint32_t frameIndex) const override;
116 * @brief Get the animated image file URL
118 * @return The URL string of the animated image file
120 std::string GetUrl() const override;
123 * @brief Return whether the animated image loading is succeeded or not.
125 * @return True when the animated image loading is succeeded.
127 bool HasLoadingSucceeded() const override;
131 * @brief Decode Frame of the animated image.
133 * @param[in] frameIndex The frame counter to load. Will usually be the next frame.
134 * @return Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
136 Dali::Devel::PixelBuffer DecodeFrame(uint32_t frameIndex);
143 } // namespace Adaptor
145 } // namespace Internal
149 #endif // DALI_INTERNAL_WEBP_LOADING_H