3698bf5ef694ca97dfdc3580203867e49517b26f
[WebKit-https.git] / Source / WebCore / Modules / webaudio / AsyncAudioDecoder.cpp
1 /*
2  * Copyright (C) 2011, Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1.  Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2.  Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #include "config.h"
26
27 #if ENABLE(WEB_AUDIO)
28
29 #include "AsyncAudioDecoder.h"
30
31 #include "AudioBuffer.h"
32 #include "AudioBufferCallback.h"
33 #include <runtime/ArrayBuffer.h>
34 #include <wtf/MainThread.h>
35
36 namespace WebCore {
37
38 AsyncAudioDecoder::AsyncAudioDecoder()
39 {
40     // Start worker thread.
41     MutexLocker lock(m_threadCreationMutex);
42     m_threadID = createThread(AsyncAudioDecoder::threadEntry, this, "Audio Decoder");
43 }
44
45 AsyncAudioDecoder::~AsyncAudioDecoder()
46 {
47     m_queue.kill();
48     
49     // Stop thread.
50     waitForThreadCompletion(m_threadID);
51     m_threadID = 0;
52 }
53
54 void AsyncAudioDecoder::decodeAsync(ArrayBuffer* audioData, float sampleRate, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback)
55 {
56     ASSERT(isMainThread());
57     ASSERT(audioData);
58     if (!audioData)
59         return;
60
61     auto decodingTask = DecodingTask::create(audioData, sampleRate, successCallback, errorCallback);
62     m_queue.append(std::move(decodingTask)); // note that ownership of the task is effectively taken by the queue.
63 }
64
65 // Asynchronously decode in this thread.
66 void AsyncAudioDecoder::threadEntry(void* threadData)
67 {
68     ASSERT(threadData);
69     AsyncAudioDecoder* decoder = reinterpret_cast<AsyncAudioDecoder*>(threadData);
70     decoder->runLoop();
71 }
72
73 void AsyncAudioDecoder::runLoop()
74 {
75     ASSERT(!isMainThread());
76
77     {
78         // Wait for until we have m_threadID established before starting the run loop.
79         MutexLocker lock(m_threadCreationMutex);
80     }
81
82     // Keep running decoding tasks until we're killed.
83     while (auto decodingTask = m_queue.waitForMessage()) {
84         // Let the task take care of its own ownership.
85         // See DecodingTask::notifyComplete() for cleanup.
86         decodingTask.release()->decode();
87     }
88 }
89
90 std::unique_ptr<AsyncAudioDecoder::DecodingTask> AsyncAudioDecoder::DecodingTask::create(ArrayBuffer* audioData, float sampleRate, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback)
91 {
92     return std::unique_ptr<DecodingTask>(new DecodingTask(audioData, sampleRate, successCallback, errorCallback));
93 }
94
95 AsyncAudioDecoder::DecodingTask::DecodingTask(ArrayBuffer* audioData, float sampleRate, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback)
96     : m_audioData(audioData)
97     , m_sampleRate(sampleRate)
98     , m_successCallback(successCallback)
99     , m_errorCallback(errorCallback)
100 {
101 }
102
103 void AsyncAudioDecoder::DecodingTask::decode()
104 {
105     ASSERT(m_audioData.get());
106     if (!m_audioData.get())
107         return;
108
109     // Do the actual decoding and invoke the callback.
110     m_audioBuffer = AudioBuffer::createFromAudioFileData(m_audioData->data(), m_audioData->byteLength(), false, sampleRate());
111     
112     // Decoding is finished, but we need to do the callbacks on the main thread.
113     callOnMainThread(notifyCompleteDispatch, this);
114 }
115
116 void AsyncAudioDecoder::DecodingTask::notifyCompleteDispatch(void* userData)
117 {
118     AsyncAudioDecoder::DecodingTask* task = reinterpret_cast<AsyncAudioDecoder::DecodingTask*>(userData);
119     ASSERT(task);
120     if (!task)
121         return;
122
123     task->notifyComplete();
124 }
125
126 void AsyncAudioDecoder::DecodingTask::notifyComplete()
127 {
128     if (audioBuffer() && successCallback())
129         successCallback()->handleEvent(audioBuffer());
130     else if (errorCallback())
131         errorCallback()->handleEvent(audioBuffer());
132
133     // Our ownership was given up in AsyncAudioDecoder::runLoop()
134     // Make sure to clean up here.
135     delete this;
136 }
137
138 } // namespace WebCore
139
140 #endif // ENABLE(WEB_AUDIO)