Skip to content

Commit

Permalink
Update readme, push version.
Browse files Browse the repository at this point in the history
  • Loading branch information
cubicibo committed Jun 18, 2023
1 parent fd47e5e commit 1bd028e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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`<br>

### Parameters
`-s --stream <file>` – Input raw stream file (SUP-PGS or MNU-IGS).<br>
`-x --xes <file>` – Input Scenarist Elementary Stream file (PES or IES).<br>
`-s --stream <file>` – Input raw stream file (SUP-PGS, MNU-IGS or TextST (.textst)).<br>
`-x --xes <file>` – Input Scenarist Elementary Stream file (PES, IES or TES).<br>
`-m --mui <file>` – Input Scenarist MUI file.<br>
`-o --output <file>` – 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 <file>` – 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.<br>
`-t --textst` – Flag for TextST conversion.

### As a package
You can also install this utility as a Python package:<br>
Expand All @@ -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.<br>
`python3 client.py -s subtitles.sup -o ./project/subtitles.pes`<br>
In the project folder, subtitles.pes and subtitles.pes.mui will be created.
In the project folder, subtitles.pes and subtitles.pes.mui will be created.
2 changes: 1 addition & 1 deletion scenaristream/__metadata__.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

__MAJOR = 0
__MINOR = 0
__REV = 2
__REV = 3

__version__ = '.'.join(map(str, [__MAJOR, __MINOR, __REV]))
__author__ = 'cubicibo'

0 comments on commit 1bd028e

Please sign in to comment.