mirror of https://github.com/mosra/magnum.git
Vladimír Vondruš
13 years ago
9 changed files with 378 additions and 1 deletions
@ -0,0 +1,97 @@
|
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a |
||||
copy of this software and associated documentation files (the "Software"), |
||||
to deal in the Software without restriction, including without limitation |
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the |
||||
Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included |
||||
in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
*/ |
||||
|
||||
#include "AbstractImporter.h" |
||||
|
||||
#include <fstream> |
||||
#include <Containers/Array.h> |
||||
#include <Utility/Assert.h> |
||||
|
||||
namespace Magnum { namespace Audio { |
||||
|
||||
AbstractImporter::AbstractImporter() = default; |
||||
|
||||
AbstractImporter::AbstractImporter(PluginManager::AbstractManager* manager, std::string plugin): PluginManager::AbstractPlugin(manager, std::move(plugin)) {} |
||||
|
||||
bool AbstractImporter::openData(Containers::ArrayReference<const unsigned char> data) { |
||||
CORRADE_ASSERT(features() & Feature::OpenData, |
||||
"Audio::AbstractImporter::openData(): feature not supported", nullptr); |
||||
|
||||
close(); |
||||
doOpenData(data); |
||||
return isOpened(); |
||||
} |
||||
|
||||
void AbstractImporter::doOpenData(Containers::ArrayReference<const unsigned char>) { |
||||
CORRADE_ASSERT(false, "Audio::AbstractImporter::openData(): feature advertised but not implemented", ); |
||||
} |
||||
|
||||
bool AbstractImporter::openFile(const std::string& filename) { |
||||
close(); |
||||
doOpenFile(filename); |
||||
return isOpened(); |
||||
} |
||||
|
||||
void AbstractImporter::doOpenFile(const std::string& filename) { |
||||
CORRADE_ASSERT(features() & Feature::OpenData, "Audio::AbstractImporter::openFile(): not implemented", ); |
||||
|
||||
/* Open file */ |
||||
std::ifstream in(filename.data(), std::ios::binary); |
||||
if(!in.good()) { |
||||
Error() << "Trade::AbstractImporter::openFile(): cannot open file" << filename; |
||||
return; |
||||
} |
||||
|
||||
/* Create array to hold file contents */ |
||||
in.seekg(0, std::ios::end); |
||||
Containers::Array<unsigned char> data(in.tellg()); |
||||
|
||||
/* Read data, close */ |
||||
in.seekg(0, std::ios::beg); |
||||
in.read(reinterpret_cast<char*>(data.begin()), data.size()); |
||||
in.close(); |
||||
|
||||
doOpenData(data); |
||||
} |
||||
|
||||
void AbstractImporter::close() { |
||||
if(isOpened()) doClose(); |
||||
} |
||||
|
||||
Buffer::Format AbstractImporter::format() const { |
||||
CORRADE_ASSERT(isOpened(), "Audio::AbstractImporter::format(): no file opened", {}); |
||||
return doFormat(); |
||||
} |
||||
|
||||
UnsignedInt AbstractImporter::frequency() const { |
||||
CORRADE_ASSERT(isOpened(), "Audio::AbstractImporter::frequency(): no file opened", {}); |
||||
return doFrequency(); |
||||
} |
||||
|
||||
Containers::Array<unsigned char> AbstractImporter::data() { |
||||
CORRADE_ASSERT(isOpened(), "Audio::AbstractImporter::data(): no file opened", {}); |
||||
return doData(); |
||||
} |
||||
|
||||
}} |
||||
@ -0,0 +1,163 @@
|
||||
#ifndef Magnum_Audio_AbstractImporter_h |
||||
#define Magnum_Audio_AbstractImporter_h |
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a |
||||
copy of this software and associated documentation files (the "Software"), |
||||
to deal in the Software without restriction, including without limitation |
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the |
||||
Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included |
||||
in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
*/ |
||||
|
||||
/** @file Audio/AbstractImporter.h
|
||||
* @brief Class Magnum::Audio::AbstractImporter |
||||
*/ |
||||
|
||||
#include <PluginManager/AbstractPlugin.h> |
||||
|
||||
#include "Magnum.h" |
||||
#include "Audio/Buffer.h" |
||||
|
||||
namespace Magnum { namespace Audio { |
||||
|
||||
/**
|
||||
@brief Base for audio importer plugins |
||||
|
||||
@section Audio-AbstractImporter-subclassing Subclassing |
||||
|
||||
Plugin implements function doFeatures(), doIsOpened(), one of or both |
||||
doOpenData() and doOpenFile() functions, function doClose() and data access |
||||
functions doFormat(), doFrequency() and doData(). |
||||
|
||||
You don't need to do most of the redundant sanity checks, these things are |
||||
checked by the implementation: |
||||
|
||||
- Functions doOpenData() and doOpenFile() are called after the previous file |
||||
was closed, function doClose() is called only if there is any file opened. |
||||
- Function doOpenData() is called only if @ref Feature "Feature::OpenData" |
||||
is supported. |
||||
- All `do*()` implementations working on opened file are called only if |
||||
there is any file opened. |
||||
*/ |
||||
class MAGNUM_AUDIO_EXPORT AbstractImporter: public PluginManager::AbstractPlugin { |
||||
CORRADE_PLUGIN_INTERFACE("cz.mosra.magnum.Audio.AbstractImporter/0.1") |
||||
|
||||
public: |
||||
/**
|
||||
* @brief Features supported by this importer |
||||
* |
||||
* @see Features, features() |
||||
*/ |
||||
enum class Feature: UnsignedByte { |
||||
/** Opening files from raw data using openData() */ |
||||
OpenData = 1 << 0 |
||||
}; |
||||
|
||||
/**
|
||||
* @brief Features supported by this importer |
||||
* |
||||
* @see features() |
||||
*/ |
||||
typedef Containers::EnumSet<Feature, UnsignedByte> Features; |
||||
|
||||
/** @brief Default constructor */ |
||||
explicit AbstractImporter(); |
||||
|
||||
/** @brief Plugin manager constructor */ |
||||
explicit AbstractImporter(PluginManager::AbstractManager* manager, std::string plugin); |
||||
|
||||
/** @brief Features supported by this importer */ |
||||
Features features() const { return doFeatures(); } |
||||
|
||||
/** @brief Whether any file is opened */ |
||||
bool isOpened() const { return doIsOpened(); } |
||||
|
||||
/**
|
||||
* @brief Open raw data |
||||
* |
||||
* Closes previous file, if it was opened, and tries to open given |
||||
* file. Available only if @ref Feature "Feature::OpenData" is |
||||
* supported. Returns `true` on success, `false` otherwise. |
||||
* @see features(), openFile() |
||||
*/ |
||||
bool openData(Containers::ArrayReference<const unsigned char> data); |
||||
|
||||
/**
|
||||
* @brief Open file |
||||
* |
||||
* Closes previous file, if it was opened, and tries to open given |
||||
* file. Returns `true` on success, `false` otherwise. |
||||
* @see features(), openData() |
||||
*/ |
||||
bool openFile(const std::string& filename); |
||||
|
||||
/** @brief Close file */ |
||||
void close(); |
||||
|
||||
/** @{ @name Data access */ |
||||
|
||||
/** @brief Sample format */ |
||||
Buffer::Format format() const; |
||||
|
||||
/** @brief Sample frequency */ |
||||
UnsignedInt frequency() const; |
||||
|
||||
/** @brief Sample data */ |
||||
Containers::Array<unsigned char> data(); |
||||
|
||||
/*@}*/ |
||||
|
||||
#ifndef DOXYGEN_GENERATING_OUTPUT |
||||
private: |
||||
#else |
||||
protected: |
||||
#endif |
||||
/** @brief Implementation for features() */ |
||||
virtual Features doFeatures() const = 0; |
||||
|
||||
/** @brief Implementation for isOpened() */ |
||||
virtual bool doIsOpened() const = 0; |
||||
|
||||
/** @brief Implementation for openData() */ |
||||
virtual void doOpenData(Containers::ArrayReference<const unsigned char> data); |
||||
|
||||
/**
|
||||
* @brief Implementation for openFile() |
||||
* |
||||
* If @ref Feature "Feature::OpenData" is supported, default |
||||
* implementation opens the file and calls doOpenData() with its |
||||
* contents. |
||||
*/ |
||||
virtual void doOpenFile(const std::string& filename); |
||||
|
||||
/** @brief Implementation for close() */ |
||||
virtual void doClose() = 0; |
||||
|
||||
/** @brief Implementation for format() */ |
||||
virtual Buffer::Format doFormat() const = 0; |
||||
|
||||
/** @brief Implementation for frequency() */ |
||||
virtual UnsignedInt doFrequency() const = 0; |
||||
|
||||
/** @brief Implementation for data() */ |
||||
virtual Containers::Array<unsigned char> doData() = 0; |
||||
}; |
||||
|
||||
}} |
||||
|
||||
#endif |
||||
@ -0,0 +1,76 @@
|
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a |
||||
copy of this software and associated documentation files (the "Software"), |
||||
to deal in the Software without restriction, including without limitation |
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the |
||||
Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included |
||||
in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
*/ |
||||
|
||||
#include <Containers/Array.h> |
||||
#include <TestSuite/Tester.h> |
||||
#include <Utility/Directory.h> |
||||
|
||||
#include "Audio/AbstractImporter.h" |
||||
|
||||
#include "testConfigure.h" |
||||
|
||||
namespace Magnum { namespace Audio { namespace Test { |
||||
|
||||
class AbstractImporterTest: public TestSuite::Tester { |
||||
public: |
||||
explicit AbstractImporterTest(); |
||||
|
||||
void openFile(); |
||||
}; |
||||
|
||||
AbstractImporterTest::AbstractImporterTest() { |
||||
addTests({&AbstractImporterTest::openFile}); |
||||
} |
||||
|
||||
void AbstractImporterTest::openFile() { |
||||
class DataImporter: public Audio::AbstractImporter { |
||||
public: |
||||
explicit DataImporter(): opened(false) {} |
||||
|
||||
private: |
||||
Features doFeatures() const override { return Feature::OpenData; } |
||||
bool doIsOpened() const override { return opened; } |
||||
void doClose() override {} |
||||
|
||||
void doOpenData(Containers::ArrayReference<const unsigned char> data) override { |
||||
opened = (data.size() == 1 && data[0] == 0xa5); |
||||
} |
||||
|
||||
Buffer::Format doFormat() const override { return {}; } |
||||
UnsignedInt doFrequency() const override { return {}; } |
||||
Corrade::Containers::Array<unsigned char> doData() override { return nullptr; } |
||||
|
||||
bool opened; |
||||
}; |
||||
|
||||
/* doOpenFile() should call doOpenData() */ |
||||
DataImporter importer; |
||||
CORRADE_VERIFY(!importer.isOpened()); |
||||
importer.openFile(Utility::Directory::join(AUDIO_TEST_DIR, "file.bin")); |
||||
CORRADE_VERIFY(importer.isOpened()); |
||||
} |
||||
|
||||
}}} |
||||
|
||||
CORRADE_TEST_MAIN(Magnum::Audio::Test::AbstractImporterTest) |
||||
@ -0,0 +1,25 @@
|
||||
/* |
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš <mosra@centrum.cz> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a |
||||
copy of this software and associated documentation files (the "Software"), |
||||
to deal in the Software without restriction, including without limitation |
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the |
||||
Software is furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included |
||||
in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
*/ |
||||
|
||||
#define AUDIO_TEST_DIR "${CMAKE_CURRENT_SOURCE_DIR}" |
||||
Loading…
Reference in new issue