展讯平台音频接口使用说明

Layer1 音频接口使用说明

版本: 1.0.2

SW-BASE-DS-0020

2005-03-15

https://www.360docs.net/doc/1b5551724.html,

展讯通信有限公司·保密·

修订历史

版本日期作者审核说明

1.0.0 2004-07-21 Chris.Jin Draft

1.0.1 2005-2-28 Yujun.Ke Add some constant definitions 1.0.2 2005-3-15 Yujun.Ke Add voice record part

重要声明

版权声明

版权所有 ? 2005, 展讯通信有限公司，保留所有权利。

商标声明

展讯通信有限公司和展讯通信有限公司的产品是展讯通信有限公司专有。在提及其他公司及其产品时将使用各自公司所拥有的商标，这种使用的目的仅限于引用。

不作保证声明

展讯通信有限公司不对此文档中的任何内容作任何明示或暗示的陈述或保证，而且不对特定目的的适销性及适用性或者任何间接、特殊或连带的损失承担任何责任。

保密声明

本文档（包括任何附件）包含的信息是保密信息。接收人了解其获得的本文档是保密的，除用于规定的目的外不得用于任何目的，也不得将本文档泄露给任何第三方。

目录

1介绍 (5)

1.1范围 (5)

1.2参考文档 (5)

1.3缩写和定义 (5)

2概述 (6)

2.1文件组织 (6)

2.2接口使用注意事项 (6)

2.2.1当发现本文档与提供的头文件不一致，请以头文件为准。 (6)

2.2.2设置模式注意的事项 (6)

3接口函数说明 (7)

3.1播放特定的DTMF音 (7)

3.2播放由一个或一个以上频率合成的音调 (7)

3.3停止播放音 (8)

3.4切换主路/辅路Audio设备 (8)

3.5设置音量 (9)

3.6打开/关闭静音 (9)

3.7打开/关闭Codec (10)

3.8录音 (10)

3.8.1开始录音 (10)

3.8.2读取数据 (11)

3.8.3停止录音 (11)

4附录 (12)

4.1常量 (12)

4.1.1Tone ID 的定义 (12)

4.1.2音频设备类型 (12)

4.1.3录音数据格式 AUD_REC_FORMAT_E定义 (12)

1 介绍

1.1 范围

本文档描述了向上层应用（如MMI等）提供的layer1 audio 接口的使用说明。可作为参考设计、MMI 等开发人员重要的参考文档。

1.2 参考文档

《操作系统API用户指南》

1.3 缩写和定义

MMI Man-Machine Interface

RTOS Real-Time Operating System

2 概述

2.1 文件组织

layer1_audio.h

该文件定义了所有layer1 audio接口，应用程序只需要包含这个头文件即可。

《layer1接口使用说明》

本文档，详细描述了layer1 audio接口的使用方法。

2.2 接口使用注意事项

2.2.1 当发现本文档与提供的头文件不一致，请以头文件为准。

2.2.2 设置模式注意的事项

调用LAYER1_SwitchSoundDevice函数之后，要调用LAYER1_SetVolume函数设置音量。

3 接口函数说明

3.1 播放特定的DTMF音

LAYER1_PlaySpecialTone

命令DSP根据参数 tone_id 播放特定的DTMF Tone音，并依据参数 b_uplink 来决定是否将音频信号经过Codec发送给网络。

uint32 LAYER1_PlaySpecialTone(

AUD_DTMF_TONE_ID_E tone_id,

BOOLEAN b_uplink

);

参数：

[in] tone_id

特定的DTMF Tone音

[in] b_uplink

是否将音频信号经过Codec发送给网络

返回值：

SCI_SUCCESS 表示操作成功

SCI_ERROR 失败

参考：

无

举例：

3.2 播放由一个或一个以上频率合成的音调

LAYER1_PlayGenericTone

命令DSP根据参数 freq1, freq2, freq3 指定的三个频率来播放音。

uint32 LAYER1_PlayGenericTone(

uint16 freq1,

uint16 freq2,

uint16 freq3,

);

参数：

[in] freq1

用来合成音的频率，范围是 [250，3400] hz。0值表示此路频率无效。

[in] freq2

用来合成音的频率，范围是 [250，3400] hz。0值表示此路频率无效。

[in] freq3

用来合成音的频率，范围是 [250，3400] hz。0值表示此路频率无效。返回值：

SCI_SUCCESS 表示操作成功

SCI_ERROR 失败

参考：

无

举例：

无

3.3 停止播放音

LAYER1_StopTone

命令 DSP 停止播放音，可以是Special tone，也可以是Generic tone。uint32 LAYER1_StopTone(void);

参数：

无

返回值：

SCI_SUCCESS 表示操作成功

SCI_ERROR 失败

参考：

无

举例：

无

3.4 切换主路/辅路Audio设备

LAYER1_SwitchSoundDevice

切换主路/辅路Audio设备

uint32 LAYER1_SwitchSoundDevice(

BOOLEAN b_aux_mic,

BOOLEAN b_aux_speaker,

AUD_DEV_MODE_E mode

);

参数：

[in] b_aux_mic

TRUE：表示辅麦克风；FALSE：表示主麦克风；

[in] b_aux_speaker

TRUE表示辅扬声器；FALSE：表示主扬声器；

[in] mode

Audio：设备的类型

返回值：

SCI_SUCCESS 表示操作成功

SCI_ERROR 失败

参考：

无

举例：

无

3.5 设置音量

LAYER1_SetVolume

设置扬声器的音量。

uint32 LAYER1_SetVolume(uint16 speaker_vol);

参数：

[in] speaker_vol

扬声器的音量值，有效值 0 ~ 7，0 表示扬声器音量为0。

返回值：

SCI_SUCCESS 表示操作成功

SCI_ERROR 失败

参考：

无

举例：

无

3.6 打开/关闭静音

LAYER1_SwitchMute

打开/关闭静音。

uint32 LAYER1_SwitchMute(Boolean b_mute);

参数：

[in] b_mute

True: 静音打开, False: 静音关闭。

返回值：

SCI_SUCCESS 表示操作成功

SCI_ERROR 失败

参考：

无

举例：

无

3.7 打开/关闭Codec

LAYER1_SetCodecEnable

打开/关闭 Codec 。

uint32 LAYER1_SetCodecEnable (BOOLEAN is_enable);

参数：

[in] is_enable

TRUE：打开CODEC；FALSE：关闭CODEC。

返回值：

SCI_SUCCESS 表示操作成功

SCI_ERROR 失败

参考：

无

举例：

无

3.8 录音

3.8.1 开始录音

Layer1_StartRecord

开始录音，通知DSP发送数据

void Layer1_StartRecord (AUD_REC_FORMAT_E recorder_format,

callback_fun

REF_RDMEM_CALLBACK

)

[in] recorder_format：

指定输出的语音格式。

AUD_REC_ADPCM：以ADPCM格式存储（在录网络语音时仅能用此格式或PCM格式）

AUD_REC_EFS：以EFS格式存储

AUD_REC_FS：以FS格式存储

AUD_REC_PCM ：以PCM格式存储

[in] callback_fun：

回调函数，DSP送来一个语音数据包，会调用此函数。

注意：REF_RDMEM_CALLBACK 的定义为：

typedef void (*REF_RDMEM_CALLBACK)()

注意：该函数中仅能发送消息或进行其它占用资源少的操作，不能用来进行读写FLASH或其它耗时操作3.8.2 读取数据

LAYER1_ReadVoiceData

该函数用来提供给上层主动读取语音数据，每次读取160word。

uint8 LAYER1_ReadVoiceData( uint16 *destination_buf_ptr)

参数：

[in] uint16 *destination_buf_ptr

用来存放数据的buffer地址

返回值：

返回读取的block数，1 block = 160 word。通常为1。

参考：

无

举例：

无

3.8.3 停止录音

LAYER1_StopRecord

该函数用来停止当前录音。

void LAYER1_StopRecord ( );

参数：

无

返回值：

无

参考：

无

举例：

无

4 附录

4.1 常量

4.1.1 Tone ID 的定义

类型 AUD_DTMF_TONE_ID_E 的定义为：

#define DTMF_One 0 // 代表1

#define DTMF_Two 1 // 代表2

#define DTMF_Three 2 // 代表3

#define DTMF_letterA 3 // 代表A

#define DTMF_Four 4 // 代表4

#define DTMF_Five 5 // 代表5

#define DTMF_Six 6 // 代表6

#define DTMF_letterB 7 // 代表B

#define DTMF_Seven 8 // 代表7

#define DTMF_Eight 9 // 代表8

#define DTMF_Nine 10 // 代表9

#define DTMF_letterC 11 // 代表C

#define DTMF_Star 12 // 代表*

#define DTMF_Zero 13 // 代表0

#define DTMF_Pond 14 // 代表#

#define DTMF_letterD 15 // 代表D

4.1.2 音频设备类型

typedef enum

{

AUD_DEV_MODE_HANDHOLD, //手柄

AUD_DEV_MODE_HANDFREE, //免提

AUD_DEV_MODE_EARPHONE, //耳机

AUD_DEV_MODE_MAX // Reserved, user can't use it.

} AUD_DEV_MODE_E;

4.1.3 录音数据格式 AUD_REC_FORMAT_E定义

typedef enum

{

AUD_REC_ADPCM,

AUD_REC_EFS,

AUD_REC_FS,

AUD_REC_PCM

} AUD_REC_FORMAT_E;

参数：

AUD_REC_ADPCM：以ADPCM格式存储AUD_REC_EFS：以EFS格式存储

AUD_REC_FS：以FS格式存储

AUD_REC_PCM ：以PCM格式存储