1 #ifndef DALI_VIDEO_PLAYER_PLUGIN_H
2 #define DALI_VIDEO_PLAYER_PLUGIN_H
5 * Copyright (c) 2019 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.
22 #include <dali/public-api/signals/dali-signal.h>
23 #include <dali/public-api/math/rect.h>
29 typedef Dali::Rect< int > DisplayArea;
32 * @brief VideoPlayerPlugin is an abstract interface, used by dali-adaptor to access video player plugin.
33 * A concrete implementation must be created for each platform and provided as dynamic library.
36 class VideoPlayerPlugin
40 typedef Signal< void () > VideoPlayerSignalType;
43 * @brief Video display rotation option
45 * @remarks The option is needed only for window surface rendering target
49 ROTATION_NONE, ///< Display isn't rotated. @SINCE_1_1.38
50 ROTATION_90, ///< Display is rotated 90 degree. @SINCE_1_1.38
51 ROTATION_180, ///< Display is rotated 180 degree. @SINCE_1_1.38
52 ROTATION_270 ///< Display is rotated 270 degree. @SINCE_1_1.38
56 * @brief Enumeration for video codec type
60 DEFAULT, ///< Codec which has higher priority as default. Platform selects it. Usually the H/W codec has higher priority than S/W codec if it exist.
66 * @brief The values of this enum determine how the video should be display mode to the view
72 LETTER_BOX = 0, /**< Letter box */
73 ORIGIN_SIZE, /**< Origin size */
74 FULL_SCREEN, /**< Full-screen */
75 CROPPED_FULL, /**< Cropped full-screen */
76 ORIGIN_OR_LETTER, /**< Origin size (if surface size is larger than video size(width/height)) or Letter box (if video size(width/height) is larger than surface size) */
77 DST_ROI /**< Region of Interest */
91 virtual ~VideoPlayerPlugin(){}
94 * @brief Sets a URL of the video file to play.
97 * @param [in] url The url of video file
99 virtual void SetUrl( const std::string& url ) = 0;
102 * @brief Returns the URL of the video file.
104 * @return Url of string type
106 virtual std::string GetUrl() = 0;
109 * @brief Sets the player looping status.
112 * @param [in] looping The new looping status: true or false
114 virtual void SetLooping(bool looping) = 0;
117 * @brief Returns the player looping status.
120 * @return True if player is looping, false otherwise.
122 virtual bool IsLooping() = 0;
125 * @brief Starts the video playback.
128 virtual void Play() = 0;
131 * @brief Pauses the video playback.
134 virtual void Pause() = 0;
137 * @brief Stops the video playback.
140 virtual void Stop() = 0;
143 * @brief Sets the player mute status.
145 * @param[in] mute The new mute status, true is mute.
147 virtual void SetMute( bool mute ) = 0;
150 * @brief Returns the player mute status.
152 * @return True if player is mute.
154 virtual bool IsMuted() = 0;
157 * @brief Sets the player volume.
159 * @param[in] left The left volume scalar
160 * @param[in] right The right volume scalar
162 virtual void SetVolume( float left, float right ) = 0;
165 * @brief Gets current volume factor.
167 * @param[out] left The current left volume scalar
168 * @param[out] right The current right volume scalar
170 virtual void GetVolume( float& left, float& right ) = 0;
173 * @brief Sets video rendering target.
175 * @param[in] target The target for video rendering, window surface or native image source
177 virtual void SetRenderingTarget( Any target ) = 0;
180 * @brief Sets the position for playback.
183 * @param[in] millisecond The position for playback
185 virtual void SetPlayPosition( int millisecond ) = 0;
188 * @brief Returns the current position in milliseconds.
191 * @return The current position of playback
193 virtual int GetPlayPosition() = 0;
196 * @brief Sets the area of video display.
198 * param[in] area The left-top position and size of the video display area
200 virtual void SetDisplayArea( DisplayArea area ) = 0;
203 * @brief Sets video display rotation
205 * @param[in] rotation The rotation of display
207 virtual void SetDisplayRotation( Dali::VideoPlayerPlugin::DisplayRotation rotation ) = 0;
210 * @brief Returns rotation of current video display
212 * @return The rotation of current display
214 virtual Dali::VideoPlayerPlugin::DisplayRotation GetDisplayRotation() = 0;
217 * @brief Connect to this signal to be notified when a video playback have finished.
220 * @return A signal object to connect with.
222 virtual VideoPlayerSignalType& FinishedSignal() = 0;
225 * @brief Seeks forward by the specified number of milliseconds.
228 * @param[in] millisecond The position for forward playback
230 virtual void Forward( int millisecond ) = 0;
233 * @brief Seeks backward by the specified number of milliseconds.
236 * @param[in] millisecond The position for backward playback
238 virtual void Backward( int millisecond ) = 0;
241 * @brief Checks whether the video texture is supported
242 * @return True if supported, otherwise false.
244 virtual bool IsVideoTextureSupported() = 0;
247 * @brief Sets codec type
248 * @param[in] type The CodecType
250 virtual void SetCodecType( VideoPlayerPlugin::CodecType type ) = 0;
253 * @brief Gets codec type
256 virtual VideoPlayerPlugin::CodecType GetCodecType() const = 0;
259 * @brief Sets the display mode for playback.
260 * @param[in] mode of playback
262 virtual void SetDisplayMode( VideoPlayerPlugin::DisplayMode::Type mode ) = 0;
265 * @brief Returns the current display mode.
266 * @return The current display mode of playback
268 virtual VideoPlayerPlugin::DisplayMode::Type GetDisplayMode() const = 0;
271 * @brief Returns the current internal media player.
272 * @return The current internal media player of video player
274 virtual Any GetMediaPlayer() = 0;
280 #endif // DALI_VIDEO_PLAYER_PLUGIN_H