aboutsummaryrefslogtreecommitdiff
path: root/src/Jellyfin.MediaEncoding.Keyframes
diff options
context:
space:
mode:
authorcvium <clausvium@gmail.com>2021-09-23 17:00:39 +0200
committercvium <clausvium@gmail.com>2021-09-23 17:00:39 +0200
commit30230aff73271acb521c427f9815df6adf1814bb (patch)
tree3d7d0aedbfeee5f241695d135a206f2b251cce37 /src/Jellyfin.MediaEncoding.Keyframes
parentd995f0e092f997930e6561a343072c26f100bb35 (diff)
Fix build?
Diffstat (limited to 'src/Jellyfin.MediaEncoding.Keyframes')
-rw-r--r--src/Jellyfin.MediaEncoding.Keyframes/FfProbe/FfProbeKeyframeExtractor.cs10
-rw-r--r--src/Jellyfin.MediaEncoding.Keyframes/FfTool/FfToolKeyframeExtractor.cs12
-rw-r--r--src/Jellyfin.MediaEncoding.Keyframes/Jellyfin.MediaEncoding.Keyframes.csproj7
-rw-r--r--src/Jellyfin.MediaEncoding.Keyframes/KeyframeData.cs3
-rw-r--r--src/Jellyfin.MediaEncoding.Keyframes/Matroska/Extensions/EbmlReaderExtensions.cs1
5 files changed, 29 insertions, 4 deletions
diff --git a/src/Jellyfin.MediaEncoding.Keyframes/FfProbe/FfProbeKeyframeExtractor.cs b/src/Jellyfin.MediaEncoding.Keyframes/FfProbe/FfProbeKeyframeExtractor.cs
index 249608ef9..e09b9da9a 100644
--- a/src/Jellyfin.MediaEncoding.Keyframes/FfProbe/FfProbeKeyframeExtractor.cs
+++ b/src/Jellyfin.MediaEncoding.Keyframes/FfProbe/FfProbeKeyframeExtractor.cs
@@ -2,9 +2,17 @@
namespace Jellyfin.MediaEncoding.Keyframes.FfProbe
{
+ /// <summary>
+ /// FfProbe based keyframe extractor.
+ /// </summary>
public static class FfProbeKeyframeExtractor
{
- // TODO
+ /// <summary>
+ /// Extracts the keyframes using the ffprobe executable at the specified path.
+ /// </summary>
+ /// <param name="ffProbePath">The path to the ffprobe executable.</param>
+ /// <param name="filePath">The file path.</param>
+ /// <returns>An instance of <see cref="KeyframeData"/>.</returns>
public static KeyframeData GetKeyframeData(string ffProbePath, string filePath) => throw new NotImplementedException();
}
}
diff --git a/src/Jellyfin.MediaEncoding.Keyframes/FfTool/FfToolKeyframeExtractor.cs b/src/Jellyfin.MediaEncoding.Keyframes/FfTool/FfToolKeyframeExtractor.cs
index 89c149ff4..fdd5dc577 100644
--- a/src/Jellyfin.MediaEncoding.Keyframes/FfTool/FfToolKeyframeExtractor.cs
+++ b/src/Jellyfin.MediaEncoding.Keyframes/FfTool/FfToolKeyframeExtractor.cs
@@ -2,9 +2,17 @@
namespace Jellyfin.MediaEncoding.Keyframes.FfTool
{
+ /// <summary>
+ /// FfTool based keyframe extractor.
+ /// </summary>
public static class FfToolKeyframeExtractor
{
- // TODO
- public static KeyframeData GetKeyframeData(string ffProbePath, string filePath) => throw new NotImplementedException();
+ /// <summary>
+ /// Extracts the keyframes using the fftool executable at the specified path.
+ /// </summary>
+ /// <param name="ffToolPath">The path to the fftool executable.</param>
+ /// <param name="filePath">The file path.</param>
+ /// <returns>An instance of <see cref="KeyframeData"/>.</returns>
+ public static KeyframeData GetKeyframeData(string ffToolPath, string filePath) => throw new NotImplementedException();
}
}
diff --git a/src/Jellyfin.MediaEncoding.Keyframes/Jellyfin.MediaEncoding.Keyframes.csproj b/src/Jellyfin.MediaEncoding.Keyframes/Jellyfin.MediaEncoding.Keyframes.csproj
index 2cb8cf9bc..253dd83c7 100644
--- a/src/Jellyfin.MediaEncoding.Keyframes/Jellyfin.MediaEncoding.Keyframes.csproj
+++ b/src/Jellyfin.MediaEncoding.Keyframes/Jellyfin.MediaEncoding.Keyframes.csproj
@@ -2,10 +2,15 @@
<PropertyGroup>
<TargetFramework>net5.0</TargetFramework>
- <RootNamespace>Jellyfin.MediaEncoding.Keyframes</RootNamespace>
+ <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
+ <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
<ItemGroup>
+ <Compile Include="../../SharedVersion.cs" />
+ </ItemGroup>
+
+ <ItemGroup>
<PackageReference Include="NEbml" Version="0.11.0" />
</ItemGroup>
diff --git a/src/Jellyfin.MediaEncoding.Keyframes/KeyframeData.cs b/src/Jellyfin.MediaEncoding.Keyframes/KeyframeData.cs
index 3122f827c..1683cd22a 100644
--- a/src/Jellyfin.MediaEncoding.Keyframes/KeyframeData.cs
+++ b/src/Jellyfin.MediaEncoding.Keyframes/KeyframeData.cs
@@ -2,6 +2,9 @@
namespace Jellyfin.MediaEncoding.Keyframes
{
+ /// <summary>
+ /// Keyframe information for a specific file.
+ /// </summary>
public class KeyframeData
{
/// <summary>
diff --git a/src/Jellyfin.MediaEncoding.Keyframes/Matroska/Extensions/EbmlReaderExtensions.cs b/src/Jellyfin.MediaEncoding.Keyframes/Matroska/Extensions/EbmlReaderExtensions.cs
index 0de0f996c..c44734245 100644
--- a/src/Jellyfin.MediaEncoding.Keyframes/Matroska/Extensions/EbmlReaderExtensions.cs
+++ b/src/Jellyfin.MediaEncoding.Keyframes/Matroska/Extensions/EbmlReaderExtensions.cs
@@ -120,6 +120,7 @@ namespace Jellyfin.MediaEncoding.Keyframes.Matroska.Extensions
/// Reads from SegmentContainer to retrieve the Info segment.
/// </summary>
/// <param name="reader">An instance of <see cref="EbmlReader"/>.</param>
+ /// <param name="position">The position of the info segment relative to the Segment container.</param>
/// <returns>Instance of <see cref="Info"/></returns>
internal static Info ReadInfo(this EbmlReader reader, long position)
{