1 #ifndef DALI_INTERNAL_ANIMATED_IMAGE_LOADING_IMPL_H
2 #define DALI_INTERNAL_ANIMATED_IMAGE_LOADING_IMPL_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/intrusive-ptr.h>
23 #include <dali/public-api/common/vector-wrapper.h>
24 #include <dali/public-api/math/uint-16-pair.h>
25 #include <dali/public-api/object/base-object.h>
28 #include <dali/devel-api/adaptor-framework/animated-image-loading.h>
29 #include <dali/public-api/dali-adaptor-common.h>
30 #include <dali/internal/imaging/common/image-operations.h>
35 typedef Dali::Uint16Pair ImageDimensions;
41 class AnimatedImageLoading;
42 typedef IntrusivePtr<AnimatedImageLoading> AnimatedImageLoadingPtr;
45 * Class interface for animated image loading.
46 * Each loading classes for animated image file format(e.g., gif and webp) needs to inherit this interface
48 class AnimatedImageLoading : public BaseObject
52 * @copydoc Dali::AnimatedImageLoading::New()
54 static AnimatedImageLoadingPtr New(const std::string& url, bool isLocalResource);
56 AnimatedImageLoading() = default;
58 // Moveable but not copyable
59 AnimatedImageLoading(const AnimatedImageLoading&);
60 AnimatedImageLoading& operator =(const AnimatedImageLoading&);
61 AnimatedImageLoading(AnimatedImageLoading&&) = default;
62 AnimatedImageLoading& operator=(AnimatedImageLoading&&) = default;
67 ~AnimatedImageLoading() override = default;
70 * @brief Load a frame of the animated image.
72 * @note This function will load the entire animated image into memory if not already loaded.
73 * @param[in] frameIndex The frame index to load.
74 * @param[in] size The width and height to fit the loaded image to.
75 * @param[in] fittingMode The FittingMode of the resource to load
76 * @param[in] samplingMode The SamplingMode of the resource to load
78 * @return Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
80 Dali::Devel::PixelBuffer LoadFrame(uint32_t frameIndex,
82 Dali::FittingMode::Type fittingMode,
83 Dali::SamplingMode::Type samplingMode)
85 Dali::Devel::PixelBuffer pixelBuffer = LoadFrame(frameIndex, size);
86 return Dali::Internal::Platform::ApplyAttributesToBitmap(pixelBuffer, size, fittingMode, samplingMode);
92 * @copydoc Dali::AnimatedImageLoading::GetImageSize()
94 virtual ImageDimensions GetImageSize() const = 0;
97 * @copydoc Dali::AnimatedImageLoading::GetImageCount()
99 virtual uint32_t GetImageCount() const = 0;
102 * @copydoc Dali::AnimatedImageLoading::LoadFrameDelays()
104 virtual uint32_t GetFrameInterval(uint32_t frameIndex) const = 0;
107 * @copydoc Dali::AnimatedImageLoading::GetUrl()
109 virtual std::string GetUrl() const = 0;
112 * @copydoc Dali::AnimatedImageLoading::HasLoadingSucceeded()
114 virtual bool HasLoadingSucceeded() const = 0;
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 * @param[in] size The width and height to fit the loaded image to.
123 * @return Dali::Devel::PixelBuffer The loaded PixelBuffer. If loading is fail, return empty handle.
125 virtual Dali::Devel::PixelBuffer LoadFrame(uint32_t frameIndex, ImageDimensions size = ImageDimensions()) = 0;
128 } // namespace Adaptor
130 } // namespace Internal
132 // Helpers for api forwarding methods
134 inline Internal::Adaptor::AnimatedImageLoading& GetImplementation(Dali::AnimatedImageLoading& handle)
136 DALI_ASSERT_ALWAYS(handle && "AnimatedImageLoading handle is empty");
138 BaseObject& object = handle.GetBaseObject();
140 return static_cast<Internal::Adaptor::AnimatedImageLoading&>(object);
143 inline const Internal::Adaptor::AnimatedImageLoading& GetImplementation(const Dali::AnimatedImageLoading& handle)
145 DALI_ASSERT_ALWAYS(handle && "AnimatedImageLoading handle is empty");
147 const BaseObject& object = handle.GetBaseObject();
149 return static_cast<const Internal::Adaptor::AnimatedImageLoading&>(object);
154 #endif // DALI_INTERNAL_ANIMATED_IMAGE_LOADING_IMPL_H