|
@@ -330,7 +330,6 @@ namespace Jellyfin.Api.Controllers
|
|
|
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
|
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
|
/// <param name="imageIndex">Image index.</param>
|
|
|
- /// <param name="enableImageEnhancers">Enable or disable image enhancers such as cover art.</param>
|
|
|
/// <response code="200">Image stream returned.</response>
|
|
|
/// <response code="404">Item not found.</response>
|
|
|
/// <returns>
|
|
@@ -341,6 +340,8 @@ namespace Jellyfin.Api.Controllers
|
|
|
[HttpHead("/Items/{itemId}/Images/{imageType}")]
|
|
|
[HttpGet("/Items/{itemId}/Images/{imageType}/{imageIndex?}")]
|
|
|
[HttpHead("/Items/{itemId}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
public async Task<ActionResult> GetItemImage(
|
|
|
[FromRoute] Guid itemId,
|
|
|
[FromRoute] ImageType imageType,
|
|
@@ -349,17 +350,16 @@ namespace Jellyfin.Api.Controllers
|
|
|
[FromQuery] int? width,
|
|
|
[FromQuery] int? height,
|
|
|
[FromQuery] int? quality,
|
|
|
- [FromQuery] string tag,
|
|
|
+ [FromQuery] string? tag,
|
|
|
[FromQuery] bool? cropWhitespace,
|
|
|
- [FromQuery] string format,
|
|
|
- [FromQuery] bool addPlayedIndicator,
|
|
|
+ [FromQuery] string? format,
|
|
|
+ [FromQuery] bool? addPlayedIndicator,
|
|
|
[FromQuery] double? percentPlayed,
|
|
|
[FromQuery] int? unplayedCount,
|
|
|
[FromQuery] int? blur,
|
|
|
- [FromQuery] string backgroundColor,
|
|
|
- [FromQuery] string foregroundLayer,
|
|
|
- [FromRoute] int? imageIndex = null,
|
|
|
- [FromQuery] bool enableImageEnhancers = true)
|
|
|
+ [FromQuery] string? backgroundColor,
|
|
|
+ [FromQuery] string? foregroundLayer,
|
|
|
+ [FromRoute] int? imageIndex = null)
|
|
|
{
|
|
|
var item = _libraryManager.GetItemById(itemId);
|
|
|
if (item == null)
|
|
@@ -385,7 +385,6 @@ namespace Jellyfin.Api.Controllers
|
|
|
blur,
|
|
|
backgroundColor,
|
|
|
foregroundLayer,
|
|
|
- enableImageEnhancers,
|
|
|
item,
|
|
|
Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
|
|
|
.ConfigureAwait(false);
|
|
@@ -396,7 +395,84 @@ namespace Jellyfin.Api.Controllers
|
|
|
/// </summary>
|
|
|
/// <param name="itemId">Item id.</param>
|
|
|
/// <param name="imageType">Image type.</param>
|
|
|
+ /// <param name="maxWidth">The maximum image width to return.</param>
|
|
|
+ /// <param name="maxHeight">The maximum image height to return.</param>
|
|
|
+ /// <param name="width">The fixed image width to return.</param>
|
|
|
+ /// <param name="height">The fixed image height to return.</param>
|
|
|
+ /// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
|
+ /// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
|
+ /// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
|
|
|
+ /// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
|
+ /// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
|
|
|
+ /// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
|
+ /// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
|
+ /// <param name="blur">Optional. Blur image.</param>
|
|
|
+ /// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
|
+ /// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
|
/// <param name="imageIndex">Image index.</param>
|
|
|
+ /// <response code="200">Image stream returned.</response>
|
|
|
+ /// <response code="404">Item not found.</response>
|
|
|
+ /// <returns>
|
|
|
+ /// A <see cref="FileStreamResult"/> containing the file stream on success,
|
|
|
+ /// or a <see cref="NotFoundResult"/> if item not found.
|
|
|
+ /// </returns>
|
|
|
+ [HttpGet("/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}")]
|
|
|
+ [HttpHead("/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
+ public async Task<ActionResult> GetItemImage2(
|
|
|
+ [FromRoute] Guid itemId,
|
|
|
+ [FromRoute] ImageType imageType,
|
|
|
+ [FromRoute] int? maxWidth,
|
|
|
+ [FromRoute] int? maxHeight,
|
|
|
+ [FromQuery] int? width,
|
|
|
+ [FromQuery] int? height,
|
|
|
+ [FromQuery] int? quality,
|
|
|
+ [FromRoute] string tag,
|
|
|
+ [FromQuery] bool? cropWhitespace,
|
|
|
+ [FromRoute] string format,
|
|
|
+ [FromQuery] bool? addPlayedIndicator,
|
|
|
+ [FromRoute] double? percentPlayed,
|
|
|
+ [FromRoute] int? unplayedCount,
|
|
|
+ [FromQuery] int? blur,
|
|
|
+ [FromQuery] string? backgroundColor,
|
|
|
+ [FromQuery] string? foregroundLayer,
|
|
|
+ [FromRoute] int? imageIndex = null)
|
|
|
+ {
|
|
|
+ var item = _libraryManager.GetItemById(itemId);
|
|
|
+ if (item == null)
|
|
|
+ {
|
|
|
+ return NotFound();
|
|
|
+ }
|
|
|
+
|
|
|
+ return await GetImageInternal(
|
|
|
+ itemId,
|
|
|
+ imageType,
|
|
|
+ imageIndex,
|
|
|
+ tag,
|
|
|
+ format,
|
|
|
+ maxWidth,
|
|
|
+ maxHeight,
|
|
|
+ percentPlayed,
|
|
|
+ unplayedCount,
|
|
|
+ width,
|
|
|
+ height,
|
|
|
+ quality,
|
|
|
+ cropWhitespace,
|
|
|
+ addPlayedIndicator,
|
|
|
+ blur,
|
|
|
+ backgroundColor,
|
|
|
+ foregroundLayer,
|
|
|
+ item,
|
|
|
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
|
|
|
+ .ConfigureAwait(false);
|
|
|
+ }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Get artist image by name.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="name">Artist name.</param>
|
|
|
+ /// <param name="imageType">Image type.</param>
|
|
|
/// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
|
/// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
|
/// <param name="maxWidth">The maximum image width to return.</param>
|
|
@@ -411,19 +487,20 @@ namespace Jellyfin.Api.Controllers
|
|
|
/// <param name="blur">Optional. Blur image.</param>
|
|
|
/// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
|
/// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
|
- /// <param name="enableImageEnhancers">Enable or disable image enhancers such as cover art.</param>
|
|
|
+ /// <param name="imageIndex">Image index.</param>
|
|
|
/// <response code="200">Image stream returned.</response>
|
|
|
/// <response code="404">Item not found.</response>
|
|
|
/// <returns>
|
|
|
/// A <see cref="FileStreamResult"/> containing the file stream on success,
|
|
|
/// or a <see cref="NotFoundResult"/> if item not found.
|
|
|
/// </returns>
|
|
|
- [HttpGet("/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}")]
|
|
|
- [HttpHead("/Items/{itemId}/Images/{imageType}/{imageIndex}/{tag}/{format}/{maxWidth}/{maxHeight}/{percentPlayed}/{unplayedCount}")]
|
|
|
- public ActionResult<object> GetItemImage(
|
|
|
- [FromRoute] Guid itemId,
|
|
|
+ [HttpGet("/Artists/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [HttpHead("/Artists/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
+ public async Task<ActionResult> GetArtistImage(
|
|
|
+ [FromRoute] string name,
|
|
|
[FromRoute] ImageType imageType,
|
|
|
- [FromRoute] int? imageIndex,
|
|
|
[FromRoute] string tag,
|
|
|
[FromRoute] string format,
|
|
|
[FromRoute] int? maxWidth,
|
|
@@ -434,39 +511,447 @@ namespace Jellyfin.Api.Controllers
|
|
|
[FromQuery] int? height,
|
|
|
[FromQuery] int? quality,
|
|
|
[FromQuery] bool? cropWhitespace,
|
|
|
- [FromQuery] bool addPlayedIndicator,
|
|
|
+ [FromQuery] bool? addPlayedIndicator,
|
|
|
[FromQuery] int? blur,
|
|
|
- [FromQuery] string backgroundColor,
|
|
|
- [FromQuery] string foregroundLayer,
|
|
|
- [FromQuery] bool enableImageEnhancers = true)
|
|
|
+ [FromQuery] string? backgroundColor,
|
|
|
+ [FromQuery] string? foregroundLayer,
|
|
|
+ [FromRoute] int? imageIndex = null)
|
|
|
{
|
|
|
- var item = _libraryManager.GetItemById(itemId);
|
|
|
+ var item = _libraryManager.GetArtist(name);
|
|
|
if (item == null)
|
|
|
{
|
|
|
return NotFound();
|
|
|
}
|
|
|
|
|
|
- return GetImageInternal(
|
|
|
- itemId,
|
|
|
- imageType,
|
|
|
- imageIndex,
|
|
|
- tag,
|
|
|
- format,
|
|
|
- maxWidth,
|
|
|
- maxHeight,
|
|
|
- percentPlayed,
|
|
|
- unplayedCount,
|
|
|
- width,
|
|
|
- height,
|
|
|
- quality,
|
|
|
- cropWhitespace,
|
|
|
- addPlayedIndicator,
|
|
|
- blur,
|
|
|
- backgroundColor,
|
|
|
- foregroundLayer,
|
|
|
- enableImageEnhancers,
|
|
|
- item,
|
|
|
- Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase));
|
|
|
+ return await GetImageInternal(
|
|
|
+ item.Id,
|
|
|
+ imageType,
|
|
|
+ imageIndex,
|
|
|
+ tag,
|
|
|
+ format,
|
|
|
+ maxWidth,
|
|
|
+ maxHeight,
|
|
|
+ percentPlayed,
|
|
|
+ unplayedCount,
|
|
|
+ width,
|
|
|
+ height,
|
|
|
+ quality,
|
|
|
+ cropWhitespace,
|
|
|
+ addPlayedIndicator,
|
|
|
+ blur,
|
|
|
+ backgroundColor,
|
|
|
+ foregroundLayer,
|
|
|
+ item,
|
|
|
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
|
|
|
+ .ConfigureAwait(false);
|
|
|
+ }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Get genre image by name.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="name">Genre name.</param>
|
|
|
+ /// <param name="imageType">Image type.</param>
|
|
|
+ /// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
|
+ /// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
|
+ /// <param name="maxWidth">The maximum image width to return.</param>
|
|
|
+ /// <param name="maxHeight">The maximum image height to return.</param>
|
|
|
+ /// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
|
+ /// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
|
+ /// <param name="width">The fixed image width to return.</param>
|
|
|
+ /// <param name="height">The fixed image height to return.</param>
|
|
|
+ /// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
|
+ /// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
|
|
|
+ /// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
|
|
|
+ /// <param name="blur">Optional. Blur image.</param>
|
|
|
+ /// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
|
+ /// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
|
+ /// <param name="imageIndex">Image index.</param>
|
|
|
+ /// <response code="200">Image stream returned.</response>
|
|
|
+ /// <response code="404">Item not found.</response>
|
|
|
+ /// <returns>
|
|
|
+ /// A <see cref="FileStreamResult"/> containing the file stream on success,
|
|
|
+ /// or a <see cref="NotFoundResult"/> if item not found.
|
|
|
+ /// </returns>
|
|
|
+ [HttpGet("/Genres/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [HttpHead("/Genres/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
+ public async Task<ActionResult> GetGenreImage(
|
|
|
+ [FromRoute] string name,
|
|
|
+ [FromRoute] ImageType imageType,
|
|
|
+ [FromRoute] string tag,
|
|
|
+ [FromRoute] string format,
|
|
|
+ [FromRoute] int? maxWidth,
|
|
|
+ [FromRoute] int? maxHeight,
|
|
|
+ [FromRoute] double? percentPlayed,
|
|
|
+ [FromRoute] int? unplayedCount,
|
|
|
+ [FromQuery] int? width,
|
|
|
+ [FromQuery] int? height,
|
|
|
+ [FromQuery] int? quality,
|
|
|
+ [FromQuery] bool? cropWhitespace,
|
|
|
+ [FromQuery] bool? addPlayedIndicator,
|
|
|
+ [FromQuery] int? blur,
|
|
|
+ [FromQuery] string? backgroundColor,
|
|
|
+ [FromQuery] string? foregroundLayer,
|
|
|
+ [FromRoute] int? imageIndex = null)
|
|
|
+ {
|
|
|
+ var item = _libraryManager.GetGenre(name);
|
|
|
+ if (item == null)
|
|
|
+ {
|
|
|
+ return NotFound();
|
|
|
+ }
|
|
|
+
|
|
|
+ return await GetImageInternal(
|
|
|
+ item.Id,
|
|
|
+ imageType,
|
|
|
+ imageIndex,
|
|
|
+ tag,
|
|
|
+ format,
|
|
|
+ maxWidth,
|
|
|
+ maxHeight,
|
|
|
+ percentPlayed,
|
|
|
+ unplayedCount,
|
|
|
+ width,
|
|
|
+ height,
|
|
|
+ quality,
|
|
|
+ cropWhitespace,
|
|
|
+ addPlayedIndicator,
|
|
|
+ blur,
|
|
|
+ backgroundColor,
|
|
|
+ foregroundLayer,
|
|
|
+ item,
|
|
|
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
|
|
|
+ .ConfigureAwait(false);
|
|
|
+ }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Get music genre image by name.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="name">Music genre name.</param>
|
|
|
+ /// <param name="imageType">Image type.</param>
|
|
|
+ /// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
|
+ /// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
|
+ /// <param name="maxWidth">The maximum image width to return.</param>
|
|
|
+ /// <param name="maxHeight">The maximum image height to return.</param>
|
|
|
+ /// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
|
+ /// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
|
+ /// <param name="width">The fixed image width to return.</param>
|
|
|
+ /// <param name="height">The fixed image height to return.</param>
|
|
|
+ /// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
|
+ /// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
|
|
|
+ /// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
|
|
|
+ /// <param name="blur">Optional. Blur image.</param>
|
|
|
+ /// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
|
+ /// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
|
+ /// <param name="imageIndex">Image index.</param>
|
|
|
+ /// <response code="200">Image stream returned.</response>
|
|
|
+ /// <response code="404">Item not found.</response>
|
|
|
+ /// <returns>
|
|
|
+ /// A <see cref="FileStreamResult"/> containing the file stream on success,
|
|
|
+ /// or a <see cref="NotFoundResult"/> if item not found.
|
|
|
+ /// </returns>
|
|
|
+ [HttpGet("/MusicGenres/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [HttpHead("/MusicGenres/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
+ public async Task<ActionResult> GetMusicGenreImage(
|
|
|
+ [FromRoute] string name,
|
|
|
+ [FromRoute] ImageType imageType,
|
|
|
+ [FromRoute] string tag,
|
|
|
+ [FromRoute] string format,
|
|
|
+ [FromRoute] int? maxWidth,
|
|
|
+ [FromRoute] int? maxHeight,
|
|
|
+ [FromRoute] double? percentPlayed,
|
|
|
+ [FromRoute] int? unplayedCount,
|
|
|
+ [FromQuery] int? width,
|
|
|
+ [FromQuery] int? height,
|
|
|
+ [FromQuery] int? quality,
|
|
|
+ [FromQuery] bool? cropWhitespace,
|
|
|
+ [FromQuery] bool? addPlayedIndicator,
|
|
|
+ [FromQuery] int? blur,
|
|
|
+ [FromQuery] string? backgroundColor,
|
|
|
+ [FromQuery] string? foregroundLayer,
|
|
|
+ [FromRoute] int? imageIndex = null)
|
|
|
+ {
|
|
|
+ var item = _libraryManager.GetMusicGenre(name);
|
|
|
+ if (item == null)
|
|
|
+ {
|
|
|
+ return NotFound();
|
|
|
+ }
|
|
|
+
|
|
|
+ return await GetImageInternal(
|
|
|
+ item.Id,
|
|
|
+ imageType,
|
|
|
+ imageIndex,
|
|
|
+ tag,
|
|
|
+ format,
|
|
|
+ maxWidth,
|
|
|
+ maxHeight,
|
|
|
+ percentPlayed,
|
|
|
+ unplayedCount,
|
|
|
+ width,
|
|
|
+ height,
|
|
|
+ quality,
|
|
|
+ cropWhitespace,
|
|
|
+ addPlayedIndicator,
|
|
|
+ blur,
|
|
|
+ backgroundColor,
|
|
|
+ foregroundLayer,
|
|
|
+ item,
|
|
|
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
|
|
|
+ .ConfigureAwait(false);
|
|
|
+ }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Get person image by name.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="name">Person name.</param>
|
|
|
+ /// <param name="imageType">Image type.</param>
|
|
|
+ /// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
|
+ /// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
|
+ /// <param name="maxWidth">The maximum image width to return.</param>
|
|
|
+ /// <param name="maxHeight">The maximum image height to return.</param>
|
|
|
+ /// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
|
+ /// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
|
+ /// <param name="width">The fixed image width to return.</param>
|
|
|
+ /// <param name="height">The fixed image height to return.</param>
|
|
|
+ /// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
|
+ /// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
|
|
|
+ /// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
|
|
|
+ /// <param name="blur">Optional. Blur image.</param>
|
|
|
+ /// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
|
+ /// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
|
+ /// <param name="imageIndex">Image index.</param>
|
|
|
+ /// <response code="200">Image stream returned.</response>
|
|
|
+ /// <response code="404">Item not found.</response>
|
|
|
+ /// <returns>
|
|
|
+ /// A <see cref="FileStreamResult"/> containing the file stream on success,
|
|
|
+ /// or a <see cref="NotFoundResult"/> if item not found.
|
|
|
+ /// </returns>
|
|
|
+ [HttpGet("/Persons/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [HttpHead("/Persons/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
+ public async Task<ActionResult> GetPersonImage(
|
|
|
+ [FromRoute] string name,
|
|
|
+ [FromRoute] ImageType imageType,
|
|
|
+ [FromRoute] string tag,
|
|
|
+ [FromRoute] string format,
|
|
|
+ [FromRoute] int? maxWidth,
|
|
|
+ [FromRoute] int? maxHeight,
|
|
|
+ [FromRoute] double? percentPlayed,
|
|
|
+ [FromRoute] int? unplayedCount,
|
|
|
+ [FromQuery] int? width,
|
|
|
+ [FromQuery] int? height,
|
|
|
+ [FromQuery] int? quality,
|
|
|
+ [FromQuery] bool? cropWhitespace,
|
|
|
+ [FromQuery] bool? addPlayedIndicator,
|
|
|
+ [FromQuery] int? blur,
|
|
|
+ [FromQuery] string? backgroundColor,
|
|
|
+ [FromQuery] string? foregroundLayer,
|
|
|
+ [FromRoute] int? imageIndex = null)
|
|
|
+ {
|
|
|
+ var item = _libraryManager.GetPerson(name);
|
|
|
+ if (item == null)
|
|
|
+ {
|
|
|
+ return NotFound();
|
|
|
+ }
|
|
|
+
|
|
|
+ return await GetImageInternal(
|
|
|
+ item.Id,
|
|
|
+ imageType,
|
|
|
+ imageIndex,
|
|
|
+ tag,
|
|
|
+ format,
|
|
|
+ maxWidth,
|
|
|
+ maxHeight,
|
|
|
+ percentPlayed,
|
|
|
+ unplayedCount,
|
|
|
+ width,
|
|
|
+ height,
|
|
|
+ quality,
|
|
|
+ cropWhitespace,
|
|
|
+ addPlayedIndicator,
|
|
|
+ blur,
|
|
|
+ backgroundColor,
|
|
|
+ foregroundLayer,
|
|
|
+ item,
|
|
|
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
|
|
|
+ .ConfigureAwait(false);
|
|
|
+ }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Get studio image by name.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="name">Studio name.</param>
|
|
|
+ /// <param name="imageType">Image type.</param>
|
|
|
+ /// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
|
+ /// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
|
+ /// <param name="maxWidth">The maximum image width to return.</param>
|
|
|
+ /// <param name="maxHeight">The maximum image height to return.</param>
|
|
|
+ /// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
|
+ /// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
|
+ /// <param name="width">The fixed image width to return.</param>
|
|
|
+ /// <param name="height">The fixed image height to return.</param>
|
|
|
+ /// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
|
+ /// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
|
|
|
+ /// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
|
|
|
+ /// <param name="blur">Optional. Blur image.</param>
|
|
|
+ /// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
|
+ /// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
|
+ /// <param name="imageIndex">Image index.</param>
|
|
|
+ /// <response code="200">Image stream returned.</response>
|
|
|
+ /// <response code="404">Item not found.</response>
|
|
|
+ /// <returns>
|
|
|
+ /// A <see cref="FileStreamResult"/> containing the file stream on success,
|
|
|
+ /// or a <see cref="NotFoundResult"/> if item not found.
|
|
|
+ /// </returns>
|
|
|
+ [HttpGet("/Studios/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [HttpHead("/Studios/{name}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
+ public async Task<ActionResult> GetStudioImage(
|
|
|
+ [FromRoute] string name,
|
|
|
+ [FromRoute] ImageType imageType,
|
|
|
+ [FromRoute] string tag,
|
|
|
+ [FromRoute] string format,
|
|
|
+ [FromRoute] int? maxWidth,
|
|
|
+ [FromRoute] int? maxHeight,
|
|
|
+ [FromRoute] double? percentPlayed,
|
|
|
+ [FromRoute] int? unplayedCount,
|
|
|
+ [FromQuery] int? width,
|
|
|
+ [FromQuery] int? height,
|
|
|
+ [FromQuery] int? quality,
|
|
|
+ [FromQuery] bool? cropWhitespace,
|
|
|
+ [FromQuery] bool? addPlayedIndicator,
|
|
|
+ [FromQuery] int? blur,
|
|
|
+ [FromQuery] string? backgroundColor,
|
|
|
+ [FromQuery] string? foregroundLayer,
|
|
|
+ [FromRoute] int? imageIndex = null)
|
|
|
+ {
|
|
|
+ var item = _libraryManager.GetStudio(name);
|
|
|
+ if (item == null)
|
|
|
+ {
|
|
|
+ return NotFound();
|
|
|
+ }
|
|
|
+
|
|
|
+ return await GetImageInternal(
|
|
|
+ item.Id,
|
|
|
+ imageType,
|
|
|
+ imageIndex,
|
|
|
+ tag,
|
|
|
+ format,
|
|
|
+ maxWidth,
|
|
|
+ maxHeight,
|
|
|
+ percentPlayed,
|
|
|
+ unplayedCount,
|
|
|
+ width,
|
|
|
+ height,
|
|
|
+ quality,
|
|
|
+ cropWhitespace,
|
|
|
+ addPlayedIndicator,
|
|
|
+ blur,
|
|
|
+ backgroundColor,
|
|
|
+ foregroundLayer,
|
|
|
+ item,
|
|
|
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase))
|
|
|
+ .ConfigureAwait(false);
|
|
|
+ }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Get user profile image.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="userId">User id.</param>
|
|
|
+ /// <param name="imageType">Image type.</param>
|
|
|
+ /// <param name="tag">Optional. Supply the cache tag from the item object to receive strong caching headers.</param>
|
|
|
+ /// <param name="format">Determines the output format of the image - original,gif,jpg,png.</param>
|
|
|
+ /// <param name="maxWidth">The maximum image width to return.</param>
|
|
|
+ /// <param name="maxHeight">The maximum image height to return.</param>
|
|
|
+ /// <param name="percentPlayed">Optional. Percent to render for the percent played overlay.</param>
|
|
|
+ /// <param name="unplayedCount">Optional. Unplayed count overlay to render.</param>
|
|
|
+ /// <param name="width">The fixed image width to return.</param>
|
|
|
+ /// <param name="height">The fixed image height to return.</param>
|
|
|
+ /// <param name="quality">Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.</param>
|
|
|
+ /// <param name="cropWhitespace">Optional. Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.</param>
|
|
|
+ /// <param name="addPlayedIndicator">Optional. Add a played indicator.</param>
|
|
|
+ /// <param name="blur">Optional. Blur image.</param>
|
|
|
+ /// <param name="backgroundColor">Optional. Apply a background color for transparent images.</param>
|
|
|
+ /// <param name="foregroundLayer">Optional. Apply a foreground layer on top of the image.</param>
|
|
|
+ /// <param name="imageIndex">Image index.</param>
|
|
|
+ /// <response code="200">Image stream returned.</response>
|
|
|
+ /// <response code="404">Item not found.</response>
|
|
|
+ /// <returns>
|
|
|
+ /// A <see cref="FileStreamResult"/> containing the file stream on success,
|
|
|
+ /// or a <see cref="NotFoundResult"/> if item not found.
|
|
|
+ /// </returns>
|
|
|
+ [HttpGet("/Users/{userId}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [HttpHead("/Users/{userId}/Images/{imageType}/{imageIndex?}")]
|
|
|
+ [ProducesResponseType(StatusCodes.Status200OK)]
|
|
|
+ [ProducesResponseType(StatusCodes.Status404NotFound)]
|
|
|
+ public async Task<ActionResult> GetUserImage(
|
|
|
+ [FromRoute] Guid userId,
|
|
|
+ [FromRoute] ImageType imageType,
|
|
|
+ [FromQuery] string? tag,
|
|
|
+ [FromQuery] string? format,
|
|
|
+ [FromQuery] int? maxWidth,
|
|
|
+ [FromQuery] int? maxHeight,
|
|
|
+ [FromQuery] double? percentPlayed,
|
|
|
+ [FromQuery] int? unplayedCount,
|
|
|
+ [FromQuery] int? width,
|
|
|
+ [FromQuery] int? height,
|
|
|
+ [FromQuery] int? quality,
|
|
|
+ [FromQuery] bool? cropWhitespace,
|
|
|
+ [FromQuery] bool? addPlayedIndicator,
|
|
|
+ [FromQuery] int? blur,
|
|
|
+ [FromQuery] string? backgroundColor,
|
|
|
+ [FromQuery] string? foregroundLayer,
|
|
|
+ [FromRoute] int? imageIndex = null)
|
|
|
+ {
|
|
|
+ var user = _userManager.GetUserById(userId);
|
|
|
+ if (user == null)
|
|
|
+ {
|
|
|
+ return NotFound();
|
|
|
+ }
|
|
|
+
|
|
|
+ var info = new ItemImageInfo
|
|
|
+ {
|
|
|
+ Path = user.ProfileImage.Path,
|
|
|
+ Type = ImageType.Profile,
|
|
|
+ DateModified = user.ProfileImage.LastModified
|
|
|
+ };
|
|
|
+
|
|
|
+ if (width.HasValue)
|
|
|
+ {
|
|
|
+ info.Width = width.Value;
|
|
|
+ }
|
|
|
+
|
|
|
+ if (height.HasValue)
|
|
|
+ {
|
|
|
+ info.Height = height.Value;
|
|
|
+ }
|
|
|
+
|
|
|
+ return await GetImageInternal(
|
|
|
+ user.Id,
|
|
|
+ imageType,
|
|
|
+ imageIndex,
|
|
|
+ tag,
|
|
|
+ format,
|
|
|
+ maxWidth,
|
|
|
+ maxHeight,
|
|
|
+ percentPlayed,
|
|
|
+ unplayedCount,
|
|
|
+ width,
|
|
|
+ height,
|
|
|
+ quality,
|
|
|
+ cropWhitespace,
|
|
|
+ addPlayedIndicator,
|
|
|
+ blur,
|
|
|
+ backgroundColor,
|
|
|
+ foregroundLayer,
|
|
|
+ null,
|
|
|
+ Request.Method.Equals(HttpMethods.Head, StringComparison.OrdinalIgnoreCase),
|
|
|
+ info)
|
|
|
+ .ConfigureAwait(false);
|
|
|
}
|
|
|
|
|
|
private static async Task<MemoryStream> GetMemoryStream(Stream inputStream)
|
|
@@ -475,7 +960,7 @@ namespace Jellyfin.Api.Controllers
|
|
|
var text = await reader.ReadToEndAsync().ConfigureAwait(false);
|
|
|
|
|
|
var bytes = Convert.FromBase64String(text);
|
|
|
- return new MemoryStream(bytes) {Position = 0};
|
|
|
+ return new MemoryStream(bytes) { Position = 0 };
|
|
|
}
|
|
|
|
|
|
private ImageInfo? GetImageInfo(BaseItem item, ItemImageInfo info, int? imageIndex)
|
|
@@ -525,7 +1010,6 @@ namespace Jellyfin.Api.Controllers
|
|
|
catch (Exception ex)
|
|
|
{
|
|
|
_logger.LogError(ex, "Error getting image information for {Path}", info.Path);
|
|
|
-
|
|
|
return null;
|
|
|
}
|
|
|
}
|
|
@@ -534,8 +1018,8 @@ namespace Jellyfin.Api.Controllers
|
|
|
Guid itemId,
|
|
|
ImageType imageType,
|
|
|
int? imageIndex,
|
|
|
- string tag,
|
|
|
- string format,
|
|
|
+ string? tag,
|
|
|
+ string? format,
|
|
|
int? maxWidth,
|
|
|
int? maxHeight,
|
|
|
double? percentPlayed,
|
|
@@ -544,13 +1028,13 @@ namespace Jellyfin.Api.Controllers
|
|
|
int? height,
|
|
|
int? quality,
|
|
|
bool? cropWhitespace,
|
|
|
- bool addPlayedIndicator,
|
|
|
+ bool? addPlayedIndicator,
|
|
|
int? blur,
|
|
|
- string backgroundColor,
|
|
|
- string foregroundLayer,
|
|
|
- bool enableImageEnhancers,
|
|
|
- BaseItem item,
|
|
|
- bool isHeadRequest)
|
|
|
+ string? backgroundColor,
|
|
|
+ string? foregroundLayer,
|
|
|
+ BaseItem? item,
|
|
|
+ bool isHeadRequest,
|
|
|
+ ItemImageInfo? imageInfo = null)
|
|
|
{
|
|
|
if (percentPlayed.HasValue)
|
|
|
{
|
|
@@ -576,16 +1060,16 @@ namespace Jellyfin.Api.Controllers
|
|
|
unplayedCount = null;
|
|
|
}
|
|
|
|
|
|
- var imageInfo = item.GetImageInfo(imageType, imageIndex ?? 0);
|
|
|
if (imageInfo == null)
|
|
|
{
|
|
|
- return NotFound(string.Format(NumberFormatInfo.InvariantInfo, "{0} does not have an image of type {1}", item.Name, imageType));
|
|
|
+ imageInfo = item?.GetImageInfo(imageType, imageIndex ?? 0);
|
|
|
+ if (imageInfo == null)
|
|
|
+ {
|
|
|
+ return NotFound(string.Format(NumberFormatInfo.InvariantInfo, "{0} does not have an image of type {1}", item?.Name, imageType));
|
|
|
+ }
|
|
|
}
|
|
|
|
|
|
- if (!cropWhitespace.HasValue)
|
|
|
- {
|
|
|
- cropWhitespace = imageType == ImageType.Logo || imageType == ImageType.Art;
|
|
|
- }
|
|
|
+ cropWhitespace ??= imageType == ImageType.Logo || imageType == ImageType.Art;
|
|
|
|
|
|
var outputFormats = GetOutputFormats(format);
|
|
|
|
|
@@ -596,7 +1080,11 @@ namespace Jellyfin.Api.Controllers
|
|
|
cacheDuration = TimeSpan.FromDays(365);
|
|
|
}
|
|
|
|
|
|
- var responseHeaders = new Dictionary<string, string> {{"transferMode.dlna.org", "Interactive"}, {"realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*"}};
|
|
|
+ var responseHeaders = new Dictionary<string, string>
|
|
|
+ {
|
|
|
+ { "transferMode.dlna.org", "Interactive" },
|
|
|
+ { "realTimeInfo.dlna.org", "DLNA.ORG_TLAG=*" }
|
|
|
+ };
|
|
|
|
|
|
return await GetImageResult(
|
|
|
item,
|
|
@@ -621,12 +1109,12 @@ namespace Jellyfin.Api.Controllers
|
|
|
isHeadRequest).ConfigureAwait(false);
|
|
|
}
|
|
|
|
|
|
- private ImageFormat[] GetOutputFormats(string format)
|
|
|
+ private ImageFormat[] GetOutputFormats(string? format)
|
|
|
{
|
|
|
if (!string.IsNullOrWhiteSpace(format)
|
|
|
&& Enum.TryParse(format, true, out ImageFormat parsedFormat))
|
|
|
{
|
|
|
- return new[] {parsedFormat};
|
|
|
+ return new[] { parsedFormat };
|
|
|
}
|
|
|
|
|
|
return GetClientSupportedFormats();
|
|
@@ -698,7 +1186,7 @@ namespace Jellyfin.Api.Controllers
|
|
|
}
|
|
|
|
|
|
private async Task<ActionResult> GetImageResult(
|
|
|
- BaseItem item,
|
|
|
+ BaseItem? item,
|
|
|
Guid itemId,
|
|
|
int? index,
|
|
|
int? height,
|
|
@@ -706,12 +1194,12 @@ namespace Jellyfin.Api.Controllers
|
|
|
int? maxWidth,
|
|
|
int? quality,
|
|
|
int? width,
|
|
|
- bool addPlayedIndicator,
|
|
|
+ bool? addPlayedIndicator,
|
|
|
double? percentPlayed,
|
|
|
int? unplayedCount,
|
|
|
int? blur,
|
|
|
- string backgroundColor,
|
|
|
- string foregroundLayer,
|
|
|
+ string? backgroundColor,
|
|
|
+ string? foregroundLayer,
|
|
|
ItemImageInfo imageInfo,
|
|
|
bool cropWhitespace,
|
|
|
IReadOnlyCollection<ImageFormat> supportedFormats,
|
|
@@ -719,7 +1207,7 @@ namespace Jellyfin.Api.Controllers
|
|
|
IDictionary<string, string> headers,
|
|
|
bool isHeadRequest)
|
|
|
{
|
|
|
- if (!imageInfo.IsLocalFile)
|
|
|
+ if (!imageInfo.IsLocalFile && item != null)
|
|
|
{
|
|
|
imageInfo = await _libraryManager.ConvertImageToLocal(item, imageInfo, index ?? 0).ConfigureAwait(false);
|
|
|
}
|
|
@@ -736,7 +1224,7 @@ namespace Jellyfin.Api.Controllers
|
|
|
MaxWidth = maxWidth,
|
|
|
Quality = quality ?? 100,
|
|
|
Width = width,
|
|
|
- AddPlayedIndicator = addPlayedIndicator,
|
|
|
+ AddPlayedIndicator = addPlayedIndicator ?? false,
|
|
|
PercentPlayed = percentPlayed ?? 0,
|
|
|
UnplayedCount = unplayedCount,
|
|
|
Blur = blur,
|
|
@@ -745,23 +1233,63 @@ namespace Jellyfin.Api.Controllers
|
|
|
SupportedOutputFormats = supportedFormats
|
|
|
};
|
|
|
|
|
|
- var imageResult = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
|
|
|
-
|
|
|
- headers[HeaderNames.Vary] = HeaderNames.Accept;
|
|
|
- /*
|
|
|
- // TODO
|
|
|
- return _resultFactory.GetStaticFileResult(Request, new StaticFileResultOptions
|
|
|
- {
|
|
|
- CacheDuration = cacheDuration,
|
|
|
- ResponseHeaders = headers,
|
|
|
- ContentType = imageResult.Item2,
|
|
|
- DateLastModified = imageResult.Item3,
|
|
|
- IsHeadRequest = isHeadRequest,
|
|
|
- Path = imageResult.Item1,
|
|
|
- FileShare = FileShare.Read
|
|
|
- });
|
|
|
- */
|
|
|
- return NoContent();
|
|
|
+ var (imagePath, imageContentType, dateImageModified) = await _imageProcessor.ProcessImage(options).ConfigureAwait(false);
|
|
|
+
|
|
|
+ var disableCaching = Request.Headers[HeaderNames.CacheControl].Contains("no-cache");
|
|
|
+ var parsingSuccessful = DateTime.TryParse(Request.Headers[HeaderNames.IfModifiedSince], out var ifModifiedSinceHeader);
|
|
|
+
|
|
|
+ // if the parsing of the IfModifiedSince header was not successful, disable caching
|
|
|
+ if (!parsingSuccessful)
|
|
|
+ {
|
|
|
+ // disableCaching = true;
|
|
|
+ }
|
|
|
+
|
|
|
+ foreach (var (key, value) in headers)
|
|
|
+ {
|
|
|
+ Response.Headers.Add(key, value);
|
|
|
+ }
|
|
|
+
|
|
|
+ Response.ContentType = imageContentType;
|
|
|
+ Response.Headers.Add(HeaderNames.Age, Convert.ToInt64((DateTime.UtcNow - dateImageModified).TotalSeconds).ToString(CultureInfo.InvariantCulture));
|
|
|
+ Response.Headers.Add(HeaderNames.Vary, HeaderNames.Accept);
|
|
|
+
|
|
|
+ if (disableCaching)
|
|
|
+ {
|
|
|
+ Response.Headers.Add(HeaderNames.CacheControl, "no-cache, no-store, must-revalidate");
|
|
|
+ Response.Headers.Add(HeaderNames.Pragma, "no-cache, no-store, must-revalidate");
|
|
|
+ }
|
|
|
+ else
|
|
|
+ {
|
|
|
+ if (cacheDuration.HasValue)
|
|
|
+ {
|
|
|
+ Response.Headers.Add(HeaderNames.CacheControl, "public, max-age=" + cacheDuration.Value.TotalSeconds);
|
|
|
+ }
|
|
|
+ else
|
|
|
+ {
|
|
|
+ Response.Headers.Add(HeaderNames.CacheControl, "public");
|
|
|
+ }
|
|
|
+
|
|
|
+ Response.Headers.Add(HeaderNames.LastModified, dateImageModified.ToUniversalTime().ToString("ddd, dd MMM yyyy HH:mm:ss \"GMT\"", new CultureInfo("en-US", false)));
|
|
|
+
|
|
|
+ // if the image was not modified since "ifModifiedSinceHeader"-header, return a HTTP status code 304 not modified
|
|
|
+ if (!(dateImageModified > ifModifiedSinceHeader))
|
|
|
+ {
|
|
|
+ if (ifModifiedSinceHeader.Add(cacheDuration!.Value) < DateTime.UtcNow)
|
|
|
+ {
|
|
|
+ Response.StatusCode = StatusCodes.Status304NotModified;
|
|
|
+ return new ContentResult();
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ // if the request is a head request, return a NoContent result with the same headers as it would with a GET request
|
|
|
+ if (isHeadRequest)
|
|
|
+ {
|
|
|
+ return NoContent();
|
|
|
+ }
|
|
|
+
|
|
|
+ var stream = new FileStream(imagePath, FileMode.Open, FileAccess.Read);
|
|
|
+ return File(stream, imageContentType);
|
|
|
}
|
|
|
}
|
|
|
}
|