libSYS/include/cmdl_parser.h

   1
   2 /* -----------------------------------------------------------------------------------------------------------
   3 Software License for The Fraunhofer FDK AAC Codec Library for Android
   4
   5 © Copyright  1995 - 2013 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
   6   All rights reserved.
   7
   8  1.    INTRODUCTION
   9 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
  10 the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
  11 This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
  12
  13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
  14 audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
  15 independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
  16 of the MPEG specifications.
  17
  18 Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
  19 may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
  20 individually for the purpose of encoding or decoding bit streams in products that are compliant with
  21 the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
  22 these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
  23 software may already be covered under those patent licenses when it is used for those licensed purposes only.
  24
  25 Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
  26 are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
  27 applications information and documentation.
  28
  29 2.    COPYRIGHT LICENSE
  30
  31 Redistribution and use in source and binary forms, with or without modification, are permitted without
  32 payment of copyright license fees provided that you satisfy the following conditions:
  33
  34 You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
  35 your modifications thereto in source code form.
  36
  37 You must retain the complete text of this software license in the documentation and/or other materials
  38 provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
  39 You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
  40 modifications thereto to recipients of copies in binary form.
  41
  42 The name of Fraunhofer may not be used to endorse or promote products derived from this library without
  43 prior written permission.
  44
  45 You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
  46 software or your modifications thereto.
  47
  48 Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
  49 and the date of any change. For modified versions of the FDK AAC Codec, the term
  50 "Fraunhofer FDK AAC Codec Library for Android" must be replaced by the term
  51 "Third-Party Modified Version of the Fraunhofer FDK AAC Codec Library for Android."
  52
  53 3.    NO PATENT LICENSE
  54
  55 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
  56 ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
  57 respect to this software.
  58
  59 You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
  60 by appropriate patent licenses.
  61
  62 4.    DISCLAIMER
  63
  64 This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright holders and contributors
  65 "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, including but not limited to the implied warranties
  66 of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  67 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
  68 including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
  69 or business interruption, however caused and on any theory of liability, whether in contract, strict
  70 liability, or tort (including negligence), arising in any way out of the use of this software, even if
  71 advised of the possibility of such damage.
  72
  73 5.    CONTACT INFORMATION
  74
  75 Fraunhofer Institute for Integrated Circuits IIS
  76 Attention: Audio and Multimedia Departments - FDK AAC LL
  77 Am Wolfsmantel 33
  78 91058 Erlangen, Germany
  79
  80 www.iis.fraunhofer.de/amm
  81 amm-info@iis.fraunhofer.de
  82 ----------------------------------------------------------------------------------------------------------- */
  83
  84 /**************************  Fraunhofer IIS FDK SysLib  **********************
  85
  86    Author(s):
  87    Description: command line parser
  88
  89 ******************************************************************************/
  90
  91 /** \file   cmdl_parser.h
  92  *  \brief  Command line parser.
  93  *
  94  *  The command line parser can extract certain data fields out of a character
  95  *  string and assign values to variables. It has 2 main functions. One to parse
  96  *  a command line in the form of standard C runtime "argc" and "argv" parameters,
  97  *  and the other to assemble these parameters reading text lines from a file in
  98  *  case the C runtime does not provide them.
  99  */
 100
 101 #ifndef  __PARSER_H
 102 #define __PARSER_H
 103
 104
 105
 106 #include "machine_type.h"
 107
 108 #define CMDL_MAX_STRLEN 255
 109 #define CMDL_MAX_ARGC    30
 110
 111 /* \cond */
 112 /* Type definition for text */
 113
 114
 115 #ifdef WIN32
 116   #include <tchar.h>
 117   #ifndef _tstof  /* For Visual Studio 6 */
 118     #ifdef _UNICODE
 119       #include <wchar.h>
 120       #define _tstof(x)   (float) wcstod(x, NULL)  /* For Visual Studio 6 */
 121     #else
 122       #define _tstof      atof
 123     #endif
 124   #endif
 125
 126   #ifndef _tstol  /* For Visual Studio 6 */
 127     #ifdef _UNICODE
 128       #define _tstol      _wtol
 129     #else
 130       #define _tstol      atol
 131     #endif
 132   #endif
 133
 134   #ifndef _tstoi  /* For Visual Studio 6 */
 135     #ifdef _UNICODE
 136       #define _tstoi      _wtoi
 137     #else
 138       #define _tstoi      atoi
 139     #endif
 140   #endif
 141
 142   #ifndef TEXTCHAR
 143     #define TEXTCHAR char
 144   #endif
 145
 146   #ifndef _TEXT
 147     #define _TEXT
 148   #endif
 149
 150 #else /* WIN32 */
 151
 152     #define TEXTCHAR char
 153     #define _tcslen(a)  FDKstrlen(a)
 154     #define _tcscpy     strcpy
 155     #define _tcscmp     FDKstrcmp
 156     #define _tcsncmp    FDKstrncmp
 157     #define _tscanf     scanf
 158     #define _TEXT(x)    x
 159     #define _tfopen     fopen
 160     #define _ftprintf   fprintf
 161     #define _tcsncpy    FDKstrncpy
 162     #define _tstof      FDKatof
 163     #define _tstol      FDKatol
 164     #define _tstoi      FDKatoi
 165     #define _tcstol     strtol
 166     #define _istdigit   isdigit
 167 #endif /* WIN32 */
 168
 169 /* \endcond */
 170
 171 #ifdef __cplusplus
 172 extern "C"
 173 {
 174 #endif
 175
 176 /**
 177  *  Scans argc, argv and a scanf style format string for parameters and stores the
 178  *  values in the variable number of pointers passed to the function.
 179
 180  For example:
 181    \code
 182    #define ARG_PARAM  "(-a %d) (-v %1)"
 183    #define ARG_VALUE &config->aot, &verbose
 184    int nFoundArgs = IIS_ScanCmdl(argc, argv, ARG_PARAM, ARG_VALUE);
 185    \endcode
 186    wheras the wild-cards (\%d, \%1, ..) define the data type of the argument:
 187         - \%1 boolean (e. g. -x)
 188         - \%d integer (e. g. -x 23)
 189         - \%f float (e. g. -x 3.4)
 190         - \%y double (e. g. -x 31415926535897932384626433832795028841971693993751)
 191         - \%s string (e. g. -x "file.dat")
 192         - \%u unsigned character (e. g. -x 3)
 193         - \%c signed character (e. g. -x -3)
 194     More examples on how to use it are located in every (encoder/decoder) example framework.
 195
 196  * \param argc      Number of arguments.
 197  * \param argv      Complete character string of the command line arguments.
 198  * \param pReqArgs  A list of parameters and a corresponding list of memory addresses to
 199  *                  assign each parameter to.
 200  *
 201  * \return  Number of found arguments.
 202  */
 203 INT IIS_ScanCmdl(INT argc, TEXTCHAR* argv[], const TEXTCHAR* pReqArgs, ...);
 204
 205 #ifdef __cplusplus
 206 }
 207 #endif
 208
 209 /**
 210  *  Reads a text file, assembles argc and argv parameters for each text line
 211  *  and calls the given function for each set of argc, argv parameters.
 212  *
 213  * \param param_filename  Name of text file that should be parsed.
 214  * \param pFunction       Pointer to function that should be called for every text line found.
 215  *
 216  * \return  0 on success, 1 on failure.
 217  */
 218 INT IIS_ProcessCmdlList(const TEXTCHAR* param_filename, int (*pFunction)(int, TEXTCHAR**));
 219
 220
 221 #endif /* __PARSER_H */