9#include "libxr_def.hpp"
20template <u
int8_t CHANNELS, u
int8_t BITS_PER_SAMPLE>
23 static_assert(CHANNELS >= 1 && CHANNELS <= 8,
"CHANNELS out of range");
24 static_assert(BITS_PER_SAMPLE == 8 || BITS_PER_SAMPLE == 16 || BITS_PER_SAMPLE == 24,
25 "BITS_PER_SAMPLE must be 8/16/24");
29 : (BITS_PER_SAMPLE <= 16) ? 2
45 int16_t vol_res, Speed speed,
size_t queue_bytes = 8192,
48 : iso_in_ep_num_(iso_in_ep_num),
54 sr_hz_(sample_rate_hz),
55 pcm_queue_(queue_bytes)
59 sf_cur_[0] =
static_cast<uint8_t
>(sr_hz_ & 0xFF);
60 sf_cur_[1] =
static_cast<uint8_t
>((sr_hz_ >> 8) & 0xFF);
61 sf_cur_[2] =
static_cast<uint8_t
>((sr_hz_ >> 16) & 0xFF);
69 ErrorCode
WritePcm(
const void* data,
size_t nbytes)
71 return pcm_queue_.
PushBatch(
reinterpret_cast<const uint8_t*
>(data), nbytes);
83 USB_CLASS_AUDIO = 0x01,
95 AC_INPUT_TERMINAL = 0x02,
96 AC_OUTPUT_TERMINAL = 0x03,
97 AC_FEATURE_UNIT = 0x06
102 AS_FORMAT_TYPE = 0x02
110 WFORMAT_PCM = 0x0001,
111 WFORMAT_UNKNOWN = 0xFFFF
151 uint8_t bLength = 9, bDescriptorType = CS_INTERFACE, bDescriptorSubtype = AC_HEADER;
152 uint16_t bcdADC = 0x0100, wTotalLength = 0;
153 uint8_t bInCollection = 1, baInterfaceNr = 0;
162 uint8_t bLength = 12, bDescriptorType = CS_INTERFACE,
163 bDescriptorSubtype = AC_INPUT_TERMINAL;
164 uint8_t bTerminalID = ID_IT_MIC;
165 uint16_t wTerminalType = 0x0201;
166 uint8_t bAssocTerminal = 0, bNrChannels = CHANNELS;
167 uint16_t wChannelConfig = 0x0000;
168 uint8_t iChannelNames = 0, iTerminal = 0;
177 uint8_t bLength =
static_cast<uint8_t
>(7 + (CHANNELS + 1) * 1);
178 uint8_t bDescriptorType = CS_INTERFACE, bDescriptorSubtype = AC_FEATURE_UNIT;
179 uint8_t bUnitID = ID_FU, bSourceID = ID_IT_MIC, bControlSize = 1;
180 uint8_t bmaControlsMaster = 0x03;
181 uint8_t bmaControlsCh[CHANNELS] = {0x03};
182 uint8_t iFeature = 0;
191 uint8_t bLength = 9, bDescriptorType = CS_INTERFACE,
192 bDescriptorSubtype = AC_OUTPUT_TERMINAL;
193 uint8_t bTerminalID = ID_OT_USB;
194 uint16_t wTerminalType = 0x0101;
195 uint8_t bAssocTerminal = 0, bSourceID = ID_FU, iTerminal = 0;
204 uint8_t bLength = 7, bDescriptorType = CS_INTERFACE, bDescriptorSubtype = AS_GENERAL;
205 uint8_t bTerminalLink = ID_OT_USB, bDelay = 1;
206 uint16_t wFormatTag = WFORMAT_PCM;
215 uint8_t bLength = 11, bDescriptorType = CS_INTERFACE,
216 bDescriptorSubtype = AS_FORMAT_TYPE;
217 uint8_t bFormatType = FORMAT_TYPE_I, bNrChannels = CHANNELS;
218 uint8_t bSubframeSize =
K_SUBFRAME_SIZE, bBitResolution = BITS_PER_SAMPLE,
229 uint8_t bLength = 7, bDescriptorType = CS_ENDPOINT, bDescriptorSubtype = EP_GENERAL;
230 uint8_t bmAttributes = 0x00;
231 uint8_t bLockDelayUnits = 0;
232 uint16_t wLockDelay = 0;
242 uint8_t bDescriptorType =
static_cast<uint8_t
>(DescriptorType::ENDPOINT);
243 uint8_t bEndpointAddress = 0;
244 uint8_t bmAttributes = 0x05;
245 uint16_t wMaxPacketSize = 0;
246 uint8_t bInterval = 0x01;
247 uint8_t bRefresh = 0x00;
248 uint8_t bSynchAddress = 0x00;
286 if (speed_ == Speed::HIGH)
288 ASSERT(w_max_packet_size_ <= 1024);
292 ASSERT(interval_ == 1);
293 ASSERT(w_max_packet_size_ <= 1023);
298 ASSERT(ans == ErrorCode::OK);
301 static_cast<uint16_t
>(w_max_packet_size_),
true});
303 itf_ac_num_ = start_itf_num;
304 itf_as_num_ =
static_cast<uint8_t
>(start_itf_num + 1);
307 desc_block_.
iad = {8,
308 static_cast<uint8_t
>(DescriptorType::IAD),
318 static_cast<uint8_t
>(DescriptorType::INTERFACE),
328 desc_block_.
ac_hdr.baInterfaceNr = itf_as_num_;
329 desc_block_.
ac_hdr.wTotalLength =
334 if constexpr (CHANNELS == 2)
336 desc_block_.
it_mic.wChannelConfig = 0x0003;
340 desc_block_.
it_mic.wChannelConfig = 0x0000;
345 static_cast<uint8_t
>(DescriptorType::INTERFACE),
356 static_cast<uint8_t
>(DescriptorType::INTERFACE),
367 desc_block_.
as_gen.bTerminalLink = ID_OT_USB;
368 desc_block_.
as_gen.bDelay = 1;
369 desc_block_.
as_gen.wFormatTag = WFORMAT_PCM;
372 desc_block_.
fmt.bFormatType = FORMAT_TYPE_I;
373 desc_block_.
fmt.bNrChannels = CHANNELS;
375 desc_block_.
fmt.bBitResolution = BITS_PER_SAMPLE;
376 desc_block_.
fmt.bSamFreqType = 1;
377 desc_block_.
fmt.tSamFreq[0] =
static_cast<uint8_t
>(sr_hz_ & 0xFF);
378 desc_block_.
fmt.tSamFreq[1] =
static_cast<uint8_t
>((sr_hz_ >> 8) & 0xFF);
379 desc_block_.
fmt.tSamFreq[2] =
static_cast<uint8_t
>((sr_hz_ >> 16) & 0xFF);
382 desc_block_.
ep_in = {};
383 desc_block_.
ep_in.bEndpointAddress =
static_cast<uint8_t
>(
385 desc_block_.
ep_in.bmAttributes = 0x05;
386 desc_block_.
ep_in.wMaxPacketSize =
static_cast<uint16_t
>(w_max_packet_size_);
387 desc_block_.
ep_in.bInterval = (speed_ == Speed::HIGH) ? interval_ : 0x01;
388 desc_block_.
ep_in.bRefresh = 0x00;
389 desc_block_.
ep_in.bSynchAddress = 0x00;
391 desc_block_.
ep_cs = {};
392 desc_block_.
ep_cs.bmAttributes = 0x00;
397 SetData(
RawData{
reinterpret_cast<uint8_t*
>(&desc_block_),
sizeof(desc_block_)});
417 endpoint_pool.
Release(ep_iso_in_);
418 ep_iso_in_ =
nullptr;
428 return ErrorCode::NOT_SUPPORT;
436 uint16_t wLength, uint16_t wIndex,
440 const uint8_t EP_ADDR =
static_cast<uint8_t
>(wIndex & 0xFF);
441 const uint8_t CS_EP =
442 static_cast<uint8_t
>((wValue >> 8) & 0xFF);
444 if (EP_ADDR == desc_block_.
ep_in.bEndpointAddress && CS_EP == 0x01)
452 return ErrorCode::OK;
458 pending_set_sf_ =
true;
460 return ErrorCode::OK;
468 return ErrorCode::OK;
473 static uint8_t one_hz[3] = {1, 0, 0};
477 return ErrorCode::OK;
485 return ErrorCode::ARG_ERR;
489 const uint8_t CS =
static_cast<uint8_t
>((wValue >> 8) & 0xFF);
490 const uint8_t CH =
static_cast<uint8_t
>(wValue & 0xFF);
492 static_cast<uint8_t
>((wIndex >> 8) & 0xFF);
493 const uint8_t ITF =
static_cast<uint8_t
>(wIndex & 0xFF);
495 if (ITF != itf_ac_num_ || ENT != ID_FU)
498 return ErrorCode::NOT_SUPPORT;
503 return ErrorCode::ARG_ERR;
509 if (bRequest == SET_CUR && wLength == 1)
512 return ErrorCode::OK;
514 if (bRequest == GET_CUR && wLength == 1)
517 return ErrorCode::OK;
520 return ErrorCode::ARG_ERR;
529 return ErrorCode::OK;
536 return ErrorCode::OK;
543 return ErrorCode::OK;
550 return ErrorCode::OK;
557 return ErrorCode::OK;
564 return ErrorCode::OK;
570 return ErrorCode::ARG_ERR;
574 return ErrorCode::NOT_SUPPORT;
585 if (bRequest == SET_CUR && pending_set_sf_)
587 const uint32_t NEW_SR =
static_cast<uint32_t
>(sf_cur_[0]) |
588 (
static_cast<uint32_t
>(sf_cur_[1]) << 8) |
589 (
static_cast<uint32_t
>(sf_cur_[2]) << 16);
590 if (NEW_SR > 0 && NEW_SR != sr_hz_)
595 pending_set_sf_ =
false;
596 return ErrorCode::OK;
598 return ErrorCode::OK;
607 if (itf != itf_as_num_)
610 return ErrorCode::NOT_SUPPORT;
612 alt = streaming_ ? 1 : 0;
613 return ErrorCode::OK;
622 if (itf != itf_as_num_)
625 return ErrorCode::NOT_SUPPORT;
630 return ErrorCode::FAILED;
639 return ErrorCode::OK;
643 static_cast<uint16_t
>(w_max_packet_size_),
false});
648 return ErrorCode::OK;
652 return ErrorCode::ARG_ERR;
716 uint16_t to_send =
static_cast<uint16_t
>(base_bytes_per_service_);
717 acc_rem_ += rem_bytes_per_service_;
718 if (acc_rem_ >= service_hz_)
721 acc_rem_ -= service_hz_;
724 if (to_send > w_max_packet_size_)
726 to_send =
static_cast<uint16_t
>(w_max_packet_size_);
730 if (buf.size_ < to_send)
732 to_send =
static_cast<uint16_t
>(buf.size_);
736 size_t have = pcm_queue_.
Size();
737 size_t take = (have >= to_send) ? to_send : have;
741 pcm_queue_.
PopBatch(
reinterpret_cast<uint8_t*
>(buf.addr_), take);
754 if (speed_ == Speed::HIGH)
756 uint8_t eff = interval_ ? interval_ : 1;
761 const uint32_t MICROFRAMES = 1u << (eff - 1u);
762 service_hz_ = 8000u / MICROFRAMES;
770 bytes_per_sec_ =
static_cast<uint32_t
>(sr_hz_) * CHANNELS *
K_SUBFRAME_SIZE;
771 base_bytes_per_service_ = bytes_per_sec_ / service_hz_;
772 rem_bytes_per_service_ = bytes_per_sec_ % service_hz_;
773 uint32_t ceil_bpt = base_bytes_per_service_ + (rem_bytes_per_service_ ? 1u : 0u);
776 const uint32_t PER_TX_LIMIT = (speed_ == Speed::HIGH) ? 1024u : 1023u;
777 if (ceil_bpt > PER_TX_LIMIT)
779 ceil_bpt = PER_TX_LIMIT;
782 w_max_packet_size_ =
static_cast<uint16_t
>(ceil_bpt);
785 if (desc_block_.
ep_in.wMaxPacketSize != 0 &&
786 w_max_packet_size_ > desc_block_.
ep_in.wMaxPacketSize)
788 w_max_packet_size_ = desc_block_.
ep_in.wMaxPacketSize;
795 uint8_t itf_ac_num_ = 0;
796 uint8_t itf_as_num_ = 0;
799 bool inited_ =
false;
800 bool streaming_ =
false;
804 int16_t vol_cur_ = 0;
805 int16_t vol_min_, vol_max_, vol_res_;
812 uint32_t bytes_per_sec_ = 0;
813 uint32_t base_bytes_per_service_ = 0;
814 uint32_t rem_bytes_per_service_ = 0;
815 uint32_t acc_rem_ = 0;
816 uint16_t w_max_packet_size_ = 0;
817 uint32_t service_hz_ = 1000;
819 UAC1DescBlock desc_block_;
822 uint8_t sf_cur_[3] = {0, 0, 0};
823 bool pending_set_sf_ =
false;
通用回调包装,支持动态参数传递 / Generic callback wrapper supporting dynamic argument passing
static Callback Create(FunType fun, ArgType arg)
创建回调对象并绑定回调函数与参数 / Create a callback instance with bound function and argument
常量原始数据封装类。 A class for encapsulating constant raw data.
无锁队列实现 / Lock-free queue implementation
void Reset()
重置队列 / Resets the queue
ErrorCode PushBatch(const Data *data, size_t size)
批量推入数据 / Pushes multiple elements into the queue
size_t EmptySize()
计算队列剩余可用空间 / Calculates the remaining available space in the queue
size_t Size() const
获取当前队列中的元素数量 / Returns the number of elements currently in the queue
ErrorCode PopBatch(Data *data, size_t size)
批量弹出数据 / Pops multiple elements from the queue
原始数据封装类。 A class for encapsulating raw data.
void SetData(RawData data)
设置内部数据缓存 / Set internal data cache
USB 设备类接口基类 / USB device class interface base.
USB 端点基类 / USB Endpoint base class.
EPNumber
端点号 Endpoint number
@ EP_AUTO
自动分配端点号 / Auto allocate
uint8_t GetAddress() const
获取端点地址(方向 + 号) / Get endpoint address (dir + num)
static constexpr uint8_t EPNumberToAddr(EPNumber ep, Direction dir)
端点号转换为端点地址 / Convert endpoint number to endpoint address
void SetActiveLength(uint16_t len)
设置当前活动缓冲区有效长度 / Set active buffer valid length
void SetOnTransferCompleteCallback(Callback< ConstRawData & > cb)
设置传输完成回调 / Set transfer complete callback
virtual void Configure(const Config &cfg)=0
配置端点协议参数 / Configure endpoint protocol parameters
@ ISOCHRONOUS
等时端点 / Isochronous
EPNumber GetNumber() const
获取端点号 / Get endpoint number
virtual void Close()=0
关闭端点 / Close endpoint
State GetState() const
获取端点状态 / Get endpoint state
virtual ErrorCode Transfer(size_t size)=0
启动一次传输 / Start a transfer
RawData GetBuffer() const
获取当前可用于传输的缓冲区 / Get current transfer buffer
USB端点池类 / USB endpoint pool class.
ErrorCode Get(Endpoint *&ep_info, Endpoint::Direction direction, Endpoint::EPNumber ep_num=Endpoint::EPNumber::EP_AUTO)
分配端点 / Allocate endpoint
ErrorCode Release(Endpoint *ep_info)
回收端点 / Release endpoint
UAC1 队列式麦克风设备类实现 UAC1 queue‑driven microphone device class implementation.
size_t GetInterfaceCount() override
返回接口数量(AC+AS=2)| Get number of interfaces (AC+AS=2)
void RecomputeTiming()
统一重算时序与包长(运行时 MPS 钳制到描述符宣告值) Recompute timing and packet sizing (runtime MPS clamped to descriptor)
ErrorCode OnClassRequest(bool, uint8_t bRequest, uint16_t wValue, uint16_t wLength, uint16_t wIndex, DeviceClass::ControlTransferResult &r) override
处理类请求:端点采样率控制 + Feature Unit(静音/音量) Handle class requests: EP sampling‑freq control + Feature Unit (m...
ErrorCode OnGetDescriptor(bool, uint8_t, uint16_t, uint16_t, ConstRawData &) override
UAC1 无类特定描述符读出(配置中已包含) UAC1 does not use GET_DESCRIPTOR(0x21/0x22) here.
void UnbindEndpoints(EndpointPool &endpoint_pool, bool) override
反初始化设备,释放端点 Deinitialize device and release endpoints
static const constexpr uint8_t K_SUBFRAME_SIZE
每通道每采样的子帧字节数 / Subframe size (bytes per channel per sample)
bool HasIAD() override
包含 IAD | Has IAD
size_t QueueSpace()
获取队列剩余空间 | Get remaining queue capacity (bytes)
UAC1MicrophoneQ(uint32_t sample_rate_hz, int16_t vol_min, int16_t vol_max, int16_t vol_res, Speed speed, size_t queue_bytes=8192, uint8_t interval=1, Endpoint::EPNumber iso_in_ep_num=Endpoint::EPNumber::EP_AUTO)
构造 UAC1 队列式麦克风 Construct a queue‑backed UAC1 microphone
size_t GetMaxConfigSize() override
配置描述符最大尺寸 | Get maximum configuration size
void KickOneFrame()
计算并投递一帧(按 1ms 变包 + 零填充) Compute and submit one frame (1 ms variable size + zero fill)
bool OwnsEndpoint(uint8_t ep_addr) const override
可选:端点归属判定 / Optional: endpoint ownership
static void OnInCompleteStatic(bool in_isr, UAC1MicrophoneQ *self, ConstRawData &data)
IN 传输完成静态回调 Static callback for IN transfer completion.
void OnInComplete(bool, ConstRawData &)
IN 传输完成处理:继续投下一帧 Handle IN transfer completion: kick next frame.
void ResetQueue()
重置队列为空 | Reset queue to empty
ErrorCode OnClassData(bool, uint8_t bRequest, LibXR::ConstRawData &) override
处理类请求数据阶段(应用 SET_CUR 的采样率) Handle class request data stage (apply SET_CUR sampling freq)
void BindEndpoints(EndpointPool &endpoint_pool, uint8_t start_itf_num, bool) override
初始化设备(分配端点、填充描述符) Initialize device (allocate endpoints, populate descriptors)
ErrorCode GetAltSetting(uint8_t itf, uint8_t &alt) override
获取接口的当前 Alternate Setting Get current alternate setting for interface
size_t QueueSize() const
获取队列当前字节数 | Get current queued bytes
ErrorCode WritePcm(const void *data, size_t nbytes)
写入 PCM 字节流(如 S16LE / S24_3LE) Write interleaved PCM bytes (e.g., S16LE / S24_3LE)
ErrorCode SetAltSetting(uint8_t itf, uint8_t alt) override
设置接口的 Alternate Setting(切换数据流) Set interface alternate setting (toggle streaming)
IAD(8 字节)/ Interface Association Descriptor (8 bytes)
接口描述符(9 字节)/ Interface descriptor (9 bytes)
控制请求(Class/Vendor)处理结果 / Control request (Class/Vendor) handling result
AC 特性单元(静音/音量) AC feature unit (mute/volume)
AC 输出端子(USB 流) AC output terminal (USB streaming)
AS 通用描述符 AS general descriptor.
类特定端点(通用) Class‑specific endpoint (general)
标准等时 IN 端点(9 字节,含 bRefresh/bSynchAddress) Standard isoch IN endpoint (9 bytes, with bRefresh/bSynchAd...
UAC1 描述符块 UAC1 descriptor block.
ACInputTerminal it_mic
输入端子 / Input terminal
ACFeatureUnit fu
特性单元 / Feature unit
InterfaceDescriptor ac_intf
AC 接口 / AC interface.
CSACHeader ac_hdr
AC 头 / AC header.
InterfaceDescriptor as_alt1
AS Alt 1(1 个 IN 端点)/ AS Alt 1 (1 IN EP)
InterfaceDescriptor as_alt0
AS Alt 0(无端点)/ AS Alt 0 (no EP)
IADDescriptor iad
接口关联描述符 / Interface association descriptor
TypeIFormat1 fmt
格式描述符 / format descriptor
ASGeneral as_gen
AS 通用 / AS general.
CSEndpointGeneral ep_cs
类特定端点 / CS EP
ACOutputTerminal ot_usb
输出端子 / Output terminal
EndpointDescriptorIso9 ep_in
标准 IN 端点(9B)/ Std IN EP (9B)