Bulk update copyright dates
[flac.git] / include / FLAC / export.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000-2009  Josh Coalson
3  * Copyright (C) 2011-2016  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
33 #ifndef FLAC__EXPORT_H
34 #define FLAC__EXPORT_H
35
36 /** \file include/FLAC/export.h
37  *
38  *  \brief
39  *  This module contains #defines and symbols for exporting function
40  *  calls, and providing version information and compiled-in features.
41  *
42  *  See the \link flac_export export \endlink module.
43  */
44
45 /** \defgroup flac_export FLAC/export.h: export symbols
46  *  \ingroup flac
47  *
48  *  \brief
49  *  This module contains #defines and symbols for exporting function
50  *  calls, and providing version information and compiled-in features.
51  *
52  *  If you are compiling with MSVC and will link to the static library
53  *  (libFLAC.lib) you should define FLAC__NO_DLL in your project to
54  *  make sure the symbols are exported properly.
55  *
56  * \{
57  */
58
59 #if defined(FLAC__NO_DLL)
60 #define FLAC_API
61
62 #elif defined(_MSC_VER)
63 #ifdef FLAC_API_EXPORTS
64 #define FLAC_API __declspec(dllexport)
65 #else
66 #define FLAC_API __declspec(dllimport)
67 #endif
68
69 #elif defined(FLAC__USE_VISIBILITY_ATTR)
70 #define FLAC_API __attribute__ ((visibility ("default")))
71
72 #else
73 #define FLAC_API
74
75 #endif
76
77 /** These #defines will mirror the libtool-based library version number, see
78  * http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning
79  */
80 #define FLAC_API_VERSION_CURRENT 11
81 #define FLAC_API_VERSION_REVISION 0 /**< see above */
82 #define FLAC_API_VERSION_AGE 3 /**< see above */
83
84 #ifdef __cplusplus
85 extern "C" {
86 #endif
87
88 /** \c 1 if the library has been compiled with support for Ogg FLAC, else \c 0. */
89 extern FLAC_API int FLAC_API_SUPPORTS_OGG_FLAC;
90
91 #ifdef __cplusplus
92 }
93 #endif
94
95 /* \} */
96
97 #endif