| | | 1 | | using System; |
| | | 2 | | using System.Buffers; |
| | | 3 | | using System.ComponentModel.DataAnnotations; |
| | | 4 | | using System.Linq; |
| | | 5 | | using System.Net.Mime; |
| | | 6 | | using System.Threading.Tasks; |
| | | 7 | | using Jellyfin.Api.Attributes; |
| | | 8 | | using Jellyfin.Api.Extensions; |
| | | 9 | | using Jellyfin.Api.Helpers; |
| | | 10 | | using Jellyfin.Api.Models.MediaInfoDtos; |
| | | 11 | | using Jellyfin.Extensions; |
| | | 12 | | using MediaBrowser.Common.Extensions; |
| | | 13 | | using MediaBrowser.Controller.Devices; |
| | | 14 | | using MediaBrowser.Controller.Entities; |
| | | 15 | | using MediaBrowser.Controller.Library; |
| | | 16 | | using MediaBrowser.Model.MediaInfo; |
| | | 17 | | using Microsoft.AspNetCore.Authorization; |
| | | 18 | | using Microsoft.AspNetCore.Http; |
| | | 19 | | using Microsoft.AspNetCore.Mvc; |
| | | 20 | | using Microsoft.AspNetCore.Mvc.ModelBinding; |
| | | 21 | | using Microsoft.Extensions.Logging; |
| | | 22 | | |
| | | 23 | | namespace Jellyfin.Api.Controllers; |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// The media info controller. |
| | | 27 | | /// </summary> |
| | | 28 | | [Route("")] |
| | | 29 | | [Authorize] |
| | | 30 | | public class MediaInfoController : BaseJellyfinApiController |
| | | 31 | | { |
| | | 32 | | private readonly IMediaSourceManager _mediaSourceManager; |
| | | 33 | | private readonly IDeviceManager _deviceManager; |
| | | 34 | | private readonly ILibraryManager _libraryManager; |
| | | 35 | | private readonly ILogger<MediaInfoController> _logger; |
| | | 36 | | private readonly MediaInfoHelper _mediaInfoHelper; |
| | | 37 | | private readonly IUserManager _userManager; |
| | | 38 | | |
| | | 39 | | /// <summary> |
| | | 40 | | /// Initializes a new instance of the <see cref="MediaInfoController"/> class. |
| | | 41 | | /// </summary> |
| | | 42 | | /// <param name="mediaSourceManager">Instance of the <see cref="IMediaSourceManager"/> interface.</param> |
| | | 43 | | /// <param name="deviceManager">Instance of the <see cref="IDeviceManager"/> interface.</param> |
| | | 44 | | /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param> |
| | | 45 | | /// <param name="logger">Instance of the <see cref="ILogger{MediaInfoController}"/> interface.</param> |
| | | 46 | | /// <param name="mediaInfoHelper">Instance of the <see cref="MediaInfoHelper"/>.</param> |
| | | 47 | | /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface..</param> |
| | 5 | 48 | | public MediaInfoController( |
| | 5 | 49 | | IMediaSourceManager mediaSourceManager, |
| | 5 | 50 | | IDeviceManager deviceManager, |
| | 5 | 51 | | ILibraryManager libraryManager, |
| | 5 | 52 | | ILogger<MediaInfoController> logger, |
| | 5 | 53 | | MediaInfoHelper mediaInfoHelper, |
| | 5 | 54 | | IUserManager userManager) |
| | | 55 | | { |
| | 5 | 56 | | _mediaSourceManager = mediaSourceManager; |
| | 5 | 57 | | _deviceManager = deviceManager; |
| | 5 | 58 | | _libraryManager = libraryManager; |
| | 5 | 59 | | _logger = logger; |
| | 5 | 60 | | _mediaInfoHelper = mediaInfoHelper; |
| | 5 | 61 | | _userManager = userManager; |
| | 5 | 62 | | } |
| | | 63 | | |
| | | 64 | | /// <summary> |
| | | 65 | | /// Gets live playback media info for an item. |
| | | 66 | | /// </summary> |
| | | 67 | | /// <param name="itemId">The item id.</param> |
| | | 68 | | /// <param name="userId">The user id.</param> |
| | | 69 | | /// <response code="200">Playback info returned.</response> |
| | | 70 | | /// <response code="404">Item not found.</response> |
| | | 71 | | /// <returns>A <see cref="Task"/> containing a <see cref="PlaybackInfoResponse"/> with the playback information.</re |
| | | 72 | | [HttpGet("Items/{itemId}/PlaybackInfo")] |
| | | 73 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 74 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 75 | | public async Task<ActionResult<PlaybackInfoResponse>> GetPlaybackInfo([FromRoute, Required] Guid itemId, [FromQuery] |
| | | 76 | | { |
| | 0 | 77 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 78 | | var user = userId.IsNullOrEmpty() |
| | 0 | 79 | | ? null |
| | 0 | 80 | | : _userManager.GetUserById(userId.Value); |
| | 0 | 81 | | var item = _libraryManager.GetItemById<BaseItem>(itemId, user); |
| | 0 | 82 | | if (item is null) |
| | | 83 | | { |
| | 0 | 84 | | return NotFound(); |
| | | 85 | | } |
| | | 86 | | |
| | 0 | 87 | | return await _mediaInfoHelper.GetPlaybackInfo(item, user).ConfigureAwait(false); |
| | 0 | 88 | | } |
| | | 89 | | |
| | | 90 | | /// <summary> |
| | | 91 | | /// Gets live playback media info for an item. |
| | | 92 | | /// </summary> |
| | | 93 | | /// <remarks> |
| | | 94 | | /// For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. |
| | | 95 | | /// Query parameters are obsolete. |
| | | 96 | | /// </remarks> |
| | | 97 | | /// <param name="itemId">The item id.</param> |
| | | 98 | | /// <param name="userId">The user id.</param> |
| | | 99 | | /// <param name="maxStreamingBitrate">The maximum streaming bitrate.</param> |
| | | 100 | | /// <param name="startTimeTicks">The start time in ticks.</param> |
| | | 101 | | /// <param name="audioStreamIndex">The audio stream index.</param> |
| | | 102 | | /// <param name="subtitleStreamIndex">The subtitle stream index.</param> |
| | | 103 | | /// <param name="maxAudioChannels">The maximum number of audio channels.</param> |
| | | 104 | | /// <param name="mediaSourceId">The media source id.</param> |
| | | 105 | | /// <param name="liveStreamId">The livestream id.</param> |
| | | 106 | | /// <param name="autoOpenLiveStream">Whether to auto open the livestream.</param> |
| | | 107 | | /// <param name="enableDirectPlay">Whether to enable direct play. Default: true.</param> |
| | | 108 | | /// <param name="enableDirectStream">Whether to enable direct stream. Default: true.</param> |
| | | 109 | | /// <param name="enableTranscoding">Whether to enable transcoding. Default: true.</param> |
| | | 110 | | /// <param name="allowVideoStreamCopy">Whether to allow to copy the video stream. Default: true.</param> |
| | | 111 | | /// <param name="allowAudioStreamCopy">Whether to allow to copy the audio stream. Default: true.</param> |
| | | 112 | | /// <param name="playbackInfoDto">The playback info.</param> |
| | | 113 | | /// <response code="200">Playback info returned.</response> |
| | | 114 | | /// <response code="404">Item not found.</response> |
| | | 115 | | /// <returns>A <see cref="Task"/> containing a <see cref="PlaybackInfoResponse"/> with the playback info.</returns> |
| | | 116 | | [HttpPost("Items/{itemId}/PlaybackInfo")] |
| | | 117 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 118 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 119 | | public async Task<ActionResult<PlaybackInfoResponse>> GetPostedPlaybackInfo( |
| | | 120 | | [FromRoute, Required] Guid itemId, |
| | | 121 | | [FromQuery, ParameterObsolete] Guid? userId, |
| | | 122 | | [FromQuery, ParameterObsolete] int? maxStreamingBitrate, |
| | | 123 | | [FromQuery, ParameterObsolete] long? startTimeTicks, |
| | | 124 | | [FromQuery, ParameterObsolete] int? audioStreamIndex, |
| | | 125 | | [FromQuery, ParameterObsolete] int? subtitleStreamIndex, |
| | | 126 | | [FromQuery, ParameterObsolete] int? maxAudioChannels, |
| | | 127 | | [FromQuery, ParameterObsolete] string? mediaSourceId, |
| | | 128 | | [FromQuery, ParameterObsolete] string? liveStreamId, |
| | | 129 | | [FromQuery, ParameterObsolete] bool? autoOpenLiveStream, |
| | | 130 | | [FromQuery, ParameterObsolete] bool? enableDirectPlay, |
| | | 131 | | [FromQuery, ParameterObsolete] bool? enableDirectStream, |
| | | 132 | | [FromQuery, ParameterObsolete] bool? enableTranscoding, |
| | | 133 | | [FromQuery, ParameterObsolete] bool? allowVideoStreamCopy, |
| | | 134 | | [FromQuery, ParameterObsolete] bool? allowAudioStreamCopy, |
| | | 135 | | [FromBody(EmptyBodyBehavior = EmptyBodyBehavior.Allow)] PlaybackInfoDto? playbackInfoDto) |
| | | 136 | | { |
| | 0 | 137 | | var profile = playbackInfoDto?.DeviceProfile; |
| | 0 | 138 | | _logger.LogDebug("GetPostedPlaybackInfo profile: {@Profile}", profile); |
| | | 139 | | |
| | 0 | 140 | | if (profile is null) |
| | | 141 | | { |
| | 0 | 142 | | var caps = _deviceManager.GetCapabilities(User.GetDeviceId()); |
| | 0 | 143 | | if (caps is not null) |
| | | 144 | | { |
| | 0 | 145 | | profile = caps.DeviceProfile; |
| | | 146 | | } |
| | | 147 | | } |
| | | 148 | | |
| | | 149 | | // Copy params from posted body |
| | | 150 | | // TODO clean up when breaking API compatibility. |
| | 0 | 151 | | userId ??= playbackInfoDto?.UserId; |
| | 0 | 152 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 153 | | maxStreamingBitrate ??= playbackInfoDto?.MaxStreamingBitrate; |
| | 0 | 154 | | startTimeTicks ??= playbackInfoDto?.StartTimeTicks; |
| | 0 | 155 | | audioStreamIndex ??= playbackInfoDto?.AudioStreamIndex; |
| | 0 | 156 | | subtitleStreamIndex ??= playbackInfoDto?.SubtitleStreamIndex; |
| | 0 | 157 | | maxAudioChannels ??= playbackInfoDto?.MaxAudioChannels; |
| | 0 | 158 | | mediaSourceId ??= playbackInfoDto?.MediaSourceId; |
| | 0 | 159 | | liveStreamId ??= playbackInfoDto?.LiveStreamId; |
| | 0 | 160 | | autoOpenLiveStream ??= playbackInfoDto?.AutoOpenLiveStream ?? false; |
| | 0 | 161 | | enableDirectPlay ??= playbackInfoDto?.EnableDirectPlay ?? true; |
| | 0 | 162 | | enableDirectStream ??= playbackInfoDto?.EnableDirectStream ?? true; |
| | 0 | 163 | | enableTranscoding ??= playbackInfoDto?.EnableTranscoding ?? true; |
| | 0 | 164 | | allowVideoStreamCopy ??= playbackInfoDto?.AllowVideoStreamCopy ?? true; |
| | 0 | 165 | | allowAudioStreamCopy ??= playbackInfoDto?.AllowAudioStreamCopy ?? true; |
| | | 166 | | |
| | 0 | 167 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 168 | | var user = userId.IsNullOrEmpty() |
| | 0 | 169 | | ? null |
| | 0 | 170 | | : _userManager.GetUserById(userId.Value); |
| | 0 | 171 | | var item = _libraryManager.GetItemById<BaseItem>(itemId, user); |
| | 0 | 172 | | if (item is null) |
| | | 173 | | { |
| | 0 | 174 | | return NotFound(); |
| | | 175 | | } |
| | | 176 | | |
| | 0 | 177 | | var info = await _mediaInfoHelper.GetPlaybackInfo( |
| | 0 | 178 | | item, |
| | 0 | 179 | | user, |
| | 0 | 180 | | mediaSourceId, |
| | 0 | 181 | | liveStreamId) |
| | 0 | 182 | | .ConfigureAwait(false); |
| | | 183 | | |
| | 0 | 184 | | if (info.ErrorCode is not null) |
| | | 185 | | { |
| | 0 | 186 | | return info; |
| | | 187 | | } |
| | | 188 | | |
| | 0 | 189 | | if (profile is not null) |
| | | 190 | | { |
| | | 191 | | // set device specific data |
| | 0 | 192 | | foreach (var mediaSource in info.MediaSources) |
| | | 193 | | { |
| | 0 | 194 | | _mediaInfoHelper.SetDeviceSpecificData( |
| | 0 | 195 | | item, |
| | 0 | 196 | | mediaSource, |
| | 0 | 197 | | profile, |
| | 0 | 198 | | User, |
| | 0 | 199 | | maxStreamingBitrate ?? profile.MaxStreamingBitrate, |
| | 0 | 200 | | startTimeTicks ?? 0, |
| | 0 | 201 | | mediaSourceId ?? string.Empty, |
| | 0 | 202 | | audioStreamIndex, |
| | 0 | 203 | | subtitleStreamIndex, |
| | 0 | 204 | | maxAudioChannels, |
| | 0 | 205 | | info.PlaySessionId!, |
| | 0 | 206 | | userId ?? Guid.Empty, |
| | 0 | 207 | | enableDirectPlay.Value, |
| | 0 | 208 | | enableDirectStream.Value, |
| | 0 | 209 | | enableTranscoding.Value, |
| | 0 | 210 | | allowVideoStreamCopy.Value, |
| | 0 | 211 | | allowAudioStreamCopy.Value, |
| | 0 | 212 | | playbackInfoDto?.AlwaysBurnInSubtitleWhenTranscoding ?? false, |
| | 0 | 213 | | Request.HttpContext.GetNormalizedRemoteIP()); |
| | | 214 | | } |
| | | 215 | | |
| | 0 | 216 | | _mediaInfoHelper.SortMediaSources(info, maxStreamingBitrate); |
| | | 217 | | } |
| | | 218 | | |
| | 0 | 219 | | if (autoOpenLiveStream.Value) |
| | | 220 | | { |
| | 0 | 221 | | var mediaSource = string.IsNullOrWhiteSpace(mediaSourceId) ? info.MediaSources[0] : info.MediaSources.FirstO |
| | | 222 | | |
| | 0 | 223 | | if (mediaSource is not null && mediaSource.RequiresOpening && string.IsNullOrWhiteSpace(mediaSource.LiveStre |
| | | 224 | | { |
| | 0 | 225 | | var openStreamResult = await _mediaInfoHelper.OpenMediaSource( |
| | 0 | 226 | | HttpContext, |
| | 0 | 227 | | new LiveStreamRequest |
| | 0 | 228 | | { |
| | 0 | 229 | | AudioStreamIndex = audioStreamIndex, |
| | 0 | 230 | | DeviceProfile = playbackInfoDto?.DeviceProfile, |
| | 0 | 231 | | EnableDirectPlay = enableDirectPlay.Value, |
| | 0 | 232 | | EnableDirectStream = enableDirectStream.Value, |
| | 0 | 233 | | ItemId = itemId, |
| | 0 | 234 | | MaxAudioChannels = maxAudioChannels, |
| | 0 | 235 | | MaxStreamingBitrate = maxStreamingBitrate, |
| | 0 | 236 | | PlaySessionId = info.PlaySessionId, |
| | 0 | 237 | | StartTimeTicks = startTimeTicks, |
| | 0 | 238 | | SubtitleStreamIndex = subtitleStreamIndex, |
| | 0 | 239 | | UserId = userId ?? Guid.Empty, |
| | 0 | 240 | | OpenToken = mediaSource.OpenToken, |
| | 0 | 241 | | AlwaysBurnInSubtitleWhenTranscoding = playbackInfoDto?.AlwaysBurnInSubtitleWhenTranscoding ?? fa |
| | 0 | 242 | | }).ConfigureAwait(false); |
| | | 243 | | |
| | 0 | 244 | | info.MediaSources = new[] { openStreamResult.MediaSource }; |
| | | 245 | | } |
| | | 246 | | } |
| | | 247 | | |
| | 0 | 248 | | return info; |
| | 0 | 249 | | } |
| | | 250 | | |
| | | 251 | | /// <summary> |
| | | 252 | | /// Opens a media source. |
| | | 253 | | /// </summary> |
| | | 254 | | /// <param name="openToken">The open token.</param> |
| | | 255 | | /// <param name="userId">The user id.</param> |
| | | 256 | | /// <param name="playSessionId">The play session id.</param> |
| | | 257 | | /// <param name="maxStreamingBitrate">The maximum streaming bitrate.</param> |
| | | 258 | | /// <param name="startTimeTicks">The start time in ticks.</param> |
| | | 259 | | /// <param name="audioStreamIndex">The audio stream index.</param> |
| | | 260 | | /// <param name="subtitleStreamIndex">The subtitle stream index.</param> |
| | | 261 | | /// <param name="maxAudioChannels">The maximum number of audio channels.</param> |
| | | 262 | | /// <param name="itemId">The item id.</param> |
| | | 263 | | /// <param name="openLiveStreamDto">The open live stream dto.</param> |
| | | 264 | | /// <param name="enableDirectPlay">Whether to enable direct play. Default: true.</param> |
| | | 265 | | /// <param name="enableDirectStream">Whether to enable direct stream. Default: true.</param> |
| | | 266 | | /// <param name="alwaysBurnInSubtitleWhenTranscoding">Always burn-in subtitle when transcoding.</param> |
| | | 267 | | /// <response code="200">Media source opened.</response> |
| | | 268 | | /// <returns>A <see cref="Task"/> containing a <see cref="LiveStreamResponse"/>.</returns> |
| | | 269 | | [HttpPost("LiveStreams/Open")] |
| | | 270 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 271 | | public async Task<ActionResult<LiveStreamResponse>> OpenLiveStream( |
| | | 272 | | [FromQuery] string? openToken, |
| | | 273 | | [FromQuery] Guid? userId, |
| | | 274 | | [FromQuery] string? playSessionId, |
| | | 275 | | [FromQuery] int? maxStreamingBitrate, |
| | | 276 | | [FromQuery] long? startTimeTicks, |
| | | 277 | | [FromQuery] int? audioStreamIndex, |
| | | 278 | | [FromQuery] int? subtitleStreamIndex, |
| | | 279 | | [FromQuery] int? maxAudioChannels, |
| | | 280 | | [FromQuery] Guid? itemId, |
| | | 281 | | [FromBody] OpenLiveStreamDto? openLiveStreamDto, |
| | | 282 | | [FromQuery] bool? enableDirectPlay, |
| | | 283 | | [FromQuery] bool? enableDirectStream, |
| | | 284 | | [FromQuery] bool? alwaysBurnInSubtitleWhenTranscoding) |
| | | 285 | | { |
| | 0 | 286 | | userId ??= openLiveStreamDto?.UserId; |
| | 0 | 287 | | userId = RequestHelpers.GetUserId(User, userId); |
| | 0 | 288 | | var request = new LiveStreamRequest |
| | 0 | 289 | | { |
| | 0 | 290 | | OpenToken = openToken ?? openLiveStreamDto?.OpenToken, |
| | 0 | 291 | | UserId = userId.Value, |
| | 0 | 292 | | PlaySessionId = playSessionId ?? openLiveStreamDto?.PlaySessionId, |
| | 0 | 293 | | MaxStreamingBitrate = maxStreamingBitrate ?? openLiveStreamDto?.MaxStreamingBitrate, |
| | 0 | 294 | | StartTimeTicks = startTimeTicks ?? openLiveStreamDto?.StartTimeTicks, |
| | 0 | 295 | | AudioStreamIndex = audioStreamIndex ?? openLiveStreamDto?.AudioStreamIndex, |
| | 0 | 296 | | SubtitleStreamIndex = subtitleStreamIndex ?? openLiveStreamDto?.SubtitleStreamIndex, |
| | 0 | 297 | | MaxAudioChannels = maxAudioChannels ?? openLiveStreamDto?.MaxAudioChannels, |
| | 0 | 298 | | ItemId = itemId ?? openLiveStreamDto?.ItemId ?? Guid.Empty, |
| | 0 | 299 | | DeviceProfile = openLiveStreamDto?.DeviceProfile, |
| | 0 | 300 | | EnableDirectPlay = enableDirectPlay ?? openLiveStreamDto?.EnableDirectPlay ?? true, |
| | 0 | 301 | | EnableDirectStream = enableDirectStream ?? openLiveStreamDto?.EnableDirectStream ?? true, |
| | 0 | 302 | | DirectPlayProtocols = openLiveStreamDto?.DirectPlayProtocols ?? new[] { MediaProtocol.Http }, |
| | 0 | 303 | | AlwaysBurnInSubtitleWhenTranscoding = alwaysBurnInSubtitleWhenTranscoding ?? openLiveStreamDto?.AlwaysBurnIn |
| | 0 | 304 | | }; |
| | 0 | 305 | | return await _mediaInfoHelper.OpenMediaSource(HttpContext, request).ConfigureAwait(false); |
| | 0 | 306 | | } |
| | | 307 | | |
| | | 308 | | /// <summary> |
| | | 309 | | /// Closes a media source. |
| | | 310 | | /// </summary> |
| | | 311 | | /// <param name="liveStreamId">The livestream id.</param> |
| | | 312 | | /// <response code="204">Livestream closed.</response> |
| | | 313 | | /// <returns>A <see cref="NoContentResult"/> indicating success.</returns> |
| | | 314 | | [HttpPost("LiveStreams/Close")] |
| | | 315 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 316 | | public async Task<ActionResult> CloseLiveStream([FromQuery, Required] string liveStreamId) |
| | | 317 | | { |
| | 0 | 318 | | await _mediaSourceManager.CloseLiveStream(liveStreamId).ConfigureAwait(false); |
| | 0 | 319 | | return NoContent(); |
| | 0 | 320 | | } |
| | | 321 | | |
| | | 322 | | /// <summary> |
| | | 323 | | /// Tests the network with a request with the size of the bitrate. |
| | | 324 | | /// </summary> |
| | | 325 | | /// <param name="size">The bitrate. Defaults to 102400.</param> |
| | | 326 | | /// <response code="200">Test buffer returned.</response> |
| | | 327 | | /// <returns>A <see cref="FileResult"/> with specified bitrate.</returns> |
| | | 328 | | [HttpGet("Playback/BitrateTest")] |
| | | 329 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 330 | | [ProducesFile(MediaTypeNames.Application.Octet)] |
| | | 331 | | public ActionResult GetBitrateTestBytes([FromQuery][Range(1, 100_000_000, ErrorMessage = "The requested size must be |
| | | 332 | | { |
| | 2 | 333 | | byte[] buffer = ArrayPool<byte>.Shared.Rent(size); |
| | | 334 | | try |
| | | 335 | | { |
| | 2 | 336 | | Random.Shared.NextBytes(buffer); |
| | 2 | 337 | | return File(buffer, MediaTypeNames.Application.Octet); |
| | | 338 | | } |
| | | 339 | | finally |
| | | 340 | | { |
| | 2 | 341 | | ArrayPool<byte>.Shared.Return(buffer); |
| | 2 | 342 | | } |
| | 2 | 343 | | } |
| | | 344 | | } |