Automatically download subtitles for your movies
Clone or download
Zerratar
Zerratar fix a bug, subtitles would not be downloaded for a video that was bei…
…ng used as it could not calculate the hash of that file.

fixed by using the filename as key instead of the hash, will have to give it some more thoughts for the future how to better solve this.

also make sure we redownload lost subtitles, even if the file has previously been flagged as synced.
Latest commit 3612a2a Jun 10, 2018

README.md

SubSync

Automatically download subtitles for your movies

I hope this little tool comes to help you out as much as it did for me. My girlfriend and I both struggled with using the VLC Sub add-on for downloading subtitles, a tool that we previously been using lots! And when that tool stopped working on later days, keep being unresponsive and continuesly crashing VLC, we had to manually look for those darn subtitles on the web and if you have a lot of shows to watch then its a huge pain in the ass.

SubSync is a tool that will keep your movies folder synchronized with subtitles. That means, if you add a video file to the folder or its sub-folders being watched a subtitle will automatically be downloaded for that movie.

It works by using the filename of the movie to determine the name and use that to do a search on subscene.com to find the "first best" subtitle to download. It will then extract the file (if its an archive) and rename it to have the same name as the movie file so it can be quickly recognized as a subtitle using VLC.

SubSync will also prefer a chosen language over the other, so for me I prefer Swedish but if that one does not exist I want English, you can set this as a startup argument.

Note: This tool was created with just a couple of hours so be aware that it may not always work perfectly. I do appreciate any problems you may stumble upon either code-wise or functionality when/or if testing this application out. Don't be afraid to add an issue!

Binaries

You can download the somewhat latest binaries from the release tab thingy https://github.com/zerratar/SubSync/releases

Mirror mirror on the wall http://www.shinobytes.com/files/SubSync-binaries-win32.zip

Building SubSync

Load up Visual Studio 2017, open SubSync.sln and hit CTRL+SHIFT+B like your life depends on it!

Running SubSync

SubSync.exe <input folder> [-lang <languages>] [-vid <video extensions>] [-sub <subtitle extensions>] [-delay <ms>] [-resync] [-resyncall] [-exit]

<input folder>: So this is the folder you want to watch, it will also watch all its subfolders.
                As an example: 'D:\Movies'

-lang
<languages>: A list of languages separated by a semi-colon. Example: swedish;english
             The priority of the languages is from left to right, so in this example if 
             a swedish translation subtitle is available it will take that one rather 
             than the english one.

             The value is just English per default.

-vid
<video extensions>: A list of video extensions to watch seperated by a semi-colon, just add
                    all you can think of. But this is an optional and default value is:
                    *.avi;*.mp4;*.mkv;*.mpeg;*.flv;*.webm

-sub
<subtitle extensions>: A list of recognizable subtitle files, formatted same way as video extensions
                       since I don't know of all possible extensions I've made this an optional parameter
                       to change which subtitles SubSync should recognize. The default value is:
                       *.srt;*.txt;*.sub;*.idx;*.ssa;*.ass

-delay
<ms>: If you want to have a delay between each request by a set of milliseconds you can use this flag. 
      This will then run all request sequential instead of concurrent which will take a lot longer to download
      all subtitles. However by adding a delay you have a greater chance of the server giving you a proper response
      and therefor can make the download more stable. 
      The value is set to 0 as default and therefor disabled.

-resync: Downloads subtitles for all your videos that has not been previously synchronized with SubSync
         regardless of whether they already have a subtitle file or not. 
         Warning: This will overwrite any existing subtitles you may already have.

-resyncall: As -resync, it downloads all subtitles again but this one also downloads all subtitles SubSync
            has previously flagged as synced.
            Warning: This will overwrite any existing subtitles you may already have.

-exit: If you don't want to keep SubSync running, you can have it automatically exit as soon as its done syncing
       your subtitles, remember this will exit even if there are no subtitles to sync.

In most cases you will probably only need to run it like this:

SubSync.exe "D:\My Awesome Movies\"

Or if you want to have your subtitles in another language (if one exists) and you're crazy enough to think you will want Latin before English.

SubSync.exe "D:\My Awesome Movies\" -lang spanish;japanese;latin;english

Now keep it running in the background. Its not going to hog up your cpu. Its pretty friendly, and you can be sure to have subtitles available for you whenever you need it!

Tips and tricks

Exiting Press 'q' at any time to exit SubSync. Or you can supply the argument --exit to automatically close SubSync down when its done downloading subtitles.

Retrying Press 'a' to try and re-sync any previously unsynced subtitles. Yes the subtitle downloads can randomly fail some times when the subtitle providers decides you shouldn't be downloading their subtitles too often.

ignoring videos There is a file called .vidignore, it is a list of 1 entry per row that is being used by SubSync to completely ignore a video and not download any subtitles for that particular video. This can be handy when SubSync keeps failing on some videos and you don't want it to keep trying.

The patterns are similar to .gitignore, but this only support wildcards.

Oh, and be sure to bring popcorns or your favorite snacks when watching your movies!

Known issues / To-dos

The OpenSubtitles provider ignore language priority.

Add support for http://www.yifysubtitles.com/

Changes

v0.1.6.2

Reworked the startup arguments and added an --exit flag that can be used to force quit SubSync after first sync.

v0.1.4

Add support for OpenSubtitles.org and is also now the default subtitle provider for SubSync. subscene.com will still be used but only if no subtitles were found on opensubtitles.org. Improved subtitle search algorithm, but only for OpenSubtitles.org right now. The subscene provider will be updated in a future version.

The opensubtitles.org provider has not been properly tested though, so there may still be some bugs that needs to be squished. But initial tests returned great results!

v0.1.3

Use Unicode encoding in the console to properly display all texts.

v0.1.2

Update the usage of all FileInfo and DirectoryInfo instances to use the ZetaLongPaths available from here https://github.com/UweKeim/ZetaLongPaths to fix the bug caused by too long paths.

v0.1.1

This version didn't like anyone.

v0.1.0

Initial release on GitHub, you know the magical first version