Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

AudioPlayer completionHandler #2916 fix #2917

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+30 −12
Open

AudioPlayer completionHandler #2916 fix #2917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cdcd0e6
Add test for #2916
emurray2 May 16, 2024
c374f8c
Test based off audio instead of status
emurray2 May 16, 2024
729157e
Remove references to thread-unsafe variables #2916
emurray2 May 16, 2024
dacfbf4
Add extra thread-safety note to docs
emurray2 May 16, 2024
a16b029
hound
emurray2 May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 3 additions & 12 deletions Sources/AudioKit/Nodes/Playback/AudioPlayer/AudioPlayer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ public class AudioPlayer: Node {

/// Completion handler to be called when file or buffer is done playing.
/// This also will be called when looping from disk,
/// but no completion is called when looping seamlessly when buffered
/// but no completion is called when looping seamlessly when buffered.
/// This runs on an asyncronous thread and
/// requires thread-safety practice. See: https://web.mit.edu/6.031/www/fa17/classes/20-thread-safety/.
public var completionHandler: AVAudioNodeCompletionHandler?

/// The file to use with the player. This can be set while the player is playing.
Expand Down Expand Up @@ -197,18 +199,7 @@ public class AudioPlayer: Node {
// MARK: - Internal functions

func internalCompletionHandler() {
guard status == .playing,
!isSeeking,
engine?.isInManualRenderingMode == false else { return }

completionHandler?()

if isLooping, !isBuffered {
status = .stopped
play()
} else {
status = .stopped
}
}

// MARK: - Init
Expand Down
26 changes: 26 additions & 0 deletions Tests/AudioKitTests/Node Tests/Player Tests/AudioPlayerTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,4 +522,30 @@ class AudioPlayerTests: XCTestCase {
XCTAssert(player.status == .stopped)
testMD5(audio)
}

// https://github.com/AudioKit/AudioKit/issues/2916
func testCompletionHandler() {
guard let counting = Bundle.module.url(forResource: "TestResources/12345", withExtension: "wav")
else {
XCTFail("Couldn't find file")
return
}
guard let drumLoop = Bundle.module.url(forResource: "TestResources/drumloop", withExtension: "wav")
else {
XCTFail("Couldn't find file")
return
}
let engine = AudioEngine()
let player = AudioPlayer()
engine.output = player
player.completionHandler = {
try? player.load(url: drumLoop)
player.play()
}
try? player.load(url: counting)
let audio = engine.startTest(totalDuration: 9.0)
player.play()
audio.append(engine.render(duration: 9.0))
testMD5(audio)
}
}
1 change: 1 addition & 0 deletions Tests/AudioKitTests/ValidatedMD5s.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ let validatedMD5s: [String: [String]] = [
"-[AudioPlayerTests testSeekWillStop]": ["84b026cbdf45d9c5f5659f1106fdee6a"],
"-[AudioPlayerTests testSeekWillContinueLooping]": ["5becbd9530850f217f95ee1142a8db30"],
"-[AudioPlayerTests testPlaybackWillStopWhenSettingLoopingForBuffer]": ["5becbd9530850f217f95ee1142a8db30"],
"-[AudioPlayerTests testCompletionHandler]": ["931361a78333a754a4c357aa82301e94"],
"-[CompressorTests testAttackTime]": ["f2da585c3e9838c1a41f1a5f34c467d0"],
"-[CompressorTests testDefault]": ["3064ef82b30c512b2f426562a2ef3448"],
"-[CompressorTests testHeadRoom]": ["98ac5f20a433ba5a858c461aa090d81f", "db27f010ec481cd02ca73b8652c4f7c1"],
Expand Down