DynamicHlsController.cs 114 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103
  1. using System;
  2. using System.Collections.Generic;
  3. using System.ComponentModel.DataAnnotations;
  4. using System.Diagnostics.CodeAnalysis;
  5. using System.Globalization;
  6. using System.IO;
  7. using System.Linq;
  8. using System.Text;
  9. using System.Threading;
  10. using System.Threading.Tasks;
  11. using Jellyfin.Api.Attributes;
  12. using Jellyfin.Api.Extensions;
  13. using Jellyfin.Api.Helpers;
  14. using Jellyfin.Api.Models.StreamingDtos;
  15. using Jellyfin.Data.Enums;
  16. using Jellyfin.Extensions;
  17. using Jellyfin.MediaEncoding.Hls.Playlist;
  18. using MediaBrowser.Common.Configuration;
  19. using MediaBrowser.Controller.Configuration;
  20. using MediaBrowser.Controller.Library;
  21. using MediaBrowser.Controller.MediaEncoding;
  22. using MediaBrowser.Controller.Streaming;
  23. using MediaBrowser.MediaEncoding.Encoder;
  24. using MediaBrowser.Model.Configuration;
  25. using MediaBrowser.Model.Dlna;
  26. using MediaBrowser.Model.Entities;
  27. using MediaBrowser.Model.IO;
  28. using MediaBrowser.Model.Net;
  29. using Microsoft.AspNetCore.Authorization;
  30. using Microsoft.AspNetCore.Http;
  31. using Microsoft.AspNetCore.Mvc;
  32. using Microsoft.Extensions.Logging;
  33. namespace Jellyfin.Api.Controllers;
  34. /// <summary>
  35. /// Dynamic hls controller.
  36. /// </summary>
  37. [Route("")]
  38. [Authorize]
  39. public class DynamicHlsController : BaseJellyfinApiController
  40. {
  41. private const EncoderPreset DefaultVodEncoderPreset = EncoderPreset.veryfast;
  42. private const EncoderPreset DefaultEventEncoderPreset = EncoderPreset.superfast;
  43. private const TranscodingJobType TranscodingJobType = MediaBrowser.Controller.MediaEncoding.TranscodingJobType.Hls;
  44. private readonly Version _minFFmpegFlacInMp4 = new Version(6, 0);
  45. private readonly Version _minFFmpegX265BframeInFmp4 = new Version(7, 0, 1);
  46. private readonly Version _minFFmpegHlsSegmentOptions = new Version(5, 0);
  47. private readonly ILibraryManager _libraryManager;
  48. private readonly IUserManager _userManager;
  49. private readonly IMediaSourceManager _mediaSourceManager;
  50. private readonly IServerConfigurationManager _serverConfigurationManager;
  51. private readonly IMediaEncoder _mediaEncoder;
  52. private readonly IFileSystem _fileSystem;
  53. private readonly ITranscodeManager _transcodeManager;
  54. private readonly ILogger<DynamicHlsController> _logger;
  55. private readonly EncodingHelper _encodingHelper;
  56. private readonly IDynamicHlsPlaylistGenerator _dynamicHlsPlaylistGenerator;
  57. private readonly DynamicHlsHelper _dynamicHlsHelper;
  58. private readonly EncodingOptions _encodingOptions;
  59. /// <summary>
  60. /// Initializes a new instance of the <see cref="DynamicHlsController"/> class.
  61. /// </summary>
  62. /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
  63. /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
  64. /// <param name="mediaSourceManager">Instance of the <see cref="IMediaSourceManager"/> interface.</param>
  65. /// <param name="serverConfigurationManager">Instance of the <see cref="IServerConfigurationManager"/> interface.</param>
  66. /// <param name="mediaEncoder">Instance of the <see cref="IMediaEncoder"/> interface.</param>
  67. /// <param name="fileSystem">Instance of the <see cref="IFileSystem"/> interface.</param>
  68. /// <param name="transcodeManager">Instance of the <see cref="ITranscodeManager"/> interface.</param>
  69. /// <param name="logger">Instance of the <see cref="ILogger{DynamicHlsController}"/> interface.</param>
  70. /// <param name="dynamicHlsHelper">Instance of <see cref="DynamicHlsHelper"/>.</param>
  71. /// <param name="encodingHelper">Instance of <see cref="EncodingHelper"/>.</param>
  72. /// <param name="dynamicHlsPlaylistGenerator">Instance of <see cref="IDynamicHlsPlaylistGenerator"/>.</param>
  73. public DynamicHlsController(
  74. ILibraryManager libraryManager,
  75. IUserManager userManager,
  76. IMediaSourceManager mediaSourceManager,
  77. IServerConfigurationManager serverConfigurationManager,
  78. IMediaEncoder mediaEncoder,
  79. IFileSystem fileSystem,
  80. ITranscodeManager transcodeManager,
  81. ILogger<DynamicHlsController> logger,
  82. DynamicHlsHelper dynamicHlsHelper,
  83. EncodingHelper encodingHelper,
  84. IDynamicHlsPlaylistGenerator dynamicHlsPlaylistGenerator)
  85. {
  86. _libraryManager = libraryManager;
  87. _userManager = userManager;
  88. _mediaSourceManager = mediaSourceManager;
  89. _serverConfigurationManager = serverConfigurationManager;
  90. _mediaEncoder = mediaEncoder;
  91. _fileSystem = fileSystem;
  92. _transcodeManager = transcodeManager;
  93. _logger = logger;
  94. _dynamicHlsHelper = dynamicHlsHelper;
  95. _encodingHelper = encodingHelper;
  96. _dynamicHlsPlaylistGenerator = dynamicHlsPlaylistGenerator;
  97. _encodingOptions = serverConfigurationManager.GetEncodingOptions();
  98. }
  99. /// <summary>
  100. /// Gets a hls live stream.
  101. /// </summary>
  102. /// <param name="itemId">The item id.</param>
  103. /// <param name="container">The audio container.</param>
  104. /// <param name="static">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.</param>
  105. /// <param name="params">The streaming parameters.</param>
  106. /// <param name="tag">The tag.</param>
  107. /// <param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
  108. /// <param name="playSessionId">The play session id.</param>
  109. /// <param name="segmentContainer">The segment container.</param>
  110. /// <param name="segmentLength">The segment length.</param>
  111. /// <param name="minSegments">The minimum number of segments.</param>
  112. /// <param name="mediaSourceId">The media version id, if playing an alternate version.</param>
  113. /// <param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
  114. /// <param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
  115. /// <param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
  116. /// <param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
  117. /// <param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
  118. /// <param name="breakOnNonKeyFrames">Optional. Whether to break on non key frames.</param>
  119. /// <param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
  120. /// <param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
  121. /// <param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
  122. /// <param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
  123. /// <param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
  124. /// <param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
  125. /// <param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
  126. /// <param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  127. /// <param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  128. /// <param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
  129. /// <param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
  130. /// <param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
  131. /// <param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
  132. /// <param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
  133. /// <param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
  134. /// <param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
  135. /// <param name="maxRefFrames">Optional.</param>
  136. /// <param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
  137. /// <param name="requireAvc">Optional. Whether to require avc.</param>
  138. /// <param name="deInterlace">Optional. Whether to deinterlace the video.</param>
  139. /// <param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
  140. /// <param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
  141. /// <param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
  142. /// <param name="liveStreamId">The live stream id.</param>
  143. /// <param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
  144. /// <param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
  145. /// <param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
  146. /// <param name="transcodeReasons">Optional. The transcoding reason.</param>
  147. /// <param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
  148. /// <param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
  149. /// <param name="context">Optional. The <see cref="EncodingContext"/>.</param>
  150. /// <param name="streamOptions">Optional. The streaming options.</param>
  151. /// <param name="maxWidth">Optional. The max width.</param>
  152. /// <param name="maxHeight">Optional. The max height.</param>
  153. /// <param name="enableSubtitlesInManifest">Optional. Whether to enable subtitles in the manifest.</param>
  154. /// <param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
  155. /// <param name="alwaysBurnInSubtitleWhenTranscoding">Whether to always burn in subtitles when transcoding.</param>
  156. /// <response code="200">Hls live stream retrieved.</response>
  157. /// <returns>A <see cref="FileResult"/> containing the hls file.</returns>
  158. [HttpGet("Videos/{itemId}/live.m3u8")]
  159. [ProducesResponseType(StatusCodes.Status200OK)]
  160. [ProducesPlaylistFile]
  161. public async Task<ActionResult> GetLiveHlsStream(
  162. [FromRoute, Required] Guid itemId,
  163. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? container,
  164. [FromQuery] bool? @static,
  165. [FromQuery] string? @params,
  166. [FromQuery] string? tag,
  167. [FromQuery, ParameterObsolete] string? deviceProfileId,
  168. [FromQuery] string? playSessionId,
  169. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? segmentContainer,
  170. [FromQuery] int? segmentLength,
  171. [FromQuery] int? minSegments,
  172. [FromQuery] string? mediaSourceId,
  173. [FromQuery] string? deviceId,
  174. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? audioCodec,
  175. [FromQuery] bool? enableAutoStreamCopy,
  176. [FromQuery] bool? allowVideoStreamCopy,
  177. [FromQuery] bool? allowAudioStreamCopy,
  178. [FromQuery] bool? breakOnNonKeyFrames,
  179. [FromQuery] int? audioSampleRate,
  180. [FromQuery] int? maxAudioBitDepth,
  181. [FromQuery] int? audioBitRate,
  182. [FromQuery] int? audioChannels,
  183. [FromQuery] int? maxAudioChannels,
  184. [FromQuery] string? profile,
  185. [FromQuery] [RegularExpression(EncodingHelper.LevelValidationRegex)] string? level,
  186. [FromQuery] float? framerate,
  187. [FromQuery] float? maxFramerate,
  188. [FromQuery] bool? copyTimestamps,
  189. [FromQuery] long? startTimeTicks,
  190. [FromQuery] int? width,
  191. [FromQuery] int? height,
  192. [FromQuery] int? videoBitRate,
  193. [FromQuery] int? subtitleStreamIndex,
  194. [FromQuery] SubtitleDeliveryMethod? subtitleMethod,
  195. [FromQuery] int? maxRefFrames,
  196. [FromQuery] int? maxVideoBitDepth,
  197. [FromQuery] bool? requireAvc,
  198. [FromQuery] bool? deInterlace,
  199. [FromQuery] bool? requireNonAnamorphic,
  200. [FromQuery] int? transcodingMaxAudioChannels,
  201. [FromQuery] int? cpuCoreLimit,
  202. [FromQuery] string? liveStreamId,
  203. [FromQuery] bool? enableMpegtsM2TsMode,
  204. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? videoCodec,
  205. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? subtitleCodec,
  206. [FromQuery] string? transcodeReasons,
  207. [FromQuery] int? audioStreamIndex,
  208. [FromQuery] int? videoStreamIndex,
  209. [FromQuery] EncodingContext? context,
  210. [FromQuery] Dictionary<string, string> streamOptions,
  211. [FromQuery] int? maxWidth,
  212. [FromQuery] int? maxHeight,
  213. [FromQuery] bool? enableSubtitlesInManifest,
  214. [FromQuery] bool enableAudioVbrEncoding = true,
  215. [FromQuery] bool alwaysBurnInSubtitleWhenTranscoding = false)
  216. {
  217. VideoRequestDto streamingRequest = new VideoRequestDto
  218. {
  219. Id = itemId,
  220. Container = container,
  221. Static = @static ?? false,
  222. Params = @params,
  223. Tag = tag,
  224. PlaySessionId = playSessionId,
  225. SegmentContainer = segmentContainer,
  226. SegmentLength = segmentLength,
  227. MinSegments = minSegments,
  228. MediaSourceId = mediaSourceId,
  229. DeviceId = deviceId,
  230. AudioCodec = audioCodec,
  231. EnableAutoStreamCopy = enableAutoStreamCopy ?? true,
  232. AllowAudioStreamCopy = allowAudioStreamCopy ?? true,
  233. AllowVideoStreamCopy = allowVideoStreamCopy ?? true,
  234. BreakOnNonKeyFrames = breakOnNonKeyFrames ?? false,
  235. AudioSampleRate = audioSampleRate,
  236. MaxAudioChannels = maxAudioChannels,
  237. AudioBitRate = audioBitRate,
  238. MaxAudioBitDepth = maxAudioBitDepth,
  239. AudioChannels = audioChannels,
  240. Profile = profile,
  241. Level = level,
  242. Framerate = framerate,
  243. MaxFramerate = maxFramerate,
  244. CopyTimestamps = copyTimestamps ?? false,
  245. StartTimeTicks = startTimeTicks,
  246. Width = width,
  247. Height = height,
  248. VideoBitRate = videoBitRate,
  249. SubtitleStreamIndex = subtitleStreamIndex,
  250. SubtitleMethod = subtitleMethod ?? SubtitleDeliveryMethod.External,
  251. MaxRefFrames = maxRefFrames,
  252. MaxVideoBitDepth = maxVideoBitDepth,
  253. RequireAvc = requireAvc ?? false,
  254. DeInterlace = deInterlace ?? false,
  255. RequireNonAnamorphic = requireNonAnamorphic ?? false,
  256. TranscodingMaxAudioChannels = transcodingMaxAudioChannels,
  257. CpuCoreLimit = cpuCoreLimit,
  258. LiveStreamId = liveStreamId,
  259. EnableMpegtsM2TsMode = enableMpegtsM2TsMode ?? false,
  260. VideoCodec = videoCodec,
  261. SubtitleCodec = subtitleCodec,
  262. TranscodeReasons = transcodeReasons,
  263. AudioStreamIndex = audioStreamIndex,
  264. VideoStreamIndex = videoStreamIndex,
  265. Context = context ?? EncodingContext.Streaming,
  266. StreamOptions = streamOptions,
  267. MaxHeight = maxHeight,
  268. MaxWidth = maxWidth,
  269. EnableSubtitlesInManifest = enableSubtitlesInManifest ?? true,
  270. EnableAudioVbrEncoding = enableAudioVbrEncoding,
  271. AlwaysBurnInSubtitleWhenTranscoding = alwaysBurnInSubtitleWhenTranscoding
  272. };
  273. // CTS lifecycle is managed internally.
  274. var cancellationTokenSource = new CancellationTokenSource();
  275. // Due to CTS.Token calling ThrowIfDisposed (https://github.com/dotnet/runtime/issues/29970) we have to "cache" the token
  276. // since it gets disposed when ffmpeg exits
  277. var cancellationToken = cancellationTokenSource.Token;
  278. var state = await StreamingHelpers.GetStreamingState(
  279. streamingRequest,
  280. HttpContext,
  281. _mediaSourceManager,
  282. _userManager,
  283. _libraryManager,
  284. _serverConfigurationManager,
  285. _mediaEncoder,
  286. _encodingHelper,
  287. _transcodeManager,
  288. TranscodingJobType,
  289. cancellationToken)
  290. .ConfigureAwait(false);
  291. TranscodingJob? job = null;
  292. var playlistPath = Path.ChangeExtension(state.OutputFilePath, ".m3u8");
  293. if (!System.IO.File.Exists(playlistPath))
  294. {
  295. using (await _transcodeManager.LockAsync(playlistPath, cancellationToken).ConfigureAwait(false))
  296. {
  297. if (!System.IO.File.Exists(playlistPath))
  298. {
  299. // If the playlist doesn't already exist, startup ffmpeg
  300. try
  301. {
  302. job = await _transcodeManager.StartFfMpeg(
  303. state,
  304. playlistPath,
  305. GetCommandLineArguments(playlistPath, state, true, 0),
  306. Request.HttpContext.User.GetUserId(),
  307. TranscodingJobType,
  308. cancellationTokenSource)
  309. .ConfigureAwait(false);
  310. job.IsLiveOutput = true;
  311. }
  312. catch
  313. {
  314. state.Dispose();
  315. throw;
  316. }
  317. minSegments = state.MinSegments;
  318. if (minSegments > 0)
  319. {
  320. await HlsHelpers.WaitForMinimumSegmentCount(playlistPath, minSegments, _logger, cancellationToken).ConfigureAwait(false);
  321. }
  322. }
  323. }
  324. }
  325. job ??= _transcodeManager.OnTranscodeBeginRequest(playlistPath, TranscodingJobType);
  326. if (job is not null)
  327. {
  328. _transcodeManager.OnTranscodeEndRequest(job);
  329. }
  330. var playlistText = HlsHelpers.GetLivePlaylistText(playlistPath, state);
  331. return Content(playlistText, MimeTypes.GetMimeType("playlist.m3u8"));
  332. }
  333. /// <summary>
  334. /// Gets a video hls playlist stream.
  335. /// </summary>
  336. /// <param name="itemId">The item id.</param>
  337. /// <param name="static">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.</param>
  338. /// <param name="params">The streaming parameters.</param>
  339. /// <param name="tag">The tag.</param>
  340. /// <param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
  341. /// <param name="playSessionId">The play session id.</param>
  342. /// <param name="segmentContainer">The segment container.</param>
  343. /// <param name="segmentLength">The segment length.</param>
  344. /// <param name="minSegments">The minimum number of segments.</param>
  345. /// <param name="mediaSourceId">The media version id, if playing an alternate version.</param>
  346. /// <param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
  347. /// <param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
  348. /// <param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
  349. /// <param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
  350. /// <param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
  351. /// <param name="breakOnNonKeyFrames">Optional. Whether to break on non key frames.</param>
  352. /// <param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
  353. /// <param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
  354. /// <param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
  355. /// <param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
  356. /// <param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
  357. /// <param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
  358. /// <param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
  359. /// <param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  360. /// <param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  361. /// <param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
  362. /// <param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
  363. /// <param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
  364. /// <param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
  365. /// <param name="maxWidth">Optional. The maximum horizontal resolution of the encoded video.</param>
  366. /// <param name="maxHeight">Optional. The maximum vertical resolution of the encoded video.</param>
  367. /// <param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
  368. /// <param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
  369. /// <param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
  370. /// <param name="maxRefFrames">Optional.</param>
  371. /// <param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
  372. /// <param name="requireAvc">Optional. Whether to require avc.</param>
  373. /// <param name="deInterlace">Optional. Whether to deinterlace the video.</param>
  374. /// <param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
  375. /// <param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
  376. /// <param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
  377. /// <param name="liveStreamId">The live stream id.</param>
  378. /// <param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
  379. /// <param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
  380. /// <param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
  381. /// <param name="transcodeReasons">Optional. The transcoding reason.</param>
  382. /// <param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
  383. /// <param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
  384. /// <param name="context">Optional. The <see cref="EncodingContext"/>.</param>
  385. /// <param name="streamOptions">Optional. The streaming options.</param>
  386. /// <param name="enableAdaptiveBitrateStreaming">Enable adaptive bitrate streaming.</param>
  387. /// <param name="enableTrickplay">Enable trickplay image playlists being added to master playlist.</param>
  388. /// <param name="enableAudioVbrEncoding">Whether to enable Audio Encoding.</param>
  389. /// <param name="alwaysBurnInSubtitleWhenTranscoding">Whether to always burn in subtitles when transcoding.</param>
  390. /// <response code="200">Video stream returned.</response>
  391. /// <returns>A <see cref="FileResult"/> containing the playlist file.</returns>
  392. [HttpGet("Videos/{itemId}/master.m3u8")]
  393. [HttpHead("Videos/{itemId}/master.m3u8", Name = "HeadMasterHlsVideoPlaylist")]
  394. [ProducesResponseType(StatusCodes.Status200OK)]
  395. [ProducesPlaylistFile]
  396. public async Task<ActionResult> GetMasterHlsVideoPlaylist(
  397. [FromRoute, Required] Guid itemId,
  398. [FromQuery] bool? @static,
  399. [FromQuery] string? @params,
  400. [FromQuery] string? tag,
  401. [FromQuery, ParameterObsolete] string? deviceProfileId,
  402. [FromQuery] string? playSessionId,
  403. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? segmentContainer,
  404. [FromQuery] int? segmentLength,
  405. [FromQuery] int? minSegments,
  406. [FromQuery, Required] string mediaSourceId,
  407. [FromQuery] string? deviceId,
  408. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? audioCodec,
  409. [FromQuery] bool? enableAutoStreamCopy,
  410. [FromQuery] bool? allowVideoStreamCopy,
  411. [FromQuery] bool? allowAudioStreamCopy,
  412. [FromQuery] bool? breakOnNonKeyFrames,
  413. [FromQuery] int? audioSampleRate,
  414. [FromQuery] int? maxAudioBitDepth,
  415. [FromQuery] int? audioBitRate,
  416. [FromQuery] int? audioChannels,
  417. [FromQuery] int? maxAudioChannels,
  418. [FromQuery] string? profile,
  419. [FromQuery] [RegularExpression(EncodingHelper.LevelValidationRegex)] string? level,
  420. [FromQuery] float? framerate,
  421. [FromQuery] float? maxFramerate,
  422. [FromQuery] bool? copyTimestamps,
  423. [FromQuery] long? startTimeTicks,
  424. [FromQuery] int? width,
  425. [FromQuery] int? height,
  426. [FromQuery] int? maxWidth,
  427. [FromQuery] int? maxHeight,
  428. [FromQuery] int? videoBitRate,
  429. [FromQuery] int? subtitleStreamIndex,
  430. [FromQuery] SubtitleDeliveryMethod? subtitleMethod,
  431. [FromQuery] int? maxRefFrames,
  432. [FromQuery] int? maxVideoBitDepth,
  433. [FromQuery] bool? requireAvc,
  434. [FromQuery] bool? deInterlace,
  435. [FromQuery] bool? requireNonAnamorphic,
  436. [FromQuery] int? transcodingMaxAudioChannels,
  437. [FromQuery] int? cpuCoreLimit,
  438. [FromQuery] string? liveStreamId,
  439. [FromQuery] bool? enableMpegtsM2TsMode,
  440. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? videoCodec,
  441. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? subtitleCodec,
  442. [FromQuery] string? transcodeReasons,
  443. [FromQuery] int? audioStreamIndex,
  444. [FromQuery] int? videoStreamIndex,
  445. [FromQuery] EncodingContext? context,
  446. [FromQuery] Dictionary<string, string> streamOptions,
  447. [FromQuery] bool enableAdaptiveBitrateStreaming = false,
  448. [FromQuery] bool enableTrickplay = true,
  449. [FromQuery] bool enableAudioVbrEncoding = true,
  450. [FromQuery] bool alwaysBurnInSubtitleWhenTranscoding = false)
  451. {
  452. var streamingRequest = new HlsVideoRequestDto
  453. {
  454. Id = itemId,
  455. Static = @static ?? false,
  456. Params = @params,
  457. Tag = tag,
  458. PlaySessionId = playSessionId,
  459. SegmentContainer = segmentContainer,
  460. SegmentLength = segmentLength,
  461. MinSegments = minSegments,
  462. MediaSourceId = mediaSourceId,
  463. DeviceId = deviceId,
  464. AudioCodec = audioCodec,
  465. EnableAutoStreamCopy = enableAutoStreamCopy ?? true,
  466. AllowAudioStreamCopy = allowAudioStreamCopy ?? true,
  467. AllowVideoStreamCopy = allowVideoStreamCopy ?? true,
  468. BreakOnNonKeyFrames = breakOnNonKeyFrames ?? false,
  469. AudioSampleRate = audioSampleRate,
  470. MaxAudioChannels = maxAudioChannels,
  471. AudioBitRate = audioBitRate,
  472. MaxAudioBitDepth = maxAudioBitDepth,
  473. AudioChannels = audioChannels,
  474. Profile = profile,
  475. Level = level,
  476. Framerate = framerate,
  477. MaxFramerate = maxFramerate,
  478. CopyTimestamps = copyTimestamps ?? false,
  479. StartTimeTicks = startTimeTicks,
  480. Width = width,
  481. Height = height,
  482. MaxWidth = maxWidth,
  483. MaxHeight = maxHeight,
  484. VideoBitRate = videoBitRate,
  485. SubtitleStreamIndex = subtitleStreamIndex,
  486. SubtitleMethod = subtitleMethod ?? SubtitleDeliveryMethod.External,
  487. MaxRefFrames = maxRefFrames,
  488. MaxVideoBitDepth = maxVideoBitDepth,
  489. RequireAvc = requireAvc ?? false,
  490. DeInterlace = deInterlace ?? false,
  491. RequireNonAnamorphic = requireNonAnamorphic ?? false,
  492. TranscodingMaxAudioChannels = transcodingMaxAudioChannels,
  493. CpuCoreLimit = cpuCoreLimit,
  494. LiveStreamId = liveStreamId,
  495. EnableMpegtsM2TsMode = enableMpegtsM2TsMode ?? false,
  496. VideoCodec = videoCodec,
  497. SubtitleCodec = subtitleCodec,
  498. TranscodeReasons = transcodeReasons,
  499. AudioStreamIndex = audioStreamIndex,
  500. VideoStreamIndex = videoStreamIndex,
  501. Context = context ?? EncodingContext.Streaming,
  502. StreamOptions = streamOptions,
  503. EnableAdaptiveBitrateStreaming = enableAdaptiveBitrateStreaming,
  504. EnableTrickplay = enableTrickplay,
  505. EnableAudioVbrEncoding = enableAudioVbrEncoding,
  506. AlwaysBurnInSubtitleWhenTranscoding = alwaysBurnInSubtitleWhenTranscoding
  507. };
  508. return await _dynamicHlsHelper.GetMasterHlsPlaylist(TranscodingJobType, streamingRequest, enableAdaptiveBitrateStreaming).ConfigureAwait(false);
  509. }
  510. /// <summary>
  511. /// Gets an audio hls playlist stream.
  512. /// </summary>
  513. /// <param name="itemId">The item id.</param>
  514. /// <param name="static">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.</param>
  515. /// <param name="params">The streaming parameters.</param>
  516. /// <param name="tag">The tag.</param>
  517. /// <param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
  518. /// <param name="playSessionId">The play session id.</param>
  519. /// <param name="segmentContainer">The segment container.</param>
  520. /// <param name="segmentLength">The segment length.</param>
  521. /// <param name="minSegments">The minimum number of segments.</param>
  522. /// <param name="mediaSourceId">The media version id, if playing an alternate version.</param>
  523. /// <param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
  524. /// <param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
  525. /// <param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
  526. /// <param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
  527. /// <param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
  528. /// <param name="breakOnNonKeyFrames">Optional. Whether to break on non key frames.</param>
  529. /// <param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
  530. /// <param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
  531. /// <param name="maxStreamingBitrate">Optional. The maximum streaming bitrate.</param>
  532. /// <param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
  533. /// <param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
  534. /// <param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
  535. /// <param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
  536. /// <param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
  537. /// <param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  538. /// <param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  539. /// <param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
  540. /// <param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
  541. /// <param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
  542. /// <param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
  543. /// <param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
  544. /// <param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
  545. /// <param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
  546. /// <param name="maxRefFrames">Optional.</param>
  547. /// <param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
  548. /// <param name="requireAvc">Optional. Whether to require avc.</param>
  549. /// <param name="deInterlace">Optional. Whether to deinterlace the video.</param>
  550. /// <param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
  551. /// <param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
  552. /// <param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
  553. /// <param name="liveStreamId">The live stream id.</param>
  554. /// <param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
  555. /// <param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
  556. /// <param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
  557. /// <param name="transcodeReasons">Optional. The transcoding reason.</param>
  558. /// <param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
  559. /// <param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
  560. /// <param name="context">Optional. The <see cref="EncodingContext"/>.</param>
  561. /// <param name="streamOptions">Optional. The streaming options.</param>
  562. /// <param name="enableAdaptiveBitrateStreaming">Enable adaptive bitrate streaming.</param>
  563. /// <param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
  564. /// <response code="200">Audio stream returned.</response>
  565. /// <returns>A <see cref="FileResult"/> containing the playlist file.</returns>
  566. [HttpGet("Audio/{itemId}/master.m3u8")]
  567. [HttpHead("Audio/{itemId}/master.m3u8", Name = "HeadMasterHlsAudioPlaylist")]
  568. [ProducesResponseType(StatusCodes.Status200OK)]
  569. [ProducesPlaylistFile]
  570. public async Task<ActionResult> GetMasterHlsAudioPlaylist(
  571. [FromRoute, Required] Guid itemId,
  572. [FromQuery] bool? @static,
  573. [FromQuery] string? @params,
  574. [FromQuery] string? tag,
  575. [FromQuery, ParameterObsolete] string? deviceProfileId,
  576. [FromQuery] string? playSessionId,
  577. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? segmentContainer,
  578. [FromQuery] int? segmentLength,
  579. [FromQuery] int? minSegments,
  580. [FromQuery, Required] string mediaSourceId,
  581. [FromQuery] string? deviceId,
  582. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? audioCodec,
  583. [FromQuery] bool? enableAutoStreamCopy,
  584. [FromQuery] bool? allowVideoStreamCopy,
  585. [FromQuery] bool? allowAudioStreamCopy,
  586. [FromQuery] bool? breakOnNonKeyFrames,
  587. [FromQuery] int? audioSampleRate,
  588. [FromQuery] int? maxAudioBitDepth,
  589. [FromQuery] int? maxStreamingBitrate,
  590. [FromQuery] int? audioBitRate,
  591. [FromQuery] int? audioChannels,
  592. [FromQuery] int? maxAudioChannels,
  593. [FromQuery] string? profile,
  594. [FromQuery] [RegularExpression(EncodingHelper.LevelValidationRegex)] string? level,
  595. [FromQuery] float? framerate,
  596. [FromQuery] float? maxFramerate,
  597. [FromQuery] bool? copyTimestamps,
  598. [FromQuery] long? startTimeTicks,
  599. [FromQuery] int? width,
  600. [FromQuery] int? height,
  601. [FromQuery] int? videoBitRate,
  602. [FromQuery] int? subtitleStreamIndex,
  603. [FromQuery] SubtitleDeliveryMethod? subtitleMethod,
  604. [FromQuery] int? maxRefFrames,
  605. [FromQuery] int? maxVideoBitDepth,
  606. [FromQuery] bool? requireAvc,
  607. [FromQuery] bool? deInterlace,
  608. [FromQuery] bool? requireNonAnamorphic,
  609. [FromQuery] int? transcodingMaxAudioChannels,
  610. [FromQuery] int? cpuCoreLimit,
  611. [FromQuery] string? liveStreamId,
  612. [FromQuery] bool? enableMpegtsM2TsMode,
  613. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? videoCodec,
  614. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? subtitleCodec,
  615. [FromQuery] string? transcodeReasons,
  616. [FromQuery] int? audioStreamIndex,
  617. [FromQuery] int? videoStreamIndex,
  618. [FromQuery] EncodingContext? context,
  619. [FromQuery] Dictionary<string, string> streamOptions,
  620. [FromQuery] bool enableAdaptiveBitrateStreaming = false,
  621. [FromQuery] bool enableAudioVbrEncoding = true)
  622. {
  623. var streamingRequest = new HlsAudioRequestDto
  624. {
  625. Id = itemId,
  626. Static = @static ?? false,
  627. Params = @params,
  628. Tag = tag,
  629. PlaySessionId = playSessionId,
  630. SegmentContainer = segmentContainer,
  631. SegmentLength = segmentLength,
  632. MinSegments = minSegments,
  633. MediaSourceId = mediaSourceId,
  634. DeviceId = deviceId,
  635. AudioCodec = audioCodec,
  636. EnableAutoStreamCopy = enableAutoStreamCopy ?? true,
  637. AllowAudioStreamCopy = allowAudioStreamCopy ?? true,
  638. AllowVideoStreamCopy = allowVideoStreamCopy ?? true,
  639. BreakOnNonKeyFrames = breakOnNonKeyFrames ?? false,
  640. AudioSampleRate = audioSampleRate,
  641. MaxAudioChannels = maxAudioChannels,
  642. AudioBitRate = audioBitRate ?? maxStreamingBitrate,
  643. MaxAudioBitDepth = maxAudioBitDepth,
  644. AudioChannels = audioChannels,
  645. Profile = profile,
  646. Level = level,
  647. Framerate = framerate,
  648. MaxFramerate = maxFramerate,
  649. CopyTimestamps = copyTimestamps ?? false,
  650. StartTimeTicks = startTimeTicks,
  651. Width = width,
  652. Height = height,
  653. VideoBitRate = videoBitRate,
  654. SubtitleStreamIndex = subtitleStreamIndex,
  655. SubtitleMethod = subtitleMethod ?? SubtitleDeliveryMethod.External,
  656. MaxRefFrames = maxRefFrames,
  657. MaxVideoBitDepth = maxVideoBitDepth,
  658. RequireAvc = requireAvc ?? false,
  659. DeInterlace = deInterlace ?? false,
  660. RequireNonAnamorphic = requireNonAnamorphic ?? false,
  661. TranscodingMaxAudioChannels = transcodingMaxAudioChannels,
  662. CpuCoreLimit = cpuCoreLimit,
  663. LiveStreamId = liveStreamId,
  664. EnableMpegtsM2TsMode = enableMpegtsM2TsMode ?? false,
  665. VideoCodec = videoCodec,
  666. SubtitleCodec = subtitleCodec,
  667. TranscodeReasons = transcodeReasons,
  668. AudioStreamIndex = audioStreamIndex,
  669. VideoStreamIndex = videoStreamIndex,
  670. Context = context ?? EncodingContext.Streaming,
  671. StreamOptions = streamOptions,
  672. EnableAdaptiveBitrateStreaming = enableAdaptiveBitrateStreaming,
  673. EnableAudioVbrEncoding = enableAudioVbrEncoding,
  674. AlwaysBurnInSubtitleWhenTranscoding = false
  675. };
  676. return await _dynamicHlsHelper.GetMasterHlsPlaylist(TranscodingJobType, streamingRequest, enableAdaptiveBitrateStreaming).ConfigureAwait(false);
  677. }
  678. /// <summary>
  679. /// Gets a video stream using HTTP live streaming.
  680. /// </summary>
  681. /// <param name="itemId">The item id.</param>
  682. /// <param name="static">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.</param>
  683. /// <param name="params">The streaming parameters.</param>
  684. /// <param name="tag">The tag.</param>
  685. /// <param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
  686. /// <param name="playSessionId">The play session id.</param>
  687. /// <param name="segmentContainer">The segment container.</param>
  688. /// <param name="segmentLength">The segment length.</param>
  689. /// <param name="minSegments">The minimum number of segments.</param>
  690. /// <param name="mediaSourceId">The media version id, if playing an alternate version.</param>
  691. /// <param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
  692. /// <param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
  693. /// <param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
  694. /// <param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
  695. /// <param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
  696. /// <param name="breakOnNonKeyFrames">Optional. Whether to break on non key frames.</param>
  697. /// <param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
  698. /// <param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
  699. /// <param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
  700. /// <param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
  701. /// <param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
  702. /// <param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
  703. /// <param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
  704. /// <param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  705. /// <param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  706. /// <param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
  707. /// <param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
  708. /// <param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
  709. /// <param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
  710. /// <param name="maxWidth">Optional. The maximum horizontal resolution of the encoded video.</param>
  711. /// <param name="maxHeight">Optional. The maximum vertical resolution of the encoded video.</param>
  712. /// <param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
  713. /// <param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
  714. /// <param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
  715. /// <param name="maxRefFrames">Optional.</param>
  716. /// <param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
  717. /// <param name="requireAvc">Optional. Whether to require avc.</param>
  718. /// <param name="deInterlace">Optional. Whether to deinterlace the video.</param>
  719. /// <param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
  720. /// <param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
  721. /// <param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
  722. /// <param name="liveStreamId">The live stream id.</param>
  723. /// <param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
  724. /// <param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
  725. /// <param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
  726. /// <param name="transcodeReasons">Optional. The transcoding reason.</param>
  727. /// <param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
  728. /// <param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
  729. /// <param name="context">Optional. The <see cref="EncodingContext"/>.</param>
  730. /// <param name="streamOptions">Optional. The streaming options.</param>
  731. /// <param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
  732. /// <param name="alwaysBurnInSubtitleWhenTranscoding">Whether to always burn in subtitles when transcoding.</param>
  733. /// <response code="200">Video stream returned.</response>
  734. /// <returns>A <see cref="FileResult"/> containing the audio file.</returns>
  735. [HttpGet("Videos/{itemId}/main.m3u8")]
  736. [ProducesResponseType(StatusCodes.Status200OK)]
  737. [ProducesPlaylistFile]
  738. public async Task<ActionResult> GetVariantHlsVideoPlaylist(
  739. [FromRoute, Required] Guid itemId,
  740. [FromQuery] bool? @static,
  741. [FromQuery] string? @params,
  742. [FromQuery] string? tag,
  743. [FromQuery, ParameterObsolete] string? deviceProfileId,
  744. [FromQuery] string? playSessionId,
  745. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? segmentContainer,
  746. [FromQuery] int? segmentLength,
  747. [FromQuery] int? minSegments,
  748. [FromQuery] string? mediaSourceId,
  749. [FromQuery] string? deviceId,
  750. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? audioCodec,
  751. [FromQuery] bool? enableAutoStreamCopy,
  752. [FromQuery] bool? allowVideoStreamCopy,
  753. [FromQuery] bool? allowAudioStreamCopy,
  754. [FromQuery] bool? breakOnNonKeyFrames,
  755. [FromQuery] int? audioSampleRate,
  756. [FromQuery] int? maxAudioBitDepth,
  757. [FromQuery] int? audioBitRate,
  758. [FromQuery] int? audioChannels,
  759. [FromQuery] int? maxAudioChannels,
  760. [FromQuery] string? profile,
  761. [FromQuery] [RegularExpression(EncodingHelper.LevelValidationRegex)] string? level,
  762. [FromQuery] float? framerate,
  763. [FromQuery] float? maxFramerate,
  764. [FromQuery] bool? copyTimestamps,
  765. [FromQuery] long? startTimeTicks,
  766. [FromQuery] int? width,
  767. [FromQuery] int? height,
  768. [FromQuery] int? maxWidth,
  769. [FromQuery] int? maxHeight,
  770. [FromQuery] int? videoBitRate,
  771. [FromQuery] int? subtitleStreamIndex,
  772. [FromQuery] SubtitleDeliveryMethod? subtitleMethod,
  773. [FromQuery] int? maxRefFrames,
  774. [FromQuery] int? maxVideoBitDepth,
  775. [FromQuery] bool? requireAvc,
  776. [FromQuery] bool? deInterlace,
  777. [FromQuery] bool? requireNonAnamorphic,
  778. [FromQuery] int? transcodingMaxAudioChannels,
  779. [FromQuery] int? cpuCoreLimit,
  780. [FromQuery] string? liveStreamId,
  781. [FromQuery] bool? enableMpegtsM2TsMode,
  782. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? videoCodec,
  783. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? subtitleCodec,
  784. [FromQuery] string? transcodeReasons,
  785. [FromQuery] int? audioStreamIndex,
  786. [FromQuery] int? videoStreamIndex,
  787. [FromQuery] EncodingContext? context,
  788. [FromQuery] Dictionary<string, string> streamOptions,
  789. [FromQuery] bool enableAudioVbrEncoding = true,
  790. [FromQuery] bool alwaysBurnInSubtitleWhenTranscoding = false)
  791. {
  792. using var cancellationTokenSource = new CancellationTokenSource();
  793. var streamingRequest = new VideoRequestDto
  794. {
  795. Id = itemId,
  796. Static = @static ?? false,
  797. Params = @params,
  798. Tag = tag,
  799. PlaySessionId = playSessionId,
  800. SegmentContainer = segmentContainer,
  801. SegmentLength = segmentLength,
  802. MinSegments = minSegments,
  803. MediaSourceId = mediaSourceId,
  804. DeviceId = deviceId,
  805. AudioCodec = audioCodec,
  806. EnableAutoStreamCopy = enableAutoStreamCopy ?? true,
  807. AllowAudioStreamCopy = allowAudioStreamCopy ?? true,
  808. AllowVideoStreamCopy = allowVideoStreamCopy ?? true,
  809. BreakOnNonKeyFrames = breakOnNonKeyFrames ?? false,
  810. AudioSampleRate = audioSampleRate,
  811. MaxAudioChannels = maxAudioChannels,
  812. AudioBitRate = audioBitRate,
  813. MaxAudioBitDepth = maxAudioBitDepth,
  814. AudioChannels = audioChannels,
  815. Profile = profile,
  816. Level = level,
  817. Framerate = framerate,
  818. MaxFramerate = maxFramerate,
  819. CopyTimestamps = copyTimestamps ?? false,
  820. StartTimeTicks = startTimeTicks,
  821. Width = width,
  822. Height = height,
  823. MaxWidth = maxWidth,
  824. MaxHeight = maxHeight,
  825. VideoBitRate = videoBitRate,
  826. SubtitleStreamIndex = subtitleStreamIndex,
  827. SubtitleMethod = subtitleMethod ?? SubtitleDeliveryMethod.External,
  828. MaxRefFrames = maxRefFrames,
  829. MaxVideoBitDepth = maxVideoBitDepth,
  830. RequireAvc = requireAvc ?? false,
  831. DeInterlace = deInterlace ?? false,
  832. RequireNonAnamorphic = requireNonAnamorphic ?? false,
  833. TranscodingMaxAudioChannels = transcodingMaxAudioChannels,
  834. CpuCoreLimit = cpuCoreLimit,
  835. LiveStreamId = liveStreamId,
  836. EnableMpegtsM2TsMode = enableMpegtsM2TsMode ?? false,
  837. VideoCodec = videoCodec,
  838. SubtitleCodec = subtitleCodec,
  839. TranscodeReasons = transcodeReasons,
  840. AudioStreamIndex = audioStreamIndex,
  841. VideoStreamIndex = videoStreamIndex,
  842. Context = context ?? EncodingContext.Streaming,
  843. StreamOptions = streamOptions,
  844. EnableAudioVbrEncoding = enableAudioVbrEncoding,
  845. AlwaysBurnInSubtitleWhenTranscoding = alwaysBurnInSubtitleWhenTranscoding
  846. };
  847. return await GetVariantPlaylistInternal(streamingRequest, cancellationTokenSource)
  848. .ConfigureAwait(false);
  849. }
  850. /// <summary>
  851. /// Gets an audio stream using HTTP live streaming.
  852. /// </summary>
  853. /// <param name="itemId">The item id.</param>
  854. /// <param name="static">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.</param>
  855. /// <param name="params">The streaming parameters.</param>
  856. /// <param name="tag">The tag.</param>
  857. /// <param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
  858. /// <param name="playSessionId">The play session id.</param>
  859. /// <param name="segmentContainer">The segment container.</param>
  860. /// <param name="segmentLength">The segment length.</param>
  861. /// <param name="minSegments">The minimum number of segments.</param>
  862. /// <param name="mediaSourceId">The media version id, if playing an alternate version.</param>
  863. /// <param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
  864. /// <param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
  865. /// <param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
  866. /// <param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
  867. /// <param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
  868. /// <param name="breakOnNonKeyFrames">Optional. Whether to break on non key frames.</param>
  869. /// <param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
  870. /// <param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
  871. /// <param name="maxStreamingBitrate">Optional. The maximum streaming bitrate.</param>
  872. /// <param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
  873. /// <param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
  874. /// <param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
  875. /// <param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
  876. /// <param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
  877. /// <param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  878. /// <param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  879. /// <param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
  880. /// <param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
  881. /// <param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
  882. /// <param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
  883. /// <param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
  884. /// <param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
  885. /// <param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
  886. /// <param name="maxRefFrames">Optional.</param>
  887. /// <param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
  888. /// <param name="requireAvc">Optional. Whether to require avc.</param>
  889. /// <param name="deInterlace">Optional. Whether to deinterlace the video.</param>
  890. /// <param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
  891. /// <param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
  892. /// <param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
  893. /// <param name="liveStreamId">The live stream id.</param>
  894. /// <param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
  895. /// <param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
  896. /// <param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
  897. /// <param name="transcodeReasons">Optional. The transcoding reason.</param>
  898. /// <param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
  899. /// <param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
  900. /// <param name="context">Optional. The <see cref="EncodingContext"/>.</param>
  901. /// <param name="streamOptions">Optional. The streaming options.</param>
  902. /// <param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
  903. /// <response code="200">Audio stream returned.</response>
  904. /// <returns>A <see cref="FileResult"/> containing the audio file.</returns>
  905. [HttpGet("Audio/{itemId}/main.m3u8")]
  906. [ProducesResponseType(StatusCodes.Status200OK)]
  907. [ProducesPlaylistFile]
  908. public async Task<ActionResult> GetVariantHlsAudioPlaylist(
  909. [FromRoute, Required] Guid itemId,
  910. [FromQuery] bool? @static,
  911. [FromQuery] string? @params,
  912. [FromQuery] string? tag,
  913. [FromQuery, ParameterObsolete] string? deviceProfileId,
  914. [FromQuery] string? playSessionId,
  915. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? segmentContainer,
  916. [FromQuery] int? segmentLength,
  917. [FromQuery] int? minSegments,
  918. [FromQuery] string? mediaSourceId,
  919. [FromQuery] string? deviceId,
  920. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? audioCodec,
  921. [FromQuery] bool? enableAutoStreamCopy,
  922. [FromQuery] bool? allowVideoStreamCopy,
  923. [FromQuery] bool? allowAudioStreamCopy,
  924. [FromQuery] bool? breakOnNonKeyFrames,
  925. [FromQuery] int? audioSampleRate,
  926. [FromQuery] int? maxAudioBitDepth,
  927. [FromQuery] int? maxStreamingBitrate,
  928. [FromQuery] int? audioBitRate,
  929. [FromQuery] int? audioChannels,
  930. [FromQuery] int? maxAudioChannels,
  931. [FromQuery] string? profile,
  932. [FromQuery] [RegularExpression(EncodingHelper.LevelValidationRegex)] string? level,
  933. [FromQuery] float? framerate,
  934. [FromQuery] float? maxFramerate,
  935. [FromQuery] bool? copyTimestamps,
  936. [FromQuery] long? startTimeTicks,
  937. [FromQuery] int? width,
  938. [FromQuery] int? height,
  939. [FromQuery] int? videoBitRate,
  940. [FromQuery] int? subtitleStreamIndex,
  941. [FromQuery] SubtitleDeliveryMethod? subtitleMethod,
  942. [FromQuery] int? maxRefFrames,
  943. [FromQuery] int? maxVideoBitDepth,
  944. [FromQuery] bool? requireAvc,
  945. [FromQuery] bool? deInterlace,
  946. [FromQuery] bool? requireNonAnamorphic,
  947. [FromQuery] int? transcodingMaxAudioChannels,
  948. [FromQuery] int? cpuCoreLimit,
  949. [FromQuery] string? liveStreamId,
  950. [FromQuery] bool? enableMpegtsM2TsMode,
  951. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? videoCodec,
  952. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? subtitleCodec,
  953. [FromQuery] string? transcodeReasons,
  954. [FromQuery] int? audioStreamIndex,
  955. [FromQuery] int? videoStreamIndex,
  956. [FromQuery] EncodingContext? context,
  957. [FromQuery] Dictionary<string, string> streamOptions,
  958. [FromQuery] bool enableAudioVbrEncoding = true)
  959. {
  960. using var cancellationTokenSource = new CancellationTokenSource();
  961. var streamingRequest = new StreamingRequestDto
  962. {
  963. Id = itemId,
  964. Static = @static ?? false,
  965. Params = @params,
  966. Tag = tag,
  967. PlaySessionId = playSessionId,
  968. SegmentContainer = segmentContainer,
  969. SegmentLength = segmentLength,
  970. MinSegments = minSegments,
  971. MediaSourceId = mediaSourceId,
  972. DeviceId = deviceId,
  973. AudioCodec = audioCodec,
  974. EnableAutoStreamCopy = enableAutoStreamCopy ?? true,
  975. AllowAudioStreamCopy = allowAudioStreamCopy ?? true,
  976. AllowVideoStreamCopy = allowVideoStreamCopy ?? true,
  977. BreakOnNonKeyFrames = breakOnNonKeyFrames ?? false,
  978. AudioSampleRate = audioSampleRate,
  979. MaxAudioChannels = maxAudioChannels,
  980. AudioBitRate = audioBitRate ?? maxStreamingBitrate,
  981. MaxAudioBitDepth = maxAudioBitDepth,
  982. AudioChannels = audioChannels,
  983. Profile = profile,
  984. Level = level,
  985. Framerate = framerate,
  986. MaxFramerate = maxFramerate,
  987. CopyTimestamps = copyTimestamps ?? false,
  988. StartTimeTicks = startTimeTicks,
  989. Width = width,
  990. Height = height,
  991. VideoBitRate = videoBitRate,
  992. SubtitleStreamIndex = subtitleStreamIndex,
  993. SubtitleMethod = subtitleMethod ?? SubtitleDeliveryMethod.External,
  994. MaxRefFrames = maxRefFrames,
  995. MaxVideoBitDepth = maxVideoBitDepth,
  996. RequireAvc = requireAvc ?? false,
  997. DeInterlace = deInterlace ?? false,
  998. RequireNonAnamorphic = requireNonAnamorphic ?? false,
  999. TranscodingMaxAudioChannels = transcodingMaxAudioChannels,
  1000. CpuCoreLimit = cpuCoreLimit,
  1001. LiveStreamId = liveStreamId,
  1002. EnableMpegtsM2TsMode = enableMpegtsM2TsMode ?? false,
  1003. VideoCodec = videoCodec,
  1004. SubtitleCodec = subtitleCodec,
  1005. TranscodeReasons = transcodeReasons,
  1006. AudioStreamIndex = audioStreamIndex,
  1007. VideoStreamIndex = videoStreamIndex,
  1008. Context = context ?? EncodingContext.Streaming,
  1009. StreamOptions = streamOptions,
  1010. EnableAudioVbrEncoding = enableAudioVbrEncoding,
  1011. AlwaysBurnInSubtitleWhenTranscoding = false
  1012. };
  1013. return await GetVariantPlaylistInternal(streamingRequest, cancellationTokenSource)
  1014. .ConfigureAwait(false);
  1015. }
  1016. /// <summary>
  1017. /// Gets a video stream using HTTP live streaming.
  1018. /// </summary>
  1019. /// <param name="itemId">The item id.</param>
  1020. /// <param name="playlistId">The playlist id.</param>
  1021. /// <param name="segmentId">The segment id.</param>
  1022. /// <param name="container">The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. </param>
  1023. /// <param name="runtimeTicks">The position of the requested segment in ticks.</param>
  1024. /// <param name="actualSegmentLengthTicks">The length of the requested segment in ticks.</param>
  1025. /// <param name="static">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.</param>
  1026. /// <param name="params">The streaming parameters.</param>
  1027. /// <param name="tag">The tag.</param>
  1028. /// <param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
  1029. /// <param name="playSessionId">The play session id.</param>
  1030. /// <param name="segmentContainer">The segment container.</param>
  1031. /// <param name="segmentLength">The desired segment length.</param>
  1032. /// <param name="minSegments">The minimum number of segments.</param>
  1033. /// <param name="mediaSourceId">The media version id, if playing an alternate version.</param>
  1034. /// <param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
  1035. /// <param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
  1036. /// <param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
  1037. /// <param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
  1038. /// <param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
  1039. /// <param name="breakOnNonKeyFrames">Optional. Whether to break on non key frames.</param>
  1040. /// <param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
  1041. /// <param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
  1042. /// <param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
  1043. /// <param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
  1044. /// <param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
  1045. /// <param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
  1046. /// <param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
  1047. /// <param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  1048. /// <param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  1049. /// <param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
  1050. /// <param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
  1051. /// <param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
  1052. /// <param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
  1053. /// <param name="maxWidth">Optional. The maximum horizontal resolution of the encoded video.</param>
  1054. /// <param name="maxHeight">Optional. The maximum vertical resolution of the encoded video.</param>
  1055. /// <param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
  1056. /// <param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
  1057. /// <param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
  1058. /// <param name="maxRefFrames">Optional.</param>
  1059. /// <param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
  1060. /// <param name="requireAvc">Optional. Whether to require avc.</param>
  1061. /// <param name="deInterlace">Optional. Whether to deinterlace the video.</param>
  1062. /// <param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
  1063. /// <param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
  1064. /// <param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
  1065. /// <param name="liveStreamId">The live stream id.</param>
  1066. /// <param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
  1067. /// <param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
  1068. /// <param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
  1069. /// <param name="transcodeReasons">Optional. The transcoding reason.</param>
  1070. /// <param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
  1071. /// <param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
  1072. /// <param name="context">Optional. The <see cref="EncodingContext"/>.</param>
  1073. /// <param name="streamOptions">Optional. The streaming options.</param>
  1074. /// <param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
  1075. /// <param name="alwaysBurnInSubtitleWhenTranscoding">Whether to always burn in subtitles when transcoding.</param>
  1076. /// <response code="200">Video stream returned.</response>
  1077. /// <returns>A <see cref="FileResult"/> containing the audio file.</returns>
  1078. [HttpGet("Videos/{itemId}/hls1/{playlistId}/{segmentId}.{container}")]
  1079. [ProducesResponseType(StatusCodes.Status200OK)]
  1080. [ProducesVideoFile]
  1081. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "playlistId", Justification = "Imported from ServiceStack")]
  1082. public async Task<ActionResult> GetHlsVideoSegment(
  1083. [FromRoute, Required] Guid itemId,
  1084. [FromRoute, Required] string playlistId,
  1085. [FromRoute, Required] int segmentId,
  1086. [FromRoute, Required] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string container,
  1087. [FromQuery, Required] long runtimeTicks,
  1088. [FromQuery, Required] long actualSegmentLengthTicks,
  1089. [FromQuery] bool? @static,
  1090. [FromQuery] string? @params,
  1091. [FromQuery] string? tag,
  1092. [FromQuery, ParameterObsolete] string? deviceProfileId,
  1093. [FromQuery] string? playSessionId,
  1094. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? segmentContainer,
  1095. [FromQuery] int? segmentLength,
  1096. [FromQuery] int? minSegments,
  1097. [FromQuery] string? mediaSourceId,
  1098. [FromQuery] string? deviceId,
  1099. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? audioCodec,
  1100. [FromQuery] bool? enableAutoStreamCopy,
  1101. [FromQuery] bool? allowVideoStreamCopy,
  1102. [FromQuery] bool? allowAudioStreamCopy,
  1103. [FromQuery] bool? breakOnNonKeyFrames,
  1104. [FromQuery] int? audioSampleRate,
  1105. [FromQuery] int? maxAudioBitDepth,
  1106. [FromQuery] int? audioBitRate,
  1107. [FromQuery] int? audioChannels,
  1108. [FromQuery] int? maxAudioChannels,
  1109. [FromQuery] string? profile,
  1110. [FromQuery] [RegularExpression(EncodingHelper.LevelValidationRegex)] string? level,
  1111. [FromQuery] float? framerate,
  1112. [FromQuery] float? maxFramerate,
  1113. [FromQuery] bool? copyTimestamps,
  1114. [FromQuery] long? startTimeTicks,
  1115. [FromQuery] int? width,
  1116. [FromQuery] int? height,
  1117. [FromQuery] int? maxWidth,
  1118. [FromQuery] int? maxHeight,
  1119. [FromQuery] int? videoBitRate,
  1120. [FromQuery] int? subtitleStreamIndex,
  1121. [FromQuery] SubtitleDeliveryMethod? subtitleMethod,
  1122. [FromQuery] int? maxRefFrames,
  1123. [FromQuery] int? maxVideoBitDepth,
  1124. [FromQuery] bool? requireAvc,
  1125. [FromQuery] bool? deInterlace,
  1126. [FromQuery] bool? requireNonAnamorphic,
  1127. [FromQuery] int? transcodingMaxAudioChannels,
  1128. [FromQuery] int? cpuCoreLimit,
  1129. [FromQuery] string? liveStreamId,
  1130. [FromQuery] bool? enableMpegtsM2TsMode,
  1131. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? videoCodec,
  1132. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? subtitleCodec,
  1133. [FromQuery] string? transcodeReasons,
  1134. [FromQuery] int? audioStreamIndex,
  1135. [FromQuery] int? videoStreamIndex,
  1136. [FromQuery] EncodingContext? context,
  1137. [FromQuery] Dictionary<string, string> streamOptions,
  1138. [FromQuery] bool enableAudioVbrEncoding = true,
  1139. [FromQuery] bool alwaysBurnInSubtitleWhenTranscoding = false)
  1140. {
  1141. var streamingRequest = new VideoRequestDto
  1142. {
  1143. Id = itemId,
  1144. CurrentRuntimeTicks = runtimeTicks,
  1145. ActualSegmentLengthTicks = actualSegmentLengthTicks,
  1146. Container = container,
  1147. Static = @static ?? false,
  1148. Params = @params,
  1149. Tag = tag,
  1150. PlaySessionId = playSessionId,
  1151. SegmentContainer = segmentContainer,
  1152. SegmentLength = segmentLength,
  1153. MinSegments = minSegments,
  1154. MediaSourceId = mediaSourceId,
  1155. DeviceId = deviceId,
  1156. AudioCodec = audioCodec,
  1157. EnableAutoStreamCopy = enableAutoStreamCopy ?? true,
  1158. AllowAudioStreamCopy = allowAudioStreamCopy ?? true,
  1159. AllowVideoStreamCopy = allowVideoStreamCopy ?? true,
  1160. BreakOnNonKeyFrames = breakOnNonKeyFrames ?? false,
  1161. AudioSampleRate = audioSampleRate,
  1162. MaxAudioChannels = maxAudioChannels,
  1163. AudioBitRate = audioBitRate,
  1164. MaxAudioBitDepth = maxAudioBitDepth,
  1165. AudioChannels = audioChannels,
  1166. Profile = profile,
  1167. Level = level,
  1168. Framerate = framerate,
  1169. MaxFramerate = maxFramerate,
  1170. CopyTimestamps = copyTimestamps ?? false,
  1171. StartTimeTicks = startTimeTicks,
  1172. Width = width,
  1173. Height = height,
  1174. MaxWidth = maxWidth,
  1175. MaxHeight = maxHeight,
  1176. VideoBitRate = videoBitRate,
  1177. SubtitleStreamIndex = subtitleStreamIndex,
  1178. SubtitleMethod = subtitleMethod ?? SubtitleDeliveryMethod.External,
  1179. MaxRefFrames = maxRefFrames,
  1180. MaxVideoBitDepth = maxVideoBitDepth,
  1181. RequireAvc = requireAvc ?? false,
  1182. DeInterlace = deInterlace ?? false,
  1183. RequireNonAnamorphic = requireNonAnamorphic ?? false,
  1184. TranscodingMaxAudioChannels = transcodingMaxAudioChannels,
  1185. CpuCoreLimit = cpuCoreLimit,
  1186. LiveStreamId = liveStreamId,
  1187. EnableMpegtsM2TsMode = enableMpegtsM2TsMode ?? false,
  1188. VideoCodec = videoCodec,
  1189. SubtitleCodec = subtitleCodec,
  1190. TranscodeReasons = transcodeReasons,
  1191. AudioStreamIndex = audioStreamIndex,
  1192. VideoStreamIndex = videoStreamIndex,
  1193. Context = context ?? EncodingContext.Streaming,
  1194. StreamOptions = streamOptions,
  1195. EnableAudioVbrEncoding = enableAudioVbrEncoding,
  1196. AlwaysBurnInSubtitleWhenTranscoding = alwaysBurnInSubtitleWhenTranscoding
  1197. };
  1198. return await GetDynamicSegment(streamingRequest, segmentId)
  1199. .ConfigureAwait(false);
  1200. }
  1201. /// <summary>
  1202. /// Gets a video stream using HTTP live streaming.
  1203. /// </summary>
  1204. /// <param name="itemId">The item id.</param>
  1205. /// <param name="playlistId">The playlist id.</param>
  1206. /// <param name="segmentId">The segment id.</param>
  1207. /// <param name="container">The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv. </param>
  1208. /// <param name="runtimeTicks">The position of the requested segment in ticks.</param>
  1209. /// <param name="actualSegmentLengthTicks">The length of the requested segment in ticks.</param>
  1210. /// <param name="static">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.</param>
  1211. /// <param name="params">The streaming parameters.</param>
  1212. /// <param name="tag">The tag.</param>
  1213. /// <param name="deviceProfileId">Optional. The dlna device profile id to utilize.</param>
  1214. /// <param name="playSessionId">The play session id.</param>
  1215. /// <param name="segmentContainer">The segment container.</param>
  1216. /// <param name="segmentLength">The segment length.</param>
  1217. /// <param name="minSegments">The minimum number of segments.</param>
  1218. /// <param name="mediaSourceId">The media version id, if playing an alternate version.</param>
  1219. /// <param name="deviceId">The device id of the client requesting. Used to stop encoding processes when needed.</param>
  1220. /// <param name="audioCodec">Optional. Specify an audio codec to encode to, e.g. mp3.</param>
  1221. /// <param name="enableAutoStreamCopy">Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true.</param>
  1222. /// <param name="allowVideoStreamCopy">Whether or not to allow copying of the video stream url.</param>
  1223. /// <param name="allowAudioStreamCopy">Whether or not to allow copying of the audio stream url.</param>
  1224. /// <param name="breakOnNonKeyFrames">Optional. Whether to break on non key frames.</param>
  1225. /// <param name="audioSampleRate">Optional. Specify a specific audio sample rate, e.g. 44100.</param>
  1226. /// <param name="maxAudioBitDepth">Optional. The maximum audio bit depth.</param>
  1227. /// <param name="maxStreamingBitrate">Optional. The maximum streaming bitrate.</param>
  1228. /// <param name="audioBitRate">Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults.</param>
  1229. /// <param name="audioChannels">Optional. Specify a specific number of audio channels to encode to, e.g. 2.</param>
  1230. /// <param name="maxAudioChannels">Optional. Specify a maximum number of audio channels to encode to, e.g. 2.</param>
  1231. /// <param name="profile">Optional. Specify a specific an encoder profile (varies by encoder), e.g. main, baseline, high.</param>
  1232. /// <param name="level">Optional. Specify a level for the encoder profile (varies by encoder), e.g. 3, 3.1.</param>
  1233. /// <param name="framerate">Optional. A specific video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  1234. /// <param name="maxFramerate">Optional. A specific maximum video framerate to encode to, e.g. 23.976. Generally this should be omitted unless the device has specific requirements.</param>
  1235. /// <param name="copyTimestamps">Whether or not to copy timestamps when transcoding with an offset. Defaults to false.</param>
  1236. /// <param name="startTimeTicks">Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms.</param>
  1237. /// <param name="width">Optional. The fixed horizontal resolution of the encoded video.</param>
  1238. /// <param name="height">Optional. The fixed vertical resolution of the encoded video.</param>
  1239. /// <param name="videoBitRate">Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults.</param>
  1240. /// <param name="subtitleStreamIndex">Optional. The index of the subtitle stream to use. If omitted no subtitles will be used.</param>
  1241. /// <param name="subtitleMethod">Optional. Specify the subtitle delivery method.</param>
  1242. /// <param name="maxRefFrames">Optional.</param>
  1243. /// <param name="maxVideoBitDepth">Optional. The maximum video bit depth.</param>
  1244. /// <param name="requireAvc">Optional. Whether to require avc.</param>
  1245. /// <param name="deInterlace">Optional. Whether to deinterlace the video.</param>
  1246. /// <param name="requireNonAnamorphic">Optional. Whether to require a non anamorphic stream.</param>
  1247. /// <param name="transcodingMaxAudioChannels">Optional. The maximum number of audio channels to transcode.</param>
  1248. /// <param name="cpuCoreLimit">Optional. The limit of how many cpu cores to use.</param>
  1249. /// <param name="liveStreamId">The live stream id.</param>
  1250. /// <param name="enableMpegtsM2TsMode">Optional. Whether to enable the MpegtsM2Ts mode.</param>
  1251. /// <param name="videoCodec">Optional. Specify a video codec to encode to, e.g. h264.</param>
  1252. /// <param name="subtitleCodec">Optional. Specify a subtitle codec to encode to.</param>
  1253. /// <param name="transcodeReasons">Optional. The transcoding reason.</param>
  1254. /// <param name="audioStreamIndex">Optional. The index of the audio stream to use. If omitted the first audio stream will be used.</param>
  1255. /// <param name="videoStreamIndex">Optional. The index of the video stream to use. If omitted the first video stream will be used.</param>
  1256. /// <param name="context">Optional. The <see cref="EncodingContext"/>.</param>
  1257. /// <param name="streamOptions">Optional. The streaming options.</param>
  1258. /// <param name="enableAudioVbrEncoding">Optional. Whether to enable Audio Encoding.</param>
  1259. /// <response code="200">Video stream returned.</response>
  1260. /// <returns>A <see cref="FileResult"/> containing the audio file.</returns>
  1261. [HttpGet("Audio/{itemId}/hls1/{playlistId}/{segmentId}.{container}")]
  1262. [ProducesResponseType(StatusCodes.Status200OK)]
  1263. [ProducesAudioFile]
  1264. [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "playlistId", Justification = "Imported from ServiceStack")]
  1265. public async Task<ActionResult> GetHlsAudioSegment(
  1266. [FromRoute, Required] Guid itemId,
  1267. [FromRoute, Required] string playlistId,
  1268. [FromRoute, Required] int segmentId,
  1269. [FromRoute, Required] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string container,
  1270. [FromQuery, Required] long runtimeTicks,
  1271. [FromQuery, Required] long actualSegmentLengthTicks,
  1272. [FromQuery] bool? @static,
  1273. [FromQuery] string? @params,
  1274. [FromQuery] string? tag,
  1275. [FromQuery, ParameterObsolete] string? deviceProfileId,
  1276. [FromQuery] string? playSessionId,
  1277. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? segmentContainer,
  1278. [FromQuery] int? segmentLength,
  1279. [FromQuery] int? minSegments,
  1280. [FromQuery] string? mediaSourceId,
  1281. [FromQuery] string? deviceId,
  1282. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? audioCodec,
  1283. [FromQuery] bool? enableAutoStreamCopy,
  1284. [FromQuery] bool? allowVideoStreamCopy,
  1285. [FromQuery] bool? allowAudioStreamCopy,
  1286. [FromQuery] bool? breakOnNonKeyFrames,
  1287. [FromQuery] int? audioSampleRate,
  1288. [FromQuery] int? maxAudioBitDepth,
  1289. [FromQuery] int? maxStreamingBitrate,
  1290. [FromQuery] int? audioBitRate,
  1291. [FromQuery] int? audioChannels,
  1292. [FromQuery] int? maxAudioChannels,
  1293. [FromQuery] string? profile,
  1294. [FromQuery] [RegularExpression(EncodingHelper.LevelValidationRegex)] string? level,
  1295. [FromQuery] float? framerate,
  1296. [FromQuery] float? maxFramerate,
  1297. [FromQuery] bool? copyTimestamps,
  1298. [FromQuery] long? startTimeTicks,
  1299. [FromQuery] int? width,
  1300. [FromQuery] int? height,
  1301. [FromQuery] int? videoBitRate,
  1302. [FromQuery] int? subtitleStreamIndex,
  1303. [FromQuery] SubtitleDeliveryMethod? subtitleMethod,
  1304. [FromQuery] int? maxRefFrames,
  1305. [FromQuery] int? maxVideoBitDepth,
  1306. [FromQuery] bool? requireAvc,
  1307. [FromQuery] bool? deInterlace,
  1308. [FromQuery] bool? requireNonAnamorphic,
  1309. [FromQuery] int? transcodingMaxAudioChannels,
  1310. [FromQuery] int? cpuCoreLimit,
  1311. [FromQuery] string? liveStreamId,
  1312. [FromQuery] bool? enableMpegtsM2TsMode,
  1313. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? videoCodec,
  1314. [FromQuery] [RegularExpression(EncodingHelper.ContainerValidationRegex)] string? subtitleCodec,
  1315. [FromQuery] string? transcodeReasons,
  1316. [FromQuery] int? audioStreamIndex,
  1317. [FromQuery] int? videoStreamIndex,
  1318. [FromQuery] EncodingContext? context,
  1319. [FromQuery] Dictionary<string, string> streamOptions,
  1320. [FromQuery] bool enableAudioVbrEncoding = true)
  1321. {
  1322. var streamingRequest = new StreamingRequestDto
  1323. {
  1324. Id = itemId,
  1325. Container = container,
  1326. CurrentRuntimeTicks = runtimeTicks,
  1327. ActualSegmentLengthTicks = actualSegmentLengthTicks,
  1328. Static = @static ?? false,
  1329. Params = @params,
  1330. Tag = tag,
  1331. PlaySessionId = playSessionId,
  1332. SegmentContainer = segmentContainer,
  1333. SegmentLength = segmentLength,
  1334. MinSegments = minSegments,
  1335. MediaSourceId = mediaSourceId,
  1336. DeviceId = deviceId,
  1337. AudioCodec = audioCodec,
  1338. EnableAutoStreamCopy = enableAutoStreamCopy ?? true,
  1339. AllowAudioStreamCopy = allowAudioStreamCopy ?? true,
  1340. AllowVideoStreamCopy = allowVideoStreamCopy ?? true,
  1341. BreakOnNonKeyFrames = breakOnNonKeyFrames ?? false,
  1342. AudioSampleRate = audioSampleRate,
  1343. MaxAudioChannels = maxAudioChannels,
  1344. AudioBitRate = audioBitRate ?? maxStreamingBitrate,
  1345. MaxAudioBitDepth = maxAudioBitDepth,
  1346. AudioChannels = audioChannels,
  1347. Profile = profile,
  1348. Level = level,
  1349. Framerate = framerate,
  1350. MaxFramerate = maxFramerate,
  1351. CopyTimestamps = copyTimestamps ?? false,
  1352. StartTimeTicks = startTimeTicks,
  1353. Width = width,
  1354. Height = height,
  1355. VideoBitRate = videoBitRate,
  1356. SubtitleStreamIndex = subtitleStreamIndex,
  1357. SubtitleMethod = subtitleMethod ?? SubtitleDeliveryMethod.External,
  1358. MaxRefFrames = maxRefFrames,
  1359. MaxVideoBitDepth = maxVideoBitDepth,
  1360. RequireAvc = requireAvc ?? false,
  1361. DeInterlace = deInterlace ?? false,
  1362. RequireNonAnamorphic = requireNonAnamorphic ?? false,
  1363. TranscodingMaxAudioChannels = transcodingMaxAudioChannels,
  1364. CpuCoreLimit = cpuCoreLimit,
  1365. LiveStreamId = liveStreamId,
  1366. EnableMpegtsM2TsMode = enableMpegtsM2TsMode ?? false,
  1367. VideoCodec = videoCodec,
  1368. SubtitleCodec = subtitleCodec,
  1369. TranscodeReasons = transcodeReasons,
  1370. AudioStreamIndex = audioStreamIndex,
  1371. VideoStreamIndex = videoStreamIndex,
  1372. Context = context ?? EncodingContext.Streaming,
  1373. StreamOptions = streamOptions,
  1374. EnableAudioVbrEncoding = enableAudioVbrEncoding,
  1375. AlwaysBurnInSubtitleWhenTranscoding = false
  1376. };
  1377. return await GetDynamicSegment(streamingRequest, segmentId)
  1378. .ConfigureAwait(false);
  1379. }
  1380. private async Task<ActionResult> GetVariantPlaylistInternal(StreamingRequestDto streamingRequest, CancellationTokenSource cancellationTokenSource)
  1381. {
  1382. using var state = await StreamingHelpers.GetStreamingState(
  1383. streamingRequest,
  1384. HttpContext,
  1385. _mediaSourceManager,
  1386. _userManager,
  1387. _libraryManager,
  1388. _serverConfigurationManager,
  1389. _mediaEncoder,
  1390. _encodingHelper,
  1391. _transcodeManager,
  1392. TranscodingJobType,
  1393. cancellationTokenSource.Token)
  1394. .ConfigureAwait(false);
  1395. var mediaSourceId = state.BaseRequest.MediaSourceId;
  1396. var request = new CreateMainPlaylistRequest(
  1397. mediaSourceId is null ? null : Guid.Parse(mediaSourceId),
  1398. state.MediaPath,
  1399. state.SegmentLength * 1000,
  1400. state.RunTimeTicks ?? 0,
  1401. state.Request.SegmentContainer ?? string.Empty,
  1402. "hls1/main/",
  1403. Request.QueryString.ToString(),
  1404. EncodingHelper.IsCopyCodec(state.OutputVideoCodec));
  1405. var playlist = _dynamicHlsPlaylistGenerator.CreateMainPlaylist(request);
  1406. return new FileContentResult(Encoding.UTF8.GetBytes(playlist), MimeTypes.GetMimeType("playlist.m3u8"));
  1407. }
  1408. private async Task<ActionResult> GetDynamicSegment(StreamingRequestDto streamingRequest, int segmentId)
  1409. {
  1410. if ((streamingRequest.StartTimeTicks ?? 0) > 0)
  1411. {
  1412. throw new ArgumentException("StartTimeTicks is not allowed.");
  1413. }
  1414. // CTS lifecycle is managed internally.
  1415. var cancellationTokenSource = new CancellationTokenSource();
  1416. var cancellationToken = cancellationTokenSource.Token;
  1417. var state = await StreamingHelpers.GetStreamingState(
  1418. streamingRequest,
  1419. HttpContext,
  1420. _mediaSourceManager,
  1421. _userManager,
  1422. _libraryManager,
  1423. _serverConfigurationManager,
  1424. _mediaEncoder,
  1425. _encodingHelper,
  1426. _transcodeManager,
  1427. TranscodingJobType,
  1428. cancellationToken)
  1429. .ConfigureAwait(false);
  1430. var playlistPath = Path.ChangeExtension(state.OutputFilePath, ".m3u8");
  1431. var segmentPath = GetSegmentPath(state, playlistPath, segmentId);
  1432. var segmentExtension = EncodingHelper.GetSegmentFileExtension(state.Request.SegmentContainer);
  1433. TranscodingJob? job;
  1434. if (System.IO.File.Exists(segmentPath))
  1435. {
  1436. job = _transcodeManager.OnTranscodeBeginRequest(playlistPath, TranscodingJobType);
  1437. _logger.LogDebug("returning {0} [it exists, try 1]", segmentPath);
  1438. return await GetSegmentResult(state, playlistPath, segmentPath, segmentExtension, segmentId, job, cancellationToken).ConfigureAwait(false);
  1439. }
  1440. using (await _transcodeManager.LockAsync(playlistPath, cancellationToken).ConfigureAwait(false))
  1441. {
  1442. var startTranscoding = false;
  1443. if (System.IO.File.Exists(segmentPath))
  1444. {
  1445. job = _transcodeManager.OnTranscodeBeginRequest(playlistPath, TranscodingJobType);
  1446. _logger.LogDebug("returning {0} [it exists, try 2]", segmentPath);
  1447. return await GetSegmentResult(state, playlistPath, segmentPath, segmentExtension, segmentId, job, cancellationToken).ConfigureAwait(false);
  1448. }
  1449. var currentTranscodingIndex = GetCurrentTranscodingIndex(playlistPath, segmentExtension);
  1450. var segmentGapRequiringTranscodingChange = 24 / state.SegmentLength;
  1451. if (segmentId == -1)
  1452. {
  1453. _logger.LogDebug("Starting transcoding because fmp4 init file is being requested");
  1454. startTranscoding = true;
  1455. segmentId = 0;
  1456. }
  1457. else if (currentTranscodingIndex is null)
  1458. {
  1459. _logger.LogDebug("Starting transcoding because currentTranscodingIndex=null");
  1460. startTranscoding = true;
  1461. }
  1462. else if (segmentId < currentTranscodingIndex.Value)
  1463. {
  1464. _logger.LogDebug("Starting transcoding because requestedIndex={0} and currentTranscodingIndex={1}", segmentId, currentTranscodingIndex);
  1465. startTranscoding = true;
  1466. }
  1467. else if (segmentId - currentTranscodingIndex.Value > segmentGapRequiringTranscodingChange)
  1468. {
  1469. _logger.LogDebug("Starting transcoding because segmentGap is {0} and max allowed gap is {1}. requestedIndex={2}", segmentId - currentTranscodingIndex.Value, segmentGapRequiringTranscodingChange, segmentId);
  1470. startTranscoding = true;
  1471. }
  1472. if (startTranscoding)
  1473. {
  1474. // If the playlist doesn't already exist, startup ffmpeg
  1475. try
  1476. {
  1477. await _transcodeManager.KillTranscodingJobs(streamingRequest.DeviceId, streamingRequest.PlaySessionId, p => false)
  1478. .ConfigureAwait(false);
  1479. if (currentTranscodingIndex.HasValue)
  1480. {
  1481. await DeleteLastFile(playlistPath, segmentExtension, 0).ConfigureAwait(false);
  1482. }
  1483. streamingRequest.StartTimeTicks = streamingRequest.CurrentRuntimeTicks;
  1484. state.WaitForPath = segmentPath;
  1485. job = await _transcodeManager.StartFfMpeg(
  1486. state,
  1487. playlistPath,
  1488. GetCommandLineArguments(playlistPath, state, false, segmentId),
  1489. Request.HttpContext.User.GetUserId(),
  1490. TranscodingJobType,
  1491. cancellationTokenSource).ConfigureAwait(false);
  1492. }
  1493. catch
  1494. {
  1495. state.Dispose();
  1496. throw;
  1497. }
  1498. // await WaitForMinimumSegmentCount(playlistPath, 1, cancellationTokenSource.Token).ConfigureAwait(false);
  1499. }
  1500. else
  1501. {
  1502. job = _transcodeManager.OnTranscodeBeginRequest(playlistPath, TranscodingJobType);
  1503. if (job?.TranscodingThrottler is not null)
  1504. {
  1505. await job.TranscodingThrottler.UnpauseTranscoding().ConfigureAwait(false);
  1506. }
  1507. }
  1508. }
  1509. _logger.LogDebug("returning {0} [general case]", segmentPath);
  1510. job ??= _transcodeManager.OnTranscodeBeginRequest(playlistPath, TranscodingJobType);
  1511. return await GetSegmentResult(state, playlistPath, segmentPath, segmentExtension, segmentId, job, cancellationToken).ConfigureAwait(false);
  1512. }
  1513. private static double[] GetSegmentLengths(StreamState state)
  1514. => GetSegmentLengthsInternal(state.RunTimeTicks ?? 0, state.SegmentLength);
  1515. internal static double[] GetSegmentLengthsInternal(long runtimeTicks, int segmentlength)
  1516. {
  1517. var segmentLengthTicks = TimeSpan.FromSeconds(segmentlength).Ticks;
  1518. var wholeSegments = runtimeTicks / segmentLengthTicks;
  1519. var remainingTicks = runtimeTicks % segmentLengthTicks;
  1520. var segmentsLen = wholeSegments + (remainingTicks == 0 ? 0 : 1);
  1521. var segments = new double[segmentsLen];
  1522. for (int i = 0; i < wholeSegments; i++)
  1523. {
  1524. segments[i] = segmentlength;
  1525. }
  1526. if (remainingTicks != 0)
  1527. {
  1528. segments[^1] = TimeSpan.FromTicks(remainingTicks).TotalSeconds;
  1529. }
  1530. return segments;
  1531. }
  1532. private string GetCommandLineArguments(string outputPath, StreamState state, bool isEventPlaylist, int startNumber)
  1533. {
  1534. var videoCodec = _encodingHelper.GetVideoEncoder(state, _encodingOptions);
  1535. var threads = EncodingHelper.GetNumberOfThreads(state, _encodingOptions, videoCodec);
  1536. if (state.BaseRequest.BreakOnNonKeyFrames)
  1537. {
  1538. // FIXME: this is actually a workaround, as ideally it really should be the client which decides whether non-keyframe
  1539. // breakpoints are supported; but current implementation always uses "ffmpeg input seeking" which is liable
  1540. // to produce a missing part of video stream before first keyframe is encountered, which may lead to
  1541. // awkward cases like a few starting HLS segments having no video whatsoever, which breaks hls.js
  1542. _logger.LogInformation("Current HLS implementation doesn't support non-keyframe breaks but one is requested, ignoring that request");
  1543. state.BaseRequest.BreakOnNonKeyFrames = false;
  1544. }
  1545. var mapArgs = state.IsOutputVideo ? _encodingHelper.GetMapArgs(state) : string.Empty;
  1546. var directory = Path.GetDirectoryName(outputPath) ?? throw new ArgumentException($"Provided path ({outputPath}) is not valid.", nameof(outputPath));
  1547. var outputFileNameWithoutExtension = Path.GetFileNameWithoutExtension(outputPath);
  1548. var outputPrefix = Path.Combine(directory, outputFileNameWithoutExtension);
  1549. var outputExtension = EncodingHelper.GetSegmentFileExtension(state.Request.SegmentContainer);
  1550. var outputTsArg = outputPrefix + "%d" + outputExtension;
  1551. var segmentFormat = string.Empty;
  1552. var segmentContainer = outputExtension.TrimStart('.');
  1553. var inputModifier = _encodingHelper.GetInputModifier(state, _encodingOptions, segmentContainer);
  1554. var hlsArguments = $"-hls_playlist_type {(isEventPlaylist ? "event" : "vod")} -hls_list_size 0";
  1555. if (string.Equals(segmentContainer, "ts", StringComparison.OrdinalIgnoreCase))
  1556. {
  1557. segmentFormat = "mpegts";
  1558. }
  1559. else if (string.Equals(segmentContainer, "mp4", StringComparison.OrdinalIgnoreCase))
  1560. {
  1561. var outputFmp4HeaderArg = OperatingSystem.IsWindows() switch
  1562. {
  1563. // on Windows, the path of fmp4 header file needs to be configured
  1564. true => " -hls_fmp4_init_filename \"" + outputPrefix + "-1" + outputExtension + "\"",
  1565. // on Linux/Unix, ffmpeg generate fmp4 header file to m3u8 output folder
  1566. false => " -hls_fmp4_init_filename \"" + outputFileNameWithoutExtension + "-1" + outputExtension + "\""
  1567. };
  1568. var useLegacySegmentOption = _mediaEncoder.EncoderVersion < _minFFmpegHlsSegmentOptions;
  1569. // fMP4 needs this flag to write the audio packet DTS/PTS including the initial delay into MOOF::TRAF::TFDT
  1570. hlsArguments += $" {(useLegacySegmentOption ? "-hls_ts_options" : "-hls_segment_options")} movflags=+frag_discont";
  1571. segmentFormat = "fmp4" + outputFmp4HeaderArg;
  1572. }
  1573. else
  1574. {
  1575. _logger.LogError("Invalid HLS segment container: {SegmentContainer}, default to mpegts", segmentContainer);
  1576. segmentFormat = "mpegts";
  1577. }
  1578. var maxMuxingQueueSize = _encodingOptions.MaxMuxingQueueSize > 128
  1579. ? _encodingOptions.MaxMuxingQueueSize.ToString(CultureInfo.InvariantCulture)
  1580. : "128";
  1581. var baseUrlParam = string.Empty;
  1582. if (isEventPlaylist)
  1583. {
  1584. baseUrlParam = string.Format(
  1585. CultureInfo.InvariantCulture,
  1586. " -hls_base_url \"hls/{0}/\"",
  1587. Path.GetFileNameWithoutExtension(outputPath));
  1588. }
  1589. return string.Format(
  1590. CultureInfo.InvariantCulture,
  1591. "{0} {1} -map_metadata -1 -map_chapters -1 -threads {2} {3} {4} {5} -copyts -avoid_negative_ts disabled -max_muxing_queue_size {6} -f hls -max_delay 5000000 -hls_time {7} -hls_segment_type {8} -start_number {9}{10} -hls_segment_filename \"{11}\" {12} -y \"{13}\"",
  1592. inputModifier,
  1593. _encodingHelper.GetInputArgument(state, _encodingOptions, segmentContainer),
  1594. threads,
  1595. mapArgs,
  1596. GetVideoArguments(state, startNumber, isEventPlaylist, segmentContainer),
  1597. GetAudioArguments(state),
  1598. maxMuxingQueueSize,
  1599. state.SegmentLength.ToString(CultureInfo.InvariantCulture),
  1600. segmentFormat,
  1601. startNumber.ToString(CultureInfo.InvariantCulture),
  1602. baseUrlParam,
  1603. EncodingUtils.NormalizePath(outputTsArg),
  1604. hlsArguments,
  1605. EncodingUtils.NormalizePath(outputPath)).Trim();
  1606. }
  1607. /// <summary>
  1608. /// Gets the audio arguments for transcoding.
  1609. /// </summary>
  1610. /// <param name="state">The <see cref="StreamState"/>.</param>
  1611. /// <returns>The command line arguments for audio transcoding.</returns>
  1612. private string GetAudioArguments(StreamState state)
  1613. {
  1614. if (state.AudioStream is null)
  1615. {
  1616. return string.Empty;
  1617. }
  1618. var audioCodec = _encodingHelper.GetAudioEncoder(state);
  1619. var bitStreamArgs = _encodingHelper.GetAudioBitStreamArguments(state, state.Request.SegmentContainer, state.MediaSource.Container);
  1620. // opus, dts, truehd and flac (in FFmpeg 5 and older) are experimental in mp4 muxer
  1621. var strictArgs = string.Empty;
  1622. var actualOutputAudioCodec = state.ActualOutputAudioCodec;
  1623. if (string.Equals(actualOutputAudioCodec, "opus", StringComparison.OrdinalIgnoreCase)
  1624. || string.Equals(actualOutputAudioCodec, "dts", StringComparison.OrdinalIgnoreCase)
  1625. || string.Equals(actualOutputAudioCodec, "truehd", StringComparison.OrdinalIgnoreCase)
  1626. || (string.Equals(actualOutputAudioCodec, "flac", StringComparison.OrdinalIgnoreCase)
  1627. && _mediaEncoder.EncoderVersion < _minFFmpegFlacInMp4))
  1628. {
  1629. strictArgs = " -strict -2";
  1630. }
  1631. if (!state.IsOutputVideo)
  1632. {
  1633. var audioTranscodeParams = string.Empty;
  1634. // -vn to drop any video streams
  1635. audioTranscodeParams += "-vn";
  1636. if (EncodingHelper.IsCopyCodec(audioCodec))
  1637. {
  1638. return audioTranscodeParams + " -acodec copy" + bitStreamArgs + strictArgs;
  1639. }
  1640. audioTranscodeParams += " -acodec " + audioCodec + bitStreamArgs + strictArgs;
  1641. var audioBitrate = state.OutputAudioBitrate;
  1642. var audioChannels = state.OutputAudioChannels;
  1643. if (audioBitrate.HasValue && !EncodingHelper.LosslessAudioCodecs.Contains(state.ActualOutputAudioCodec, StringComparison.OrdinalIgnoreCase))
  1644. {
  1645. var vbrParam = _encodingHelper.GetAudioVbrModeParam(audioCodec, audioBitrate.Value, audioChannels ?? 2);
  1646. if (_encodingOptions.EnableAudioVbr && state.EnableAudioVbrEncoding && vbrParam is not null)
  1647. {
  1648. audioTranscodeParams += vbrParam;
  1649. }
  1650. else
  1651. {
  1652. audioTranscodeParams += " -ab " + audioBitrate.Value.ToString(CultureInfo.InvariantCulture);
  1653. }
  1654. }
  1655. if (audioChannels.HasValue)
  1656. {
  1657. audioTranscodeParams += " -ac " + audioChannels.Value.ToString(CultureInfo.InvariantCulture);
  1658. }
  1659. if (state.OutputAudioSampleRate.HasValue)
  1660. {
  1661. audioTranscodeParams += " -ar " + state.OutputAudioSampleRate.Value.ToString(CultureInfo.InvariantCulture);
  1662. }
  1663. return audioTranscodeParams;
  1664. }
  1665. if (EncodingHelper.IsCopyCodec(audioCodec))
  1666. {
  1667. var videoCodec = _encodingHelper.GetVideoEncoder(state, _encodingOptions);
  1668. var copyArgs = "-codec:a:0 copy" + bitStreamArgs + strictArgs;
  1669. if (EncodingHelper.IsCopyCodec(videoCodec) && state.EnableBreakOnNonKeyFrames(videoCodec))
  1670. {
  1671. return copyArgs + " -copypriorss:a:0 0";
  1672. }
  1673. return copyArgs;
  1674. }
  1675. var args = "-codec:a:0 " + audioCodec + bitStreamArgs + strictArgs;
  1676. var channels = state.OutputAudioChannels;
  1677. var useDownMixAlgorithm = DownMixAlgorithmsHelper.AlgorithmFilterStrings.ContainsKey((_encodingOptions.DownMixStereoAlgorithm, DownMixAlgorithmsHelper.InferChannelLayout(state.AudioStream)));
  1678. if (channels.HasValue
  1679. && (channels.Value != 2
  1680. || (state.AudioStream?.Channels is not null && !useDownMixAlgorithm)))
  1681. {
  1682. args += " -ac " + channels.Value;
  1683. }
  1684. var bitrate = state.OutputAudioBitrate;
  1685. if (bitrate.HasValue && !EncodingHelper.LosslessAudioCodecs.Contains(actualOutputAudioCodec, StringComparison.OrdinalIgnoreCase))
  1686. {
  1687. var vbrParam = _encodingHelper.GetAudioVbrModeParam(audioCodec, bitrate.Value, channels ?? 2);
  1688. if (_encodingOptions.EnableAudioVbr && state.EnableAudioVbrEncoding && vbrParam is not null)
  1689. {
  1690. args += vbrParam;
  1691. }
  1692. else
  1693. {
  1694. args += " -ab " + bitrate.Value.ToString(CultureInfo.InvariantCulture);
  1695. }
  1696. }
  1697. if (state.OutputAudioSampleRate.HasValue)
  1698. {
  1699. args += " -ar " + state.OutputAudioSampleRate.Value.ToString(CultureInfo.InvariantCulture);
  1700. }
  1701. else if (state.AudioStream?.CodecTag is not null && state.AudioStream.CodecTag.Equals("ac-4", StringComparison.Ordinal))
  1702. {
  1703. // ac-4 audio tends to have a super weird sample rate that will fail most encoders
  1704. // force resample it to 48KHz
  1705. args += " -ar 48000";
  1706. }
  1707. args += _encodingHelper.GetAudioFilterParam(state, _encodingOptions);
  1708. return args;
  1709. }
  1710. /// <summary>
  1711. /// Gets the video arguments for transcoding.
  1712. /// </summary>
  1713. /// <param name="state">The <see cref="StreamState"/>.</param>
  1714. /// <param name="startNumber">The first number in the hls sequence.</param>
  1715. /// <param name="isEventPlaylist">Whether the playlist is EVENT or VOD.</param>
  1716. /// <param name="segmentContainer">The segment container.</param>
  1717. /// <returns>The command line arguments for video transcoding.</returns>
  1718. private string GetVideoArguments(StreamState state, int startNumber, bool isEventPlaylist, string segmentContainer)
  1719. {
  1720. if (state.VideoStream is null)
  1721. {
  1722. return string.Empty;
  1723. }
  1724. if (!state.IsOutputVideo)
  1725. {
  1726. return string.Empty;
  1727. }
  1728. var codec = _encodingHelper.GetVideoEncoder(state, _encodingOptions);
  1729. var args = "-codec:v:0 " + codec;
  1730. var isActualOutputVideoCodecAv1 = string.Equals(state.ActualOutputVideoCodec, "av1", StringComparison.OrdinalIgnoreCase);
  1731. var isActualOutputVideoCodecHevc = string.Equals(state.ActualOutputVideoCodec, "h265", StringComparison.OrdinalIgnoreCase)
  1732. || string.Equals(state.ActualOutputVideoCodec, "hevc", StringComparison.OrdinalIgnoreCase);
  1733. if (isActualOutputVideoCodecHevc || isActualOutputVideoCodecAv1)
  1734. {
  1735. var requestedRange = state.GetRequestedRangeTypes(state.ActualOutputVideoCodec);
  1736. // Clients reporting Dolby Vision capabilities with fallbacks may only support the fallback layer.
  1737. // Only enable Dolby Vision remuxing if the client explicitly declares support for profiles without fallbacks.
  1738. var clientSupportsDoVi = requestedRange.Contains(VideoRangeType.DOVI.ToString(), StringComparison.OrdinalIgnoreCase);
  1739. var videoIsDoVi = EncodingHelper.IsDovi(state.VideoStream);
  1740. if (EncodingHelper.IsCopyCodec(codec)
  1741. && (videoIsDoVi && clientSupportsDoVi)
  1742. && !_encodingHelper.IsDoviRemoved(state))
  1743. {
  1744. if (isActualOutputVideoCodecHevc)
  1745. {
  1746. // Prefer dvh1 to dvhe
  1747. args += " -tag:v:0 dvh1 -strict -2";
  1748. }
  1749. else if (isActualOutputVideoCodecAv1)
  1750. {
  1751. args += " -tag:v:0 dav1 -strict -2";
  1752. }
  1753. }
  1754. else if (isActualOutputVideoCodecHevc)
  1755. {
  1756. // Prefer hvc1 to hev1
  1757. args += " -tag:v:0 hvc1";
  1758. }
  1759. }
  1760. // if (state.EnableMpegtsM2TsMode)
  1761. // {
  1762. // args += " -mpegts_m2ts_mode 1";
  1763. // }
  1764. // See if we can save come cpu cycles by avoiding encoding.
  1765. if (EncodingHelper.IsCopyCodec(codec))
  1766. {
  1767. // If h264_mp4toannexb is ever added, do not use it for live tv.
  1768. if (state.VideoStream is not null && !string.Equals(state.VideoStream.NalLengthSize, "0", StringComparison.OrdinalIgnoreCase))
  1769. {
  1770. string bitStreamArgs = _encodingHelper.GetBitStreamArgs(state, MediaStreamType.Video);
  1771. if (!string.IsNullOrEmpty(bitStreamArgs))
  1772. {
  1773. args += " " + bitStreamArgs;
  1774. }
  1775. }
  1776. args += " -start_at_zero";
  1777. }
  1778. else
  1779. {
  1780. args += _encodingHelper.GetVideoQualityParam(state, codec, _encodingOptions, isEventPlaylist ? DefaultEventEncoderPreset : DefaultVodEncoderPreset);
  1781. // Set the key frame params for video encoding to match the hls segment time.
  1782. args += _encodingHelper.GetHlsVideoKeyFrameArguments(state, codec, state.SegmentLength, isEventPlaylist, startNumber);
  1783. // Currently b-frames in libx265 breaks the FMP4-HLS playback on iOS, disable it for now.
  1784. if (string.Equals(codec, "libx265", StringComparison.OrdinalIgnoreCase)
  1785. && _mediaEncoder.EncoderVersion < _minFFmpegX265BframeInFmp4)
  1786. {
  1787. args += " -bf 0";
  1788. }
  1789. // video processing filters.
  1790. var videoProcessParam = _encodingHelper.GetVideoProcessingFilterParam(state, _encodingOptions, codec);
  1791. var negativeMapArgs = _encodingHelper.GetNegativeMapArgsByFilters(state, videoProcessParam);
  1792. args = negativeMapArgs + args + videoProcessParam;
  1793. // -start_at_zero is necessary to use with -ss when seeking,
  1794. // otherwise the target position cannot be determined.
  1795. if (state.SubtitleStream is not null)
  1796. {
  1797. // Disable start_at_zero for external graphical subs
  1798. if (!(state.SubtitleStream.IsExternal && !state.SubtitleStream.IsTextSubtitleStream))
  1799. {
  1800. args += " -start_at_zero";
  1801. }
  1802. }
  1803. }
  1804. // TODO why was this not enabled for VOD?
  1805. if (isEventPlaylist && string.Equals(segmentContainer, "ts", StringComparison.OrdinalIgnoreCase))
  1806. {
  1807. args += " -flags -global_header";
  1808. }
  1809. if (!string.IsNullOrEmpty(state.OutputVideoSync))
  1810. {
  1811. args += EncodingHelper.GetVideoSyncOption(state.OutputVideoSync, _mediaEncoder.EncoderVersion);
  1812. }
  1813. args += _encodingHelper.GetOutputFFlags(state);
  1814. return args;
  1815. }
  1816. private string GetSegmentPath(StreamState state, string playlist, int index)
  1817. {
  1818. var folder = Path.GetDirectoryName(playlist) ?? throw new ArgumentException($"Provided path ({playlist}) is not valid.", nameof(playlist));
  1819. var filename = Path.GetFileNameWithoutExtension(playlist);
  1820. return Path.Combine(folder, filename + index.ToString(CultureInfo.InvariantCulture) + EncodingHelper.GetSegmentFileExtension(state.Request.SegmentContainer));
  1821. }
  1822. private async Task<ActionResult> GetSegmentResult(
  1823. StreamState state,
  1824. string playlistPath,
  1825. string segmentPath,
  1826. string segmentExtension,
  1827. int segmentIndex,
  1828. TranscodingJob? transcodingJob,
  1829. CancellationToken cancellationToken)
  1830. {
  1831. var segmentExists = System.IO.File.Exists(segmentPath);
  1832. if (segmentExists)
  1833. {
  1834. if (transcodingJob is not null && transcodingJob.HasExited)
  1835. {
  1836. // Transcoding job is over, so assume all existing files are ready
  1837. _logger.LogDebug("serving up {0} as transcode is over", segmentPath);
  1838. return GetSegmentResult(state, segmentPath, transcodingJob);
  1839. }
  1840. var currentTranscodingIndex = GetCurrentTranscodingIndex(playlistPath, segmentExtension);
  1841. // If requested segment is less than transcoding position, we can't transcode backwards, so assume it's ready
  1842. if (segmentIndex < currentTranscodingIndex)
  1843. {
  1844. _logger.LogDebug("serving up {0} as transcode index {1} is past requested point {2}", segmentPath, currentTranscodingIndex, segmentIndex);
  1845. return GetSegmentResult(state, segmentPath, transcodingJob);
  1846. }
  1847. }
  1848. var nextSegmentPath = GetSegmentPath(state, playlistPath, segmentIndex + 1);
  1849. if (transcodingJob is not null)
  1850. {
  1851. while (!cancellationToken.IsCancellationRequested && !transcodingJob.HasExited)
  1852. {
  1853. // To be considered ready, the segment file has to exist AND
  1854. // either the transcoding job should be done or next segment should also exist
  1855. if (segmentExists)
  1856. {
  1857. if (transcodingJob.HasExited || System.IO.File.Exists(nextSegmentPath))
  1858. {
  1859. _logger.LogDebug("Serving up {SegmentPath} as it deemed ready", segmentPath);
  1860. return GetSegmentResult(state, segmentPath, transcodingJob);
  1861. }
  1862. }
  1863. else
  1864. {
  1865. segmentExists = System.IO.File.Exists(segmentPath);
  1866. if (segmentExists)
  1867. {
  1868. continue; // avoid unnecessary waiting if segment just became available
  1869. }
  1870. }
  1871. await Task.Delay(100, cancellationToken).ConfigureAwait(false);
  1872. }
  1873. if (!System.IO.File.Exists(segmentPath))
  1874. {
  1875. _logger.LogWarning("cannot serve {0} as transcoding quit before we got there", segmentPath);
  1876. }
  1877. else
  1878. {
  1879. _logger.LogDebug("serving {0} as it's on disk and transcoding stopped", segmentPath);
  1880. }
  1881. cancellationToken.ThrowIfCancellationRequested();
  1882. }
  1883. else
  1884. {
  1885. _logger.LogWarning("cannot serve {0} as it doesn't exist and no transcode is running", segmentPath);
  1886. }
  1887. return GetSegmentResult(state, segmentPath, transcodingJob);
  1888. }
  1889. private ActionResult GetSegmentResult(StreamState state, string segmentPath, TranscodingJob? transcodingJob)
  1890. {
  1891. var segmentEndingPositionTicks = state.Request.CurrentRuntimeTicks + state.Request.ActualSegmentLengthTicks;
  1892. Response.OnCompleted(() =>
  1893. {
  1894. _logger.LogDebug("Finished serving {SegmentPath}", segmentPath);
  1895. if (transcodingJob is not null)
  1896. {
  1897. transcodingJob.DownloadPositionTicks = Math.Max(transcodingJob.DownloadPositionTicks ?? segmentEndingPositionTicks, segmentEndingPositionTicks);
  1898. _transcodeManager.OnTranscodeEndRequest(transcodingJob);
  1899. }
  1900. return Task.CompletedTask;
  1901. });
  1902. return FileStreamResponseHelpers.GetStaticFileResult(segmentPath, MimeTypes.GetMimeType(segmentPath));
  1903. }
  1904. private int? GetCurrentTranscodingIndex(string playlist, string segmentExtension)
  1905. {
  1906. var job = _transcodeManager.GetTranscodingJob(playlist, TranscodingJobType);
  1907. if (job is null || job.HasExited)
  1908. {
  1909. return null;
  1910. }
  1911. var file = GetLastTranscodingFile(playlist, segmentExtension, _fileSystem);
  1912. if (file is null)
  1913. {
  1914. return null;
  1915. }
  1916. var playlistFilename = Path.GetFileNameWithoutExtension(playlist.AsSpan());
  1917. var indexString = Path.GetFileNameWithoutExtension(file.Name.AsSpan()).Slice(playlistFilename.Length);
  1918. return int.Parse(indexString, NumberStyles.Integer, CultureInfo.InvariantCulture);
  1919. }
  1920. private static FileSystemMetadata? GetLastTranscodingFile(string playlist, string segmentExtension, IFileSystem fileSystem)
  1921. {
  1922. var folder = Path.GetDirectoryName(playlist) ?? throw new ArgumentException("Path can't be a root directory.", nameof(playlist));
  1923. var filePrefix = Path.GetFileNameWithoutExtension(playlist);
  1924. try
  1925. {
  1926. return fileSystem.GetFiles(folder, new[] { segmentExtension }, true, false)
  1927. .Where(i => Path.GetFileNameWithoutExtension(i.Name).StartsWith(filePrefix, StringComparison.OrdinalIgnoreCase))
  1928. .MaxBy(fileSystem.GetLastWriteTimeUtc);
  1929. }
  1930. catch (IOException)
  1931. {
  1932. return null;
  1933. }
  1934. }
  1935. private async Task DeleteLastFile(string playlistPath, string segmentExtension, int retryCount)
  1936. {
  1937. var file = GetLastTranscodingFile(playlistPath, segmentExtension, _fileSystem);
  1938. if (file is null)
  1939. {
  1940. return;
  1941. }
  1942. await DeleteFile(file.FullName, retryCount).ConfigureAwait(false);
  1943. }
  1944. private async Task DeleteFile(string path, int retryCount)
  1945. {
  1946. if (retryCount >= 5)
  1947. {
  1948. return;
  1949. }
  1950. _logger.LogDebug("Deleting partial HLS file {Path}", path);
  1951. try
  1952. {
  1953. _fileSystem.DeleteFile(path);
  1954. }
  1955. catch (IOException ex)
  1956. {
  1957. _logger.LogError(ex, "Error deleting partial stream file(s) {Path}", path);
  1958. await Task.Delay(100).ConfigureAwait(false);
  1959. await DeleteFile(path, retryCount + 1).ConfigureAwait(false);
  1960. }
  1961. catch (Exception ex)
  1962. {
  1963. _logger.LogError(ex, "Error deleting partial stream file(s) {Path}", path);
  1964. }
  1965. }
  1966. }