music_blender 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+coverage
+*.swp
+log/*
+db/*.db
+*.backup

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    music_blender (0.0.1)
+      activerecord
+      sqlite3
+      taglib-ruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    assert_difference (0.5.0)
+    atomic (1.1.13)
+    builder (3.1.4)
+    coderay (1.0.9)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    fakefs (0.4.2)
+    i18n (0.6.5)
+    metaclass (0.0.1)
+    method_source (0.8.1)
+    minitest (4.7.5)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.4)
+    pry (0.9.12.1)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.4)
+    sqlite3 (1.3.7)
+    taglib-ruby (0.6.0)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  assert_difference
+  factory_girl
+  fakefs
+  mocha
+  music_blender!
+  pry
+  simplecov

data/ID3TAGS.txt

@@ -0,0 +1,26 @@
+Adding ID3 Comments
+
+gem 'taglib-ruby', :require => 'taglib'
+require 'taglib'
+file = TagLib::MPEG::File.new('/path/to/file.mp3')
+tag = file.id3v2_tag(true)
+
+comment = TagLib::ID3v2::CommentsFrame.new()
+comment.description = 'MMP Rating'
+comment.text = '10'
+
+tag.add_frame(comment)
+
+file.save
+##############
+
+tag.frame_list #=> array of frames. 
+
+# Get array of comment frames
+tag.frame_list.select {|frame| frame.is_a?(TagLib::ID3v2::CommentsFrame) }
+
+# Get MMP Rating Frame
+tag.frame_list.detect { |frame| 
+  frame.is_a?(TagLib::ID3v2::CommentsFrame) and 
+    frame.description == 'MMP Rating'
+}

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2013 Jonathan S Garvin <jon(at)(numeral-five)valleys(dot)com>
+
+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,41 @@
+# MusicBlender
+
+A ruby wrapper around [mpg123](http://www.mpg123.de/ "mpg123") providing some additional features.
+
+## Motivation
+
+I was unsatisfied with how every other mp3 player I'd tried randomized music. So, I wrote my own to satisfy my desires.  Maybe it will satisy yours, too.
+
+MusicBlender...
+
+1. allows you to rate songs on any scale you choose (but I recommend using 1-11). 
+2. writes ratings to custom field in ID3 tags, for persistance across devices.
+3. plays those with a higher rating more frequently.
+4. is more likely to play a song that it hasn't played in a while than another of equal rating that it's played more recently.
+5. will not play songs by the same artist too close to each other.
+6. supports relative volume adjustments embeded in ID3 tags with mpg123's --rva-mix flag.
+7. currently is operated from it's own command shell.  Maybe someday I'll create a GUI.  Maybe I won't.
+
+## Dependencies
+
+MusicBlender requires you to have [mpg123](http://www.mpg123.de/ "mpg123") installed and in your path. MusicBlender does *not* play well with mpg321.
+
+## Installation
+
+1. install [mpg123](http://www.mpg123.de/ "mpg123")
+2. `gem install music_blender`
+
+## Quick Start
+
+1. From the console, run `blender /path/to/music/folder`
+2. From MusicBlender's command prompt, enter `play`
+
+## Additional Commands
+
+1. `pause` - pause and restart playback.
+2. `play` - play a new song (aborts current song if already playing).
+3. `stop` - stop playback.
+4. `exit` - stop playback and exit.
+5. `info` - print out info about currently play song.
+6. `rate` # - set current songs rating to #.
+

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/testtask'
+require File.expand_path('../lib/music_blender', __FILE__)
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+namespace :db do
+  desc "Migrate the database through scripts in db/migrate. Target specific version with VERSION=x"
+  task :migrate => :environment do
+    dba.migrate_db
+  end
+end
+
+task :environment do
+  dba.establish_connection
+end
+
+def dba
+  @dba ||= MyMusicPlayer::DbAdapter.new
+end
+

data/bin/blend

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require_relative '../lib/music_blender'
+
+MusicBlender::MUSIC_PATH = ARGV.pop
+MusicBlender::Bootstrap.new.call

data/db/migrate/001_create_root_folders.rb

@@ -0,0 +1,10 @@
+class CreateRootFolders < ActiveRecord::Migration
+  def change
+    create_table :root_folders do |t|
+      t.column :path, :string, :null => false
+
+      t.timestamps
+    end
+    add_index :root_folders, :path
+  end
+end

data/db/migrate/002_create_tracks.rb

@@ -0,0 +1,15 @@
+class CreateTracks < ActiveRecord::Migration
+  def change
+    create_table :tracks do |t|
+      t.column :relative_path, :string, :null => false
+      t.column :last_played_at, :datetime
+      t.column :rating, :integer
+      t.column :title, :string
+      t.column :root_folder_id, :integer
+
+      t.timestamps
+    end
+    add_index :tracks, [:root_folder_id, :relative_path]
+    add_index :tracks, [:root_folder_id, :last_played_at]
+  end
+end

data/db/migrate/003_rename_root_folders_table_to_music_folders.rb

@@ -0,0 +1,6 @@
+class RenameRootFoldersTableToMusicFolders < ActiveRecord::Migration
+  def change
+    rename_table :root_folders, :music_folders
+    rename_column :tracks, :root_folder_id, :music_folder_id
+  end
+end

data/db/migrate/004_create_artists.rb

@@ -0,0 +1,11 @@
+class CreateArtists < ActiveRecord::Migration
+  def change
+    create_table :artists do |t|
+      t.column :name, :string, :null => false
+
+      t.timestamps
+    end
+    add_index :artists, :name
+    add_column :tracks, :artist_id, :integer
+  end
+end

data/db/migrate/005_add_missing_column_to_tracks.rb

@@ -0,0 +1,5 @@
+class AddMissingColumnToTracks < ActiveRecord::Migration
+  def change
+    add_column :tracks, :missing, :boolean, :default => false
+  end
+end

data/db/schema.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 5) do
+
+  create_table "artists", force: true do |t|
+    t.string   "name",       null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "artists", ["name"], name: "index_artists_on_name"
+
+  create_table "music_folders", force: true do |t|
+    t.string   "path",       null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "music_folders", ["path"], name: "index_music_folders_on_path"
+
+  create_table "tracks", force: true do |t|
+    t.string   "relative_path",                   null: false
+    t.datetime "last_played_at"
+    t.integer  "rating"
+    t.string   "title"
+    t.integer  "music_folder_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.integer  "artist_id"
+    t.boolean  "missing",         default: false
+  end
+
+  add_index "tracks", ["music_folder_id", "last_played_at"], name: "index_tracks_on_music_folder_id_and_last_played_at"
+  add_index "tracks", ["music_folder_id", "relative_path"], name: "index_tracks_on_music_folder_id_and_relative_path"
+
+end

data/lib/music_blender.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+require 'bundler/setup'
+require 'etc'
+require 'fileutils'
+require 'find'
+require 'io/wait'
+require 'singleton'
+require 'sqlite3'
+require 'taglib'
+require 'open3'
+
+require_relative 'music_blender/artist'
+require_relative 'music_blender/bootstrap'
+require_relative 'music_blender/db_adapter'
+require_relative 'music_blender/id3_adapter'
+require_relative 'music_blender/music_folder'
+require_relative 'music_blender/player'
+require_relative 'music_blender/player_monitor'
+require_relative 'music_blender/shell'
+require_relative 'music_blender/track'
+
+Thread.abort_on_exception = true
+
+module MusicBlender
+  BLENDER_ROOT = File.expand_path('../../', __FILE__)
+end

data/lib/music_blender/artist.rb

@@ -0,0 +1,6 @@
+module MusicBlender
+  class Artist < ActiveRecord::Base
+    has_many :tracks
+    validates_uniqueness_of :name
+  end
+end

data/lib/music_blender/bootstrap.rb

@@ -0,0 +1,32 @@
+module MusicBlender
+  class Bootstrap
+
+    def call
+      spin_up_db
+      update_tracks
+      launch_shell
+    end
+
+    #######
+    private
+    #######
+
+    def spin_up_db
+      DbAdapter.new.spin_up
+    end
+
+    def update_tracks
+      music_folder.load_tracks
+      music_folder.update_missing_flags
+    end
+
+    def launch_shell
+      puts catch(:exited) { Shell.new.run(*ARGV) }
+    end
+
+    def music_folder
+      MusicFolder.current
+    end
+
+  end
+end

data/lib/music_blender/db_adapter.rb

@@ -0,0 +1,58 @@
+module MusicBlender
+  class DbAdapter
+    attr_reader :connection
+
+    def spin_up
+      establish_connection
+      silence_stream(STDOUT)  { initialize_or_migrate_db }
+      setup_db_log
+    end
+
+    def establish_connection
+      FileUtils.mkdir_p(db_folder)
+      @connection ||= ActiveRecord::Base.establish_connection(
+        :adapter => 'sqlite3',
+        :database => path_to_db
+      )
+    end
+
+    def migrate_db
+      ActiveRecord::Migrator.migrate('db/migrate', ENV["VERSION"] ? ENV["VERSION"].to_i : nil )
+      File.open(path_to_schema, 'w:utf-8') do |file|
+        ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+      end
+    end
+
+    #######
+    private
+    #######
+
+    def initialize_or_migrate_db
+      if File.exist?(path_to_db)
+         migrate_db
+      else
+        initialize_db
+      end
+    end
+
+    def initialize_db
+      load(path_to_schema) #load and run schema.rb
+    end
+
+    def path_to_db
+      @path_to_db ||= "#{db_folder}/music_blender.db"
+    end
+
+    def db_folder
+      "#{Etc.getpwuid.dir}/.music_blender/db"
+    end
+
+    def path_to_schema
+      @path_to_schema ||= "#{BLENDER_ROOT}/db/schema.rb"
+    end
+
+    def setup_db_log
+      ActiveRecord::Base.logger ||= Logger.new("#{BLENDER_ROOT}/log/database.log",'daily')
+    end
+  end
+end

data/lib/music_blender/id3_adapter.rb

@@ -0,0 +1,70 @@
+module MusicBlender
+  class Id3Adapter
+    RATING_FRAME_DESCRIPTION = 'MMP Rating'
+    attr_reader :initial_rating, :path
+
+    def initialize(path,initial_rating)
+      @path = path
+      @initial_rating = initial_rating
+    end
+
+    def title
+      v2tag.title || v1tag.title
+    end
+
+    def artist
+      v2tag.artist || v1tag.artist
+    end
+
+    def rating
+      rating_frame.text.to_i
+    end
+
+    def set_rating(value)
+      rating_frame.text = value.to_s
+      tag_file.save
+    end
+
+    #######
+    private
+    #######
+
+    def v1tag
+      @v1tag ||= tag_file.id3v1_tag(true)
+    end
+
+    def v2tag
+      @v2tag ||= tag_file.id3v2_tag(true)
+    end
+
+    def tag_file
+      @tag_file ||= TagLib::MPEG::File.new(path)
+    end
+
+    def rating_frame
+      @rating_frame ||= (find_rating_frame || create_and_find_rating_frame)
+    end
+
+    def find_rating_frame
+      v2tag.frame_list.detect { |frame|
+        frame.is_a?(TagLib::ID3v2::CommentsFrame) and
+          frame.description == RATING_FRAME_DESCRIPTION
+      }
+    end
+
+    def create_and_find_rating_frame
+      TagLib::ID3v2::CommentsFrame.new.tap do |new_frame|
+        new_frame.description = RATING_FRAME_DESCRIPTION
+        new_frame.text = (initial_rating || 1).to_s
+        v2tag.add_frame(new_frame)
+        tag_file.save
+      end
+      # Due to quirk in TagLib, the new_frame
+      # from the above block is not accessible
+      # anymore, so need to re-find an instance
+      # of it that we can read and manipulate.
+      find_rating_frame
+    end
+
+  end
+end