blender/extern/audaspace/include/file/File.h
Jörg Müller 986267300b Audaspace: Moving audaspace 1.3 into extern.
Deleting the old internal audaspace.

Major changes from there are:
- The whole library was refactored to use C++11.
- Many stability and performance improvements.
- Major Python API refactor:
 - Most requested: Play self generated sounds using numpy arrays.
 - For games: Sound list, random sounds and dynamic music.
 - Writing sounds to files.
 - Sequencing API.
 - Opening sound devices, eg. Jack.
- Ability to choose different OpenAL devices in the user settings.
2017-08-18 08:24:12 +02:00

75 lines
1.8 KiB
C++

/*******************************************************************************
* Copyright 2009-2016 Jörg Müller
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
#pragma once
/**
* @file File.h
* @ingroup file
* The File class.
*/
#include "ISound.h"
#include <string>
#include <memory>
AUD_NAMESPACE_BEGIN
class Buffer;
/**
* The File sound tries to read a sound file via all available file inputs
* that have been registered in the FileManager class.
*/
class AUD_API File : public ISound
{
private:
/**
* The filename of the sound source file.
*/
std::string m_filename;
/**
* The buffer to read from.
*/
std::shared_ptr<Buffer> m_buffer;
// delete copy constructor and operator=
File(const File&) = delete;
File& operator=(const File&) = delete;
public:
/**
* Creates a new sound.
* The file is read from the file system using the given path.
* \param filename The sound file path.
*/
File(std::string filename);
/**
* Creates a new sound.
* The file is read from memory using the supplied buffer.
* \param buffer The buffer to read from.
* \param size The size of the buffer.
*/
File(const data_t* buffer, int size);
virtual std::shared_ptr<IReader> createReader();
};
AUD_NAMESPACE_END