build based on f2bc8a9

.editorconfig

@@ -0,0 +1,18 @@
+# https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Set default charset
+[*.jl]
+charset = utf-8
+
+# 4 space indentation
+[*.jl]
+indent_style = space
+indent_size = 4

.github/workflows/CI.yml

@@ -0,0 +1,52 @@
+name: CI
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.6'
+          - 'nightly'
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macOS-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v1
+        with:
+          file: lcov.info
+#     - uses: julia-actions/julia-uploadcoveralls@v1
+#       env:
+#         COVERALLS_TOKEN: ${{ secrets.COVERALLS_TOKEN }}

.github/workflows/CompatHelper.yml

@@ -0,0 +1,20 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * 0 # weekly
+  workflow_dispatch:
+
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} # need ssh
+        run: julia -e 'using CompatHelper; CompatHelper.main()'
+
+# based on:
+# https://github.com/JuliaRegistries/CompatHelper.jl

.github/workflows/Documentation.yml

@@ -0,0 +1,43 @@
+name: Documentation
+
+on:
+  pull_request:
+  push:
+    branches:
+      - 'main'
+      - 'release-'
+    tags: '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: '1.6'
+      - name: Cache artifacts
+        uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - name: Install dependencies
+        run: |
+          julia --project=docs/ -e '
+          ENV["JULIA_PKG_SERVER"] = ""
+          using Pkg
+          Pkg.develop(PackageSpec(path=pwd()))
+          Pkg.instantiate()'
+      - name: BuildAndDeploy
+        env:
+# https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#Authentication:-GITHUB_TOKEN
+#         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia --project=docs/ docs/make.jl

.github/workflows/TagBot.yml

@@ -0,0 +1,15 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/clean.yml

@@ -0,0 +1,28 @@
+# https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#gh-pages-Branch
+
+name: DocPreviewCleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "[email protected]"
+              git rm -rf "previews/PR$PRNUM"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+            fi
+        env:
+            PRNUM: ${{ github.event.number }}

.gitignore

@@ -0,0 +1,29 @@
+# Files generated by invoking Julia with --code-coverage
+*.jl.cov
+*.jl.*.cov
+
+# Files generated by invoking Julia with --track-allocation
+*.jl.mem
+
+# System-specific files and directories generated by the BinaryProvider and BinDeps packages
+# They contain absolute paths specific to the host computer, and so should not be committed
+deps/deps.jl
+deps/build.log
+deps/downloads/
+deps/usr/
+deps/src/
+
+# Build artifacts for creating documentation generated by the Documenter package
+docs/build/
+docs/site/
+
+# File generated by Pkg, the package manager, based on a corresponding Project.toml
+# It records a fixed state of all packages used by the project. As such, it should not be
+# committed for packages, but should be committed for applications that require a static
+# environment.
+Manifest.toml
+
+# other
+.DS_Store
+.*.*.swp
+.benchmarkci

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jeff Fessler <[email protected]> and contributors
+
+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.

Project.toml

@@ -0,0 +1,13 @@
+name = "Sound"
+uuid = "afe32e48-2646-410f-a1df-ae97debbc86b"
+authors = ["Jeff Fessler <[email protected]>"]
+version = "0.1.0"
+
+[deps]
+PortAudio = "80ea8bcb-4634-5cb3-8ee8-a132660d1d2d"
+SampledSignals = "bd7594eb-a658-542f-9e75-4c4d8908c167"
+
+[compat]
+julia = "1.6"
+PortAudio = "1.1"
+SampledSignals = "2.1"

README.md

@@ -0,0 +1,79 @@
+# Sound
+
+https://github.com/JeffFessler/Sound.jl
+
+[![action status][action-img]][action-url]
+[![pkgeval status][pkgeval-img]][pkgeval-url]
+[![codecov][codecov-img]][codecov-url]
+[![license][license-img]][license-url]
+[![docs-stable][docs-stable-img]][docs-stable-url]
+[![docs-dev][docs-dev-img]][docs-dev-url]
+[![code-style][code-blue-img]][code-blue-url]
+
+This Julia repo exports the function `sound`
+that plays an audio signal through a computer's speakers.
+Its usage is designed to be similar to that of
+[Matlab's `sound` command](https://www.mathworks.com/help/matlab/ref/sound.html)
+to facilitate migration.
+
+## Getting started
+
+```julia
+using Pkg
+Pkg.add("Sound")
+```
+
+
+## Example
+
+```julia
+using Sound
+S = 8192 # sampling rate in Hz
+x = cos.(2pi*(1:S÷2)*440/S)
+y = sin.(2pi*(1:S÷2)*660/S)
+sound(x, S) # specify sampling rate
+sound(y) # use default sampling rate of 8192 Hz
+sound([x y]) # stereo
+```
+
+See the
+[documentation](https://jefffessler.github.io/Sound.jl/stable).
+
+
+Matlab also has a
+[`soundsc`](https://www.mathworks.com/help/matlab/ref/soundsc.html)
+command
+that scales the audio;
+such scaling is already built into `sound` here,
+so `soundsc` is unnecessary.
+
+### Compatibility
+
+Tested with Julia ≥ 1.6.
+
+
+### Related packages
+
+* https://github.com/dancasimiro/WAV.jl
+  has a similar `wavplay` function
+* https://github.com/JuliaAudio/PortAudio.jl
+  The `sound` function is just a wrapper around functions in this package.
+
+
+<!-- URLs -->
+[action-img]: https://github.com/JeffFessler/Sound.jl/workflows/CI/badge.svg
+[action-url]: https://github.com/JeffFessler/Sound.jl/actions
+[build-img]: https://github.com/JeffFessler/Sound.jl/workflows/CI/badge.svg?branch=main
+[build-url]: https://github.com/JeffFessler/Sound.jl/actions?query=workflow%3ACI+branch%3Amain
+[pkgeval-img]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/S/Sound.svg
+[pkgeval-url]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/S/Sound.html
+[code-blue-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg
+[code-blue-url]: https://github.com/invenia/BlueStyle
+[codecov-img]: https://codecov.io/github/JeffFessler/Sound.jl/coverage.svg?branch=main
+[codecov-url]: https://codecov.io/github/JeffFessler/Sound.jl?branch=main
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: https://JeffFessler.github.io/Sound.jl/stable
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://JeffFessler.github.io/Sound.jl/dev
+[license-img]: http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat
+[license-url]: LICENSE

dev/.documenter-siteinfo.json

@@ -0,0 +1 @@
+{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-17T02:23:20","documenter_version":"1.4.0"}}