Remove unused parameters from WTF threading API
[WebKit-https.git] / Source / WebCore / webaudio / AsyncAudioDecoder.h
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 #ifndef AsyncAudioDecoder_h
26 #define AsyncAudioDecoder_h
27
28 #include <wtf/Forward.h>
29 #include <wtf/MessageQueue.h>
30 #include <wtf/PassOwnPtr.h>
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/RefPtr.h>
33 #include <wtf/Threading.h>
34
35 namespace WebCore {
36
37 class AudioBuffer;
38 class AudioBufferCallback;
39
40 // AsyncAudioDecoder asynchronously decodes audio file data from an ArrayBuffer in a worker thread.
41 // Upon successful decoding, a completion callback will be invoked with the decoded PCM data in an AudioBuffer.
42
43 class AsyncAudioDecoder {
44     WTF_MAKE_NONCOPYABLE(AsyncAudioDecoder);
45 public:
46     AsyncAudioDecoder();
47     ~AsyncAudioDecoder();
48
49     // Must be called on the main thread.
50     void decodeAsync(ArrayBuffer* audioData, float sampleRate, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback);
51
52 private:
53     class DecodingTask {
54         WTF_MAKE_NONCOPYABLE(DecodingTask);
55     public:
56         static PassOwnPtr<DecodingTask> create(ArrayBuffer* audioData, float sampleRate, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback);
57
58         void decode();
59         
60     private:
61         DecodingTask(ArrayBuffer* audioData, float sampleRate, PassRefPtr<AudioBufferCallback> successCallback, PassRefPtr<AudioBufferCallback> errorCallback);
62
63         ArrayBuffer* audioData() { return m_audioData.get(); }
64         float sampleRate() const { return m_sampleRate; }
65         AudioBufferCallback* successCallback() { return m_successCallback.get(); }
66         AudioBufferCallback* errorCallback() { return m_errorCallback.get(); }
67         AudioBuffer* audioBuffer() { return m_audioBuffer.get(); }
68
69         static void notifyCompleteDispatch(void* userData);
70         void notifyComplete();
71
72         RefPtr<ArrayBuffer> m_audioData;
73         float m_sampleRate;
74         RefPtr<AudioBufferCallback> m_successCallback;
75         RefPtr<AudioBufferCallback> m_errorCallback;
76         RefPtr<AudioBuffer> m_audioBuffer;
77     };
78     
79     static void threadEntry(void* threadData);
80     void runLoop();
81
82     WTF::ThreadIdentifier m_threadID;
83     Mutex m_threadCreationMutex;
84     MessageQueue<DecodingTask> m_queue;
85 };
86
87 } // namespace WebCore
88
89 #endif // AsyncAudioDecoder_h