agora-python-server-sdk 1.1.2__tar.gz → 2.0.0__tar.gz

agora_python_server_sdk-2.0.0/MANIFEST.in

@@ -0,0 +1 @@
+exclude agora_rtc/agora/rtc/agora_sdk/*

agora_python_server_sdk-2.0.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: agora_python_server_sdk
+Version: 2.0.0
+Summary: A Python SDK for Agora Server
+Home-page: https://github.com/AgoraIO-Extensions/Agora-Python-Server-SDK
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# Notice
+- this is a python sdk wrappered agora rtc sdk.
+- can dev under mac, and release unde linux
+- the examples is just a simple demo, it is not a good practice to use it in production
+# Very import notice !!!!!!!
+- It's crucial that a process can only have one instance.
+- One instance can have multiple connections.
+- In all observers or callbacks, it is not allowed to call the SDK's own APIs, nor is it permitted to perform   CPU-intensive tasks within the callbacks. However, data copying is allowed.
+
+# Required OS and python version
+- supported Linux version: 
+  - Ubuntu 18.04 LTS and above
+  - CentOS 7.0 and above
+  
+- supported Mac version:
+
+  - MacOS 13 and above
+
+- python version:
+  - python 3.8 above
+
+# Test Data
+- download and unzip [test_data.zip](https://download.agora.io/demo/test/test_data_202408221437.zip)
+- make **test_data** directory in the same directory with **agora_rtc**
+
+# Linux debug & develop
+## Prepare C version of agora rtc sdk
+
+- make **agora_sdk** directory under the directory of **agora_rtc/agora/rtc**
+- download and unzip [agora_sdk.zip](https://download.agora.io/sdk/release/agora_rtc_sdk_linux_v4.4_20240914_1538_336910.zip) to **agora_sdk**
+- there should be **libagora_rtc_sdk.so** and **include_c** in **agora_sdk** directory
+
+## run example on linux
+```
+python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx --userId=xxx --audioFile=./test_data/demo.pcm --sampleRate=16000 --numOfChannels=1
+```
+
+# Mac debug & develop
+## Prepare C version of agora rtc sdk
+- make **agora_sdk** directory under the directory of **agora_rtc/agora/rtc**
+- download and unzip [agora_sdk.zip](https://download.agora.io/sdk/release/agora_rtc_sdk_mac_v4.4_20240914_1538_336910.zip) to **agora_sdk**
+- there should be **libAgoraRtcKit.dylib** in **agora_sdk** directory
+
+## run example on mac
+
+```
+python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx --userId=xxx --audioFile=./test_data/demo.pcm --sampleRate=16000 --numOfChannels=1
+```
+# Some import call sequence
+- 1. about audio frame observer： 
+
+set_playback_audio_frame_before_mixing_parameters MUST be call before register_audio_frame_observer
+
+sample code:
+```
+localuser.set_playback_audio_frame_before_mixing_parameters(1, 16000)
+audio_observer = BizAudioFrameObserver()
+localuser.register_audio_frame_observer(audio_observer)
+```

agora_python_server_sdk-2.0.0/README.md

@@ -0,0 +1,59 @@
+# Notice
+- this is a python sdk wrappered agora rtc sdk.
+- can dev under mac, and release unde linux
+- the examples is just a simple demo, it is not a good practice to use it in production
+# Very import notice !!!!!!!
+- It's crucial that a process can only have one instance.
+- One instance can have multiple connections.
+- In all observers or callbacks, it is not allowed to call the SDK's own APIs, nor is it permitted to perform   CPU-intensive tasks within the callbacks. However, data copying is allowed.
+
+# Required OS and python version
+- supported Linux version: 
+  - Ubuntu 18.04 LTS and above
+  - CentOS 7.0 and above
+  
+- supported Mac version:
+
+  - MacOS 13 and above
+
+- python version:
+  - python 3.8 above
+
+# Test Data
+- download and unzip [test_data.zip](https://download.agora.io/demo/test/test_data_202408221437.zip)
+- make **test_data** directory in the same directory with **agora_rtc**
+
+# Linux debug & develop
+## Prepare C version of agora rtc sdk
+
+- make **agora_sdk** directory under the directory of **agora_rtc/agora/rtc**
+- download and unzip [agora_sdk.zip](https://download.agora.io/sdk/release/agora_rtc_sdk_linux_v4.4_20240914_1538_336910.zip) to **agora_sdk**
+- there should be **libagora_rtc_sdk.so** and **include_c** in **agora_sdk** directory
+
+## run example on linux
+```
+python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx --userId=xxx --audioFile=./test_data/demo.pcm --sampleRate=16000 --numOfChannels=1
+```
+
+# Mac debug & develop
+## Prepare C version of agora rtc sdk
+- make **agora_sdk** directory under the directory of **agora_rtc/agora/rtc**
+- download and unzip [agora_sdk.zip](https://download.agora.io/sdk/release/agora_rtc_sdk_mac_v4.4_20240914_1538_336910.zip) to **agora_sdk**
+- there should be **libAgoraRtcKit.dylib** in **agora_sdk** directory
+
+## run example on mac
+
+```
+python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx --userId=xxx --audioFile=./test_data/demo.pcm --sampleRate=16000 --numOfChannels=1
+```
+# Some import call sequence
+- 1. about audio frame observer： 
+
+set_playback_audio_frame_before_mixing_parameters MUST be call before register_audio_frame_observer
+
+sample code:
+```
+localuser.set_playback_audio_frame_before_mixing_parameters(1, 16000)
+audio_observer = BizAudioFrameObserver()
+localuser.register_audio_frame_observer(audio_observer)
+```

{agora_python_server_sdk-1.1.2/agora_service → agora_python_server_sdk-2.0.0/agora/rtc}/__init__.py

@@ -7,19 +7,16 @@ import ctypes
 sdk_dir = os.path.dirname(os.path.abspath(__file__))
 lib_path = os.path.join(sdk_dir, 'agora_sdk')
 
-print("sdk_dir:", lib_path)
-
 try:
     if sys.platform == 'darwin':
         lib_agora_rtc_path =os.path.join(lib_path, 'libAgoraRtcKit.dylib')
         agora_lib = ctypes.CDLL(lib_agora_rtc_path)
-    elif sys.platform == 'linux':        
+
+    elif sys.platform == 'linux':
         lib_agora_rtc_path =os.path.join(lib_path, 'libagora_rtc_sdk.so')
         ctypes.CDLL(os.path.join(lib_path, 'libagora-fdkaac.so'))
-        ctypes.CDLL(os.path.join(lib_path, 'libagora-core.so'))
-        ctypes.CDLL(os.path.join(lib_path, 'libagora-soundtouch.so'))
-        ctypes.CDLL(os.path.join(lib_path, 'libagora_uap_aed.so'))
-        agora_lib = ctypes.CDLL(lib_agora_rtc_path)
+        ctypes.CDLL(os.path.join(lib_path, 'libaosl.so'))
+        agora_lib = ctypes.CDLL(lib_agora_rtc_path)    
 except OSError as e:
     print(f"Error loading the library: {e}")
     print(f"Attempted to load from: {lib_agora_rtc_path}")

agora_python_server_sdk-2.0.0/agora/rtc/_audio_frame_observer.py

@@ -0,0 +1,155 @@
+import ctypes
+from .agora_base import *
+from .local_user import *
+import ctypes
+from .audio_frame_observer import *
+
+
+class AudioFrameInner(ctypes.Structure):
+    _fields_ = [
+        ("type", ctypes.c_int),
+        ("samples_per_channel", ctypes.c_int),
+        ("bytes_per_sample", ctypes.c_int),
+        ("channels", ctypes.c_int),
+        ("samples_per_sec", ctypes.c_int),
+        ("buffer", ctypes.c_void_p),
+        ("render_time_ms", ctypes.c_int64),
+        ("avsync_type", ctypes.c_int)
+    ]
+    def _to_audio_frame(self):
+        audio_frame = AudioFrame()
+        audio_frame.type = self.type
+        audio_frame.samples_per_channel = self.samples_per_channel
+        audio_frame.bytes_per_sample = self.bytes_per_sample
+        audio_frame.channels = self.channels
+        audio_frame.samples_per_sec = self.samples_per_sec
+        cdata = ctypes.string_at(self.buffer, self.samples_per_channel * self.bytes_per_sample * self.channels)
+        audio_frame.buffer = bytearray(cdata)
+        audio_frame.render_time_ms = self.render_time_ms
+        audio_frame.avsync_type = self.avsync_type
+        return audio_frame
+    
+
+ON_RECORD_AUDIO_FRAME_CALLBACK = ctypes.CFUNCTYPE(ctypes.c_int, AGORA_HANDLE, ctypes.c_char_p, ctypes.POINTER(AudioFrameInner))
+ON_PLAYBACK_AUDIO_FRAME_CALLBACK = ctypes.CFUNCTYPE(ctypes.c_int, AGORA_HANDLE, ctypes.c_char_p, ctypes.POINTER(AudioFrameInner))
+ON_MIXED_AUDIO_FRAME_CALLBACK = ctypes.CFUNCTYPE(ctypes.c_int, AGORA_HANDLE, ctypes.c_char_p, ctypes.POINTER(AudioFrameInner))
+ON_EAR_MONITORING_AUDIO_FRAME_CALLBACK = ctypes.CFUNCTYPE(ctypes.c_int, AGORA_HANDLE, ctypes.POINTER(AudioFrameInner))
+ON_PLAYBACK_AUDIO_FRAME_BEFORE_MIXING_CALLBACK = ctypes.CFUNCTYPE(ctypes.c_int, AGORA_HANDLE, ctypes.c_char_p, user_id_t, ctypes.POINTER(AudioFrameInner))
+ON_GET_AUDIO_FRAME_POSITION_CALLBACK = ctypes.CFUNCTYPE(ctypes.c_int, AGORA_HANDLE)
+ON_GET_PLAYBACK_AUDIO_FRAME_PARAM_CALLBACK = ctypes.CFUNCTYPE(AudioParams, AGORA_HANDLE)
+ON_GET_RECORD_AUDIO_FRAME_PARAM_CALLBACK = ctypes.CFUNCTYPE(AudioParams, AGORA_HANDLE)
+ON_GET_MIXED_AUDIO_FRAME_PARAM_CALLBACK = ctypes.CFUNCTYPE(AudioParams, AGORA_HANDLE)
+ON_GET_EAR_MONITORING_AUDIO_FRAME_PARAM_CALLBACK = ctypes.CFUNCTYPE(AudioParams, AGORA_HANDLE)
+
+class AudioFrameObserverInner(ctypes.Structure):
+    _fields_ = [
+        ("on_record_audio_frame", ON_RECORD_AUDIO_FRAME_CALLBACK),
+        ("on_playback_audio_frame", ON_PLAYBACK_AUDIO_FRAME_CALLBACK),
+        ("on_mixed_audio_frame", ON_MIXED_AUDIO_FRAME_CALLBACK),
+        ("on_ear_monitoring_audio_frame", ON_EAR_MONITORING_AUDIO_FRAME_CALLBACK),
+
+        ("on_playback_audio_frame_before_mixing", ON_PLAYBACK_AUDIO_FRAME_BEFORE_MIXING_CALLBACK),
+        ("on_get_audio_frame_position", ON_GET_AUDIO_FRAME_POSITION_CALLBACK),
+        ("on_get_playback_audio_frame_param", ON_GET_PLAYBACK_AUDIO_FRAME_PARAM_CALLBACK),
+        ("on_get_record_audio_frame_param", ON_GET_RECORD_AUDIO_FRAME_PARAM_CALLBACK),
+        
+        ("on_get_mixed_audio_frame_param", ON_GET_MIXED_AUDIO_FRAME_PARAM_CALLBACK),
+        ("on_get_ear_monitoring_audio_frame_param", ON_GET_EAR_MONITORING_AUDIO_FRAME_PARAM_CALLBACK)
+    ]
+
+    def __init__(self, observer:IAudioFrameObserver, local_user: 'LocalUser'):
+        self.observer = observer
+        self.local_user = local_user
+        self.on_record_audio_frame = ON_RECORD_AUDIO_FRAME_CALLBACK(self._on_record_audio_frame)
+        self.on_playback_audio_frame = ON_PLAYBACK_AUDIO_FRAME_CALLBACK(self._on_playback_audio_frame)
+        self.on_mixed_audio_frame = ON_MIXED_AUDIO_FRAME_CALLBACK(self._on_mixed_audio_frame)
+        self.on_ear_monitoring_audio_frame = ON_EAR_MONITORING_AUDIO_FRAME_CALLBACK(self._on_ear_monitoring_audio_frame)
+        self.on_playback_audio_frame_before_mixing = ON_PLAYBACK_AUDIO_FRAME_BEFORE_MIXING_CALLBACK(self._on_playback_audio_frame_before_mixing)
+        self.on_get_audio_frame_position = ON_GET_AUDIO_FRAME_POSITION_CALLBACK(self._on_get_audio_frame_position)
+
+        # self.on_get_playback_audio_frame_param = ON_GET_PLAYBACK_AUDIO_FRAME_PARAM_CALLBACK(self._on_get_playback_audio_frame_param)
+        # self.on_get_record_audio_frame_param = ON_GET_RECORD_AUDIO_FRAME_PARAM_CALLBACK(self._on_get_record_audio_frame_param)
+        # self.on_get_mixed_audio_frame_param = ON_GET_MIXED_AUDIO_FRAME_PARAM_CALLBACK(self._on_get_mixed_audio_frame_param)
+        # self.on_get_ear_monitoring_audio_frame_param = ON_GET_EAR_MONITORING_AUDIO_FRAME_PARAM_CALLBACK(self._on_get_ear_monitoring_audio_frame_param)
+
+    def _on_record_audio_frame(self, local_user_handle, channel_id, audio_frame_inner):
+        print("AudioFrameObserverInner _on_record_audio_frame", local_user_handle, channel_id, audio_frame_inner)
+        channel_id_str = channel_id.decode('utf-8')
+        frame = audio_frame_inner.contents._to_audio_frame()
+        ret = self.observer.on_record_audio_frame(self.local_user, channel_id_str, frame)
+        return ret
+
+    def _on_playback_audio_frame(self, local_user_handle, channel_id, audio_frame_inner):
+        print("AudioFrameObserverInner _on_playback_audio_frame", local_user_handle, channel_id, audio_frame_inner)
+        channel_id_str = channel_id.decode('utf-8')
+        frame = audio_frame_inner.contents._to_audio_frame()
+        ret = self.observer.on_playback_audio_frame(self.local_user, channel_id_str, frame)
+        return ret
+
+    def _on_mixed_audio_frame(self, local_user_handle, channel_id, audio_frame_inner):
+        print("AudioFrameObserverInner _on_mixed_audio_frame", local_user_handle, channel_id, audio_frame_inner)
+        ret = self.observer.on_mixed_audio_frame(self.local_user, audio_frame_inner)
+        return ret
+
+    def _on_ear_monitoring_audio_frame(self, local_user_handle, audio_frame_inner):
+        print("AudioFrameObserverInner _on_ear_monitoring_audio_frame", local_user_handle, audio_frame_inner)
+        ret = self.observer.on_ear_monitoring_audio_frame(self.local_user, audio_frame_inner)
+        return ret
+
+    def _on_playback_audio_frame_before_mixing(self, local_user_handle, channel_id, user_id, audio_frame_inner):
+        print("AudioFrameObserverInner _on_playback_audio_frame_before_mixing", local_user_handle, channel_id, user_id, audio_frame_inner)
+        if channel_id is None:
+            channel_id_str = ""
+        else:
+            channel_id_str = channel_id.decode('utf-8')
+
+        user_id_str = user_id.decode('utf-8')
+        frame = audio_frame_inner.contents._to_audio_frame()
+        ret = self.observer.on_playback_audio_frame_before_mixing(self.local_user, channel_id_str, user_id_str, frame)
+        return ret
+    
+    def _on_get_audio_frame_position(self, local_user_handle):
+        print("AudioFrameObserverInner _on_get_audio_frame_position", local_user_handle)
+        return 0
+        return self.observer.on_get_audio_frame_position(self.local_user)
+
+    def _on_get_playback_audio_frame_param(self, local_user_handle):
+        print("AudioFrameObserverInner _on_get_playback_audio_frame_param", local_user_handle)
+        params = AudioParams()
+        params.sample_rate = 16000  # 示例值
+        params.channels = 1          # 示例值
+        params.mode = 0              # 示例值
+        params.samples_per_call = 1024  # 示例值
+        return params
+        return self.observer.on_get_playback_audio_frame_param(self.local_user)
+
+    def _on_get_record_audio_frame_param(self, local_user_handle):
+        print("AudioFrameObserverInner _on_get_record_audio_frame_param", local_user_handle)
+        params = AudioParams()
+        params.sample_rate = 16000  # 示例值
+        params.channels = 1          # 示例值
+        params.mode = 0              # 示例值
+        params.samples_per_call = 1024  # 示例值
+        return params
+        return self.observer.on_get_record_audio_frame_param(self.local_user)
+
+    def _on_get_mixed_audio_frame_param(self, local_user_handle):
+        print("AudioFrameObserverInner _on_get_mixed_audio_frame_param", local_user_handle)
+        params = AudioParams()
+        params.sample_rate = 16000  # 示例值
+        params.channels = 1          # 示例值
+        params.mode = 0              # 示例值
+        params.samples_per_call = 1024  # 示例值
+        return params
+        return self.observer.on_get_mixed_audio_frame_param(self.local_user)
+
+    def _on_get_ear_monitoring_audio_frame_param(self, local_user_handle):
+        print("AudioFrameObserverInner _on_get_ear_monitoring_audio_frame_param", local_user_handle)
+        params = AudioParams()
+        params.sample_rate = 16000  # 示例值
+        params.channels = 1          # 示例值
+        params.mode = 0              # 示例值
+        params.samples_per_call = 1024  # 示例值
+        return params
+        return self.observer.on_get_ear_monitoring_audio_frame_param(self.local_user)
+