2008-07-30 10:50:14 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* vim:set ts=2 sw=2 sts=2 et cindent: */
|
2012-05-21 15:12:37 +04:00
|
|
|
/* 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 http://mozilla.org/MPL/2.0/. */
|
2012-11-14 23:46:40 +04:00
|
|
|
#if !defined(AudioStream_h_)
|
|
|
|
#define AudioStream_h_
|
2008-11-06 23:53:20 +03:00
|
|
|
|
2008-07-30 10:50:14 +04:00
|
|
|
#include "nscore.h"
|
2010-11-17 07:14:19 +03:00
|
|
|
#include "nsISupportsImpl.h"
|
|
|
|
#include "nsIThread.h"
|
2010-11-30 08:37:32 +03:00
|
|
|
#include "nsAutoPtr.h"
|
2012-10-25 14:09:40 +04:00
|
|
|
#include "AudioSampleFormat.h"
|
2012-11-16 07:25:26 +04:00
|
|
|
#include "AudioChannelCommon.h"
|
2008-07-30 10:50:14 +04:00
|
|
|
|
2012-11-14 23:45:33 +04:00
|
|
|
namespace mozilla {
|
|
|
|
|
2012-06-01 08:45:01 +04:00
|
|
|
// Access to a single instance of this class must be synchronized by
|
|
|
|
// callers, or made from a single thread. One exception is that access to
|
2012-10-25 14:09:39 +04:00
|
|
|
// GetPosition, GetPositionInFrames, SetVolume, and Get{Rate,Channels}
|
2012-06-01 08:45:01 +04:00
|
|
|
// is thread-safe without external synchronization.
|
2012-11-14 23:46:40 +04:00
|
|
|
class AudioStream : public nsISupports
|
2008-07-30 10:50:14 +04:00
|
|
|
{
|
2010-11-17 07:14:19 +03:00
|
|
|
public:
|
2012-11-14 23:46:40 +04:00
|
|
|
AudioStream()
|
2012-02-14 08:39:33 +04:00
|
|
|
: mRate(0),
|
2012-08-17 05:10:36 +04:00
|
|
|
mChannels(0)
|
2012-02-14 08:39:33 +04:00
|
|
|
{}
|
|
|
|
|
2012-11-14 23:46:40 +04:00
|
|
|
virtual ~AudioStream();
|
2011-01-04 06:55:32 +03:00
|
|
|
|
2008-11-10 11:12:13 +03:00
|
|
|
// Initialize Audio Library. Some Audio backends require initializing the
|
2011-09-27 07:31:18 +04:00
|
|
|
// library before using it.
|
2008-10-28 19:17:59 +03:00
|
|
|
static void InitLibrary();
|
2008-07-30 10:50:14 +04:00
|
|
|
|
2008-11-10 11:12:13 +03:00
|
|
|
// Shutdown Audio Library. Some Audio backends require shutting down the
|
|
|
|
// library after using it.
|
2008-07-30 10:50:14 +04:00
|
|
|
static void ShutdownLibrary();
|
|
|
|
|
2011-04-03 06:14:00 +04:00
|
|
|
// Thread that is shared between audio streams.
|
2010-11-17 07:14:19 +03:00
|
|
|
// This may return null in the child process
|
2011-01-04 06:55:32 +03:00
|
|
|
nsIThread *GetThread();
|
2010-11-17 07:14:19 +03:00
|
|
|
|
|
|
|
// AllocateStream will return either a local stream or a remoted stream
|
2011-04-03 06:14:00 +04:00
|
|
|
// depending on where you call it from. If you call this from a child process,
|
|
|
|
// you may receive an implementation which forwards to a compositing process.
|
2012-11-14 23:46:40 +04:00
|
|
|
static AudioStream* AllocateStream();
|
2008-07-30 10:50:14 +04:00
|
|
|
|
2011-09-27 07:31:18 +04:00
|
|
|
// Initialize the audio stream. aNumChannels is the number of audio
|
|
|
|
// channels (1 for mono, 2 for stereo, etc) and aRate is the sample rate
|
|
|
|
// (22050Hz, 44100Hz, etc).
|
2012-06-01 08:45:01 +04:00
|
|
|
// Unsafe to call with a monitor held due to synchronous event execution
|
|
|
|
// on the main thread, which may attempt to acquire any held monitor.
|
2012-11-16 07:25:26 +04:00
|
|
|
virtual nsresult Init(int32_t aNumChannels, int32_t aRate,
|
|
|
|
const mozilla::dom::AudioChannelType aAudioStreamType) = 0;
|
2008-07-30 10:50:14 +04:00
|
|
|
|
|
|
|
// Closes the stream. All future use of the stream is an error.
|
2012-06-01 08:45:01 +04:00
|
|
|
// Unsafe to call with a monitor held due to synchronous event execution
|
|
|
|
// on the main thread, which may attempt to acquire any held monitor.
|
2010-11-17 07:14:19 +03:00
|
|
|
virtual void Shutdown() = 0;
|
2008-07-30 10:50:14 +04:00
|
|
|
|
2012-10-25 14:10:51 +04:00
|
|
|
// Write audio data to the audio hardware. aBuf is an array of AudioDataValues
|
|
|
|
// AudioDataValue of length aFrames*mChannels. If aFrames is larger
|
2011-09-27 07:31:18 +04:00
|
|
|
// than the result of Available(), the write will block until sufficient
|
|
|
|
// buffer space is available.
|
2012-10-25 14:10:51 +04:00
|
|
|
virtual nsresult Write(const mozilla::AudioDataValue* aBuf, uint32_t aFrames) = 0;
|
2008-07-30 10:50:14 +04:00
|
|
|
|
2011-09-27 07:31:18 +04:00
|
|
|
// Return the number of audio frames that can be written without blocking.
|
2012-08-22 19:56:38 +04:00
|
|
|
virtual uint32_t Available() = 0;
|
2008-10-19 11:39:21 +04:00
|
|
|
|
2008-07-30 10:50:14 +04:00
|
|
|
// Set the current volume of the audio playback. This is a value from
|
2012-06-01 08:45:01 +04:00
|
|
|
// 0 (meaning muted) to 1 (meaning full volume). Thread-safe.
|
2011-01-17 06:03:00 +03:00
|
|
|
virtual void SetVolume(double aVolume) = 0;
|
2008-07-30 10:50:14 +04:00
|
|
|
|
2008-11-06 23:53:20 +03:00
|
|
|
// Block until buffered audio data has been consumed.
|
2012-06-01 08:45:01 +04:00
|
|
|
// Unsafe to call with a monitor held due to synchronous event execution
|
|
|
|
// on the main thread, which may attempt to acquire any held monitor.
|
2010-11-17 07:14:19 +03:00
|
|
|
virtual void Drain() = 0;
|
2008-11-06 23:53:20 +03:00
|
|
|
|
2009-05-15 05:29:05 +04:00
|
|
|
// Pause audio playback
|
2010-11-17 07:14:19 +03:00
|
|
|
virtual void Pause() = 0;
|
2009-05-15 05:29:05 +04:00
|
|
|
|
|
|
|
// Resume audio playback
|
2010-11-17 07:14:19 +03:00
|
|
|
virtual void Resume() = 0;
|
2009-05-15 05:29:05 +04:00
|
|
|
|
2011-09-27 07:31:18 +04:00
|
|
|
// Return the position in microseconds of the audio frame being played by
|
2012-06-01 08:45:01 +04:00
|
|
|
// the audio hardware. Thread-safe.
|
2012-08-22 19:56:38 +04:00
|
|
|
virtual int64_t GetPosition() = 0;
|
2010-04-02 07:03:07 +04:00
|
|
|
|
2011-09-27 07:31:18 +04:00
|
|
|
// Return the position, measured in audio frames played since the stream
|
2012-06-01 08:45:01 +04:00
|
|
|
// was opened, of the audio hardware. Thread-safe.
|
2012-08-22 19:56:38 +04:00
|
|
|
virtual int64_t GetPositionInFrames() = 0;
|
2010-08-25 17:10:00 +04:00
|
|
|
|
2011-09-30 03:34:37 +04:00
|
|
|
// Returns true when the audio stream is paused.
|
2011-09-29 10:19:26 +04:00
|
|
|
virtual bool IsPaused() = 0;
|
2010-11-30 08:37:32 +03:00
|
|
|
|
2011-09-27 07:31:18 +04:00
|
|
|
// Returns the minimum number of audio frames which must be written before
|
2010-12-19 22:05:40 +03:00
|
|
|
// you can be sure that something will be played.
|
2012-06-01 08:45:01 +04:00
|
|
|
// Unsafe to call with a monitor held due to synchronous event execution
|
|
|
|
// on the main thread, which may attempt to acquire any held monitor.
|
2012-08-22 19:56:38 +04:00
|
|
|
virtual int32_t GetMinWriteSize() = 0;
|
2010-12-19 22:05:40 +03:00
|
|
|
|
2012-02-14 08:39:33 +04:00
|
|
|
int GetRate() { return mRate; }
|
|
|
|
int GetChannels() { return mChannels; }
|
2012-10-25 14:09:38 +04:00
|
|
|
|
2010-11-30 08:37:32 +03:00
|
|
|
protected:
|
|
|
|
nsCOMPtr<nsIThread> mAudioPlaybackThread;
|
2012-02-14 08:39:33 +04:00
|
|
|
int mRate;
|
|
|
|
int mChannels;
|
2008-07-30 10:50:14 +04:00
|
|
|
};
|
2010-11-17 07:14:19 +03:00
|
|
|
|
2012-11-14 23:45:33 +04:00
|
|
|
} // namespace mozilla
|
|
|
|
|
2008-11-06 23:53:20 +03:00
|
|
|
#endif
|