audiomator 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cee451824e25a7fcefed1d9cb967a5921c8d98b1
+  data.tar.gz: d9656a18a2d5d63b6f6deab65459885b8cb1eb5e
+SHA512:
+  metadata.gz: 8fd4ab80d5e4b943dd94d85a2109bf35b7c8987ace0d645addb11385b714c32cbdc3a983aec75ab419810c73b7dc4cc8f22056ca0456b644af496fccc7f93da0
+  data.tar.gz: f65a60dcc9986380b0017f7d112f1491826d562ffc0c98c692488f62af5f422462b018a56a4e7cc6c16954d9f5d166969daec647e867fd8b67d9234ae9645df9

data/.github/issue_template.md

@@ -0,0 +1,13 @@
+### Steps to reproduce
+
+Tell us how to reproduce
+
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### System configuration
+
+**Ruby version**:

data/.github/pull_request_template.md

@@ -0,0 +1,17 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. This could include
+benchmarks, or other information.
+
+If you are updating any of the CHANGELOG files or are asked to update the
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
+
+Thanks for contributing to Audiomator!

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,26 @@
+image:
+  ruby:ffmpeg
+
+before_script:
+  - export LC_ALL="C.UTF-8"
+  - export RAILS_ENV=test
+  - export RACK_ENV=test
+  - eval "$(rbenv init -)"
+  - rbenv global 2.2.2
+  - rbenv rehash
+  - ruby -v
+  - gem -v
+
+  - bundle install -j8 --path /cache/bundle --quiet
+
+
+stages:
+  - test
+
+job_test:
+  stage: test
+  tags:
+    - ruby
+
+  script:
+    - bundle exec rspec

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+  - 2.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in audiomator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Yuan He
+
+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,61 @@
+# Audiomator
+
+A ffmpeg wrapper for ruby to easy split and processing audio files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'audiomator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install audiomator
+
+## Usage
+
+    ## Load an audio file
+    @audio_file = "PATH/TO/AUDIO_FILE/FILENAME.m4a"
+    @record = Audiomator::Record.new(@audio_file)
+
+    # Get audio metadata
+    @record.duration
+    @record.bitrate
+    @record.size
+    @record.sample_rate
+    @record.codec
+
+    # any FFMPEG errors when loading audio
+    @record.valid?
+
+    # clip audio with start_time and end_time
+    @start_time = '00:00:00.59'
+    @end_time = '00:00:01.53'
+    @record.clip(@start_time, @end_time)
+
+    # Adding metadata to output audio file
+    metadata = {description: 'This is AudioMator'}
+    @record.clip(@start_time, @end_time, nil, metadata: metadata)
+
+    # Add prefix to save all clips to a specify folder
+    @record.clip(@start_time, @end_time, nil, prefix: 'clips')
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/lenage/audiomator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/audiomator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'audiomator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "audiomator"
+  spec.version       = Audiomator::VERSION
+  spec.authors       = ["Yuan He"]
+  spec.email         = ["lendage@gmail.com"]
+
+  spec.summary       = %q{A ffmpeg wrapper for ruby to easy split and processing audio files.}
+  spec.description   = %q{A ffmpeg wrapper for ruby to easy split and processing audio files.}
+  spec.homepage      = "https://github.com/lenage/audiomator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "audiomator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/audiomator.rb

@@ -0,0 +1,55 @@
+require 'logger'
+
+require 'audiomator/error'
+require 'audiomator/options'
+require 'audiomator/record'
+require 'audiomator/version'
+
+# Main module for Audiomator
+module Audiomator
+  # Set FFMPEG logs about its process when it's transcoding
+  # @params {logger} log you own logger
+  # @return [Logger] the logger you ser
+  def self.logger=(log)
+    @logger = log
+  end
+
+  # Get FFMPEG logger.
+  #
+  # @return [Logger]
+  def self.logger
+    return @logger if @logger
+    logger = ::Logger.new(STDOUT)
+    logger.level = ::Logger::INFO
+    @logger = logger
+  end
+
+  # Set the path of ffmpeg
+  # Can be useful if you need to specify a path as /usr/local/bin/ffmpeg
+  #
+  # @param [String] path to the ffmpeg
+  # @return [String] the path of ffmpeg
+  def self.ffmpeg=(bin)
+    @ffmpeg = bin
+  end
+
+  def self.ffmpeg
+    @ffmpeg || 'ffmpeg'
+  end
+
+  def self.ffprobe=(bin)
+    @ffprobe = bin
+  end
+
+  def self.ffprobe
+    @ffprobe || 'ffprobe'
+  end
+
+  def self.timeout=(time)
+    @timeout = time
+  end
+
+  def self.timeout
+    @timeout || 45
+  end
+end

data/lib/audiomator/error.rb

@@ -0,0 +1,4 @@
+module Audiomator
+  class Error < StandardError
+  end
+end

data/lib/audiomator/options.rb

@@ -0,0 +1,20 @@
+require 'shellwords'
+module Audiomator
+  # Options which convert audio to
+  class Options < Struct.new(:start_time, :end_time, :bitrate, :sample_rate, :metadata)
+
+    def initialize(start_time, end_time, bitrate = '96k', sample_rate = '44100', metadata = {})
+      super
+    end
+
+    # see http://multimedia.cx/eggs/supplying-ffmpeg-with-metadata/ for metadata
+    def metadata_string
+      return '' if metadata.empty?
+      metadata.map { |k, v| "-metadata #{k}=#{Shellwords.escape(v)}" }.join(' ')
+    end
+
+    def to_s
+      "-b:a #{bitrate} -ar #{sample_rate} -ss #{start_time} -to #{end_time} #{metadata_string}"
+    end
+  end
+end

data/lib/audiomator/record.rb

@@ -0,0 +1,126 @@
+require 'timeout'
+require 'time'
+require 'shellwords'
+require 'open3'
+require 'audiomator/options'
+require 'fileutils'
+
+module Audiomator
+  class Record
+    attr_reader :path, :duration, :time, :bitrate, :rotation, :creation_time
+    attr_reader :stream, :codec, :sample_rate
+    attr_reader :container
+
+    def initialize(path)
+      fail Errno::ENOENT, "'#{path}' does not exist" unless File.exist?(path)
+      @path = path
+
+      # ffmpeg will output to stderr
+      @output = Open3.popen3(ffmpeg_command) { |_stdin, _stdout, stderr| stderr.read }
+
+      parse_container
+      parse_duration
+      parse_time
+      parse_creation_time
+      parse_stream_info
+      validate
+    end
+
+    def valid?
+      !@invalid
+    end
+
+    def size
+      File.size(@path)
+    end
+
+    def basename
+      File.basename(@path, '.*')
+    end
+
+    def clip(start_time, end_time, output = nil, options = {})
+      options = default_clip_options.merge!(options)
+      output = output_file(start_time, end_time, options) unless output
+      FileUtils.mkdir_p(File.dirname(output)) unless Dir.exist?(File.dirname(output))
+      opts = Options.new(start_time,
+                         end_time,
+                         options[:bitrate],
+                         options[:sample_rate],
+                         options[:metadata])
+      command = [ffmpeg_command, opts.to_s, output].join(' ')
+      Audiomator.logger.info("Running audio processing...\n #{command}\n")
+      @output_error = ''
+
+      begin
+        Timeout.timeout(Audiomator.timeout) do
+          _stdout, stderr, status = Open3.capture3(command)
+          @output_error = stderr
+          unless status.success?
+            fail Error, "Proecess Failed, Full output: #{stderr}"
+          end
+        end
+      rescue Timeout::Error => e
+        raise Error, "Proecess Timeout #{e.message} \n: #{@output_error} \n"
+      end
+      Audiomator.logger.info("Audio processing finished\n")
+    end
+
+    private
+
+    def output_file(start_time, end_time, options = default_clip_options)
+      options = default_clip_options.merge!(options)
+      output_filename = "#{basename}-#{duration}-#{start_time}_#{end_time}.#{options[:format]}"
+      output_filename = "#{options[:prefix].to_s}/#{output_filename}" if options[:prefix]
+      File.join File.dirname(@path), output_filename
+    end
+
+    def default_clip_options
+      { bitrate: '32k', format: 'm4a', metadata: {}, sample_rate: '44100'}
+    end
+
+    def ffmpeg_command
+      "#{Audiomator.ffmpeg} -i #{Shellwords.escape(@path)}"
+    end
+
+    def parse_container
+      @output[/Input \#\d+\,\s*(\S+),\s*from/]
+      @container = $1
+    end
+
+    def parse_duration
+      @output[/Duration: (\d{2}):(\d{2}):(\d{2}\.\d{2})/]
+      @duration = ($1.to_i * 60 * 60) + ($2.to_i * 60) + $3.to_f
+    end
+
+    def parse_time
+      @output[/start: (\d*\.\d*)/]
+      @time = $1 ? $1.to_f : 0.0
+    end
+
+    def parse_creation_time
+      @output[/creation_time {1,}: {1,}(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})/]
+      @creation_time = $1 ? Time.parse("#{$1}") : nil
+    end
+
+    def parse_bitrate
+      @output[/bitrate: (\d*)/]
+      @bitrate = $1 ? $1.to_i : nil
+    end
+
+    def parse_stream_info
+      @output[/Audio:\ (.*)/]
+      @stream = $1
+      if stream
+        @codec, audio_sample_rate, @channels, _, audio_bitrate = stream.split(/\s?,\s?/)
+        @bitrate = audio_bitrate =~ %r(\A(\d+) kb/s) ? $1.to_i : nil
+        @sample_rate = audio_sample_rate[/\d*/].to_i
+      end
+    end
+
+    def validate
+      @invalid = true if @output.include?('is not supported')
+      @invalid = true if @output.include?('Invalid data found when processing input')
+      @invalid = true if @output.include?('could not find codec parameters')
+    end
+  end
+end

data/lib/audiomator/version.rb

@@ -0,0 +1,3 @@
+module Audiomator
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: audiomator
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Yuan He
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: A ffmpeg wrapper for ruby to easy split and processing audio files.
+email:
+- lendage@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/issue_template.md"
+- ".github/pull_request_template.md"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- audiomator.gemspec
+- bin/console
+- bin/setup
+- lib/audiomator.rb
+- lib/audiomator/error.rb
+- lib/audiomator/options.rb
+- lib/audiomator/record.rb
+- lib/audiomator/version.rb
+homepage: https://github.com/lenage/audiomator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A ffmpeg wrapper for ruby to easy split and processing audio files.
+test_files: []