playlist_transfer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fd192fa3c2a686c5948da6ea5c719647d42725a
+  data.tar.gz: 831a032a4b71b801395246667b78b71ce7ab7fdb
+SHA512:
+  metadata.gz: 0427271e71200e98d78ff23f20442ea8750468e1213ab3bafa0a3d8b723b634e603ddf3f58480aa79df59c47f3837d82ff67cab32ef8af7b4fed26be7a1f47bd
+  data.tar.gz: a0acda4092de869b08d196f76001de6cf4489d9765c762ee608aa2ddc94ca1629e9fc34e391c50c17b22829be378c25a2f8c0b0c59186fb2aa11fbc78771d564

data/README.md

@@ -0,0 +1,49 @@
+# playlist_transfer
+## About
+Ruby script to transfer music defined by playlist from music library to another directory (typically mounted flashdrive) including directory structure from library.
+
+By default, script converts all FLAC files from playlist to MP3 format
+
+This is script I created to put files from my Banshee managed music library (mostly FLAC files, some MP3 files) to flashdrive
+Flashdrive is used in my car radio, which reads only MP3 files and cannot read files with special characters in name.
+
+It reads playlist file (m3u8) generated by some media player and transfers each song to destination directory, including directory structure.
+
+## Installation
+###Easy way:
+If are using rubygems, just run:
+
+<pre>gem install playlist_transfer</pre>
+
+###Manually:
+Or you can build it from github manually:
+
+<pre>
+git clone https://github.com/Kisuke-CZE/playlist_transfer.git
+cd playlist_transfer
+gem build playlist_transfer.gemspec
+gem install playlist_transfer
+</pre>
+
+
+## Usage
+<pre>playlist_transfer if=INPUT_FILE out=OUTPUT_DIR [basedir=MUSIC_DIR] [OPTIONS]</pre>
+
+**INPUT_FILE** - m3u8 playlist with songs you want to transfer
+
+**OUTPUT_DIR** - output directory where to create file structure and copy files (usually some flashdrive)
+
+**MUSIC_DIR** - Path to directory where is your whole music library located. Optional argument if INPUT_FILE is located in your MUSIC_DIR
+
+### Options
+Script has these options:
+
+**--compatible**  - transfer filenames and directory names to target without special characters
+
+**--justcopy**  - do not convert FLAC files to MP3
+
+## Requirements
+* flac binary installed
+* lame binary installed
+* installed gems: m3u8, activesupport
+* whole music library in one directory :)

data/bin/playlist_transfer

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# This is script I created to put files from my Banshee managed music library to flashdrive
+# It reads M3U8 playlist (defined by if=PATH_TO_PLAYLIST) and transfers files to output directory (defined by out=PATH_TO_DIRECTORY) including directory structure (Directory structure is created as relative from basedir=MUSIC_DIR)
+# If there is any FLAC file it converts it to MP3 file (you can disable conversion by parameter --justcopy). Any other files will be just copied.
+# It can also remove any special characters from file and directory names in output path. You can do that adding parameter --compatible
+require 'pathname'
+require 'm3u8'
+require 'playlist_transfer'
+
+ARGV.each do |argument|
+  case argument
+    when /if=/
+      $input_file = Pathname.new($')
+    when /out=/
+      $output_dir = Pathname.new($')
+    when /basedir=/
+      $base_dir = Pathname.new($')
+    when /--compatible/
+      $compatible = true
+    when /--justcopy/
+      $justcopy = true
+    else
+      puts "Invalid argument #{argument}"
+    end
+end
+
+abort "Bad syntax.\nUsage: #{File.basename($0)} if=INPUT_FILE out=OUTPUT_DIR [basedir=MUSIC_DIR] [OPTIONS]
+
+Available options:
+--compatible = transfer filenames and directory names without special characters
+--justcopy = do not convert FLAC files to MP3" unless $input_file && $output_dir
+abort "Cannot read file #{$input_file.to_s} . Does it exist?" unless $input_file.expand_path.file? && $input_file.expand_path.readable?
+
+# If basedir is not defined by input, set basedir to directory where playlist is located
+$base_dir = $input_file.expand_path.dirname if $base_dir==nil
+
+puts "Using input file: #{$input_file.to_s}"
+puts "Output will be placed in: #{$output_dir.to_s}"
+puts "Base directory to define relative paths: #{$base_dir.to_s}"
+
+# Change workdir to directory where playlist is located. Usually playlist has paths to audio files defined as relative from its location in filesystem. If it has absolute paths, changing current workdir is not a problem.
+Dir.chdir($input_file.expand_path.dirname)
+playlist_file = File.open($input_file.expand_path)
+playlist = M3u8::Playlist.read(playlist_file)
+
+playlist.items.each do |item|
+  track_location = Pathname.new(item.segment)
+  track=MusicTrack.new(track_location,$base_dir)
+  track.transfer($output_dir, $compatible, $justcopy)
+end
+puts "Transfer complete."

data/lib/playlist_transfer.rb

@@ -0,0 +1,128 @@
+require 'pathname'
+require 'tempfile'
+require 'playlist_transfer/extensions'
+
+# Class MusicTrack represents one audiofile (trackfile) in some "Music folder" (basedir).
+# trackfile and basedir are Pathnames
+class MusicTrack
+  # Class MusicTrack represents one audiofile (trackfile) in some "Music folder" (basedir).
+  def initialize(trackfile,basedir)
+    abort "File #{trackfile.expand_path} is not located in #{basedir.expand_path}" if !trackfile.expand_path.is_child?(basedir.expand_path)
+    @path = trackfile.expand_path
+    @basedir = basedir.expand_path
+  end
+
+# Methods flactags and encode_flac are highly inspired by script from guy named Mathew who posted his script on github: https://gist.github.com/lpar/4645195
+
+# Method get_tags returns an array with tags extracted from original FLAC file. Array has fields named as attributes from original file. Each field contains value of that attribute
+  def get_tags
+  tmpfile = Tempfile.new('flacdata')
+  system(
+    'metaflac',
+    "--export-tags-to=#{tmpfile.path}",
+    '--no-utf8-convert',
+    @path.to_s
+  )
+  data = tmpfile.open
+  tags = { 'title' => '', 'artist' => '', 'album' => '', 'date' => '', 'tracknumber' => '0' }
+  while line = data.gets
+    m = line.match(/^(\w+)=(.*)$/)
+    if m && m[2]
+      tags[m[1].downcase] = m[2]
+    end
+  end
+  return tags
+  end
+
+# Method encode_flac transcodes FLAC file to MP3 file placed in output (which is passed as parameter).
+# Parameter output should be Pathname
+  def encode_flac(outputfile)
+  wavtemp = Tempfile.new('wavfile')
+  info = self.get_tags
+  track = info['tracknumber'].gsub(/\D/,'')
+  system(
+    'flac',
+    '-s',
+    '-d',
+    '-f',
+    '-o',
+    wavtemp.path,
+    @path.to_s
+  )
+  system(
+    'lame',
+    '--silent',
+    '--replaygain-accurate',
+    '--preset', 'cbr', '320',
+    '-m', 's',
+    '-q', '0',
+    '--add-id3v2',
+    '--tt', info['title'],
+    '--ta', info['artist'],
+    '--tl', info['album'],
+    '--ty', info['date'],
+    '--tn', track,
+    '--tg', info['genre'] || 'Rock',
+    wavtemp.path,
+    outputfile.to_s
+  )
+
+  # If encoding process is interrupted (by pressinc Ctrl + C), remove probably incomplete file in destination.
+  rescue Interrupt
+  FileUtils.rm(mp3name) if mp3name.file?
+  abort "Interrupted when encoding #{mp3name}. Incomplete file removed from destination."
+  end
+
+  # Returns true if track type is FLAC. Identified by file extension.
+  def is_flac?
+    if @path.extname.downcase == ".flac"
+      return true
+    else
+      return false
+    end
+  end
+
+  # This method transfers track file to destination (outfile parameter is Pathname). (When it is FLAC, it converts it to MP3 by default, other files will be just copied).
+  # You can specify that you do not want to convert FLAC to MP3 by adding second parameter (justcopy) with value "true".
+  # It also creates directory structure (relatively from basedir to track itself) in destination.
+  def filetransfer(outfile, justcopy = nil)
+    abort "File #{@path.to_s} does not exist."  if !@path.file?
+    outfile = outfile.sub(/\.flac$/i, '.mp3') if !justcopy
+    # If file in destination already exists in destination, skip it, no need to tranfer it.
+    if !outfile.file?
+      puts "Transfering #{outfile.to_s}"
+      outfile.dirname.mkpath
+      if self.is_flac? && !justcopy
+        self.encode_flac(outfile)
+      else
+        FileUtils.cp(@path.realpath,outfile)
+      end
+    else
+      puts "File #{outfile.to_s} already exists. Skipping..."
+    end
+  end
+
+  # Method to transfer file and it's directory structure to destination (output)
+  # You can specify you want to create directory srtucture in destination in "compatible" way. This means no spaces and special characters in filenames.
+  # If you do not want any conversion from FLAC to MP3, just set justcopy to true.
+  def transfer(output, compatible = nil, justcopy = nil)
+    abort "Can't write to #{output.to_s} or it is not directory." unless output.expand_path.directory? && output.expand_path.writable?
+
+    # Next 3 lines just creates complete destination path for transfered track (combining desired output directory, current track location, and basedir). It also removes special characters if necessary.
+    relative_path = @path.relative_path_from(@basedir)
+    relative_path = relative_path.no_special_chars if compatible
+    output_file = output.expand_path + relative_path
+
+    self.filetransfer(output_file, justcopy)
+  end
+
+  # Method to transfer file and it's structure in "compatible" way (file and it's directory structure with removed special characters) - just alias for transfer with proper parameters.
+  def transfer_compatible(output, justcopy = nil)
+    self.transfer(output, true, justcopy)
+  end
+
+  # Method to transfer file and it's structure without removing special characters or transcoding files to MP3 - just alias for transfer with proper parameters.
+  def just_copy(output)
+    self.transfer(output, nil, true)
+  end
+end

data/lib/playlist_transfer/extensions.rb

@@ -0,0 +1,22 @@
+#Some enhancements to standard classes created to fit my needs
+
+require 'active_support/inflector'
+
+class Pathname
+  # Adds new method to Pathname, which removes accented characters from Pathname. Then removes spaces and any special characters (they are replaced by _). This method returns another Pathname.
+  def no_special_chars
+    transliterated=ActiveSupport::Inflector.transliterate(self.to_s)
+    return Pathname.new(transliterated.gsub!(/[^0-9A-Za-z\/.]/, '_'))
+  end
+
+  # Adds new method to Pathname, which can check if path itself is child of root (parameter, root is another Pathname)
+  # It is used in MusicTrack class to determine if track initialization is correct (if file is really located in defined directory)
+  def is_child?(root)
+    if self.to_s.size >= root.to_s.size
+      return self.to_s[0...root.to_s.size] == root.to_s && (self.to_s.size == root.to_s.size || self.to_s[root.to_s.size] == ?/ )
+    else
+      return false
+    end
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: playlist_transfer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kisuke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: m3u8
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.9
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: Transfers your music (from m3u playlist) to destination folder (for example
+  USB drive). It can convert your FLAC files to MP3 files, or leave as is and just
+  copy files-
+email: kisuke@kisuke.cz
+executables:
+- playlist_transfer
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/playlist_transfer
+- lib/playlist_transfer.rb
+- lib/playlist_transfer/extensions.rb
+homepage: https://github.com/Kisuke-CZE/playlist_transfer
+licenses:
+- WTFPL
+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: Transfers music (defined by M3U playlist) from your music library to destination
+  folder - including directory structure
+test_files: []