1/*
2 * Copyright (C) 2010 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 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of Apple Inc. ("Apple") nor the names of
14 * its contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef HRTFDatabaseLoader_h
30#define HRTFDatabaseLoader_h
31
32#include "HRTFDatabase.h"
33#include <memory>
34#include <wtf/Lock.h>
35#include <wtf/RefCounted.h>
36#include <wtf/RefPtr.h>
37#include <wtf/Threading.h>
38
39namespace WebCore {
40
41// HRTFDatabaseLoader will asynchronously load the default HRTFDatabase in a new thread.
42
43class HRTFDatabaseLoader : public RefCounted<HRTFDatabaseLoader> {
44public:
45 // Lazily creates a HRTFDatabaseLoader (if not already created) for the given sample-rate
46 // and starts loading asynchronously (when created the first time).
47 // Returns the HRTFDatabaseLoader.
48 // Must be called from the main thread.
49 static Ref<HRTFDatabaseLoader> createAndLoadAsynchronouslyIfNecessary(float sampleRate);
50
51 // Both constructor and destructor must be called from the main thread.
52 ~HRTFDatabaseLoader();
53
54 // Returns true once the default database has been completely loaded.
55 bool isLoaded() const;
56
57 // waitForLoaderThreadCompletion() may be called more than once and is thread-safe.
58 void waitForLoaderThreadCompletion();
59
60 HRTFDatabase* database() { return m_hrtfDatabase.get(); }
61
62 float databaseSampleRate() const { return m_databaseSampleRate; }
63
64private:
65 // Both constructor and destructor must be called from the main thread.
66 explicit HRTFDatabaseLoader(float sampleRate);
67
68 // If it hasn't already been loaded, creates a new thread and initiates asynchronous loading of the default database.
69 // This must be called from the main thread.
70 void loadAsynchronously();
71
72 // Called in asynchronous loading thread.
73 void load();
74
75 std::unique_ptr<HRTFDatabase> m_hrtfDatabase;
76
77 // Holding a m_threadLock is required when accessing m_databaseLoaderThread.
78 Lock m_threadLock;
79 RefPtr<Thread> m_databaseLoaderThread;
80
81 float m_databaseSampleRate;
82};
83
84} // namespace WebCore
85
86#endif // HRTFDatabaseLoader_h
87