03943ea8ae053c9197954cd9d4c29b8d2a09c59f
[blender.git] / extern / audaspace / include / file / FileManager.h
1 /*******************************************************************************
2  * Copyright 2009-2016 Jörg Müller
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  ******************************************************************************/
16
17 #pragma once
18
19 /**
20  * @file FileManager.h
21  * @ingroup file
22  * The FileManager class.
23  */
24
25 #include "respec/Specification.h"
26 #include "IWriter.h"
27
28 #include <list>
29 #include <memory>
30
31 AUD_NAMESPACE_BEGIN
32
33 class IFileInput;
34 class IFileOutput;
35 class IReader;
36 class Buffer;
37
38 /**
39  * The FileManager manages all file input and output plugins.
40  */
41 class AUD_API FileManager
42 {
43 private:
44         static std::list<std::shared_ptr<IFileInput>>& inputs();
45         static std::list<std::shared_ptr<IFileOutput>>& outputs();
46
47         // delete copy constructor and operator=
48         FileManager(const FileManager&) = delete;
49         FileManager& operator=(const FileManager&) = delete;
50         FileManager() = delete;
51
52 public:
53         /**
54          * Registers a file input used to create an IReader to read from a file.
55          * @param input The IFileInput to register.
56          */
57         static void registerInput(std::shared_ptr<IFileInput> input);
58
59         /**
60          * Registers a file output used to create an IWriter to write to a file.
61          * @param output The IFileOutput to register.
62          */
63         static void registerOutput(std::shared_ptr<IFileOutput> output);
64
65         /**
66          * Creates a file reader for the given filename if a registed IFileInput is able to read it.
67          * @param filename The path to the file.
68          * @return The reader created.
69          * @exception Exception If no file input can read the file an exception is thrown.
70          */
71         static std::shared_ptr<IReader> createReader(std::string filename);
72
73         /**
74          * Creates a file reader for the given buffer if a registed IFileInput is able to read it.
75          * @param buffer The buffer to read the file from.
76          * @return The reader created.
77          * @exception Exception If no file input can read the file an exception is thrown.
78          */
79         static std::shared_ptr<IReader> createReader(std::shared_ptr<Buffer> buffer);
80
81         /**
82          * Creates a file writer that writes a sound to the given file path.
83          * Existing files will be overwritten.
84          * @param filename The file path to write to.
85          * @param specs The output specification.
86          * @param format The container format for the file.
87          * @param codec The codec used inside the container.
88          * @param bitrate The bitrate to write with.
89          * @return A writer that creates the file.
90          * @exception Exception If no file output can write the file with the given specification an exception is thrown.
91          */
92         static std::shared_ptr<IWriter> createWriter(std::string filename, DeviceSpecs specs, Container format, Codec codec, unsigned int bitrate);
93 };
94
95 AUD_NAMESPACE_END