2 * Copyright (c) 2018 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 using System.Threading.Tasks;
18 using System.Runtime.InteropServices;
19 using System.Diagnostics;
21 using System.Threading;
22 using NativeDisplay = Interop.Display;
25 namespace Tizen.Multimedia
28 /// Represents properties for streaming buffering time.
30 /// <since_tizen> 5 </since_tizen>
31 public struct PlayerBufferingTime
34 /// Initializes a new instance of the PlayerBufferingTime struct.
36 /// <param name="preBufferMillisecond">A duration of buffering data that must be prerolled to start playback.</param>
37 /// Except 0 and -1, setting at least 1000 milliseconds is recommended to ensure the normal buffering operation.
38 /// 0 : use platform default value which could be different depending on the streaming type and network status. (the initial value)
39 /// -1 : use current value. (since 5.5)
40 /// <param name="reBufferMillisecond">A duration of buffering data that must be prerolled to resume playback,
41 /// when player is internally paused for buffering.
42 /// Except 0 and -1, setting at least 1000 milliseconds is recommended to ensure the normal buffering operation.
43 /// 0 : use platform default value, which depends on the streaming type and network status. It is set as the initial value of this parameter.
44 /// If the player state is <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/>,
45 /// this function will return correct time value instead of 0. (since 5.5)
46 /// -1 : use current value. (since 5.5)</param>
47 /// <since_tizen> 5 </since_tizen>
48 public PlayerBufferingTime(int preBufferMillisecond = -1, int reBufferMillisecond = -1)
50 PreBufferMillisecond = preBufferMillisecond;
51 ReBufferMillisecond = reBufferMillisecond;
55 /// Gets or sets the duration of buffering data that must be prerolled to start playback.
57 /// <since_tizen> 5 </since_tizen>
58 public int PreBufferMillisecond
65 /// Gets or sets the duration of buffering data that must be prerolled to resume playback
66 /// if player enters pause state for buffering.
68 /// <since_tizen> 5 </since_tizen>
69 public int ReBufferMillisecond
75 /// <since_tizen> 3 </since_tizen>
76 public partial class Player
79 /// Gets the native handle of the player.
81 /// <value>An IntPtr that contains the native handle of the player.</value>
82 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
83 /// <since_tizen> 3 </since_tizen>
88 ValidateNotDisposed();
89 return _handle.DangerousGetHandle();
93 #region Network configuration
94 private string _cookie = "";
95 private string _userAgent = "";
96 private const int MinBufferingTime = -1;
99 /// Gets or sets the cookie for streaming playback.
101 /// <remarks>To set, the player must be in the <see cref="PlayerState.Idle"/> state.</remarks>
102 /// <exception cref="InvalidOperationException">The player is not in the valid state.</exception>
103 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
104 /// <exception cref="ArgumentNullException">The value to set is null.</exception>
105 /// <since_tizen> 3 </since_tizen>
114 ValidatePlayerState(PlayerState.Idle);
118 throw new ArgumentNullException(nameof(value), "Cookie can't be null.");
121 NativePlayer.SetStreamingCookie(Handle, value, value.Length).
122 ThrowIfFailed(this, "Failed to set the cookie to the player");
129 /// Gets or sets the user agent for streaming playback.
131 /// <remarks>To set, the player must be in the <see cref="PlayerState.Idle"/> state.</remarks>
132 /// <exception cref="InvalidOperationException">The player is not in the valid state.</exception>
133 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
134 /// <exception cref="ArgumentNullException">The value to set is null.</exception>
135 /// <since_tizen> 3 </since_tizen>
136 public string UserAgent
144 ValidatePlayerState(PlayerState.Idle);
148 throw new ArgumentNullException(nameof(value), "UserAgent can't be null.");
151 NativePlayer.SetStreamingUserAgent(Handle, value, value.Length).
152 ThrowIfFailed(this, "Failed to set the user agent to the player");
159 /// Gets or sets the streaming buffering time.
161 /// <remarks>To set, the player must be in the <see cref="PlayerState.Idle"/> state.</remarks>
162 /// <exception cref="InvalidOperationException">The player is not in the valid state.</exception>
163 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
164 /// <exception cref="ArgumentOutOfRangeException">
165 /// <pramref name="PreBufferMillisecond"/> is less than -1.<br/>
167 /// <pramref name="ReBufferMillisecond"/> is less than -1.<br/>
169 /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
170 /// <seealso cref="PlayerBufferingTime"/>
171 /// <since_tizen> 5 </since_tizen>
172 public PlayerBufferingTime BufferingTime
176 ValidateNotDisposed();
178 NativePlayer.GetStreamingBufferingTime(Handle, out var PreBuffMillisecond, out var ReBuffMillisecond).
179 ThrowIfFailed(this, "Failed to get the buffering time of the player");
181 return new PlayerBufferingTime(PreBuffMillisecond, ReBuffMillisecond);
185 ValidatePlayerState(PlayerState.Idle);
187 if (value.PreBufferMillisecond < MinBufferingTime || value.ReBufferMillisecond < MinBufferingTime)
189 throw new ArgumentOutOfRangeException(nameof(value), value,
190 $"invalid range, got { value.PreBufferMillisecond }, { value.ReBufferMillisecond }.");
193 NativePlayer.SetStreamingBufferingTime(Handle, value.PreBufferMillisecond, value.ReBufferMillisecond).
194 ThrowIfFailed(this, "Failed to set the buffering time of the player");
200 /// Gets the state of the player.
202 /// <value>The current state of the player.</value>
203 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
204 /// <since_tizen> 3 </since_tizen>
205 public PlayerState State
209 ValidateNotDisposed();
213 return PlayerState.Preparing;
216 NativePlayer.GetState(Handle, out var state).
217 ThrowIfFailed(this, "Failed to retrieve the state of the player");
219 Debug.Assert(Enum.IsDefined(typeof(PlayerState), state));
221 return (PlayerState)state;
226 /// Gets or sets the audio latency mode.
228 /// <value>A <see cref="AudioLatencyMode"/> that specifies the mode. The default is <see cref="AudioLatencyMode.Mid"/>.</value>
230 /// If the mode is <see cref="AudioLatencyMode.High"/>,
231 /// audio output interval can be increased, so it can keep more audio data to play.
232 /// But, state transition like pause or resume can be more slower than default(<see cref="AudioLatencyMode.Mid"/>).
234 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
235 /// <exception cref="ArgumentException">The value is not valid.</exception>
236 /// <since_tizen> 3 </since_tizen>
237 public AudioLatencyMode AudioLatencyMode
241 NativePlayer.GetAudioLatencyMode(Handle, out var value).
242 ThrowIfFailed(this, "Failed to get the audio latency mode of the player");
248 ValidateNotDisposed();
250 ValidationUtil.ValidateEnum(typeof(AudioLatencyMode), value, nameof(value));
252 NativePlayer.SetAudioLatencyMode(Handle, value).
253 ThrowIfFailed(this, "Failed to set the audio latency mode of the player");
258 /// Gets or sets the looping state.
260 /// <value>true if the playback is looping; otherwise, false. The default value is false.</value>
261 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
262 /// <since_tizen> 3 </since_tizen>
263 public bool IsLooping
267 NativePlayer.IsLooping(Handle, out var value).
268 ThrowIfFailed(this, "Failed to get the looping state of the player");
274 ValidateNotDisposed();
276 NativePlayer.SetLooping(Handle, value).
277 ThrowIfFailed(this, "Failed to set the looping state of the player");
281 #region Display methods
283 private PlayerDisplaySettings _displaySettings;
286 /// Gets the display settings.
288 /// <value>A <see cref="PlayerDisplaySettings"/> that specifies the display settings.</value>
289 /// <since_tizen> 3 </since_tizen>
290 public PlayerDisplaySettings DisplaySettings => _displaySettings;
292 private Display _display;
294 private PlayerErrorCode SetDisplay(Display display)
298 return NativeDisplay.SetDisplay(Handle, PlayerDisplayType.None, IntPtr.Zero);
301 return display.ApplyTo(this);
304 private void ReplaceDisplay(Display newDisplay)
306 _display?.SetOwner(null);
307 _display = newDisplay;
308 _display?.SetOwner(this);
312 /// Gets or sets the display.
314 /// <value>A <see cref="Multimedia.Display"/> that specifies the display.</value>
316 /// The player must be in the <see cref="PlayerState.Idle"/> state.<br/>
317 /// The raw video feature(http://tizen.org/feature/multimedia.raw_video) is required if
318 /// the display is created with <see cref="MediaView"/>.
320 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
321 /// <exception cref="ArgumentException">The value has already been assigned to another player.</exception>
322 /// <exception cref="InvalidOperationException">The player is not in the valid state.</exception>
323 /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
324 /// <since_tizen> 3 </since_tizen>
325 public Display Display
333 ValidatePlayerState(PlayerState.Idle);
335 if (value != null && value.HasMediaView)
337 ValidationUtil.ValidateFeatureSupported(PlayerFeatures.RawVideo);
340 if (value?.Owner != null)
342 if (ReferenceEquals(this, value.Owner))
347 throw new ArgumentException("The display has already been assigned to another.");
350 SetDisplay(value).ThrowIfFailed(this, "Failed to configure display of the player");
352 ReplaceDisplay(value);
356 PlayerErrorCode IDisplayable<PlayerErrorCode>.ApplyEvasDisplay(DisplayType type, ElmSharp.EvasObject evasObject)
358 Debug.Assert(IsDisposed == false);
360 Debug.Assert(Enum.IsDefined(typeof(DisplayType), type));
361 Debug.Assert(type != DisplayType.None);
363 return NativeDisplay.SetDisplay(Handle,
364 type == DisplayType.Overlay ? PlayerDisplayType.Overlay : PlayerDisplayType.Evas, evasObject);
367 PlayerErrorCode IDisplayable<PlayerErrorCode>.ApplyEcoreWindow(IntPtr windowHandle)
369 Debug.Assert(IsDisposed == false);
371 return NativeDisplay.SetEcoreDisplay(Handle, PlayerDisplayType.Overlay, windowHandle);
375 private PlayerTrackInfo _audioTrack;
378 /// Gets the track info for the audio.
380 /// <value>A <see cref="PlayerTrackInfo"/> for audio.</value>
381 /// <since_tizen> 3 </since_tizen>
382 public PlayerTrackInfo AudioTrackInfo
386 if (_audioTrack == null)
388 _audioTrack = new PlayerTrackInfo(this, StreamType.Audio);
394 private PlayerTrackInfo _subtitleTrackInfo;
397 /// Gets the track info for the subtitle.
399 /// <value>A <see cref="PlayerTrackInfo"/> for the subtitle.</value>
400 /// <since_tizen> 3 </since_tizen>
401 public PlayerTrackInfo SubtitleTrackInfo
405 if (_subtitleTrackInfo == null)
407 _subtitleTrackInfo = new PlayerTrackInfo(this, StreamType.Text);
409 return _subtitleTrackInfo;
413 private StreamInfo _streamInfo;
416 /// Gets the stream information.
418 /// <value>A <see cref="StreamInfo"/> for this player.</value>
419 /// <since_tizen> 3 </since_tizen>
420 public StreamInfo StreamInfo
424 if (_streamInfo == null)
426 _streamInfo = new StreamInfo(this);
432 private AudioEffect _audioEffect;
435 /// Gets the audio effect.
437 /// <feature>http://tizen.org/feature/multimedia.custom_audio_effect</feature>
438 /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
439 /// <since_tizen> 3 </since_tizen>
440 public AudioEffect AudioEffect
444 if (_audioEffect == null)
446 throw new NotSupportedException($"The feature({PlayerFeatures.AudioEffect}) is not supported.");
454 /// Gets or sets the mute state.
456 /// <value>true if the player is muted; otherwise, false.</value>
457 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
458 /// <since_tizen> 3 </since_tizen>
463 NativePlayer.IsMuted(Handle, out var value).
464 ThrowIfFailed(this, "Failed to get the mute state of the player");
466 Log.Info(PlayerLog.Tag, "get mute : " + value);
472 NativePlayer.SetMute(Handle, value).ThrowIfFailed(this, "Failed to set the mute state of the player");
477 /// Gets or sets the current volume.
479 /// <remarks>Valid volume range is from 0 to 1.0, inclusive.</remarks>
480 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
481 /// <exception cref="ArgumentOutOfRangeException">
482 /// <paramref name="value"/> is less than zero.<br/>
484 /// <paramref name="value"/> is greater than 1.0.
486 /// <since_tizen> 3 </since_tizen>
492 NativePlayer.GetVolume(Handle, out value, out value).
493 ThrowIfFailed(this, "Failed to get the volume of the player");
499 if (value < 0F || 1.0F < value)
501 throw new ArgumentOutOfRangeException(nameof(value), value,
502 $"Valid volume range is 0 <= value <= 1.0, but got { value }.");
505 NativePlayer.SetVolume(Handle, value, value).
506 ThrowIfFailed(this, "Failed to set the volume of the player");
511 /// Gets or sets the audio-only state.
513 /// <value>true if the playback is audio-only mode; otherwise, false. The default value is false.</value>
514 /// The <see cref="Player"/> must be in the <see cref="PlayerState.Ready"/>,
515 /// <see cref="PlayerState.Playing"/>, or <see cref="PlayerState.Paused"/> state.
516 /// <exception cref="InvalidOperationException">The player is not in the valid state.</exception>
517 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
518 /// <since_tizen> 5 </since_tizen>
519 public bool IsAudioOnly
523 ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused);
524 NativePlayer.IsAudioOnly(Handle, out var value).
525 ThrowIfFailed(this, "Failed to get the audio-only state of the player");
530 ValidateNotDisposed();
531 ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused);
532 NativePlayer.SetAudioOnly(Handle, value).
533 ThrowIfFailed(this, "Failed to set the audio-only state of the player");
538 /// Gets or sets the player's replaygain state.
540 /// <value>If the replaygain status is true, replaygain is applied (if contents has a replaygain tag);
541 /// otherwise, the replaygain is not affected by tag and properties.</value>
542 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
543 /// <exception cref="InvalidOperationException">The player is not in the valid state.</exception>
544 /// <since_tizen> 5 </since_tizen>
545 public bool ReplayGain
549 ValidateNotDisposed();
550 NativePlayer.IsReplayGain(Handle, out var value).
551 ThrowIfFailed(this, "Failed to get the replaygain of the player");
556 ValidateNotDisposed();
557 NativePlayer.SetReplayGain(Handle, value).
558 ThrowIfFailed(this, "Failed to set the replaygain of the player");
563 /// Gets or sets the audio pitch.
565 /// <value>The value indicating whether or not AudioPitch is enabled. The default is false.</value>
566 /// <remarks>This function is used for audio content only.
567 /// To set, the player must be in the <see cref="PlayerState.Idle"/> state.</remarks>
568 /// <exception cref="InvalidOperationException">The player is not in the valid state.</exception>
569 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
570 /// <seealso cref="AudioPitch"/>
571 /// <since_tizen> 6 </since_tizen>
572 public bool AudioPitchEnabled
576 ValidateNotDisposed();
577 NativePlayer.IsAudioPitchEnabled(Handle, out var value).
578 ThrowIfFailed(this, "Failed to get whether the audio pitch is enabled or not");
584 ValidateNotDisposed();
585 ValidatePlayerState(PlayerState.Idle);
587 NativePlayer.SetAudioPitchEnabled(Handle, value).
588 ThrowIfFailed(this, "Failed to enable the audio pitch of the player");
593 /// Gets or sets the audio pitch value.
595 /// <value>The audio stream pitch value. The default is 1.</value>
596 /// <remarks>Enabling pitch control could increase the CPU usage on some devices.
597 /// This function is used for audio content only.</remarks>
598 /// <exception cref="InvalidOperationException">A pitch is not enabled.</exception>
599 /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
600 /// <exception cref="ArgumentOutOfRangeException">
601 /// value is less than 0.5.
603 /// value is greater than 2.0.<br/>
605 /// <seealso cref="AudioPitchEnabled"/>
606 /// <since_tizen> 6 </since_tizen>
607 public float AudioPitch
611 ValidateNotDisposed();
613 if (AudioPitchEnabled == false)
615 throw new InvalidOperationException("An audio pitch is not enabled.");
618 NativePlayer.GetAudioPitch(Handle, out var value).
619 ThrowIfFailed(this, "Failed to get the audio pitch");
626 ValidateNotDisposed();
628 if (AudioPitchEnabled == false)
630 throw new InvalidOperationException("An audio pitch is not enabled.");
633 if (value < 0.5F || 2.0F < value)
635 throw new ArgumentOutOfRangeException(nameof(value), value, "Valid value is 0.5 to 2.0");
638 NativePlayer.SetAudioPitch(Handle, value).ThrowIfFailed(this, "Failed to set the audio pitch");
642 private SphericalVideo _sphericalVideo;
645 /// Gets the spherical video settings.
647 /// <since_tizen> 5 </since_tizen>
648 public SphericalVideo SphericalVideo
652 if (_sphericalVideo == null)
654 _sphericalVideo = new SphericalVideo(this);
657 return _sphericalVideo;
661 private AdaptiveVariants _adaptiveVariants;
664 /// Gets the adaptive variants settings.
666 /// <since_tizen> 5 </since_tizen>
667 public AdaptiveVariants AdaptiveVariants
671 if (_adaptiveVariants == null)
673 _adaptiveVariants = new AdaptiveVariants(this);
676 return _adaptiveVariants;