README
¶
mt
mt is a lightweight media thumbnailer. it aims to be a simple and fast alternative to outlayers awesome Video Contact Sheet
Download
you can download the latest version from githubs release page alternatively you can install mt from source as descibed down below
Installation from Source
mt uses depends on ffmpeg's libraries, so you'll need those installed (for windows you might want to have a look here)and then run:
go get github.com/mutschler/mt
go install github.com/mutschler/mt
if you'll have ffmpeg installed in a non standart directory you'll may have to use PKG_CONFIG_PATH variable like this:
LD_LIBRARY_PATH=/path/to/ffmpeg/lib/ PKG_CONFIG_PATH=/path/to//ffmpeg/lib/pkgconfig/ go build
Settings
Default Settings can be alternated via config files in JSON format, there are 3 directories in which the config can be saved:
/etc/mt/, $HOME/.mt/ and the current working directory
just create a file called mt.json in any of this locations to change the settings
to change settings on runtime you can either use the provided pflags (use mt --help for more info) or set environment Variables with the MT_ prefix:
mt --numcaps=20 myvideo.mkv will change the numcaps settings to 20 for this run only, so will MT_NUMCAPS=20 mt myvideo.mkv
since v 1.0.3-dev there is an option to save the current settings to a specified config file:
mt --save-config=/path/to/config.json
and load a custom config on runtime:
mt --config-file=/path/to/config.json
Available Config Options:
| name | default value | description |
|---|---|---|
| numcaps | 4 | number of screenshots to take |
| columns | 2 | how many columns should be used |
| padding | 5 | add a padding around the images |
| width | 400 | width of a single screenshot |
| height | 0 | height of a single screenshot |
| font_all | "Ubuntu.ttf" | Font to use for timestamps and header |
| font_size | 12 | font size |
| disable_timestamps | false | option to disable timestamp generation |
| timestamp_opacity | 1.0 | opacity of the timestamps must be from 0.0 to 1.0 |
| filename | {{.Path}}{{.Name}}.jpg | filename for the generated file |
| verbose | false | verbose logging |
| bg_content | "0,0,0" | RGB values for background color |
| from | "00:00:00" | starting timestamp |
| to | "00:00:00" | end timestamp |
| single_images | false | will create a single image for each screenshot |
| header | true | append a header with file informations |
| header_meta | false | append codec, bitrate and FPS to header |
| bg_header | "0,0,0" | header background color |
| fg_header | "255,255,255" | header font color |
| header_image | "" | absolute path to an image that should be added to the header |
| watermark | "" | absolute path to an watermark image that will be added to the middle image of the contact sheet |
| comment | "" | comment that will be added to the bottom-left of the header |
| watermark_all | "" | absolute path to an image that will be added to the bottom left corner of each image |
| filter | "none" | choose a filter to add to the thumbnails: "greyscale", "invert", "fancy", "cross" |
| skip_blank | false | try up to 3 times to skip a blank image (can slow down mt) |
| skip_blurry | false | try up to 3 times to skip a blurry image (can slow down mt) |
| sfw | false | EXPERIMENTAL nude detection |
| skip_existing | false | skip movie if there is already a jpg with the same name |
| overwrite | false | by default mt will increment the filename by adding -01 if there is already a jpg use --overwrite to overwrite the image instead |
| fast | false | makes mt faster a lot, but seeking will be more inacurate and may produce duplicate screens |
| webvtt | false | create a webvtt file for use with html5 video players |
| interval | 0 | creates a screencap every interval seconds, this overwrites numcaps |
| skip_credits | false | try to skip movie credits by cutting of 4 minutes or 10% of the length |
| webvtt | false | generate a webvtt file |
| blur_threshold | 62 | threshold for blur detection |
| blank_threshold | 85 | threshold for blank image detection |
| upload | false | upload the generated image |
| upload_url | "" | url to send the image to |
Upload Info
upload needs upload_url to be set as well. You'll need a simple script on the Server that saves the content of $_FILES["image"]
Uplad URL Example script:
<?php
if(isset($_FILES["image"])) {
$uploadfile = "yourFilename.jpg";
move_uploaded_file($_FILES['image']['tmp_name'], $uploadfile))
}
?>
please note that all those values are also available as runtime pflags just replace the _ with an - ex: single_images will get single-images
Usage
just run mt and provide any video file as args:
mt video.avi
Some of the settings can be changed through runtime flags provided directly to mt for more information just run mt --help
example:
more examples can be found in the example older
Documentation
¶
There is no documentation for this package.
Source Files