c9ee2b1ee12046baae22523256f56be9b852b6e7
[blender.git] / intern / audaspace / intern / AUD_FileWriter.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/intern/AUD_FileWriter.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_FILEWRITER_H__
31 #define __AUD_FILEWRITER_H__
32
33 #include <string>
34
35 #include "AUD_Reference.h"
36
37 #include "AUD_IWriter.h"
38 #include "AUD_IReader.h"
39
40 /**
41  * This class is able to create IWriter classes as well as write reads to them.
42  */
43 class AUD_FileWriter
44 {
45 private:
46         // hide default constructor, copy constructor and operator=
47         AUD_FileWriter();
48         AUD_FileWriter(const AUD_FileWriter&);
49         AUD_FileWriter& operator=(const AUD_FileWriter&);
50
51 public:
52         /**
53          * Creates a new IWriter.
54          * \param filename The file to write to.
55          * \param specs The file's audio specification.
56          * \param format The file's container format.
57          * \param codec The codec used for encoding the audio data.
58          * \param bitrate The bitrate for encoding.
59          * \return The writer to write data to.
60          */
61         static AUD_Reference<AUD_IWriter> createWriter(std::string filename, AUD_DeviceSpecs specs, AUD_Container format, AUD_Codec codec, unsigned int bitrate);
62
63         /**
64          * Writes a reader to a writer.
65          * \param reader The reader to read from.
66          * \param writer The writer to write to.
67          * \param length How many samples should be transfered.
68          * \param buffersize How many samples should be transfered at once.
69          */
70         static void writeReader(AUD_Reference<AUD_IReader> reader, AUD_Reference<AUD_IWriter> writer, unsigned int length, unsigned int buffersize);
71 };
72
73 #endif //__AUD_FILEWRITER_H__