diff options
author | Dave Burke <daveburke@google.com> | 2012-04-17 09:51:45 -0700 |
---|---|---|
committer | Dave Burke <daveburke@google.com> | 2012-04-17 23:04:43 -0700 |
commit | 9bf37cc9712506b2483650c82d3c41152337ef7e (patch) | |
tree | 77db44e2bae06e3d144b255628be2b7a55c581d3 /libSYS/include | |
parent | a37315fe10ee143d6d0b28c19d41a476a23e63ea (diff) | |
download | fdk-aac-9bf37cc9712506b2483650c82d3c41152337ef7e.tar.gz fdk-aac-9bf37cc9712506b2483650c82d3c41152337ef7e.tar.bz2 fdk-aac-9bf37cc9712506b2483650c82d3c41152337ef7e.zip |
Fraunhofer AAC codec.
License boilerplate update to follow.
Change-Id: I2810460c11a58b6d148d84673cc031f3685e79b5
Diffstat (limited to 'libSYS/include')
-rw-r--r-- | libSYS/include/FDK_audio.h | 544 | ||||
-rw-r--r-- | libSYS/include/audio.h | 44 | ||||
-rw-r--r-- | libSYS/include/cmdl_parser.h | 159 | ||||
-rw-r--r-- | libSYS/include/conv_string.h | 74 | ||||
-rw-r--r-- | libSYS/include/genericStds.h | 421 | ||||
-rw-r--r-- | libSYS/include/machine_type.h | 295 | ||||
-rw-r--r-- | libSYS/include/wav_file.h | 150 |
7 files changed, 1687 insertions, 0 deletions
diff --git a/libSYS/include/FDK_audio.h b/libSYS/include/FDK_audio.h new file mode 100644 index 0000000..1d28187 --- /dev/null +++ b/libSYS/include/FDK_audio.h @@ -0,0 +1,544 @@ +/************************** Fraunhofer IIS FDK SysLib ********************** + + (C) Copyright Fraunhofer IIS (2004) + All Rights Reserved + + Please be advised that this software and/or program delivery is + Confidential Information of Fraunhofer and subject to and covered by the + + Fraunhofer IIS Software Evaluation Agreement + between Google Inc. and Fraunhofer + effective and in full force since March 1, 2012. + + You may use this software and/or program only under the terms and + conditions described in the above mentioned Fraunhofer IIS Software + Evaluation Agreement. Any other and/or further use requires a separate agreement. + + + $Id$ + Author(s): Manuel Jander + + This software and/or program is protected by copyright law and international + treaties. Any reproduction or distribution of this software and/or program, + or any portion of it, may result in severe civil and criminal penalties, and + will be prosecuted to the maximum extent possible under law. + +******************************************************************************/ + +/** \file FDK_audio.h + * \brief Global audio struct and constant definitions. + */ + +#ifndef FDK_AUDIO_H +#define FDK_AUDIO_H + +#include "machine_type.h" +#include "genericStds.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + +/** + * File format identifiers. + */ +typedef enum +{ + FF_UNKNOWN = -1, /**< Unknown format. */ + FF_RAW = 0, /**< No container, bit stream data conveyed "as is". */ + + FF_MP4_3GPP = 3, /**< 3GPP file format. */ + FF_MP4_MP4F = 4, /**< MPEG-4 File format. */ + + FF_RAWPACKETS = 5, /**< Proprietary raw packet file. */ + + FF_DRMCT = 12 /**< Digital Radio Mondial (DRM30/DRM+) CT proprietary file format. */ + +} FILE_FORMAT; + +/** + * Transport type identifiers. + */ +typedef enum +{ + TT_UNKNOWN = -1, /**< Unknown format. */ + TT_MP4_RAW = 0, /**< "as is" access units (packet based since there is obviously no sync layer) */ + TT_MP4_ADIF = 1, /**< ADIF bitstream format. */ + TT_MP4_ADTS = 2, /**< ADTS bitstream format. */ + + TT_MP4_LATM_MCP1 = 6, /**< Audio Mux Elements with muxConfigPresent = 1 */ + TT_MP4_LATM_MCP0 = 7, /**< Audio Mux Elements with muxConfigPresent = 0, out of band StreamMuxConfig */ + + TT_MP4_LOAS = 10, /**< Audio Sync Stream. */ + + TT_DRM = 12, /**< Digital Radio Mondial (DRM30/DRM+) bitstream format. */ + + TT_MP1_L1 = 16, /**< MPEG 1 Audio Layer 1 audio bitstream. */ + TT_MP1_L2 = 17, /**< MPEG 1 Audio Layer 2 audio bitstream. */ + TT_MP1_L3 = 18, /**< MPEG 1 Audio Layer 3 audio bitstream. */ + + TT_RSVD50 = 50 /**< */ + +} TRANSPORT_TYPE; + +/** + * Audio Object Type definitions. + */ +typedef enum +{ + AOT_NONE = -1, + AOT_NULL_OBJECT = 0, + AOT_AAC_MAIN = 1, /**< Main profile */ + AOT_AAC_LC = 2, /**< Low Complexity object */ + AOT_AAC_SSR = 3, + AOT_AAC_LTP = 4, + AOT_SBR = 5, + AOT_AAC_SCAL = 6, + AOT_TWIN_VQ = 7, + AOT_CELP = 8, + AOT_HVXC = 9, + AOT_RSVD_10 = 10, /**< (reserved) */ + AOT_RSVD_11 = 11, /**< (reserved) */ + AOT_TTSI = 12, /**< TTSI Object */ + AOT_MAIN_SYNTH = 13, /**< Main Synthetic object */ + AOT_WAV_TAB_SYNTH = 14, /**< Wavetable Synthesis object */ + AOT_GEN_MIDI = 15, /**< General MIDI object */ + AOT_ALG_SYNTH_AUD_FX = 16, /**< Algorithmic Synthesis and Audio FX object */ + AOT_ER_AAC_LC = 17, /**< Error Resilient(ER) AAC Low Complexity */ + AOT_RSVD_18 = 18, /**< (reserved) */ + AOT_ER_AAC_LTP = 19, /**< Error Resilient(ER) AAC LTP object */ + AOT_ER_AAC_SCAL = 20, /**< Error Resilient(ER) AAC Scalable object */ + AOT_ER_TWIN_VQ = 21, /**< Error Resilient(ER) TwinVQ object */ + AOT_ER_BSAC = 22, /**< Error Resilient(ER) BSAC object */ + AOT_ER_AAC_LD = 23, /**< Error Resilient(ER) AAC LowDelay object */ + AOT_ER_CELP = 24, /**< Error Resilient(ER) CELP object */ + AOT_ER_HVXC = 25, /**< Error Resilient(ER) HVXC object */ + AOT_ER_HILN = 26, /**< Error Resilient(ER) HILN object */ + AOT_ER_PARA = 27, /**< Error Resilient(ER) Parametric object */ + AOT_RSVD_28 = 28, /**< might become SSC */ + AOT_PS = 29, /**< PS, Parametric Stereo (includes SBR) */ + AOT_MPEGS = 30, /**< MPEG Surround */ + + AOT_ESCAPE = 31, /**< Signal AOT uses more than 5 bits */ + + AOT_MP3ONMP4_L1 = 32, /**< MPEG-Layer1 in mp4 */ + AOT_MP3ONMP4_L2 = 33, /**< MPEG-Layer2 in mp4 */ + AOT_MP3ONMP4_L3 = 34, /**< MPEG-Layer3 in mp4 */ + AOT_RSVD_35 = 35, /**< might become DST */ + AOT_RSVD_36 = 36, /**< might become ALS */ + AOT_AAC_SLS = 37, /**< AAC + SLS */ + AOT_SLS = 38, /**< SLS */ + AOT_ER_AAC_ELD = 39, /**< AAC Enhanced Low Delay */ + + AOT_USAC = 42, /**< USAC */ + AOT_SAOC = 43, /**< SAOC */ + AOT_LD_MPEGS = 44, /**< Low Delay MPEG Surround */ + + AOT_RSVD50 = 50, /**< Interim AOT for Rsvd50 */ + + /* Pseudo AOTs */ + AOT_MP2_AAC_MAIN = 128, /**< Virtual AOT MP2 Main profile */ + AOT_MP2_AAC_LC = 129, /**< Virtual AOT MP2 Low Complexity profile */ + AOT_MP2_AAC_SSR = 130, /**< Virtual AOT MP2 Scalable Sampling Rate profile */ + + AOT_MP2_SBR = 132, /**< Virtual AOT MP2 Low Complexity Profile with SBR */ + + AOT_DAB = 134, /**< Virtual AOT for DAB (Layer2 with scalefactor CRC) */ + AOT_DABPLUS_AAC_LC = 135, /**< Virtual AOT for DAB plus AAC-LC */ + AOT_DABPLUS_SBR = 136, /**< Virtual AOT for DAB plus HE-AAC */ + AOT_DABPLUS_PS = 137, /**< Virtual AOT for DAB plus HE-AAC v2 */ + + AOT_PLAIN_MP1 = 140, /**< Virtual AOT for plain mp1 */ + AOT_PLAIN_MP2 = 141, /**< Virtual AOT for plain mp2 */ + AOT_PLAIN_MP3 = 142, /**< Virtual AOT for plain mp3 */ + + AOT_DRM_AAC = 143, /**< Virtual AOT for DRM (ER-AAC-SCAL without SBR) */ + AOT_DRM_SBR = 144, /**< Virtual AOT for DRM (ER-AAC-SCAL with SBR) */ + AOT_DRM_MPEG_PS = 145, /**< Virtual AOT for DRM (ER-AAC-SCAL with SBR and MPEG-PS) */ + AOT_DRM_SURROUND = 146, /**< Virtual AOT for DRM Surround (ER-AAC-SCAL (+SBR) +MPS) */ + + AOT_MP2_PS = 156, /**< Virtual AOT MP2 Low Complexity Profile with SBR and PS */ + + AOT_MPEGS_RESIDUALS = 256 /**< Virtual AOT for MPEG Surround residuals */ + +} AUDIO_OBJECT_TYPE; + +/** Channel Mode ( 1-7 equals MPEG channel configurations, others are arbitrary). */ +typedef enum { + MODE_INVALID = -1, + MODE_UNKNOWN = 0, + MODE_1 = 1, /**< SCE */ + MODE_2 = 2, /**< CPE */ + MODE_1_2 = 3, /**< SCE,CPE */ + MODE_1_2_1 = 4, /**< SCE,CPE,SCE */ + MODE_1_2_2 = 5, /**< SCE,CPE,CPE */ + MODE_1_2_2_1 = 6, /**< SCE,CPE,CPE,LFE */ + MODE_1_2_2_2_1 = 7, /**< SCE,CPE,CPE,CPE,LFE */ + + MODE_1_1 = 16, /**< 2 SCEs (dual mono) */ + MODE_1_1_1_1 = 17, /**< 4 SCEs */ + MODE_1_1_1_1_1_1 = 18, /**< 6 SCEs */ + MODE_1_1_1_1_1_1_1_1 = 19, /**< 8 SCEs */ + MODE_1_1_1_1_1_1_1_1_1_1_1_1 = 20, /**< 12 SCEs */ + + MODE_2_2 = 21, /**< 2 CPEs */ + MODE_2_2_2 = 22, /**< 3 CPEs */ + MODE_2_2_2_2 = 23, /**< 4 CPEs */ + MODE_2_2_2_2_2_2 = 24, /**< 6 CPEs */ + + MODE_2_1 = 30 /**< CPE,SCE (ARIB standard) */ + +} CHANNEL_MODE; + +/** Speaker description tags */ +typedef enum { + ACT_NONE, + ACT_FRONT, + ACT_SIDE, + ACT_BACK, + ACT_LFE, + ACT_FRONT_TOP, + ACT_SIDE_TOP, + ACT_BACK_TOP, + ACT_TOP /* Ts */ +} AUDIO_CHANNEL_TYPE; + +/** + * Audio Codec flags. + */ +#define AC_ER_VCB11 0x000001 /*!< aacSectionDataResilienceFlag flag (from ASC): 1 means use virtual codebooks */ +#define AC_ER_RVLC 0x000002 /*!< aacSpectralDataResilienceFlag flag (from ASC): 1 means use huffman codeword reordering */ +#define AC_ER_HCR 0x000004 /*!< aacSectionDataResilienceFlag flag (from ASC): 1 means use virtual codebooks */ +#define AC_SCALABLE 0x000008 /*!< AAC Scalable*/ +#define AC_ELD 0x000010 /*!< AAC-ELD */ +#define AC_LD 0x000020 /*!< AAC-LD */ +#define AC_ER 0x000040 /*!< ER syntax */ +#define AC_BSAC 0x000080 /*!< BSAC */ +#define AC_USAC 0x000100 /*!< USAC */ +#define AC_USAC_TW 0x000200 /*!< USAC time warped filter bank is active */ +#define AC_USAC_NOISE 0x000400 /*!< USAC noise filling is active */ +#define AC_USAC_HBE 0x000800 /*!< USAC harmonic bandwidth extension is active */ +#define AC_RSVD50 0x001000 /*!< Rsvd50 */ +#define AC_SBR_PRESENT 0x002000 /*!< SBR present flag (from ASC) */ +#define AC_SBRCRC 0x004000 /*!< SBR CRC present flag. Only relevant for AAC-ELD for now. */ +#define AC_PS_PRESENT 0x008000 /*!< PS present flag (from ASC or implicit) */ +#define AC_MPS_PRESENT 0x010000 /*!< MPS present flag (from ASC or implicit) */ +#define AC_DRM 0x020000 /*!< DRM bit stream syntax */ +#define AC_INDEP 0x040000 /*!< Independency flag */ +#define AC_MPS_RES 0x080000 /*!< MPS residual individual channel data. */ +#define AC_DAB 0x800000 /*!< DAB bit stream syntax */ +#define AC_LD_MPS 0x01000000 /*!< Low Delay MPS. */ + + +/* CODER_CONFIG::flags */ +#define CC_MPEG_ID 0x00100000 +#define CC_IS_BASELAYER 0x00200000 +#define CC_PROTECTION 0x00400000 +#define CC_SBR 0x00800000 +#define CC_RVLC 0x01000000 +#define CC_VCB11 0x02000000 +#define CC_HCR 0x04000000 +#define CC_PSEUDO_SURROUND 0x08000000 +#define CC_USAC_NOISE 0x10000000 +#define CC_USAC_TW 0x20000000 +#define CC_USAC_HBE 0x40000000 + +/** Generic audio coder configuration structure. */ +typedef struct { + AUDIO_OBJECT_TYPE aot; /**< Audio Object Type (AOT). */ + AUDIO_OBJECT_TYPE extAOT; /**< Extension Audio Object Type (SBR). */ + CHANNEL_MODE channelMode; /**< Channel mode. */ + INT samplingRate; /**< Sampling rate. */ + INT extSamplingRate; /**< Extended samplerate (SBR). */ + INT bitRate; /**< Average bitrate. */ + int samplesPerFrame; /**< Number of PCM samples per codec frame and audio channel. */ + int noChannels; /**< Number of audio channels. */ + int bitsFrame; + int nSubFrames; /**< Amount of encoder subframes. 1 means no subframing. */ + int BSACnumOfSubFrame; /**< The number of the sub-frames which are grouped and transmitted in a super-frame (BSAC). */ + int BSAClayerLength; /**< The average length of the large-step layers in bytes (BSAC). */ + UINT flags; /**< flags */ + UCHAR matrixMixdownA; /**< Matrix mixdown index to put into PCE. Default value 0 means no mixdown coefficient, + valid values are 1-4 which correspond to matrix_mixdown_idx 0-3. */ + UCHAR headerPeriod; /**< Frame period for sending in band configuration buffers in the transport layer. */ + + UCHAR stereoConfigIndex; /**< USAC MPS stereo mode */ + UCHAR sbrMode; /**< USAC SBR mode */ +} CODER_CONFIG; + +/** MP4 Element IDs. */ +typedef enum +{ + ID_NONE = -1, /**< Invalid Element helper ID. */ + ID_SCE = 0, /**< Single Channel Element. */ + ID_CPE = 1, /**< Channel Pair Element. */ + ID_CCE = 2, /**< Coupling Channel Element. */ + ID_LFE = 3, /**< LFE Channel Element. */ + ID_DSE = 4, /**< Currently one Data Stream Element for ancillary data is supported. */ + ID_PCE = 5, /**< Program Config Element. */ + ID_FIL = 6, /**< Fill Element. */ + ID_END = 7, /**< Arnie (End Element = Terminator). */ + ID_EXT = 8, /**< Extension Payload (ER only). */ + ID_SCAL = 9, /**< AAC scalable element (ER only). */ + ID_LAST +} MP4_ELEMENT_ID; + +#define EXT_ID_BITS 4 /**< Size in bits of extension payload type tags. */ + +/** Extension payload types. */ +typedef enum { + EXT_FIL = 0x00, + EXT_FILL_DATA = 0x01, + EXT_DATA_ELEMENT = 0x02, + EXT_DATA_LENGTH = 0x03, + EXT_LDSAC_DATA = 0x09, + EXT_SAOC_DATA = 0x0a, + EXT_DYNAMIC_RANGE = 0x0b, + EXT_SAC_DATA = 0x0c, + EXT_SBR_DATA = 0x0d, + EXT_SBR_DATA_CRC = 0x0e +} EXT_PAYLOAD_TYPE; + + +/** + * Proprietary raw packet file configuration data type identifier. + */ +typedef enum +{ + TC_NOTHING = 0, /* No configuration available -> in-band configuration. */ + TC_RAW_ASC, /* Configuration data field is a raw AudioSpecificConfig. */ + TC_RAW_SMC, /* Configuration data field is a raw StreamMuxConfig. */ + TC_RAW_SDC /* Configuration data field is a raw Drm SDC. */ + +} TP_CONFIG_TYPE; + +/* + * ############################################################################################## + * Library identification and error handling + * ############################################################################################## + */ +/* \cond */ +#define MODULE_ID_MASK (0x000000ff) +#define MODULE_ID_SHIFT (24) + +typedef enum { + FDK_NONE = 0, + FDK_TOOLS = 1, + FDK_SYSLIB = 2, + FDK_AACDEC = 3, + FDK_AACENC = 4, + FDK_SBRDEC = 5, + FDK_SBRENC = 6, + FDK_TPDEC = 7, + FDK_TPENC = 8, + FDK_MPSDEC = 9, + FDK_MPEGFILEREAD = 10, + FDK_MPEGFILEWRITE = 11, + FDK_MP2DEC = 12, + FDK_DABDEC = 13, + FDK_DABPARSE = 14, + FDK_DRMDEC = 15, + FDK_DRMPARSE = 16, + FDK_AACLDENC = 17, + FDK_MP2ENC = 18, + FDK_MP3ENC = 19, + FDK_MP3DEC = 20, + FDK_MP3HEADPHONE = 21, + FDK_MP3SDEC = 22, + FDK_MP3SENC = 23, + FDK_EAEC = 24, + FDK_DABENC = 25, + FDK_DMBDEC = 26, + FDK_FDREVERB = 27, + FDK_DRMENC = 28, + FDK_METADATATRANSCODER = 29, + FDK_AC3DEC = 30, + FDK_PCMDMX = 31, + + FDK_MODULE_LAST + +} FDK_MODULE_ID; + +/* AAC capability flags */ +#define CAPF_AAC_LC 0x00000001 /**< Support flag for AAC Low Complexity. */ +#define CAPF_ER_AAC_LD 0x00000002 /**< Support flag for AAC Low Delay with Error Resilience tools. */ +#define CAPF_ER_AAC_SCAL 0x00000004 /**< Support flag for AAC Scalable. */ +#define CAPF_ER_AAC_LC 0x00000008 /**< Support flag for AAC Low Complexity with Error Resilience tools. */ +#define CAPF_AAC_480 0x00000010 /**< Support flag for AAC with 480 framelength. */ +#define CAPF_AAC_512 0x00000020 /**< Support flag for AAC with 512 framelength. */ +#define CAPF_AAC_960 0x00000040 /**< Support flag for AAC with 960 framelength. */ +#define CAPF_AAC_1024 0x00000080 /**< Support flag for AAC with 1024 framelength. */ +#define CAPF_AAC_HCR 0x00000100 /**< Support flag for AAC with Huffman Codeword Reordering. */ +#define CAPF_AAC_VCB11 0x00000200 /**< Support flag for AAC Virtual Codebook 11. */ +#define CAPF_AAC_RVLC 0x00000400 /**< Support flag for AAC Reversible Variable Length Coding. */ +#define CAPF_AAC_MPEG4 0x00000800 /**< Support flag for MPEG file format. */ +#define CAPF_AAC_DRC 0x00001000 /**< Support flag for AAC Dynamic Range Control. */ +#define CAPF_AAC_CONCEALMENT 0x00002000 /**< Support flag for AAC concealment. */ +#define CAPF_AAC_DRM_BSFORMAT 0x00004000 /**< Support flag for AAC DRM bistream format. */ +#define CAPF_ER_AAC_ELD 0x00008000 /**< Support flag for AAC Enhanced Low Delay with Error Resilience tools. */ +#define CAPF_ER_AAC_BSAC 0x00010000 /**< Support flag for AAC BSAC. */ +#define CAPF_AAC_SUPERFRAMING 0x00020000 /**< Support flag for AAC Superframing. */ + +/* Transport capability flags */ +#define CAPF_ADTS 0x00000001 /**< Support flag for ADTS transport format. */ +#define CAPF_ADIF 0x00000002 /**< Support flag for ADIF transport format. */ +#define CAPF_LATM 0x00000004 /**< Support flag for LATM transport format. */ +#define CAPF_LOAS 0x00000008 /**< Support flag for LOAS transport format. */ +#define CAPF_RAWPACKETS 0x00000010 /**< Support flag for RAW PACKETS transport format. */ +#define CAPF_DRM 0x00000020 /**< Support flag for DRM/DRM+ transport format. */ +#define CAPF_RSVD50 0x00000040 /**< Support flag for RSVD50 transport format */ + +/* SBR capability flags */ +#define CAPF_SBR_LP 0x00000001 /**< Support flag for SBR Low Power mode. */ +#define CAPF_SBR_HQ 0x00000002 /**< Support flag for SBR High Quality mode. */ +#define CAPF_SBR_DRM_BS 0x00000004 /**< Support flag for */ +#define CAPF_SBR_CONCEALMENT 0x00000008 /**< Support flag for SBR concealment. */ +#define CAPF_SBR_DRC 0x00000010 /**< Support flag for SBR Dynamic Range Control. */ +#define CAPF_SBR_PS_MPEG 0x00000020 /**< Support flag for MPEG Parametric Stereo. */ +#define CAPF_SBR_PS_DRM 0x00000040 /**< Support flag for DRM Parametric Stereo. */ + +/* MP2 encoder capability flags */ +#define CAPF_MP2ENC_SS 0x00000001 /**< Support flag for Seamless Switching. */ +#define CAPF_MP2ENC_DAB 0x00000002 /**< Support flag for Layer2 DAB. */ + +/* DAB capability flags */ +#define CAPF_DAB_MP2 0x00000001 /**< Support flag for Layer2 DAB. */ +#define CAPF_DAB_AAC 0x00000002 /**< Support flag for DAB+ (HE-AAC v2). */ +#define CAPF_DAB_PAD 0x00000004 /**< Support flag for PAD extraction. */ +#define CAPF_DAB_DRC 0x00000008 /**< Support flag for Dynamic Range Control. */ +#define CAPF_DAB_SURROUND 0x00000010 /**< Support flag for DAB Surround (MPS). */ + +/* DMB capability flags */ +#define CAPF_DMB_BSAC 0x00000001 /**< Support flag for ER AAC BSAC. */ +#define CAPF_DMB_DRC 0x00000008 /**< Support flag for Dynamic Range Control. */ +#define CAPF_DMB_SURROUND 0x00000010 /**< Support flag for DMB Surround (MPS). */ + +/* PCM up/downmmix capability flags */ +#define CAPF_DMX_BLIND 0x00000001 /**< Support flag for blind downmixing. */ +#define CAPF_DMX_PCE 0x00000002 /**< Support flag for guided downmix with data from MPEG-2/4 Program Config Elements (PCE). */ +#define CAPF_DMX_ARIB 0x00000004 /**< Support flag for PCE guided downmix with slightly different equations and levels to fulfill ARIB standard. */ +#define CAPF_DMX_DVB 0x00000008 /**< Support flag for guided downmix with data from DVB ancillary data fields. */ +#define CAPF_DMX_CH_EXP 0x00000010 /**< Support flag for simple upmixing by dublicating channels or adding zero channels. */ +/* \endcond */ + + +/* + * ############################################################################################## + * Library versioning + * ############################################################################################## + */ + +/** + * Convert each member of version numbers to one single numeric version representation. + * \param lev0 1st level of version number. + * \param lev1 2nd level of version number. + * \param lev2 3rd level of version number. + */ +#define LIB_VERSION(lev0, lev1, lev2) ((lev0<<24 & 0xff000000) | \ + (lev1<<16 & 0x00ff0000) | \ + (lev2<<8 & 0x0000ff00)) + +/** + * Build text string of version. + */ +#define LIB_VERSION_STRING(info) FDKsprintf((info)->versionStr, "%d.%d.%d", (((info)->version >> 24) & 0xff), (((info)->version >> 16) & 0xff), (((info)->version >> 8 ) & 0xff)) + +/** + * Library information. + */ +typedef struct LIB_INFO +{ + const char* title; + const char* build_date; + const char* build_time; + FDK_MODULE_ID module_id; + INT version; + UINT flags; + char versionStr[32]; +} LIB_INFO; + +/** Initialize library info. */ +static inline void FDKinitLibInfo( LIB_INFO* info ) +{ + int i; + + for (i = 0; i < FDK_MODULE_LAST; i++) { + info[i].module_id = FDK_NONE; + } +} + +/** Aquire supported features of library. */ +static inline UINT FDKlibInfo_getCapabilities( const LIB_INFO* info, FDK_MODULE_ID module_id ) +{ + int i; + + for (i=0; i<FDK_MODULE_LAST; i++) { + if (info[i].module_id == module_id) { + return info[i].flags; + } + } + return 0; +} + +/** Search for next free tab. */ +static inline INT FDKlibInfo_lookup( const LIB_INFO* info, FDK_MODULE_ID module_id ) +{ + int i = -1; + + for (i = 0; i < FDK_MODULE_LAST; i++) { + if (info[i].module_id == module_id) + return -1; + if (info[i].module_id == FDK_NONE) + break; + } + if (i == FDK_MODULE_LAST) + return -1; + + return i; +} + + +/* + * ############################################################################################## + * Buffer description + * ############################################################################################## + */ + +/** + * I/O buffer descriptor. + */ +typedef struct FDK_bufDescr +{ + void **ppBase; /*!< Pointer to an array containing buffer base addresses. + Set to NULL for buffer requirement info. */ + UINT *pBufSize; /*!< Pointer to an array containing the number of elements that can + be placed in the specific buffer. */ + UINT *pEleSize; /*!< Pointer to an array containing the element size for each buffer + in bytes. That is mostly the number returned by the sizeof() + operator for the data type used for the specific buffer. */ + UINT *pBufType; /*!< Pointer to an array of bit fields containing a description + for each buffer. See XXX below for more details. */ + UINT numBufs; /*!< Total number of buffers. */ + +} FDK_bufDescr; + +/** + * Buffer type description field. + */ +#define FDK_BUF_TYPE_MASK_IO ( 0x03 << 30 ) +#define FDK_BUF_TYPE_MASK_DESCR ( 0x3F << 16 ) +#define FDK_BUF_TYPE_MASK_ID ( 0xFF ) + +#define FDK_BUF_TYPE_INPUT ( 0x1 << 30 ) +#define FDK_BUF_TYPE_OUTPUT ( 0x2 << 30 ) + +#define FDK_BUF_TYPE_PCM_DATA ( 0x1 << 16 ) +#define FDK_BUF_TYPE_ANC_DATA ( 0x2 << 16 ) +#define FDK_BUF_TYPE_BS_DATA ( 0x4 << 16 ) + +#ifdef __cplusplus +} +#endif + +#endif /* FDK_AUDIO_H */ diff --git a/libSYS/include/audio.h b/libSYS/include/audio.h new file mode 100644 index 0000000..08e679d --- /dev/null +++ b/libSYS/include/audio.h @@ -0,0 +1,44 @@ +/************************** Fraunhofer IIS FDK SysLib ********************** + + (C) Copyright Fraunhofer IIS (2003) + All Rights Reserved + + Please be advised that this software and/or program delivery is + Confidential Information of Fraunhofer and subject to and covered by the + + Fraunhofer IIS Software Evaluation Agreement + between Google Inc. and Fraunhofer + effective and in full force since March 1, 2012. + + You may use this software and/or program only under the terms and + conditions described in the above mentioned Fraunhofer IIS Software + Evaluation Agreement. Any other and/or further use requires a separate agreement. + + + $Id$ + Author: Manuel Jander + + This software and/or program is protected by copyright law and international + treaties. Any reproduction or distribution of this software and/or program, + or any portion of it, may result in severe civil and criminal penalties, and + will be prosecuted to the maximum extent possible under law. + +******************************************************************************/ + +/** \file audio.h + * \brief Audio device support. + * + * This component features audio playback and capture with a common API for + * any software/hardware platform. + * + * If you use Microsoft Visual C++ Version 6 and Ksmedia.h cannot be found, + * installing DirectX (e.g. dx9sdk_summer2004.exe) solves it. + * + */ + +#ifndef AUDIO_H +#define AUDIO_H + + + +#endif diff --git a/libSYS/include/cmdl_parser.h b/libSYS/include/cmdl_parser.h new file mode 100644 index 0000000..9ddf692 --- /dev/null +++ b/libSYS/include/cmdl_parser.h @@ -0,0 +1,159 @@ +/************************** Fraunhofer IIS FDK SysLib ********************** + + (C) Copyright Fraunhofer IIS (1999) + All Rights Reserved + + Please be advised that this software and/or program delivery is + Confidential Information of Fraunhofer and subject to and covered by the + + Fraunhofer IIS Software Evaluation Agreement + between Google Inc. and Fraunhofer + effective and in full force since March 1, 2012. + + You may use this software and/or program only under the terms and + conditions described in the above mentioned Fraunhofer IIS Software + Evaluation Agreement. Any other and/or further use requires a separate agreement. + + + $Id$ + Author(s): + Description: command line parser + + This software and/or program is protected by copyright law and international + treaties. Any reproduction or distribution of this software and/or program, + or any portion of it, may result in severe civil and criminal penalties, and + will be prosecuted to the maximum extent possible under law. + +******************************************************************************/ + +/** \file cmdl_parser.h + * \brief Command line parser. + * + * The command line parser can extract certain data fields out of a character + * string and assign values to variables. It has 2 main functions. One to parse + * a command line in the form of standard C runtime "argc" and "argv" parameters, + * and the other to assemble these parameters reading text lines from a file in + * case the C runtime does not provide them. + */ + +#ifndef __PARSER_H +#define __PARSER_H + + + +#include "machine_type.h" + +#define CMDL_MAX_STRLEN 255 +#define CMDL_MAX_ARGC 30 + +/* \cond */ +/* Type definition for text */ + + +#ifdef WIN32 + #include <tchar.h> + #ifndef _tstof /* For Visual Studio 6 */ + #ifdef _UNICODE + #include <wchar.h> + #define _tstof(x) (float) wcstod(x, NULL) /* For Visual Studio 6 */ + #else + #define _tstof atof + #endif + #endif + + #ifndef _tstol /* For Visual Studio 6 */ + #ifdef _UNICODE + #define _tstol _wtol + #else + #define _tstol atol + #endif + #endif + + #ifndef _tstoi /* For Visual Studio 6 */ + #ifdef _UNICODE + #define _tstoi _wtoi + #else + #define _tstoi atoi + #endif + #endif + + #ifndef TEXTCHAR + #define TEXTCHAR char + #endif + + #ifndef _TEXT + #define _TEXT + #endif + +#else /* WIN32 */ + + #define TEXTCHAR char + #define _tcslen(a) FDKstrlen(a) + #define _tcscpy strcpy + #define _tcscmp FDKstrcmp + #define _tcsncmp FDKstrncmp + #define _tscanf scanf + #define _TEXT(x) x + #define _tfopen fopen + #define _ftprintf fprintf + #define _tcsncpy FDKstrncpy + #define _tstof FDKatof + #define _tstol FDKatol + #define _tstoi FDKatoi + #define _tcstol strtol + #define _istdigit isdigit +#endif /* WIN32 */ + +/* \endcond */ + +#ifdef __cplusplus +extern "C" +{ +#endif + +/** + * Scans argc, argv and a scanf style format string for parameters and stores the + * values in the variable number of pointers passed to the function. + + For example: + \code + #define ARG_PARAM "(-a %d) (-v %1)" + #define ARG_VALUE &config->aot, &verbose + int nFoundArgs = IIS_ScanCmdl(argc, argv, ARG_PARAM, ARG_VALUE); + \endcode + wheras the wild-cards (\%d, \%1, ..) define the data type of the argument: + - \%1 boolean (e. g. -x) + - \%d integer (e. g. -x 23) + - \%f float (e. g. -x 3.4) + - \%y double (e. g. -x 31415926535897932384626433832795028841971693993751) + - \%s string (e. g. -x "file.dat") + - \%u unsigned character (e. g. -x 3) + - \%c signed character (e. g. -x -3) + More examples on how to use it are located in every (encoder/decoder) example framework. + + * \param argc Number of arguments. + * \param argv Complete character string of the command line arguments. + * \param pReqArgs A list of parameters and a corresponding list of memory addresses to + * assign each parameter to. + * + * \return Number of found arguments. + */ +INT IIS_ScanCmdl(INT argc, TEXTCHAR* argv[], const TEXTCHAR* pReqArgs, ...); + +#ifdef __cplusplus +} +#endif + +/** + * Reads a text file, assembles argc and argv parameters for each text line + * and calls the given function for each set of argc, argv parameters. + * + * \param param_filename Name of text file that should be parsed. + * \param pFunction Pointer to function that should be called for every text line found. + * + * \return 0 on success, 1 on failure. + */ +INT IIS_ProcessCmdlList(const TEXTCHAR* param_filename, int (*pFunction)(int, TEXTCHAR**)); + + +#endif /* __PARSER_H */ diff --git a/libSYS/include/conv_string.h b/libSYS/include/conv_string.h new file mode 100644 index 0000000..923ae4d --- /dev/null +++ b/libSYS/include/conv_string.h @@ -0,0 +1,74 @@ +/************************** Fraunhofer IIS FDK SysLib ********************** + + (C) Copyright Fraunhofer IIS (2009) + All Rights Reserved + + Please be advised that this software and/or program delivery is + Confidential Information of Fraunhofer and subject to and covered by the + + Fraunhofer IIS Software Evaluation Agreement + between Google Inc. and Fraunhofer + effective and in full force since March 1, 2012. + + You may use this software and/or program only under the terms and + conditions described in the above mentioned Fraunhofer IIS Software + Evaluation Agreement. Any other and/or further use requires a separate agreement. + + + $Id$ + Author(s): + + This software and/or program is protected by copyright law and international + treaties. Any reproduction or distribution of this software and/or program, + or any portion of it, may result in severe civil and criminal penalties, and + will be prosecuted to the maximum extent possible under law. + +******************************************************************************/ + +/** \file conv_string.h + * \brief String conversion functions. + */ + +#ifndef _CONV_STRING_H +#define _CONV_STRING_H + + + +#include "genericStds.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + +/** + * \brief Convert a bitbuffer to a hex string. + * \param string Hex string. + * \param charBuf Input buffer that has to be converted. + * \param charBufLength Size of the input buffer. + * \return Error code. + */ +INT charBuf2HexString(char *string, UCHAR *charBuf, INT charBufLength); + +/** + * \brief Convert a hex string to bits. + * \param string Hex string that has to be converted. + * \param charBuf Output buffer holding the bits, will be filled up with zeros. + * \param charBufLength Size of the output buffer. + * \return Error code. + */ +INT hexString2CharBuf(const char *string, UCHAR *charBuf, UINT charBufLength); + +/** + * \brief Convert a character representing a hex sign to the appropriate value. + * \param c Character that has to be converted. + * \return Converted value (value between 0 and 15), if 16, an error has occured. + */ +UCHAR hexChar2Dec(const char c); + +#ifdef __cplusplus +} +#endif + + +#endif /* _CONV_STRING_H */ diff --git a/libSYS/include/genericStds.h b/libSYS/include/genericStds.h new file mode 100644 index 0000000..8009050 --- /dev/null +++ b/libSYS/include/genericStds.h @@ -0,0 +1,421 @@ +/************************** Fraunhofer IIS FDK SysLib ********************** + + (C) Copyright Fraunhofer IIS (2002) + All Rights Reserved + + Please be advised that this software and/or program delivery is + Confidential Information of Fraunhofer and subject to and covered by the + + Fraunhofer IIS Software Evaluation Agreement + between Google Inc. and Fraunhofer + effective and in full force since March 1, 2012. + + You may use this software and/or program only under the terms and + conditions described in the above mentioned Fraunhofer IIS Software + Evaluation Agreement. Any other and/or further use requires a separate agreement. + + + $Id$ + Author(s): + + This software and/or program is protected by copyright law and international + treaties. Any reproduction or distribution of this software and/or program, + or any portion of it, may result in severe civil and criminal penalties, and + will be prosecuted to the maximum extent possible under law. + +******************************************************************************/ + +/** \file genericStds.h + \brief Generic Run-Time Support function wrappers and heap allocation monitoring. + */ + +#if !defined(__GENERICSTDS_H__) +#define __GENERICSTDS_H__ + +#include "machine_type.h" + +/* Work around for broken android toolchain: sys/types.h:137: error: 'uint64_t' does not name a type */ +#define _SYS_TYPES_H_ + + +/* Always increase verbosity of memory allocation in case of a debug built. DEBUG is defined globally in that case. */ +#if defined(DEBUG) || defined(FDK_DEBUG) +#define MEMORY_MEASUREMENT +#endif + +#ifndef M_PI + #define M_PI 3.14159265358979323846 /*! Pi. Only used in example projects. */ +#endif + + +/* #define _CRT_SECURE_NO_DEPRECATE */ + + +/** + * Identifiers for various memory locations. They are used along with memory allocation + * functions like FDKcalloc_L() to specify the requested memory's location. + */ +typedef enum { + /* Internal */ + SECT_DATA_L1 = 0x2000, + SECT_DATA_L2, + SECT_DATA_L1_A, + SECT_DATA_L1_B, + SECT_CONSTDATA_L1, + + /* External */ + SECT_DATA_EXTERN = 0x4000, + SECT_CONSTDATA_EXTERN + +} MEMORY_SECTION; + + +/** + * The H_ prefix indicates header file version, the C_* prefix indicates the corresponding + * object version. + * + * Declaring memory areas requires to specify a unique name and a data type. Use the H_ macro + * for this purpose inside a header file. + * + * For defining a memory area your require additionally one or two sizes, depending if the + * memory should be organized into one or two dimensions. + * + * The macros containing the keyword AALLOC instead of ALLOC also do take care of returning + * aligned memory addresses (beyond the natural alignment of its type). The preprocesor macro + * ::ALIGNMENT_DEFAULT indicates the aligment to be used (this is hardware specific). + * + * The _L suffix indicates that the memory will be located in a specific section. This is + * useful to allocate critical memory section into fast internal SRAM for example. + * + */ + +#define H_ALLOC_MEM(name,type) type * Get ## name(int n=0); void Free ## name(type** p); \ + UINT GetRequiredMem ## name(void); + +/** See #H_ALLOC_MEM for description. */ +#define H_ALLOC_MEM_OVERLAY(name,type) type * Get ## name(int n=0); void Free ## name(type** p); \ + UINT GetRequiredMem ## name(void); + + + /** See #H_ALLOC_MEM for description. */ + #define C_ALLOC_MEM(name,type,num) \ + type * Get ## name(int n) { FDK_ASSERT((n) == 0); return ((type*)FDKcalloc(num, sizeof(type))); } \ + void Free ## name(type** p) { if (p != NULL) { FDKfree(*p); *p=NULL; } } \ + UINT GetRequiredMem ## name(void) { return ALGN_SIZE_EXTRES((num) * sizeof(type)); } + + /** See #H_ALLOC_MEM for description. */ + #define C_ALLOC_MEM_STATIC(name,type,num) \ + static type * Get ## name(int n) { FDK_ASSERT((n) == 0); return ((type*)FDKcalloc(num, sizeof(type))); } \ + static void Free ## name(type** p) { if (p != NULL) { FDKfree(*p); *p=NULL; } } \ + static UINT GetRequiredMem ## name(void) { return ALGN_SIZE_EXTRES((num) * sizeof(type)); } + + /** See #H_ALLOC_MEM for description. */ + #define C_ALLOC_MEM2(name,type,n1,n2) \ + type * Get ## name (int n) { FDK_ASSERT((n) < (n2)); return ((type*)FDKcalloc(n1, sizeof(type))); } \ + void Free ## name(type** p) { if (p != NULL) { FDKfree(*p); *p=NULL; } } \ + UINT GetRequiredMem ## name(void) { return ALGN_SIZE_EXTRES((n1) * sizeof(type)) * (n2); } + + /** See #H_ALLOC_MEM for description. */ + #define C_AALLOC_MEM(name,type,num) \ + type * Get ## name(int n) { FDK_ASSERT((n) == 0); return ((type*)FDKaalloc((num)*sizeof(type), ALIGNMENT_DEFAULT)); } \ + void Free ## name(type** p) { if (p != NULL) { FDKafree(*p); *p=NULL; } } \ + UINT GetRequiredMem ## name(void) { return ALGN_SIZE_EXTRES((num) * sizeof(type) + ALIGNMENT_DEFAULT + sizeof(void *)); } + + /** See #H_ALLOC_MEM for description. */ + #define C_AALLOC_MEM2(name,type,n1,n2) \ + type * Get ## name (int n) { FDK_ASSERT((n) < (n2)); return ((type*)FDKaalloc((n1)*sizeof(type), ALIGNMENT_DEFAULT)); } \ + void Free ## name(type** p) { if (p != NULL) { FDKafree(*p); *p=NULL; } } \ + UINT GetRequiredMem ## name(void) { return ALGN_SIZE_EXTRES((n1) * sizeof(type) + ALIGNMENT_DEFAULT + sizeof(void *)) * (n2); } + + /** See #H_ALLOC_MEM for description. */ + #define C_ALLOC_MEM_L(name,type,num,s) \ + type * Get ## name(int n) { FDK_ASSERT((n) == 0); return ((type*)FDKcalloc_L(num, sizeof(type), s)); } \ + void Free ## name(type** p) { if (p != NULL) { FDKfree_L(*p); *p=NULL; } } \ + UINT GetRequiredMem ## name(void) { return ALGN_SIZE_EXTRES((num) * sizeof(type)); } + + /** See #H_ALLOC_MEM for description. */ + #define C_ALLOC_MEM2_L(name,type,n1,n2,s) \ + type * Get ## name (int n) { FDK_ASSERT((n) < (n2)); return (type*)FDKcalloc_L(n1, sizeof(type), s); } \ + void Free ## name(type** p) { if (p != NULL) { FDKfree_L(*p); *p=NULL; } } \ + UINT GetRequiredMem ## name(void) { return ALGN_SIZE_EXTRES((n1) * sizeof(type)) * (n2); } + + /** See #H_ALLOC_MEM for description. */ + #define C_AALLOC_MEM_L(name,type,num,s) \ + type * Get ## name(int n) { FDK_ASSERT((n) == 0); return ((type*)FDKaalloc_L((num)*sizeof(type), ALIGNMENT_DEFAULT, s)); } \ + void Free ## name(type** p) { if (p != NULL) { FDKafree_L(*p); *p=NULL; } } \ + UINT GetRequiredMem ## name(void) { return ALGN_SIZE_EXTRES((num) * sizeof(type) + ALIGNMENT_DEFAULT + sizeof(void *)); } + + /** See #H_ALLOC_MEM for description. */ + #define C_AALLOC_MEM2_L(name,type,n1,n2,s) \ + type * Get ## name (int n) { FDK_ASSERT((n) < (n2)); return ((type*)FDKaalloc_L((n1)*sizeof(type), ALIGNMENT_DEFAULT, s)); } \ + void Free ## name(type** p) { if (p != NULL) { FDKafree_L(*p); *p=NULL; } } \ + UINT GetRequiredMem ## name(void) { return ALGN_SIZE_EXTRES((n1) * sizeof(type) + ALIGNMENT_DEFAULT + sizeof(void *)) * (n2); } + +/** See #H_ALLOC_MEM_OVERLAY for description. */ + + + #define C_ALLOC_MEM_OVERLAY(name,type,num,sect,tag) C_AALLOC_MEM_L(name,type,num,sect) + + + #define C_AALLOC_SCRATCH_START(name,type,n) \ + type _ ## name[(n)+(ALIGNMENT_DEFAULT+sizeof(type)-1)]; \ + type * name = (type*)ALIGN_PTR(_ ## name); \ + + #define C_ALLOC_SCRATCH_START(name,type,n) \ + type name[n]; + + #define C_AALLOC_SCRATCH_END(name,type,n) + #define C_ALLOC_SCRATCH_END(name,type,n) + + +/*-------------------------------------------- + * Runtime support declarations + *---------------------------------------------*/ +#ifdef __cplusplus +extern "C" { +#endif + +/** printf() using stdout. If ::ARCH_WA_FLUSH_CONSOLE defined, a flush is done additionally after printf(). */ +void FDKprintf ( const char* szFmt, ...); + +/** printf() using stderr. If ::ARCH_WA_FLUSH_CONSOLE defined, a flush is done additionally after printf(). */ +void FDKprintfErr ( const char* szFmt, ...); + +/** Wrapper for <stdio.h>'s getchar(). */ +int FDKgetchar(void); + +INT FDKfprintf(void *stream, const char *format, ...); +INT FDKsprintf(char *str, const char *format, ...); + + + +const char *FDKstrchr(const char *s, INT c); +const char *FDKstrstr(const char *haystack, const char *needle); +char *FDKstrcpy(char *dest, const char *src); +char *FDKstrncpy(char *dest, const char *src, const UINT n); + +#define FDK_MAX_OVERLAYS 8 /**< Maximum number of memory overlays. */ + + +void *FDKcalloc (const UINT n, const UINT size); +void *FDKmalloc (const UINT size); +void FDKfree (void *ptr); + +/** + * Allocate and clear an aligned memory area. Use FDKafree() instead of FDKfree() for these memory areas. + * + * \param size Size of requested memory in bytes. + * \param alignment Alignment of requested memory in bytes. + * \return Pointer to allocated memory. + */ +void *FDKaalloc (const UINT size, const UINT alignment); + +/** + * Free an aligned memory area. + * + * \param ptr Pointer to be freed. + * \return void + */ +void FDKafree (void *ptr); + + +/** + * Allocate memory in a specific memory section. + * Requests can be made for internal or external memory. If internal memory is + * requested, FDKcalloc_L() first tries to use L1 memory, which sizes are defined + * by ::DATA_L1_A_SIZE and ::DATA_L1_B_SIZE. If no L1 memory is available, then + * FDKcalloc_L() tries to use L2 memory. If that fails as well, the requested + * memory is allocated at an extern location using the fallback FDKcalloc(). + * + * \param n See MSDN documentation on calloc(). + * \param size See MSDN documentation on calloc(). + * \param s Memory section. + * \return See MSDN documentation on calloc(). + */ +void *FDKcalloc_L(const UINT n, const UINT size, MEMORY_SECTION s); + +/** + * Allocate aligned memory in a specific memory section. + * See FDKcalloc_L() description for details - same applies here. + */ +void *FDKaalloc_L(const UINT size, const UINT alignment, MEMORY_SECTION s); + +/** + * Free memory that was allocated in a specific memory section. + */ +void FDKfree_L(void *ptr); + +/** + * Free aligned memory that was allocated in a specific memory section. + */ +void FDKafree_L(void *ptr); + + +/** + * Copy memory. Source and destination memory must not overlap. + * Either use implementation from a Standard Library, or, if no Standard Library + * is available, a generic implementation. + * The define ::USE_BUILTIN_MEM_FUNCTIONS in genericStds.cpp controls what to use. + * The function arguments correspond to the standard memcpy(). Please see MSDN + * documentation for details on how to use it. + */ +void FDKmemcpy(void *dst, const void *src, const UINT size); + +/** + * Copy memory. Source and destination memory are allowed to overlap. + * Either use implementation from a Standard Library, or, if no Standard Library + * is available, a generic implementation. + * The define ::USE_BUILTIN_MEM_FUNCTIONS in genericStds.cpp controls what to use. + * The function arguments correspond to the standard memmove(). Please see MSDN + * documentation for details on how to use it. +*/ +void FDKmemmove(void *dst, const void *src, const UINT size); + +/** + * Clear memory. + * Either use implementation from a Standard Library, or, if no Standard Library + * is available, a generic implementation. + * The define ::USE_BUILTIN_MEM_FUNCTIONS in genericStds.cpp controls what to use. + * The function arguments correspond to the standard memclear(). Please see MSDN + * documentation for details on how to use it. +*/ +void FDKmemclear(void *memPtr, const UINT size); + +/** + * Fill memory with values. + * The function arguments correspond to the standard memset(). Please see MSDN + * documentation for details on how to use it. + */ +void FDKmemset(void *memPtr, const INT value, const UINT size); + +/* Compare function wrappers */ +INT FDKmemcmp(const void *s1, const void *s2, const UINT size); +INT FDKstrcmp(const char *s1, const char *s2); +INT FDKstrncmp(const char *s1, const char *s2, const UINT size); + +UINT FDKstrlen(const char *s); + +#define FDKmax(a,b) ( (a) > (b) ? (a):(b)) +#define FDKmin(a,b) ( (a) < (b) ? (a):(b)) + +#define FDK_INT_MAX ((INT)0x7FFFFFFF) +#define FDK_INT_MIN ((INT)0x80000000) + +/* Math function wrappers. Only intended for compatibility, not to be highly optimized. */ +/* Used for debugging, dev code .. */ + +INT FDKabs(INT j); +double FDKfabs(double x); +double FDKpow(double x, double y); +double FDKsqrt(double x); +double FDKatan(double x); +double FDKlog(double x); +double FDKsin(double x); +double FDKcos(double x); +double FDKexp(double x); +#define FDKlog2(a) (FDKlog(a)*1.442695041) /* log(2.0) = 1.442695041 */ +#define FDKlog10(a) (FDKlog(a)*0.434294482) /* 1.0/log(10.0) = 0.434294482 */ +double FDKatan2(double y, double x); +double FDKacos(double x); +double FDKtan(double x); +double FDKfloor(double x); +double FDKceil(double x); +INT FDKatoi(const char *nptr); +long FDKatol(const char *nptr); +float FDKatof(const char *nptr); +/* LONG LONG FDKatoll(const char *nptr); */ +/* LONG LONG FDKatoq(const char *nptr); */ + + + +/* FILE I/O */ + +/*! + * Check platform for endianess. + * + * \return 1 if platform is little endian, non-1 if platform is big endian. + */ +#ifdef __cplusplus +inline +#else +static +#endif +int IS_LITTLE_ENDIAN(void) { + int __dummy = 1; + return ( *( (UCHAR*)(&(__dummy) ) ) ); +} + +/*! + * Convert input value to little endian format. + * + * \param val Value to be converted. It may be in both big or little endian. + * \return Value in little endian format. + */ +#define TO_LITTLE_ENDIAN(val) \ + ( (IS_LITTLE_ENDIAN()) ? \ + (val) \ + : ( (((val) & 0xff) << 24) || (((val) & 0xff00)<< 8) || (((val) & 0xff0000)>>8) || (((val) & 0xff000000) >> 24) ) ) + + +/*! + * \fn FDKFILE *FDKfopen(const char *filename, const char *mode); + * Standard fopen() wrapper. + * \fn INT FDKfclose(FDKFILE *FP); + * Standard fclose() wrapper. + * \fn INT FDKfseek(FDKFILE *FP, LONG OFFSET, int WHENCE); + * Standard fseek() wrapper. + * \fn INT FDKftell(FDKFILE *FP); + * Standard ftell() wrapper. + * \fn INT FDKfflush(FDKFILE *fp); + * Standard fflush() wrapper. + * \fn UINT FDKfwrite(void *ptrf, INT size, UINT nmemb, FDKFILE *fp); + * Standard fwrite() wrapper. + * \fn UINT FDKfread(void *dst, INT size, UINT nmemb, FDKFILE *fp); + * Standard fread() wrapper. + */ +typedef void FDKFILE; +extern const INT FDKSEEK_SET, FDKSEEK_CUR, FDKSEEK_END; + +FDKFILE *FDKfopen(const char *filename, const char *mode); +INT FDKfclose(FDKFILE *FP); +INT FDKfseek(FDKFILE *FP, LONG OFFSET, int WHENCE); +INT FDKftell(FDKFILE *FP); +INT FDKfflush(FDKFILE *fp); +UINT FDKfwrite(void *ptrf, INT size, UINT nmemb, FDKFILE *fp); +UINT FDKfread(void *dst, INT size, UINT nmemb, FDKFILE *fp); +char* FDKfgets(void *dst, INT size, FDKFILE *fp); +void FDKrewind(FDKFILE *fp); +INT FDKfeof(FDKFILE *fp); + +/** + * \brief Write each member in little endian order. Convert automatically to host endianess. + * \param ptrf Pointer to memory where to read data from. + * \param size Size of each item to be written. + * \param nmemb Number of items to be written. + * \param fp File pointer of type FDKFILE. + * \return Number of items read on success and fread() error on failure. + */ +UINT FDKfwrite_EL(void *ptrf, INT size, UINT nmemb, FDKFILE *fp); + +/** + * \brief Read variable of size "size" as little endian. Convert automatically to host endianess. + * 4-byte alignment is enforced for 24 bit data, at 32 bit full scale. + * \param dst Pointer to memory where to store data into. + * \param size Size of each item to be read. + * \param nmemb Number of items to be read. + * \param fp File pointer of type FDKFILE. + * \return Number of items read on success and fread() error on failure. + */ +UINT FDKfread_EL(void *dst, INT size, UINT nmemb, FDKFILE *fp); + + +/** + * \brief Print FDK software disclaimer. + */ +void FDKprintDisclaimer(void); + +#ifdef __cplusplus +} +#endif + +#endif /* __GENERICSTDS_H__ */ diff --git a/libSYS/include/machine_type.h b/libSYS/include/machine_type.h new file mode 100644 index 0000000..6b9b7e6 --- /dev/null +++ b/libSYS/include/machine_type.h @@ -0,0 +1,295 @@ +/************************** Fraunhofer IIS FDK SysLib ********************** + + (C) Copyright Fraunhofer IIS (2003) + All Rights Reserved + + Please be advised that this software and/or program delivery is + Confidential Information of Fraunhofer and subject to and covered by the + + Fraunhofer IIS Software Evaluation Agreement + between Google Inc. and Fraunhofer + effective and in full force since March 1, 2012. + + You may use this software and/or program only under the terms and + conditions described in the above mentioned Fraunhofer IIS Software + Evaluation Agreement. Any other and/or further use requires a separate agreement. + + + $Id$ + Author(s): + + This software and/or program is protected by copyright law and international + treaties. Any reproduction or distribution of this software and/or program, + or any portion of it, may result in severe civil and criminal penalties, and + will be prosecuted to the maximum extent possible under law. + +******************************************************************************/ + +/** \file machine_type.h + * \brief Type defines for various processors and compiler tools. + */ + +#if !defined(__MACHINE_TYPE_H__) +#define __MACHINE_TYPE_H__ + + +/* Library calling convention spec. __cdecl and friends might be added here as required. */ + #define LINKSPEC_H + #define LINKSPEC_CPP + + +/** + * collate all corresponding compiler specific macros to detect a debug build, and set the DEBUG macro if that is the case. + */ +#if defined(_DEBUG) +#define DEBUG +#endif + + +/* for doxygen the following docu parts must be separated */ +/** \var SCHAR + * Data type representing at least 1 byte signed integer on all supported platforms. + */ +/** \var UCHAR + * Data type representing at least 1 byte unsigned integer on all supported platforms. + */ +/** \var INT + * Data type representing at least 4 byte signed integer on all supported platforms. + */ +/** \var UINT + * Data type representing at least 4 byte unsigned integer on all supported platforms. + */ +/** \var LONG + * Data type representing 4 byte signed integer on all supported platforms. + */ +/** \var ULONG + * Data type representing 4 byte unsigned integer on all supported platforms. + */ +/** \var SHORT + * Data type representing 2 byte signed integer on all supported platforms. + */ +/** \var USHORT + * Data type representing 2 byte unsigned integer on all supported platforms. + */ +/** \var INT64 + * Data type representing 8 byte signed integer on all supported platforms. + */ +/** \var UINT64 + * Data type representing 8 byte unsigned integer on all supported platforms. + */ +/** \def SHORT_BITS + * Number of bits the data type short represents. sizeof() is not suited to get this info, + * because a byte is not always defined as 8 bits. + */ +/** \def CHAR_BITS + * Number of bits the data type char represents. sizeof() is not suited to get this info, + * because a byte is not always defined as 8 bits. + */ +/** \var INT_PCM + * Data type representing the width of input and output PCM samples. + */ + + + typedef signed int INT; + typedef unsigned int UINT; +#ifdef __x86_64__ + /* force FDK long-datatypes to 4 byte */ + /* jdr: Use defines to avoid type alias problems on 64 bit machines. */ + #define LONG INT + #define ULONG UINT +#else /* __x86_64__ */ + typedef signed long LONG; + typedef unsigned long ULONG; +#endif /* __x86_64__ */ + typedef signed short SHORT; + typedef unsigned short USHORT; + typedef signed char SCHAR; + typedef unsigned char UCHAR; + + #define SHORT_BITS 16 + #define CHAR_BITS 8 + + +/* Define 64 bit base integer type. */ +#ifdef _WIN32 + typedef __int64 INT64; + typedef unsigned __int64 UINT64; +#else + typedef long long INT64; + typedef unsigned long long UINT64; +#endif + +#ifndef NULL + #ifdef __cplusplus + #define NULL 0 + #else + #define NULL ((void *)0) + #endif +#endif + +/* Assert is functional on x86 PC's and also when debugging is turned on. */ +#if defined(DEBUG) || defined(__i686__) || defined(__i586__) || defined(__i386__) || defined(__x86_64__) || defined(_M_IX86) || defined(FDK_DEBUG) || defined(FDK_ASSERT_ENABLE) + #include <assert.h> + #define FDK_ASSERT(x) assert(x) +#else + #define FDK_ASSERT(ignore) +#endif + + typedef SHORT INT_PCM; + #define WAV_BITS 16 + #define SAMPLE_BITS 16 + #define SAMPLE_MAX (((LONG)1<<(SAMPLE_BITS-1))-1) + #define SAMPLE_MIN (~SAMPLE_MAX) + +/*! +* \def RAM_ALIGN +* Used to align memory as prefix before memory declaration. For example: + \code + RAM_ALIGN + int myArray[16]; + \endcode + + Note, that not all platforms support this mechanism. For example with TI compilers + a preprocessor pragma is used, but to do something like + + \code + #define RAM_ALIGN #pragma DATA_ALIGN(x) + \encode + + would require the preprocessor to process this line twice to fully resolve it. Hence, + a fully platform-independant way to use alignment is not supported. + +* \def ALIGNMENT_DEFAULT +* Default alignment in bytes. +*/ +#if defined(__GNUC__) /* cppp replaced: elif */ + #define ALIGNMENT_DEFAULT 8 + #define RAM_ALIGN __attribute__((aligned(ALIGNMENT_DEFAULT))) +#else + #define ALIGNMENT_DEFAULT 8 + #define RAM_ALIGN +#endif + + +/*! +* \def RESTRICT +* The restrict keyword is supported by some platforms and RESTRICT maps to +* either the corresponding keyword on each platform or to void if the +* compiler does not provide such feature. +* +* \def WORD_ALIGNED(x) +* Tells the compiler that pointer x is WORD aligned. +* At the moment only supported by TI compilers. +* +* \def DWORD_ALIGNED(x) +* Tells the compiler that pointer x is DWORD aligned. +* At the moment only supported by TI compilers. +*/ + #define RESTRICT + #define WORD_ALIGNED(x) + #define DWORD_ALIGNED(x) + + +/*----------------------------------------------------------------------------------- + * ALIGN_SIZE + *-----------------------------------------------------------------------------------*/ +/*! + * \brief This macro aligns a given value depending on ::ALIGNMENT_DEFAULT. + * + * For example if #ALIGNMENT_DEFAULT equals 8, then: + * - ALIGN_SIZE(3) returns 8 + * - ALIGN_SIZE(8) returns 8 + * - ALIGN_SIZE(9) returns 16 + */ +#define ALIGN_SIZE(a) ((a)+ (((INT)ALIGNMENT_DEFAULT - ((INT)(a) & (ALIGNMENT_DEFAULT-1)) ) & (ALIGNMENT_DEFAULT-1))) + +/*----------------------------------------------------------------------------------- + * ALIGN_PTR + * cast (a) to width of pointer + *-----------------------------------------------------------------------------------*/ +/*! + * \brief This macro aligns a given address depending on ::ALIGNMENT_DEFAULT. + */ +#define ALIGN_PTR(a) ( (unsigned char*)(a) + (((INT)ALIGNMENT_DEFAULT - ((INT)(UINT64)(a) & (ALIGNMENT_DEFAULT-1)) ) & (ALIGNMENT_DEFAULT-1)) ) + + /* Alignment macro for libSYS heap implementation */ +#define ALIGNMENT_EXTRES ( ALIGNMENT_DEFAULT ) +#define ALGN_SIZE_EXTRES(a) ((a)+ (((INT)ALIGNMENT_EXTRES - ((INT)(a) & (ALIGNMENT_EXTRES-1)) ) & (ALIGNMENT_EXTRES-1))) + + +/*! + * \def FORCEINLINE + * Sometimes compiler do not do what they are told to do, and in case of inlining some + * additional command might be necessary depending on the platform. + * + * \def FDK_INLINE + * Defines how the compiler is told to inline stuff. + */ +#ifdef DEBUG +#undef FORCEINLINE +#define FORCEINLINE +#else +#ifndef FORCEINLINE + #if defined(__GNUC__) /* cppp replaced: elif */ + #define FORCEINLINE __attribute((always_inline)) + #else + #define FORCEINLINE + #endif +#endif +#endif + + /* for all other platforms */ + #define FDK_INLINE inline + + +/*! + * \def LNK_SECTION_DATA_L1 + * The LNK_SECTION_* defines allow memory to be drawn from specific memory + * sections. Used as prefix before variable declaration. + * + * \def LNK_SECTION_DATA_L2 + * See ::LNK_SECTION_DATA_L1 + * \def LNK_SECTION_L1_DATA_A + * See ::LNK_SECTION_DATA_L1 + * \def LNK_SECTION_L1_DATA_B + * See ::LNK_SECTION_DATA_L1 + * \def LNK_SECTION_CONSTDATA_L1 + * See ::LNK_SECTION_DATA_L1 + * \def LNK_SECTION_CONSTDATA + * See ::LNK_SECTION_DATA_L1 + * \def LNK_SECTION_CODE_L1 + * See ::LNK_SECTION_DATA_L1 + * \def LNK_SECTION_CODE_L2 + * See ::LNK_SECTION_DATA_L1 + * \def LNK_SECTION_INITCODE + * See ::LNK_SECTION_DATA_L1 + */ +/************************************************** + * Code Section macros + **************************************************/ + #define LNK_SECTION_CODE_L1 + #define LNK_SECTION_CODE_L2 + #define LNK_SECTION_INITCODE + +/* Memory section macros. */ + + /* default fall back */ + #define LNK_SECTION_DATA_L1 + #define LNK_SECTION_DATA_L2 + #define LNK_SECTION_CONSTDATA + #define LNK_SECTION_CONSTDATA_L1 + + #define LNK_SECTION_L1_DATA_A + #define LNK_SECTION_L1_DATA_B + + +#ifdef _MSC_VER + /* + * Sometimes certain features are excluded from compilation and therefore the warning 4065 may occur: + * "switch statement contains 'default' but no 'case' labels" + * We consider this warning irrelevant and disable it. + */ + #pragma warning( disable : 4065 ) +#endif + +#endif /* __MACHINE_TYPE_H__ */ diff --git a/libSYS/include/wav_file.h b/libSYS/include/wav_file.h new file mode 100644 index 0000000..bebf112 --- /dev/null +++ b/libSYS/include/wav_file.h @@ -0,0 +1,150 @@ +/************************** Fraunhofer IIS FDK SysLib ********************** + + (C) Copyright Fraunhofer IIS (2000) + All Rights Reserved + + Please be advised that this software and/or program delivery is + Confidential Information of Fraunhofer and subject to and covered by the + + Fraunhofer IIS Software Evaluation Agreement + between Google Inc. and Fraunhofer + effective and in full force since March 1, 2012. + + You may use this software and/or program only under the terms and + conditions described in the above mentioned Fraunhofer IIS Software + Evaluation Agreement. Any other and/or further use requires a separate agreement. + + + $Id$ + Author(s): Eric Allamanche + + This software and/or program is protected by copyright law and international + treaties. Any reproduction or distribution of this software and/or program, + or any portion of it, may result in severe civil and criminal penalties, and + will be prosecuted to the maximum extent possible under law. + +******************************************************************************/ + +/** \file wav_file.h + * \brief Rudimentary WAVE file read/write support. + * + * The WAVE file reader/writer is intented to be used in the codec's example + * framework for easily getting started with encoding/decoding. Therefore + * it serves mainly for helping quickly understand how a codec's API actually + * works. + * Being a WAVE file reader/writer with very basic functionality, it may not be + * able to read WAVE files that come with unusual configurations. + * Details on how to use the interface functions can be found in every + * (encoder/decoder) example framework. + */ + +#ifndef __WAV_FILE_H__ +#define __WAV_FILE_H__ + + + +#include "genericStds.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/*! + * RIFF WAVE file struct. + * For details see WAVE file format documentation (for example at http://www.wotsit.org). + */ +typedef struct WAV_HEADER +{ + char riffType[4]; + UINT riffSize; + char waveType[4]; + char formatType[4]; + UINT formatSize; + USHORT compressionCode; + USHORT numChannels; + UINT sampleRate; + UINT bytesPerSecond; + USHORT blockAlign; + USHORT bitsPerSample; + char dataType[4]; + UINT dataSize; +} WAV_HEADER; + +struct WAV +{ + WAV_HEADER header; + FDKFILE *fp; +}; + +typedef struct WAV *HANDLE_WAV; + +/** + * \brief Open a WAV file handle for reading. + * + * \param pWav Pointer to a memory location, where a WAV handle is returned. + * \param filename File name to be opened. + * + * \return 0 on success and non-zero on failure. + */ +INT WAV_InputOpen (HANDLE_WAV *pWav, const char *filename); + +/** + * \brief Read samples from a WAVE file. The samples are automatically re-ordered to the + * native host endianess and scaled to full scale of the INT_PCM type, from + * whatever BPS the WAVE file had specified in its header data. + * + * \param wav Handle of WAV file. + * \param sampleBuffer Pointer to store audio data. + * \param numSamples Desired number of samples to read. + * \param nBufBits Size in bit of each audio sample of sampleBuffer. + * + * \return Number of samples actually read. + */ +INT WAV_InputRead (HANDLE_WAV wav, void *sampleBuffer, UINT numSamples, int nBufBits); + +/** + * \brief Close a WAV file reading handle. + * \param pWav Pointer to a WAV file reading handle. + * \return void + */ +void WAV_InputClose(HANDLE_WAV *pWav); + +/** + * \brief Open WAV output/writer handle. + * + * \param pWav Pointer to WAV handle to be returned. + * \param outputFilename File name of the file to be written to. + * \param sampleRate Desired samplerate of the resulting WAV file. + * \param numChannels Desired number of audio channels of the resulting WAV file. + * \param bitsPerSample Desired number of bits per audio sample of the resulting WAV file. + * + * \return 0: ok; -1: error + */ +INT WAV_OutputOpen(HANDLE_WAV *pWav, const char *outputFilename, INT sampleRate, INT numChannels, INT bitsPerSample); + +/** + * \brief Write data to WAV file asociated to WAV handle. + * + * \param wav Handle of WAV file + * \param sampleBuffer Pointer to audio samples, right justified integer values. + * \param numberOfSamples The number of individual audio sample valuesto be written. + * \param nBufBits Size in bits of each audio sample in sampleBuffer. + * \param nSigBits Amount of significant bits of each nBufBits in sampleBuffer. + * + * \return 0: ok; -1: error + */ +INT WAV_OutputWrite(HANDLE_WAV wav, void *sampleBuffer, UINT numberOfSamples, int nBufBits, int nSigBits); + +/** + * \brief Close WAV output handle. + * \param pWav Pointer to WAV handle. *pWav is set to NULL. + * \return void + */ +void WAV_OutputClose(HANDLE_WAV *pWav); + +#ifdef __cplusplus +} +#endif + + +#endif /* __WAV_FILE_H__ */ |