asterism-games 0.20.0 → 0.21.0

data/lib/asterism_games/commentate/assets/index.html

@@ -11,16 +11,18 @@
   <span id="tname" class="item strong">卓を待っています</span>
   <select id="tables" class="item" title="卓" hidden></select>
   <span id="voice" class="item" title="M で切り替え">声: 切</span>
+  <span id="bgm" class="item btn" role="button" title="B で切り替え (切/小/中/大)">BGM 小 [B]</span>
+  <span id="se" class="item btn" role="button" title="E で切り替え">効果音 入 [E]</span>
   <span id="ai" class="item"></span>
   <span id="delay" class="item"></span>
   <span id="mode" class="item"></span>
   <span id="conn" class="item"></span>
 </header>
-<div id="hint" role="button" tabindex="0">画面をクリックすると実況の声が出ます (ブラウザの自動再生の決まり)</div>
+<div id="hint" role="button" tabindex="0">画面をクリックすると実況の声と音が出ます (ブラウザの自動再生の決まり)</div>
 <main id="stage"><canvas id="table" aria-label="卓"></canvas></main>
 <section id="captions" aria-live="polite"></section>
-<footer id="keys">Space 一時停止 / M 声 / H 手牌を隠す</footer>
-<div id="credit" hidden></div>
+<footer id="keys">Space 一時停止 / M 声 / B BGM / E 効果音 / H 手牌を隠す</footer>
+<div id="credits"><span id="credit" hidden></span><span id="bgmcredit" hidden>BGM: shiru8bit (CC BY 3.0)</span></div>
 <script src="/commentate.js"></script>
 </body>
 </html>

data/lib/asterism_games/commentate/assets/sounds/sounds.json

@@ -0,0 +1,335 @@
+{
+  "made_by": "fmruby-core tools/mahjong_sounds.rb (Family mruby's APU, components/apu_emu)",
+  "from": {
+    "flash/app/game/mahjong/mahjong_sound.rb": {
+      "SFX": "a8739fe35e6aa353a1bca456b26bd90f706ce1cbd0b43824f1531f890048e2bd"
+    },
+    "flash/usr/share/sounds/nsf/after_the_rain.nsf": "2d12f597da28207ae72d6ef82ceda6e7a0c32268d09e94328e499a9c6dff1023",
+    "flash/usr/share/sounds/nsf/spring_thing.nsf": "7541ff743d241752fa0b496b1f6ed7146526208c5a4b0d59cff8f8e8d55e45ac",
+    "flash/usr/share/sounds/nsf/encounter.nsf": "d11c34896b7a60a325e7296499e3b58bb4df04dec2d26bdd15bed178baf551a7"
+  },
+  "rate": 15720,
+  "bgm_levels": [
+    0.0,
+    0.3,
+    0.55,
+    1.0
+  ],
+  "bgm_names": [
+    "切",
+    "小",
+    "中",
+    "大"
+  ],
+  "bgm_default": 1,
+  "tense_left": 10,
+  "scenes": {
+    "lobby": "after_the_rain",
+    "play": "spring_thing",
+    "tense": "encounter"
+  },
+  "tunes": {
+    "after_the_rain": {
+      "file": "after_the_rain.mp3",
+      "nsf": "after_the_rain.nsf",
+      "track": 0,
+      "title": "8-bit Chiptune - After The Rain",
+      "author": "shiru8bit",
+      "license": "CC BY 3.0",
+      "intro_s": 0.0167,
+      "loop_s": 153.6,
+      "loop_start": 3.083333,
+      "loop_end": 156.683333,
+      "length_s": 157.6833
+    },
+    "spring_thing": {
+      "file": "spring_thing.mp3",
+      "nsf": "spring_thing.nsf",
+      "track": 0,
+      "title": "8-bit Chiptune - Spring Thing",
+      "author": "shiru8bit",
+      "license": "CC BY 3.0",
+      "intro_s": 1.9167,
+      "loop_s": 115.2,
+      "loop_start": 7.183333,
+      "loop_end": 122.383333,
+      "length_s": 123.3833
+    },
+    "encounter": {
+      "file": "encounter.mp3",
+      "nsf": "encounter.nsf",
+      "track": 0,
+      "title": "8-bit Chiptune - Encounter",
+      "author": "shiru8bit",
+      "license": "CC BY 3.0",
+      "intro_s": 0.0,
+      "loop_s": 128.0,
+      "loop_start": 1.116667,
+      "loop_end": 129.116667,
+      "length_s": 130.1167
+    }
+  },
+  "effects": {
+    "discard": {
+      "file": "discard.wav",
+      "priority": 1,
+      "channels": [
+        3
+      ],
+      "length_s": 0.083
+    },
+    "discard_other": {
+      "file": "discard_other.wav",
+      "priority": 1,
+      "channels": [
+        3
+      ],
+      "length_s": 0.05
+    },
+    "draw": {
+      "file": "draw.wav",
+      "priority": 1,
+      "channels": [
+        1
+      ],
+      "length_s": 0.083
+    },
+    "turn": {
+      "file": "turn.wav",
+      "priority": 2,
+      "channels": [
+        0
+      ],
+      "length_s": 0.2
+    },
+    "round": {
+      "file": "round.wav",
+      "priority": 3,
+      "channels": [
+        0,
+        2
+      ],
+      "length_s": 0.545
+    },
+    "yaku": {
+      "file": "yaku.wav",
+      "priority": 2,
+      "channels": [
+        0
+      ],
+      "length_s": 0.117
+    },
+    "points": {
+      "file": "points.wav",
+      "priority": 3,
+      "channels": [
+        0,
+        1,
+        2
+      ],
+      "length_s": 0.476
+    },
+    "riichi": {
+      "file": "riichi.wav",
+      "priority": 3,
+      "channels": [
+        0,
+        1
+      ],
+      "length_s": 0.35
+    },
+    "pon": {
+      "file": "pon.wav",
+      "priority": 3,
+      "channels": [
+        0,
+        3
+      ],
+      "length_s": 0.183
+    },
+    "chi": {
+      "file": "chi.wav",
+      "priority": 3,
+      "channels": [
+        0
+      ],
+      "length_s": 0.167
+    },
+    "kan": {
+      "file": "kan.wav",
+      "priority": 3,
+      "channels": [
+        0,
+        2
+      ],
+      "length_s": 0.374
+    },
+    "ron": {
+      "file": "ron.wav",
+      "priority": 3,
+      "channels": [
+        3,
+        0,
+        1,
+        2
+      ],
+      "length_s": 0.599
+    },
+    "tsumo": {
+      "file": "tsumo.wav",
+      "priority": 3,
+      "channels": [
+        0,
+        1,
+        2
+      ],
+      "length_s": 0.532
+    },
+    "kyuushu": {
+      "file": "kyuushu.wav",
+      "priority": 3,
+      "channels": [
+        0,
+        2
+      ],
+      "length_s": 0.464
+    },
+    "ryuukyoku": {
+      "file": "ryuukyoku.wav",
+      "priority": 3,
+      "channels": [
+        0,
+        2
+      ],
+      "length_s": 0.841
+    },
+    "fanfare1": {
+      "file": "fanfare1.wav",
+      "priority": 4,
+      "channels": [
+        0,
+        1,
+        2
+      ],
+      "length_s": 1.188
+    },
+    "fanfare2": {
+      "file": "fanfare2.wav",
+      "priority": 4,
+      "channels": [
+        0,
+        1,
+        2
+      ],
+      "length_s": 0.783
+    },
+    "fanfare3": {
+      "file": "fanfare3.wav",
+      "priority": 4,
+      "channels": [
+        0,
+        2
+      ],
+      "length_s": 0.853
+    },
+    "fanfare4": {
+      "file": "fanfare4.wav",
+      "priority": 4,
+      "channels": [
+        0,
+        2
+      ],
+      "length_s": 1.06
+    }
+  },
+  "files": {
+    "after_the_rain.mp3": {
+      "sha256": "031f62d6d389cf972ca4d76d4f60eb39aaf81abfddb8cd9bfdadb6a9ee2d0c36",
+      "bytes": 1262208
+    },
+    "chi.wav": {
+      "sha256": "4dc17f9942b7b24c0516e63722edb0337b8a08878436c541a25b008afffd93db",
+      "bytes": 5286
+    },
+    "discard.wav": {
+      "sha256": "b7c7e6d9d85c095086bbb363878f2d43718852faa760ec9a80c22a278af25c3d",
+      "bytes": 2664
+    },
+    "discard_other.wav": {
+      "sha256": "827a02bcc0b4b562c0e5570fbdefa7380c1d93f08d891c5a25b582d78eebc19b",
+      "bytes": 1616
+    },
+    "draw.wav": {
+      "sha256": "109f99db18e74a70c658651fde27080ca3d10e56ad6af9c4923fa79b3cc55c5f",
+      "bytes": 2666
+    },
+    "encounter.mp3": {
+      "sha256": "d266523c8a39b9df416ba0e279b3d408ed53aa9cb9eb4dd91c234f3e81ab7e70",
+      "bytes": 1041600
+    },
+    "fanfare1.wav": {
+      "sha256": "1c033836febf9f7fd4453c33233fd23103f4ad0f86caf385faf86227e38d2a90",
+      "bytes": 37404
+    },
+    "fanfare2.wav": {
+      "sha256": "7c5cf3343d909d0fd0c0bc7218ef27b824d3ee3b217ed3b80ada4141813dd9b3",
+      "bytes": 24652
+    },
+    "fanfare3.wav": {
+      "sha256": "1bf38ce91857961b980d268adb8898a5242c159d1d4f00a5e8243fc919b94c57",
+      "bytes": 26872
+    },
+    "fanfare4.wav": {
+      "sha256": "f75997ee293281fa8b5c5dc0a33980def453f6a889cba16a36cb2449e3ef87c1",
+      "bytes": 33362
+    },
+    "kan.wav": {
+      "sha256": "50ac3498c781e1c7cfd1275c9625167650d1b1390719bc544dc6e90aa73e06f9",
+      "bytes": 11790
+    },
+    "kyuushu.wav": {
+      "sha256": "73d5c7a57ad5dd109df0da1cde6364943ac9b956233cac1336c5d5d517bcf7af",
+      "bytes": 14626
+    },
+    "points.wav": {
+      "sha256": "2b6167f3bc36339118e30b290a8a2fe9b5069da5cb2b6160b1be89db24546296",
+      "bytes": 15004
+    },
+    "pon.wav": {
+      "sha256": "cf904f8855444198c89a76d76acf1041efc42dd888b3ad0f1f964099ab1ee8d8",
+      "bytes": 5810
+    },
+    "riichi.wav": {
+      "sha256": "e8d8064abba1da685453bc0fb30d938a2da5ad69aef69e4993459676c1a75e65",
+      "bytes": 11050
+    },
+    "ron.wav": {
+      "sha256": "aaec44cfe51ffb0219e6936cd0642e0b8b972b0f4e21625fb54d1e36028e4029",
+      "bytes": 18892
+    },
+    "round.wav": {
+      "sha256": "f2857dd2e45e0a1e130e63285119e3072a35056f571954f95665cce81b7047d4",
+      "bytes": 17164
+    },
+    "ryuukyoku.wav": {
+      "sha256": "105f366cf26b8be5e8aa210886c05b91965e566ecf610a64b4b5b63db452bff7",
+      "bytes": 26500
+    },
+    "spring_thing.mp3": {
+      "sha256": "55f90585c6994293d33ece9145b9a7f58c457a86a9b466c52882997a12fb87db",
+      "bytes": 987648
+    },
+    "tsumo.wav": {
+      "sha256": "2f849a68fe071355714322e0e5693c529067621c7030252ad6efce69f7ef5750",
+      "bytes": 16766
+    },
+    "turn.wav": {
+      "sha256": "a2813659474f629ea8fc88e5dc4eae70ba662d8bbe569178089522c929edd0c4",
+      "bytes": 6334
+    },
+    "yaku.wav": {
+      "sha256": "b19fbb15ad4ee6125bfa9ebe31c3701d6a25551a2bdb7e490f68c1f26dd3d8a5",
+      "bytes": 3714
+    }
+  }
+}

data/lib/asterism_games/commentate/mahjong.rb

@@ -4,6 +4,7 @@ require "json"
 require "monitor"
 require_relative "mahjong_events"
 require_relative "mahjong_phrases"
+require_relative "mahjong_sounds"
 require_relative "server"
 require_relative "voice"
 require_relative "ai_comment"
@@ -68,6 +69,7 @@ module AsterismGames
           t["gone"] = false
           t["at"] = @clock.call
           evs, t["memo"] = MahjongEvents.diff(t["view"], view, t["memo"])
+          sounds = MahjongSounds.effects(t["view"], view)
           evs.each do |ev|
             l = MahjongPhrases.line(ev, view, @rng, tone: @tone)
             l = public_line(l) if @public
@@ -82,8 +84,7 @@ module AsterismGames
           end
           t["lines"].shift while t["lines"].size > KEEP_LINES
           t["view"] = view
-          out = shown(view)
-          frames << [id, Server.frame("state", { "table" => id, "view" => out })]
+          frames << [id, Server.frame("state", state_frame(id, view).merge("sounds" => sounds))]
           lines.each { |l| frames << [id, Server.frame("line", l)] }
           broadcast_status if fresh || was_gone
           frames.each { |tid, f| each_client(tid) { |c| c.push(f) } }
@@ -182,7 +183,7 @@ module AsterismGames
           out = [["status", status]]
           t = @tables[client.table]
           if t
-            out << ["state", { "table" => client.table, "view" => shown(t["view"]) }]
+            out << ["state", state_frame(client.table, t["view"])]
             t["lines"].each { |l| out << ["line", l.merge("old" => true)] }
           end
           out
@@ -226,7 +227,7 @@ module AsterismGames
           if c.table.nil? && (d = default_table)
             c.table = d
             t = @tables[d]
-            c.push(Server.frame("state", { "table" => d, "view" => shown(t["view"]) })) if t["view"]
+            c.push(Server.frame("state", state_frame(d, t["view"]))) if t["view"]
           end
           c.push(f)
         end
@@ -239,6 +240,12 @@ module AsterismGames
         end
       end
 
+      # A "state" event: the view as it leaves, and the BGM's scene for it
+      # (MahjongSounds; update adds the effects of the step).
+      def state_frame(id, view)
+        { "table" => id, "view" => shown(view), "bgm" => MahjongSounds.scene(view) }
+      end
+
       # The view as it leaves: without the hands with --public.
       def shown(view)
         return view unless @public && view.is_a?(Hash)

data/lib/asterism_games/commentate/mahjong_sounds.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module AsterismGames
+  module Commentate
+    # The sound of Family mruby's mahjong app at the commentary page
+    # (README "Commentary", "The sound"): which of the app's effects a new
+    # spectate view calls for, and the scene of the BGM. Pure functions, as
+    # MahjongEvents: the same two views always give the same sounds.
+    #
+    #   sounds = MahjongSounds.effects(prev, cur)   # [[name, delay_ms], ...]
+    #   scene  = MahjongSounds.scene(cur)           # "lobby", "play", "tense" or "none"
+    #
+    # The names are the app's (mahjong_sound.rb's SFX, the files in
+    # assets/sounds/, sounds.json). The page hears the table as the app's
+    # spectator does: a discard is discard_other whoever made it, and the
+    # player's own sounds (a draw, the turn coming) are not played. In the
+    # order the app plays them, at the same moments:
+    #   a new round           round
+    #   a call, a riichi      chi, pon, kan, riichi (the jingle of the call)
+    #   a discard             discard_other
+    #   a win                 ron or tsumo (the jingle), then points after
+    #                         the shout (1 s), the winner's points
+    #   a draw of the round   ryuukyoku (and the abortive draws: kyuushu for
+    #                         nine kinds, ryuukyoku for the others; three
+    #                         rons is the app's ryuukyoku jingle too)
+    #   the end of the game   fanfare1 (a spectator's: the winner's), after
+    #                         a win's shout when one is sounding
+    # The BGM's scenes are the app's: the lobby (waiting), the game and its
+    # results, the tense one (a riichi on the table, or TENSE_LEFT tiles or
+    # fewer left), and none at the end of a game (the fanfare plays alone).
+    module MahjongSounds
+      TENSE_LEFT = 10 # mahjong_sound.rb's TENSE_LEFT (sounds.json's tense_left)
+      SHOUT_MS = 1000 # how long the app shows a shout (a win's result waits for it)
+      CALLS = { "chi" => "chi", "pon" => "pon", "open_kan" => "kan", "closed_kan" => "kan", "added_kan" => "kan" }.freeze
+      DRAWS = %w[ryuukyoku suufon_renda suukaikan suucha_riichi sanchahou].freeze
+      # Every name these functions give (the files the page needs).
+      NAMES = %w[round chi pon kan riichi discard_other ron tsumo points ryuukyoku kyuushu fanfare1].freeze
+
+      module_function
+
+      # [[name, delay_ms], ...] for the step from prev to cur (nothing for the
+      # first view: that one is old news, as in the app).
+      def effects(prev, cur)
+        return [] unless prev.is_a?(Hash) && cur.is_a?(Hash)
+        out = []
+        st = cur["status"]
+        pst = prev["status"]
+        same = %w[play result].include?(pst) && round_key(prev) == round_key(cur)
+        if st == "play" && !same
+          out << ["round", 0]
+          return out
+        end
+        jingle = nil
+        if same && %w[play result over].include?(st)
+          ps = Array(prev["seats"])
+          Array(cur["seats"]).each_with_index do |s, i|
+            p = ps[i] || {}
+            call = new_call(Array(p["melds"]), Array(s["melds"]))
+            jingle = call if call
+            jingle = "riichi" if s["riichi"] && !p["riichi"]
+          end
+        end
+        res = cur["result"]
+        win = false
+        if %w[result over].include?(st) && res.is_a?(Hash) && (pst == "play" || prev["result"] != res)
+          kind = res["kind"].to_s
+          if %w[ron_agari tsumo_agari].include?(kind)
+            jingle = kind == "ron_agari" ? "ron" : "tsumo"
+            win = true
+          elsif kind == "kyuushu_kyuuhai"
+            jingle = "kyuushu"
+          elsif DRAWS.include?(kind)
+            jingle = "ryuukyoku"
+          end
+        end
+        out << [jingle, 0] if jingle
+        out << ["discard_other", 0] if st == "play" && pst == "play" && same && river_n(cur) > river_n(prev)
+        if st == "over" && pst != "over"
+          out << ["fanfare1", jingle ? SHOUT_MS : 0]
+        elsif win
+          out << ["points", SHOUT_MS]
+        end
+        out
+      end
+
+      # The BGM's scene for a view (nil: no table yet, the lobby's tune).
+      def scene(view)
+        return "lobby" unless view.is_a?(Hash)
+        st = view["status"]
+        return "lobby" if st == "wait"
+        return "none" if st == "over"
+        return "play" unless %w[play result].include?(st)
+        riichi = Array(view["seats"]).any? { |s| s.is_a?(Hash) && s["riichi"] }
+        left = view.dig("round", "wall_left")
+        riichi || (st == "play" && left.is_a?(Integer) && left <= TENSE_LEFT) ? "tense" : "play"
+      end
+
+      def round_key(v)
+        r = v["round"]
+        r.is_a?(Hash) ? [r["wind"], r["number"], r["honba"]] : nil
+      end
+
+      def river_n(v)
+        Array(v["seats"]).sum { |s| s.is_a?(Hash) ? Array(s["river"]).size : 0 }
+      end
+
+      # The jingle of a seat's new meld, or nil.
+      def new_call(old, cur)
+        return CALLS[cur.last["type"].to_s] if cur.size > old.size && cur.last.is_a?(Hash)
+        cur.each_with_index do |m, j|
+          o = old[j]
+          return "kan" if o.is_a?(Hash) && m.is_a?(Hash) && o["type"] != m["type"] && m["type"] == "added_kan"
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/asterism_games/commentate/server.rb

@@ -15,7 +15,9 @@ module AsterismGames
     # VOICEVOX voice (the hub's voice), also the fixed phrases'
     # files (/clip/<digest>.wav, only those of the list) and the lines'
     # sound (/voice/<digest>.wav, only the texts the hub registered:
-    # never a text a page sends).
+    # never a text a page sends). And the mahjong app's sound (README "The
+    # sound"): /sounds/<name>.wav|mp3 and their sounds.json, the files of
+    # assets/sounds/ only, with their note (/SOUNDS_LICENSE.txt).
     class Server
       ASSETS = File.expand_path("assets", __dir__)
       FILES = {
@@ -25,8 +27,11 @@ module AsterismGames
         "/commentate.css" => ["commentate.css", "text/css; charset=utf-8"],
         "/tiles_hand.bmp" => ["tiles_hand.bmp", "image/bmp"],
         "/tiles_river.bmp" => ["tiles_river.bmp", "image/bmp"],
-        "/TILES_LICENSE.txt" => ["TILES_LICENSE.txt", "text/plain; charset=utf-8"]
+        "/TILES_LICENSE.txt" => ["TILES_LICENSE.txt", "text/plain; charset=utf-8"],
+        "/SOUNDS_LICENSE.txt" => ["SOUNDS_LICENSE.txt", "text/plain; charset=utf-8"]
       }.freeze
+      SOUNDS = %r{\A/sounds/([a-z0-9_]+\.(wav|mp3|json))\z}
+      SOUND_TYPES = { "wav" => "audio/wav", "mp3" => "audio/mpeg", "json" => "application/json; charset=utf-8" }.freeze
       CLIP = %r{\A/clip/([0-9a-f]{16}\.wav)\z}
       LIVE = %r{\A/voice/([0-9a-f]{32}\.wav)\z}
       LOCAL_HOSTS = %w[127.0.0.1 localhost].freeze
@@ -98,6 +103,13 @@ module AsterismGames
           return respond(sock, 404, "text/plain", "not found\n") unless body
           respond(sock, 200, "audio/wav", method == "HEAD" ? "" : body, "Cache-Control" => "max-age=600",
                                                                 "Content-Length" => body.bytesize.to_s)
+        elsif (m = path.match(SOUNDS))
+          file = File.join(ASSETS, "sounds", m[1])
+          return respond(sock, 404, "text/plain", "not found\n") unless File.file?(file)
+          body = File.binread(file)
+          cache = m[2] == "json" ? "no-cache" : "max-age=3600"
+          respond(sock, 200, SOUND_TYPES[m[2]], method == "HEAD" ? "" : body, "Cache-Control" => cache,
+                                                                         "Content-Length" => body.bytesize.to_s)
         elsif (f = FILES[path])
           body = File.binread(File.join(ASSETS, f[0]))
           respond(sock, 200, f[1], method == "HEAD" ? "" : body, "Cache-Control" => "no-cache",

data/lib/asterism_games/commentate.rb

@@ -56,8 +56,14 @@ module AsterismGames
                               fixed commentary alone
         -h, --help            this text
 
-      The page: Space pauses, M turns the voice off and on, H hides the hands.
-      The browser speaks once the page has been clicked (its autoplay rule).
+      The page: Space pauses, M turns the voice off and on, B steps the BGM
+      (off, low, mid, high), E turns the effects off and on, H hides the
+      hands. The browser speaks once the page has been clicked (its autoplay rule).
+
+      The sound: the BGM and the effects of Family mruby's mahjong app, at
+      the app's moments, the BGM low by default and lower while the voice
+      speaks. The BGM is shiru8bit's (CC BY 3.0): the page shows the credit
+      (BGM: shiru8bit (CC BY 3.0)); put it in a stream's description too.
 
       The voice: VOICEVOX's character says the fixed phrases (リーチ, ポン,
       ロン, the rounds ...) from WAV files made on this machine at the first

data/lib/asterism_games/play/mahjong.rb

@@ -327,7 +327,9 @@ module AsterismGames
         return "待ち合わせを待っています" unless v["st"] == "wait"
         return nil unless OWNER_WORDS.include?(w)
         unless MahjongText.owner?(v)
-          return v["me"].to_i >= 0 ? "卓の主を待っています" : "席に着くのを待っています"
+          # Seated or not, the role is someone else's (since games 0.20.0
+          # an owner may be unseated): wait for it to come here.
+          return "卓の主ではありません。卓の主の役が回ってくるのを待っています"
         end
         return "4 席がそろうのを待っています" if %w[start watch].include?(w) && (v["sk"] || [0]).any?(&:zero?)
         nil