initial commit

2022-10-23 23:45:43 -07:00
commit e190fa5193
6450 changed files with 8626944 additions and 0 deletions
@@ -0,0 +1,124 @@
+//*****************************************************************************
+//
+//  ae.api.h
+//! @file
+//!
+//! @brief Functions for interfacing with the encoder library
+//!
+//! @addtogroup 
+//! @ingroup 
+//! @{
+//
+//*****************************************************************************
+
+//*****************************************************************************
+//
+// Copyright (c) 2020, Ambiq Micro
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice,
+// this list of conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright
+// notice, this list of conditions and the following disclaimer in the
+// documentation and/or other materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its
+// contributors may be used to endorse or promote products derived from this
+// software without specific prior written permission.
+//
+// Third party software included in this distribution is subject to the
+// additional license terms as defined in the /docs/licenses directory.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+//
+// This is part of revision 2.4.2 of the AmbiqSuite Development Package.
+//
+//*****************************************************************************
+
+#ifndef AE_API__H
+#define AE_API__H
+
+
+//*****************************************************************************
+//
+// External Function Calls
+//
+//*****************************************************************************
+
+//*****************************************************************************
+//
+//! @brief Initialization of the library
+//!
+//! Run the initialization function before any operation with the encoder.
+//! @param option - option to select whether to include 8-byte header into output.
+//!                 0 for no header.
+//!                 other value for with header.
+//! @return numBytes - number of bytes of the data output, including header length. 
+//!
+//! @{
+//
+//*****************************************************************************
+int audio_enc_init(int option);
+
+//*****************************************************************************
+//
+//! @brief Encodes a frame of audio
+//!
+//! @param p_pcm_buffer - pointer to the input buffer.
+//! @param n_pcm_samples - input length in samples.
+//! @param p_encoded_buffer - pointer to the output buffer.
+//!
+//! This is the major function of the encoder, the encoder encodes a fixed length 
+//! of audio (20ms) in a fixed input format (16KHz, 16bit, mono, 640 bytes in length), 
+//! with a fixed output format: CBR, 32000bps output rate (8:1 compression), 
+//! complexity 4.
+//! When output header is selected, each output frame will have a 8 byte header in
+//! the beginning of the output data: 4 bytes of length (fixed to 80) followed by 
+//! 4 bytes of range code.
+//!
+//! @return numBytes - number of bytes of the data output, including header length. 
+//!
+//! @{
+//
+//*****************************************************************************
+int audio_enc_encode_frame(short *p_pcm_buffer, int n_pcm_samples, unsigned char *p_encoded_buffer);
+
+//*****************************************************************************
+//
+//! @brief Get version information of the libary
+//!
+//! @return version_string - pointer to the libary version string. 
+//!
+//! @{
+//
+//*****************************************************************************
+char* audio_get_lib_version(void);
+
+//*****************************************************************************
+//
+//! @brief Get version information of the base package
+//!
+//! @return version_string - pointer to the base package version string. 
+//!                          version information is 7 byte long without line break
+//! @{
+//
+//*****************************************************************************
+char* audio_get_package_version(void);
+
+#endif // AE_API__H
+
+