ome-files  0.5.0
Codec.h
1 /*
2  * #%L
3  * OME-FILES C++ library for image IO.
4  * Copyright © 2006 - 2014 Open Microscopy Environment:
5  * - Massachusetts Institute of Technology
6  * - National Institutes of Health
7  * - University of Dundee
8  * - Board of Regents of the University of Wisconsin-Madison
9  * - Glencoe Software, Inc.
10  * %%
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright notice,
15  * this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  * The views and conclusions contained in the software and documentation are
33  * those of the authors and should not be interpreted as representing official
34  * policies, either expressed or implied, of any organization.
35  * #L%
36  */
37 
38 #ifndef OME_FILES_TIFF_CODEC_H
39 #define OME_FILES_TIFF_CODEC_H
40 
41 #include <string>
42 #include <vector>
43 
44 #include <ome/files/tiff/Types.h>
45 
46 #include <ome/xml/model/enums/PixelType.h>
47 
48 namespace ome
49 {
50  namespace files
51  {
52  namespace tiff
53  {
54 
55  // Functions to query TIFF codec support.
56 
58  struct Codec
59  {
61  std::string name;
64  };
65 
71  const std::vector<Codec>&
72  getCodecs();
73 
79  const std::vector<std::string>&
80  getCodecNames();
81 
89  const std::vector<std::string>&
91 
100  getCodecScheme(const std::string& name);
101  }
102  }
103 }
104 
105 #endif // OME_FILES_TIFF_CODEC_H
106 
107 /*
108  * Local Variables:
109  * mode:C++
110  * End:
111  */
const std::vector< std::string > & getCodecNames()
Get codec names registered with the TIFF library.
Definition: Codec.cpp:78
Compression
Compression technique.
Definition: Types.h:93
std::string name
Codec name.
Definition: Codec.h:61
Compression scheme
Codec number.
Definition: Codec.h:63
Open Microscopy Environment C++.
A TIFF codec.
Definition: Codec.h:58
const std::vector< Codec > & getCodecs()
Get codecs registered with the TIFF library.
Definition: Codec.cpp:55
Compression getCodecScheme(const std::string &name)
Get the compression scheme enumeration for a codec name.
Definition: Codec.cpp:184