283 lines
14 KiB
C#
283 lines
14 KiB
C#
#pragma warning disable CS1591
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using MediaBrowser.Model.Dlna;
|
|
using MediaBrowser.Model.Services;
|
|
|
|
namespace MediaBrowser.Controller.MediaEncoding
|
|
{
|
|
public class EncodingJobOptions : BaseEncodingJobOptions
|
|
{
|
|
public string OutputDirectory { get; set; }
|
|
|
|
public string ItemId { get; set; }
|
|
|
|
public string TempDirectory { get; set; }
|
|
|
|
public bool ReadInputAtNativeFramerate { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether this instance has fixed resolution.
|
|
/// </summary>
|
|
/// <value><c>true</c> if this instance has fixed resolution; otherwise, <c>false</c>.</value>
|
|
public bool HasFixedResolution => Width.HasValue || Height.HasValue;
|
|
|
|
public DeviceProfile DeviceProfile { get; set; }
|
|
|
|
public EncodingJobOptions(StreamInfo info, DeviceProfile deviceProfile)
|
|
{
|
|
Container = info.Container;
|
|
StartTimeTicks = info.StartPositionTicks;
|
|
MaxWidth = info.MaxWidth;
|
|
MaxHeight = info.MaxHeight;
|
|
MaxFramerate = info.MaxFramerate;
|
|
Id = info.ItemId;
|
|
MediaSourceId = info.MediaSourceId;
|
|
AudioCodec = info.TargetAudioCodec.FirstOrDefault();
|
|
MaxAudioChannels = info.GlobalMaxAudioChannels;
|
|
AudioBitRate = info.AudioBitrate;
|
|
AudioSampleRate = info.TargetAudioSampleRate;
|
|
DeviceProfile = deviceProfile;
|
|
VideoCodec = info.TargetVideoCodec.FirstOrDefault();
|
|
VideoBitRate = info.VideoBitrate;
|
|
AudioStreamIndex = info.AudioStreamIndex;
|
|
SubtitleMethod = info.SubtitleDeliveryMethod;
|
|
Context = info.Context;
|
|
TranscodingMaxAudioChannels = info.TranscodingMaxAudioChannels;
|
|
|
|
if (info.SubtitleDeliveryMethod != SubtitleDeliveryMethod.External)
|
|
{
|
|
SubtitleStreamIndex = info.SubtitleStreamIndex;
|
|
}
|
|
|
|
StreamOptions = info.StreamOptions;
|
|
}
|
|
}
|
|
|
|
// For now until api and media encoding layers are unified
|
|
public class BaseEncodingJobOptions
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the id.
|
|
/// </summary>
|
|
/// <value>The id.</value>
|
|
[ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
public Guid Id { get; set; }
|
|
|
|
[ApiMember(Name = "MediaSourceId", Description = "The media version id, if playing an alternate version", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
public string MediaSourceId { get; set; }
|
|
|
|
[ApiMember(Name = "DeviceId", Description = "The device id of the client requesting. Used to stop encoding processes when needed.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
public string DeviceId { get; set; }
|
|
|
|
[ApiMember(Name = "Container", Description = "Container", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
public string Container { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the audio codec.
|
|
/// </summary>
|
|
/// <value>The audio codec.</value>
|
|
[ApiMember(Name = "AudioCodec", Description = "Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
public string AudioCodec { get; set; }
|
|
|
|
[ApiMember(Name = "EnableAutoStreamCopy", Description = "Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
public bool EnableAutoStreamCopy { get; set; }
|
|
|
|
public bool AllowVideoStreamCopy { get; set; }
|
|
|
|
public bool AllowAudioStreamCopy { get; set; }
|
|
|
|
public bool BreakOnNonKeyFrames { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the audio sample rate.
|
|
/// </summary>
|
|
/// <value>The audio sample rate.</value>
|
|
[ApiMember(Name = "AudioSampleRate", Description = "Optional. Specify a specific audio sample rate, e.g. 44100", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? AudioSampleRate { get; set; }
|
|
|
|
public int? MaxAudioBitDepth { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the audio bit rate.
|
|
/// </summary>
|
|
/// <value>The audio bit rate.</value>
|
|
[ApiMember(Name = "AudioBitRate", Description = "Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? AudioBitRate { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the audio channels.
|
|
/// </summary>
|
|
/// <value>The audio channels.</value>
|
|
[ApiMember(Name = "AudioChannels", Description = "Optional. Specify a specific number of audio channels to encode to, e.g. 2", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? AudioChannels { get; set; }
|
|
|
|
[ApiMember(Name = "MaxAudioChannels", Description = "Optional. Specify a maximum number of audio channels to encode to, e.g. 2", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? MaxAudioChannels { get; set; }
|
|
|
|
[ApiMember(Name = "Static", Description = "Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
public bool Static { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the profile.
|
|
/// </summary>
|
|
/// <value>The profile.</value>
|
|
[ApiMember(Name = "Profile", Description = "Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
public string Profile { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the level.
|
|
/// </summary>
|
|
/// <value>The level.</value>
|
|
[ApiMember(Name = "Level", Description = "Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
public string Level { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the framerate.
|
|
/// </summary>
|
|
/// <value>The framerate.</value>
|
|
[ApiMember(Name = "Framerate", Description = "Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.", IsRequired = false, DataType = "double", ParameterType = "query", Verb = "GET")]
|
|
public float? Framerate { get; set; }
|
|
|
|
[ApiMember(Name = "MaxFramerate", Description = "Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.", IsRequired = false, DataType = "double", ParameterType = "query", Verb = "GET")]
|
|
public float? MaxFramerate { get; set; }
|
|
|
|
[ApiMember(Name = "CopyTimestamps", Description = "Whether or not to copy timestamps when transcoding with an offset. Defaults to false.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
public bool CopyTimestamps { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the start time ticks.
|
|
/// </summary>
|
|
/// <value>The start time ticks.</value>
|
|
[ApiMember(Name = "StartTimeTicks", Description = "Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public long? StartTimeTicks { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the width.
|
|
/// </summary>
|
|
/// <value>The width.</value>
|
|
[ApiMember(Name = "Width", Description = "Optional. The fixed horizontal resolution of the encoded video.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? Width { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the height.
|
|
/// </summary>
|
|
/// <value>The height.</value>
|
|
[ApiMember(Name = "Height", Description = "Optional. The fixed vertical resolution of the encoded video.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? Height { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the width of the max.
|
|
/// </summary>
|
|
/// <value>The width of the max.</value>
|
|
[ApiMember(Name = "MaxWidth", Description = "Optional. The maximum horizontal resolution of the encoded video.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? MaxWidth { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the height of the max.
|
|
/// </summary>
|
|
/// <value>The height of the max.</value>
|
|
[ApiMember(Name = "MaxHeight", Description = "Optional. The maximum vertical resolution of the encoded video.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? MaxHeight { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the video bit rate.
|
|
/// </summary>
|
|
/// <value>The video bit rate.</value>
|
|
[ApiMember(Name = "VideoBitRate", Description = "Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? VideoBitRate { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the index of the subtitle stream.
|
|
/// </summary>
|
|
/// <value>The index of the subtitle stream.</value>
|
|
[ApiMember(Name = "SubtitleStreamIndex", Description = "Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? SubtitleStreamIndex { get; set; }
|
|
|
|
[ApiMember(Name = "SubtitleMethod", Description = "Optional. Specify the subtitle delivery method.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
public SubtitleDeliveryMethod SubtitleMethod { get; set; }
|
|
|
|
[ApiMember(Name = "MaxRefFrames", Description = "Optional.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? MaxRefFrames { get; set; }
|
|
|
|
[ApiMember(Name = "MaxVideoBitDepth", Description = "Optional.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? MaxVideoBitDepth { get; set; }
|
|
|
|
public bool RequireAvc { get; set; }
|
|
|
|
public bool DeInterlace { get; set; }
|
|
|
|
public bool RequireNonAnamorphic { get; set; }
|
|
|
|
public int? TranscodingMaxAudioChannels { get; set; }
|
|
|
|
public int? CpuCoreLimit { get; set; }
|
|
|
|
public string LiveStreamId { get; set; }
|
|
|
|
public bool EnableMpegtsM2TsMode { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the video codec.
|
|
/// </summary>
|
|
/// <value>The video codec.</value>
|
|
[ApiMember(Name = "VideoCodec", Description = "Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h265, h264, mpeg4, theora, vpx, wmv.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
|
|
public string VideoCodec { get; set; }
|
|
|
|
public string SubtitleCodec { get; set; }
|
|
|
|
public string TranscodeReasons { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the index of the audio stream.
|
|
/// </summary>
|
|
/// <value>The index of the audio stream.</value>
|
|
[ApiMember(Name = "AudioStreamIndex", Description = "Optional. The index of the audio stream to use. If omitted the first audio stream will be used.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? AudioStreamIndex { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the index of the video stream.
|
|
/// </summary>
|
|
/// <value>The index of the video stream.</value>
|
|
[ApiMember(Name = "VideoStreamIndex", Description = "Optional. The index of the video stream to use. If omitted the first video stream will be used.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
|
|
public int? VideoStreamIndex { get; set; }
|
|
|
|
public EncodingContext Context { get; set; }
|
|
|
|
public Dictionary<string, string> StreamOptions { get; set; }
|
|
|
|
public string GetOption(string qualifier, string name)
|
|
{
|
|
var value = GetOption(qualifier + "-" + name);
|
|
|
|
if (string.IsNullOrEmpty(value))
|
|
{
|
|
value = GetOption(name);
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
public string GetOption(string name)
|
|
{
|
|
if (StreamOptions.TryGetValue(name, out var value))
|
|
{
|
|
return value;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
public BaseEncodingJobOptions()
|
|
{
|
|
EnableAutoStreamCopy = true;
|
|
AllowVideoStreamCopy = true;
|
|
AllowAudioStreamCopy = true;
|
|
Context = EncodingContext.Streaming;
|
|
StreamOptions = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
|
|
}
|
|
}
|
|
}
|