audiere.h

Go to the documentation of this file.
00001 /*
00002  * audiere.h
00003  *
00004  * Copyright (C) 2009  Thomas A. Vaughan
00005  * All rights reserved.
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  *
00031  * This "library" (my own audiere library) is just a thin shell on top of the
00032  * actual audiere library.  This is here only to make it easy for other
00033  * programs that use audiere to find headers, link correctly, etc.
00034  */
00035 
00036 #ifndef WAVE_AUDIO_AUDIERE_H__
00037 #define WAVE_AUDIO_AUDIERE_H__
00038 
00039 
00040 // includes --------------------------------------------------------------------
00041 #include "common/common.h"
00042 
00043 #include "src/audiere.h"                // the real audiere header
00044 
00045 
00046 namespace wave_audio {
00047 
00048 
00049 ////////////////////////////////////////////////////////////////////////////////
00050 ///
00051 /// \ingroup wave_audio
00052 /// \defgroup audiere Wavepacket Audiere Library Wrapper
00053 ///
00054 /// This library provides convenient access to the audiere APIs.
00055 ///
00056 /// \n
00057 /// Mostly this library
00058 /// is here only as a convenient placeholder.  Code with
00059 /// audiere dependencies can refer to this module in the build, and then the
00060 /// right directories will be searched for include files, the right libraries
00061 /// linked, etc.
00062 ///
00063 /// This library does provide a few helper objects and methods to make using
00064 /// audiere easier, and to abstract away common setup code.
00065 ///
00066 ////////////////////////////////////////////////////////////////////////////////
00067 /*@{*/
00068 
00069 
00070 
00071 };      // wave_audio namespace
00072 
00073 
00074 #endif  //WAVE_AUDIO_AUDIERE_H__
00075