src/Tizen.Multimedia.Remoting/MediaController/MediaControlServer.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 using System;
  18 using System.Collections.Generic;
  19 using System.Threading.Tasks;
  20 using Tizen.Applications;
  21 using Native = Interop.MediaControllerServer;
  22
  23 namespace Tizen.Multimedia.Remoting
  24 {
  25     /// <summary>
  26     /// Provides a means to set playback information and metadata and receive commands from clients.
  27     /// </summary>
  28     /// <seealso cref="MediaControllerManager"/>
  29     /// <seealso cref="MediaController"/>
  30     /// <since_tizen> 4 </since_tizen>
  31     public static partial class MediaControlServer
  32     {
  33         private static IntPtr _handle = IntPtr.Zero;
  34         private static bool? _isRunning;
  35
  36         /// <summary>
  37         /// Gets a value indicating whether the server is running.
  38         /// </summary>
  39         /// <value>true if the server has started; otherwise, false.</value>
  40         /// <seealso cref="Start"/>
  41         /// <seealso cref="Stop"/>
  42         /// <since_tizen> 4 </since_tizen>
  43         public static bool IsRunning
  44         {
  45             get
  46             {
  47                 if (_isRunning.HasValue == false)
  48                 {
  49                     _isRunning = GetRunningState();
  50                 }
  51
  52                 return _isRunning.Value;
  53             }
  54         }
  55
  56         private static bool GetRunningState()
  57         {
  58             IntPtr handle = IntPtr.Zero;
  59             try
  60             {
  61                 Native.ConnectDb(out handle).ThrowIfError("Failed to retrieve the running state.");
  62
  63                 Native.CheckServerExist(handle, Applications.Application.Current.ApplicationInfo.ApplicationId,
  64                     out var value).ThrowIfError("Failed to retrieve the running state.");
  65
  66                 return value;
  67             }
  68             finally
  69             {
  70                 if (handle != IntPtr.Zero)
  71                 {
  72                     Native.DisconnectDb(handle);
  73                 }
  74             }
  75         }
  76
  77         private static void EnsureInitializedIfRunning()
  78         {
  79             if (_handle != IntPtr.Zero)
  80             {
  81                 return;
  82             }
  83
  84             if (IsRunning == false)
  85             {
  86                 throw new InvalidOperationException("The server is not running.");
  87             }
  88
  89             Initialize();
  90         }
  91
  92         private static IntPtr Handle
  93         {
  94             get
  95             {
  96                 EnsureInitializedIfRunning();
  97
  98                 return _handle;
  99             }
 100         }
 101
 102         private static void Initialize()
 103         {
 104             Native.Create(out _handle).ThrowIfError("Failed to create media controller server.");
 105
 106             try
 107             {
 108                 RegisterPlaybackCommandReceivedEvent();
 109                 RegisterPlaybackActionCommandReceivedEvent();
 110                 RegisterPlaybackPositionCommandReceivedEvent();
 111                 RegisterPlaylistCommandReceivedEvent();
 112                 RegisterShuffleModeCommandReceivedEvent();
 113                 RegisterRepeatModeCommandReceivedEvent();
 114                 RegisterCustomCommandReceivedEvent();
 115                 RegisterCommandCompletedEvent();
 116                 RegisterSearchCommandReceivedEvent();
 117
 118                 _isRunning = true;
 119             }
 120             catch
 121             {
 122                 Native.Destroy(_handle);
 123                 _playbackCommandCallback = null;
 124                 _handle = IntPtr.Zero;
 125                 throw;
 126             }
 127         }
 128
 129         /// <summary>
 130         /// Starts the media control server.
 131         /// </summary>
 132         /// <remarks>
 133         /// When the server starts, <see cref="MediaControllerManager.ServerStarted"/> will be raised.
 134         /// </remarks>
 135         /// <privilege>http://tizen.org/privilege/mediacontroller.server</privilege>
 136         /// <exception cref="InvalidOperationException">An internal error occurs.</exception>
 137         /// <exception cref="UnauthorizedAccessException">Caller does not have required privilege.</exception>
 138         /// <seealso cref="MediaControllerManager.ServerStarted"/>
 139         /// <since_tizen> 4 </since_tizen>
 140         public static void Start()
 141         {
 142             Initialize();
 143         }
 144
 145         /// <summary>
 146         /// Stops the media control server.
 147         /// </summary>
 148         /// <remarks>
 149         /// When the server stops, <see cref="MediaControllerManager.ServerStopped"/> will be raised.
 150         /// </remarks>
 151         /// <exception cref="InvalidOperationException">
 152         ///     The server is not running .<br/>
 153         ///     -or-<br/>
 154         ///     An internal error occurs.
 155         /// </exception>
 156         /// <seealso cref="MediaControllerManager.ServerStopped"/>
 157         /// <since_tizen> 4 </since_tizen>
 158         public static void Stop()
 159         {
 160             EnsureInitializedIfRunning();
 161
 162             Native.Destroy(_handle).ThrowIfError("Failed to stop the server.");
 163
 164             _handle = IntPtr.Zero;
 165             _playbackCommandCallback = null;
 166             _isRunning = false;
 167         }
 168
 169         /// <summary>
 170         /// Updates playback state and playback position.</summary>
 171         /// <param name="state">The playback state.</param>
 172         /// <param name="position">The playback position in milliseconds.</param>
 173         /// <exception cref="ArgumentException"><paramref name="state"/> is not valid.</exception>
 174         /// <exception cref="ArgumentOutOfRangeException"><paramref name="position"/> is less than zero.</exception>
 175         /// <exception cref="InvalidOperationException">
 176         ///     The server is not running .<br/>
 177         ///     -or-<br/>
 178         ///     An internal error occurs.
 179         /// </exception>
 180         /// <since_tizen> 4 </since_tizen>
 181         public static void SetPlaybackState(MediaControlPlaybackState state, long position)
 182         {
 183             ValidationUtil.ValidateEnum(typeof(MediaControlPlaybackState), state, nameof(state));
 184
 185             if (position < 0)
 186             {
 187                 throw new ArgumentOutOfRangeException(nameof(position), position, "position can't be less than zero.");
 188             }
 189
 190             Native.SetPlaybackState(Handle, state.ToNative()).ThrowIfError("Failed to set playback state.");
 191
 192             Native.SetPlaybackPosition(Handle, (ulong)position).ThrowIfError("Failed to set playback position.");
 193
 194             Native.UpdatePlayback(Handle).ThrowIfError("Failed to set playback.");
 195         }
 196
 197         private static void SetMetadata(MediaControllerNativeAttribute attribute, string value)
 198         {
 199             Native.SetMetadata(Handle, attribute, value).ThrowIfError($"Failed to set metadata({attribute}).");
 200         }
 201
 202         /// <summary>
 203         /// Updates metadata information.
 204         /// </summary>
 205         /// <param name="metadata">The metadata to update.</param>
 206         /// <exception cref="ArgumentNullException"><paramref name="metadata"/> is null.</exception>
 207         /// <exception cref="InvalidOperationException">
 208         ///     The server is not running .<br/>
 209         ///     -or-<br/>
 210         ///     An internal error occurs.
 211         /// </exception>
 212         /// <since_tizen> 4 </since_tizen>
 213         public static void SetMetadata(MediaControlMetadata metadata)
 214         {
 215             if (metadata == null)
 216             {
 217                 throw new ArgumentNullException(nameof(metadata));
 218             }
 219
 220             SetMetadata(MediaControllerNativeAttribute.Title, metadata.Title);
 221             SetMetadata(MediaControllerNativeAttribute.Artist, metadata.Artist);
 222             SetMetadata(MediaControllerNativeAttribute.Album, metadata.Album);
 223             SetMetadata(MediaControllerNativeAttribute.Author, metadata.Author);
 224             SetMetadata(MediaControllerNativeAttribute.Genre, metadata.Genre);
 225             SetMetadata(MediaControllerNativeAttribute.Duration, metadata.Duration);
 226             SetMetadata(MediaControllerNativeAttribute.Date, metadata.Date);
 227             SetMetadata(MediaControllerNativeAttribute.Copyright, metadata.Copyright);
 228             SetMetadata(MediaControllerNativeAttribute.Description, metadata.Description);
 229             SetMetadata(MediaControllerNativeAttribute.TrackNumber, metadata.TrackNumber);
 230             SetMetadata(MediaControllerNativeAttribute.Picture, metadata.AlbumArtPath);
 231
 232             Native.UpdateMetadata(Handle).ThrowIfError("Failed to set metadata.");
 233         }
 234
 235         /// <summary>
 236         /// Updates the shuffle mode.
 237         /// </summary>
 238         /// <param name="enabled">A value indicating whether the shuffle mode is enabled.</param>
 239         /// <exception cref="InvalidOperationException">
 240         ///     The server is not running .<br/>
 241         ///     -or-<br/>
 242         ///     An internal error occurs.
 243         /// </exception>
 244         /// <since_tizen> 4 </since_tizen>
 245         public static void SetShuffleModeEnabled(bool enabled)
 246         {
 247             Native.UpdateShuffleMode(Handle, enabled ? MediaControllerNativeShuffleMode.On : MediaControllerNativeShuffleMode.Off).
 248                 ThrowIfError("Failed to set shuffle mode.");
 249         }
 250
 251         /// <summary>
 252         /// Updates the repeat mode.
 253         /// </summary>
 254         /// <param name="mode">A value indicating the repeat mode.</param>
 255         /// <exception cref="InvalidOperationException">
 256         ///     The server is not running .<br/>
 257         ///     -or-<br/>
 258         ///     An internal error occurs.
 259         /// </exception>
 260         /// <exception cref="ArgumentException"><paramref name="mode"/> is invalid.</exception>
 261         /// <since_tizen> 4 </since_tizen>
 262         public static void SetRepeatMode(MediaControlRepeatMode mode)
 263         {
 264             ValidationUtil.ValidateEnum(typeof(MediaControlRepeatMode), mode, nameof(mode));
 265
 266             Native.UpdateRepeatMode(Handle, mode.ToNative()).ThrowIfError("Failed to set repeat mode.");
 267         }
 268
 269         /// <summary>
 270         /// Sets the index of current playing media.
 271         /// </summary>
 272         /// <param name="index">The index of current playing media.</param>
 273         /// <exception cref="ArgumentNullException"><paramref name="index"/> is null.</exception>
 274         /// <exception cref="InvalidOperationException">
 275         ///     The server is not running .<br/>
 276         ///     -or-<br/>
 277         ///     An internal error occurs.
 278         /// </exception>
 279         /// <since_tizen> 5 </since_tizen>
 280         public static void SetIndexOfCurrentPlayingMedia(string index)
 281         {
 282             Native.SetIndexOfCurrentPlayingMedia(Handle, index)
 283                 .ThrowIfError("Failed to set the index of current playing media");
 284         }
 285
 286         /// <summary>
 287         /// Delete playlist.
 288         /// </summary>
 289         /// <param name="playlist">The name of playlist.</param>
 290         /// <exception cref="InvalidOperationException">
 291         ///     The server is not running .<br/>
 292         ///     -or-<br/>
 293         ///     An internal error occurs.
 294         /// </exception>
 295         /// <since_tizen> 5 </since_tizen>
 296         public static void RemovePlaylist(MediaControlPlaylist playlist)
 297         {
 298             Native.DeletePlaylist(Handle, playlist.Handle);
 299             playlist.Dispose();
 300         }
 301
 302         // Saves the playlist to the persistent storage.
 303         internal static void SavePlaylist(IntPtr playlistHandle)
 304         {
 305             Native.SavePlaylist(Handle, playlistHandle).ThrowIfError("Failed to save playlist");
 306         }
 307
 308         // Gets the playlist handle by name.
 309         internal static IntPtr GetPlaylistHandle(string name)
 310         {
 311             Native.GetPlaylistHandle(Handle, name, out IntPtr playlistHandle)
 312                 .ThrowIfError("Failed to get playlist handle by name");
 313
 314             return playlistHandle;
 315         }
 316
 317         /// <summary>
 318         /// Gets the active clients.
 319         /// </summary>
 320         /// <exception cref="InvalidOperationException">
 321         ///     The server is not running .<br/>
 322         ///     -or-<br/>
 323         ///     An internal error occurs.
 324         /// </exception>
 325         /// <returns>the activated client ids.</returns>
 326         /// <since_tizen> 5 </since_tizen>
 327         public static IEnumerable<string> GetActivatedClients()
 328         {
 329             var clientIds = new List<string>();
 330
 331             Native.ActivatedClientCallback activatedClientCallback = (name, _) =>
 332             {
 333                 clientIds.Add(name);
 334                 return true;
 335             };
 336
 337             Native.ForeachActivatedClient(Handle, activatedClientCallback).
 338                 ThrowIfError("Failed to get activated client.");
 339
 340             return clientIds.AsReadOnly();
 341         }
 342
 343         /// <summary>
 344         /// Requests commands to the client.
 345         /// </summary>
 346         /// <remarks>
 347         /// The client can request the command to execute <see cref="Command"/>, <br/>
 348         /// and then, the server receive the result of each request(command).
 349         /// </remarks>
 350         /// <param name="command">A <see cref="Command"/> class.</param>
 351         /// <param name="clientId">The client Id to send command.</param>
 352         /// <returns>A task that represents the asynchronous operation.</returns>
 353         /// <exception cref="InvalidOperationException">
 354         ///     The server has already been stopped.<br/>
 355         ///     -or-<br/>
 356         ///     An internal error occurs.
 357         /// </exception>
 358         /// <since_tizen> 5 </since_tizen>
 359         public static async Task RequestAsync(Command command, string clientId)
 360         {
 361             command.SetRequestInformation(clientId);
 362
 363             var tcs = new TaskCompletionSource<MediaControllerError>();
 364             string reqeustId = null;
 365
 366             EventHandler<CommandCompletedEventArgs> eventHandler = (s, e) =>
 367             {
 368                 if (e.RequestId == reqeustId)
 369                 {
 370                     tcs.TrySetResult(e.Result);
 371                 }
 372             };
 373
 374             try
 375             {
 376                 CommandCompleted += eventHandler;
 377
 378                 reqeustId = command.Request(Handle);
 379
 380                 (await tcs.Task).ThrowIfError("Failed to request event.");
 381             }
 382             finally
 383             {
 384                 CommandCompleted -= eventHandler;
 385             }
 386         }
 387
 388         /// <summary>
 389         /// Sends the result of each command.
 390         /// </summary>
 391         /// <param name="command">The command that return to client.</param>
 392         /// <param name="result">The result of <paramref name="command"/>.</param>
 393         /// <param name="bundle">The extra data.</param>
 394         /// <exception cref="InvalidOperationException">
 395         ///     The server is not running .<br/>
 396         ///     -or-<br/>
 397         ///     An internal error occurs.
 398         /// </exception>
 399         /// <since_tizen> 5 </since_tizen>
 400         public static void Response(Command command, int result, Bundle bundle)
 401         {
 402             command.Response(Handle, result, bundle);
 403         }
 404
 405         /// <summary>
 406         /// Sends the result of each command.
 407         /// </summary>
 408         /// <param name="command">The command that return to client.</param>
 409         /// <param name="result">The result of <paramref name="command"/>.</param>
 410         /// <exception cref="InvalidOperationException">
 411         ///     The server is not running .<br/>
 412         ///     -or-<br/>
 413         ///     An internal error occurs.
 414         /// </exception>
 415         /// <since_tizen> 5 </since_tizen>
 416         public static void Response(Command command, int result)
 417         {
 418             command.Response(Handle, result, null);
 419         }
 420
 421         #region Capabilities
 422         /// <summary>
 423         /// Sets the content type of latest played media.
 424         /// </summary>
 425         /// <param name="type">A value indicating the content type of the latest played media.</param>
 426         /// <exception cref="InvalidOperationException">
 427         ///     The server is not running .<br/>
 428         ///     -or-<br/>
 429         ///     An internal error occurs.
 430         /// </exception>
 431         /// <exception cref="ArgumentException"><paramref name="type"/> is invalid.</exception>
 432         /// <since_tizen> 5 </since_tizen>
 433         public static void SetPlaybackContentType(MediaControlContentType type)
 434         {
 435             ValidationUtil.ValidateEnum(typeof(MediaControlContentType), type, nameof(type));
 436
 437             Native.SetPlaybackContentType(Handle, type).ThrowIfError("Failed to set playback content type.");
 438         }
 439
 440         /// <summary>
 441         /// Sets the path of icon.
 442         /// </summary>
 443         /// <param name="path">The path of icon.</param>
 444         /// <exception cref="InvalidOperationException">
 445         ///     The server is not running .<br/>
 446         ///     -or-<br/>
 447         ///     An internal error occurs.
 448         /// </exception>
 449         /// <exception cref="ArgumentNullException"><paramref name="path"/> is invalid.</exception>
 450         /// <since_tizen> 5 </since_tizen>
 451         public static void SetIconPath(string path)
 452         {
 453             if (path == null)
 454             {
 455                 throw new ArgumentNullException(nameof(path));
 456             }
 457
 458             Native.SetIconPath(Handle, path).ThrowIfError("Failed to set uri path.");
 459         }
 460
 461         /// <summary>
 462         /// Sets the capabilities by <see cref="MediaControlPlaybackCommand"/>.
 463         /// </summary>
 464         /// <param name="capabilities">The set of <see cref="MediaControlPlaybackCommand"/> and <see cref="MediaControlCapabilitySupport"/>.</param>
 465         /// <exception cref="InvalidOperationException">
 466         ///     The server is not running .<br/>
 467         ///     -or-<br/>
 468         ///     An internal error occurs.
 469         /// </exception>
 470         /// <exception cref="ArgumentException"><paramref name="capabilities"/> is invalid.</exception>
 471         /// <since_tizen> 5 </since_tizen>
 472         public static void SetPlaybackCapability(Dictionary<MediaControlPlaybackCommand, MediaControlCapabilitySupport> capabilities)
 473         {
 474             foreach (var pair in capabilities)
 475             {
 476                 ValidationUtil.ValidateEnum(typeof(MediaControlPlaybackCommand), pair.Key, nameof(pair.Key));
 477                 ValidationUtil.ValidateEnum(typeof(MediaControlCapabilitySupport), pair.Value, nameof(pair.Value));
 478
 479                 SetPlaybackCapability(pair.Key, pair.Value);
 480                 Native.SetPlaybackCapability(Handle, pair.Key.ToNative(), pair.Value).
 481                     ThrowIfError("Failed to set playback capability.");
 482             }
 483
 484             Native.SaveAndNotifyPlaybackCapabilityUpdated(Handle).ThrowIfError("Failed to update playback capability.");
 485         }
 486
 487         /// <summary>
 488         /// Sets the capabilities by <see cref="MediaControlPlaybackCommand"/>.
 489         /// </summary>
 490         /// <param name="action">A playback command.</param>
 491         /// <param name="support">A value indicating whether the <paramref name="action"/> is supported or not.</param>
 492         /// <exception cref="InvalidOperationException">
 493         ///     The server is not running .<br/>
 494         ///     -or-<br/>
 495         ///     An internal error occurs.
 496         /// </exception>
 497         /// <exception cref="ArgumentException"><paramref name="action"/> or <paramref name="support"/> is invalid.</exception>
 498         /// <since_tizen> 5 </since_tizen>
 499         public static void SetPlaybackCapability(MediaControlPlaybackCommand action, MediaControlCapabilitySupport support)
 500         {
 501             ValidationUtil.ValidateEnum(typeof(MediaControlPlaybackCommand), action, nameof(action));
 502             ValidationUtil.ValidateEnum(typeof(MediaControlCapabilitySupport), support, nameof(support));
 503
 504             Native.SetPlaybackCapability(Handle, action.ToNative(), support).ThrowIfError("Failed to set playback capability.");
 505
 506             Native.SaveAndNotifyPlaybackCapabilityUpdated(Handle).ThrowIfError("Failed to update playback capability.");
 507         }
 508
 509         /// <summary>
 510         /// Sets the <see cref="MediaControlCapabilitySupport"/> indicating shuffle mode is supported or not.
 511         /// </summary>
 512         /// <param name="support">A value indicating whether the shuffle mode is supported or not.</param>
 513         /// <exception cref="InvalidOperationException">
 514         ///     The server is not running .<br/>
 515         ///     -or-<br/>
 516         ///     An internal error occurs.
 517         /// </exception>
 518         /// <exception cref="ArgumentException"><paramref name="support"/> is invalid.</exception>
 519         /// <since_tizen> 5 </since_tizen>
 520         public static void SetShuffleModeCapability(MediaControlCapabilitySupport support)
 521         {
 522             ValidationUtil.ValidateEnum(typeof(MediaControlCapabilitySupport), support, nameof(support));
 523
 524             Native.SetShuffleModeCapability(Handle, support).ThrowIfError("Failed to set shuffle mode capability.");
 525         }
 526
 527         /// <summary>
 528         /// Sets the content type of latest played media.
 529         /// </summary>
 530         /// <param name="support">A value indicating whether the <see cref="MediaControlRepeatMode"/> is supported or not.</param>
 531         /// <exception cref="InvalidOperationException">
 532         ///     The server is not running .<br/>
 533         ///     -or-<br/>
 534         ///     An internal error occurs.
 535         /// </exception>
 536         /// <exception cref="ArgumentException"><paramref name="support"/> is invalid.</exception>
 537         /// <since_tizen> 5 </since_tizen>
 538         public static void SetRepeatModeCapability(MediaControlCapabilitySupport support)
 539         {
 540             ValidationUtil.ValidateEnum(typeof(MediaControlCapabilitySupport), support, nameof(support));
 541
 542             Native.SetRepeatModeCapability(Handle, support).ThrowIfError("Failed to set shuffle mode capability.");
 543         }
 544         #endregion Capabilities
 545     }
 546 }