Relicensing audaspace under GPL 2 or later.
[blender.git] / intern / audaspace / ffmpeg / AUD_FFMPEGFactory.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * Audaspace is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #ifndef AUD_FFMPEGFACTORY
28 #define AUD_FFMPEGFACTORY
29
30 #include "AUD_IFactory.h"
31 #include "AUD_Reference.h"
32 class AUD_Buffer;
33
34 #include <string>
35
36 /**
37  * This factory reads a sound file via ffmpeg.
38  * \warning Notice that the needed formats and codecs have to be registered
39  * for ffmpeg before this class can be used.
40  */
41 class AUD_FFMPEGFactory : public AUD_IFactory
42 {
43 private:
44         /**
45          * The filename of the sound source file.
46          */
47         const std::string m_filename;
48
49         /**
50          * The buffer to read from.
51          */
52         AUD_Reference<AUD_Buffer> m_buffer;
53
54         // hide copy constructor and operator=
55         AUD_FFMPEGFactory(const AUD_FFMPEGFactory&);
56         AUD_FFMPEGFactory& operator=(const AUD_FFMPEGFactory&);
57
58 public:
59         /**
60          * Creates a new factory.
61          * \param filename The sound file path.
62          */
63         AUD_FFMPEGFactory(std::string filename);
64
65         /**
66          * Creates a new factory.
67          * \param buffer The buffer to read from.
68          * \param size The size of the buffer.
69          */
70         AUD_FFMPEGFactory(const data_t* buffer, int size);
71
72         virtual AUD_IReader* createReader() const;
73 };
74
75 #endif //AUD_FFMPEGFACTORY