// // Copyright (c) PlaceholderCompany. All rights reserved. // #nullable disable #pragma warning disable CS1591 namespace MediaBrowser.Model.Entities; using global::System; using global::System.Collections.Frozen; using global::System.Collections.Generic; using global::System.ComponentModel; using global::System.Globalization; using global::System.Linq; using global::System.Text; using global::System.Text.Json.Serialization; using Jellyfin.Data.Enums; using Jellyfin.Extensions; using MediaBrowser.Model.Dlna; using MediaBrowser.Model.Extensions; using MediaBrowser.Model.MediaInfo; /// /// Class MediaStream. /// public class MediaStream { /// /// Special ISO 639-2 language codes that should not be displayed in the UI. /// private static readonly string[] SpecialCodes = { // Uncoded languages. "mis", // Multiple languages. "mul", // Undetermined. "und", // No linguistic content; not applicable. "zxx", }; /// /// Gets or sets the codec. /// /// The codec. public string Codec { get; set; } /// /// Gets or sets the codec tag. /// /// The codec tag. public string CodecTag { get; set; } /// /// Gets or sets the language. /// /// The language. public string Language { get; set; } /// /// Gets or sets the color range. /// /// The color range. public string ColorRange { get; set; } /// /// Gets or sets the color space. /// /// The color space. public string ColorSpace { get; set; } /// /// Gets or sets the color transfer. /// /// The color transfer. public string ColorTransfer { get; set; } /// /// Gets or sets the color primaries. /// /// The color primaries. public string ColorPrimaries { get; set; } /// /// Gets or sets the Dolby Vision version major. /// /// The Dolby Vision version major. public int? DvVersionMajor { get; set; } /// /// Gets or sets the Dolby Vision version minor. /// /// The Dolby Vision version minor. public int? DvVersionMinor { get; set; } /// /// Gets or sets the Dolby Vision profile. /// /// The Dolby Vision profile. public int? DvProfile { get; set; } /// /// Gets or sets the Dolby Vision level. /// /// The Dolby Vision level. public int? DvLevel { get; set; } /// /// Gets or sets the Dolby Vision rpu present flag. /// /// The Dolby Vision rpu present flag. public int? RpuPresentFlag { get; set; } /// /// Gets or sets the Dolby Vision el present flag. /// /// The Dolby Vision el present flag. public int? ElPresentFlag { get; set; } /// /// Gets or sets the Dolby Vision bl present flag. /// /// The Dolby Vision bl present flag. public int? BlPresentFlag { get; set; } /// /// Gets or sets the Dolby Vision bl signal compatibility id. /// /// The Dolby Vision bl signal compatibility id. public int? DvBlSignalCompatibilityId { get; set; } /// /// Gets or sets the Rotation in degrees. /// /// The video rotation. public int? Rotation { get; set; } /// /// Gets or sets the comment. /// /// The comment. public string Comment { get; set; } /// /// Gets or sets the time base. /// /// The time base. public string TimeBase { get; set; } /// /// Gets or sets the codec time base. /// /// The codec time base. public string CodecTimeBase { get; set; } /// /// Gets or sets the title. /// /// The title. public string Title { get; set; } /// /// Gets or sets a value indicating whether the HDR10+ present flag. /// /// The HDR10+ present flag. public bool? Hdr10PlusPresentFlag { get; set; } /// /// Gets the video range. /// /// The video range. [DefaultValue(VideoRange.Unknown)] public VideoRange VideoRange { get { var (videoRange, _) = this.GetVideoColorRange(); return videoRange; } } /// /// Gets the video range type. /// /// The video range type. [DefaultValue(VideoRangeType.Unknown)] public VideoRangeType VideoRangeType { get { var (_, videoRangeType) = this.GetVideoColorRange(); return videoRangeType; } } /// /// Gets the video dovi title. /// /// The video dovi title. public string VideoDoViTitle { get { var dvProfile = this.DvProfile; var rpuPresentFlag = this.RpuPresentFlag == 1; var blPresentFlag = this.BlPresentFlag == 1; var dvBlCompatId = this.DvBlSignalCompatibilityId; if (rpuPresentFlag && blPresentFlag && (dvProfile == 4 || dvProfile == 5 || dvProfile == 7 || dvProfile == 8 || dvProfile == 9 || dvProfile == 10)) { var title = "Dolby Vision Profile " + dvProfile; if (dvBlCompatId > 0) { title += "." + dvBlCompatId; } return dvBlCompatId switch { 1 => title + " (HDR10)", 2 => title + " (SDR)", 4 => title + " (HLG)", 6 => title + " (HDR10)", // Technically means Blu-ray, but practically always HDR10 _ => title, }; } return null; } } /// /// Gets the audio spatial format. /// /// The audio spatial format. [DefaultValue(AudioSpatialFormat.None)] public AudioSpatialFormat AudioSpatialFormat { get { if (this.Type != MediaStreamType.Audio || string.IsNullOrEmpty(this.Profile)) { return AudioSpatialFormat.None; } return this.Profile.Contains("Dolby Atmos", StringComparison.OrdinalIgnoreCase) ? AudioSpatialFormat.DolbyAtmos : this.Profile.Contains("DTS:X", StringComparison.OrdinalIgnoreCase) ? AudioSpatialFormat.DTSX : AudioSpatialFormat.None; } } /// /// Gets or sets the localized text for undefined language. /// /// The localized text for undefined language. public string LocalizedUndefined { get; set; } /// /// Gets or sets the localized text for default stream indicator. /// /// The localized text for default stream indicator. public string LocalizedDefault { get; set; } /// /// Gets or sets the localized text for forced stream indicator. /// /// The localized text for forced stream indicator. public string LocalizedForced { get; set; } /// /// Gets or sets the localized text for external stream indicator. /// /// The localized text for external stream indicator. public string LocalizedExternal { get; set; } /// /// Gets or sets the localized text for hearing impaired indicator. /// /// The localized text for hearing impaired indicator. public string LocalizedHearingImpaired { get; set; } /// /// Gets or sets the localized language name. /// /// The localized language name. public string LocalizedLanguage { get; set; } /// /// Gets the display title for the media stream. /// /// The display title. public string DisplayTitle { get { switch (this.Type) { case MediaStreamType.Audio: { var attributes = new List(); // Do not display the language code in display titles if unset or set to a special code. Show it in all other cases (possibly expanded). if (!string.IsNullOrEmpty(this.Language) && !SpecialCodes.Contains(this.Language, StringComparison.OrdinalIgnoreCase)) { // Use pre-resolved localized language name, falling back to raw language code. attributes.Add(StringHelper.FirstToUpper(this.LocalizedLanguage ?? this.Language)); } if (!string.IsNullOrEmpty(this.Profile) && !string.Equals(this.Profile, "lc", StringComparison.OrdinalIgnoreCase)) { attributes.Add(this.Profile); } else if (!string.IsNullOrEmpty(this.Codec)) { attributes.Add(AudioCodec.GetFriendlyName(this.Codec)); } if (!string.IsNullOrEmpty(this.ChannelLayout)) { attributes.Add(StringHelper.FirstToUpper(this.ChannelLayout)); } else if (this.Channels.HasValue) { attributes.Add(this.Channels.Value.ToString(CultureInfo.InvariantCulture) + " ch"); } if (this.IsDefault) { attributes.Add(string.IsNullOrEmpty(this.LocalizedDefault) ? "Default" : this.LocalizedDefault); } if (this.IsExternal) { attributes.Add(string.IsNullOrEmpty(this.LocalizedExternal) ? "External" : this.LocalizedExternal); } if (!string.IsNullOrEmpty(this.Title)) { var result = new StringBuilder(this.Title); foreach (var tag in attributes) { // Keep Tags that are not already in Title. if (!this.Title.Contains(tag, StringComparison.OrdinalIgnoreCase)) { result.Append(" - ").Append(tag); } } return result.ToString(); } return string.Join(" - ", attributes); } case MediaStreamType.Video: { var attributes = new List(); var resolutionText = this.GetResolutionText(); if (!string.IsNullOrEmpty(resolutionText)) { attributes.Add(resolutionText); } if (!string.IsNullOrEmpty(this.Codec)) { attributes.Add(this.Codec.ToUpperInvariant()); } if (this.VideoDoViTitle is not null) { attributes.Add(this.VideoDoViTitle); } else if (this.VideoRange != VideoRange.Unknown) { attributes.Add(this.VideoRange.ToString()); } if (!string.IsNullOrEmpty(this.Title)) { var result = new StringBuilder(this.Title); foreach (var tag in attributes) { // Keep Tags that are not already in Title. if (!this.Title.Contains(tag, StringComparison.OrdinalIgnoreCase)) { result.Append(" - ").Append(tag); } } return result.ToString(); } return string.Join(' ', attributes); } case MediaStreamType.Subtitle: { var attributes = new List(); if (!string.IsNullOrEmpty(this.Language)) { // Use pre-resolved localized language name, falling back to raw language code. attributes.Add(StringHelper.FirstToUpper(this.LocalizedLanguage ?? this.Language)); } else { attributes.Add(string.IsNullOrEmpty(this.LocalizedUndefined) ? "Und" : this.LocalizedUndefined); } if (this.IsHearingImpaired == true) { attributes.Add(string.IsNullOrEmpty(this.LocalizedHearingImpaired) ? "Hearing Impaired" : this.LocalizedHearingImpaired); } if (this.IsDefault) { attributes.Add(string.IsNullOrEmpty(this.LocalizedDefault) ? "Default" : this.LocalizedDefault); } if (this.IsForced) { attributes.Add(string.IsNullOrEmpty(this.LocalizedForced) ? "Forced" : this.LocalizedForced); } if (!string.IsNullOrEmpty(this.Codec)) { attributes.Add(this.Codec.ToUpperInvariant()); } if (this.IsExternal) { attributes.Add(string.IsNullOrEmpty(this.LocalizedExternal) ? "External" : this.LocalizedExternal); } if (!string.IsNullOrEmpty(this.Title)) { var result = new StringBuilder(this.Title); foreach (var tag in attributes) { // Keep Tags that are not already in Title. if (!this.Title.Contains(tag, StringComparison.OrdinalIgnoreCase)) { result.Append(" - ").Append(tag); } } return result.ToString(); } return string.Join(" - ", attributes); } default: return null; } } } /// /// Gets or sets the NAL length size. /// /// The NAL length size. public string NalLengthSize { get; set; } /// /// Gets or sets a value indicating whether this instance is interlaced. /// /// true if this instance is interlaced; otherwise, false. public bool IsInterlaced { get; set; } /// /// Gets or sets a value indicating whether this instance is AVC. /// /// true if this instance is AVC; otherwise, false. public bool? IsAVC { get; set; } /// /// Gets or sets the channel layout. /// /// The channel layout. public string ChannelLayout { get; set; } /// /// Gets or sets the bit rate. /// /// The bit rate. public int? BitRate { get; set; } /// /// Gets or sets the bit depth. /// /// The bit depth. public int? BitDepth { get; set; } /// /// Gets or sets the reference frames. /// /// The reference frames. public int? RefFrames { get; set; } /// /// Gets or sets the length of the packet. /// /// The length of the packet. public int? PacketLength { get; set; } /// /// Gets or sets the channels. /// /// The channels. public int? Channels { get; set; } /// /// Gets or sets the sample rate. /// /// The sample rate. public int? SampleRate { get; set; } /// /// Gets or sets a value indicating whether this instance is default. /// /// true if this instance is default; otherwise, false. public bool IsDefault { get; set; } /// /// Gets or sets a value indicating whether this instance is forced. /// /// true if this instance is forced; otherwise, false. public bool IsForced { get; set; } /// /// Gets or sets a value indicating whether this instance is for the hearing impaired. /// /// true if this instance is for the hearing impaired; otherwise, false. public bool IsHearingImpaired { get; set; } /// /// Gets or sets the height. /// /// The height. public int? Height { get; set; } /// /// Gets or sets the width. /// /// The width. public int? Width { get; set; } /// /// Gets or sets the average frame rate. /// /// The average frame rate. public float? AverageFrameRate { get; set; } /// /// Gets or sets the real frame rate. /// /// The real frame rate. public float? RealFrameRate { get; set; } /// /// Gets the framerate used as reference. /// Prefer AverageFrameRate, if that is null or an unrealistic value /// then fallback to RealFrameRate. /// /// The reference frame rate. public float? ReferenceFrameRate { get { // In some cases AverageFrameRate for videos will be read as 1000fps even if it is not. // This is probably due to a library compatibility issue. // See https://github.com/jellyfin/jellyfin/pull/12603#discussion_r1748044018 for more info. return this.AverageFrameRate < 1000 ? this.AverageFrameRate : this.RealFrameRate; } } /// /// Gets or sets the profile. /// /// The profile. public string Profile { get; set; } /// /// Gets or sets the type. /// /// The type. public MediaStreamType Type { get; set; } /// /// Gets or sets the aspect ratio. /// /// The aspect ratio. public string AspectRatio { get; set; } /// /// Gets or sets the index. /// /// The index. public int Index { get; set; } /// /// Gets or sets the score. /// /// The score. public int? Score { get; set; } /// /// Gets or sets a value indicating whether this instance is external. /// /// true if this instance is external; otherwise, false. public bool IsExternal { get; set; } /// /// Gets or sets the method. /// /// The method. public SubtitleDeliveryMethod? DeliveryMethod { get; set; } /// /// Gets or sets the delivery URL. /// /// The delivery URL. public string DeliveryUrl { get; set; } /// /// Gets or sets a value indicating whether this instance is external URL. /// /// null if [is external URL] contains no value, true if [is external URL]; otherwise, false. public bool? IsExternalUrl { get; set; } /// /// Gets a value indicating whether this instance is a text subtitle stream. /// /// true if this instance is a text subtitle stream; otherwise, false. public bool IsTextSubtitleStream { get { if (this.Type != MediaStreamType.Subtitle) { return false; } if (string.IsNullOrEmpty(this.Codec) && !this.IsExternal) { return false; } return IsTextFormat(this.Codec); } } /// /// Gets a value indicating whether this instance is a PGS subtitle stream. /// /// true if this instance is a PGS subtitle stream; otherwise, false. [JsonIgnore] public bool IsPgsSubtitleStream { get { if (this.Type != MediaStreamType.Subtitle) { return false; } if (string.IsNullOrEmpty(this.Codec) && !this.IsExternal) { return false; } return IsPgsFormat(this.Codec); } } /// /// Gets a value indicating whether this is a subtitle steam that is extractable by ffmpeg. /// All text-based and pgs subtitles can be extracted. /// /// true if this is a extractable subtitle steam otherwise, false. [JsonIgnore] public bool IsExtractableSubtitleStream => this.IsTextSubtitleStream || this.IsPgsSubtitleStream; /// /// Gets or sets a value indicating whether [supports external stream]. /// /// true if [supports external stream]; otherwise, false. public bool SupportsExternalStream { get; set; } /// /// Gets or sets the filename. /// /// The filename. public string Path { get; set; } /// /// Gets or sets the pixel format. /// /// The pixel format. public string PixelFormat { get; set; } /// /// Gets or sets the level. /// /// The level. public double? Level { get; set; } /// /// Gets or sets whether this instance is anamorphic. /// /// true if this instance is anamorphic; otherwise, false. public bool? IsAnamorphic { get; set; } /// /// Determines whether the specified format is a text-based subtitle format. /// /// The subtitle format/codec to check. /// true if the format is text-based; otherwise, false. public static bool IsTextFormat(string format) { string codec = format ?? string.Empty; // microdvd and dvdsub/vobsub share the ".sub" file extension, but it's text-based. return codec.Contains("microdvd", StringComparison.OrdinalIgnoreCase) || (!codec.Contains("pgs", StringComparison.OrdinalIgnoreCase) && !codec.Contains("dvdsub", StringComparison.OrdinalIgnoreCase) && !codec.Contains("dvbsub", StringComparison.OrdinalIgnoreCase) && !string.Equals(codec, "sup", StringComparison.OrdinalIgnoreCase) && !string.Equals(codec, "sub", StringComparison.OrdinalIgnoreCase)); } /// /// Determines whether the specified format is a PGS (Presentation Graphic Stream) subtitle format. /// /// The subtitle format/codec to check. /// true if the format is PGS; otherwise, false. public static bool IsPgsFormat(string format) { string codec = format ?? string.Empty; return codec.Contains("pgs", StringComparison.OrdinalIgnoreCase) || string.Equals(codec, "sup", StringComparison.OrdinalIgnoreCase); } /// /// Determines whether this subtitle stream can be converted to the specified codec. /// /// The target codec to convert to. /// true if the subtitle stream can be converted to the specified codec; otherwise, false. public bool SupportsSubtitleConversionTo(string toCodec) { if (!this.IsTextSubtitleStream) { return false; } var fromCodec = this.Codec; // Can't convert from this if (string.Equals(fromCodec, "ass", StringComparison.OrdinalIgnoreCase)) { return false; } if (string.Equals(fromCodec, "ssa", StringComparison.OrdinalIgnoreCase)) { return false; } // Can't convert to this if (string.Equals(toCodec, "ass", StringComparison.OrdinalIgnoreCase)) { return false; } if (string.Equals(toCodec, "ssa", StringComparison.OrdinalIgnoreCase)) { return false; } return true; } /// /// Gets the video color range information based on codec tags, Dolby Vision properties, and color transfer characteristics. /// /// A tuple containing the video range (SDR/HDR) and the specific video range type. public (VideoRange VideoRange, VideoRangeType VideoRangeType) GetVideoColorRange() { if (this.Type != MediaStreamType.Video) { return (VideoRange.Unknown, VideoRangeType.Unknown); } var codecTag = this.CodecTag; var dvProfile = this.DvProfile; var rpuPresentFlag = this.RpuPresentFlag == 1; var blPresentFlag = this.BlPresentFlag == 1; var dvBlCompatId = this.DvBlSignalCompatibilityId; var isDoViProfile = dvProfile is 5 or 7 or 8 or 10; var isDoViFlag = rpuPresentFlag && blPresentFlag && dvBlCompatId is 0 or 1 or 4 or 2 or 6; if ((isDoViProfile && isDoViFlag) || string.Equals(codecTag, "dovi", StringComparison.OrdinalIgnoreCase) || string.Equals(codecTag, "dvh1", StringComparison.OrdinalIgnoreCase) || string.Equals(codecTag, "dvhe", StringComparison.OrdinalIgnoreCase) || string.Equals(codecTag, "dav1", StringComparison.OrdinalIgnoreCase)) { var dvRangeSet = dvProfile switch { 5 => (VideoRange.HDR, VideoRangeType.DOVI), 8 => dvBlCompatId switch { 1 => (VideoRange.HDR, VideoRangeType.DOVIWithHDR10), 4 => (VideoRange.HDR, VideoRangeType.DOVIWithHLG), 2 => (VideoRange.SDR, VideoRangeType.DOVIWithSDR), // Out of Dolby Spec files should be marked as invalid _ => (VideoRange.HDR, VideoRangeType.DOVIInvalid), }, 7 => (VideoRange.HDR, VideoRangeType.DOVIWithEL), 10 => dvBlCompatId switch { 0 => (VideoRange.HDR, VideoRangeType.DOVI), 1 => (VideoRange.HDR, VideoRangeType.DOVIWithHDR10), 2 => (VideoRange.SDR, VideoRangeType.DOVIWithSDR), 4 => (VideoRange.HDR, VideoRangeType.DOVIWithHLG), // Out of Dolby Spec files should be marked as invalid _ => (VideoRange.HDR, VideoRangeType.DOVIInvalid), }, _ => (VideoRange.SDR, VideoRangeType.SDR), }; if (this.Hdr10PlusPresentFlag == true) { return dvRangeSet.Item2 switch { VideoRangeType.DOVIWithHDR10 => (VideoRange.HDR, VideoRangeType.DOVIWithHDR10Plus), VideoRangeType.DOVIWithEL => (VideoRange.HDR, VideoRangeType.DOVIWithELHDR10Plus), _ => dvRangeSet, }; } return dvRangeSet; } var colorTransfer = this.ColorTransfer; if (string.Equals(colorTransfer, "smpte2084", StringComparison.OrdinalIgnoreCase)) { return this.Hdr10PlusPresentFlag == true ? (VideoRange.HDR, VideoRangeType.HDR10Plus) : (VideoRange.HDR, VideoRangeType.HDR10); } else if (string.Equals(colorTransfer, "arib-std-b67", StringComparison.OrdinalIgnoreCase)) { return (VideoRange.HDR, VideoRangeType.HLG); } return (VideoRange.SDR, VideoRangeType.SDR); } /// /// Gets the resolution text based on width and height. /// /// The resolution text (e.g., "1080p", "4K") or null if width/height are not available. internal string GetResolutionText() { if (!this.Width.HasValue || !this.Height.HasValue) { return null; } return this.Width switch { // 256x144 (16:9 square pixel format) <= 256 when this.Height <= 144 => this.IsInterlaced ? "144i" : "144p", // 426x240 (16:9 square pixel format) <= 426 when this.Height <= 240 => this.IsInterlaced ? "240i" : "240p", // 640x360 (16:9 square pixel format) <= 640 when this.Height <= 360 => this.IsInterlaced ? "360i" : "360p", // 682x384 (16:9 square pixel format) <= 682 when this.Height <= 384 => this.IsInterlaced ? "384i" : "384p", // 720x404 (16:9 square pixel format) <= 720 when this.Height <= 404 => this.IsInterlaced ? "404i" : "404p", // 854x480 (16:9 square pixel format) <= 854 when this.Height <= 480 => this.IsInterlaced ? "480i" : "480p", // 960x544 (16:9 square pixel format) <= 960 when this.Height <= 544 => this.IsInterlaced ? "540i" : "540p", // 1024x576 (16:9 square pixel format) <= 1024 when this.Height <= 576 => this.IsInterlaced ? "576i" : "576p", // 1280x720 <= 1280 when this.Height <= 962 => this.IsInterlaced ? "720i" : "720p", // 2560x1080 (FHD ultra wide 21:9) using 1440px width to accommodate WQHD <= 2560 when this.Height <= 1440 => this.IsInterlaced ? "1080i" : "1080p", // 4K <= 4096 when this.Height <= 3072 => "4K", // 8K <= 8192 when this.Height <= 6144 => "8K", _ => null, }; } }