export.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. /* libFLAC - Free Lossless Audio Codec library
  2. * Copyright (C) 2000-2009 Josh Coalson
  3. * Copyright (C) 2011-2022 Xiph.Org Foundation
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions
  7. * are met:
  8. *
  9. * - Redistributions of source code must retain the above copyright
  10. * notice, this list of conditions and the following disclaimer.
  11. *
  12. * - Redistributions in binary form must reproduce the above copyright
  13. * notice, this list of conditions and the following disclaimer in the
  14. * documentation and/or other materials provided with the distribution.
  15. *
  16. * - Neither the name of the Xiph.org Foundation nor the names of its
  17. * contributors may be used to endorse or promote products derived from
  18. * this software without specific prior written permission.
  19. *
  20. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21. * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
  24. * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25. * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26. * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27. * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29. * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31. */
  32. #ifndef FLAC__EXPORT_H
  33. #define FLAC__EXPORT_H
  34. /** \file include/FLAC/export.h
  35. *
  36. * \brief
  37. * This module contains \#defines and symbols for exporting function
  38. * calls, and providing version information and compiled-in features.
  39. *
  40. * See the \link flac_export export \endlink module.
  41. */
  42. /** \defgroup flac_export FLAC/export.h: export symbols
  43. * \ingroup flac
  44. *
  45. * \brief
  46. * This module contains \#defines and symbols for exporting function
  47. * calls, and providing version information and compiled-in features.
  48. *
  49. * If you are compiling for Windows (with Visual Studio or MinGW for
  50. * example) and will link to the static library (libFLAC++.lib) you
  51. * should define FLAC__NO_DLL in your project to make sure the symbols
  52. * are exported properly.
  53. *
  54. * \{
  55. */
  56. /** This \#define is used internally in libFLAC and its headers to make
  57. * sure the correct symbols are exported when working with shared
  58. * libraries. On Windows, this \#define is set to __declspec(dllexport)
  59. * when compiling libFLAC into a library and to __declspec(dllimport)
  60. * when the headers are used to link to that DLL. On non-Windows systems
  61. * it is used to set symbol visibility.
  62. *
  63. * Because of this, the define FLAC__NO_DLL must be defined when linking
  64. * to libFLAC statically or linking will fail.
  65. */
  66. /* This has grown quite complicated. FLAC__NO_DLL is used by MSVC sln
  67. * files and CMake, which build either static or shared. autotools can
  68. * build static, shared or **both**. Therefore, DLL_EXPORT, which is set
  69. * by libtool, must override FLAC__NO_DLL on building shared components
  70. */
  71. #if defined(_WIN32)
  72. #if defined(FLAC__NO_DLL) && !(defined(DLL_EXPORT))
  73. #define FLAC_API
  74. #else
  75. #ifdef FLAC_API_EXPORTS
  76. #define FLAC_API __declspec(dllexport)
  77. #else
  78. #define FLAC_API __declspec(dllimport)
  79. #endif
  80. #endif
  81. #elif defined(FLAC__USE_VISIBILITY_ATTR)
  82. #define FLAC_API __attribute__ ((visibility ("default")))
  83. #else
  84. #define FLAC_API
  85. #endif
  86. /** These \#defines will mirror the libtool-based library version number, see
  87. * http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning
  88. */
  89. #define FLAC_API_VERSION_CURRENT 12
  90. #define FLAC_API_VERSION_REVISION 0 /**< see above */
  91. #define FLAC_API_VERSION_AGE 0 /**< see above */
  92. #ifdef __cplusplus
  93. extern "C" {
  94. #endif
  95. /** \c 1 if the library has been compiled with support for Ogg FLAC, else \c 0. */
  96. extern FLAC_API int FLAC_API_SUPPORTS_OGG_FLAC;
  97. #ifdef __cplusplus
  98. }
  99. #endif
  100. /* \} */
  101. #endif