af95e3a3b813d2aca31160345bae845805fd5fdc
[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 /** \file audaspace/ffmpeg/AUD_FFMPEGFactory.h
28  *  \ingroup audffmpeg
29  */
30
31
32 #ifndef AUD_FFMPEGFACTORY
33 #define AUD_FFMPEGFACTORY
34
35 #include "AUD_IFactory.h"
36 #include "AUD_Reference.h"
37 class AUD_Buffer;
38
39 #include <string>
40
41 /**
42  * This factory reads a sound file via ffmpeg.
43  * \warning Notice that the needed formats and codecs have to be registered
44  * for ffmpeg before this class can be used.
45  */
46 class AUD_FFMPEGFactory : public AUD_IFactory
47 {
48 private:
49         /**
50          * The filename of the sound source file.
51          */
52         const std::string m_filename;
53
54         /**
55          * The buffer to read from.
56          */
57         AUD_Reference<AUD_Buffer> m_buffer;
58
59         // hide copy constructor and operator=
60         AUD_FFMPEGFactory(const AUD_FFMPEGFactory&);
61         AUD_FFMPEGFactory& operator=(const AUD_FFMPEGFactory&);
62
63 public:
64         /**
65          * Creates a new factory.
66          * \param filename The sound file path.
67          */
68         AUD_FFMPEGFactory(std::string filename);
69
70         /**
71          * Creates a new factory.
72          * \param buffer The buffer to read from.
73          * \param size The size of the buffer.
74          */
75         AUD_FFMPEGFactory(const data_t* buffer, int size);
76
77         virtual AUD_Reference<AUD_IReader> createReader();
78 };
79
80 #endif //AUD_FFMPEGFACTORY