ipod_db 0.2.4

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - rbx-19mode
+
+before_install:
+ - sudo apt-get update -qq
+ - sudo apt-get install -qq libtag1-dev

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+guard 'minitest' do
+  # with Minitest::Spec
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/HISTORY

@@ -0,0 +1,9 @@
+I used to do the same sort of thing and more with a bunch of python scripts.
+My cheapo mass-storage mp3 player has died recently and my son has donated
+(voluntarily) his Shuffle to me, but python scripts were all bit-rot and
+refused to work and I haven't touched python for several years already, so
+I rewrote the main script in ruby. The reading part of python version still
+worked so I made it dump what it read in ruby-esque format for testing
+(that's test_data.rb). The test_data isn't very exciting though (all
+tracks are in default state without bookmarks).
+

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/README.md

@@ -0,0 +1,132 @@
+NAME
+====
+
+    ipod_db v0.2.4
+
+SYNOPSIS
+========
+
+    ipod_db (sync|ls|rm) [options]+
+
+DESCRIPTION
+===========
+
+    A couple of tools for working with iPod Shuffle (2nd gen) database from
+    command line. Each subcommand understands -h/--help flag.
+
+PARAMETERS
+==========
+
+    --version, -v 
+        show package version and exit 
+    --help, -h 
+
+AUTHOR
+======
+
+    artm <femistofel@gmail.com>
+
+
+[![Build Status](https://travis-ci.org/artm/ipod_db.png)](https://travis-ci.org/artm/ipod_db)
+
+
+SUBCOMMAND: sync
+================
+
+SYNOPSIS
+========
+
+    ipod_db sync [options]+
+
+DESCRIPTION
+===========
+
+    Update the iPod database. Given directories of bookmarkable and non-bookmarkable
+    media 'ipod' will find all supported tracks add them to the iPod database so
+    the device is aware of their existance.
+    
+    The tracks under 'books' folder will get "riffled" - tracks from the same folder
+    are spread out in the list so they don't follow each other if possible. IN THE
+    FUTURE it is planned to allow configuring of track groups which are treated like
+    single folders - e.g. to spread out all SciAm's "60 second somthing" podcasts along
+    the playlist.
+    
+    It is perfectly possible to have other directories full of tracks in device's
+    subconscious - e.g. when time-sharing the device among members of a poor
+    family. Just make sure you update the database using your directories when
+    receiving it from a relation.
+    
+    iPod remembers playback position on bookmarkable media and the 'ipod' goes
+    out of its way to preserve the bookmarks. It also removes bookmarkable files
+    from shuffle list.
+    
+    I configure gpodder to place podcast files inside IPOD/books directory and delete
+    them after syncing. Having copied podcasts I run 'ipod sync' to update the
+    database on the device and it's ready for consumption.
+
+PARAMETERS
+==========
+
+    --version, -v 
+        show package version and exit 
+    --books=books, -b (0 ~> books=books) 
+        subdirectory of ipod with bookmarkable media 
+    --songs=songs, -s (0 ~> songs=songs) 
+        subdirectory of ipod with non-bookmarkable media 
+    --help, -h 
+
+SUBCOMMAND: ls
+==============
+
+SYNOPSIS
+========
+
+    ipod_db ls [options]+
+
+DESCRIPTION
+===========
+
+    produce a colorful listing of the tracks in the ipod database
+
+PARAMETERS
+==========
+
+    --version, -v 
+        show package version and exit 
+    --help, -h 
+
+SUBCOMMAND: rm
+==============
+
+SYNOPSIS
+========
+
+    ipod_db rm track track* [options]+
+
+DESCRIPTION
+===========
+
+    Remove tracks from the device by their numbers (that's why ls
+    displays numbers: so it's easier to select them for rm).
+
+PARAMETERS
+==========
+
+    track (-2 -> track) 
+         track numbers to delete from device (ranges like 2-5 are accepted 
+        too). 
+    --version, -v 
+        show package version and exit 
+    --help, -h 
+
+HISTORY
+=======
+
+    I used to do the same sort of thing and more with a bunch of python scripts.
+    My cheapo mass-storage mp3 player has died recently and my son has donated
+    (voluntarily) his Shuffle to me, but python scripts were all bit-rot and
+    refused to work and I haven't touched python for several years already, so
+    I rewrote the main script in ruby. The reading part of python version still
+    worked so I made it dump what it read in ruby-esque format for testing
+    (that's test_data.rb). The test_data isn't very exciting though (all
+    tracks are in default state without bookmarks).

data/Rakefile

@@ -0,0 +1,41 @@
+task :default => [:test, :build]
+task :readme do
+  readme = `bin/ipod help`
+
+  readme += <<-__
+
+[![Build Status](https://travis-ci.org/artm/ipod_db.png)](https://travis-ci.org/artm/ipod_db)
+
+  __
+
+  %w(sync ls rm).each do |subcommand|
+    readme += "\nSUBCOMMAND: #{subcommand}\n"
+
+    rejecting = false
+    rejects = %w(name author)
+    readme += `bin/ipod #{subcommand} -h`.split("\n").reject do |line|
+      if line =~ /^\w/
+        rejecting = rejects.include? line.downcase
+      else
+        rejecting
+      end
+    end.join "\n"
+  end
+
+  readme += "\nHISTORY\n"
+  readme += IO.read('HISTORY').split("\n").map{|s| "  #{s}"}.join("\n")
+
+  File.open('README.md','w') do |io|
+    io.puts readme.gsub(/^\w.*$/) {|m| "#{$&}\n#{'=' * $&.length}\n" }.gsub(/^ /,'   ')
+  end
+end
+
+Rake::TestTask.new { |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/*_spec.rb'
+}
+
+BEGIN {
+  require 'bundler/gem_tasks'
+  require 'rake/testtask'
+}

data/TODO

@@ -0,0 +1,3 @@
+- allow grouping some podcasts so their episodes are spread out (via config field)
+- display totals in ls output: total time and bytes; bytes left on device etc
+

data/bin/ipod

@@ -0,0 +1,245 @@
+#!/usr/bin/env ruby
+
+Main {
+  version IpodDB::VERSION
+
+  description <<-__
+  A couple of tools for working with iPod Shuffle (2nd gen) database from
+  command line. Each subcommand understands -h/--help flag.
+  __
+
+  author 'artm <femistofel@gmail.com>'
+
+  name 'ipod_db'
+  config ipod_root: "/media/#{ENV['USER']}/IPOD"
+  option('version','v') {
+    description 'show package version and exit'
+  }
+  IgnorePlaybackPosUnder = 10
+  IgnoreProgressUnder = 0.01
+
+  def run
+    if param['version'].given?
+      puts IpodDB::VERSION
+    else
+      help!
+    end
+  end
+
+  mode('sync') {
+    description <<-__
+    Update the iPod database. Given directories of bookmarkable and non-bookmarkable
+    media '#{program}' will find all supported tracks add them to the iPod database so
+    the device is aware of their existance.
+
+    The tracks under 'books' folder will get "riffled" - tracks from the same folder
+    are spread out in the list so they don't follow each other if possible. IN THE
+    FUTURE it is planned to allow configuring of track groups which are treated like
+    single folders - e.g. to spread out all SciAm's "60 second somthing" podcasts along
+    the playlist.
+
+    It is perfectly possible to have other directories full of tracks in device's
+    subconscious - e.g. when time-sharing the device among members of a poor
+    family. Just make sure you update the database using your directories when
+    receiving it from a relation.
+
+    iPod remembers playback position on bookmarkable media and the '#{program}' goes
+    out of its way to preserve the bookmarks. It also removes bookmarkable files
+    from shuffle list.
+
+    I configure gpodder to place podcast files inside IPOD/books directory and delete
+    them after syncing. Having copied podcasts I run 'ipod sync' to update the
+    database on the device and it's ready for consumption.
+    __
+
+    option('books','b') {
+      argument_required
+      default 'books'
+      description 'subdirectory of ipod with bookmarkable media'
+    }
+    option('songs','s') {
+      argument_required
+      default 'songs'
+      description 'subdirectory of ipod with non-bookmarkable media'
+    }
+    def run
+      load_ipod_db
+      sync
+    end
+  }
+
+  mode('ls') {
+    description 'produce a colorful listing of the tracks in the ipod database'
+
+    def run
+      load_ipod_db
+      ls
+    end
+
+  }
+
+  mode('rm') {
+    description <<-__
+    Remove tracks from the device by their numbers (that's why ls
+    displays numbers: so it's easier to select them for rm).
+    __
+    argument('track') {
+      arity -2
+      description <<-__
+      track numbers to delete from device (ranges like
+      2-5 are accepted too).
+      __
+    }
+    def run
+      load_ipod_db
+      rm
+    end
+  }
+
+  def sync
+    books_path = params['books'].value
+    songs_path = params['songs'].value
+    books = collect_tracks books_path
+    books = riffle(books)
+    songs = collect_tracks songs_path
+    @ipod_db.update books: books, songs: songs
+    @ipod_db.save
+    ls
+  end
+
+  def ls
+    @ipod_db.each_track_with_index {|track,i| list_track i, track}
+  end
+
+  def rm
+    tracks = parse_track_list(params['track'].values).map{|i,t| [i,t.filename]}
+    puts "The following tracks are selected for removal:"
+    tracks.each { |i,path| puts "  %2d. %s" % [i,path.green] }
+    if agree "Are you sure you want them gone (Y/n)?", true
+      FileUtils.rm tracks.map{|i,path|resolve_ipod_path path}
+    end
+    sync
+  end
+
+  def ipod_path path
+    '/' + Pathname.new(path).relative_path_from(Pathname.new @ipod_root).to_s
+  end
+
+  def resolve_ipod_path ipath
+    File.join @ipod_root, ipath
+  end
+
+  def track_length( path )
+    TagLib::FileRef.open(path){|file| file.audio_properties.length}
+  end
+
+  def load_ipod_db
+    @ipod_root = config['ipod_root']
+    unless IpodDB.looks_like_ipod? @ipod_root
+      fatal { "#{@ipod_root} does not appear to be a mounted ipod" }
+      exit exit_failure
+    end
+    @ipod_db = IpodDB.new @ipod_root
+  end
+
+  def collect_tracks path
+    begin
+      tracks = []
+      Find.find(resolve_ipod_path path) do |filepath|
+        tracks << ipod_path(filepath) if track? filepath
+      end
+      tracks
+    rescue Errno::ENOENT
+      []
+    end
+  end
+
+  def track? path
+    IpodDB::ExtToFileType.include? File.extname(path)
+  end
+
+  def track_info track
+    info = Map.new
+    info['playcount'] = track.playcount if track.playcount > 0
+    info['skipcount'] = track.skippedcount if track.skippedcount > 0
+    if track.bookmarkflag && track.bookmarktime > 0
+      pos = track.bookmarktime * 0.256 # ipod keeps time in 256 ms increments
+      abs_path = resolve_ipod_path track.filename
+      total_time = track_length(abs_path)
+      if pos > IgnorePlaybackPosUnder && pos / total_time >= IgnoreProgressUnder
+        info['pos'] = Pretty.seconds pos
+        info['total'] = Pretty.seconds total_time
+        # and cache seconds
+        track['pos'] = pos
+        track['total_time'] = total_time
+      end
+    end
+    info
+  end
+
+  def list_track i, track
+    abs_path = resolve_ipod_path track.filename
+    exists = File.exists?(abs_path)
+    track_color = exists ? :green : :red
+
+    listing_entry = "%2d: %s" % [i,track.filename.apply_format( color: track_color )]
+    listing_entry = listing_entry.bold if @ipod_db.playback_state.trackno == i
+    puts listing_entry
+
+    return unless exists
+
+    info = track_info(track)
+    if track.include? 'pos'
+      progress = ProgressBar.create(
+        format: "    [%b #{info.pos.yellow} %P%%%i] #{info.total.yellow}",
+        starting_at: track.pos,
+        total: track.total_time,
+      )
+      puts
+      info.delete :pos
+      info.delete :total
+    end
+    if info.count > 0
+      puts "    " + info.map{|label,value| "#{label}: #{value.to_s.yellow}"}.join(" ")
+    end
+  end
+
+  def parse_track_list args
+    tracks = Map.new
+    args.each do |arg|
+      case arg
+      when /^\d+$/
+        n = arg.to_i
+        tracks[n] = @ipod_db[n]
+      when /^(\d+)-(\d+)$/
+        (Regexp.last_match(1)..Regexp.last_match(2)).each do |n_str|
+        n = n_str.to_i
+        tracks[n] = @ipod_db[n]
+        end
+      end
+    end
+    tracks
+  end
+
+  def riffle paths
+    bins = paths.group_by{|path| File.dirname(path)}.values
+    Spread.spread *bins
+  end
+
+}
+
+BEGIN {
+  require 'main'
+  require 'find'
+  require 'pathname'
+  require 'smart_colored/extend'
+  require 'map'
+  require 'taglib'
+  require 'ruby-progressbar'
+  require 'highline/import'
+
+  # our own
+  require 'ipod_db'
+  require 'pretty'
+  require 'spread'
+}