Home | History | Annotate | Download | only in include
      1 /* -----------------------------------------------------------------------------
      2 Software License for The Fraunhofer FDK AAC Codec Library for Android
      3 
      4  Copyright  1995 - 2018 Fraunhofer-Gesellschaft zur Frderung der angewandten
      5 Forschung e.V. All rights reserved.
      6 
      7  1.    INTRODUCTION
      8 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software
      9 that implements the MPEG Advanced Audio Coding ("AAC") encoding and decoding
     10 scheme for digital audio. This FDK AAC Codec software is intended to be used on
     11 a wide variety of Android devices.
     12 
     13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient
     14 general perceptual audio codecs. AAC-ELD is considered the best-performing
     15 full-bandwidth communications codec by independent studies and is widely
     16 deployed. AAC has been standardized by ISO and IEC as part of the MPEG
     17 specifications.
     18 
     19 Patent licenses for necessary patent claims for the FDK AAC Codec (including
     20 those of Fraunhofer) may be obtained through Via Licensing
     21 (www.vialicensing.com) or through the respective patent owners individually for
     22 the purpose of encoding or decoding bit streams in products that are compliant
     23 with the ISO/IEC MPEG audio standards. Please note that most manufacturers of
     24 Android devices already license these patent claims through Via Licensing or
     25 directly from the patent owners, and therefore FDK AAC Codec software may
     26 already be covered under those patent licenses when it is used for those
     27 licensed purposes only.
     28 
     29 Commercially-licensed AAC software libraries, including floating-point versions
     30 with enhanced sound quality, are also available from Fraunhofer. Users are
     31 encouraged to check the Fraunhofer website for additional applications
     32 information and documentation.
     33 
     34 2.    COPYRIGHT LICENSE
     35 
     36 Redistribution and use in source and binary forms, with or without modification,
     37 are permitted without payment of copyright license fees provided that you
     38 satisfy the following conditions:
     39 
     40 You must retain the complete text of this software license in redistributions of
     41 the FDK AAC Codec or your modifications thereto in source code form.
     42 
     43 You must retain the complete text of this software license in the documentation
     44 and/or other materials provided with redistributions of the FDK AAC Codec or
     45 your modifications thereto in binary form. You must make available free of
     46 charge copies of the complete source code of the FDK AAC Codec and your
     47 modifications thereto to recipients of copies in binary form.
     48 
     49 The name of Fraunhofer may not be used to endorse or promote products derived
     50 from this library without prior written permission.
     51 
     52 You may not charge copyright license fees for anyone to use, copy or distribute
     53 the FDK AAC Codec software or your modifications thereto.
     54 
     55 Your modified versions of the FDK AAC Codec must carry prominent notices stating
     56 that you changed the software and the date of any change. For modified versions
     57 of the FDK AAC Codec, the term "Fraunhofer FDK AAC Codec Library for Android"
     58 must be replaced by the term "Third-Party Modified Version of the Fraunhofer FDK
     59 AAC Codec Library for Android."
     60 
     61 3.    NO PATENT LICENSE
     62 
     63 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
     64 limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
     65 Fraunhofer provides no warranty of patent non-infringement with respect to this
     66 software.
     67 
     68 You may use this FDK AAC Codec software or modifications thereto only for
     69 purposes that are authorized by appropriate patent licenses.
     70 
     71 4.    DISCLAIMER
     72 
     73 This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright
     74 holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
     75 including but not limited to the implied warranties of merchantability and
     76 fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     77 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary,
     78 or consequential damages, including but not limited to procurement of substitute
     79 goods or services; loss of use, data, or profits, or business interruption,
     80 however caused and on any theory of liability, whether in contract, strict
     81 liability, or tort (including negligence), arising in any way out of the use of
     82 this software, even if advised of the possibility of such damage.
     83 
     84 5.    CONTACT INFORMATION
     85 
     86 Fraunhofer Institute for Integrated Circuits IIS
     87 Attention: Audio and Multimedia Departments - FDK AAC LL
     88 Am Wolfsmantel 33
     89 91058 Erlangen, Germany
     90 
     91 www.iis.fraunhofer.de/amm
     92 amm-info (at) iis.fraunhofer.de
     93 ----------------------------------------------------------------------------- */
     94 
     95 /************************* System integration library **************************
     96 
     97    Author(s):
     98 
     99    Description:
    100 
    101 *******************************************************************************/
    102 
    103 /** \file   genericStds.h
    104     \brief  Generic Run-Time Support function wrappers and heap allocation
    105    monitoring.
    106  */
    107 
    108 #if !defined(GENERICSTDS_H)
    109 #define GENERICSTDS_H
    110 
    111 #include "machine_type.h"
    112 
    113 #ifndef M_PI
    114 #define M_PI 3.14159265358979323846 /*!< Pi. Only used in example projects. */
    115 #endif
    116 
    117 /**
    118  * Identifiers for various memory locations. They are used along with memory
    119  * allocation functions like FDKcalloc_L() to specify the requested memory's
    120  * location.
    121  */
    122 typedef enum {
    123   /* Internal */
    124   SECT_DATA_L1 = 0x2000,
    125   SECT_DATA_L2,
    126   SECT_DATA_L1_A,
    127   SECT_DATA_L1_B,
    128   SECT_CONSTDATA_L1,
    129 
    130   /* External */
    131   SECT_DATA_EXTERN = 0x4000,
    132   SECT_CONSTDATA_EXTERN
    133 
    134 } MEMORY_SECTION;
    135 
    136 /*! \addtogroup SYSLIB_MEMORY_MACROS FDK memory macros
    137  *
    138  * The \c H_ prefix indicates that the macro is to be used in a header file, the
    139  * \c C_ prefix indicates that the macro is to be used in a source file.
    140  *
    141  * Declaring memory areas requires to specify a unique name and a data type.
    142  *
    143  * For defining a memory area you require additionally one or two sizes,
    144  * depending if the memory should be organized into one or two dimensions.
    145  *
    146  * The macros containing the keyword \c AALLOC instead of \c ALLOC additionally
    147  * take care of returning aligned memory addresses (beyond the natural alignment
    148  * of its type). The preprocesor macro
    149  * ::ALIGNMENT_DEFAULT indicates the aligment to be used (this is hardware
    150  * specific).
    151  *
    152  * The \c _L suffix indicates that the memory will be located in a specific
    153  * section. This is useful to allocate critical memory section into fast
    154  * internal SRAM for example.
    155  *
    156  * @{
    157  */
    158 
    159 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    160 #define H_ALLOC_MEM(name, type) \
    161   type *Get##name(int n = 0);   \
    162   void Free##name(type **p);    \
    163   UINT GetRequiredMem##name(void);
    164 
    165 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    166 #define H_ALLOC_MEM_OVERLAY(name, type) \
    167   type *Get##name(int n = 0);           \
    168   void Free##name(type **p);            \
    169   UINT GetRequiredMem##name(void);
    170 
    171 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    172 #define C_ALLOC_MEM(name, type, num)               \
    173   type *Get##name(int n) {                         \
    174     FDK_ASSERT((n) == 0);                          \
    175     return ((type *)FDKcalloc(num, sizeof(type))); \
    176   }                                                \
    177   void Free##name(type **p) {                      \
    178     if (p != NULL) {                               \
    179       FDKfree(*p);                                 \
    180       *p = NULL;                                   \
    181     }                                              \
    182   }                                                \
    183   UINT GetRequiredMem##name(void) {                \
    184     return ALGN_SIZE_EXTRES((num) * sizeof(type)); \
    185   }
    186 
    187 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    188 #define C_ALLOC_MEM2(name, type, n1, n2)                 \
    189   type *Get##name(int n) {                               \
    190     FDK_ASSERT((n) < (n2));                              \
    191     return ((type *)FDKcalloc(n1, sizeof(type)));        \
    192   }                                                      \
    193   void Free##name(type **p) {                            \
    194     if (p != NULL) {                                     \
    195       FDKfree(*p);                                       \
    196       *p = NULL;                                         \
    197     }                                                    \
    198   }                                                      \
    199   UINT GetRequiredMem##name(void) {                      \
    200     return ALGN_SIZE_EXTRES((n1) * sizeof(type)) * (n2); \
    201   }
    202 
    203 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    204 #define C_AALLOC_MEM(name, type, num)                                  \
    205   type *Get##name(int n) {                                             \
    206     type *ap;                                                          \
    207     FDK_ASSERT((n) == 0);                                              \
    208     ap = ((type *)FDKaalloc((num) * sizeof(type), ALIGNMENT_DEFAULT)); \
    209     return ap;                                                         \
    210   }                                                                    \
    211   void Free##name(type **p) {                                          \
    212     if (p != NULL) {                                                   \
    213       FDKafree(*p);                                                    \
    214       *p = NULL;                                                       \
    215     }                                                                  \
    216   }                                                                    \
    217   UINT GetRequiredMem##name(void) {                                    \
    218     return ALGN_SIZE_EXTRES((num) * sizeof(type) + ALIGNMENT_DEFAULT + \
    219                             sizeof(void *));                           \
    220   }
    221 
    222 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    223 #define C_AALLOC_MEM2(name, type, n1, n2)                             \
    224   type *Get##name(int n) {                                            \
    225     type *ap;                                                         \
    226     FDK_ASSERT((n) < (n2));                                           \
    227     ap = ((type *)FDKaalloc((n1) * sizeof(type), ALIGNMENT_DEFAULT)); \
    228     return ap;                                                        \
    229   }                                                                   \
    230   void Free##name(type **p) {                                         \
    231     if (p != NULL) {                                                  \
    232       FDKafree(*p);                                                   \
    233       *p = NULL;                                                      \
    234     }                                                                 \
    235   }                                                                   \
    236   UINT GetRequiredMem##name(void) {                                   \
    237     return ALGN_SIZE_EXTRES((n1) * sizeof(type) + ALIGNMENT_DEFAULT + \
    238                             sizeof(void *)) *                         \
    239            (n2);                                                      \
    240   }
    241 
    242 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    243 #define C_ALLOC_MEM_L(name, type, num, s)               \
    244   type *Get##name(int n) {                              \
    245     FDK_ASSERT((n) == 0);                               \
    246     return ((type *)FDKcalloc_L(num, sizeof(type), s)); \
    247   }                                                     \
    248   void Free##name(type **p) {                           \
    249     if (p != NULL) {                                    \
    250       FDKfree_L(*p);                                    \
    251       *p = NULL;                                        \
    252     }                                                   \
    253   }                                                     \
    254   UINT GetRequiredMem##name(void) {                     \
    255     return ALGN_SIZE_EXTRES((num) * sizeof(type));      \
    256   }
    257 
    258 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    259 #define C_ALLOC_MEM2_L(name, type, n1, n2, s)            \
    260   type *Get##name(int n) {                               \
    261     FDK_ASSERT((n) < (n2));                              \
    262     return (type *)FDKcalloc_L(n1, sizeof(type), s);     \
    263   }                                                      \
    264   void Free##name(type **p) {                            \
    265     if (p != NULL) {                                     \
    266       FDKfree_L(*p);                                     \
    267       *p = NULL;                                         \
    268     }                                                    \
    269   }                                                      \
    270   UINT GetRequiredMem##name(void) {                      \
    271     return ALGN_SIZE_EXTRES((n1) * sizeof(type)) * (n2); \
    272   }
    273 
    274 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    275 #define C_AALLOC_MEM_L(name, type, num, s)                                  \
    276   type *Get##name(int n) {                                                  \
    277     type *ap;                                                               \
    278     FDK_ASSERT((n) == 0);                                                   \
    279     ap = ((type *)FDKaalloc_L((num) * sizeof(type), ALIGNMENT_DEFAULT, s)); \
    280     return ap;                                                              \
    281   }                                                                         \
    282   void Free##name(type **p) {                                               \
    283     if (p != NULL) {                                                        \
    284       FDKafree_L(*p);                                                       \
    285       *p = NULL;                                                            \
    286     }                                                                       \
    287   }                                                                         \
    288   UINT GetRequiredMem##name(void) {                                         \
    289     return ALGN_SIZE_EXTRES((num) * sizeof(type) + ALIGNMENT_DEFAULT +      \
    290                             sizeof(void *));                                \
    291   }
    292 
    293 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    294 #define C_AALLOC_MEM2_L(name, type, n1, n2, s)                             \
    295   type *Get##name(int n) {                                                 \
    296     type *ap;                                                              \
    297     FDK_ASSERT((n) < (n2));                                                \
    298     ap = ((type *)FDKaalloc_L((n1) * sizeof(type), ALIGNMENT_DEFAULT, s)); \
    299     return ap;                                                             \
    300   }                                                                        \
    301   void Free##name(type **p) {                                              \
    302     if (p != NULL) {                                                       \
    303       FDKafree_L(*p);                                                      \
    304       *p = NULL;                                                           \
    305     }                                                                      \
    306   }                                                                        \
    307   UINT GetRequiredMem##name(void) {                                        \
    308     return ALGN_SIZE_EXTRES((n1) * sizeof(type) + ALIGNMENT_DEFAULT +      \
    309                             sizeof(void *)) *                              \
    310            (n2);                                                           \
    311   }
    312 
    313 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    314 #define C_ALLOC_MEM_OVERLAY(name, type, num, sect, tag) \
    315   C_AALLOC_MEM_L(name, type, num, sect)
    316 
    317 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    318 #define C_AALLOC_SCRATCH_START(name, type, n)                 \
    319   type _##name[(n) + (ALIGNMENT_DEFAULT + sizeof(type) - 1)]; \
    320   type *name = (type *)ALIGN_PTR(_##name);                    \
    321   C_ALLOC_ALIGNED_REGISTER(name, (n) * sizeof(type));
    322 
    323 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    324 #define C_ALLOC_SCRATCH_START(name, type, n) type name[n];
    325 
    326 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    327 #define C_AALLOC_SCRATCH_END(name, type, n) C_ALLOC_ALIGNED_UNREGISTER(name);
    328 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    329 #define C_ALLOC_SCRATCH_END(name, type, n)
    330 
    331 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    332 #define C_AALLOC_STACK_START(name, type, n)                   \
    333   type _##name[(n) + (ALIGNMENT_DEFAULT + sizeof(type) - 1)]; \
    334   type *name = (type *)ALIGN_PTR(_##name);                    \
    335   C_ALLOC_ALIGNED_REGISTER(name, (n) * sizeof(type));
    336 
    337 /** See \ref SYSLIB_MEMORY_MACROS for description. */
    338 #define C_AALLOC_STACK_END(name, type, n) C_ALLOC_ALIGNED_UNREGISTER(name);
    339 
    340 /*! @} */
    341 
    342 #define C_ALLOC_ALIGNED_REGISTER(x, size)
    343 #define C_ALLOC_ALIGNED_UNREGISTER(x)
    344 #define C_ALLOC_ALIGNED_CHECK(x)
    345 #define C_ALLOC_ALIGNED_CHECK2(x, y)
    346 #define FDK_showBacktrace(a, b)
    347 
    348 /*! \addtogroup SYSLIB_EXITCODES Unified exit codes
    349  *  Exit codes to be used as return values of FDK software test and
    350  * demonstration applications. Not as return values of product modules and/or
    351  * libraries.
    352  *  @{
    353  */
    354 #define FDK_EXITCODE_OK 0 /*!< Successful termination. No errors. */
    355 #define FDK_EXITCODE_USAGE                                                  \
    356   64 /*!< The command/application was used incorrectly, e.g. with the wrong \
    357         number of arguments, a bad flag, a bad syntax in a parameter, or    \
    358         whatever. */
    359 #define FDK_EXITCODE_DATAERROR                                               \
    360   65 /*!< The input data was incorrect in some way. This should only be used \
    361         for user data and not system files. */
    362 #define FDK_EXITCODE_NOINPUT                                                   \
    363   66 /*!< An input file (not a system file) did not exist or was not readable. \
    364       */
    365 #define FDK_EXITCODE_UNAVAILABLE                                              \
    366   69 /*!< A service is unavailable. This can occur if a support program or    \
    367         file does not exist. This can also be used as a catchall message when \
    368         something you wanted to do doesn't work, but you don't know why. */
    369 #define FDK_EXITCODE_SOFTWARE                                                  \
    370   70 /*!< An internal software error has been detected. This should be limited \
    371         to non- operating system related errors as possible. */
    372 #define FDK_EXITCODE_CANTCREATE \
    373   73 /*!< A (user specified) output file cannot be created. */
    374 #define FDK_EXITCODE_IOERROR \
    375   74 /*!< An error occurred while doing I/O on some file. */
    376 /*! @} */
    377 
    378 /*--------------------------------------------
    379  * Runtime support declarations
    380  *---------------------------------------------*/
    381 #ifdef __cplusplus
    382 extern "C" {
    383 #endif
    384 
    385 void FDKprintf(const char *szFmt, ...);
    386 
    387 void FDKprintfErr(const char *szFmt, ...);
    388 
    389 /** Wrapper for <stdio.h>'s getchar(). */
    390 int FDKgetchar(void);
    391 
    392 INT FDKfprintf(void *stream, const char *format, ...);
    393 INT FDKsprintf(char *str, const char *format, ...);
    394 
    395 char *FDKstrchr(char *s, INT c);
    396 const char *FDKstrstr(const char *haystack, const char *needle);
    397 char *FDKstrcpy(char *dest, const char *src);
    398 char *FDKstrncpy(char *dest, const char *src, const UINT n);
    399 
    400 #define FDK_MAX_OVERLAYS 8 /**< Maximum number of memory overlays. */
    401 
    402 void *FDKcalloc(const UINT n, const UINT size);
    403 void *FDKmalloc(const UINT size);
    404 void FDKfree(void *ptr);
    405 
    406 /**
    407  *  Allocate and clear an aligned memory area. Use FDKafree() instead of
    408  * FDKfree() for these memory areas.
    409  *
    410  * \param size       Size of requested memory in bytes.
    411  * \param alignment  Alignment of requested memory in bytes.
    412  * \return           Pointer to allocated memory.
    413  */
    414 void *FDKaalloc(const UINT size, const UINT alignment);
    415 
    416 /**
    417  *  Free an aligned memory area.
    418  *
    419  * \param ptr  Pointer to be freed.
    420  */
    421 void FDKafree(void *ptr);
    422 
    423 /**
    424  *  Allocate memory in a specific memory section.
    425  *  Requests can be made for internal or external memory. If internal memory is
    426  *  requested, FDKcalloc_L() first tries to use L1 memory, which sizes are
    427  * defined by ::DATA_L1_A_SIZE and ::DATA_L1_B_SIZE. If no L1 memory is
    428  * available, then FDKcalloc_L() tries to use L2 memory. If that fails as well,
    429  * the requested memory is allocated at an extern location using the fallback
    430  * FDKcalloc().
    431  *
    432  * \param n     See MSDN documentation on calloc().
    433  * \param size  See MSDN documentation on calloc().
    434  * \param s     Memory section.
    435  * \return      See MSDN documentation on calloc().
    436  */
    437 void *FDKcalloc_L(const UINT n, const UINT size, MEMORY_SECTION s);
    438 
    439 /**
    440  *  Allocate aligned memory in a specific memory section.
    441  *  See FDKcalloc_L() description for details - same applies here.
    442  */
    443 void *FDKaalloc_L(const UINT size, const UINT alignment, MEMORY_SECTION s);
    444 
    445 /**
    446  *  Free memory that was allocated in a specific memory section.
    447  */
    448 void FDKfree_L(void *ptr);
    449 
    450 /**
    451  *  Free aligned memory that was allocated in a specific memory section.
    452  */
    453 void FDKafree_L(void *ptr);
    454 
    455 /**
    456  * Copy memory. Source and destination memory must not overlap.
    457  * Either use implementation from a Standard Library, or, if no Standard Library
    458  * is available, a generic implementation.
    459  * The define ::USE_BUILTIN_MEM_FUNCTIONS in genericStds.cpp controls what to
    460  * use. The function arguments correspond to the standard memcpy(). Please see
    461  * MSDN documentation for details on how to use it.
    462  */
    463 void FDKmemcpy(void *dst, const void *src, const UINT size);
    464 
    465 /**
    466  * Copy memory. Source and destination memory are allowed to overlap.
    467  * Either use implementation from a Standard Library, or, if no Standard Library
    468  * is available, a generic implementation.
    469  * The define ::USE_BUILTIN_MEM_FUNCTIONS in genericStds.cpp controls what to
    470  * use. The function arguments correspond to the standard memmove(). Please see
    471  * MSDN documentation for details on how to use it.
    472  */
    473 void FDKmemmove(void *dst, const void *src, const UINT size);
    474 
    475 /**
    476  * Clear memory.
    477  * Either use implementation from a Standard Library, or, if no Standard Library
    478  * is available, a generic implementation.
    479  * The define ::USE_BUILTIN_MEM_FUNCTIONS in genericStds.cpp controls what to
    480  * use. The function arguments correspond to the standard memclear(). Please see
    481  * MSDN documentation for details on how to use it.
    482  */
    483 void FDKmemclear(void *memPtr, const UINT size);
    484 
    485 /**
    486  * Fill memory with values.
    487  * The function arguments correspond to the standard memset(). Please see MSDN
    488  * documentation for details on how to use it.
    489  */
    490 void FDKmemset(void *memPtr, const INT value, const UINT size);
    491 
    492 /* Compare function wrappers */
    493 INT FDKmemcmp(const void *s1, const void *s2, const UINT size);
    494 INT FDKstrcmp(const char *s1, const char *s2);
    495 INT FDKstrncmp(const char *s1, const char *s2, const UINT size);
    496 
    497 UINT FDKstrlen(const char *s);
    498 
    499 #define FDKmax(a, b) ((a) > (b) ? (a) : (b))
    500 #define FDKmin(a, b) ((a) < (b) ? (a) : (b))
    501 
    502 #define FDK_INT_MAX ((INT)0x7FFFFFFF)
    503 #define FDK_INT_MIN ((INT)0x80000000)
    504 
    505 /* FILE I/O */
    506 
    507 /*!
    508  *  Check platform for endianess.
    509  *
    510  * \return  1 if platform is little endian, non-1 if platform is big endian.
    511  */
    512 int IS_LITTLE_ENDIAN(void);
    513 
    514 /*!
    515  *  Convert input value to little endian format.
    516  *
    517  * \param val  Value to be converted. It may be in both big or little endian.
    518  * \return     Value in little endian format.
    519  */
    520 UINT TO_LITTLE_ENDIAN(UINT val);
    521 
    522 /*!
    523  * \fn     FDKFILE *FDKfopen(const char *filename, const char *mode);
    524  *         Standard fopen() wrapper.
    525  * \fn     INT FDKfclose(FDKFILE *FP);
    526  *         Standard fclose() wrapper.
    527  * \fn     INT FDKfseek(FDKFILE *FP, LONG OFFSET, int WHENCE);
    528  *         Standard fseek() wrapper.
    529  * \fn     INT FDKftell(FDKFILE *FP);
    530  *         Standard ftell() wrapper.
    531  * \fn     INT FDKfflush(FDKFILE *fp);
    532  *         Standard fflush() wrapper.
    533  * \fn     UINT FDKfwrite(const void *ptrf, INT size, UINT nmemb, FDKFILE *fp);
    534  *         Standard fwrite() wrapper.
    535  * \fn     UINT FDKfread(void *dst, INT size, UINT nmemb, FDKFILE *fp);
    536  *         Standard fread() wrapper.
    537  */
    538 typedef void FDKFILE;
    539 extern const INT FDKSEEK_SET, FDKSEEK_CUR, FDKSEEK_END;
    540 
    541 FDKFILE *FDKfopen(const char *filename, const char *mode);
    542 INT FDKfclose(FDKFILE *FP);
    543 INT FDKfseek(FDKFILE *FP, LONG OFFSET, int WHENCE);
    544 INT FDKftell(FDKFILE *FP);
    545 INT FDKfflush(FDKFILE *fp);
    546 UINT FDKfwrite(const void *ptrf, INT size, UINT nmemb, FDKFILE *fp);
    547 UINT FDKfread(void *dst, INT size, UINT nmemb, FDKFILE *fp);
    548 char *FDKfgets(void *dst, INT size, FDKFILE *fp);
    549 void FDKrewind(FDKFILE *fp);
    550 INT FDKfeof(FDKFILE *fp);
    551 
    552 /**
    553  * \brief        Write each member in little endian order. Convert automatically
    554  * to host endianess.
    555  * \param ptrf   Pointer to memory where to read data from.
    556  * \param size   Size of each item to be written.
    557  * \param nmemb  Number of items to be written.
    558  * \param fp     File pointer of type FDKFILE.
    559  * \return       Number of items read on success and fread() error on failure.
    560  */
    561 UINT FDKfwrite_EL(const void *ptrf, INT size, UINT nmemb, FDKFILE *fp);
    562 
    563 /**
    564  * \brief        Read variable of size "size" as little endian. Convert
    565  * automatically to host endianess. 4-byte alignment is enforced for 24 bit
    566  * data, at 32 bit full scale.
    567  * \param dst    Pointer to memory where to store data into.
    568  * \param size   Size of each item to be read.
    569  * \param nmemb  Number of items to be read.
    570  * \param fp     File pointer of type FDKFILE.
    571  * \return       Number of items read on success and fread() error on failure.
    572  */
    573 UINT FDKfread_EL(void *dst, INT size, UINT nmemb, FDKFILE *fp);
    574 
    575 /**
    576  * \brief  Print FDK software disclaimer.
    577  */
    578 void FDKprintDisclaimer(void);
    579 
    580 #ifdef __cplusplus
    581 }
    582 #endif
    583 
    584 #endif /* GENERICSTDS_H */
    585