Audaspace: HUGE Refactor.
[blender.git] / intern / audaspace / ffmpeg / AUD_FFMPEGFactory.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN LGPL LICENSE BLOCK *****
5  *
6  * Copyright 2009 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 Lesser General Public License as published by
12  * the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with AudaSpace.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * ***** END LGPL LICENSE BLOCK *****
24  */
25
26 #ifndef AUD_FFMPEGFACTORY
27 #define AUD_FFMPEGFACTORY
28
29 #include "AUD_IFactory.h"
30 #include "AUD_Reference.h"
31 class AUD_Buffer;
32
33 #include <string>
34
35 /**
36  * This factory reads a sound file via ffmpeg.
37  * \warning Notice that the needed formats and codecs have to be registered
38  * for ffmpeg before this class can be used.
39  */
40 class AUD_FFMPEGFactory : public AUD_IFactory
41 {
42 private:
43         /**
44          * The filename of the sound source file.
45          */
46         const std::string m_filename;
47
48         /**
49          * The buffer to read from.
50          */
51         AUD_Reference<AUD_Buffer> m_buffer;
52
53         // hide copy constructor and operator=
54         AUD_FFMPEGFactory(const AUD_FFMPEGFactory&);
55         AUD_FFMPEGFactory& operator=(const AUD_FFMPEGFactory&);
56
57 public:
58         /**
59          * Creates a new factory.
60          * \param filename The sound file path.
61          */
62         AUD_FFMPEGFactory(std::string filename);
63
64         /**
65          * Creates a new factory.
66          * \param buffer The buffer to read from.
67          * \param size The size of the buffer.
68          */
69         AUD_FFMPEGFactory(const data_t* buffer, int size);
70
71         virtual AUD_IReader* createReader() const;
72 };
73
74 #endif //AUD_FFMPEGFACTORY