* merge r22734 from trunk
[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 /**
34  * This factory reads a sound file via ffmpeg.
35  * \warning Notice that the needed formats and codecs have to be registered
36  * for ffmpeg before this class can be used.
37  */
38 class AUD_FFMPEGFactory : public AUD_IFactory
39 {
40 private:
41         /**
42          * The filename of the sound source file.
43          */
44         char* m_filename;
45
46         /**
47          * The buffer to read from.
48          */
49         AUD_Reference<AUD_Buffer> m_buffer;
50
51 public:
52         /**
53          * Creates a new factory.
54          * \param filename The sound file path.
55          */
56         AUD_FFMPEGFactory(const char* filename);
57
58         /**
59          * Creates a new factory.
60          * \param buffer The buffer to read from.
61          * \param size The size of the buffer.
62          */
63         AUD_FFMPEGFactory(unsigned char* buffer, int size);
64
65         /**
66          * Destroys the factory.
67          */
68         ~AUD_FFMPEGFactory();
69
70         virtual AUD_IReader* createReader();
71 };
72
73 #endif //AUD_FFMPEGFACTORY