Skip to content
Extraits de code Groupes Projets
Valider 082ad229 rédigé par Seipas's avatar Seipas
Parcourir les fichiers

README : markdown and typo

parent 42a615ce
Aucune branche associée trouvée
Aucune étiquette associée trouvée
Aucune requête de fusion associée trouvée
...@@ -9,6 +9,7 @@ How to build it ? ...@@ -9,6 +9,7 @@ How to build it ?
- Install `ocamlc`, `ocamllex` and `ocamlyacc` - Install `ocamlc`, `ocamllex` and `ocamlyacc`
- Run `make` - Run `make`
If you want to built it by hand, here is what `make build` does : If you want to built it by hand, here is what `make build` does :
```sh ```sh
...@@ -34,6 +35,8 @@ ocamlc -c epitass.ml ...@@ -34,6 +35,8 @@ ocamlc -c epitass.ml
ocamlc -o epitass str.cma tree_toyunda_raw.cmo parser_toyunda_raw.cmo lexer_toyunda_raw.cmo tree_v4p_ass.cmo toyunda_raw_to_v4p_ass.cmo epitass.cmo ocamlc -o epitass str.cma tree_toyunda_raw.cmo parser_toyunda_raw.cmo lexer_toyunda_raw.cmo tree_v4p_ass.cmo toyunda_raw_to_v4p_ass.cmo epitass.cmo
``` ```
How to use it ? How to use it ?
============== ==============
...@@ -55,36 +58,51 @@ Example : ...@@ -55,36 +58,51 @@ Example :
./epitass -video Nichijou-OP1-Kakakaka-Kataomoi-C.avi -framerate 25 -o Nichijou-OP1-Kakakaka-Kataomoi-C.ass Nichijou-OP1-Kakakaka-Kataomoi-C.txt ./epitass -video Nichijou-OP1-Kakakaka-Kataomoi-C.avi -framerate 25 -o Nichijou-OP1-Kakakaka-Kataomoi-C.ass Nichijou-OP1-Kakakaka-Kataomoi-C.txt
``` ```
What are those formats ? What are those formats ?
============== ==============
ASS and Toyunda are formats used to give subtitles to a video. These subtitles can be karaoke subtitles, showing which syllable is voiced when. ASS and Toyunda are formats used to give subtitles to a video. These subtitles can be karaoke subtitles, showing which syllable is voiced when.
ASS ASS
-------------- --------------
SSA/ASS stands for Sub Station Alpha. It's a format used by the programs SubStation Alpha and Aegisub. SSA/ASS stands for Sub Station Alpha. It's a format used by the programs SubStation Alpha and Aegisub.
Modern Players can usually read those files without modifications. Modern Players can usually read those files without modifications.
EpitASS use the same format as Aegisub. For more informations : EpitASS use the same format as Aegisub. For more informations :
http://docs.aegisub.org/3.2/Main_Page/ http://docs.aegisub.org/3.2/Main_Page/
https://www.matroska.org/technical/specs/subtitles/ssa.html https://www.matroska.org/technical/specs/subtitles/ssa.html
Toyunda Toyunda
-------------- --------------
Toyunda is a format used by members of Epitanime, the anime club of French private engineering school Epita, hence the name of this program. Toyunda is a format used by members of Epitanime, the anime club of French private engineering school Epita, hence the name of this program.
In order to read those files, you have to install a plugin to your player. In order to read those files, you have to install a plugin to your player.
In addition to not being compatible, it may not be very flexible, lack functionnalities, and have technical problems, so you may want to convert your files in ASS format. In addition to not being compatible, it may not be very flexible, lack functionnalities, and have technical problems, so you may want to convert your files in ASS format.
Documentation can be found here : https://sites.google.com/site/stoyunda/documentation/format-raw Documentation can be found here : https://sites.google.com/site/stoyunda/documentation/format-raw
A Toyunda file contains several subtitles one for each line in the file, each subtitle having a start frame, end frame, options, and several lines, each line having a number of "pipes" (representing line breaks), options, and text. Usually, each subtitle have only one line. Options can be colors, size or positioning. On top of that, there is special lines containing -usually- only spaces and one 'ÿ' character. We'll call those lines "ylines", they represent when a syllable is played during the karaoke. A Toyunda file contains several subtitles one for each line in the file, each subtitle having a start frame, end frame, options, and several lines, each line having a number of "pipes" (representing line breaks), options, and text. Usually, each subtitle have only one line. Options can be colors, size or positioning. On top of that, there is special lines containing -usually- only spaces and one 'ÿ' character. We'll call those lines "ylines", they represent when a syllable is played during the karaoke.
Usually, one does not write a raw toyunda file by hand : they write a .lyr and a .frm, and use a compiler to convert them into a raw toyunda file. Usually, one does not write a raw toyunda file by hand : they write a .lyr and a .frm, and use a compiler to convert them into a raw toyunda file.
If you have those two files, you can convert them into a ASS file using a Ruby script called toyundagen2ass.rb If you have those two files, you can convert them into a ASS file using a Ruby script called toyundagen2ass.rb
This program is intended to focus on the case where you don't have those files. This program is intended to focus on the case where you don't have those files.
There are several versions of toyunda files : There are several versions of toyunda files :
- v1 don't have options, they are really simple : one subtitle/line by line of text shown in the end result. - v1 don't have options, they are really simple : one subtitle/line by line of text shown in the end result.
- v2 have options, and each shown line in the end is in fact splitted between different subtitles/lines inside the file : one for fade in, three for each syllable (before-syllable-text in one color, syllable-text in another color, after-syllable-text in a third color), and one for fade-out. - v2 have options, and each shown line in the end is in fact splitted between different subtitles/lines inside the file : one for fade in, three for each syllable (before-syllable-text in one color, syllable-text in another color, after-syllable-text in a third color), and one for fade-out.
- v3 and mikomi-generated : those files include .lyr and .frm files in comments. That means you can use toyundagen2ass.rb. EpitASS can be used on those files, but the result is not garantied. - v3 and mikomi-generated : those files include .lyr and .frm files in comments. That means you can use toyundagen2ass.rb. EpitASS can be used on those files, but the result is not garanteed.
Assumptions and possibly unwanted behaviour Assumptions and possibly unwanted behaviour
......
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter