video_to_mp3 0.0.5 → 0.0.6

data/README.md

@@ -1,7 +1,12 @@
+Note
+------------
+
+"VideoToMp3.new.connvert_to_mp3" to mp3 method would be same as convert method which is there in this release as I have made this a generic method which also gives you the fexibility to specify your own ffmpeg conversion options
+
 Video to mp3
 =========
 
-This is a video to mp3 convertor. iT converts your video files into mp3
+This is a video to mp3 convertor. It converts your video files into mp3
 
 Requirements
 ------------
@@ -23,12 +28,44 @@ Quick Start
 
 In your code
 
-VideoToMp3.new.connvert_to_mp3("\path\to\video\file", "outputfile_name", "\destination\path")
+You can intialize the code as you
+
+video = VideoToMp3.new(input_filename, output_filename, {:ab => 64000, :ar => 22050, :destination_path => "destination/path"})
+
+Then you will have method to convert into mp3 and the default location for the file will be "/home/username/mp3_files"
+
+Just call video.convert and it will do the conversion
+
+or
+
+video = VideoToMp3.new
+
+video.convert({
+    :input_filename   => "/absolute/path/to/input/file",
+    :output_filename  => "outputfile"                   #you dont need to add mp3 in the end,
+    :destination_path => "/absolute/destination/path"   #this should be directory path
+    #and any other option which which ffmpeg take for the mp3 audio conversion as key value pair
+    #for eg :ab => 64000 --> audio bitrate '-ab 64000'
+  })
+
+incase you donot provide any options for conversion then it uses the default option which is
+{
+  :ar       => 44100,       #audio rate
+  :q        => 1,           #audio quality 1..20
+  :ab       => 128000       #audio bit rate        
+}
+
+
+
+
+convert_to_mp3 has been not changed and can be used as it was
+
+  VideoToMp3.new.connvert_to_mp3("\path\to\video\file", "outputfile_name", "\destination\path")
 
-if you do not provide the output filename and destination path then inputfile name is set as 
-outputfile name and "mp3_files" directory get created if you do not provide the destination path
+  if you do not provide the output filename and destination path then inputfile name is set as 
+  outputfile name and "mp3_files" directory get created if you do not provide the destination path
 
-you can find the converted file at destination\path\outputfile_name.mp3
+  you can find the converted file at destination\path\outputfile_name.mp3
 
 
 Issue Report

data/lib/convertor/convertor.rb

@@ -0,0 +1,81 @@
+class Convertor
+
+  @@default_convert_options = {
+        :ar       => 44100,       #audio rate
+        :q        => 1,           #audio quality 1..20
+        :ab       => 128000       #audio bit rate        
+      }
+
+  ######################
+  # Attribute accessors
+  ######################
+  attr_accessor :in_filename, :out_filename, :duration, :options, :destination_path
+
+  
+  ######################
+  # Protected methods
+  ######################
+  protected
+    
+    def path
+      return "#{destination_path.to_s}/#{out_filename.to_s}.mp3"
+    end
+
+    def stringify_options
+      options_arr = []
+
+      options.each do |k, v|
+        options_arr << "-#{k.to_s.dup} #{v}"
+      end
+
+      return options_arr.join(" ")
+
+    end
+
+    def get_file_duration
+      return nil if in_filename.nil? or in_filename.empty?  
+      
+      command = "#{ffmpeg} -i \"#{File.expand_path(in_filename)}\" 2>&1 | grep 'Duration' | cut -d ' ' -f 4 | sed s/,//"
+      command_output = `#{command}`
+      
+      
+      if command_output =~ /([\d][\d]):([\d][\d]):([\d][\d]).([\d]+)/
+        hours = $1; mins = $2; seconds = $3; mseconds = $4
+        time_in_seconds = (( (hours.to_i * 60 + mins.to_i) * 60 + seconds.to_i) + (mseconds.to_f / 100).ceil).to_i
+      end
+
+      return Time.at(time_in_seconds).gmtime.strftime('%R:%S') if !time_in_seconds.nil? or !time_in_seconds.to_s.empty?
+
+    end
+
+    def ffmpeg
+      @ffmpeg ||= `which ffmpeg`.chomp
+    end
+
+    def check_for_errors
+
+      raise VideoToMp3Error, "No input file supplied" if in_filename.nil? or in_filename.empty?
+
+      raise VideoToMp3Error, "Invalid options. It should be a hash" unless options.is_a?(Hash)
+
+    end
+
+    def set_default_attributes
+      if out_filename.nil? or out_filename.empty?
+        self.out_filename = in_filename.split("/")[-1].split(".")[0..-2].join("")
+      end
+
+      if destination_path.nil? or destination_path.empty?
+        self.destination_path = "#{ENV["HOME"]}/mp3_files"
+
+        raise VideoToMp3Error, "Unable to create directory at location - #{destination_path}" if 
+          !Dir.exist?(destination_path) and !system("mkdir #{destination_path}")
+      end
+
+      if duration.nil?
+        self.duration = get_file_duration   
+      end
+      
+    end
+
+end

data/lib/convertor/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+end

data/lib/video_to_mp3.rb

@@ -1,22 +1,82 @@
 require "errors/video_to_mp3_error"
+require "convertor/hash"
+require "convertor/convertor"
+
+class VideoToMp3 < Convertor
+
+  def initialize(in_filename = nil, out_filename = nil, options = {})
+
+    raise VideoToMp3Error, "Please install ffmpeg on your system. \n
+                            Checkout the installation guide at http://ffmpeg.org/download.html
+                           " if ffmpeg.nil? or ffmpeg.empty?
+
+    raise VideoToMp3Error, "Invalid hash options" if !options.empty? and !options.is_a?(Hash)
+
+    @in_filename  = in_filename
+    @out_filename = out_filename
+    @options      = options.symbolize_keys!
+    @duration     = get_file_duration
+  end
+
+  ########################################################################################
+  # options takes the hash which will allow user to set the custom quality parameter
+  # for eg quality paramter q 1..20, audio rate ab 44100, 22050 etc
+  ########################################################################################
+
+  def convert(convert_options = {})
+    self.options = convert_options
+
+    #symbolize the hash keys
+    self.options.symbolize_keys!
+    
+    #delete the input/output filename if exists in the options hash
+    self.in_filename  = self.options.delete(:input_filename)    || in_filename
+    self.out_filename = self.options.delete(:output_filename)   || out_filename
+    
+    #raises error in case it does not have the minimum required data t convert 
+    check_for_errors
+    
+    #set the destionation path if exists in options has
+    self.destination_path = self.options.delete(:destination_path)
+
+    #check if options are empty now
+    self.options = @@default_convert_options if options.empty?
+
+    #returns the ffmpeg options hash as string for eg - '-ab 128000 -ac 2'
+    options_string = stringify_options
+
+    #set the deafult attributes if not present for eg - output filename duration etc
+    set_default_attributes
+
+    #convert to mp3
+    ffmpeg_command = "#{ffmpeg} -i #{in_filename} #{options_string} #{path}"
+
+    #system method runs the command and return the true or false
+    command_status = system(ffmpeg_command)
+
+    if command_status == true
+      return path
+    else
+      raise VideoToMp3Error, "Wrong file name or check the ffmpeg installation on your system"
+    end
+
+  end
 
-class VideoToMp3
   
-  #method to convert thhe video file to mp3
+  #method to convert the video file to mp3
   def connvert_to_mp3(input_filename, output_filename = nil, destination_path = "")
     raise VideoToMp3Error, "No input file supplied" if input_filename.nil? or input_filename.empty?
 
     #set the output filename sames as input filename if it is not supplied
     output_filename = input_filename.split("/")[-1] if output_filename.nil? or input_filename.empty?
-    ffmpeg = `which ffmpeg`.chomp
 
     raise VideoToMp3Error, "Please install ffmpeg on your system. \n
-                       Chackout the installation guide at http://ffmpeg.org/download.html
+                       Checkout the installation guide at http://ffmpeg.org/download.html
                       " if ffmpeg.nil? or ffmpeg.empty?
 
     if destination_path.nil? or destination_path.empty?
       #create the mp3_files directory
-      default_path = "mp3_files"
+      default_path = "#{ENV["HOME"]}/mp3_files"
       system("mkdir #{default_path}")
       destination_path = default_path
     end
@@ -24,10 +84,6 @@ class VideoToMp3
     path = "#{destination_path}/#{output_filename}.mp3"
     ffmpeg_command = "#{ffmpeg} -i #{input_filename} -q 1 #{path}"
 
-    puts "*********************************"
-    puts ffmpeg_command
-    puts "*********************************"
-
     #system method runs the command and return the true or false
     command_status = system(ffmpeg_command)
 
@@ -40,4 +96,12 @@ class VideoToMp3
 
   end
 
+  def options
+    @options ||= {}
+  end
+
+  def duration
+    @duration ||= get_file_duration
+  end
+
 end

data/video_to_mp3.gemspec

@@ -2,7 +2,7 @@ $LOAD_PATH.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name              = "video_to_mp3"
-  s.version           = "0.0.5"
+  s.version           = "0.0.6"
   s.platform          = Gem::Platform::RUBY
   s.author            = "Naveen Agarwal"
   s.email             = ["naveenagarwal287@gmail.com"]
@@ -22,6 +22,8 @@ Gem::Specification.new do |s|
   s.files = [
     "lib/video_to_mp3.rb",
     "lib/errors/video_to_mp3_error.rb",
+    "lib/convertor/hash.rb",
+    "lib/convertor/convertor.rb",
     "README.md",
     "video_to_mp3.gemspec"
   ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: video_to_mp3
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-13 00:00:00.000000000 Z
+date: 2013-01-26 00:00:00.000000000 Z
 dependencies: []
 description: audio/video media convertor
 email:
@@ -20,6 +20,8 @@ extra_rdoc_files: []
 files:
 - lib/video_to_mp3.rb
 - lib/errors/video_to_mp3_error.rb
+- lib/convertor/hash.rb
+- lib/convertor/convertor.rb
 - README.md
 - video_to_mp3.gemspec
 homepage: https://github.com/naveenagarwal/video_to_mp3.git