Train your listening comprehension by rewriting your favorite movies' subs (with correction)

Pratiquez votre compréhension orale en retranscrivant les sous-titres de vos films favoris (inclut la correction)

ENGLISH

Description

This Lua extension for VLC enables you to practice your listening comprehension in a foreign language.

Assuming you have a copy of a movie/video file with a synced subtitle file (.srt) in original language (or at least in the same language as the audio track):

* Perroquet Subtitles for VLC "cuts" the movie in sequences
* In each sequence, you try to understand what is said in the movie and write your guess in the input field
* Perroquet compares what you guessed with the actual subbtitles and tells you when you were right
* You can replay sequences and get help when you are stuck

Improve your listening and writing abilities in many languages and on a very large variety of video and audio tracks!

Getting Started

Dependencies & Versions

V1.1
Tested with:
* VLC 3.0.14 Vetinari for Linux Ubuntu 18.04
* VLC 3.0.16 Vetinari for Windows

V1.0:
Tested with:
* VLC 3.0.8 Vetinari for Linux Ubuntu 18.04

Installing

Copy the perroquet.lua and perroquet_intf.lua files to the following folders (depends on your OS) :

Windows
All Users:
perroquet.lua in Program Files\VideoLAN\VLC\lua\extensions\
perroquet_intf.lua in Program Files\VideoLAN\VLC\lua\intf\
Current user: [not tested]
perroquet.lua in %APPDATA%\vlc\lua\extensions\
perroquet_intf.lua in %APPDATA%\vlc\lua\extensions\
Mac OS X [not tested]
All Users:
perroquet.lua in /Applications/VLC.app/Contents/MacOS/share/lua/extensions/
perroquet_intf.lua in /Applications/VLC.app/Contents/MacOS/share/lua/intf/
Current user:
perroquet.lua in /Users/%your_name%/Library/ApplicationSupport/org.videolan.vlc/lua/extensions/
perroquet_intf.lua in /Users/%your_name%/Library/ApplicationSupport/org.videolan.vlc/lua/intf/
Linux (you may have to `chmod 755` the files)
All Users:
perroquet.lua in /usr/lib/vlc/lua/playlist/ or /usr/share/vlc/lua/extensions/
perroquet_intf.lua in /usr/lib/vlc/lua/playlist/ or /usr/share/vlc/lua/intf/
Current user: [not tested]
perroquet.lua in ~/.local/share/vlc/lua/extensions/
perroquet_intf.lua in ~/.local/share/vlc/lua/intf/
Snap: (the number 2288 maybe different on your system)
perroquet.lua in ~/snap/vlc/2288/.local/share/vlc/lua/extensions/
perroquet_intf.lua in ~/snap/vlc/2288/.local/share/vlc/lua/intf/

Then open VLC and select `Perroquet Subtitles for VLC` in the `view` menu. Click on `SAVE` and restart VLC.

Executing program

Starting up
Assuming you movie file is "MOVIE_FILE.avi" (or .mkv, .mp4, etc.) and that you have a synced subtitles file "SUB_FOR_MOVIE_FILE.srt"
1) Open VLC and select `Perroquet Subtitles for VLC` in the `view` menu. Click on `SAVE` and restart VLC
2) Rename "SUB_FOR_MOVIE_FILE.srt" to "MOVIE_FILE.perroquet" or "MOVIE_FILE[ANY_CHARACTERS].perroquet"
3) Put the newly created "MOVIE_FILE.perroquet" file in the same folder as "MOVIE_FILE.avi"
4) Make sure no .srt file or subs file named like "MOVIE_FILE[ANY_CHARACTERS].srt" and in the same folder as "MOVIE_FILE.avi" (or subs will appear in VLC...)
5) Open "MOVIE_FILE.avi" with VLC
6) In the VLC toolbar, click on View , then on Perroquet Subtitles for VLC
7) A new gui (window) should open

Using
Then you should be able to do the following
1) The .perroquet file is loaded by default, consult the Help section if you have error or encoding problems
2) Pick a sequence with VLC or `<<` / `>>` buttons and click on `(Re)play`
3) Fill what you understand in the Input field and click on `Try!` button
4) Check in the field under `(Re)play` button what you got and missed. Click on `(Re)play` if you want to hear the sequence again
5) When you correctly write the sequence, VLC replays the sequence one last time and goes to the next sequence
6) If you are stuck, click on `Help!`

* Notes:
* Files like "MOVIE_FILE[ANY_CHARACTERS].perroquet.srt" are also accepted but you may have to deactivate the sub tracks in VLC interface.

Help

General
* The program supports several encodings for the subtitles (files encoded in ISO-8859-1, UTF-8 and UTF-8-SIG were successfully tested). Please let me know if your sub file is not supported.
* Although subtitle files seldom correspond exactly to the audio track, subs are almost always close enough to the track to still provide a good learning experience. Use the button `Help` when you feel the subs are different from the track.
* Subs for deafened or hard or hearing person are usually very good files to train. They may however enhance non-verbal sounds in the track, usually with "(...)" such as in "(Indistinct chatter)"

Subtitle files and settings:
* If you have several ".perroquet" files, select one of them in the drowdown list and click on `Load`
* If you have an error "Malformed subtitle...", try to change the default UTF-8 encoding to "UTF-8-SIG" or "ISO_8859-1-SIG" in the dedicated Dropdown menu. Then click on `Load`.
* If you have unrecognized/weird character such as � or ã, try to change the default UTF-8 encoding to "ISO_8859-1" in the dedicated Dropdown menu. Then click on `Load`
* If the sequence are too short or start too late (and you cannot hear the whole sequence), try to
* change the `Delay before` and `Delay After` (default to 1s) to a larger one
* manually change the synchronization with `g` and `h` key in VLC
* resync your original srt file with a dedicated tool

Other
If you want to deactivate the Perroquet_intf interface, go to Tools> Preferences and select "All" under `show settings` bullet. Then go to Interface> Main interface> Lua and delete the field `Lua interface`. Save and restart vlc.

Debugging

The program can be debugged by running VLC in verbose mode. Under linux this means:
vlc --verbose=2

Under windows: open VLC, then `ctrl+M` and change verbosity to 2.

FRANÇAIS

Présentation

Cette extension Lua pour VLC vous permet de pratiquer votre compréhension orale dans la/les langue(s) que vous apprenez.

A partir d'une copie d'une vidéo ou d'un film en votre possession et accompagné d'un fichier (.srt) de sous-titres synchronisé dans la langue originale (ou dans la même langue que la bande son) :

* Perroquet Subtitles for VLC "découpe" votre film en séquence
* Pour chaque séquence, vous écrivez ce que vous comprenez dans le champs "input"
* Perroquet compare ce que vous avez deviné avec les véritables sous-titres et vous aide a progresser.
* Vous pouvez rejouer les séquences et obtenir de l'aide quand vous êtes bloqués

Améliorez votre compréhension orale et votre orthographe dans de nombreux langages et sur un large panel de fichiers vidéos et audios !

Premiers pas

Versions

V1.1
Testé avec:
* VLC 3.0.14 Vetinari pour Linux Ubuntu 18.04
* VLC 3.0.16 Vetinari pour Windows

V1.0:
Testé avec:
* VLC 3.0.8 Vetinari pour Linux Ubuntu 18.04

Installation

Copier les fichiers perroquet.lua et perroquet_intf.lua dans les dossiers suivants (dépend de votre OS) :

Windows
Tous les utilisateurs :
perroquet.lua dans Program Files\VideoLAN\VLC\lua\extensions\
perroquet_intf.lua dans Program Files\VideoLAN\VLC\lua\intf\
Utilisateur : non testé
perroquet.lua dans %APPDATA%\vlc\lua\extensions\
perroquet_intf.lua dans %APPDATA%\vlc\lua\extensions\
Mac OS X non testé
Tous les utilisateurs :
perroquet.lua dans /Applications/VLC.app/Contents/MacOS/share/lua/extensions/
perroquet_intf.lua dans /Applications/VLC.app/Contents/MacOS/share/lua/intf/
Utilisateur :
perroquet.lua dans /Users/%your_name%/Library/ApplicationSupport/org.videolan.vlc/lua/extensions/
perroquet_intf.lua dans /Users/%your_name%/Library/ApplicationSupport/org.videolan.vlc/lua/intf/
Linux (il peut être nécessaire de `chmod 755` les fichiers)
Tous les utilisateurs :
perroquet.lua dans /usr/lib/vlc/lua/playlist/ or /usr/share/vlc/lua/extensions/
perroquet_intf.lua dans /usr/lib/vlc/lua/playlist/ or /usr/share/vlc/lua/intf/
Utilisateur :
perroquet.lua in ~/.local/share/vlc/lua/extensions/
perroquet_intf.lua in ~/.local/share/vlc/lua/intf/
Snap: (le numéro 2288 peut être différent sur votre machine)
perroquet.lua in ~/snap/vlc/2288/.local/share/vlc/lua/extensions/
perroquet_intf.lua in ~/snap/vlc/2288/.local/share/vlc/lua/intf/

Ouvrez ensuite VLC et sélectionnez `Perroquet Subtitles for VLC` dans le menu `Vue`. Cliquez sur `SAVE` and rédemarrez VLC.

Utilisation

Préparation
En supposant que le fichier vidéo s'apelle "MOVIE_FILE.avi" (ou .mkv, .mp4, etc.) et que vous disposez d'un fichier de sous-titres synchronisés "SUB_FOR_MOVIE_FILE.srt".
1) Ouvrez VLC et sélectionnez `Perroquet Subtitles for VLC` dans le menu `Vue`. Cliquez sur `SAVE` et redémarrez VLC
2) Renommez "SUB_FOR_MOVIE_FILE.srt" en "MOVIE_FILE.perroquet" ou "MOVIE_FILE[ANY_CHARACTERS].perroquet"
3) Vérifiez que le fichier "MOVIE_FILE.perroquet" se trouve dans le même dossier que "MOVIE_FILE.avi"
4) Assurez-vous qu'aucun fichier .srt ou de sous-titre nommé "MOVIE_FILE[ANY_CHARACTERS].srt" ou similaire ne soit dans le même dossier que le fichier "MOVIE_FILE.avi" (dans le cas contraire, les sous-titres apparaitront dans VLC...)
5) Ouvrez "MOVIE_FILE.avi" dans VLC
6) Dans le menu de VLC, cliquez sur Vue, puis sur Perroquet Subtitles for VLC
7) Une nouvelle fenêtre devrait s'ouvrir

Utilisation
Vous devriez alors pouvoir exécutez les actions suivantes
1) Le fichier .perroquet file est chargé par défaut, consultez la section "Aide" si vous rencontrez une erreur ou des problèmes d'encodage de caractères
2) Choisissez une séquence avec VLC ou avec les boutons `<<` / `>>` et cliquez sur `(Re)play`
3) Écrivez ce que vous comprenez dans le champs Input et cliquez sur le bouton `Try!`
4) Vérifiez dans le champs situé sous le bouton `(Re)play` ce que vous avez trouvé ou raté. Cliquez sur `(Re)play` si vous voulez écouter la séquence a nouveau
5) Quand vous avez correctement reproduit la séquence, VLC rejoue la séquence une dernière fois et poursuit avec la séquence suivante
6) Si vous êtes bloqué, cliquez sur `Help!`

* Remarques:
* Les fichiers comme "MOVIE_FILE[ANY_CHARACTERS].perroquet.srt" sont également acceptés mais vous devrez peut-être désactiver les sous-titres dans l'interface de VLC.

Aide

Remarques générales
* Le programme accepte plusieurs encodages de caractère dans les sous-titres (des fichiers encodés en ISO-8859-1, UTF-8 et UTF-8-SIG ont été testés avec succès)
* Bien que les fichiers de sous-titres correspondent rarement exactement à la bande son, ceux-ci sont dans leur vaste majorité suffisamment proches pour permettre une bonne expérience d'apprentissage. Utilise le bouton `Help` quand vous sentez que vous êtes bloqués
* Les sous-titres pour personnes sourdes et malentendantes sont généralement de très bons fichiers pour pratiquer. Ces derniers peuvent cependant transcrire des sons non verbaux, généralement mis en évidence par des "(...)"

Fichiers de sous-titres et configurations:
* Si vous avez plusieurs fichiers ".perroquet" files, sélectionnez l'un d'entre eux dans la liste déroulante puis cliquez sur `Load`
* Si vous avez une erreur du type "Malformed subtitle...", essayez de modifier l'encodage par défaut UTF-8 en "UTF-8-SIG" ou "ISO_8859-1-SIG" dans la liste déroulante. Puis cliquez sur `Load`.
* Si vous voyez des caractères mal encodés tels que � or ã, essayez de changer l'encodage par défaut UTF-8 en "ISO_8859-1" dans la liste déroulante. Puis cliquez sur `Load`
* Si la séquence est trop courte ou commence trop tard (et que vous ne pouvez pas entendre la séquence complète), essayez de
* Changer les paramètres `Delay before` et `Delay After` (par défaut à 1s) par des valeurs plus grandes
* Changer manuellement la synchronisation dans VLC avec les touches `g` and `h` dans VLC
* Resynchroniser votre fichier .srt original avec un outil adéquat.

Autres
Si vous voulez désactiver l'interface Perroquet_intf, allez dans Outils> Préférences et sélectionnez "Tous" dans `Afficher les paramètres`. Puis allez dans Interface> Interfaces Principales et effacez le champs `Interface Lua`. Enregistrez et redémarrez VLC.

Débugage

Le programme peut être debugé en démarrant VLC en mode verbose. Sous Linux cela donne:

vlc --verbose=2

Sous windows: ouvrez VLC, puis `ctrl+M` et changez la "verbosity" à 2.

MISCELLANEOUS

Author

Gaspard DOUXCHAMPS

Version History

* 1.1
* Tested and corrected for Windows
* Solved the freeze problem
* Readme in French

* 1.0
* Initial Release tested on linux

* Main possible improvements:
* Support and test srt file for better compatibility
* Implement color code when "input" is getting close to "correction"

License

This project is licensed under the GNU GPL v3 License - see the LICENSE.md file for details

Acknowledgments

Inspiration :
* Perroquet Team and Fred Bertolus for the original software Perroquet (https://launchpad.net/perroquet)

Code snippet :
* The `Perroquet.lua` script was adapted from the "Subtitle Word Search" add-on by Tomás Crespo (https://github.com/tcrespog/vlc-subtitle-word-search/)
* The `Time v3.2` script by Mederi was adapted for the version 1.1 (https://addons.videolan.org/p/1154032/)