author Matthew Gregan <>
Mon, 15 Sep 2014 18:10:00 +1200
changeset 206001 e14e8c4b30216df3c66cbc39ad7d7b0e83a0799d
parent 206000 f5d2ffa0f1a8bfe2f7c5b92236f62431a54d691e
permissions -rw-r--r--
Bug 1067414 - Add a comment about thread-safety of unlocked sPreferredSampleRate reads. Also, fix return type of MaxNumberOfChannels and PreferredSampleRate.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */

#if !defined(CubebUtils_h_)
#define CubebUtils_h_

#include "cubeb/cubeb.h"
#include "mozilla/dom/AudioChannelBinding.h"

namespace mozilla {
namespace CubebUtils {

// Initialize Audio Library. Some Audio backends require initializing the
// library before using it.
void InitLibrary();

// Shutdown Audio Library. Some Audio backends require shutting down the
// library after using it.
void ShutdownLibrary();

// Returns the maximum number of channels supported by the audio hardware.
uint32_t MaxNumberOfChannels();

// Queries the samplerate the hardware/mixer runs at, and stores it.
// Can be called on any thread. When this returns, it is safe to call
// PreferredSampleRate.
void InitPreferredSampleRate();

// Get the aforementioned sample rate. Thread safe.
uint32_t PreferredSampleRate();

void PrefChanged(const char* aPref, void* aClosure);
double GetVolumeScale();
bool GetFirstStream();
cubeb* GetCubebContext();
cubeb* GetCubebContextUnlocked();
uint32_t GetCubebLatency();
bool CubebLatencyPrefSet();
#if defined(__ANDROID__) && defined(MOZ_B2G)
cubeb_stream_type ConvertChannelToCubebType(dom::AudioChannel aChannel);

} // namespace CubebUtils
} // namespace mozilla

#endif // CubebUtils_h_