OGRE  1.9.0
OgreFreeImageCodec.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4(Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2014 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef _FreeImageCodec_H__
29#define _FreeImageCodec_H__
30
31#include "OgreImageCodec.h"
32// Forward-declaration to avoid external dependency on FreeImage
33struct FIBITMAP;
34
35namespace Ogre {
36
49 {
50 private:
52 unsigned int mFreeImageType;
53
56
58 FIBITMAP* encodeBitmap(MemoryDataStreamPtr& input, CodecDataPtr& pData) const;
59
60 public:
61 FreeImageCodec(const String &type, unsigned int fiType);
62 virtual ~FreeImageCodec() { }
63
67 void encodeToFile(MemoryDataStreamPtr& input, const String& outFileName, CodecDataPtr& pData) const;
70
71
72 virtual String getType() const;
73
75 String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const;
76
78 static void startup(void);
80 static void shutdown(void);
81 };
82
84
85} // namespace
86
87#endif
#define _OgreExport
SharedPtr< CodecData > CodecDataPtr
Definition OgreCodec.h:74
std::pair< MemoryDataStreamPtr, CodecDataPtr > DecodeResult
Result of a decoding; both a decoded data stream and CodecData metadata.
Definition OgreCodec.h:141
list< ImageCodec * >::type RegisteredCodecList
virtual String getType() const
Returns the type of the codec as a String.
void encodeToFile(MemoryDataStreamPtr &input, const String &outFileName, CodecDataPtr &pData) const
Codes the data in the input chunk and saves the result in the output filename provided.
FIBITMAP * encodeBitmap(MemoryDataStreamPtr &input, CodecDataPtr &pData) const
Common encoding routine.
DataStreamPtr encode(MemoryDataStreamPtr &input, CodecDataPtr &pData) const
Codes the data in the input stream and saves the result in the output stream.
String magicNumberToFileExt(const char *magicNumberPtr, size_t maxbytes) const
Maps a magic number header to a file extension, if this codec recognises it.
DecodeResult decode(DataStreamPtr &input) const
Codes the data from the input chunk into the output chunk.
FreeImageCodec(const String &type, unsigned int fiType)
static RegisteredCodecList msCodecList
static void shutdown(void)
Static method to shutdown FreeImage and unregister the FreeImage codecs.
static void startup(void)
Static method to startup FreeImage and register the FreeImage codecs.
Codec specialized in images.
SharedPtr< DataStream > DataStreamPtr
Shared pointer to allow data streams to be passed around without worrying about deallocation.
SharedPtr< MemoryDataStream > MemoryDataStreamPtr
Shared pointer to allow memory data streams to be passed around without worrying about deallocation.
_StringBase String
std::list< T, A > type