Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
NGIAgoraMediaNode.h
1#pragma once
2#include "AgoraRefPtr.h"
3#include "AgoraBase.h"
4#include "IAgoraLog.h"
5#include "NGIAgoraVideoFrame.h"
6#include "AgoraExtensionVersion.h"
7#include <api/aosl_ref.h>
8
9#ifndef OPTIONAL_PROCESSRESULT_SPECIFIER
10#if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
11#define OPTIONAL_PROCESSRESULT_SPECIFIER ProcessResult::
12#else
13#define OPTIONAL_PROCESSRESULT_SPECIFIER
14#endif
15#endif
16
17namespace webrtc {
18struct AudioFrameHandleInfo;
19} // namespace webrtc
20
21namespace agora {
22namespace rtc {
28 public:
29 // Return false if filter decide to drop the frame.
30 // Implementation should not change samples_per_channel_/sample_rate_hz_/num_channels_
31 // Implementation should just adapt data of audio frame.
40 virtual bool adaptAudioFrame(const media::base::AudioPcmFrame& inAudioFrame,
41 media::base::AudioPcmFrame& adaptedFrame) = 0;
42
50 virtual int getPreferredSampleRate() = 0;
51
60 virtual int getPreferredChannelNumbers() = 0;
61
62 protected:
64};
65
71 public:
82 virtual bool adaptVideoFrame(const media::base::VideoFrame& capturedFrame,
83 media::base::VideoFrame& adaptedFrame) = 0;
84};
85
86// TODO(Bob): private inherit?
95 public:
103 virtual void setEnabled(bool enable) {}
110 virtual bool isEnabled() { return true; }
121 virtual int setProperty(const char* key, const void* buf, size_t buf_size) { return -1; }
132 virtual int getProperty(const char* key, void* buf, size_t buf_size) { return -1; }
140 virtual bool onDataStreamWillStart() { return true; }
145 virtual void onDataStreamWillStop() { }
153 virtual bool isExternal() { return true; }
161 virtual bool isExtensionFilter() { return false; }
162};
163
168 public:
179 virtual int setProperty(const char* key, const void* buf, int buf_size) { return -1; }
190 virtual int getProperty(const char* key, void* buf, int buf_size) { return -1; }
195 virtual int onFrame(const media::base::VideoFrame& videoFrame) = 0;
200 virtual bool isExternalSink() { return true; }
208 virtual bool onDataStreamWillStart() { return true; }
213 virtual void onDataStreamWillStop() { }
220 virtual bool applyMirror() { return false; }
227 virtual bool applyRotation() { return false; }
228};
229
231public:
233 virtual void onEventWithContext(const ExtensionContext& context, const char* key, const char* json_value) {}
234 virtual void onExtensionStoppedWithContext(const ExtensionContext& context) {}
235 virtual void onExtensionStartedWithContext(const ExtensionContext& context) {}
236 virtual void onExtensionErrorWithContext(const ExtensionContext& context, int error, const char* message) {}
237};
238
245 public:
259 virtual int sendAudioPcmData(
260 const void* audio_data, uint32_t capture_timestamp, int64_t presentation_ms,
261 const size_t samples_per_channel, // for 10ms Data, number_of_samples * 100 = sample_rate
262 const agora::rtc::BYTES_PER_SAMPLE bytes_per_sample, // 2
263 const size_t number_of_channels,
264 const uint32_t sample_rate, aosl_ref_t ares = AOSL_REF_INVALID) = 0; // sample_rate > 8000)
265
266 protected:
268};
269
278 public:
291 virtual bool sendEncodedAudioFrame(const uint8_t* payload_data, size_t payload_size,
292 const EncodedAudioFrameInfo& audioFrameInfo, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
293
294 protected:
296};
297
299 public:
309 const uint8_t *packet, size_t length, const media::base::AudioEncodedFrameInfo& info) = 0;
310
312};
313
319 public:
329 const uint8_t *packet, size_t length, const agora::media::base::PacketOptions& options) = 0;
330
332};
333
341 public:
349 virtual bool onMediaControlPacketReceived(uid_t uid, const uint8_t *packet, size_t length) = 0;
350
352};
353
362 public:
374 virtual int sendMediaPacket(const uint8_t *packet, size_t length,
375 const media::base::PacketOptions &options, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
376 protected:
378};
379
388 public:
402 const uint8_t *packet,
403 size_t length, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
404
415 virtual int sendBroadcastMediaControlPacket(const uint8_t *packet, size_t length, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
416
418};
419
425 public:
433 virtual bool onAudioFrame(const media::base::AudioPcmFrame& audioFrame) = 0;
434
435 protected:
437};
438
447 public:
457 virtual int sendVideoFrame(const media::base::ExternalVideoFrame& videoFrame, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
458
459 protected:
461};
462
471 public:
483 virtual bool sendEncodedVideoImage(const uint8_t* imageBuffer, size_t length,
484 const EncodedVideoFrameInfo& videoEncodedFrameInfo, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
485
486 protected:
488};
489
494 public:
553
563 virtual int setBeautyEffectOptions(bool enabled, BeautyOptions options) = 0;
564};
565
570 public:
578 virtual int setRenderMode(media::base::RENDER_MODE_TYPE renderMode, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
587 virtual int setRenderMode(void* view, media::base::RENDER_MODE_TYPE renderMode, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
597 virtual int setMirror(bool mirror, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
608 virtual int setMirror(void* view, bool mirror, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
616 virtual int setView(void* view, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
625 virtual int addView(void* view, const Rectangle& cropArea, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
632 virtual int unsetView(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
639 virtual int removeView(void* view) = 0;
640};
641
642static const int kDeviceIdSize = 128;
643
644class IVideoTrack;
649 public:
650 virtual int getTranscodingDelayMs() = 0;
651 virtual int addVideoTrack(agora_refptr<IVideoTrack> track, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
652 virtual int removeVideoTrack(agora_refptr<IVideoTrack> track, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
653};
654}
655}
Definition AgoraRefPtr.h:31
Definition AgoraRefPtr.h:44
Definition NGIAgoraMediaNode.h:298
virtual bool onEncodedAudioFrameReceived(const uint8_t *packet, size_t length, const media::base::AudioEncodedFrameInfo &info)=0
virtual ~IAudioEncodedFrameReceiver()
Definition NGIAgoraMediaNode.h:311
Definition NGIAgoraMediaNode.h:277
~IAudioEncodedFrameSender()
Definition NGIAgoraMediaNode.h:295
virtual bool sendEncodedAudioFrame(const uint8_t *payload_data, size_t payload_size, const EncodedAudioFrameInfo &audioFrameInfo, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition NGIAgoraMediaNode.h:27
~IAudioFilterBase()
Definition NGIAgoraMediaNode.h:63
virtual int getPreferredSampleRate()=0
virtual bool adaptAudioFrame(const media::base::AudioPcmFrame &inAudioFrame, media::base::AudioPcmFrame &adaptedFrame)=0
virtual int getPreferredChannelNumbers()=0
Definition NGIAgoraMediaNode.h:244
virtual int sendAudioPcmData(const void *audio_data, uint32_t capture_timestamp, int64_t presentation_ms, const size_t samples_per_channel, const agora::rtc::BYTES_PER_SAMPLE bytes_per_sample, const size_t number_of_channels, const uint32_t sample_rate, aosl_ref_t ares=AOSL_REF_INVALID)=0
~IAudioPcmDataSender()
Definition NGIAgoraMediaNode.h:267
Definition NGIAgoraMediaNode.h:424
virtual bool onAudioFrame(const media::base::AudioPcmFrame &audioFrame)=0
~IAudioSinkBase()
Definition NGIAgoraMediaNode.h:436
Definition NGIAgoraMediaNode.h:340
virtual bool onMediaControlPacketReceived(uid_t uid, const uint8_t *packet, size_t length)=0
virtual ~IMediaControlPacketReceiver()
Definition NGIAgoraMediaNode.h:351
Definition NGIAgoraMediaNode.h:387
virtual int sendPeerMediaControlPacket(media::base::user_id_t userId, const uint8_t *packet, size_t length, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual ~IMediaControlPacketSender()
Definition NGIAgoraMediaNode.h:417
virtual int sendBroadcastMediaControlPacket(const uint8_t *packet, size_t length, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition NGIAgoraMediaNode.h:230
virtual void onExtensionStartedWithContext(const ExtensionContext &context)
Definition NGIAgoraMediaNode.h:235
virtual void onEventWithContext(const ExtensionContext &context, const char *key, const char *json_value)
Definition NGIAgoraMediaNode.h:233
virtual void onExtensionStoppedWithContext(const ExtensionContext &context)
Definition NGIAgoraMediaNode.h:234
virtual ~IMediaExtensionObserver()
Definition NGIAgoraMediaNode.h:232
virtual void onExtensionErrorWithContext(const ExtensionContext &context, int error, const char *message)
Definition NGIAgoraMediaNode.h:236
Definition NGIAgoraMediaNode.h:318
virtual bool onMediaPacketReceived(const uint8_t *packet, size_t length, const agora::media::base::PacketOptions &options)=0
virtual ~IMediaPacketReceiver()
Definition NGIAgoraMediaNode.h:331
Definition NGIAgoraMediaNode.h:361
virtual int sendMediaPacket(const uint8_t *packet, size_t length, const media::base::PacketOptions &options, aosl_ref_t ares=AOSL_REF_INVALID)=0
~IMediaPacketSender()
Definition NGIAgoraMediaNode.h:377
Definition NGIAgoraMediaNode.h:493
virtual int setBeautyEffectOptions(bool enabled, BeautyOptions options)=0
Definition NGIAgoraMediaNode.h:470
~IVideoEncodedImageSender()
Definition NGIAgoraMediaNode.h:487
virtual bool sendEncodedVideoImage(const uint8_t *imageBuffer, size_t length, const EncodedVideoFrameInfo &videoEncodedFrameInfo, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition NGIAgoraMediaNode.h:70
virtual bool adaptVideoFrame(const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)=0
Definition NGIAgoraMediaNode.h:94
virtual bool onDataStreamWillStart()
Definition NGIAgoraMediaNode.h:140
virtual bool isExtensionFilter()
Definition NGIAgoraMediaNode.h:161
virtual bool isExternal()
Definition NGIAgoraMediaNode.h:153
virtual bool isEnabled()
Definition NGIAgoraMediaNode.h:110
virtual int setProperty(const char *key, const void *buf, size_t buf_size)
Definition NGIAgoraMediaNode.h:121
virtual void onDataStreamWillStop()
Definition NGIAgoraMediaNode.h:145
virtual int getProperty(const char *key, void *buf, size_t buf_size)
Definition NGIAgoraMediaNode.h:132
virtual void setEnabled(bool enable)
Definition NGIAgoraMediaNode.h:103
Definition NGIAgoraMediaNode.h:446
~IVideoFrameSender()
Definition NGIAgoraMediaNode.h:460
virtual int sendVideoFrame(const media::base::ExternalVideoFrame &videoFrame, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition NGIAgoraMediaNode.h:648
virtual int addVideoTrack(agora_refptr< IVideoTrack > track, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int removeVideoTrack(agora_refptr< IVideoTrack > track, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition NGIAgoraMediaNode.h:569
virtual int removeView(void *view)=0
virtual int setRenderMode(media::base::RENDER_MODE_TYPE renderMode, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setView(void *view, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setRenderMode(void *view, media::base::RENDER_MODE_TYPE renderMode, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int unsetView(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setMirror(void *view, bool mirror, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setMirror(bool mirror, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int addView(void *view, const Rectangle &cropArea, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition NGIAgoraMediaNode.h:167
virtual int onFrame(const media::base::VideoFrame &videoFrame)=0
virtual int getProperty(const char *key, void *buf, int buf_size)
Definition NGIAgoraMediaNode.h:190
virtual bool applyRotation()
Definition NGIAgoraMediaNode.h:227
virtual void onDataStreamWillStop()
Definition NGIAgoraMediaNode.h:213
virtual bool isExternalSink()
Definition NGIAgoraMediaNode.h:200
virtual bool applyMirror()
Definition NGIAgoraMediaNode.h:220
virtual int setProperty(const char *key, const void *buf, int buf_size)
Definition NGIAgoraMediaNode.h:179
virtual bool onDataStreamWillStart()
Definition NGIAgoraMediaNode.h:208
Definition NGIAgoraVideoTrack.h:101
RENDER_MODE_TYPE
Definition AgoraMediaBase.h:532
const char * user_id_t
Definition AgoraMediaBase.h:314
Definition AgoraExtensions.h:5
BYTES_PER_SAMPLE
Definition AgoraMediaBase.h:210
unsigned int uid_t
Definition AgoraMediaBase.h:28
static const int kDeviceIdSize
Definition NGIAgoraMediaNode.h:642
Definition AgoraAtomicOps.h:21
Definition common_defines.h:18
Definition AgoraMediaBase.h:336
Definition AgoraMediaBase.h:351
Definition AgoraMediaBase.h:770
Definition AgoraMediaBase.h:322
Definition AgoraMediaBase.h:963
Definition AgoraBase.h:1518
Definition AgoraBase.h:1679
Definition AgoraMediaBase.h:41
Definition NGIAgoraMediaNode.h:498
float rednessLevel
Definition NGIAgoraMediaNode.h:538
LIGHTENING_CONTRAST_LEVEL
Definition NGIAgoraMediaNode.h:502
@ LIGHTENING_CONTRAST_HIGH
Definition NGIAgoraMediaNode.h:514
@ LIGHTENING_CONTRAST_LOW
Definition NGIAgoraMediaNode.h:506
@ LIGHTENING_CONTRAST_NORMAL
Definition NGIAgoraMediaNode.h:510
float smoothnessLevel
Definition NGIAgoraMediaNode.h:532
BeautyOptions(LIGHTENING_CONTRAST_LEVEL contrastLevel, float lightening, float smoothness, float redness)
Definition NGIAgoraMediaNode.h:540
BeautyOptions()
Definition NGIAgoraMediaNode.h:547
float lighteningLevel
Definition NGIAgoraMediaNode.h:526
LIGHTENING_CONTRAST_LEVEL lighteningContrastLevel
Definition NGIAgoraMediaNode.h:521
Definition AgoraBase.h:2281