Merge remote-tracking branch 'upstream/master' into no-scaling

11 files changed, 213 insertions, 88 deletions

diff --git a/Emby.Dlna/Common/Argument.cs b/Emby.Dlna/Common/Argument.cs
index 430a3b47d5..e4e9c55e0d 100644
--- a/Emby.Dlna/Common/Argument.cs
+++ b/Emby.Dlna/Common/Argument.cs
@@ -1,7 +1,7 @@
 namespace Emby.Dlna.Common
 {
     /// <summary>
-    /// DLNA Query parameter type, used when quering DLNA devices via SOAP.
+    /// DLNA Query parameter type, used when querying DLNA devices via SOAP.
     /// </summary>
     public class Argument
     {
diff --git a/Emby.Dlna/Configuration/DlnaOptions.cs b/Emby.Dlna/Configuration/DlnaOptions.cs
index 6dd9a445a8..e63a858605 100644
--- a/Emby.Dlna/Configuration/DlnaOptions.cs
+++ b/Emby.Dlna/Configuration/DlnaOptions.cs
@@ -2,8 +2,14 @@
 
 namespace Emby.Dlna.Configuration
 {
+    /// <summary>
+    /// The DlnaOptions class contains the user definable parameters for the dlna subsystems.
+    /// </summary>
     public class DlnaOptions
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DlnaOptions"/> class.
+        /// </summary>
         public DlnaOptions()
         {
             EnablePlayTo = true;
@@ -11,23 +17,76 @@ namespace Emby.Dlna.Configuration
             BlastAliveMessages = true;
             SendOnlyMatchedHost = true;
             ClientDiscoveryIntervalSeconds = 60;
-            BlastAliveMessageIntervalSeconds = 1800;
+            AliveMessageIntervalSeconds = 1800;
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether gets or sets a value to indicate the status of the dlna playTo subsystem.
+        /// </summary>
         public bool EnablePlayTo { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether gets or sets a value to indicate the status of the dlna server subsystem.
+        /// </summary>
         public bool EnableServer { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether detailed dlna server logs are sent to the console/log.
+        /// If the setting "Emby.Dlna": "Debug" msut be set in logging.default.json for this property to work.
+        /// </summary>
         public bool EnableDebugLog { get; set; }
 
-        public bool BlastAliveMessages { get; set; }
-
-        public bool SendOnlyMatchedHost { get; set; }
+        /// <summary>
+        /// Gets or sets a value indicating whether whether detailed playTo debug logs are sent to the console/log.
+        /// If the setting "Emby.Dlna.PlayTo": "Debug" msut be set in logging.default.json for this property to work.
+        /// </summary>
+        public bool EnablePlayToTracing { get; set; }
 
+        /// <summary>
+        /// Gets or sets the ssdp client discovery interval time (in seconds).
+        /// This is the time after which the server will send a ssdp search request.
+        /// </summary>
         public int ClientDiscoveryIntervalSeconds { get; set; }
 
-        public int BlastAliveMessageIntervalSeconds { get; set; }
+        /// <summary>
+        /// Gets or sets the frequency at which ssdp alive notifications are transmitted.
+        /// </summary>
+        public int AliveMessageIntervalSeconds { get; set; }
+
+        /// <summary>
+        /// Gets or sets the frequency at which ssdp alive notifications are transmitted. MIGRATING - TO BE REMOVED ONCE WEB HAS BEEN ALTERED.
+        /// </summary>
+        public int BlastAliveMessageIntervalSeconds
+        {
+            get
+            {
+                return AliveMessageIntervalSeconds;
+            }
+
+            set
+            {
+                AliveMessageIntervalSeconds = value;
+            }
+        }
 
+        /// <summary>
+        /// Gets or sets the default user account that the dlna server uses.
+        /// </summary>
         public string DefaultUserId { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether playTo device profiles should be created.
+        /// </summary>
+        public bool AutoCreatePlayToProfiles { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to blast alive messages.
+        /// </summary>
+        public bool BlastAliveMessages { get; set; } = true;
+
+        /// <summary>
+        /// gets or sets a value indicating whether to send only matched host.
+        /// </summary>
+        public bool SendOnlyMatchedHost { get; set; } = true;
     }
 }
diff --git a/Emby.Dlna/ConnectionManager/ConnectionManagerService.cs b/Emby.Dlna/ConnectionManager/ConnectionManagerService.cs
index f5a7eca720..916044a0cc 100644
--- a/Emby.Dlna/ConnectionManager/ConnectionManagerService.cs
+++ b/Emby.Dlna/ConnectionManager/ConnectionManagerService.cs
@@ -9,11 +9,21 @@ using Microsoft.Extensions.Logging;
 
 namespace Emby.Dlna.ConnectionManager
 {
+    /// <summary>
+    /// Defines the <see cref="ConnectionManagerService" />.
+    /// </summary>
     public class ConnectionManagerService : BaseService, IConnectionManager
     {
         private readonly IDlnaManager _dlna;
         private readonly IServerConfigurationManager _config;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConnectionManagerService"/> class.
+        /// </summary>
+        /// <param name="dlna">The <see cref="IDlnaManager"/> for use with the <see cref="ConnectionManagerService"/> instance.</param>
+        /// <param name="config">The <see cref="IServerConfigurationManager"/> for use with the <see cref="ConnectionManagerService"/> instance.</param>
+        /// <param name="logger">The <see cref="ILogger{ConnectionManagerService}"/> for use with the <see cref="ConnectionManagerService"/> instance..</param>
+        /// <param name="httpClientFactory">The <see cref="IHttpClientFactory"/> for use with the <see cref="ConnectionManagerService"/> instance..</param>
         public ConnectionManagerService(
             IDlnaManager dlna,
             IServerConfigurationManager config,
@@ -28,7 +38,7 @@ namespace Emby.Dlna.ConnectionManager
         /// <inheritdoc />
         public string GetServiceXml()
         {
-            return new ConnectionManagerXmlBuilder().GetXml();
+            return ConnectionManagerXmlBuilder.GetXml();
         }
 
         /// <inheritdoc />
diff --git a/Emby.Dlna/ConnectionManager/ConnectionManagerXmlBuilder.cs b/Emby.Dlna/ConnectionManager/ConnectionManagerXmlBuilder.cs
index c8db5a3674..c484dac542 100644
--- a/Emby.Dlna/ConnectionManager/ConnectionManagerXmlBuilder.cs
+++ b/Emby.Dlna/ConnectionManager/ConnectionManagerXmlBuilder.cs
@@ -6,45 +6,57 @@ using Emby.Dlna.Service;
 
 namespace Emby.Dlna.ConnectionManager
 {
-    public class ConnectionManagerXmlBuilder
+    /// <summary>
+    /// Defines the <see cref="ConnectionManagerXmlBuilder" />.
+    /// </summary>
+    public static class ConnectionManagerXmlBuilder
     {
-        public string GetXml()
+        /// <summary>
+        /// Gets the ConnectionManager:1 service template.
+        /// See http://upnp.org/specs/av/UPnP-av-ConnectionManager-v1-Service.pdf.
+        /// </summary>
+        /// <returns>An XML description of this service.</returns>
+        public static string GetXml()
         {
-            return new ServiceXmlBuilder().GetXml(new ServiceActionListBuilder().GetActions(), GetStateVariables());
+            return new ServiceXmlBuilder().GetXml(ServiceActionListBuilder.GetActions(), GetStateVariables());
         }
 
+        /// <summary>
+        /// Get the list of state variables for this invocation.
+        /// </summary>
+        /// <returns>The <see cref="IEnumerable{StateVariable}"/>.</returns>
         private static IEnumerable<StateVariable> GetStateVariables()
         {
-            var list = new List<StateVariable>();
-
-            list.Add(new StateVariable
+            var list = new List<StateVariable>
             {
-                Name = "SourceProtocolInfo",
-                DataType = "string",
-                SendsEvents = true
-            });
+                new StateVariable
+                {
+                    Name = "SourceProtocolInfo",
+                    DataType = "string",
+                    SendsEvents = true
+                },
 
-            list.Add(new StateVariable
-            {
-                Name = "SinkProtocolInfo",
-                DataType = "string",
-                SendsEvents = true
-            });
+                new StateVariable
+                {
+                    Name = "SinkProtocolInfo",
+                    DataType = "string",
+                    SendsEvents = true
+                },
 
-            list.Add(new StateVariable
-            {
-                Name = "CurrentConnectionIDs",
-                DataType = "string",
-                SendsEvents = true
-            });
+                new StateVariable
+                {
+                    Name = "CurrentConnectionIDs",
+                    DataType = "string",
+                    SendsEvents = true
+                },
 
-            list.Add(new StateVariable
-            {
-                Name = "A_ARG_TYPE_ConnectionStatus",
-                DataType = "string",
-                SendsEvents = false,
+                new StateVariable
+                {
+                    Name = "A_ARG_TYPE_ConnectionStatus",
+                    DataType = "string",
+                    SendsEvents = false,
 
-                AllowedValues = new[]
+                    AllowedValues = new[]
                 {
                     "OK",
                     "ContentFormatMismatch",
@@ -52,55 +64,56 @@ namespace Emby.Dlna.ConnectionManager
                     "UnreliableChannel",
                     "Unknown"
                 }
-            });
+                },
 
-            list.Add(new StateVariable
-            {
-                Name = "A_ARG_TYPE_ConnectionManager",
-                DataType = "string",
-                SendsEvents = false
-            });
+                new StateVariable
+                {
+                    Name = "A_ARG_TYPE_ConnectionManager",
+                    DataType = "string",
+                    SendsEvents = false
+                },
 
-            list.Add(new StateVariable
-            {
-                Name = "A_ARG_TYPE_Direction",
-                DataType = "string",
-                SendsEvents = false,
+                new StateVariable
+                {
+                    Name = "A_ARG_TYPE_Direction",
+                    DataType = "string",
+                    SendsEvents = false,
 
-                AllowedValues = new[]
+                    AllowedValues = new[]
                 {
                     "Output",
                     "Input"
                 }
-            });
+                },
 
-            list.Add(new StateVariable
-            {
-                Name = "A_ARG_TYPE_ProtocolInfo",
-                DataType = "string",
-                SendsEvents = false
-            });
+                new StateVariable
+                {
+                    Name = "A_ARG_TYPE_ProtocolInfo",
+                    DataType = "string",
+                    SendsEvents = false
+                },
 
-            list.Add(new StateVariable
-            {
-                Name = "A_ARG_TYPE_ConnectionID",
-                DataType = "ui4",
-                SendsEvents = false
-            });
+                new StateVariable
+                {
+                    Name = "A_ARG_TYPE_ConnectionID",
+                    DataType = "ui4",
+                    SendsEvents = false
+                },
 
-            list.Add(new StateVariable
-            {
-                Name = "A_ARG_TYPE_AVTransportID",
-                DataType = "ui4",
-                SendsEvents = false
-            });
+                new StateVariable
+                {
+                    Name = "A_ARG_TYPE_AVTransportID",
+                    DataType = "ui4",
+                    SendsEvents = false
+                },
 
-            list.Add(new StateVariable
-            {
-                Name = "A_ARG_TYPE_RcsID",
-                DataType = "ui4",
-                SendsEvents = false
-            });
+                new StateVariable
+                {
+                    Name = "A_ARG_TYPE_RcsID",
+                    DataType = "ui4",
+                    SendsEvents = false
+                }
+            };
 
             return list;
         }
diff --git a/Emby.Dlna/ConnectionManager/ControlHandler.cs b/Emby.Dlna/ConnectionManager/ControlHandler.cs
index d4cc653942..2f8d197a7a 100644
--- a/Emby.Dlna/ConnectionManager/ControlHandler.cs
+++ b/Emby.Dlna/ConnectionManager/ControlHandler.cs
@@ -11,10 +11,19 @@ using Microsoft.Extensions.Logging;
 
 namespace Emby.Dlna.ConnectionManager
 {
+    /// <summary>
+    /// Defines the <see cref="ControlHandler" />.
+    /// </summary>
     public class ControlHandler : BaseControlHandler
     {
         private readonly DeviceProfile _profile;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ControlHandler"/> class.
+        /// </summary>
+        /// <param name="config">The <see cref="IServerConfigurationManager"/> for use with the <see cref="ControlHandler"/> instance.</param>
+        /// <param name="logger">The <see cref="ILogger"/> for use with the <see cref="ControlHandler"/> instance.</param>
+        /// <param name="profile">The <see cref="DeviceProfile"/> for use with the <see cref="ControlHandler"/> instance.</param>
         public ControlHandler(IServerConfigurationManager config, ILogger logger, DeviceProfile profile)
             : base(config, logger)
         {
@@ -33,6 +42,10 @@ namespace Emby.Dlna.ConnectionManager
             throw new ResourceNotFoundException("Unexpected control request name: " + methodName);
         }
 
+        /// <summary>
+        /// Builds the response to the GetProtocolInfo request.
+        /// </summary>
+        /// <param name="xmlWriter">The <see cref="XmlWriter"/>.</param>
         private void HandleGetProtocolInfo(XmlWriter xmlWriter)
         {
             xmlWriter.WriteElementString("Source", _profile.ProtocolInfo);
diff --git a/Emby.Dlna/ConnectionManager/ServiceActionListBuilder.cs b/Emby.Dlna/ConnectionManager/ServiceActionListBuilder.cs
index b853e7eab6..542c7bfb4b 100644
--- a/Emby.Dlna/ConnectionManager/ServiceActionListBuilder.cs
+++ b/Emby.Dlna/ConnectionManager/ServiceActionListBuilder.cs
@@ -5,9 +5,16 @@ using Emby.Dlna.Common;
 
 namespace Emby.Dlna.ConnectionManager
 {
-    public class ServiceActionListBuilder
+    /// <summary>
+    /// Defines the <see cref="ServiceActionListBuilder" />.
+    /// </summary>
+    public static class ServiceActionListBuilder
     {
-        public IEnumerable<ServiceAction> GetActions()
+        /// <summary>
+        /// Returns an enumerable of the ConnectionManagar:1 DLNA actions.
+        /// </summary>
+        /// <returns>An <see cref="IEnumerable{ServiceAction}"/>.</returns>
+        public static IEnumerable<ServiceAction> GetActions()
         {
             var list = new List<ServiceAction>
             {
@@ -21,6 +28,10 @@ namespace Emby.Dlna.ConnectionManager
             return list;
         }
 
+        /// <summary>
+        /// Returns the action details for "PrepareForConnection".
+        /// </summary>
+        /// <returns>The <see cref="ServiceAction"/>.</returns>
         private static ServiceAction PrepareForConnection()
         {
             var action = new ServiceAction
@@ -80,6 +91,10 @@ namespace Emby.Dlna.ConnectionManager
             return action;
         }
 
+        /// <summary>
+        /// Returns the action details for "GetCurrentConnectionInfo".
+        /// </summary>
+        /// <returns>The <see cref="ServiceAction"/>.</returns>
         private static ServiceAction GetCurrentConnectionInfo()
         {
             var action = new ServiceAction
@@ -146,7 +161,11 @@ namespace Emby.Dlna.ConnectionManager
             return action;
         }
 
-        private ServiceAction GetProtocolInfo()
+        /// <summary>
+        /// Returns the action details for "GetProtocolInfo".
+        /// </summary>
+        /// <returns>The <see cref="ServiceAction"/>.</returns>
+        private static ServiceAction GetProtocolInfo()
         {
             var action = new ServiceAction
             {
@@ -170,7 +189,11 @@ namespace Emby.Dlna.ConnectionManager
             return action;
         }
 
-        private ServiceAction GetCurrentConnectionIDs()
+        /// <summary>
+        /// Returns the action details for "GetCurrentConnectionIDs".
+        /// </summary>
+        /// <returns>The <see cref="ServiceAction"/>.</returns>
+        private static ServiceAction GetCurrentConnectionIDs()
         {
             var action = new ServiceAction
             {
@@ -187,7 +210,11 @@ namespace Emby.Dlna.ConnectionManager
             return action;
         }
 
-        private ServiceAction ConnectionComplete()
+        /// <summary>
+        /// Returns the action details for "ConnectionComplete".
+        /// </summary>
+        /// <returns>The <see cref="ServiceAction"/>.</returns>
+        private static ServiceAction ConnectionComplete()
         {
             var action = new ServiceAction
             {
diff --git a/Emby.Dlna/ContentDirectory/ControlHandler.cs b/Emby.Dlna/ContentDirectory/ControlHandler.cs
index 9f35c19594..b93651746b 100644
--- a/Emby.Dlna/ContentDirectory/ControlHandler.cs
+++ b/Emby.Dlna/ContentDirectory/ControlHandler.cs
@@ -1674,7 +1674,7 @@ namespace Emby.Dlna.ContentDirectory
         }
 
         /// <summary>
-        /// Retreives the ServerItem id.
+        /// Retrieves the ServerItem id.
         /// </summary>
         /// <param name="id">The id<see cref="string"/>.</param>
         /// <returns>The <see cref="ServerItem"/>.</returns>
diff --git a/Emby.Dlna/DlnaManager.cs b/Emby.Dlna/DlnaManager.cs
index 069400833e..fedd20b68a 100644
--- a/Emby.Dlna/DlnaManager.cs
+++ b/Emby.Dlna/DlnaManager.cs
@@ -484,10 +484,10 @@ namespace Emby.Dlna
 
         /// <summary>
         /// Recreates the object using serialization, to ensure it's not a subclass.
-        /// If it's a subclass it may not serlialize properly to xml (different root element tag name).
+        /// If it's a subclass it may not serialize properly to xml (different root element tag name).
         /// </summary>
         /// <param name="profile">The device profile.</param>
-        /// <returns>The reserialized device profile.</returns>
+        /// <returns>The re-serialized device profile.</returns>
         private DeviceProfile ReserializeProfile(DeviceProfile profile)
         {
             if (profile.GetType() == typeof(DeviceProfile))
diff --git a/Emby.Dlna/PlayTo/Device.cs b/Emby.Dlna/PlayTo/Device.cs
index c97acdb026..f8ff03076a 100644
--- a/Emby.Dlna/PlayTo/Device.cs
+++ b/Emby.Dlna/PlayTo/Device.cs
@@ -480,7 +480,7 @@ namespace Emby.Dlna.PlayTo
                         return;
                     }
 
-                    // If we're not playing anything make sure we don't get data more often than neccessry to keep the Session alive
+                    // If we're not playing anything make sure we don't get data more often than necessary to keep the Session alive
                     if (transportState.Value == TransportState.Stopped)
                     {
                         RestartTimerInactive();
@@ -775,7 +775,7 @@ namespace Emby.Dlna.PlayTo
 
             if (track == null)
             {
-                // If track is null, some vendors do this, use GetMediaInfo instead
+                // If track is null, some vendors do this, use GetMediaInfo instead.
                 return (true, null);
             }
 
@@ -812,7 +812,7 @@ namespace Emby.Dlna.PlayTo
 
         private XElement ParseResponse(string xml)
         {
-            // Handle different variations sent back by devices
+            // Handle different variations sent back by devices.
             try
             {
                 return XElement.Parse(xml);
@@ -821,7 +821,7 @@ namespace Emby.Dlna.PlayTo
             {
             }
 
-            // first try to add a root node with a dlna namesapce
+            // first try to add a root node with a dlna namespace.
             try
             {
                 return XElement.Parse("<data xmlns:dlna=\"urn:schemas-dlna-org:device-1-0\">" + xml + "</data>")
diff --git a/Emby.Dlna/PlayTo/PlayToController.cs b/Emby.Dlna/PlayTo/PlayToController.cs
index c07c8aefa6..3907b2a396 100644
--- a/Emby.Dlna/PlayTo/PlayToController.cs
+++ b/Emby.Dlna/PlayTo/PlayToController.cs
@@ -945,7 +945,10 @@ namespace Emby.Dlna.PlayTo
                 request.DeviceId = values.GetValueOrDefault("DeviceId");
                 request.MediaSourceId = values.GetValueOrDefault("MediaSourceId");
                 request.LiveStreamId = values.GetValueOrDefault("LiveStreamId");
-                request.IsDirectStream = string.Equals("true", values.GetValueOrDefault("Static"), StringComparison.OrdinalIgnoreCase);
+
+                // Be careful, IsDirectStream==true by default (Static != false or not in query).
+                // See initialization of StreamingRequestDto in AudioController.GetAudioStream() method : Static = @static ?? true.
+                request.IsDirectStream = !string.Equals("false", values.GetValueOrDefault("Static"), StringComparison.OrdinalIgnoreCase);
 
                 request.AudioStreamIndex = GetIntValue(values, "AudioStreamIndex");
                 request.SubtitleStreamIndex = GetIntValue(values, "SubtitleStreamIndex");
diff --git a/Emby.Dlna/PlayTo/SsdpHttpClient.cs b/Emby.Dlna/PlayTo/SsdpHttpClient.cs
index c8c36fc972..f4d7937907 100644
--- a/Emby.Dlna/PlayTo/SsdpHttpClient.cs
+++ b/Emby.Dlna/PlayTo/SsdpHttpClient.cs
@@ -45,7 +45,7 @@ namespace Emby.Dlna.PlayTo
                     header,
                     cancellationToken)
                 .ConfigureAwait(false);
-            await using var stream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false);
+            await using var stream = await response.Content.ReadAsStreamAsync(cancellationToken).ConfigureAwait(false);
             using var reader = new StreamReader(stream, Encoding.UTF8);
             return XDocument.Parse(
                 await reader.ReadToEndAsync().ConfigureAwait(false),
@@ -94,7 +94,7 @@ namespace Emby.Dlna.PlayTo
             options.Headers.UserAgent.ParseAdd(USERAGENT);
             options.Headers.TryAddWithoutValidation("FriendlyName.DLNA.ORG", FriendlyName);
             using var response = await _httpClientFactory.CreateClient(NamedClient.Default).SendAsync(options, HttpCompletionOption.ResponseHeadersRead, cancellationToken).ConfigureAwait(false);
-            await using var stream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false);
+            await using var stream = await response.Content.ReadAsStreamAsync(cancellationToken).ConfigureAwait(false);
             using var reader = new StreamReader(stream, Encoding.UTF8);
             return XDocument.Parse(
                 await reader.ReadToEndAsync().ConfigureAwait(false),