d-streamio-ffmpeg 3.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a981303075790fd07460a42f62b562b6e05f59dd377a34252ce90d3e55ef3bb
+  data.tar.gz: 5610658999c6811facecc0c8e5288dcbda6d31813b83d80cead6afddbb571183
+SHA512:
+  metadata.gz: 1752b2bf0e09e9695d47b1c0aab552e4c93d45f5b2ca190b11bfe62f815f2cf8e56aa46bfd3f41ed112e5401b08a8d26ca9ef9fcb6b17a84c7ca552192abbf03
+  data.tar.gz: 8ac71feee27b6a73162af2dfdfb6674f7fbd5a9cb56c84ed648b31690e60be9126675c3a6ba255067d8d01cd29763f47b565c5e3438ed2fcf1a58e593a0d9e68

data/CHANGELOG

@@ -0,0 +1,263 @@
+== Master
+
+Current with 3.0.2
+
+== 3.0.2 2016-11-18
+
+Improvements:
+* Issue #153 Adds support for multiple audio streams
+* Issue #150 Does not trust reported SAR/DAR as these may not be defined per https://trac.ffmpeg.org/ticket/3798
+
+== 3.0.1 2016-11-10
+
+Improvements:
+* Issue #144 is fixed. Of a nil movie is presented to transcode, the progress block does not fail
+* Issue #145 Adds ability to follow URLs when presented as Movie inputs
+
+
+== 3.0.0 2016-09-07
+
+Breaking Changes:
+* Changes: custom parameters now specified using an array syntax
+
+Improvements:
+* Issue # 128, #137 are fixed (custom parameters passed as strings) which was caused
+  by 2.1.0 in attempting to avoid the use of shell and filename escaping issues
+  on various platforms.
+
+
+== 2.1.0 2016-08-08
+
+New:
+* Issue #135, Support creating slideshows from stills
+* Issue #130, Adds support for a URL as an input
+* Support for specifying options to apply to the input file
+* Improved support for calling  FFMpeg with popen3, improving compatibility with various platforms, including windows
+* Issue #111. uses attr_accessor for the timeout attribute
+* Exposes the movie's entire meta data and format tags as movie attributes
+* Issue #122, adds encoding fix to stderr
+* All specs pass and brought current with Rspec V3
+* Issue #123, #131 improved stream validation, ignoring additional invalid streams if a valid stream is recognized
+* Issue #124, improved parsing for moving creation_time
+* SAR and DAR now adapt after rotation, DAR is ignored when calculating dimensions
+
+Improvements:
+* Allow parenthesis in colorspace (thanks walterdavis for initial code and rociiu for finding a bug with it)
+* Width and height now switched if video is filmed in portrait mode. ffmpeg 2.7 or later now automatically rotates output
+* Movie metadata now provided with ffprobe (#114). Thanks to Ryan Lovelett for the contributions!
+* Ability to create multiple screenshots at consistent intervals in one pass (#113)
+
+== 2.0.0 2016-01-14
+
+New:
+* Support watermarking (thanks smoothdvd)
+* Bumped target ffmpeg version to 2.8
+
+Improvements:
+* Allow parenthesis in colorspace (thanks walterdavis for initial code and rociiu for finding a bug with it)
+* Width and height now switched if video is filmed in portrait mode. ffmpeg 2.7 or later now automatically rotates output
+* Movie metadata now provided with ffprobe (#114). Thanks to Ryan Lovelett for the contributions!
+* Ability to create multiple screenshots at consistent intervals in one pass (#113)
+
+== 1.0.0 2013-07-08
+
+New:
+* Bumped target ffmpeg version to 1.2.1
+
+Improvements:
+* Simpler implementation for timeouts.
+  Should be far less cpu and memory dependent (don't spawn a thread for every line of output)
+  Timeout spec now passes in Rubinius (using 1.9 mode)
+* Give helpful error message for windows users lacking the win32-process gem (thanks casoetan)
+* Add Movie#container (thanks vitalis)
+* Support vprofile and preset encoding options (thanks vitalis)
+
+Changes:
+* Default timeout lowered to 30 seconds
+
+Bugs:
+* Avoid crash if asking for frame_rate of a video without video stream (thanks squidarth)
+* Fix crash when doing audio transcoding on ffmpeg >= 1.0.1 (thanks vitalis)
+
+Deprecations:
+* Removed support for Ruby 1.8
+* Removed support for ffmpeg 0.7
+
+Refactorings:
+* Quite a few, see commit history for details.
+
+== 0.9.0 2012-07-24
+
+New:
+* Bumped target ffmpeg version to 0.11.1
+* Add hung process detection with configurable timeout (thanks stakach)
+* Raise FFMPEG::Error instead of generic RuntimeError on failed transcodings
+* Movie#screenshot for more intuitive screenshotting (README has details)
+* Movie#creation_time and Movie#rotation attributes when metadata is available (thanks Innonate)
+
+Bugs:
+* Fixed too many open files bug (thanks to akicho8)
+* Fixed missing path escaping (thanks to mikesager)
+* Fixed README typo (thanks to Linutux)
+* Files outputing "could not find codec parameters" are now recognized as invalid
+
+Deprecations:
+* Removed Movie#uncertain_duration?
+* Removed all the deprecated crop options (use :custom => '-vf crop=x:x:x:x' if you need it)
+
+Refactorings:
+* Removed the deprecated duration validation code
+* Polish on the transcoder class
+* Polish on the spec suite
+
+== 0.8.5 2011-03-05
+
+* If a clip has a DAR that doesn't make sense fall back to calculating aspect ratio from dimensions
+* Allow filenames with single quote characters (thanks to youpy)
+
+== 0.8.4 2011-11-30
+
+* Duration now one decimal more accurate (thanks to Russel Brooks)
+* Added encoding option seek_time (thanks to Misty De Meo)
+
+== 0.8.3 2011-09-01
+
+* Parameters now come in the order of codecs, presets, others so that we can override the presets
+* Added encoding option keyframe_interval to set number of frames between i-frames (aka GOP size)
+* Streamio (sponsor of this project) have launched new awesome pricing @ http://streamio.com
+
+== 0.8.2 2011-08-19
+
+* Path to ffmpeg binary can now be specified (thanks jonathandean)
+* If ffmpeg output contains "is not supported" the Movie will be considered invalid
+
+== 0.8.1 2011-07-28
+
+* Fix progress yielding with ffmpeg 0.8
+* Updated specs to pass with ffmpeg 0.8
+
+== 0.8.0 2011-05-26
+
+* Duration is now ALWAYS considered uncertain (we've noticed that ffmpeg is not always correct)
+* This means that the duration check will normally never run (unless you manually hack @uncertain_duration to false)
+* Movie#audio_channels now returns nil if there is no audio stream (instead of crashing)
+* Development: Use Bundler
+* Development: Update RSpec to 2.6
+
+== 0.7.8 2011-04-04
+
+* Fixed number of audio channels on files with 5.1 audio
+
+== 0.7.7 2011-02-01
+
+* Movies with starttime are now considered as having uncertain duration as its behavior is not consistent across formats
+* Upgrade development environment to RSpec 2.4
+
+== 0.7.6 2011-01-14
+
+* Another ruby 1.9 encoding fix
+
+== 0.7.5 2011-01-14
+
+* Fixed some ruby 1.9 issues
+* Added Movie#video_bitrate and Movie#audio_bitrate (thanks to mbj)
+
+== 0.7.4 2010-12-07
+
+* Fixed broken duration on movies with start times over 0 by reducing duration with start-time
+
+== 0.7.3 2010-08-26
+
+* Replaced Jewler with simple dynamic gemspec file
+* Spec files now not in published gem to make it a lot smaller in size
+* Full output from ffmpeg command in error raised during transcoding
+
+== 0.7.2 2010-08-11
+
+* Added encoding option duration
+* Avoid crashing when ffmpeg can't find resolution of a movie
+
+== 0.7.1 2010-07-08
+
+* Make sure preset parameters are always put last to avoid them ending up before any codec assignments
+* Testing against a fresh ffmpeg build (r24069)
+
+== 0.7.0 2010-07-07
+
+* Support for ffpresets through video_preset, audio_preset and file_preset encoding options
+* Added encoding option video_bitrate_tolerance
+
+== 0.6.8.1 2010-07-06
+
+* Bugfix - aspect ratio was not calculated properly on movies with no DAR
+
+== 0.6.8 2010-07-06
+
+* Don't use encoding options with nil values
+* Added encoding options video_max_bitrate, video_min_bitrate and buffer_size for constant bitrate encoding
+
+== 0.6.7 2010-06-10
+
+* Bugfix - aspect ratio preserver could suggest non even resolutions in certain circumstances
+
+== 0.6.6 2010-06-10
+
+* Transcodings to .jpg and .png will now work as they will skip duration validation
+
+== 0.6.5 2010-05-19
+
+* Movie#size method to get file size.
+
+== 0.6.4 2010-05-12
+
+* Ruby 1.9 compatibility fix for EncodingOptions (thanks michalf!)
+
+== 0.6.3 2010-05-05
+
+* Use DAR to calculate aspect ratio if available
+
+== 0.6.2 2010-05-05
+
+* Added Movie#uncertain_duration? which is true if ffmpeg is guessing duration from bitrate
+* Skipping the transcoders duration validation if original file has uncertain duration
+* Made sure aspect ratio preservation always rounds new size to an even number to avoid "not divisible by 2" errors
+* Changed Movie#valid? logic to accept any movie with either a readable audio or video stream
+
+== 0.6.0 2010-05-04
+
+* Cropping options now handled by EncodingOptions (croptop, cropbottom, cropleft and cropright)
+* Aspect ratio parameter calculated and added by default
+* Added transcoder options to preserve original aspect ratio on width or height
+
+== 0.5.0 2010-04-28
+
+* Added logging capabilities
+
+== 0.4.3 2010-04-06
+
+* Correctly identify invalid movies on latest ffmpeg build (r22811)
+
+== 0.4.2 2010-04-06
+
+* Escape the path to handle spaces in filenames and avoid CLI injection attacks (thanks J. Weir!)
+
+== 0.4.1 2010-02-10
+
+* Forgot to change the transcoding shortcut from Movie
+
+== 0.4.0 2010-02-10
+
+* Transcoding API changed to make use of more humanly readable options (see README for examples)
+* Fixed frame rate parsing for integer frame rates
+
+== 0.3.0 2010-02-07
+
+* Simple transcoding
+
+== 0.2.0 2010-02-06
+
+* Some more metadata parsing
+
+== 0.1.0 2010-02-05
+
+* Some basic parsing of metadata added

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Streamio AB
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,286 @@
+Streamio FFMPEG
+===============
+
+[![Code Climate](https://codeclimate.com/github/streamio/streamio-ffmpeg/badges/gpa.svg)](https://codeclimate.com/github/streamio/streamio-ffmpeg)
+
+Simple yet powerful wrapper around the ffmpeg command for reading metadata and transcoding movies.
+
+All work on this project is sponsored by the online video platform [Streamio](http://streamio.com).
+
+[![Streamio](http://d253c4ja9jigvu.cloudfront.net/assets/small-logo.png)](http://streamio.com)
+
+Installation
+------------
+
+    gem install streamio-ffmpeg
+
+Compatibility
+-------------
+
+### Ruby
+
+Only guaranteed to work with MRI Ruby 1.9.3 or later.
+Should work with rubinius head in 1.9 mode.
+Will not work in jruby until they fix: http://goo.gl/Z4UcX (should work in the upcoming 1.7.5)
+
+### ffmpeg
+
+The current gem is tested against ffmpeg 2.8.4. So no guarantees with earlier (or much later) 
+versions. Output and input standards have inconveniently changed rather a lot between versions 
+of ffmpeg. My goal is to keep this library in sync with new versions of ffmpeg as they come along.
+
+On macOS: `brew install ffmpeg`.
+
+Usage
+-----
+
+### Require the gem
+
+``` ruby
+require 'streamio-ffmpeg'
+```
+
+### Reading Metadata
+
+``` ruby
+movie = FFMPEG::Movie.new("path/to/movie.mov")
+
+movie.duration # 7.5 (duration of the movie in seconds)
+movie.bitrate # 481 (bitrate in kb/s)
+movie.size # 455546 (filesize in bytes)
+
+movie.video_stream # "h264, yuv420p, 640x480 [PAR 1:1 DAR 4:3], 371 kb/s, 16.75 fps, 15 tbr, 600 tbn, 1200 tbc" (raw video stream info)
+movie.video_codec # "h264"
+movie.colorspace # "yuv420p"
+movie.resolution # "640x480"
+movie.width # 640 (width of the movie in pixels)
+movie.height # 480 (height of the movie in pixels)
+movie.frame_rate # 16.72 (frames per second)
+
+movie.audio_stream # "aac, 44100 Hz, stereo, s16, 75 kb/s" (raw audio stream info)
+movie.audio_codec # "aac"
+movie.audio_sample_rate # 44100
+movie.audio_channels # 2
+
+# Multiple audio streams
+movie.audio_streams[0] # "aac, 44100 Hz, stereo, s16, 75 kb/s" (raw audio stream info)
+
+movie.valid? # true (would be false if ffmpeg fails to read the movie)
+```
+
+### Transcoding
+
+First argument is the output file path.
+
+``` ruby
+movie.transcode("tmp/movie.mp4") # Default ffmpeg settings for mp4 format
+```
+
+Keep track of progress with an optional block.
+
+``` ruby
+movie.transcode("movie.mp4") { |progress| puts progress } # 0.2 ... 0.5 ... 1.0
+```
+
+Give custom command line options with an array.
+
+``` ruby
+movie.transcode("movie.mp4", %w(-ac aac -vc libx264 -ac 2 ...))
+```
+
+Use the EncodingOptions parser for humanly readable transcoding options. Below you'll find most of the supported options.
+Note that the :custom key is an array so that it can be used for FFMpeg options like
+`-map` that can be repeated:
+
+``` ruby
+options = {
+  video_codec: "libx264", frame_rate: 10, resolution: "320x240", video_bitrate: 300, video_bitrate_tolerance: 100,
+  aspect: 1.333333, keyframe_interval: 90, x264_vprofile: "high", x264_preset: "slow",
+  audio_codec: "libfaac", audio_bitrate: 32, audio_sample_rate: 22050, audio_channels: 1,
+  threads: 2, custom: %w(-vf crop=60:60:10:10 -map 0:0 -map 0:1)
+}
+
+movie.transcode("movie.mp4", options)
+```
+
+The transcode function returns a Movie object for the encoded file.
+
+``` ruby
+transcoded_movie = movie.transcode("tmp/movie.flv")
+
+transcoded_movie.video_codec # "flv"
+transcoded_movie.audio_codec # "mp3"
+```
+
+Aspect ratio is added to encoding options automatically if none is specified.
+
+``` ruby
+options = { resolution: "320x180" } # Will add -aspect 1.77777777777778 to ffmpeg
+```
+
+Preserve aspect ratio on width or height by using the preserve_aspect_ratio transcoder option.
+
+``` ruby
+widescreen_movie = FFMPEG::Movie.new("path/to/widescreen_movie.mov")
+
+options = { resolution: "320x240" }
+
+transcoder_options = { preserve_aspect_ratio: :width }
+widescreen_movie.transcode("movie.mp4", options, transcoder_options) # Output resolution will be 320x180
+
+transcoder_options = { preserve_aspect_ratio: :height }
+widescreen_movie.transcode("movie.mp4", options, transcoder_options) # Output resolution will be 426x240
+```
+
+For constant bitrate encoding use video_min_bitrate and video_max_bitrate with buffer_size.
+
+``` ruby
+options = {video_min_bitrate: 600, video_max_bitrate: 600, buffer_size: 2000}
+movie.transcode("movie.flv", options)
+```
+
+### Specifying Input Options
+
+To specify which options apply the input, such as changing the input framerate, use `input_options` hash
+in the transcoder_options.
+
+``` ruby
+movie = FFMPEG::Movie.new("path/to/movie.mov")
+
+transcoder_options = { input_options: { framerate: '1/5' } }
+movie.transcode("movie.mp4", {}, transcoder_options)
+
+# FFMPEG Command will look like this:
+# ffmpeg -y -framerate 1/5 -i path/to/movie.mov movie.mp4
+```
+
+### Overriding the Input Path
+
+If FFMPEG's input path needs to specify a sequence of files, rather than a path to a single movie, transcoding_options
+`input` can be set. If this option is present, the path of the original movie will not be used.
+
+``` ruby
+movie = FFMPEG::Movie.new("path/to/movie.mov")
+
+transcoder_options = { input: 'img_%03d.png' }
+movie.transcode("movie.mp4", {}, transcoder_options)
+
+# FFMPEG Command will look like this:
+# ffmpeg -y -i img_%03d.png movie.mp4
+```
+
+### Watermarking
+
+Add watermark image on the video.
+
+For example, you want to add a watermark on the video at right top corner with 10px padding.
+
+``` ruby
+options = {
+  watermark: "full_path_of_watermark.png", resolution: "640x360",
+  watermark_filter: { position: "RT", padding_x: 10, padding_y: 10 }
+}
+```
+
+Position can be "LT" (Left Top Corner), "RT" (Right Top Corner), "LB" (Left Bottom Corner), "RB" (Right Bottom Corner).
+The watermark will not appear unless `watermark_options` specifies the position. `padding_x` and `padding_y` default to
+`10`.
+
+### Taking Screenshots
+
+You can use the screenshot method to make taking screenshots a bit simpler.
+
+``` ruby
+movie.screenshot("screenshot.jpg")
+```
+
+The screenshot method has the very same API as transcode so the same options will work.
+
+``` ruby
+movie.screenshot("screenshot.bmp", seek_time: 5, resolution: '320x240')
+```
+
+To generate multiple screenshots in a single pass, specify `vframes` and a wildcard filename. Make
+sure to disable output file validation. The following code generates up to 20 screenshots every 10 seconds:
+
+``` ruby
+movie.screenshot("screenshot_%d.jpg", { vframes: 20, frame_rate: '1/6' }, validate: false)
+```
+
+To specify the quality when generating compressed screenshots (.jpg), use `quality` which specifies
+ffmpeg `-v:q` option. Quality is an integer between 1 and 31, where lower is better quality:
+
+``` ruby
+movie.screenshot("screenshot_%d.jpg", quality: 3)
+```
+
+You can preserve aspect ratio the same way as when using transcode.
+
+``` ruby
+movie.screenshot("screenshot.png", { seek_time: 2, resolution: '200x120' }, preserve_aspect_ratio: :width)
+```
+
+### Create a Slideshow from Stills
+Creating a slideshow from stills uses named sequences of files and stiches the result together in a slideshow
+video.
+
+Since there is not movie to transcode, the Transcoder class needs to be used. The input and input_options are
+provided through transcoder options.
+
+``` ruby
+slideshow_transcoder = FFMPEG::Transcoder.new(
+  '',
+  'slideshow.mp4',
+  { resolution: "320x240" },
+  input: 'img_%03d.jpeg',
+  input_options: { framerate: '1/5' }
+)
+
+slideshow = slideshow_transcoder.run
+```
+
+Specify the path to ffmpeg
+--------------------------
+
+By default, the gem assumes that the ffmpeg binary is available in the execution path and named ffmpeg and so will run commands that look something like `ffmpeg -i /path/to/input.file ...`. Use the FFMPEG.ffmpeg_binary setter to specify the full path to the binary if necessary:
+
+``` ruby
+FFMPEG.ffmpeg_binary = '/usr/local/bin/ffmpeg'
+```
+
+This will cause the same command to run as `/usr/local/bin/ffmpeg -i /path/to/input.file ...` instead.
+
+
+Automatically kill hung processes
+---------------------------------
+
+By default, the gem will wait for 30 seconds between IO feedback from the FFMPEG process. After which an error is logged and the process killed.
+It is possible to modify this behaviour by setting a new default:
+
+``` ruby
+# Change the timeout
+Transcoder.timeout = 10
+
+# Disable the timeout altogether
+Transcoder.timeout = false
+```
+
+Disabling output file validation
+------------------------------
+
+By default Transcoder validates the output file, in case you use FFMPEG for HLS
+format that creates multiple outputs you can disable the validation by passing
+`validate: false` to transcoder_options.
+
+Note that transcode will not return the encoded movie object in this case since
+attempting to open a (possibly) invalid output file might result in an error being raised.
+
+```ruby
+transcoder_options = { validate: false }
+movie.transcode("movie.mp4", options, transcoder_options) # returns nil
+```
+
+Copyright
+---------
+
+Copyright (c) Streamio AB. See LICENSE for details.