midi_create 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f073594e0455e9245c959a92d992d648854ada76fb230ac93aec66cb46f388c3
+  data.tar.gz: 75890c0dee74c532168692529c0f45c0ad3695ca96d6afd468ca27b6dc4421f5
+SHA512:
+  metadata.gz: eec41bebef091eb62afbf2ef4e0fd575c8b2e497ef01875d69d6164cc61f46d30bf3cd56c09e68409cd78c4b070943fa9932ecb525be5da45963de31024ff3d5
+  data.tar.gz: fb3b385defc75010d408cc1356c25f2d031bb89de9b55a77ca6d1b4fdf849fb41b24114f2b7f1940678942cc94c035bc080710bc7b2a35b8406c903be4ce9c7d

data/.rubocop.yml

@@ -0,0 +1,61 @@
+require:
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Exclude:
+    - midi_create.gemspec
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0
+
+* Initial release.

data/README.md

@@ -0,0 +1,136 @@
+# `Midi_create` [![Gem Version](https://badge.fury.io/rb/midi_create.svg)](https://badge.fury.io/rb/midi_create)
+
+Creates a format 1 (multitrack) MIDI file with one track, defaulting to 120 BPM.
+The generated MIDI file will contain 8 notes in the C major scale, starting at middle C.
+Pro Tools and Ableton Live will not import a MIDI file unless it contains at least one note.
+
+
+## About Middle C
+
+In Pro Tools and Ableton, middle C is known as C3.
+[See a discussion about middle C](https://stackoverflow.com/a/69182634/553865),
+[and this article](https://studiocode.dev/resources/midi-middle-c/).
+
+
+## Installation
+
+Set up Ruby [(here is how)](https://www.mslinn.com/ruby/1000-ruby-setup.html),
+then type the following at a shell prompt:
+
+```shell
+$ gem install midi_create
+```
+
+If you are running `rbenv` (and you should, according to the instructions mentioned above), type:
+
+```shell
+$ rbenv rehash
+```
+
+
+## Help Message
+
+```text
+$ midi_create -h
+midi_create: Creates a MIDI file containing an 8-note scale in the key of C,
+             starting at middle C (C3 in Pro Tools and Ableton Live).
+
+Syntax: midi_create [Options] PATH_TO_MIDI_FILE
+
+Options:
+  -b 120   Specify beats per minute (BPM); default is 120 bpm.
+           Only integers can be used; a decimal point will cause an error.
+  -f       Overwrite the output file if present
+  -t NAME  Use this title for the track
+  -h       Show this help message
+```
+
+
+## Sample Usage
+
+Create a MIDI type 1 file called `filename.mid` with one track in the current directory, without a title.
+Fail if the file already exists.
+Include an 8-note scale in the key of C starting at middle C (C3).
+
+```shell
+$ midi_create filename.mid
+```
+
+
+Like the previous example, but overwrite `filename.mid` if it already exists.
+
+```shell
+$ midi_create -f filename.mid
+```
+
+
+Like the previous example, plus include the title `Test MIDI clip` for the track.
+Ableton Live and Pro Tools ignore the MIDI track title, but Guitar Pro uses it.
+
+```shell
+$ midi_create -ft 'Test MIDI clip' filename.mid
+```
+
+
+Like the previous example, plus set BPM to 150.
+BPM can only be specified as an integer; using a decimal point will cause an error.
+
+```shell
+$ midi_create -b 150 -ft 'Test MIDI clip' filename.mid
+```
+
+
+## Development
+
+After checking out this git repository, install dependencies by typing:
+
+```shell
+$ bin/setup
+```
+
+You should do the above before running Visual Studio Code.
+
+
+### Run the Tests
+
+```shell
+$ bundle exec rake test
+```
+
+
+### Interactive Session
+
+The following will allow you to experiment:
+
+```shell
+$ bin/console
+```
+
+
+### Local Installation
+
+To install this gem onto your local machine, type:
+
+```shell
+$ bundle exec rake install
+```
+
+
+### To Release A New Version
+
+To create a git tag for the new version, push git commits and tags,
+and push the new version of the gem to https://rubygems.org, type:
+
+```shell
+$ bundle exec rake release
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/mslinn/midi_create.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,40 @@
+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
+
+desc 'Bump patch version'
+task :patch do
+  system 'gem bump --tag'
+end
+
+desc 'Bump minor version'
+task :minor do
+  system 'gem bump --version minor --tag'
+end
+
+desc 'Bump major version'
+task :major do
+  system 'gem bump --version major --tag'
+end
+
+task publish: [:build] do
+  $VERBOSE = nil
+  load 'midi_create/version.rb'
+  system "gem push pkg/midi_create-#{MidiCreate::VERSION}.gem"
+end
+
+desc 'Bump patch version, create git tag, build the gem and release to geminabox (default)'
+task release_patch: %i[test patch publish]
+
+desc 'Bump minor version, create git tag, build the gem and release to geminabox'
+task release_minor: %i[test minor publish]
+
+desc 'Bump major version, create git tag, build the gem and release to geminabox'
+task release_major: %i[test major publish]
+
+task default: :test

data/exe/midi_create

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if ENV['VO_DEBUGGING']
+  require_relative '../lib/midi_create'
+else
+  require 'midi_create'
+end

data/lib/midi_create/create.rb

@@ -0,0 +1,56 @@
+require 'midilib'
+
+module MidiCreate
+  include MIDI
+
+  def self.main
+    @options = parse_options
+    help 'The name of the output MIDI file must be provided.' if ARGV.empty?
+    help "Too many parameters were specified.\n#{ARGV}" if ARGV.length > 1
+
+    @midi_out = ARGV[0]
+    if File.exist?(@midi_out)
+      if @options[:overwrite]
+        File.delete(@midi_out)
+      else
+        help "Error: File '#{@midi_out}' already exists and -f was not specified."
+      end
+    end
+    create
+  end
+
+  def self.create
+    seq = MIDI::Sequence.new # Create a new empty MIDI sequence.
+
+    # Create a first track for the MIDI sequence. This holds tempo events and other data.
+    track = Track.new(seq)
+    seq.tracks << track
+    track.events << Tempo.new(Tempo.bpm_to_mpq(@options[:bpm]))
+    track.events << MetaEvent.new(META_SEQ_NAME, @options[:title]) if @options[:title]
+
+    # Create a track to hold the notes and add it to the MIDI sequence.
+    track = Track.new(seq)
+    seq.tracks << track
+
+    # Add note events to the track, corresponding to the C major scale, from C3 to C4, inclusive.
+    # Arguments for note on and note off constructors are channel, note, velocity, and delta_time.
+    # Channel numbers start at zero.
+    # The Sequence#note_to_delta method returns the delta time length of a single quarter note.
+    track.events << ProgramChange.new(0, 1, 0)
+    quarter_note_length = seq.note_to_delta('quarter')
+
+    # There is probably a more elegant way of specifying middle C,
+    # which shows as C3 in Pro Tools and Ableton Live.
+    # See https://studiocode.dev/resources/midi-middle-c/
+    # See https://stackoverflow.com/a/69182634/553865
+    c3 = 60
+
+    [0, 2, 4, 5, 7, 9, 11, 12].each do |offset|
+      track.events << NoteOn.new(0, c3 + offset, 127, 0)
+      track.events << NoteOff.new(0, c3 + offset, 127, quarter_note_length)
+    end
+
+    # Write the sequence to a MIDI file.
+    File.open(@midi_out, 'wb') { |file| seq.write(file) }
+  end
+end

data/lib/midi_create/options.rb

@@ -0,0 +1,37 @@
+require 'colorator'
+require 'optparse'
+
+def help(msg = nil)
+  printf "Error: #{msg}\n\n".yellow unless msg.nil?
+  msg = <<~END_HELP
+    midi_create: Creates a MIDI file containing an 8-note scale in the key of C,
+                 starting at middle C (C3 in Pro Tools and Ableton Live).
+
+    Syntax: midi_create [Options] PATH_TO_MIDI_FILE
+
+    Options:
+      -b 120   Specify beats per minute (BPM); default is 120 bpm.
+               Only integers can be used; a decimal point will cause an error.
+      -f       Overwrite the output file if present
+      -t NAME  Use this title for the track
+      -h       Show this help message
+  END_HELP
+  printf msg.cyan
+  exit 1
+end
+
+def parse_options
+  options = { bpm: 120, overwrite: false }
+  OptionParser.new do |parser|
+    parser.program_name = File.basename __FILE__
+    @parser = parser
+
+    parser.on('-b',      '--bpm BPM', OptionParser::DecimalInteger, 'Specify BPM (default is 120 bpm)')
+    parser.on('-f',      '--overwrite',                             'Overwrite output MIDI file if present')
+    parser.on('-t',      '--title TITLE',                           'Generate title')
+    parser.on_tail('-h', '--help',                                  'Show this message') do
+      help
+    end
+  end.order!(into: options)
+  options
+end

data/lib/midi_create/version.rb

@@ -0,0 +1,3 @@
+module MidiCreate
+  VERSION = '0.1.0'.freeze unless defined? VERSION
+end

data/lib/midi_create.rb

@@ -0,0 +1,8 @@
+require 'colorator'
+
+# Require all Ruby files in 'lib/', except this file
+Dir[File.join("#{__dir__}/midi_create", '*.rb')].sort.each do |file|
+  require file
+end
+
+MidiCreate.main

data/midi_create.gemspec

@@ -0,0 +1,38 @@
+require_relative 'lib/midi_create/version'
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/mslinn/midi_create'
+
+  spec.authors               = ['Mike Slinn']
+  spec.bindir                = 'exe'
+  spec.executables           = %w[midi_create]
+  spec.description           = <<~END_DESC
+    Write a longer description of the gem.
+    Use as many lines as you like.
+  END_DESC
+  spec.email                 = ['mslinn@mslinn.com']
+  spec.files                 = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage              = 'https://mslinn.com/av_studio/705-midi-create.html'
+  spec.license               = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  }
+  spec.name                 = 'midi_create'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary               = 'Creates an empty MIDI file'
+  spec.version               = MidiCreate::VERSION
+
+  spec.add_dependency 'colorator'
+  spec.add_dependency 'midilib'
+  spec.add_dependency 'optparse'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: midi_create
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: midilib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Write a longer description of the gem.
+  Use as many lines as you like.
+email:
+- mslinn@mslinn.com
+executables:
+- midi_create
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- exe/midi_create
+- lib/midi_create.rb
+- lib/midi_create/create.rb
+- lib/midi_create/options.rb
+- lib/midi_create/version.rb
+- midi_create.gemspec
+homepage: https://mslinn.com/av_studio/705-midi-create.html
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/midi_create/issues
+  changelog_uri: https://github.com/mslinn/midi_create/CHANGELOG.md
+  homepage_uri: https://mslinn.com/av_studio/705-midi-create.html
+  source_code_uri: https://github.com/mslinn/midi_create
+post_install_message: |2+
+
+  Thanks for installing midi_create!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: Creates an empty MIDI file
+test_files: []
+...