benz-amr-recorder
benz-amr-recorder copied to clipboard
Play, record, reformat AMR audio
AMR 录音机 ![GitHub stars](https://img.shields.io/github/stars/BenzLeung/benz-amr-recorder.svg?style=social&label=Star&maxAge=2592000)
(README in English)
纯前端解码、播放、录音、编码 AMR 音频,无须服务器支持,基于 amr.js 和 RecorderJs。
注意:由于使用了 amr.js 做编码和解码,因此 js 文件(压缩后,未 gzip)接近 500 KB,使用前请考虑。
2019-10-05 更新 (v1.1.0): 增加浏览器支持检测功能,增加暂停播放、设置播放进度功能。
特性
- 方便的 API 实现解码、播放、录音、编码 AMR 文件。
- 支持 url 和 blob (即
<input type="file">
)方式获取 AMR。 - 支持将浏览器
<audio>
所支持的音频格式(例如 MP3 或 OGG 音频)转换成 AMR 音频。 - 编码后的 AMR 文件可下载,无须服务器。
Demo
浏览器兼容性
最新的浏览器兼容性请参阅 Can I Use 。
安装
方法一:引入 js 文件
<script type="text/javascript" src="./BenzAMRRecorder.min.js"></script>
方法二:使用 npm
npm install benz-amr-recorder
var BenzAMRRecorder = require('benz-amr-recorder');
用法
注意: 建议把 initWithXXX()
或 play()
方法绑定到一个用户事件中(例如 click
、touchstart
)。因为几乎所有移动设备(以及桌面版 Chrome 70+)都禁止页面自动播放音频。参考:
- https://webkit.org/blog/6784/new-video-policies-for-ios/
- https://developers.google.com/web/updates/2017/09/autoplay-policy-changes
播放 AMR:
var amr = new BenzAMRRecorder();
amr.initWithUrl('path/to/voice.amr').then(function() {
amr.play();
});
amr.onEnded(function() {
alert('播放完毕');
})
播放本地文件:
<input type="file" id="amr-file" accept=".amr">
var amr = new BenzAMRRecorder();
var amrFileObj = document.getElementById('amr-file');
amrFileObj.onchange = function() {
amr.initWithBlob(this.files[0]).then(function() {
amr.play();
});
}
录制 AMR:
var amrRec = new BenzAMRRecorder();
amrRec.initWithRecord().then(function() {
amrRec.startRecord();
});
下载 AMR:
window.location.href = window.URL.createObjectURL(amr.getBlob());
把 MP3 转换成 AMR (需要浏览器原生支持 MP3):
var amrFromMp3 = new BenzAMRRecorder();
amrFromMp3.initWithUrl('path/to/file.mp3').then(function() {
// 下载 amr 文件
window.location.href = window.URL.createObjectURL(amrFromMp3.getBlob());
})
API
初始化对象
/**
* 是否已经初始化
* @return {boolean}
*/
amr.isInit();
/**
* 使用浮点数据初始化
* @param {Float32Array} array
* @return {Promise}
*/
amr.initWithArrayBuffer(array);
/**
* 使用 Blob 对象初始化( <input type="file">)
* @param {Blob} blob
* @return {Promise}
*/
amr.initWithBlob(blob);
/**
* 使用 url 初始化
* @param {string} url
* @return {Promise}
*/
amr.initWithUrl(url);
/**
* 初始化录音
* @return {Promise}
*/
amr.initWithRecord();
事件
注意:事件不会叠加,也就是说,新注册的事件将覆盖掉旧的事件。
/**
* 播放
* @param {Function} fn
*/
amr.onPlay(function() {
console.log('开始播放');
});
/**
* 停止(包括播放结束)
* @param {Function} fn
*/
amr.onStop(function() {
console.log('停止播放');
});
/**
* 暂停
* @param {Function} fn
*/
amr.onPause(function() {
console.log('暂停');
});
/**
* (暂停状态中)继续播放
* @param {Function} fn
*/
amr.onResume(function() {
console.log('继续播放');
});
/**
* 播放结束
* @param {Function} fn
*/
amr.onEnded(function() {
console.log('播放结束');
});
/**
* 播放到结尾自动结束
* @param {Function} fn
*/
amr.onAutoEnded(function() {
console.log('播放自动结束');
});
/**
* 开始录音
* @param {Function} fn
*/
amr.onStartRecord(function() {
console.log('开始录音');
});
/**
* 结束录音
* @param {Function} fn
*/
amr.onFinishRecord(function() {
console.log('结束录音');
});
播放控制
/**
* 播放(无视暂停状态)
* @param {number?} startTime 可指定播放开始位置(秒,浮点数,可选)
*/
amr.play();
/**
* 停止
*/
amr.stop();
/**
* 暂停
* @since 1.1.0
*/
amr.pause();
/**
* 从暂停状态中继续播放
* @since 1.1.0
*/
amr.resume();
/**
* 整合 play() 和 resume(),若在暂停状态则继续,否则从头播放
* @since 1.1.0
*/
amr.playOrResume();
/**
* 整合 resume() 和 pause(),切换暂停状态
* @since 1.1.0
*/
amr.pauseOrResume();
/**
* 整合 play() 和 resume() 和 pause()
* @since 1.1.0
*/
amr.playOrPauseOrResume();
/**
* 跳转到音频指定位置,不改变播放状态(若停止状态则等同于 `play(time)`)
* @since 1.1.0
* @param {Number} time 指定位置(秒,浮点数)
*/
amr.setPosition(12.34);
/**
* 获取当前播放位置(秒)
* @since 1.1.0
* @return {Number} 位置,秒,浮点数
*/
amr.getCurrentPosition();
/**
* 是否正在播放
* @return {boolean}
*/
amr.isPlaying();
/**
* 是否暂停中
* @since 1.1.0
* @return {boolean}
*/
amr.isPaused();
录音控制
/**
* 开始录音
*/
amr.startRecord();
/**
* 结束录音,并把录制的音频转换成 AMR
* @return {Promise}
*/
amr.finishRecord();
/**
* 放弃录音
*/
amr.cancelRecord();
/**
* 是否正在录音
* @return {boolean}
*/
amr.isRecording();
其他
/**
* 获取音频的时间长度(单位:秒)
* @return {Number}
*/
amr.getDuration();
/**
* 获取 AMR 文件的 Blob 对象(用于下载文件)
* @return {Blob}
*/
amr.getBlob();
/**
* 判断浏览器是否支持播放
* 注意这是静态(static)方法
* @since 1.1.0
* @return {boolean}
*/
BenzAMRRecorder.isPlaySupported();
// 不是 amr.isPlaySupported();
/**
* 判断浏览器是否支持录音
* 注意这是静态(static)方法
* @since 1.1.0
* @return {boolean}
*/
BenzAMRRecorder.isRecordSupported();
// 不是 amr.isRecordSupported();
尚未完成的特性
- [x] ~~使用 Worker 编码解码 AMR。~~(v1.0.9)
- [x] ~~暂停播放功能。~~(v1.1.0)
- [ ] 暂停录音功能。
- [x] ~~播放进度控制。~~(v1.1.0)
- [x] ~~浏览器兼容性检查(#9 #11)。~~(v1.1.0)
常见问题
- 关于跨域
这需要目标服务器(即存放amr文件的服务器)支持跨域,不是修改前端代码能解决的。
基本上如果服务器是CDN的话都能支持。如果不是CDN,那就请自行谷鸽百度一下如何让服务器支持跨域,或者找你们后端或运维同事帮忙。
- 采样率?
本项目仅支持 amr-nb 格式,这种格式只有一种采样率 8000Hz。因为amr这种格式是专门设计成用于人声录音的,这个采样率足以把人类日常说话的字词句录清楚。对于人类,只有强悍的女高音歌手才能尖叫出接近8000Hz的声音。
另有一种 amr-wb 格式,采样率是 16000Hz,提升采样率可以让人声从“听得清楚”升级成“听得舒服”。人类在讲话的时候会伴随一些呼吸声气流声,这些声音有时候只能用上高采样率才能录进去。
目前本项目不支持 amr-wb。
- 能支持 amr-wb 格式吗?
不打算支持,因为这会让包体积变大。本项目原本是为了配合微信做语音应用的,微信也没有用到 amr-wb。
已经有网友fork支持amr-wb了,在此感谢AcoWaves。
- Webpack 或 babel 打包出错
由于本人已经不参与音频相关的项目,目前暂时没时间Debug了。哪位大佬要是帮忙修复了,欢迎提PR。
- 似乎好久没有更新了?
由于本人已经不参与音频相关的项目,目前暂时没时间做更新了。而且我个人感觉本项目也没什么重要的东西需要更新了。(项目的基础 amr.js 也是n年没有更新了。)欢迎大佬们提PR。
许可
MIT.