English | 简体中文 | 繁體中文 | 日本語 | Deutsch | 한국어
The WM8978 is a low power, high quality stereo CODEC designed for portable applications such as multimedia phone, digital still camera or digital camcorder.The device integrates preamps for stereo differential mics, and includes drivers for speakers, headphone and differential or stereo line output. External component requirements are reduced as no separate microphone or headphone amplifiers are required.Advanced on-chip digital signal processing includes a 5-band equaliser, a mixed signal Automatic Level Control for the microphone or line input through the ADC as well as a purely digital limiter function for record or playback. Additional digital filtering options are available in the ADC path, to cater for application filtering such as ‘wind noise reduction’.The WM8978 digital audio interface can operate as a master or a slave. An internal PLL can generate all required audio clocks for the CODEC from common reference clock frequencies, such as 12MHz and 13MHz.The WM8978 operates at analogue supply voltages from 2.5V to 3.3V, although the digital core can operate at voltages down to 1.71V to save power. The speaker outputs and OUT3/4 line outputs can run from a 5V supply if increased output power is required. Individual sections of the chip can also be powered down under software control.
LibDriver WM8978 is the full function driver of WM8978 launched by LibDriver.It provides audio playing, audio recording and other functions. LibDriver is MISRA compliant.
/src includes LibDriver WM8978 source files.
/interface includes LibDriver WM8978 IIC, IIS platform independent template.
/test includes LibDriver WM8978 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver WM8978 sample code.
/doc includes LibDriver WM8978 offline document.
/datasheet includes WM8978 datasheet.
/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.
/misra includes the LibDriver MISRA code scanning results.
Reference /interface IIC, IIS platform independent template and finish your platform IIC, IIS driver.
Add the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.
You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
#include "driver_wm8978_basic.h"
uint8_t res;
wm8978_companding_t companding = WM8978_COMPANDING_LINEAR;
wm8978_channel_t channel = WM8978_CHANNEL_STEREO;
wm8978_word_length_t length = WM8978_WORD_LENGTH_16_BITS;
/* link interface function */
WAV_LINK_INIT(wm8978_play_get_handle(), wav_handle_t);
WAV_LINK_AUDIO_INIT(wm8978_play_get_handle(), wav_audio_init);
WAV_LINK_AUDIO_DEINIT(wm8978_play_get_handle(), wav_audio_deinit);
WAV_LINK_AUDIO_READ(wm8978_play_get_handle(), wav_audio_read);
WAV_LINK_AUDIO_WRITE(wm8978_play_get_handle(), wav_audio_write);
WAV_LINK_IIS_INIT(wm8978_play_get_handle(), wav_iis_init);
WAV_LINK_IIS_DEINIT(wm8978_play_get_handle(), wav_iis_deinit);
WAV_LINK_IIS_STOP(wm8978_play_get_handle(), wav_iis_stop);
WAV_LINK_IIS_PAUSE(wm8978_play_get_handle(), wav_iis_pause);
WAV_LINK_IIS_RESUME(wm8978_play_get_handle(), wav_iis_resume);
WAV_LINK_IIS_SET_FREQ(wm8978_play_get_handle(), wav_iis_set_freq);
WAV_LINK_IIS_WRITE(wm8978_play_get_handle(), wav_iis_write);
WAV_LINK_IIS_READ(wm8978_play_get_handle(), wav_iis_read);
WAV_LINK_DELAY_MS(wm8978_play_get_handle(), wav_delay_ms);
WAV_LINK_DEBUG_PRINT(wm8978_play_get_handle(), wav_debug_print);
/* wm8978 basic init */
res = wm8978_basic_init(WM8978_BASIC_MODE_PLAY);
if (res != 0)
{
wm8978_interface_debug_print("wm8978: basic init failed.\n");
return 1;
}
/* wav init */
res = wav_init(wm8978_play_get_handle());
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav init failed.\n");
(void)wm8978_basic_deinit();
return 1;
}
...
/* wav player init */
res = wav_player_init(wm8978_play_get_handle(), path);
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav player init failed.\n");
(void)wav_deinit(wm8978_play_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
/* set num channel */
if (wm8978_play_get_handle()->wav.num_channel == 1)
{
channel = WM8978_CHANNEL_MONO;
}
else if (wm8978_play_get_handle()->wav.num_channel == 2)
{
channel = WM8978_CHANNEL_STEREO;
}
else
{
wm8978_interface_debug_print("wm8978: num channel is invalid.\n");
(void)wav_deinit(wm8978_play_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
/* set bit per sample */
if (wm8978_play_get_handle()->wav.bit_per_sample == 16)
{
length = WM8978_WORD_LENGTH_16_BITS;
}
else if (wm8978_play_get_handle()->wav.bit_per_sample == 24)
{
length = WM8978_WORD_LENGTH_24_BITS;
}
else
{
wm8978_interface_debug_print("wm8978: bit per sample is invalid.\n");
(void)wav_deinit(wm8978_play_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
/* set audio format */
if (wm8978_play_get_handle()->wav.audio_format == 1)
{
companding = WM8978_COMPANDING_LINEAR;
}
else
{
wm8978_interface_debug_print("wm8978: audio format is invalid.\n");
(void)wav_deinit(wm8978_play_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
/* wm8978 config */
if (wm8978_basic_config(companding, channel, length) != 0)
{
wm8978_interface_debug_print("wm8978: basic config failed.\n");
(void)wav_deinit(wm8978_play_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
/* wav player config */
res = wav_player_config(wm8978_play_get_handle(), I2S_STANDARD_PHILIPS,
I2S_MODE_MASTER_TX, I2S_CPOL_LOW,
I2S_DATAFORMAT_16B_EXTENDED, I2S_MCLKOUTPUT_ENABLE, wm8978_play_get_handle()->wav.sample_rate);
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav player config failed.\n");
(void)wav_deinit(wm8978_play_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
/* wav player start */
res = wav_player_start(wm8978_play_get_handle());
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav player start failed.\n");
(void)wav_deinit(wm8978_play_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
...
/* loop */
while (1)
{
wav_status_t status;
/* get status */
res = wav_player_get_status(wm8978_play_get_handle(), &status);
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav player get status failed.\n");
(void)wav_player_stop(wm8978_play_get_handle());
(void)wav_deinit(wm8978_play_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
/* check status */
if (status == WAV_STATUS_STOP)
{
break;
}
wav_delay_ms(1000);
wav_debug_print("wav: playing %d/%d.\n", wm8978_play_get_handle()->pos, wm8978_play_get_handle()->size);
...
}
...
/* wav deinit */
(void)wav_deinit(wm8978_play_get_handle());
/* deinit */
(void)wm8978_basic_deinit();
return 0;#include "driver_wm8978_basic.h"
uint8_t res;
uint32_t timeout;
wm8978_companding_t companding = WM8978_COMPANDING_LINEAR;
wm8978_channel_t channel = WM8978_CHANNEL_STEREO;
wm8978_word_length_t length = WM8978_WORD_LENGTH_16_BITS;
/* link interface function */
WAV_LINK_INIT(wm8978_record_get_handle(), wav_handle_t);
WAV_LINK_AUDIO_INIT(wm8978_record_get_handle(), wav_audio_init);
WAV_LINK_AUDIO_DEINIT(wm8978_record_get_handle(), wav_audio_deinit);
WAV_LINK_AUDIO_READ(wm8978_record_get_handle(), wav_audio_read);
WAV_LINK_AUDIO_WRITE(wm8978_record_get_handle(), wav_audio_write);
WAV_LINK_IIS_INIT(wm8978_record_get_handle(), wav_iis_init);
WAV_LINK_IIS_DEINIT(wm8978_record_get_handle(), wav_iis_deinit);
WAV_LINK_IIS_STOP(wm8978_record_get_handle(), wav_iis_stop);
WAV_LINK_IIS_PAUSE(wm8978_record_get_handle(), wav_iis_pause);
WAV_LINK_IIS_RESUME(wm8978_record_get_handle(), wav_iis_resume);
WAV_LINK_IIS_SET_FREQ(wm8978_record_get_handle(), wav_iis_set_freq);
WAV_LINK_IIS_WRITE(wm8978_record_get_handle(), wav_iis_write);
WAV_LINK_IIS_READ(wm8978_record_get_handle(), wav_iis_read);
WAV_LINK_DELAY_MS(wm8978_record_get_handle(), wav_delay_ms);
WAV_LINK_DEBUG_PRINT(wm8978_record_get_handle(), wav_debug_print);
/* wm8978 init */
res = wm8978_basic_init(WM8978_BASIC_MODE_RECORD);
if (res != 0)
{
wm8978_interface_debug_print("wm8978: basic init failed.\n");
return 1;
}
/* wav init */
res = wav_init(wm8978_record_get_handle());
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav init failed.\n");
(void)wm8978_basic_deinit();
return 1;
}
...
/* config */
res = wm8978_basic_config(companding, channel, length);
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav config failed.\n");
(void)wav_deinit(wm8978_record_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
/* wav player config */
res = wav_player_config(wm8978_record_get_handle(), I2S_STANDARD_PHILIPS,
I2S_MODE_MASTER_TX, I2S_CPOL_LOW,
I2S_DATAFORMAT_16B, I2S_MCLKOUTPUT_ENABLE, 22050);
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav record config failed.\n");
(void)wav_deinit(wm8978_record_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
/* record start */
res = wav_record_start(wm8978_record_get_handle(), 22050, path);
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav record start failed.\n");
(void)wav_deinit(wm8978_record_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
...
/* set timeout */
timeout = time;
/* loop */
while (timeout != 0)
{
wav_delay_ms(1000);
timeout--;
wav_debug_print("wav: record %d bytes time %d/%ds.\n", wm8978_record_get_handle()->pos, time - timeout, time);
...
}
/* record stop */
res = wav_record_stop(wm8978_record_get_handle());
if (res != 0)
{
wm8978_interface_debug_print("wm8978: wav record stop failed.\n");
(void)wav_deinit(wm8978_record_get_handle());
(void)wm8978_basic_deinit();
return 1;
}
...
/* wav deinit */
(void)wav_deinit(wm8978_record_get_handle());
/* deinit */
(void)wm8978_basic_deinit();
return 0;Online documents: https://www.libdriver.com/docs/wm8978/index.html.
Offline documents: /doc/html/index.html.
Please refer to CONTRIBUTING.md.
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Please send an e-mail to [email protected].