unify include guard defines, __$FILENAME__
[blender-staging.git] / intern / audaspace / sndfile / AUD_SndFileWriter.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/sndfile/AUD_SndFileWriter.h
26  *  \ingroup audsndfile
27  */
28
29
30 #ifndef __AUD_SNDFILEWRITER_H__
31 #define __AUD_SNDFILEWRITER_H__
32
33 #include "AUD_IWriter.h"
34
35 #include <string>
36 #include <sndfile.h>
37
38 /**
39  * This class writes a sound file via libsndfile.
40  */
41 class AUD_SndFileWriter : public AUD_IWriter
42 {
43 private:
44         /**
45          * The current position in samples.
46          */
47         int m_position;
48
49         /**
50          * The specification of the audio data.
51          */
52         AUD_DeviceSpecs m_specs;
53
54         /**
55          * The sndfile.
56          */
57         SNDFILE* m_sndfile;
58
59         // hide copy constructor and operator=
60         AUD_SndFileWriter(const AUD_SndFileWriter&);
61         AUD_SndFileWriter& operator=(const AUD_SndFileWriter&);
62
63 public:
64         /**
65          * Creates a new writer.
66          * \param filename The path to the file to be read.
67          * \param specs The file's audio specification.
68          * \param format The file's container format.
69          * \param codec The codec used for encoding the audio data.
70          * \param bitrate The bitrate for encoding.
71          * \exception AUD_Exception Thrown if the file specified cannot be written
72          *                          with libsndfile.
73          */
74         AUD_SndFileWriter(std::string filename, AUD_DeviceSpecs specs, AUD_Container format, AUD_Codec codec, unsigned int bitrate);
75
76         /**
77          * Destroys the writer and closes the file.
78          */
79         virtual ~AUD_SndFileWriter();
80
81         virtual int getPosition() const;
82         virtual AUD_DeviceSpecs getSpecs() const;
83         virtual void write(unsigned int length, sample_t* buffer);
84 };
85
86 #endif //__AUD_SNDFILEWRITER_H__