SpongeEngine.SubtitleSharp 2.0.1

SubtitleSharp

C# library for parsing and handling subtitle files (e.g., SRT, VTT, ASS).

Features

• Supports parsing subtitle formats including SubRip (SRT), WebVTT (VTT), and SubStation Alpha (ASS).
• Converts subtitle files to structured data (SubtitleItem) for easy processing.
• Handles timecode validation and parsing.
• Cross-platform compatibility with .NET 6.0+.
• Async/await support for non-blocking subtitle processing.

📦 View Package on NuGet

Installation

Install via NuGet:

dotnet add package SpongeEngine.SubtitleSharp

Quick Start

Basic Usage

using SpongeEngine.SubtitleSharp;

// Parse an SRT file into structured subtitle items
var srtFilePath = "path_to_subtitle.srt";
using var fileStream = new FileStream(srtFilePath, FileMode.Open, FileAccess.Read);
var parser = new SrtParser();
var subtitleItems = parser.ParseStream(fileStream, Encoding.UTF8);

// Output subtitle start and end times
foreach (var item in subtitleItems)
{
    Console.WriteLine($"Start: {item.StartTime}, End: {item.EndTime}");
}

Configuration

Parsing Options

// Manually specify format for parsing
SubtitlesFormat format = SubtitlesFormat.SubRipFormat;
using var fileStream = new FileStream("path_to_subtitle.srt", FileMode.Open, FileAccess.Read);
var parser = new SubtitleParser();
var subtitleItems = parser.ParseStream(fileStream, Encoding.UTF8, format);

Error Handling

try
{
    var subtitleItems = parser.ParseStream(fileStream, Encoding.UTF8, format);
}
catch (ArgumentException ex)
{
    Console.WriteLine($"Error parsing subtitle: {ex.Message}");
}

Logging

ILogger logger = LoggerFactory
    .Create(builder => builder
        .AddConsole()
        .SetMinimumLevel(LogLevel.Debug))
    .CreateLogger<SubtitleParser>();

// Example usage of logger in subtitle parsing
var parser = new SubtitleParser(logger);

Testing

To run the tests:

dotnet test

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

For issues and feature requests, please use the GitHub issues page.