fork/rust-sdks
git clone https://git.julia.blue/fork/rust-sdks
7e51858
livekit/livekit-ffi@0.13.0
1// Copyright 2023 LiveKit, Inc. 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto2" ; 16 17package livekit . proto ; 18option csharp_namespace= "LiveKit.Proto" ; 19 20import "handle.proto" ; 21import "track.proto" ; 22 23// Create a new AudioStream 24// AudioStream is used to receive audio frames from a track 25message NewAudioStreamRequest { 26required uint64 track_handle = 1 ; 27required AudioStreamType type = 2 ; 28optional uint32 sample_rate = 3 ; 29optional uint32 num_channels = 4 ; 30optional string audio_filter_module_id = 5 ; // Unique identifier passed in LoadAudioFilterPluginRequest 31optional string audio_filter_options = 6 ; 32} 33message NewAudioStreamResponse { required OwnedAudioStream stream = 1 ; } 34 35message AudioStreamFromParticipantRequest { 36required uint64 participant_handle = 1 ; 37required AudioStreamType type = 2 ; 38optional TrackSource track_source = 3 ; 39optional uint32 sample_rate = 5 ; 40optional uint32 num_channels = 6 ; 41optional string audio_filter_module_id = 7 ; 42optional string audio_filter_options = 8 ; 43} 44 45message AudioStreamFromParticipantResponse { required OwnedAudioStream stream = 1 ; } 46 47// Create a new AudioSource 48message NewAudioSourceRequest { 49required AudioSourceType type = 1 ; 50optional AudioSourceOptions options = 2 ; 51required uint32 sample_rate = 3 ; 52required uint32 num_channels = 4 ; 53optional uint32 queue_size_ms = 5 ; 54} 55message NewAudioSourceResponse { required OwnedAudioSource source = 1 ; } 56 57// Push a frame to an AudioSource 58// The data provided must be available as long as the client receive the callback. 59message CaptureAudioFrameRequest { 60required uint64 source_handle = 1 ; 61required AudioFrameBufferInfo buffer = 2 ; 62} 63message CaptureAudioFrameResponse { 64required uint64 async_id = 1 ; 65} 66message CaptureAudioFrameCallback { 67required uint64 async_id = 1 ; 68optional string error = 2 ; 69} 70 71message ClearAudioBufferRequest { 72required uint64 source_handle = 1 ; 73} 74message ClearAudioBufferResponse {} 75 76// Create a new AudioResampler 77message NewAudioResamplerRequest {} 78message NewAudioResamplerResponse { 79required OwnedAudioResampler resampler = 1 ; 80} 81 82// Remix and resample an audio frame 83message RemixAndResampleRequest { 84required uint64 resampler_handle = 1 ; 85required AudioFrameBufferInfo buffer = 2 ; 86required uint32 num_channels = 3 ; 87required uint32 sample_rate = 4 ; 88} 89 90message RemixAndResampleResponse { 91required OwnedAudioFrameBuffer buffer = 1 ; 92} 93 94// AEC 95 96 97message NewApmRequest { 98required bool echo_canceller_enabled = 1 ; 99required bool gain_controller_enabled = 2 ; 100required bool high_pass_filter_enabled = 3 ; 101required bool noise_suppression_enabled = 4 ; 102} 103message NewApmResponse { 104required OwnedApm apm = 1 ; 105} 106 107message ApmProcessStreamRequest { 108required uint64 apm_handle = 1 ; 109required uint64 data_ptr = 2 ; // *mut i16 110required uint32 size = 3 ; // in bytes 111required uint32 sample_rate = 4 ; 112required uint32 num_channels = 5 ; 113} 114 115message ApmProcessStreamResponse { 116optional string error = 1 ; 117} 118 119message ApmProcessReverseStreamRequest { 120required uint64 apm_handle = 1 ; 121required uint64 data_ptr = 2 ; // *mut i16 122required uint32 size = 3 ; // in bytes 123required uint32 sample_rate = 4 ; 124required uint32 num_channels = 5 ; 125} 126 127message ApmProcessReverseStreamResponse { 128optional string error = 1 ; 129} 130 131// New resampler using SoX (much better quality) 132 133message NewSoxResamplerRequest { 134required double input_rate = 1 ; 135required double output_rate = 2 ; 136required uint32 num_channels = 3 ; 137required SoxResamplerDataType input_data_type = 4 ; 138required SoxResamplerDataType output_data_type = 5 ; 139required SoxQualityRecipe quality_recipe = 6 ; 140optional uint32 flags = 7 ; 141} 142message NewSoxResamplerResponse { 143oneof message { 144OwnedSoxResampler resampler = 1 ; 145string error = 2 ; 146} 147 148} 149 150message PushSoxResamplerRequest { 151required uint64 resampler_handle = 1 ; 152required uint64 data_ptr = 2 ; // *const i16 153required uint32 size = 3 ; // in bytes 154} 155 156message PushSoxResamplerResponse { 157required uint64 output_ptr = 1 ; // *const i16 (could be null) 158required uint32 size = 2 ; // in bytes 159optional string error = 3 ; 160} 161 162message FlushSoxResamplerRequest { 163required uint64 resampler_handle = 1 ; 164} 165 166message FlushSoxResamplerResponse { 167required uint64 output_ptr = 1 ; // *const i16 (could be null) 168required uint32 size = 2 ; // in bytes 169optional string error = 3 ; 170} 171 172enum SoxResamplerDataType { 173// TODO(theomonnom): support other datatypes (shouldn't really be needed) 174SOXR_DATATYPE_INT16I = 0 ; 175SOXR_DATATYPE_INT16S = 1 ; 176} 177 178enum SoxQualityRecipe { 179SOXR_QUALITY_QUICK = 0 ; 180SOXR_QUALITY_LOW = 1 ; 181SOXR_QUALITY_MEDIUM = 2 ; 182SOXR_QUALITY_HIGH = 3 ; 183SOXR_QUALITY_VERYHIGH = 4 ; 184} 185 186enum SoxFlagBits { 187SOXR_ROLLOFF_SMALL = 0 ; // 1 << 0 188SOXR_ROLLOFF_MEDIUM = 1 ; // 1 << 1 189SOXR_ROLLOFF_NONE = 2 ; // 1 << 2 190SOXR_HIGH_PREC_CLOCK = 3 ; // 1 << 3 191SOXR_DOUBLE_PRECISION = 4 ; // 1 << 4 192SOXR_VR = 5 ; // 1 << 5 193} 194 195 196 197// 198// AudioFrame buffer 199// 200 201message AudioFrameBufferInfo { 202required uint64 data_ptr = 1 ; // *const i16 203required uint32 num_channels = 2 ; 204required uint32 sample_rate = 3 ; 205required uint32 samples_per_channel = 4 ; 206} 207 208message OwnedAudioFrameBuffer { 209required FfiOwnedHandle handle = 1 ; 210required AudioFrameBufferInfo info = 2 ; 211} 212 213// 214// AudioStream 215// 216 217enum AudioStreamType { 218AUDIO_STREAM_NATIVE = 0 ; 219AUDIO_STREAM_HTML = 1 ; 220} 221 222message AudioStreamInfo { 223required AudioStreamType type = 1 ; 224} 225 226message OwnedAudioStream { 227required FfiOwnedHandle handle = 1 ; 228required AudioStreamInfo info = 2 ; 229} 230 231message AudioStreamEvent { 232required uint64 stream_handle = 1 ; 233oneof message { 234AudioFrameReceived frame_received = 2 ; 235AudioStreamEOS eos = 3 ; 236} 237} 238 239message AudioFrameReceived { 240required OwnedAudioFrameBuffer frame = 1 ; 241} 242 243message AudioStreamEOS {} 244 245// 246// AudioSource 247// 248 249message AudioSourceOptions { 250required bool echo_cancellation = 1 ; 251required bool noise_suppression = 2 ; 252required bool auto_gain_control = 3 ; 253} 254 255enum AudioSourceType { 256AUDIO_SOURCE_NATIVE = 0 ; 257} 258 259message AudioSourceInfo { 260required AudioSourceType type = 2 ; 261} 262 263message OwnedAudioSource { 264required FfiOwnedHandle handle = 1 ; 265required AudioSourceInfo info = 2 ; 266} 267 268// 269// AudioResampler 270// 271 272message AudioResamplerInfo { } 273 274message OwnedAudioResampler { 275required FfiOwnedHandle handle = 1 ; 276required AudioResamplerInfo info = 2 ; 277} 278 279 280// 281// AEC 282// 283 284message OwnedApm { 285required FfiOwnedHandle handle = 1 ; 286} 287 288// 289// Sox AudioResampler 290// 291 292 293message SoxResamplerInfo {} 294 295message OwnedSoxResampler { 296required FfiOwnedHandle handle = 1 ; 297required SoxResamplerInfo info = 2 ; 298} 299 300// Audio Filter Plugin 301message LoadAudioFilterPluginRequest { 302required string plugin_path = 1 ; // path for ffi audio filter plugin 303repeated string dependencies = 2 ; // Optional: paths for dependency dylibs 304required string module_id = 3 ; // Unique identifier of the plugin 305} 306 307message LoadAudioFilterPluginResponse { 308optional string error = 1 ; 309}