MagickCore  6.9.10
Convert, Edit, Or Compose Bitmap Images
quantum.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2019 ImageMagick Studio LLC, a non-profit organization
3  dedicated to making software imaging solutions freely available.
4 
5  You may not use this file except in compliance with the License.
6  obtain a copy of the License at
7 
8  https://imagemagick.org/script/license.php
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 
16  MagickCore quantum inline methods.
17 */
18 #ifndef MAGICKCORE_QUANTUM_H
19 #define MAGICKCORE_QUANTUM_H
20 
21 #include "magick/image.h"
22 #include "magick/semaphore.h"
23 
24 #if defined(__cplusplus) || defined(c_plusplus)
25 extern "C" {
26 #endif
27 
28 #define RoundToQuantum(quantum) ClampToQuantum(quantum)
29 
30 typedef enum
31 {
34  MSBEndian
36 
37 typedef enum
38 {
43 
44 typedef enum
45 {
51 
52 typedef enum
53 {
74  GrayPadQuantum, /* deprecated */
83 
84 typedef struct _QuantumInfo
86 
87 static inline Quantum ClampToQuantum(const MagickRealType value)
88 {
89 #if defined(MAGICKCORE_HDRI_SUPPORT)
90  return((Quantum) value);
91 #else
92  if (value <= 0.0f)
93  return((Quantum) 0);
94  if (value >= (MagickRealType) QuantumRange)
95  return(QuantumRange);
96  return((Quantum) (value+0.5f));
97 #endif
98 }
99 
100 #if (MAGICKCORE_QUANTUM_DEPTH == 8)
101 static inline unsigned char ScaleQuantumToChar(const Quantum quantum)
102 {
103 #if !defined(MAGICKCORE_HDRI_SUPPORT)
104  return((unsigned char) quantum);
105 #else
106  if (quantum <= 0.0)
107  return(0);
108  if (quantum >= 255.0)
109  return(255);
110  return((unsigned char) (quantum+0.5));
111 #endif
112 }
113 #elif (MAGICKCORE_QUANTUM_DEPTH == 16)
114 static inline unsigned char ScaleQuantumToChar(const Quantum quantum)
115 {
116 #if !defined(MAGICKCORE_HDRI_SUPPORT)
117  return((unsigned char) (((quantum+128UL)-((quantum+128UL) >> 8)) >> 8));
118 #else
119  if (quantum <= 0.0)
120  return(0);
121  if ((quantum/257.0) >= 255.0)
122  return(255);
123  return((unsigned char) (quantum/257.0+0.5));
124 #endif
125 }
126 #elif (MAGICKCORE_QUANTUM_DEPTH == 32)
127 static inline unsigned char ScaleQuantumToChar(const Quantum quantum)
128 {
129 #if !defined(MAGICKCORE_HDRI_SUPPORT)
130  return((unsigned char) ((quantum+MagickULLConstant(8421504))/
131  MagickULLConstant(16843009)));
132 #else
133  if (quantum <= 0.0)
134  return(0);
135  if ((quantum/16843009.0) >= 255.0)
136  return(255);
137  return((unsigned char) (quantum/16843009.0+0.5));
138 #endif
139 }
140 #elif (MAGICKCORE_QUANTUM_DEPTH == 64)
141 static inline unsigned char ScaleQuantumToChar(const Quantum quantum)
142 {
143 #if !defined(MAGICKCORE_HDRI_SUPPORT)
144  return((unsigned char) (quantum/72340172838076673.0+0.5));
145 #else
146  if (quantum <= 0.0)
147  return(0);
148  if ((quantum/72340172838076673.0) >= 255.0)
149  return(255);
150  return((unsigned char) (quantum/72340172838076673.0+0.5));
151 #endif
152 }
153 #endif
154 
156  GetQuantumEndian(const QuantumInfo *);
157 
159  SetQuantumDepth(const Image *,QuantumInfo *,const size_t),
162  SetQuantumPad(const Image *,QuantumInfo *,const size_t);
163 
165  GetQuantumFormat(const QuantumInfo *);
166 
170 
173 
174 extern MagickExport size_t
176  const QuantumType,unsigned char *magick_restrict,ExceptionInfo *),
179  const unsigned char *magick_restrict,ExceptionInfo *);
180 
181 extern MagickExport unsigned char
182  *GetQuantumPixels(const QuantumInfo *);
183 
184 extern MagickExport void
191  SetQuantumScale(QuantumInfo *,const double);
192 
193 #if defined(__cplusplus) || defined(c_plusplus)
194 }
195 #endif
196 
197 #endif
#define magick_restrict
Definition: MagickCore.h:41
#define MagickULLConstant(c)
Definition: magick-type.h:39
MagickDoubleType MagickRealType
Definition: magick-type.h:129
#define QuantumRange
Definition: magick-type.h:90
unsigned short Quantum
Definition: magick-type.h:89
MagickBooleanType
Definition: magick-type.h:196
#define MagickExport
Definition: method-attribute.h:80
MagickExport MagickBooleanType SetQuantumPad(const Image *, QuantumInfo *, const size_t)
Definition: quantum.c:905
QuantumFormatType
Definition: quantum.h:45
@ UnsignedQuantumFormat
Definition: quantum.h:49
@ UndefinedQuantumFormat
Definition: quantum.h:46
@ SignedQuantumFormat
Definition: quantum.h:48
@ FloatingPointQuantumFormat
Definition: quantum.h:47
MagickExport void SetQuantumPack(QuantumInfo *, const MagickBooleanType)
MagickExport EndianType GetQuantumEndian(const QuantumInfo *)
Definition: quantum.c:359
MagickExport QuantumType GetQuantumType(Image *, ExceptionInfo *)
Definition: quantum.c:522
QuantumType
Definition: quantum.h:53
@ OpacityQuantum
Definition: quantum.h:67
@ MagentaQuantum
Definition: quantum.h:66
@ GrayPadQuantum
Definition: quantum.h:74
@ AlphaQuantum
Definition: quantum.h:55
@ IndexQuantum
Definition: quantum.h:65
@ GrayAlphaQuantum
Definition: quantum.h:61
@ CyanQuantum
Definition: quantum.h:60
@ RGBPadQuantum
Definition: quantum.h:75
@ BGROQuantum
Definition: quantum.h:81
@ CMYKOQuantum
Definition: quantum.h:79
@ CMYKAQuantum
Definition: quantum.h:58
@ CbYCrAQuantum
Definition: quantum.h:78
@ RGBAQuantum
Definition: quantum.h:69
@ RGBQuantum
Definition: quantum.h:72
@ GrayQuantum
Definition: quantum.h:62
@ BGRAQuantum
Definition: quantum.h:70
@ BlackQuantum
Definition: quantum.h:56
@ RedQuantum
Definition: quantum.h:68
@ IndexAlphaQuantum
Definition: quantum.h:64
@ CbYCrYQuantum
Definition: quantum.h:76
@ UndefinedQuantum
Definition: quantum.h:54
@ BGRQuantum
Definition: quantum.h:80
@ GreenQuantum
Definition: quantum.h:63
@ CMYKQuantum
Definition: quantum.h:59
@ CbYCrQuantum
Definition: quantum.h:77
@ YellowQuantum
Definition: quantum.h:73
@ RGBOQuantum
Definition: quantum.h:71
@ BlueQuantum
Definition: quantum.h:57
MagickExport void SetQuantumAlphaType(QuantumInfo *, const QuantumAlphaType)
MagickExport void SetQuantumImageType(Image *, const QuantumType)
MagickExport MagickBooleanType SetQuantumDepth(const Image *, QuantumInfo *, const size_t)
MagickExport QuantumInfo * DestroyQuantumInfo(QuantumInfo *)
Definition: quantum.c:214
MagickExport size_t ExportQuantumPixels(const Image *, const CacheView *, const QuantumInfo *, const QuantumType, unsigned char *magick_restrict, ExceptionInfo *)
MagickExport size_t GetQuantumExtent(const Image *, const QuantumInfo *, const QuantumType)
MagickExport size_t ImportQuantumPixels(Image *, CacheView *, const QuantumInfo *, const QuantumType, const unsigned char *magick_restrict, ExceptionInfo *)
QuantumAlphaType
Definition: quantum.h:38
@ AssociatedQuantumAlpha
Definition: quantum.h:40
@ DisassociatedQuantumAlpha
Definition: quantum.h:41
@ UndefinedQuantumAlpha
Definition: quantum.h:39
MagickExport void SetQuantumMinIsWhite(QuantumInfo *, const MagickBooleanType)
MagickExport MagickBooleanType SetQuantumEndian(const Image *, QuantumInfo *, const EndianType)
MagickExport void SetQuantumQuantum(QuantumInfo *, const size_t)
MagickExport QuantumInfo * AcquireQuantumInfo(const ImageInfo *, Image *)
MagickExport QuantumFormatType GetQuantumFormat(const QuantumInfo *)
Definition: quantum.c:388
MagickExport void SetQuantumScale(QuantumInfo *, const double)
Definition: quantum.c:1008
EndianType
Definition: quantum.h:31
@ MSBEndian
Definition: quantum.h:34
@ LSBEndian
Definition: quantum.h:33
@ UndefinedEndian
Definition: quantum.h:32
MagickExport unsigned char * GetQuantumPixels(const QuantumInfo *)
Definition: quantum.c:490
static Quantum ClampToQuantum(const MagickRealType value)
Definition: quantum.h:87
MagickExport void GetQuantumInfo(const ImageInfo *, QuantumInfo *)
MagickExport MagickBooleanType SetQuantumFormat(const Image *, QuantumInfo *, const QuantumFormatType)
Definition: cache-view.c:66
Definition: exception.h:103
Definition: image.h:362
Definition: image.h:153
Definition: quantum-private.h:46
size_t quantum
Definition: quantum-private.h:49