Changeset View
Changeset View
Standalone View
Standalone View
extern/audaspace/include/IReader.h
- This file was moved from intern/audaspace/intern/AUD_IReader.h.
| /* | /******************************************************************************* | ||||
| * ***** BEGIN GPL LICENSE BLOCK ***** | * Copyright 2009-2016 Jörg Müller | ||||
| * | * | ||||
| * Copyright 2009-2011 Jörg Hermann 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 | |||||
| * | * | ||||
| * This file is part of AudaSpace. | * http://www.apache.org/licenses/LICENSE-2.0 | ||||
| * | * | ||||
| * Audaspace is free software; you can redistribute it and/or modify | * Unless required by applicable law or agreed to in writing, software | ||||
| * it under the terms of the GNU General Public License as published by | * distributed under the License is distributed on an "AS IS" BASIS, | ||||
| * the Free Software Foundation; either version 2 of the License, or | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||
| * (at your option) any later version. | * See the License for the specific language governing permissions and | ||||
| * | * limitations under the License. | ||||
| * AudaSpace is distributed in the hope that it will be useful, | ******************************************************************************/ | ||||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | |||||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||||
| * GNU General Public License for more details. | |||||
| * | |||||
| * You should have received a copy of the GNU General Public License | |||||
| * along with Audaspace; if not, write to the Free Software Foundation, | |||||
| * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | |||||
| * | |||||
| * ***** END GPL LICENSE BLOCK ***** | |||||
| */ | |||||
| /** \file audaspace/intern/AUD_IReader.h | #pragma once | ||||
| * \ingroup audaspaceintern | |||||
| */ | |||||
| /** | |||||
| * @file IReader.h | |||||
| * @ingroup general | |||||
| * The IReader interface. | |||||
| */ | |||||
| #ifndef __AUD_IREADER_H__ | #include "respec/Specification.h" | ||||
| #define __AUD_IREADER_H__ | |||||
| #include "AUD_Space.h" | AUD_NAMESPACE_BEGIN | ||||
| /** | /** | ||||
| * @interface IReader | |||||
| * This class represents a sound source as stream or as buffer which can be read | * This class represents a sound source as stream or as buffer which can be read | ||||
| * for example by another reader, a device or whatever. | * for example by another reader, a device or whatever. | ||||
| */ | */ | ||||
| class AUD_IReader | class AUD_API IReader | ||||
| { | { | ||||
| public: | public: | ||||
| /** | /** | ||||
| * Destroys the reader. | * Destroys the reader. | ||||
| */ | */ | ||||
| virtual ~AUD_IReader() {} | virtual ~IReader() {} | ||||
| /** | /** | ||||
| * Tells whether the source provides seeking functionality or not. | * Tells whether the source provides seeking functionality or not. | ||||
| Context not available. | |||||
| /** | /** | ||||
| * Returns the specification of the reader. | * Returns the specification of the reader. | ||||
| * \return The AUD_Specs structure. | * \return The Specs structure. | ||||
| */ | */ | ||||
| virtual AUD_Specs getSpecs() const=0; | virtual Specs getSpecs() const=0; | ||||
| /** | /** | ||||
| * Request to read the next length samples out of the source. | * Request to read the next length samples out of the source. | ||||
| Context not available. | |||||
| virtual void read(int& length, bool& eos, sample_t* buffer)=0; | virtual void read(int& length, bool& eos, sample_t* buffer)=0; | ||||
| }; | }; | ||||
| #endif //__AUD_IREADER_H__ | AUD_NAMESPACE_END | ||||
| Context not available. | |||||