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