Update audio_processing module
Corresponds to upstream commit 524e9b043e7e86fd72353b987c9d5f6a1ebf83e1 Update notes: * Pull in third party license file * Replace .gypi files with BUILD.gn to keep track of what changes upstream * Bunch of new filse pulled in as dependencies * Won't build yet due to changes needed on top of these
This commit is contained in:
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2011 The WebRTC project authors. All Rights Reserved.
|
||||
* Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
|
||||
*
|
||||
* Use of this source code is governed by a BSD-style license
|
||||
* that can be found in the LICENSE file in the root of the source
|
||||
@ -11,58 +11,69 @@
|
||||
#ifndef MODULES_INTERFACE_MODULE_H_
|
||||
#define MODULES_INTERFACE_MODULE_H_
|
||||
|
||||
#include <assert.h>
|
||||
|
||||
#include "typedefs.h"
|
||||
#include "webrtc/typedefs.h"
|
||||
|
||||
namespace webrtc {
|
||||
|
||||
class ProcessThread;
|
||||
|
||||
class Module {
|
||||
public:
|
||||
// Returns version of the module and its components.
|
||||
virtual int32_t Version(char* version,
|
||||
uint32_t& remaining_buffer_in_bytes,
|
||||
uint32_t& position) const = 0;
|
||||
|
||||
// Change the unique identifier of this object.
|
||||
virtual int32_t ChangeUniqueId(const int32_t id) = 0;
|
||||
|
||||
// Returns the number of milliseconds until the module want a worker
|
||||
// Returns the number of milliseconds until the module wants a worker
|
||||
// thread to call Process.
|
||||
virtual int32_t TimeUntilNextProcess() = 0;
|
||||
// This method is called on the same worker thread as Process will
|
||||
// be called on.
|
||||
// TODO(tommi): Almost all implementations of this function, need to know
|
||||
// the current tick count. Consider passing it as an argument. It could
|
||||
// also improve the accuracy of when the next callback occurs since the
|
||||
// thread that calls Process() will also have it's tick count reference
|
||||
// which might not match with what the implementations use.
|
||||
virtual int64_t TimeUntilNextProcess() = 0;
|
||||
|
||||
// Process any pending tasks such as timeouts.
|
||||
// Called on a worker thread.
|
||||
virtual int32_t Process() = 0;
|
||||
|
||||
// This method is called when the module is attached to a *running* process
|
||||
// thread or detached from one. In the case of detaching, |process_thread|
|
||||
// will be nullptr.
|
||||
//
|
||||
// This method will be called in the following cases:
|
||||
//
|
||||
// * Non-null process_thread:
|
||||
// * ProcessThread::RegisterModule() is called while the thread is running.
|
||||
// * ProcessThread::Start() is called and RegisterModule has previously
|
||||
// been called. The thread will be started immediately after notifying
|
||||
// all modules.
|
||||
//
|
||||
// * Null process_thread:
|
||||
// * ProcessThread::DeRegisterModule() is called while the thread is
|
||||
// running.
|
||||
// * ProcessThread::Stop() was called and the thread has been stopped.
|
||||
//
|
||||
// NOTE: This method is not called from the worker thread itself, but from
|
||||
// the thread that registers/deregisters the module or calls Start/Stop.
|
||||
virtual void ProcessThreadAttached(ProcessThread* process_thread) {}
|
||||
|
||||
protected:
|
||||
virtual ~Module() {}
|
||||
};
|
||||
|
||||
// Reference counted version of the module interface.
|
||||
// Reference counted version of the Module interface.
|
||||
class RefCountedModule : public Module {
|
||||
public:
|
||||
// Increase the reference count by one.
|
||||
// Returns the incremented reference count.
|
||||
// TODO(perkj): Make this pure virtual when Chromium have implemented
|
||||
// reference counting ADM and Video capture module.
|
||||
virtual int32_t AddRef() {
|
||||
assert(!"Not implemented.");
|
||||
return 1;
|
||||
}
|
||||
virtual int32_t AddRef() const = 0;
|
||||
|
||||
// Decrease the reference count by one.
|
||||
// Returns the decreased reference count.
|
||||
// Returns 0 if the last reference was just released.
|
||||
// When the reference count reach 0 the object will self-destruct.
|
||||
// TODO(perkj): Make this pure virtual when Chromium have implemented
|
||||
// reference counting ADM and Video capture module.
|
||||
virtual int32_t Release() {
|
||||
assert(!"Not implemented.");
|
||||
return 1;
|
||||
}
|
||||
// When the reference count reaches 0 the object will self-destruct.
|
||||
virtual int32_t Release() const = 0;
|
||||
|
||||
protected:
|
||||
virtual ~RefCountedModule() {}
|
||||
~RefCountedModule() override = default;
|
||||
};
|
||||
|
||||
} // namespace webrtc
|
||||
|
Reference in New Issue
Block a user