proteaaudio: Simple audio library for Windows, Linux, OSX.

[ bsd3, library, sound ] [ Propose Tags ]

Simple audio library for Windows, Linux, OSX. Supports PCM, Ogg and Wav playback and multichannel mixing.


[Skip to Readme]
Versions [faq] 0.6.2, 0.6.3, 0.6.4, 0.6.5, 0.7.0, 0.7.0.1, 0.7.1.0, 0.8.0, 0.9.0
Change log CHANGELOG.md
Dependencies base (==4.*), bytestring (==0.10.*), filepath (>=1.4 && <2), proteaaudio [details]
License BSD-3-Clause
Author Csaba Hruska
Maintainer csaba.hruska@gmail.com
Category Sound
Source repo head: git clone https://github.com/csabahruska/proteaaudio
Uploaded by CsabaHruska at 2020-12-04T15:26:46Z
Distributions NixOS:0.9.0
Executables proteaaudio-play
Downloads 4352 total (23 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Flags

NameDescriptionDefaultType
example

Build with example

DisabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for proteaaudio-0.9.0

[back to package description]

Overview

ProteaAudio is a stereo audio mixer/playback library for

  • Linux (PulseAudio)
  • MacOS (CoreAudio)
  • Windows (DirectSound)

Supported audio formats:

  • Wav
  • Ogg
  • Raw linear PCM

Samples can be loaded from file or memory.

Setup

On Linux you need to install the pulse audio library:

sudo apt install libpulse-dev

Build

Stack

stack setup
stack build

Nix:

stack --nix build

Example

import Control.Monad
import System.Environment
import System.FilePath
import qualified Data.ByteString as SB
import Control.Concurrent

import Sound.ProteaAudio

waitPlayback = do
  n <- soundActiveAll
  when  (n > 0) $ do
    threadDelay oneSec
    waitPlayback

oneSec :: Int
oneSec = 1000000 -- micro seconds

main = do
  args <- getArgs
  filename <- case args of
    a : _ -> pure a
    _ -> fail "usage: proteaaudio-play SAMPLE_FILE_NAME"

  result <- initAudio 64 44100 1024 -- max channels, mixing frequency, mixing buffer size
  unless result $ fail "failed to initialize the audio system"

  -- (A) load sample from file
  sampleA <- sampleFromFile filename 1.0 -- volume

  -- start two sound tracks with shared sample data
  sndTrkA <- soundPlay sampleA 1 1 0 1 -- left volume, right volume, time difference between left and right, pitch factor for playback
  threadDelay oneSec -- wait 1 sec
  sndTrkB <- soundPlay sampleA 1 1 0 1 -- left volume, right volume, time difference between left and right, pitch factor for playback
  soundActive sndTrkB >>= print
  -- play 3 sec
  threadDelay $ 3 * oneSec
  soundStop sndTrkB
  soundActive sndTrkB >>= print
  -- wait sndTrkA to finish
  waitPlayback

  -- (B) load from memory buffer
  buffer <- SB.readFile filename
  sampleB <- case takeExtension filename of
    ".ogg" -> sampleFromMemoryOgg buffer 1.0
    ".wav" -> sampleFromMemoryWav buffer 1.0

  soundPlay sampleB 1 1 0 1 -- left volume, right volume, time difference between left and right, pitch factor for playback
  waitPlayback

  sampleDestroy sampleB
  soundPlay sampleB 1 1 0 1 -- we have invalidated the handle; nothing should happen now
  waitPlayback

  finishAudio