This project has been permanently moved to gitlab. It will no longer be maintained here. Please, refer to gitlab repository for updates and new releases.

Bashnapi - napiprojekt.pl client

This script is a NapiProjekt client written in bash. Itautomatically downloads subtitles from napiprojekt.pl database basing on thevideo file.

This script works on Linux & OS X systems. It has very limited requirements andis mostly depending on bash (it is proven to run from bash 2.04 - which makesit ideal for embedded devices) and coreutils (which should be available on mostmodern systems, no Perl or Python is required).

Installation

Bashnapi uses cmake to build itself and install.Typical install procedure is very simple:

$ cd bashnapi
$ mkdir build && cd build
$ cmake ..
$ make && make install

Installation on embedded devices

In case you want to install bashnapi on a host which doesn't haveCMake, the procedure is very similar. Just install to a localdirectory and deploy that to your device. Below is an example:

$ cd bashnapi
$ mkdir build
$ cmake -DCMAKE_INSTALL_PREFIX=napi_install -DNAPI_INSTALL_PREFIX=/opt/napi ..
$ make && make install

bashnapi is now installed in the napi_install directory on your localmachine. Just deploy that to your device (with scp, ftp, or whatever youprefer) and add the path to a directory under /opt/napi/bin to yourPATH. The variables:

- `CMAKE_INSTALL_PREFIX` - defines the directory on the host to which napi
will be installed

- `NAPI_INSTALL_PREFIX` - defines the directory on the target to which napi
should be deployed

You can use any directory names, napi_install and /opt/napi have been pickedarbitrarily without any strict reason.

Dockerized application

napi.sh is available as well as a Dockerized application. In order to use itwith docker, just build the container image:

$ docker build -t napi .

Once it's built it can be used through docker:

$ docker run -v /media:/mnt -it napi scan /mnt

The above command maps the directory /media to a directory /mnt in thecontainer and invokes napi.sh scan action in container's /mnt.

Actions

Script functionality has been divided into actions. Each action implements aspecific request type. Available actions:

• scan - scan a directory (or a single file) and download subtitles for allfound video files,
• download - download subtitles using a "dc link"
• search - search for a movie
• subtitles - list subtitles for given movie

Each action has its own command set and its own help system as well so,

 $ napi.sh scan --help

... and

$ napi.sh download --help

... will produce different output. Try out help for different actions to learnabout how to use them and what do they do. Generic options, shared by allactions are listed in the global help:

$ napi.sh --help

Below are some usage examples

scan action

This action is the equivalent of napi 1.X versions behaviour. It goes eitherthrough given directories or media files and, creates a media file list andtries to download subtitles for all found media files.

Examples:

• Download subtitles for video_file.avi:

  $ napi.sh scan video_file.avi

• Iterate through all elements in current directory and try to downloadsubtitles for them. If directory contains subdirectories - than the script willalso iterate through all the files in subdirectories:

  $ napi.sh scan *

• Try to find and download subtitles for all files in movie_dir/ directory:

  $ napi.sh scan movie_dir/

• This will recursively search for video file in directories like:

  $ napi.sh scan dir1/ dir2/ dir3/ dir_other/

• It has file size limitation too ! Download subtitles for all supported videofiles which are bigger than 100 MB:

  $ napi.sh scan -b 100 *

• Not to mention that it integrates a separate subtitles converter writtencompletely in bash & awk. To download subtitles for all supported videofiles and convert them to subrip format on the fly, just use the -f option:

  $ napi.sh -f subrip *

download action (experimental)

This action can be used to download a selected subtitles from napiprojekt.plusing the subtitles id, which can be obtained from napiprojekt.pl site.

• Download subtitles having its hash/id:

  $ napi.sh download napiprojekt:06aec10a749a68403613b2af8b2c4db8

search action (experimental)

This action can be used to search for a given movie in napiprojekt.pl database.

• Search for movie "terminator":

  $ napi.sh search -k movie terminator$ napi.sh search "the big bang theory"

subtitles action (experimental)

This action can be used to list all the available subtitles for a given movietitle. It accepts the url to the movie page, typical work flow is as follows:

$ napi.sh search -k movie "lord of the rings"

...
00:0003 - Wyszukuje tytul: [hobbit]
29516 | Hobbit: Niezwykła podróż | http://napiprojekt.pl/napisy-29516-Hobbit-Niezwykła-podróż-(2012)
37789 | Hobbit: Pustkowie Smauga | http://napiprojekt.pl/napisy-37789-Hobbit-Pustkowie-Smauga-(2013)
44148 | Hobbit: Bitwa Pięciu Armii | http://napiprojekt.pl/napisy-44148-Hobbit-Bitwa-Pięciu-Armii-(2014)
162 | Hobbit | http://napiprojekt.pl/napisy-162-Hobbit-(1977)

$ napi.sh subtitles "http://napiprojekt.pl/napisy-29516-Hobbit-Niezwykła-podróż-(2012)"

...
00:0003 - Przetwarzam:  [http://napiprojekt.pl/napisy-29516-Hobbit-Niezwykła-podróż-(2012)]
Rozmiar:       2491657374 bajtow | fps: 29.534 | napiprojekt:f2bed6d99e5ecc9d7b2b3cb7c51c273e
Rozmiar:       1608081408 bajtow | fps: 29.534 | napiprojekt:1e81de9b83485336d2821d8dcfefb8bd
Rozmiar:       1742344634 bajtow | fps: 29.534 | napiprojekt:51f8741fc142f3ed80313544c728d9d4
Rozmiar:       1442403786 bajtow | fps: 29.534 | napiprojekt:ee4096dce1902ea5f985dc929c9a8479
Rozmiar:        782801208 bajtow | fps: 29.535 | napiprojekt:7fd27d9777eea21f7a2b92c10919c43c
...

The last call has returned a set of napiprojekt subtitles identifiers which canbe directly used to get subtitles:

$ napi.sh download napiprojekt:1e81de9b83485336d2821d8dcfefb8bd

You can specify more than one hash/id at once as well:

$ napi.sh download napiprojekt:51f8741fc142f3ed80313544c728d9d4 napiprojekt:ee4096dce1902ea5f985dc929c9a8479

subotage.sh

subotage.sh is a simple subtitles format converter bundled with napi.sh

Currently supported formats:

• mpl2
• tmplayer (most of the versions)
• subrip
• subviewer
• microdvd

Usage

The properly convert from/to microdvd format (or any other format based onframes) a valid information about input/output file frame rate isneeded! The default value (if not specified in the command line) is 23.98 fpsfor input/output.

Examples:

• Convert from microdvd 23.98 fps to subrip. Subrip is default output format soit doesn't have to be specified. The input frame rate is also equal to thedefault one, so no addition specification in the command line has been made.

  $ subotage.sh -i input_file.txt -o output_file.srt

• Convert from microdvd 25 fps to subviewer:

  $ subotage.sh -i input_file.txt -fi 25 -of subviewer -o output_file.sub

• Convert from subrip to mpl2

  $ subotage.sh -i input_file.srt -of mpl2 -o output_file.fab

• Convert from microdvd 25 fps to microdvd 29.98 fps:

  $ subotage.sh -i input_file.txt -fi 25 -fo 29.98 -of microdvd -o output_file.txt

Colaboration

bashnapi is an open project. Feel free to send patches and pull requests.Check the COLABORATION for more details.