AudioWavFile.H

Go to the documentation of this file.
00001 /*!@file Audio/AudioWavFile.H File I/O on audio .wav files */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
00005 // by the University of Southern California (USC) and the iLab at USC.  //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file:
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Audio/AudioWavFile.H $
00035 // $Id: AudioWavFile.H 8605 2007-07-21 02:10:31Z itti $
00036 //
00037 
00038 #ifndef AUDIO_AUDIOWAVFILE_H_DEFINED
00039 #define AUDIO_AUDIOWAVFILE_H_DEFINED
00040 
00041 #include "Audio/AudioBuffer.H"
00042 #include <string>
00043 #include <vector>
00044 
00045 //! Write an audio .wav file
00046 /*! Write a data buffer to file as a basic uncompressed .wav file.
00047   @param fname name of the .wav file to be written.
00048   @param buf buffer containing the audio samples. */
00049 template <class T>
00050 void writeAudioWavFile(const std::string& fname,
00051                        const AudioBuffer<T>& buf);
00052 
00053 //! Write an audio .wav file
00054 /*! Write a series of data buffers to a single file as a basic
00055   uncompressed .wav file.
00056   @param fname name of the .wav file to be written.
00057   @param buf buffers containing the audio samples. */
00058 template <class T>
00059 void writeAudioWavFile(const std::string& fname,
00060                        const std::vector<AudioBuffer<T> >& buf);
00061 
00062 //! Read an audio .wav file
00063 /*! Read a data buffer from file as a basic uncompressed .wav
00064   file. Caveat: one needs to know the number of bits/sample beforehand
00065   so that one will call the correct template function... */
00066 template <class T>
00067 void readAudioWavFile(const std::string& fname, AudioBuffer<T>& buf);
00068 
00069 
00070 // ######################################################################
00071 /* So things look consistent in everyone's emacs... */
00072 /* Local Variables: */
00073 /* mode: c++ */
00074 /* indent-tabs-mode: nil */
00075 /* End: */
00076 
00077 #endif // DEVICES_AUDIOWAVFILE_H_DEFINED
Generated on Sun May 8 08:40:11 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3