duo_splitter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29142faa6db1a28c4729cfa2c84006ec5de9e7f57cf47ad5d14bdd450d05017b
-  data.tar.gz: e788f6c989a1f852443f130f7c2cff7d2543798f2ae4563ca47964630df95231
+  metadata.gz: cc561bd757c37766b2d291595d13e381b663fc762a1e787192ef742e4866f45e
+  data.tar.gz: 39e5095aaf66aed68a33208dcac788261abfaba3e40eaefe36513df835121c36
 SHA512:
-  metadata.gz: 0a6a9cfa9406970d34f0a746f4ccb776bc3a126cf17e198f37344b76e887bd783c9ec1b57a54433a308e741a97d9a143fbb312b243e6fbfeb7f4556b69b1c0bc
-  data.tar.gz: 8bcf3160dec0573f8151835fc521176e0e336846a74a8f370e251ef4d9dff6943c4700fed32771d7c4add8466093a56a212ade14417b9c1de8c487f31fe6da30
+  metadata.gz: f6846d989928dca0332a2756f5c6a66897c6ace7245042eb33abb53e36801adc473639c268ec59748f68081fe7d739a8958e7473e2c18e2c26c58f14a6858bc2
+  data.tar.gz: 842e11082d13c649df3bf9d84278df5466634996b01ae178f9d1ca7f509882648c1c548428546a9273d4422ff5d3fce5f7860a51a67ebe87cd271e7a68f70121

data/README.ja.md

@@ -0,0 +1,128 @@
+# duo\_splitter
+
+[![Build Status](https://travis-ci.org/healthypackrat/duo_splitter.svg?branch=master)](https://travis-ci.org/healthypackrat/duo_splitter)
+
+このgemに含まれているコマンドで[DUO 3.0 CD/**復習用**](https://www.amazon.co.jp/dp/4900790079)の音声を例文ごとに分割できます。
+
+## 必要なもの
+
+  - `ffmpeg`
+      - `brew install ffmpeg`でインストールしてください
+  - `sox`
+      - `brew install sox`でインストールしてください
+      - `repeating`コマンドと`overlapping`コマンドを実行する際に必要です
+
+## インストール
+
+```
+$ gem install duo_splitter
+```
+
+## 使い方
+
+### 準備
+
+  1. WAVエンコーダを指定してCDをiTunesにインポートしてください。
+  2. ターミナルを開いてインポートしたトラックがあるディレクトリへ移動してください。
+
+### 単純な分割
+
+以下のコマンドを実行すると`~/Desktop/DUO 3.0`に分割された音声が生成されます。
+
+```
+$ duo_splitter split *.wav
+```
+
+指定できるオプションを確認するには`duo_splitter split -h`を実行してください。
+
+出力ディレクトリを変更するには`-d`オプションを指定してください:
+
+```
+$ duo_splitter split -d /path/to/dir *.wav
+```
+
+出力フォーマットを変更するには`-f`オプションを指定してください:
+
+```
+$ duo_splitter split -f mp3 *.wav
+```
+
+「SECTION 〜」の音声が不要な場合は`--no-output-intro`オプションを指定してください:
+
+```
+$ duo_splitter split --no-output-intro *.wav
+```
+
+出力されるファイル名にセクション番号を付けたくない場合は`--no-section-number`オプションを指定してください:
+
+```
+$ duo_splitter split --no-section-number *.wav
+```
+
+`ffmpeg`の場所を変更するには`--ffmpeg-path`オプションを指定してください:
+
+```
+$ duo_splitter split --ffmpeg-path=/path/to/ffmpeg *.wav
+```
+
+### リピーティング用の分割
+
+以下のコマンドを実行すると`~/Desktop/DUO 3.0 (Repeating)`に分割された音声が生成されます。
+
+```
+$ duo_splitter repeating *.wav
+```
+
+生成された音声の最後には合図の音声と例文と同じ長さの無音の音声が追加されています。
+
+指定できるオプションを確認するには`duo_splitter repeating -h`を実行してください。
+
+合図の音声が不要な場合は`--no-notification-sound`オプションを指定してください:
+
+```
+$ duo_splitter repeating --no-notification-sound *.wav
+```
+
+合図の音声を変更するには`--notification-sound-path`オプションを指定してください:
+
+```
+$ duo_splitter repeating --notification-sound-path=/path/to/audio.wav *.wav
+```
+
+`sox`の場所を変更するには`--sox-path`オプションを指定してください:
+
+```
+$ duo_splitter repeating --sox-path=/path/to/sox *.wav
+```
+
+### オーバーラッピング用の分割
+
+以下のコマンドを実行すると`~/Desktop/DUO 3.0 (Overlapping)`に分割された音声が生成されます。
+
+```
+$ duo_splitter overlapping *.wav
+```
+
+生成された音声の先頭には合図の音声が追加されています。
+
+指定できるオプションを確認するには`duo_splitter overlapping -h`を実行してください。
+
+合図の音声を変更するには`--notification-sound-path`オプションを指定してください:
+
+```
+$ duo_splitter overlapping --notification-sound-path=/path/to/audio.wav *.wav
+```
+
+`sox`の場所を変更するには`--sox-path`オプションを指定してください:
+
+```
+$ duo_splitter overlapping --sox-path=/path/to/sox *.wav
+```
+
+## 開発
+
+テストするには`bundle install`を実行してから`bin/rspec`を実行してください。
+
+## ライセンス
+
+ライセンスは[MIT License](https://opensource.org/licenses/MIT)です。

data/README.md

@@ -1,6 +1,15 @@
-# `duo_splitter`
+[Read this README in Japanese (日本語で読む)](README.ja.md)
 
-This gem provides a command to split the tracks into each sentences from [DUO 3.0 CD](https://www.amazon.co.jp/dp/4900790079)
+# duo\_splitter
+
+[![Build Status](https://travis-ci.org/healthypackrat/duo_splitter.svg?branch=master)](https://travis-ci.org/healthypackrat/duo_splitter)
+
+This gem provides a command to split the tracks into each sentences from [DUO 3.0 CD](https://www.amazon.co.jp/dp/4900790079).
+
+## Requirements
+
+  - `ffmpeg`
+  - `sox`
 
 ## Installation
 
@@ -10,18 +19,11 @@ $ gem install duo_splitter
 
 ## Usage
 
-```
-Usage: duo_splitter [options] "01 Track 01.wav" "02 Track 02.wav" ... "45 Track 45.wav"
-    -d, --output-dir=PATH            Output directory (default: /Users/yzn/Desktop/DUO 3.0)
-    -f, --format=FORMAT              Output format (default: wav; one of aac, mp3, wav)
-        --[no-]output-intro          Output intro track (default: true)
-        --[no-]section-number        Add section number to output name (default: true)
-        --ffmpeg-path=PATH           Path to ffmpeg command (default: ffmpeg)
-```
+(To be documented)
 
 ## Development
 
-Run `bin/rspec` to run the specs.
+Run `bin/rspec` to run the specs after running `bundle install`.
 
 ## Contributing
 

data/exe/duo_splitter

@@ -1,6 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "duo_splitter"
+require 'duo_splitter'
 
-runner = DuoSplitter::Runner.new(ARGV)
-runner.run
+begin
+  runner = DuoSplitter::Runner.new(ARGV)
+  runner.run
+rescue DuoSplitter::Error => e
+  warn e.message
+  exit 1
+end

data/lib/duo_splitter.rb

@@ -1,22 +1,51 @@
-require "duo_splitter/album"
-require "duo_splitter/section"
-require "duo_splitter/sentence"
+# frozen_string_literal: true
 
-require "duo_splitter/encoder"
-require "duo_splitter/aac_encoder"
-require "duo_splitter/mp3_encoder"
-require "duo_splitter/wav_encoder"
+require 'duo_splitter/models/album'
+require 'duo_splitter/models/section'
+require 'duo_splitter/models/sentence'
 
-require "duo_splitter/runner"
+require 'duo_splitter/batch_processor'
 
-require "duo_splitter/version"
+require 'duo_splitter/context'
+
+require 'duo_splitter/temp_dir_wrapper'
+
+require 'duo_splitter/encoders/base_encoder'
+require 'duo_splitter/encoders/aac_encoder'
+require 'duo_splitter/encoders/mp3_encoder'
+require 'duo_splitter/encoders/wav_encoder'
+
+require 'duo_splitter/services/support/base_concatenate'
+require 'duo_splitter/services/support/repeating_concatenate'
+require 'duo_splitter/services/support/overlapping_concatenate'
+
+require 'duo_splitter/services/support/create_blank_sentences'
+require 'duo_splitter/services/support/encode'
+require 'duo_splitter/services/support/split_tracks'
+
+require 'duo_splitter/services/create_sentences'
+require 'duo_splitter/services/create_repeating_sentences'
+require 'duo_splitter/services/create_overlapping_sentences'
+
+require 'duo_splitter/runner'
+
+require 'duo_splitter/commands/base_command'
+require 'duo_splitter/commands/split_command'
+require 'duo_splitter/commands/repeating_command'
+require 'duo_splitter/commands/overlapping_command'
+
+require 'duo_splitter/version'
 
 require 'pathname'
 
 module DuoSplitter
   class Error < StandardError; end
 
-  DATA_DIR = Pathname.new(__dir__).parent.join('data')
+  ROOT_DIR = Pathname.new(__dir__).parent
+
+  ASSETS_DIR = ROOT_DIR.join('assets')
+
+  DATA_DIR = ROOT_DIR.join('data')
 
   NUMBER_OF_SECTIONS = 45
 

data/lib/duo_splitter/batch_processor.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'English'
+
+module DuoSplitter
+  class BatchProcessor
+    def initialize(message:, show_progress: true)
+      @message = message
+      @show_progress = show_progress
+    end
+
+    def run(commands)
+      commands.each.with_index(1) do |command, index|
+        print_progress "#{@message} #{index}/#{commands.size}\r"
+
+        shell_output = IO.popen(command, err: %i[child out], &:read)
+
+        status = $CHILD_STATUS.exitstatus
+
+        unless status.zero?
+          print_progress "\n"
+          print_progress "#{shell_output}\n"
+          raise Error, "process exit with #{status}"
+        end
+      end
+
+      print_progress "\n"
+    end
+
+    private
+
+    def print_progress(str)
+      $stderr.print(str) if @show_progress
+    end
+  end
+end

data/lib/duo_splitter/commands/base_command.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'pathname'
+
+module DuoSplitter
+  module Commands
+    class BaseCommand
+      attr_reader :parser, :context
+
+      def initialize(argv)
+        @parser = OptionParser.new
+        @context = Context.new
+        @context.output_dir = default_output_dir if default_output_dir
+
+        parse_options(argv)
+        handle_audio_paths(argv)
+      end
+
+      def run
+        raise Error, '#run must be defined in sub classes'
+      end
+
+      private
+
+      def default_output_dir
+        nil
+      end
+
+      def print_done
+        puts 'done.' if context.show_progress
+      end
+
+      def on_output_dir
+        parser.on('-d', '--output-dir=PATH', "Output directory (default: #{context.output_dir.to_s.inspect})") do |path|
+          context.output_dir = Pathname.new(path)
+        end
+      end
+
+      def on_output_format
+        formats = Encoders::BaseEncoder.known_encoders.keys.sort.map(&:to_s)
+        message = %(Output format (default: #{context.output_format.inspect}; one of #{formats.map(&:inspect).join(', ')}))
+        parser.on('-f', '--format=FORMAT', formats, message) do |format|
+          context.output_format = format
+        end
+      end
+
+      def on_output_intro
+        parser.on('--[no-]output-intro', "Output intro track (default: #{context.output_intro})") do |flag|
+          context.output_intro = flag
+        end
+      end
+
+      def on_prefix_section_number
+        parser.on('--[no-]section-number', "Add section number to output file name (default: #{context.prefix_section_number})") do |flag|
+          context.prefix_section_number = flag
+        end
+      end
+
+      def on_show_progress
+        parser.on('--[no-]progress', "Show progress (default: #{context.show_progress})") do |flag|
+          context.show_progress = flag
+        end
+      end
+
+      def on_ffmpeg_path
+        parser.on('--ffmpeg-path=PATH', "Path to ffmpeg command (default: #{context.ffmpeg_path.inspect})") do |path|
+          context.ffmpeg_path = path
+        end
+      end
+
+      def on_sox_path
+        parser.on('--sox-path=PATH', "Path to sox command (default: #{context.sox_path.inspect})") do |path|
+          context.sox_path = path
+        end
+      end
+
+      def on_use_notification_sound
+        parser.on('--[no-]notification-sound', "Use notification sound (default: #{context.use_notification_sound})") do |flag|
+          context.use_notification_sound = flag
+        end
+      end
+
+      def on_notification_sound_path
+        parser.on('--notification-sound-path=PATH', "Path to notification sound (default: #{context.notification_sound_path})") do |path|
+          context.notification_sound_path = Pathname.new(path)
+        end
+      end
+
+      def parse!(argv)
+        parser.order!(argv)
+      rescue OptionParser::ParseError => e
+        raise Error, e.message
+      end
+
+      def after_parse
+        context.output_intro = false unless context.prefix_section_number
+      end
+
+      def handle_audio_paths(argv)
+        raise Error, 'no input files were given' if argv.empty?
+
+        argv.each do |filename|
+          audio_path = Pathname.new(filename)
+
+          match_data = /\A(\d+)/.match(audio_path.basename.to_s)
+
+          raise Error, "input file name doesn't start with a number: #{audio_path.basename}" unless match_data
+
+          section_number = match_data[1].to_i
+
+          section = context.album.sections.find {|s| s.number == section_number }
+
+          raise Error, "invalid section number: #{section_number}" unless section
+
+          section.audio_path = audio_path
+        end
+      end
+    end
+  end
+end

data/lib/duo_splitter/commands/overlapping_command.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module DuoSplitter
+  module Commands
+    class OverlappingCommand < BaseCommand
+      def run
+        Services::CreateOverlappingSentences.new(context: context).run
+        print_done
+      end
+
+      private
+
+      def default_output_dir
+        Pathname.new('~/Desktop/DUO 3.0 (Overlapping)').expand_path
+      end
+
+      def parse_options(argv)
+        parser.banner = %(Usage: #{parser.program_name} [options] overlapping "01 Track 01.wav" ... "45 Track 45.wav")
+
+        on_output_dir
+        on_output_format
+        on_output_intro
+        on_prefix_section_number
+        on_show_progress
+        on_ffmpeg_path
+        on_sox_path
+        on_notification_sound_path
+
+        parse!(argv)
+
+        after_parse
+      end
+
+      Runner.register_command(:overlapping, self)
+    end
+  end
+end