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>
34 typedef Dali::Uint16Pair ImageDimensions;
40 class AnimatedImageLoading;
41 typedef IntrusivePtr<AnimatedImageLoading> AnimatedImageLoadingPtr;
44 * Class interface for animated image loading.
45 * Each loading classes for animated image file format(e.g., gif and webp) needs to inherit this interface
47 class AnimatedImageLoading : public BaseObject
51 * @copydoc Dali::AnimatedImageLoading::New()
53 static AnimatedImageLoadingPtr New(const std::string& url, bool isLocalResource);
55 AnimatedImageLoading() = default;
57 // Moveable but not copyable
58 AnimatedImageLoading(const AnimatedImageLoading&);
59 AnimatedImageLoading& operator =(const AnimatedImageLoading&);
60 AnimatedImageLoading(AnimatedImageLoading&&) = default;
61 AnimatedImageLoading& operator=(AnimatedImageLoading&&) = default;
66 ~AnimatedImageLoading() override = default;
69 * @copydoc Dali::AnimatedImageLoading::LoadNextNFrames()
71 virtual bool LoadNextNFrames(uint32_t frameStartIndex, int count, std::vector<Dali::PixelData>& pixelData) = 0;
74 * @copydoc Dali::AnimatedImageLoading::LoadFrame()
76 virtual Dali::Devel::PixelBuffer LoadFrame(uint32_t frameIndex) = 0;
79 * @copydoc Dali::AnimatedImageLoading::GetImageSize()
81 virtual ImageDimensions GetImageSize() const = 0;
84 * @copydoc Dali::AnimatedImageLoading::GetImageCount()
86 virtual uint32_t GetImageCount() const = 0;
89 * @copydoc Dali::AnimatedImageLoading::LoadFrameDelays()
91 virtual uint32_t GetFrameInterval(uint32_t frameIndex) const = 0;
94 * @copydoc Dali::AnimatedImageLoading::GetUrl()
96 virtual std::string GetUrl() const = 0;
99 * @copydoc Dali::AnimatedImageLoading::HasLoadingSucceeded()
101 virtual bool HasLoadingSucceeded() const = 0;
104 } // namespace Adaptor
106 } // namespace Internal
108 // Helpers for api forwarding methods
110 inline Internal::Adaptor::AnimatedImageLoading& GetImplementation(Dali::AnimatedImageLoading& handle)
112 DALI_ASSERT_ALWAYS(handle && "AnimatedImageLoading handle is empty");
114 BaseObject& object = handle.GetBaseObject();
116 return static_cast<Internal::Adaptor::AnimatedImageLoading&>(object);
119 inline const Internal::Adaptor::AnimatedImageLoading& GetImplementation(const Dali::AnimatedImageLoading& handle)
121 DALI_ASSERT_ALWAYS(handle && "AnimatedImageLoading handle is empty");
123 const BaseObject& object = handle.GetBaseObject();
125 return static_cast<const Internal::Adaptor::AnimatedImageLoading&>(object);
130 #endif // DALI_INTERNAL_ANIMATED_IMAGE_LOADING_IMPL_H