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