Merge branch 'main' of github.com:aclai-lab/Audio911.jl

.github/workflows/CompatHelper.yml

@@ -0,0 +1,44 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if Julia is already available in the PATH
+        id: julia_in_path
+        run: which julia
+        continue-on-error: true
+      - name: Install Julia, but only if it is not already available in the PATH
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.9'
+          arch: ${{ runner.arch }}
+        if: steps.julia_in_path.outcome != 'success'
+      - name: "Add the General registry via Git"
+        run: |
+          import Pkg
+          ENV["JULIA_PKG_SERVER"] = ""
+          Pkg.Registry.add("General")
+        shell: julia --color=yes {0}
+      - name: "Install CompatHelper"
+        run: |
+          import Pkg
+          name = "CompatHelper"
+          uuid = "aa819f21-2bde-4658-8897-bab36330d9b7"
+          version = "3"
+          Pkg.add(; name, uuid, version)
+        shell: julia --color=yes {0}
+      - name: "Run CompatHelper"
+        run: |
+          import CompatHelper
+          CompatHelper.main()
+        shell: julia --color=yes {0}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/Documentation.yml

@@ -0,0 +1,23 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - main
+      - dev
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: '1.9'
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
+        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/ci.yml

@@ -0,0 +1,20 @@
+name: Upload coverage reports to Codecov
+on: [push, pull_request]
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Julia 1.9.0
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: "1.9.0"
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: aclai-lab/Audio911.jl
+

docs/Project.toml

@@ -0,0 +1,5 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+
+[compat]
+Documenter = "1"

docs/make.jl

@@ -0,0 +1,32 @@
+using Audio911
+using Documenter
+
+DocMeta.setdocmeta!(Audio911, :DocTestSetup, :(using Audio911); recursive = true)
+
+makedocs(;
+    modules = [Audio911],
+    authors = "Mauro Milella, Giovanni Pagliarini, Alberto Paparella, Eduard I. Stan",
+    repo=Documenter.Remotes.GitHub("aclai-lab", "Audio911.jl"),
+    sitename = "Audio911.jl",
+    format = Documenter.HTML(;
+        size_threshold = 4000000,
+        prettyurls = get(ENV, "CI", "false") == "true",
+        canonical = "https://aclai-lab.github.io/Audio911.jl",
+        assets = String[],
+    ),
+    pages = [
+        "Home" => "index.md",
+        "Getting started" => "getting-started.md",
+    ],
+    # NOTE: warning
+    warnonly = :true,
+)
+
+@info "`makedocs` has finished running. "
+
+deploydocs(;
+    repo = "github.com/aclai-lab/Audio911.jl",
+    target = "build",
+    branch = "gh-pages",
+    versions = ["main" => "main", "stable" => "v^", "v#.#", "dev" => "dev"],
+)

docs/src/getting-started.md

@@ -0,0 +1,7 @@
+```@meta
+CurrentModule = SoleLogics
+```
+
+# [Getting started](@id man-core)
+
+TODO

docs/src/index.md

@@ -0,0 +1,25 @@
+```@meta
+CurrentModule = Audio911
+```
+
+# Audio911
+
+Welcome to the documentation for [Audio911.jl](https://github.com/aclai-lab/Audio911.jl), a Julia package for audio feature extraction.
+
+## Feature Summary
+
+Audio911.jl allows for:
+
+TODO
+
+## Installation
+
+To install Audio911.jl, use the Julia package manager:
+```julia
+using Pkg
+Pkg.add("Audio911")
+```
+
+## About
+
+The package is developed by the [ACLAI Lab](https://aclai.unife.it/en/) @ University of Ferrara.

src/utils/speech_detector.jl

@@ -1,6 +1,6 @@
-# include("/home/riccardopasini/.julia/dev/SoleAudio.jl/src/windowing/windows.jl")
-# include("/home/riccardopasini/.julia/dev/SoleAudio.jl/src/windowing/windowing.jl")
-# include("/home/riccardopasini/.julia/dev/SoleAudio.jl/src/fft/spectral.jl")
+# include("../windowing/windows.jl")
+# include("../windowing/windowing.jl")
+# include("../fft/spectral.jl")
 
 function moving_mean(
     x::Vector{T},