| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.ComponentModel.DataAnnotations; |
| | | 4 | | using System.Globalization; |
| | | 5 | | using System.Linq; |
| | | 6 | | using System.Threading.Tasks; |
| | | 7 | | using Jellyfin.Api.Attributes; |
| | | 8 | | using Jellyfin.Api.Helpers; |
| | | 9 | | using Jellyfin.Api.ModelBinders; |
| | | 10 | | using Jellyfin.Api.Models.StreamingDtos; |
| | | 11 | | using Jellyfin.Data.Enums; |
| | | 12 | | using Jellyfin.Extensions; |
| | | 13 | | using MediaBrowser.Common.Extensions; |
| | | 14 | | using MediaBrowser.Controller.Entities; |
| | | 15 | | using MediaBrowser.Controller.Library; |
| | | 16 | | using MediaBrowser.Controller.MediaEncoding; |
| | | 17 | | using MediaBrowser.Controller.Streaming; |
| | | 18 | | using MediaBrowser.Model.Dlna; |
| | | 19 | | using MediaBrowser.Model.MediaInfo; |
| | | 20 | | using MediaBrowser.Model.Session; |
| | | 21 | | using Microsoft.AspNetCore.Authorization; |
| | | 22 | | using Microsoft.AspNetCore.Http; |
| | | 23 | | using Microsoft.AspNetCore.Mvc; |
| | | 24 | | using Microsoft.Extensions.Logging; |
| | | 25 | | |
| | | 26 | | namespace Jellyfin.Api.Controllers; |
| | | 27 | | |
| | | 28 | | /// <summary> |
| | | 29 | | /// The universal audio controller. |
| | | 30 | | /// </summary> |
| | | 31 | | [Route("")] |
| | | 32 | | [Tags("Audio")] |
| | | 33 | | public class UniversalAudioController : BaseJellyfinApiController |
| | | 34 | | { |
| | | 35 | | private readonly ILibraryManager _libraryManager; |
| | | 36 | | private readonly ILogger<UniversalAudioController> _logger; |
| | | 37 | | private readonly MediaInfoHelper _mediaInfoHelper; |
| | | 38 | | private readonly AudioHelper _audioHelper; |
| | | 39 | | private readonly DynamicHlsHelper _dynamicHlsHelper; |
| | | 40 | | private readonly IUserManager _userManager; |
| | | 41 | | |
| | | 42 | | /// <summary> |
| | | 43 | | /// Initializes a new instance of the <see cref="UniversalAudioController"/> class. |
| | | 44 | | /// </summary> |
| | | 45 | | /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param> |
| | | 46 | | /// <param name="logger">Instance of the <see cref="ILogger{UniversalAudioController}"/> interface.</param> |
| | | 47 | | /// <param name="mediaInfoHelper">Instance of <see cref="MediaInfoHelper"/>.</param> |
| | | 48 | | /// <param name="audioHelper">Instance of <see cref="AudioHelper"/>.</param> |
| | | 49 | | /// <param name="dynamicHlsHelper">Instance of <see cref="DynamicHlsHelper"/>.</param> |
| | | 50 | | /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param> |
| | 0 | 51 | | public UniversalAudioController( |
| | 0 | 52 | | ILibraryManager libraryManager, |
| | 0 | 53 | | ILogger<UniversalAudioController> logger, |
| | 0 | 54 | | MediaInfoHelper mediaInfoHelper, |
| | 0 | 55 | | AudioHelper audioHelper, |
| | 0 | 56 | | DynamicHlsHelper dynamicHlsHelper, |
| | 0 | 57 | | IUserManager userManager) |
| | | 58 | | { |
| | 0 | 59 | | _libraryManager = libraryManager; |
| | 0 | 60 | | _logger = logger; |
| | 0 | 61 | | _mediaInfoHelper = mediaInfoHelper; |
| | 0 | 62 | | _audioHelper = audioHelper; |
| | 0 | 63 | | _dynamicHlsHelper = dynamicHlsHelper; |
| | 0 | 64 | | _userManager = userManager; |
| | 0 | 65 | | } |
| | | 66 | | |
| | | 67 | | /// <summary> |
| | | 68 | | /// Gets an audio stream. |
| | | 69 | | /// </summary> |
| | | 70 | | /// <param name="itemId">The item id.</param> |
| | | 71 | | /// <param name="container">Optional. The audio container.</param> |
| | | 72 | | /// <param name="mediaSourceId">The media version id, if playing an alternate version.</param> |
| | | 73 | | /// <param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</par |
| | | 74 | | /// <param name="userId">Optional. The user id.</param> |
| | | 75 | | /// <param name="audioCodec">Optional. The audio codec to transcode to.</param> |
| | | 76 | | /// <param name="maxAudioChannels">Optional. The maximum number of audio channels.</param> |
| | | 77 | | /// <param name="transcodingAudioChannels">Optional. The number of how many audio channels to transcode to.</param> |
| | | 78 | | /// <param name="maxStreamingBitrate">Optional. The maximum streaming bitrate.</param> |
| | | 79 | | /// <param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be |
| | | 80 | | /// <param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param> |
| | | 81 | | /// <param name="transcodingContainer">Optional. The container to transcode to.</param> |
| | | 82 | | /// <param name="transcodingProtocol">Optional. The transcoding protocol.</param> |
| | | 83 | | /// <param name="maxAudioSampleRate">Optional. The maximum audio sample rate.</param> |
| | | 84 | | /// <param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param> |
| | | 85 | | /// <param name="enableRemoteMedia">Optional. Whether to enable remote media.</param> |
| | | 86 | | /// <param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param> |
| | | 87 | | /// <param name="enableRedirection">Whether to enable redirection. Defaults to true.</param> |
| | | 88 | | /// <response code="200">Audio stream returned.</response> |
| | | 89 | | /// <response code="302">Redirected to remote audio stream.</response> |
| | | 90 | | /// <response code="404">Item not found.</response> |
| | | 91 | | /// <returns>A <see cref="Task"/> containing the audio file.</returns> |
| | | 92 | | [HttpGet("Audio/{itemId}/universal")] |
| | | 93 | | [HttpHead("Audio/{itemId}/universal", Name = "HeadUniversalAudioStream")] |
| | | 94 | | [Authorize] |
| | | 95 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 96 | | [ProducesResponseType(StatusCodes.Status302Found)] |
| | | 97 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 98 | | [ProducesAudioFile] |
| | | 99 | | public async Task<ActionResult> GetUniversalAudioStream( |
| | | 100 | | [FromRoute, Required] Guid itemId, |
| | | 101 | | [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] container, |
| | | 102 | | [FromQuery] string? mediaSourceId, |
| | | 103 | | [FromQuery] string? deviceId, |
| | | 104 | | [FromQuery] Guid? userId, |
| | | 105 | | [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegexStr)] string? audioCodec, |
| | | 106 | | [FromQuery] int? maxAudioChannels, |
| | | 107 | | [FromQuery] int? transcodingAudioChannels, |
| | | 108 | | [FromQuery] int? maxStreamingBitrate, |
| | | 109 | | [FromQuery] int? audioBitRate, |
| | | 110 | | [FromQuery] long? startTimeTicks, |
| | | 111 | | [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegexStr)] string? transcodingContainer, |
| | | 112 | | [FromQuery] MediaStreamProtocol? transcodingProtocol, |
| | | 113 | | [FromQuery] int? maxAudioSampleRate, |
| | | 114 | | [FromQuery] int? maxAudioBitDepth, |
| | | 115 | | [FromQuery] bool? enableRemoteMedia, |
| | | 116 | | [FromQuery] bool enableAudioVbrEncoding = true, |
| | | 117 | | [FromQuery] bool enableRedirection = true) |
| | | 118 | | { |
| | 0 | 119 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 120 | | var user = userId.IsNullOrEmpty() |
| | 0 | 121 | | ? null |
| | 0 | 122 | | : _userManager.GetUserById(userId.Value); |
| | 0 | 123 | | var item = _libraryManager.GetItemById<BaseItem>(itemId, user); |
| | 0 | 124 | | if (item is null) |
| | | 125 | | { |
| | 0 | 126 | | return NotFound(); |
| | | 127 | | } |
| | | 128 | | |
| | 0 | 129 | | var deviceProfile = GetDeviceProfile(container, transcodingContainer, audioCodec, transcodingProtocol, transcodi |
| | | 130 | | |
| | 0 | 131 | | _logger.LogInformation("GetPostedPlaybackInfo profile: {@Profile}", deviceProfile); |
| | | 132 | | |
| | 0 | 133 | | var info = await _mediaInfoHelper.GetPlaybackInfo( |
| | 0 | 134 | | item, |
| | 0 | 135 | | user, |
| | 0 | 136 | | mediaSourceId) |
| | 0 | 137 | | .ConfigureAwait(false); |
| | | 138 | | |
| | | 139 | | // set device specific data |
| | 0 | 140 | | foreach (var sourceInfo in info.MediaSources) |
| | | 141 | | { |
| | 0 | 142 | | sourceInfo.TranscodingContainer = transcodingContainer; |
| | 0 | 143 | | sourceInfo.TranscodingSubProtocol = transcodingProtocol ?? sourceInfo.TranscodingSubProtocol; |
| | 0 | 144 | | _mediaInfoHelper.SetDeviceSpecificData( |
| | 0 | 145 | | item, |
| | 0 | 146 | | sourceInfo, |
| | 0 | 147 | | deviceProfile, |
| | 0 | 148 | | User, |
| | 0 | 149 | | maxStreamingBitrate ?? deviceProfile.MaxStreamingBitrate, |
| | 0 | 150 | | startTimeTicks ?? 0, |
| | 0 | 151 | | mediaSourceId ?? string.Empty, |
| | 0 | 152 | | null, |
| | 0 | 153 | | null, |
| | 0 | 154 | | maxAudioChannels, |
| | 0 | 155 | | info.PlaySessionId!, |
| | 0 | 156 | | userId ?? Guid.Empty, |
| | 0 | 157 | | true, |
| | 0 | 158 | | true, |
| | 0 | 159 | | true, |
| | 0 | 160 | | true, |
| | 0 | 161 | | true, |
| | 0 | 162 | | false, |
| | 0 | 163 | | Request.HttpContext.GetNormalizedRemoteIP()); |
| | | 164 | | } |
| | | 165 | | |
| | 0 | 166 | | _mediaInfoHelper.SortMediaSources(info, maxStreamingBitrate); |
| | | 167 | | |
| | 0 | 168 | | foreach (var source in info.MediaSources) |
| | | 169 | | { |
| | 0 | 170 | | _mediaInfoHelper.NormalizeMediaSourceContainer(source, deviceProfile, DlnaProfileType.Video); |
| | | 171 | | } |
| | | 172 | | |
| | 0 | 173 | | var mediaSource = info.MediaSources[0]; |
| | 0 | 174 | | if (mediaSource.SupportsDirectPlay && mediaSource.Protocol == MediaProtocol.Http && enableRedirection && mediaSo |
| | | 175 | | { |
| | 0 | 176 | | return Redirect(mediaSource.Path); |
| | | 177 | | } |
| | | 178 | | |
| | | 179 | | // This one is currently very misleading as the SupportsDirectStream actually means "can direct play" |
| | | 180 | | // The definition of DirectStream also seems changed during development |
| | 0 | 181 | | var isStatic = mediaSource.SupportsDirectStream; |
| | 0 | 182 | | if (!isStatic && mediaSource.TranscodingSubProtocol == MediaStreamProtocol.hls) |
| | | 183 | | { |
| | | 184 | | // hls segment container can only be mpegts or fmp4 per ffmpeg documentation |
| | | 185 | | // ffmpeg option -> file extension |
| | | 186 | | // mpegts -> ts |
| | | 187 | | // fmp4 -> mp4 |
| | 0 | 188 | | var supportedHlsContainers = new[] { "ts", "mp4" }; |
| | | 189 | | |
| | | 190 | | // fallback to mpegts if device reports some weird value unsupported by hls |
| | 0 | 191 | | var requestedSegmentContainer = Array.Exists( |
| | 0 | 192 | | supportedHlsContainers, |
| | 0 | 193 | | element => string.Equals(element, transcodingContainer, StringComparison.OrdinalIgnoreCase)) ? transcodi |
| | 0 | 194 | | var segmentContainer = Array.Exists( |
| | 0 | 195 | | supportedHlsContainers, |
| | 0 | 196 | | element => string.Equals(element, mediaSource.TranscodingContainer, StringComparison.OrdinalIgnoreCase)) |
| | 0 | 197 | | var dynamicHlsRequestDto = new HlsAudioRequestDto |
| | 0 | 198 | | { |
| | 0 | 199 | | Id = itemId, |
| | 0 | 200 | | Container = ".m3u8", |
| | 0 | 201 | | Static = isStatic, |
| | 0 | 202 | | PlaySessionId = info.PlaySessionId, |
| | 0 | 203 | | SegmentContainer = segmentContainer, |
| | 0 | 204 | | MediaSourceId = mediaSourceId, |
| | 0 | 205 | | DeviceId = deviceId, |
| | 0 | 206 | | AudioCodec = mediaSource.TranscodeReasons == TranscodeReason.ContainerNotSupported ? "copy" : audioCodec |
| | 0 | 207 | | EnableAutoStreamCopy = true, |
| | 0 | 208 | | AllowAudioStreamCopy = true, |
| | 0 | 209 | | AllowVideoStreamCopy = true, |
| | 0 | 210 | | AudioSampleRate = maxAudioSampleRate, |
| | 0 | 211 | | MaxAudioChannels = maxAudioChannels, |
| | 0 | 212 | | MaxAudioBitDepth = maxAudioBitDepth, |
| | 0 | 213 | | AudioBitRate = audioBitRate ?? maxStreamingBitrate, |
| | 0 | 214 | | StartTimeTicks = startTimeTicks, |
| | 0 | 215 | | SubtitleMethod = SubtitleDeliveryMethod.Hls, |
| | 0 | 216 | | RequireAvc = false, |
| | 0 | 217 | | DeInterlace = false, |
| | 0 | 218 | | RequireNonAnamorphic = false, |
| | 0 | 219 | | EnableMpegtsM2TsMode = false, |
| | 0 | 220 | | TranscodeReasons = mediaSource.TranscodeReasons == 0 ? null : mediaSource.TranscodeReasons.ToString(), |
| | 0 | 221 | | Context = EncodingContext.Static, |
| | 0 | 222 | | StreamOptions = new Dictionary<string, string>(), |
| | 0 | 223 | | EnableAdaptiveBitrateStreaming = false, |
| | 0 | 224 | | EnableAudioVbrEncoding = enableAudioVbrEncoding |
| | 0 | 225 | | }; |
| | | 226 | | |
| | 0 | 227 | | return await _dynamicHlsHelper.GetMasterHlsPlaylist(TranscodingJobType.Hls, dynamicHlsRequestDto, true) |
| | 0 | 228 | | .ConfigureAwait(false); |
| | | 229 | | } |
| | | 230 | | |
| | 0 | 231 | | var audioStreamingDto = new StreamingRequestDto |
| | 0 | 232 | | { |
| | 0 | 233 | | Id = itemId, |
| | 0 | 234 | | Container = isStatic ? null : ("." + mediaSource.TranscodingContainer), |
| | 0 | 235 | | Static = isStatic, |
| | 0 | 236 | | PlaySessionId = info.PlaySessionId, |
| | 0 | 237 | | MediaSourceId = mediaSourceId, |
| | 0 | 238 | | DeviceId = deviceId, |
| | 0 | 239 | | AudioCodec = audioCodec, |
| | 0 | 240 | | EnableAutoStreamCopy = true, |
| | 0 | 241 | | AllowAudioStreamCopy = true, |
| | 0 | 242 | | AllowVideoStreamCopy = true, |
| | 0 | 243 | | AudioSampleRate = maxAudioSampleRate, |
| | 0 | 244 | | MaxAudioChannels = maxAudioChannels, |
| | 0 | 245 | | AudioBitRate = isStatic ? null : (audioBitRate ?? maxStreamingBitrate), |
| | 0 | 246 | | MaxAudioBitDepth = maxAudioBitDepth, |
| | 0 | 247 | | AudioChannels = maxAudioChannels, |
| | 0 | 248 | | CopyTimestamps = true, |
| | 0 | 249 | | StartTimeTicks = startTimeTicks, |
| | 0 | 250 | | SubtitleMethod = SubtitleDeliveryMethod.Embed, |
| | 0 | 251 | | TranscodeReasons = mediaSource.TranscodeReasons == 0 ? null : mediaSource.TranscodeReasons.ToString(), |
| | 0 | 252 | | Context = EncodingContext.Static |
| | 0 | 253 | | }; |
| | | 254 | | |
| | 0 | 255 | | return await _audioHelper.GetAudioStream(TranscodingJobType.Progressive, audioStreamingDto).ConfigureAwait(false |
| | 0 | 256 | | } |
| | | 257 | | |
| | | 258 | | private DeviceProfile GetDeviceProfile( |
| | | 259 | | string[] containers, |
| | | 260 | | string? transcodingContainer, |
| | | 261 | | string? audioCodec, |
| | | 262 | | MediaStreamProtocol? transcodingProtocol, |
| | | 263 | | int? transcodingAudioChannels, |
| | | 264 | | int? maxAudioSampleRate, |
| | | 265 | | int? maxAudioBitDepth, |
| | | 266 | | int? maxAudioChannels) |
| | | 267 | | { |
| | 0 | 268 | | var deviceProfile = new DeviceProfile(); |
| | | 269 | | |
| | 0 | 270 | | int len = containers.Length; |
| | 0 | 271 | | var directPlayProfiles = new DirectPlayProfile[len]; |
| | 0 | 272 | | for (int i = 0; i < len; i++) |
| | | 273 | | { |
| | 0 | 274 | | var parts = containers[i].Split('|', StringSplitOptions.RemoveEmptyEntries); |
| | | 275 | | |
| | 0 | 276 | | var audioCodecs = parts.Length == 1 ? null : string.Join(',', parts.Skip(1)); |
| | | 277 | | |
| | 0 | 278 | | directPlayProfiles[i] = new DirectPlayProfile |
| | 0 | 279 | | { |
| | 0 | 280 | | Type = DlnaProfileType.Audio, |
| | 0 | 281 | | Container = parts[0], |
| | 0 | 282 | | AudioCodec = audioCodecs |
| | 0 | 283 | | }; |
| | | 284 | | } |
| | | 285 | | |
| | 0 | 286 | | deviceProfile.DirectPlayProfiles = directPlayProfiles; |
| | | 287 | | |
| | 0 | 288 | | deviceProfile.TranscodingProfiles = new[] |
| | 0 | 289 | | { |
| | 0 | 290 | | new TranscodingProfile |
| | 0 | 291 | | { |
| | 0 | 292 | | Type = DlnaProfileType.Audio, |
| | 0 | 293 | | Context = EncodingContext.Streaming, |
| | 0 | 294 | | Container = transcodingContainer ?? "mp3", |
| | 0 | 295 | | AudioCodec = audioCodec ?? "mp3", |
| | 0 | 296 | | Protocol = transcodingProtocol ?? MediaStreamProtocol.http, |
| | 0 | 297 | | MaxAudioChannels = transcodingAudioChannels?.ToString(CultureInfo.InvariantCulture) |
| | 0 | 298 | | } |
| | 0 | 299 | | }; |
| | | 300 | | |
| | 0 | 301 | | var codecProfiles = new List<CodecProfile>(); |
| | 0 | 302 | | var conditions = new List<ProfileCondition>(); |
| | | 303 | | |
| | 0 | 304 | | if (maxAudioSampleRate.HasValue) |
| | | 305 | | { |
| | | 306 | | // codec profile |
| | 0 | 307 | | conditions.Add( |
| | 0 | 308 | | new ProfileCondition |
| | 0 | 309 | | { |
| | 0 | 310 | | Condition = ProfileConditionType.LessThanEqual, |
| | 0 | 311 | | IsRequired = false, |
| | 0 | 312 | | Property = ProfileConditionValue.AudioSampleRate, |
| | 0 | 313 | | Value = maxAudioSampleRate.Value.ToString(CultureInfo.InvariantCulture) |
| | 0 | 314 | | }); |
| | | 315 | | } |
| | | 316 | | |
| | 0 | 317 | | if (maxAudioBitDepth.HasValue) |
| | | 318 | | { |
| | | 319 | | // codec profile |
| | 0 | 320 | | conditions.Add( |
| | 0 | 321 | | new ProfileCondition |
| | 0 | 322 | | { |
| | 0 | 323 | | Condition = ProfileConditionType.LessThanEqual, |
| | 0 | 324 | | IsRequired = false, |
| | 0 | 325 | | Property = ProfileConditionValue.AudioBitDepth, |
| | 0 | 326 | | Value = maxAudioBitDepth.Value.ToString(CultureInfo.InvariantCulture) |
| | 0 | 327 | | }); |
| | | 328 | | } |
| | | 329 | | |
| | 0 | 330 | | if (maxAudioChannels.HasValue) |
| | | 331 | | { |
| | | 332 | | // codec profile |
| | 0 | 333 | | conditions.Add( |
| | 0 | 334 | | new ProfileCondition |
| | 0 | 335 | | { |
| | 0 | 336 | | Condition = ProfileConditionType.LessThanEqual, |
| | 0 | 337 | | IsRequired = false, |
| | 0 | 338 | | Property = ProfileConditionValue.AudioChannels, |
| | 0 | 339 | | Value = maxAudioChannels.Value.ToString(CultureInfo.InvariantCulture) |
| | 0 | 340 | | }); |
| | | 341 | | } |
| | | 342 | | |
| | 0 | 343 | | if (conditions.Count > 0) |
| | | 344 | | { |
| | | 345 | | // codec profile |
| | 0 | 346 | | codecProfiles.Add( |
| | 0 | 347 | | new CodecProfile |
| | 0 | 348 | | { |
| | 0 | 349 | | Type = CodecType.Audio, |
| | 0 | 350 | | Container = string.Join(',', containers), |
| | 0 | 351 | | Conditions = conditions.ToArray() |
| | 0 | 352 | | }); |
| | | 353 | | } |
| | | 354 | | |
| | 0 | 355 | | deviceProfile.CodecProfiles = codecProfiles.ToArray(); |
| | | 356 | | |
| | 0 | 357 | | return deviceProfile; |
| | | 358 | | } |
| | | 359 | | } |