From 1bd028e22226dd25fe34d6649c8a43a1dffeb845 Mon Sep 17 00:00:00 2001
From: cubicibo <55701024+cubicibo@users.noreply.github.com>
Date: Sat, 17 Jun 2023 21:22:09 +0200
Subject: [PATCH] Update readme, push version.
---
README.md | 15 ++++++++-------
scenaristream/__metadata__.py | 2 +-
2 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 2708c60..7de60d7 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# ScenariStream
-Scenarist BD MUI+Elementary Stream <-> SUP, MNU conversion tool.
+Scenarist BD MUI+Elementary Stream <-> SUP, MNU conversion tool. (+ TextST)
## Brief
ScenariStream is a python utility to perform bidirectional conversion between proprietary Scenarist project files (MUI+xES) and raw stream files like SUP/PGS and MNU/IGS.
@@ -8,18 +8,19 @@ For example, this tool can convert custom SUP or IGS files so they can be import
## Limitations
- Timestamp wrap-around is not implemented/tested. You should not try to convert files with durarions longer than 5 hours.
-- TextST support is possible but voluntarily blocked. I don't know how are structured raw TextST stream files.
-- Only Scenarist MUI for graphic props are allowed (PGS, TextST, IGS…) but chances are other MUI assets (audio, video) can be converted too with some tweaks.
+- TextST support is limited and only unidirectional, from .TextST to TES+MUI project.
+- Only Scenarist MUI for graphic and text props are allowed (PGS, TextST, IGS…) but chances are other MUI assets (audio, video) can be converted too with some tweaks.
## Usage:
If you would just like the client without thinking:
`python3 client.py PARAMETERS -o output_file`
### Parameters
-`-s --stream ` – Input raw stream file (SUP-PGS or MNU-IGS).
-`-x --xes ` – Input Scenarist Elementary Stream file (PES or IES).
+`-s --stream ` – Input raw stream file (SUP-PGS, MNU-IGS or TextST (.textst)).
+`-x --xes ` – Input Scenarist Elementary Stream file (PES, IES or TES).
`-m --mui ` – Input Scenarist MUI file.
-`-o --output ` – Output file with extension. The format is inferred from the extension. For xES+MUI output, only the xES file should be specified, the MUI file is generated aside.
+`-o --output ` – Output file with extension. The format is inferred from the extension. For xES+MUI output, only the xES file should be specified, the MUI file is generated aside.
+`-t --textst` – Flag for TextST conversion.
### As a package
You can also install this utility as a Python package:
@@ -32,4 +33,4 @@ The user is responsible for using the proper extension when converting to Scenar
### Example usage
The command below converts a .SUP file to a PES+MUI Scenarist project.
`python3 client.py -s subtitles.sup -o ./project/subtitles.pes`
-In the project folder, subtitles.pes and subtitles.pes.mui will be created.
\ No newline at end of file
+In the project folder, subtitles.pes and subtitles.pes.mui will be created.
diff --git a/scenaristream/__metadata__.py b/scenaristream/__metadata__.py
index ab1a987..ee8cc74 100644
--- a/scenaristream/__metadata__.py
+++ b/scenaristream/__metadata__.py
@@ -26,7 +26,7 @@
__MAJOR = 0
__MINOR = 0
-__REV = 2
+__REV = 3
__version__ = '.'.join(map(str, [__MAJOR, __MINOR, __REV]))
__author__ = 'cubicibo'