Skip to content

Latest commit

 

History

History
146 lines (91 loc) · 4.91 KB

README.md

File metadata and controls

146 lines (91 loc) · 4.91 KB
Raw

** napiprojekt.pl client

This script is a napiprojekt.pl client written in bash. It automatically downloads subtitles from napiprojekt.pl database basing on the video file.

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

Usage example:

napi.sh video_file.avi

  • download subtitiles for video_file.avi

napi.sh *

  • iterate through all elements in current directory and try to download subtitles for them. If directory contains subdirectories - than the script will also iterate through all the files in subdirectories.

napi.sh movie_dir/

  • try to find and download subtitles for all files in movie_dir/ directory.

napi.sh dir*

  • try to download subtitles for all files inside directories which match to pattern dir*. So i.e. if you have those dirs on disk

dir1/ dir2/ dir3/

... and you'll call napi.sh dir* - it will go through all of them and try to download subtitles for all files inside of them.

napi.sh -b 100 *

  • download subtitles for all supported video files which are bigger than 100 MB.

napi.sh -f subrip *

  • download subtitles for all supported video files and convert them to subrip format on the fly ( requires subotage.sh to be installed as well ).

subotage.sh - universal subtitle format converter

Usage

The script is ment for embedded devices mostly which dont have any other interpreters installed besides bash, or the installation/compilation of perl/python is simply to much effort to spend. Currently supported convertion formats:

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

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

Examples

  1. Convert from microdvd 23.98 fps to subrip. Subrip is default output format so it doesnt have to be specified. The input frame rate is also equal to the default one, so no addition specification in the command line has been made.

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

  1. Convert from microdvd 25 fps to subviewer

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

  1. Convert from subrip to fab

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

  1. 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

Required External Tools

  • sed
  • cut
  • head
  • grep
  • awk
  • iconv (optional)
  • any of: ffmpeg/mediainfo/mplayer/mplayer2 (for fps detection - optional)
  • mktemp

To check if the listed tools are available in your system and their functionality meets the subotage.sh script requirements please use the attached test_tools.sh script.

Availability

napi.sh & subotage.sh are available in bundle in AUR - Arch Linux User Repository. The package is named bashnapi and can be installed through yaourt:

yaourt -S bashnapi

Instalation

AUTOMATIC

Use the install.sh script to copy napi.sh / subotage.sh to the bin directory (/usr/bin - bu default) and napi_common.sh library to a shared directory (/usr/share/napi - bu default). If you want to install into directories different than defaults specify them in install.sh invocation (USE ABSOLUTE PATHS ONLY).

Examples $ ./install.sh --bindir /bin --shareddir /shared - this will install napi.sh & subotage.sh under /bin and napi_common.sh under /shared/napi

or

$ ./install.sh --shareddir /my/custom/directory
- this will install napi.sh & subotage.sh under /usr/bin (default path) and napi_common.sh under /my/custom/directory/napi

########################################

MANUAL napi.sh & subotage.sh share some common code from napi_common.sh. Both of them are sourcing this file. Bellow is an example installation procedure given (executables under /usr/bin, libraries under /usr/shared/napi)

  1. Edit path to napi_common.sh in napi.sh & subotage.sh:

Search for a variable NAPI_COMMON_PATH

38	
39	# verify presence of the napi_common library
40	declare -r NAPI_COMMON_PATH=

and set it to /usr/shared/napi

38	
39	# verify presence of the napi_common library
40	declare -r NAPI_COMMON_PATH="/usr/shared/napi"

  1. Place the napi.sh & subotage.sh under /usr/bin:

    $ cp -v napi.sh subotage.sh /usr/bin

  2. Create the /usr/shared/napi directory and place the library inside of it:

    $ mkdir -p /usr/shared/napi $ cp -v napi_common.sh /usr/shared/napi

bashnapi bundle is now installed

Colaboration

napi.sh is an open project. Feel free to send patches and pull requests. When sending pull requests please develop you changes on the "dev" branch.