xi-lang 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3feae76d4f61becebc296554b3628ee870aa429
+  data.tar.gz: cc3ad564f9d0b4559f136dfb9f1ce93c26c01efb
+SHA512:
+  metadata.gz: a7a6f4fea97a1600b38eaf844c847b8a34efc7fa6d21f33244aabd9a4dc6603528ba92651440db11510b40196dd835f04695c5ea83f22e30dfaeb3fd708702c9
+  data.tar.gz: 209c7db3b0e7cb2cd3c512756817ce7b0692bf4662658c436b9f6513651345d211dfa177732892a375d45e98ccbe6ad640ef437faf93d56c6a2cd692f96c0142

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.swo

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at munshkr@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^test/(.*)_test\.rb$})
+  watch(%r{^lib/xi/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$}) { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Damián Silvani
+
+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,70 @@
+# Xi
+
+Xi (pronounced /ˈzaɪ/) is a musical pattern language inspired in Tidal and
+SuperCollider for building higher-level musical constructs easily.  It is
+implemented on the Ruby programming language.
+
+Xi is only a patterns library, but can talk to different backends:
+
+- [SuperCollider](https://github.com/supercollider/supercollider)
+- MIDI devices
+
+## Installation
+
+You will need Ruby 2.1+ installed on your system.  Check by running `ruby
+-v`.  You will also need Bundler.  Install with `gem install bundler`.
+
+Becase Xi is still in **alpha** stage, you will have to checkout this
+repository using Git:
+
+    $ git clone https://github.com/munshkr/xi
+
+After that, change into the new directory and install gem dependencies with
+Bundler:
+
+    $ cd xi
+    $ bundle install
+
+You're done! Fire up the REPL from `bin/xi`.
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run
+`rake test` to run the tests.
+
+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`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/munshkr/xi. This project is intended to be a safe, welcoming
+space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Damián Emiliano Silvani
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/xi

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require "xi"
+require "xi/repl"
+
+include Xi
+
+REPL.start

data/lib/xi/clock.rb

@@ -0,0 +1,81 @@
+require 'thread'
+require 'logger'
+require 'set'
+
+Thread.abort_on_exception = true
+
+module Xi
+  class Clock
+    DEFAULT_CPS  = 1.0
+    INTERVAL_SEC = 10 / 1000.0
+
+    def initialize(cps: DEFAULT_CPS)
+      @mutex = Mutex.new
+      @cps = cps
+      @playing = true
+      @streams = [].to_set
+      @play_thread = Thread.new { thread_routine }
+    end
+
+    def subscribe(stream)
+      @mutex.synchronize { @streams << stream }
+    end
+
+    def unsubscribe(stream)
+      @mutex.synchronize { @streams.delete(stream) }
+    end
+
+    def cps
+      @mutex.synchronize { @cps }
+    end
+
+    def cps=(new_cps)
+      @mutex.synchronize { @cps = new_cps }
+    end
+
+    def playing?
+      @mutex.synchronize { @playing }
+    end
+
+    def stopped?
+      !playing?
+    end
+
+    def play
+      @mutex.synchronize { @playing = true }
+      self
+    end
+    alias_method :start, :play
+
+    def stop
+      @mutex.synchronize { @playing = false }
+      self
+    end
+    alias_method :pause, :play
+
+    def inspect
+      "#<#{self.class.name}:#{"0x%014x" % object_id} cps=#{cps.inspect} #{playing? ? :playing : :stopped}>"
+    end
+
+    private
+
+    def thread_routine
+      loop do
+        do_tick
+        sleep INTERVAL_SEC
+      end
+    end
+
+    def do_tick
+      cycles = Time.now.to_f * cps
+      return unless playing?
+      @streams.each { |s| s.notify(cycles) }
+    rescue => err
+      logger.error(err)
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end

data/lib/xi/core_ext/enumerable.rb

@@ -0,0 +1,25 @@
+require 'xi/pattern'
+
+module Xi
+  module Pattern::Enumerable
+    def p(dur=nil, **metadata)
+      Pattern.new(self, event_duration: dur, **metadata)
+    end
+  end
+end
+
+class Enumerator
+  include Xi::Pattern::Enumerable
+end
+
+class Array
+  include Xi::Pattern::Enumerable
+end
+
+class Hash
+  include Xi::Pattern::Enumerable
+end
+
+class Range
+  include Xi::Pattern::Enumerable
+end

data/lib/xi/core_ext/fixnum.rb

@@ -0,0 +1,11 @@
+module Xi
+  module CoerceToRational
+    def /(o)
+      super(o.to_r)
+    end
+  end
+end
+
+class Fixnum
+  prepend Xi::CoerceToRational
+end

data/lib/xi/core_ext/numeric.rb

@@ -0,0 +1,34 @@
+module Xi
+  module Numeric
+    def midi_to_cps
+      440 * (2 ** ((self - 69) / 12.0))
+    end
+
+    def db_to_amp
+      10 ** (self / 20.0)
+    end
+
+    def degree_to_key(scale, steps_per_octave)
+      accidental = (self - self.to_i) * 10.0
+      inner_key = scale[self % scale.size]
+      base_key = (self / scale.size).to_i * steps_per_octave + inner_key
+      if accidental != 0
+        base_key + accidental * (steps_per_octave / 12.0)
+      else
+        base_key
+      end
+    end
+  end
+end
+
+class Fixnum
+  include Xi::Numeric
+end
+
+class Float
+  include Xi::Numeric
+end
+
+class Rational
+  include Xi::Numeric
+end

data/lib/xi/core_ext/simple.rb

@@ -0,0 +1,15 @@
+require 'xi/pattern'
+
+module Xi
+  module Pattern::Simple
+    def p(dur=nil, **metadata)
+      [self].p(dur, metadata)
+    end
+  end
+end
+
+class Fixnum;   include Xi::Pattern::Simple; end
+class Float;    include Xi::Pattern::Simple; end
+class String;   include Xi::Pattern::Simple; end
+class Symbol;   include Xi::Pattern::Simple; end
+class Rational; include Xi::Pattern::Simple; end

data/lib/xi/core_ext.rb

@@ -0,0 +1,4 @@
+require 'xi/core_ext/enumerable'
+require 'xi/core_ext/fixnum'
+require 'xi/core_ext/numeric'
+require 'xi/core_ext/simple'

data/lib/xi/error_log.rb

@@ -0,0 +1,45 @@
+require 'singleton'
+require 'thread'
+
+module Xi
+  class ErrorLog
+    include Singleton
+
+    attr_accessor :max_msgs
+    attr_reader   :more_errors
+    alias_method  :more_errors?, :more_errors
+
+    def initialize(max_msgs: 6)
+      @max_msgs = max_msgs
+
+      @mutex = Mutex.new
+      @errors = []
+      @more_errors = false
+    end
+
+    def <<(msg)
+      @mutex.synchronize do
+        @errors.unshift(msg) unless @errors.include?(msg)
+        if @errors.size >= @max_msgs
+          @errors.slice!(@max_msgs)
+          @more_errors = true
+        end
+      end
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      msgs = @mutex.synchronize do
+        res = @errors.dup
+        @errors.clear
+        @more_errors = false
+        res
+      end
+
+      while !msgs.empty?
+        yield msgs.shift
+      end
+    end
+  end
+end

data/lib/xi/event.rb

@@ -0,0 +1,41 @@
+module Xi
+  class Event
+    attr_reader :value, :start, :duration
+
+    def initialize(value, start=0, duration=1)
+      @value = value
+      @start = start
+      @duration = duration
+    end
+
+    def self.[](*args)
+      new(*args)
+    end
+
+    def ==(o)
+      self.class == o.class &&
+        value == o.value &&
+        start == o.start &&
+        duration == o.duration
+    end
+
+    def end
+      @start + @duration
+    end
+
+    def p(dur=nil, **metadata)
+      [self].p(dur, metadata)
+    end
+
+    def inspect
+      "E[#{@value.inspect},#{@start}" \
+        "#{",#{@duration}" if @duration != 1}]"
+    end
+
+    def to_s
+      inspect
+    end
+  end
+end
+
+E = Xi::Event

data/lib/xi/pattern/generators.rb

@@ -0,0 +1,141 @@
+module Xi
+  class Pattern
+    module Generators
+      module ClassMethods
+        # Create an arithmetic series pattern of +length+ values, being +start+
+        # the starting value and +step+ the addition factor.
+        #
+        # @example
+        #   peek P.series                 #=> [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+        #   peek P.series(3)              #=> [3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
+        #   peek P.series(0, 2)           #=> [0, 2, 4, 6, 8, 10, 12, 14, 16, 18]
+        #   peek P.series(0, 0.25, 8)     #=> [0, 0.25, 0.5, 0.75, 1.0, 1.25, 1.5, 1.75]
+        #
+        # @param start [Numeric] (default: 0)
+        # @param step [Numeric] (default: 1)
+        # @param length [Numeric, Symbol] number or inf (default: inf)
+        # @return [Pattern]
+        #
+        def series(start=0, step=1, length=inf)
+          Pattern.new(size: length) do |y|
+            i = start
+            loop_n(length) do
+              y << i
+              i += step
+            end
+          end
+        end
+
+        # Create a geometric series pattern of +length+ values, being +start+ the
+        # starting value and +step+ the multiplication factor.
+        #
+        # @example
+        #   peek P.geom                 #=> [0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+        #   peek P.geom(3)              #=> [3, 3, 3, 3, 3, 3, 3, 3, 3, 3]
+        #   peek P.geom(1, 2)           #=> [1, 2, 4, 8, 16, 32, 64, 128, 256, 512]
+        #   peek P.geom(1, 1/2, 6)      #=> [1, (1/2), (1/4), (1/8), (1/16), (1/32)]
+        #   peek P.geom(1, -1, 8)       #=> [1, -1, 1, -1, 1, -1, 1, -1]
+        #
+        # @param start [Numeric] (default: 0)
+        # @param grow [Numeric] (default: 1)
+        # @param length [Numeric, Symbol] number or inf (default: inf)
+        # @return [Pattern]
+        #
+        def geom(start=0, grow=1, length=inf)
+          Pattern.new(size: length) do |y|
+            i = start
+            loop_n(length) do
+              y << i
+              i *= grow
+            end
+          end
+        end
+
+        # Choose items from the list randomly
+        #
+        # @example
+        #   peek [1, 2, 3].p.rand             #=> [2]
+        #   peek [1, 2, 3, 4].p.rand(6)       #=> [1, 3, 2, 2, 4, 3]
+        #
+        # @param repeats [Fixnum, Symbol] number or inf (default: 1)
+        # @return [Pattern]
+        #
+        def rand(list, repeats=1)
+          Pattern.new(size: repeats) do |y|
+            ls = list.to_a
+            loop_n(repeats) { y << ls.sample }
+          end
+        end
+
+        # Choose randomly, but only allow repeating the same item after yielding
+        # all items from the list.
+        #
+        # @example
+        #   peek [1, 2, 3, 4, 5].p.xrand    #=> [4]
+        #   peek [1, 2, 3].p.xrand(8)       #=> [1, 3, 2, 3, 1, 2, 3, 2]
+        #
+        # @param repeats [Fixnum, Symbol] number or inf (default: 1)
+        # @return [Pattern]
+        #
+        def xrand(list, repeats=1)
+          Pattern.new(size: repeats) do |y|
+            ls = list.to_a
+            xs = nil
+            loop_n(repeats) do |i|
+              xs = ls.shuffle if i % ls.size == 0
+              y << xs[i % ls.size]
+            end
+          end
+        end
+
+        # Shuffle the list in random order, and use the same random order
+        # +repeats+ times
+        #
+        # @example
+        #   peek [1, 2, 3, 4, 5].p.xrand    #=> [4]
+        #   peek [1, 2, 3].p.xrand(8)       #=> [1, 3, 2, 3, 1, 2, 3, 2]
+        #
+        # @param repeats [Fixnum, Symbol] number or inf (default: 1)
+        # @return [Pattern]
+        #
+        def shuf(list, repeats=1)
+          Pattern.new(size: list.size * repeats) do |y|
+            xs = list.to_a.shuffle
+            loop_n(repeats) do |i|
+              xs.each { |x| y << x }
+            end
+          end
+        end
+
+        # TODO Document
+        def sin(quant, dur=1)
+          Pattern.new(size: quant, dur: dur / quant) do |y|
+            quant.times do |i|
+              y << Math.sin(i / quant * 2 * Math::PI)
+            end
+          end
+        end
+
+        # TODO Document
+        def sin1(quant, dur=1)
+          sin(quant, dur).scale(-1, 1, 0, 1)
+        end
+
+        private
+
+        def loop_n(length)
+          i = 0
+          loop do
+            break if length != inf && i == length
+            yield i
+            i += 1
+          end
+        end
+      end
+
+      def self.included(receiver)
+        receiver.extend(ClassMethods)
+      end
+    end
+  end
+end