src/third_party/WebKit/Source/platform/audio/HRTFDatabaseLoader.h

   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 Computer, 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 "platform/audio/HRTFDatabase.h"
  33 #include "platform/heap/Handle.h"
  34 #include "public/platform/WebThread.h"
  35 #include "wtf/HashMap.h"
  36 #include "wtf/ThreadingPrimitives.h"
  37
  38 namespace blink {
  39
  40 // HRTFDatabaseLoader will asynchronously load the default HRTFDatabase in a new thread.
  41
  42 class PLATFORM_EXPORT HRTFDatabaseLoader FINAL : public GarbageCollectedFinalized<HRTFDatabaseLoader> {
  43 public:
  44     // Lazily creates a HRTFDatabaseLoader (if not already created) for the given sample-rate
  45     // and starts loading asynchronously (when created the first time).
  46     // Returns the HRTFDatabaseLoader.
  47     // Must be called from the main thread.
  48     static HRTFDatabaseLoader* createAndLoadAsynchronouslyIfNecessary(float sampleRate);
  49
  50     // Both constructor and destructor must be called from the main thread.
  51     ~HRTFDatabaseLoader();
  52
  53     // Returns true once the default database has been completely loaded.
  54     bool isLoaded() const;
  55
  56     // waitForLoaderThreadCompletion() may be called more than once and is thread-safe.
  57     void waitForLoaderThreadCompletion();
  58
  59     HRTFDatabase* database() { return m_hrtfDatabase.get(); }
  60
  61     float databaseSampleRate() const { return m_databaseSampleRate; }
  62
  63     // Called in asynchronous loading thread.
  64     void load();
  65
  66     void trace(Visitor*) { }
  67
  68 private:
  69     // Both constructor and destructor must be called from the main thread.
  70     explicit HRTFDatabaseLoader(float sampleRate);
  71
  72     // If it hasn't already been loaded, creates a new thread and initiates asynchronous loading of the default database.
  73     // This must be called from the main thread.
  74     void loadAsynchronously();
  75
  76     OwnPtr<HRTFDatabase> m_hrtfDatabase;
  77
  78     // Holding a m_threadLock is required when accessing m_databaseLoaderThread since we access it from multiple threads.
  79     Mutex m_threadLock;
  80     OwnPtr<WebThread> m_databaseLoaderThread;
  81
  82     float m_databaseSampleRate;
  83 };
  84
  85 } // namespace blink
  86
  87 #endif // HRTFDatabaseLoader_h