muvy 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a44e17f601ba5559adfa1cebee0d1757e2082e1d
-  data.tar.gz: 141c334bd2267b497661995dc933cb587bf674bf
+  metadata.gz: a23ddf9ae690a95cc698b7a66489f22fc2c1882e
+  data.tar.gz: d4b23e2d68e9a07b7fcf8316b9379e2bca7eff67
 SHA512:
-  metadata.gz: e171597cfd11434abd8adb192cbf1e4fa7d0fd1046b57b41f8c1087a87b57e6460e1d4d751b8996bd5e8da4bf9b29dd8f7ba8e2c7fcca7c68ce3d2f36a391f68
-  data.tar.gz: e8a6c56db10846b47697691e13abaad4b692a2acb1c48d5f421ccad96791a2c4cd616c34424ca015491c02de125fd3cd63b7c82770d3edec5795d704c94ade70
+  metadata.gz: ca700bb2aecd56aebd07c8063cf95528b65144a2cf6578fd7925ed9ef43f63faf44e0aab463afbfbd52b8859eda4ac0fce66e33f6e61c7af1499b9646e0c4189
+  data.tar.gz: 13802621595db0d591b5134a680008492b684e77d595c2f59e8a082bd592943bc864435373b35b3b5480ef2726c9bb2fadd1eed8296848bb54c8c7dccc0feccb

data/README.md

@@ -1,11 +1,13 @@
 <p align="center">
 
-<img src="https://i.imgur.com/Akc3Fh9.png" alt="muvy-header" />
+<a href="#examples"><img src="https://i.imgur.com/BTuglHv.png" alt="muvy-header" /></a>
+
+<br>
 
 </p>
 
 **muvy** is a simple Ruby movie barcode generator.  
-You can feed it a youtube video, phone gallery, or any locally stored video files. It pulls most of the frames out, moves around the colors, and throws them back together in a neat montage.
+You can feed it a youtube video, phone gallery, or any locally stored video files. It pulls the frames out, moves around the colors, and throws them back together in a neat montage.
 
 ------
 * [Install](#install)
@@ -18,21 +20,21 @@ You can feed it a youtube video, phone gallery, or any locally stored video file
 * [Examples](#examples)
 * [Troubleshooting](#troubleshooting)
 * [Links](#links)
-------
+
 
 ## Install
 
-### Notes
+### Changelog
 
-* Currently version 0.1.2, with many [features still planned](#features).
-* Not optimized for sites other than YouTube
+* Version 0.1.3
+  * Adds YouTube support. Not yet optimized for most other video sites.
+  * [Many features still planned](#features)!
 
 ### Getting Started
 
 #### macOS
-You can use `ffmpeg -v`, `convert -v`, or `youtube-dl --version` at the terminal to check if you already have the binaries.
-
-If you don't already have FFmpeg, ImageMagick, or youtube-dl installed, you can download all of them with [Homebrew](https://brew.sh/). With Homebrew, just bring up a terminal session and type:
+1. You can use `ffmpeg -v`, `convert -v`, or `youtube-dl --version` at the terminal to check if you already have the binaries.
+2. If you don't already have FFmpeg, ImageMagick, or youtube-dl installed, you can download all of them with [Homebrew](https://brew.sh/). With Homebrew, just bring up a terminal session and type:
 
 ```sh
 $ brew install ffmpeg
@@ -42,17 +44,17 @@ $ gem install muvy
 ```
 
 #### Windows
-1. You can [download Ruby here](https://rubyinstaller.org/).  
-2. You can download Windows binaries for [ImageMagick here](https://www.imagemagick.org/script/download.php#windows), **noting**:  
-  On the third installation window, [you need to check 2 boxes](https://i.imgur.com/d46sn8a.png):
+1. [Install Ruby](https://rubyinstaller.org/)  
+2. [Install Windows binaries for ImageMagick](https://www.imagemagick.org/script/download.php#windows), noting:  
+  On the third installation window, [check these 2 boxes](https://i.imgur.com/d46sn8a.png):
     - [x] Add application directory to your system path
     - [x] Install legacy utilities (e.g. convert)
-    - [ ] Keep 'Install FFmpeg' unchecked - IM's bundle doesn't include `ffprobe` & `ffplay`
-2. Grab [FFmpeg here](http://ffmpeg.zeranoe.com/builds/).
+    - [ ] Keep 'Install FFmpeg' unchecked. IM's bundle doesn't include `ffprobe` & `ffplay`
+2. [Install FFmpeg](http://ffmpeg.zeranoe.com/builds/)
 3. You'll have to manually edit your PATH environment variable [like in this tutorial](https://www.wikihow.com/Install-FFmpeg-on-Windows).
-Once you set up FFmpeg in the PATH, you need to move the ImageMagick folder from 'User Variables' to the first entry in the 'System Variables' PATH variable so that Windows prefers ImageMagick `convert` over its own 'convert.exe'. [Here's an image showing that process](https://i.imgur.com/cf4HvCb.png).  
+After setting up FFmpeg in the PATH, bring up the 'envrionment variables' window. Move the ImageMagick folder from 'User Variables' to the first entry in the 'System Variables' so that Windows prefers ImageMagick `convert` over its own 'convert.exe'. [Here's an image showing that process](https://i.imgur.com/cf4HvCb.png)  
 ImageMagick 7 replaced `convert` with `magick` on Windows, but this gem can't make use of that yet.
-4. Get [youtube-dl here](https://rg3.github.io/youtube-dl/download.html).   
+4. [Install youtube-dl](https://rg3.github.io/youtube-dl/download.html).   
 5. Then, you can install any gem like so:  
 ```sh
 $ gem install muvy
@@ -65,7 +67,7 @@ $ gem install muvy
 
 | Type   | Command: `muvy [Type] [Options]`                                    | Support                                                                                       |
 |--------|--------------------------------------------|-----------------------------------------------------------------------------------------------|
-| URL    | `muvy https://youtube.com/someVidID` | [youtube-dl sites](https://rg3.github.io/youtube-dl/supportedsites.html), but most fail |
+| URL    | `muvy https://youtube.com/someVidID` | [youtube-dl sites](https://rg3.github.io/youtube-dl/supportedsites.html), but many fail |
 | Local  | `muvy /Documents/Fave-Films/movie.mp4`  | [FFmpeg supported formats](https://www.ffmpeg.org/general.html#File-Formats)                                                      |
 | Folder | `muvy /Downloads/Phone-Backup-1/Photos`   | [ImageMagick supported formats](https://www.imagemagick.org/script/formats.php)                                                 |
 
@@ -76,54 +78,86 @@ $ gem install muvy
 Optionally specify the path where your final image will be saved.  
 **Default**: your present working directory
 
+<br>
+
 #### `-s, --style`
-Optionally specify currently supported styles: solid, stretch.  
-**Default**: solid
+Optionally specify currently supported styles.  
+**Styles**: `solid`, `stretch`  
+**Default**: `solid`
+
+<br>
 
 #### `-g, --gradient`
-Optionally add a gradient on top of the final image. You can choose one:
-```
-black:heavy black:medium black:light
-white:heavy white:medium white:light
-```
+Optionally add a gradient on top of the final image.   
+**Styles**:   
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`black:heavy` `black:medium` `black:light`   
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`white:heavy` `white:medium` `white:light`   
+**Default**: none
+
+<br>
+
+
+#### `-a, --arc`
+Arc all of the colored lines around the center point.   
+**Styles**: `circle`, `iris` (annulus)  
 **Default**: none
 
-#### `--arc`
-Pass `--arc` to wrap all of the lines around a center point. [See examples](#examples)  
+<br>
+
+
+#### `-r, --rotate`
+Pass to rotate the final image 90 degrees to draw horizontal lines, where the top is the 'start' of the media.   
+**Default**: none (vertical lines)  
+
+<br>
 
-#### `--rotate`
-Pass `--rotate` to rotate the final image 90 degrees, i.e. to draw horizontal lines,
-where the top is the 'start' of your media file.  
 
 #### `-h, --height`
 Optionally specify a custom height for the output image.
 
+<br>
+
+
 #### `--format`
-Optionally force the download quality for `youtube-dl`.  
-This command is currently best-suited to youtube. To see possible formats for other sites, type `youtube-dl -F <URL>` or see [youtube-dl docs on format selection](https://github.com/rg3/youtube-dl/blob/master/README.md#format-selection); however, even when specifying a suitable format, the script might fail to run.  
-This determines the height of your image when using `-s stretch` only if you didn't specify --height.  
-**Default**: 135 *(854x480 DASH at 24fps)*.
+Optionally force the download quality for `youtube-dl`.   
+Determines the height of your image when using `--style stretch` only if you didn't specify `--height`.  
+**Default**: `135` *corresponds to 854x480 DASH at 24fps*  
+
+
+This command is currently best-suited to YouTube. To see possible formats for other sites, type `youtube-dl -F <URL>` or see [youtube-dl docs on format selection](https://github.com/rg3/youtube-dl/blob/master/README.md#format-selection); however, even when specifying a suitable format, the script might fail to run.  
+
+
+<br>
+
 
 #### `--frame_rate`
 Optionally specify the amount of frames to extract per second from the media.  
-This determines the width of the image.  
+Determines the width of the image.  
+
 
 You should run `muvy [..]` without this option once and check the stats printout
 to get an idea of a better number.  
-For example, if the stats printout readsM "1.6 fps," passing `--frame_rate 3.2`
+For example, if the stats printout reads "1.6 fps," passing `--frame_rate 3.2`
 would double the amount of frames, lines, and subsequently the width.
 
 > Setting this to an unreasonable number might cause hundreds of thousands
 of files to be temporarily created in your system's temp files.
 
+<br>
+
+
 #### `--start` and `--end`
 Optionally specify starting and ending times for processing videos.  
-If you only specify one, the other will default (e.g. if you only give --end, start -> 0).
+If you only specify one, the other will default. For example, if you only pass `--end N`, start defaults to 0.
+
+<br>
+
 
 
 ### Features
 - Formats
   - [x] Accepts image galleries, local videos, and online videos
+    - [ ] Works with *any* size image folder (very large folders cause output issues)
     - [ ] Works with *any* youtube-dl supported site
     - [x] Specify start & end times for frame extraction
   - [ ] Accept music files
@@ -137,7 +171,7 @@ If you only specify one, the other will default (e.g. if you only give --end, st
   - [ ] Spotmap output, akin to 'QR' code
   - [ ] Slit scan output
   - [ ] 'Bedforms' output
-  - [ ] Stacked lines output, inspired by [Sol Lewitt's work](https://www.google.com/search?q=sol+lewitt&rlz=1C5CHFA_enUS757US757&source=lnms&tbm=isch&sa=X&ved=0ahUKEwjLjP7y5unWAhWb0YMKHcNQBhcQ_AUICigB&biw=1276&bih=680)
+  - [ ] Stacked lines output, inspired by [Sol Lewitt](https://www.google.com/search?q=sol+lewitt&rlz=1C5CHFA_enUS757US757&source=lnms&tbm=isch&sa=X&ved=0ahUKEwjLjP7y5unWAhWb0YMKHcNQBhcQ_AUICigB&biw=1276&bih=680)
     - [ ] Choose inset borders
     - [ ] Curvature
   - [ ] Crosshatch lines output
@@ -159,169 +193,210 @@ If you only specify one, the other will default (e.g. if you only give --end, st
 <div align="center">
 <img src="https://i.imgur.com/FpERYDO.png" />  
 <h4>Spirited Away (2001)</h4>
+
 `muvy film.mkv -h 300`  
+
 0.27 frames per second on 125 minutes  
 final resolution 2027x300  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/dpyoILD.png" />   
 <h4>Mad Max: Fury Road (2015)</h4>
+
 `muvy madden.mkv --end 01:52:50 -h 300`   
+
 0.276 frames per second on 120 minutes  
 final resolution 1868x300  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/ahDpJms.png" />
 <h4>The Grand Budapest Hotel (2014)</h4>
+
 `muvy "grand.avi" --end 01:33:40 --gradient black:medium --height 600`  
+
 0.303 frames per second on 100 minutes  
 final resolution 1703x600  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/pov6s07.png" />   
 <h4>Her (2013)</h4>
+
 `muvy film.mp4 -g black:medium -h 720`   
+
 0.269 frames per second on 126 minutes  
 final resolution 1919x720  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/JEHqHoG.png" />   
 <h4>Melancholia (2011)</h4>
+
 `muvy film.mp4 --gradient black:medium`   
+
 0.277 frames per second on 136 minutes  
 final resolution 2158x720  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/Up9SWKm.png" />  
 <h4>Kagemusha (1980)</h4>
+
 `muvy film.mp4 --style stretch --gradient black:medium`  
+
 0.225 frames per second on 162 minutes  
 final resolution 2439x688  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/j9yNVdN.png" />   
 <img src="https://i.imgur.com/OgOgnz0.png" />   
 <h4>Samsara (2011)</h4>
+
 (1) `muvy film.avi --end 01:35:00 -s stretch -g black:medium`  
-(2) `muvy "Samsara 2011 BRRip XviD AC3 - HDSi.avi" --height 150 --end 01:35:00`  
+
+
+(2) `muvy film.avi --height 150 --end 01:35:00`  
+
 0.3 frames per second on 95 minutes  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/7b7MWHX.png" />   
 <h4>Baraka (1992)</h4>
+
 `muvy film.avi --height 150 --end 01:30:30`   
+
 0.3 frames per second on 90 minutes   
 final resolution 1663x150  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/Q3ETqJT.png" />   
 <h4>It's Such A Beautiful Day (2012)</h4>
+
 `muvy film.mkv --height 200`   
+
 0.4843 frames per second on 62 minutes  
 final resolution 1780x720    
 </div>  
 
-<br><br>
+<br><br><br>
 
 ### YouTube
 
 <div align="center">
 <img src="https://i.imgur.com/V0ecs7s.png" />   
 <h4>Holi by Variable</h4>
+
 `muvy https://www.youtube.com/watch?v=r64Xk7c4Mr4 --frame_rate 10 --style stretch`   
+
 slow-motion youtube video   
 10 frames per second on 1 minute 47 seconds   
 final resolution 1073x480  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/F00eot2.png" />   
 <img src="https://i.imgur.com/rA2Ugr1.png" />     
 <h4>Mahalia - Sober by COLORS</h4>
+
 (1) `muvy https://www.youtube.com/watch?v=QK7JQl9jNzM --frame_rate 7.5 --start 0:05 --end 3:23 -h 200`  
+
+
 (2) `muvy https://www.youtube.com/watch?v=QK7JQl9jNzM --frame_rate 7.5 --start 0:05 --end 3:23 -s stretch`  
+
 7.5 frames per second on 3 minutes 36 seconds  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
-<img src="https://i.imgur.com/OMR4ffy.png?1" />
+<img src="https://i.imgur.com/OMR4ffy.png?1" height="240" />
 <h4>The Banach–Tarski Paradox by Vsauce</h4>
+
 `muvy https://www.youtube.com/watch?v=s86-Z-CbaHA`     
+
 0.62 frames per second on 24 minutes 14 seconds  
 final resolution 898x720  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://i.imgur.com/pdHnMQQ.png" />   
 <h4>Colors In Macro by Macro Room</h4>
+
 `muvy https://www.youtube.com/watch?v=gNbSjMFd7j4 --start 0:16 --end 2:07 --style stretch --frame_rate 10`     
+
 10 frames per second on ~ 2 minutes  
 final resolution 1110x480  
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
 <img src="https://image.ibb.co/g4WEVb/3.png" width="350" height="350" hspace="20" />
 <img src="https://image.ibb.co/eLRsGG/2.png" width="350" height="350" />    
 <h4>Ink In Motion by Macro Room</h4>
-(1) `muvy https://www.youtube.com/watch?v=BmBh0NNEm00 --start 0:37 --end 1:20 --frame_rate 10 -r -s stretch`       
-(2) `muvy https://www.youtube.com/watch?v=BmBh0NNEm00 --start 0:37 --end 1:20 --frame_rate 10 -r --arc`   
+
+(1) `muvy https://www.youtube.com/watch?v=BmBh0NNEm00 --start 0:37 --end 1:20 --frame_rate 10 -s stretch -a circle`       
+
+
+(2) `muvy https://www.youtube.com/watch?v=BmBh0NNEm00 --start 0:37 --end 1:20 --frame_rate 10 -r --arc circle`   
+
 </div>  
 
-<br><br>
+<br><br><br>
 
 <div align="center">
-<img src="https://preview.ibb.co/e49VLb/muvy_11_10_031219.png" width="300" height="300" />
-<h4>BBC Planet Earth II Episode 1</h4>
-`muvy episode.mp4 --arc -g black:light`    
-0.413 frames per second on 58 minutes  
-final resolution 1176x1176  
+<img src="https://image.ibb.co/b2GmbG/muvy_11_10_042756.png" width="350" height="350" hspace="20" />
+<img src="https://image.ibb.co/jQ08D6/muvy_16_10_225636.png" width="350" height="350" />    
+<h4>Speed Drawing</h4>
 
-<br><br>
+(1) `muvy https://www.youtube.com/watch?v=P3UozWhL6A0 --start 0:04 --end 04:45 --arc circle`     
+
+
+(2) `muvy https://www.youtube.com/watch?v=P3UozWhL6A0 --start 0:04 --end 04:45 --arc circle -r`   
 
-<img src="https://image.ibb.co/b2GmbG/muvy_11_10_042756.png" width="300" height="300" />
-<h4>Speed Drawing</h4>
-`muvy https://www.youtube.com/watch?v=P3UozWhL6A0 --start 0:04 --end 04:45 --arc`  
 1.7185 frames per second  
 final resolution 872x872  
 </div>  
 
-<br><br>
+<br><br><br>
 
 ### DCIM  
 
-TODO
+DCIM merging is currently a bit buggy in that it will create extra random lines if it's low on memory.
+
+<div align="center">
+<img src="https://i.imgur.com/0DbOO11.png" height="240" />
+<h4>2016 Travel</h4>
+
+`muvy imagefolder/`  
+
+2350 photos
+</div>  
 
 ## Troubleshooting
 

data/lib/muvy/cli.rb

@@ -23,14 +23,16 @@ module Muvy
         o.string  "-p", "--path", "Directory to save final images, " +
                   "\n\t\t\s\s\s\sDefault: your pwd → #{Dir.pwd}",
                   default: Dir.pwd
-        o.string  "-s", "--style", "Choose image style: solid, stretch " +
+        o.string  "-s", "--style", "Choose a style: solid, stretch " +
                   "\n\t\t\s\s\s\sDefault: solid",
                   default: "solid"
         o.string  "-g", "--gradient", "Add a gradient over the final image" +
                   "\n\t\t\s\s\s\sChoose one from: black:heavy black:medium black:light" +
                   "\n\t\t\s\s\s\s\t\t\s\s\s\s\swhite:heavy white:medium white:light" +
                   "\n\t\t\s\s\s\sDefault: none"
-        o.boolean "--arc", "Wrap all of the lines around a center point"
+        o.string  "-a", "--arc", "Wrap all of the lines around a center point" +
+                  "\n\t\t\s\s\s\sChoose a style: circle, iris" +
+                  "\n\t\t\s\s\s\sDefault: none"
         o.boolean "-r", "--rotate", "Image will have horizontal lines"
         o.integer "-h", "--height", "Custom height of the final image"
         o.string "--start", "Custom video start time"

data/lib/muvy/image.rb

@@ -98,7 +98,13 @@ module Muvy
           cmd << "-gravity" << "center"
           cmd << "+repage"
           cmd << "-virtual-pixel" << "Transparent"
-          cmd << "-distort" << "Arc" << "366"
+
+          if options[:arc] == "iris"
+            cmd << "-distort" << "Arc" << "363 0 540 180"
+          else
+            cmd << "-distort" << "Arc" << "363"
+          end
+
           cmd << options[:img]
         end
       end

data/lib/muvy/version.rb

@@ -1,3 +1,3 @@
 module Muvy
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muvy
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - agarun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: youtube-dl.rb