SubtitlesParserV2 2.3.0

SubtitlesParserV2

Universal subtitles parser which aims at supporting parsing for all subtitle formats. For more info on subtitles formats, see this page: http://en.wikipedia.org/wiki/Category:Subtitle_file_formats

Supported Parsers/Writers

Quickstart

Universal parser

If you don't specify the subtitle format, SubtitlesParserV2 will try all the registered parsers with the default configuration

using (FileStream fileStream = File.OpenRead(pathToSrtFile)){
	// Try to parse with all supported parsers
	SubtitleParserResultModel? result = SubtitleParser.ParseStream(fileStream, Encoding.UTF8)
	// Access the Subtitles with: result.Subtitles
	// Access the Subtitle parser that was used with: result.FormatType
	// Note that if all parsers fail, the method will return: null
}

Get Subtitle format by extension (Extensions detection)

string fileName = Path.GetFileName(file);
// Get format enum
SubtitleFormatType? mostLikelyFormat = SubtitleFormat.GetFormatTypeByFileExtensionName(Path.GetExtension(fileName).Replace(".",""));
// Get format instance
if (mostLikelyFormat != null) 
{
	SubtitleFormat format = SubtitleFormat.GetFormat(mostLikelyFormat.Value);
	Console.WriteLine($"Matching format is : {format.Name}");
}

Specific parser (default configuration)

You can use one/multiples specific parser:

using (FileStream fileStream = File.OpenRead(pathToSrtFile)){
	// Try to parse with one specific parser using default configuration
	SubtitleParserResultModel result = SubtitleParser.ParseStream(fileStream, Encoding.UTF8, SubtitleFormatType.SubStationAlpha)
	// Try to parse with multiple parser using default configuration
	SubtitleParserResultModel result = SubtitleParser.ParseStream(fileStream, Encoding.UTF8, new[] { SubtitleFormatType.SubStationAlpha, SubtitleFormatType.LRC });
}

Specific parser (Advanced configurations)

You can also specify advanced configurations for parsers that support it.

// Get the format
SubtitleFormat format = SubtitleFormat.GetFormat(SubtitleFormatType.MicroDvd);
// Get the instance as a advanced parser
ISubtitlesParser<MicroDvdParserConfig> microDvdParserInstance = format.ParserInstance as ISubtitlesParser<MicroDvdParserConfig>;
// Parse
microDvdParserInstance.ParseStream(fileStream, Encoding.UTF8, new MicroDvdParserConfig() 
{
	Framerate = 30, // Force the parser to use a framerate of 30
});

Logging

SubtitlesParserV2 implements microsoft.extensions.logging.abstractions to allow you to redirect the log output to your own logging method (using a LoggerFactory)

Base example

// Assuming a LoggerFactory already exist
ILoggerFactory existingLoggerFactory = LoggerFactory.Create(builder =>
{
	builder.AddConsole(); // Adding the default console logging
});

// Set SubtitlesParserV2 LoggerFactory to the existing one
LoggerManager.LoggerFactory = existingLoggerFactory;

ASP.NET Core Websites

// Get the app loggerFactory
ILoggerFactory loggerFactory = app.Services.GetRequiredService<ILoggerFactory>();
LoggerManager.LoggerFactory = loggerFactory; // Redirect SubtitlesParserV2 logs to our LoggerFactory

Licenses / Acknowledgements

Current code is licensed (sublicensed as allowed per the original project MIT license) under the GNU Lesser General Public License v3.0 (LGPLv3).

⚠️ The original version, available here (link redirects you to the exact commit from which the project was forked, the commit history was discarded due to concerns about some files in the commit history.), is licensed under the original project made by AlexPoint, license/credits:

The MIT License (MIT)

Copyright (c) 2015

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.