109 lines
4.5 KiB
C++
109 lines
4.5 KiB
C++
/*
|
||
* Copyright (c) 2011 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
|
||
* tree. An additional intellectual property rights grant can be found
|
||
* in the file PATENTS. All contributing project authors may
|
||
* be found in the AUTHORS file in the root of the source tree.
|
||
*/
|
||
|
||
// This sub-API supports the following functionalities:
|
||
// - Effect filters
|
||
// - Deflickering
|
||
// - Denoising
|
||
// - Color enhancement
|
||
|
||
|
||
#ifndef WEBRTC_VIDEO_ENGINE_MAIN_INTERFACE_VIE_IMAGE_PROCESS_H_
|
||
#define WEBRTC_VIDEO_ENGINE_MAIN_INTERFACE_VIE_IMAGE_PROCESS_H_
|
||
|
||
#include "common_types.h"
|
||
|
||
namespace webrtc
|
||
{
|
||
class VideoEngine;
|
||
|
||
// ----------------------------------------------------------------------------
|
||
// ViEEffectFilter
|
||
// ----------------------------------------------------------------------------
|
||
|
||
// This class declares an abstract interface for a user defined effect filter.
|
||
// The effect filter is registered using RegisterCaptureEffectFilter(),
|
||
// RegisterSendEffectFilter() or RegisterRenderEffectFilter() and deregistered
|
||
// with the corresponding deregister function.
|
||
class WEBRTC_DLLEXPORT ViEEffectFilter
|
||
{
|
||
public:
|
||
// This method is called with an I420 video frame allowing the user to
|
||
// modify the video frame.
|
||
virtual int Transform(int size, unsigned char* frameBuffer,
|
||
unsigned int timeStamp90KHz, unsigned int width,
|
||
unsigned int height) = 0;
|
||
protected:
|
||
ViEEffectFilter() {}
|
||
virtual ~ViEEffectFilter(){}
|
||
};
|
||
|
||
// ----------------------------------------------------------------------------
|
||
// ViEImageProcess
|
||
// ----------------------------------------------------------------------------
|
||
|
||
class WEBRTC_DLLEXPORT ViEImageProcess
|
||
{
|
||
public:
|
||
// Factory for the ViEImageProcess sub‐API and increases an internal
|
||
// reference counter if successful. Returns NULL if the API is not supported
|
||
// or if construction fails.
|
||
static ViEImageProcess* GetInterface(VideoEngine* videoEngine);
|
||
|
||
// Releases the ViEImageProcess sub-API and decreases an internal reference
|
||
// counter. Returns the new reference count. This value should be zero
|
||
// for all sub-API:s before the VideoEngine object can be safely deleted.
|
||
virtual int Release() = 0;
|
||
|
||
// This function registers a EffectFilter to use for a specified capture
|
||
// device.
|
||
virtual int RegisterCaptureEffectFilter(const int captureId,
|
||
ViEEffectFilter& captureFilter) = 0;
|
||
|
||
// This function deregisters a EffectFilter for a specified capture device.
|
||
virtual int DeregisterCaptureEffectFilter(const int captureId) = 0;
|
||
|
||
// This function registers an EffectFilter to use for a specified channel.
|
||
virtual int RegisterSendEffectFilter(const int videoChannel,
|
||
ViEEffectFilter& sendFilter) = 0;
|
||
|
||
// This function deregisters a send effect filter for a specified channel.
|
||
virtual int DeregisterSendEffectFilter(const int videoChannel) = 0;
|
||
|
||
// This function registers a EffectFilter to use for the rendered video
|
||
// stream on an incoming channel.
|
||
virtual int RegisterRenderEffectFilter(const int videoChannel,
|
||
ViEEffectFilter& renderFilter) = 0;
|
||
|
||
// This function deregisters a render effect filter for a specified channel.
|
||
virtual int DeregisterRenderEffectFilter(const int videoChannel) = 0;
|
||
|
||
// All cameras run the risk of getting in almost perfect sync with
|
||
// florescent lamps, which will result in a very annoying flickering of the
|
||
// image. Most cameras have some type of filter to protect against this but
|
||
// not all of them succeed. Enabling this function will remove the flicker.
|
||
virtual int EnableDeflickering(const int captureId, const bool enable) = 0;
|
||
|
||
// Some cameras produce very noisy captured images, especially in low‐light
|
||
// conditions. This functionality will reduce the camera noise.
|
||
virtual int EnableDenoising(const int captureId, const bool enable) = 0;
|
||
|
||
// This function enhances the colors on the decoded video stream, enabled by
|
||
// default.
|
||
virtual int EnableColorEnhancement(const int videoChannel,
|
||
const bool enable) = 0;
|
||
|
||
protected:
|
||
ViEImageProcess() {};
|
||
virtual ~ViEImageProcess() {};
|
||
};
|
||
} // namespace webrtc
|
||
#endif // WEBRTC_VIDEO_ENGINE_MAIN_INTERFACE_VIE_IMAGE_PROCESS_H_
|