MagickCore  6.9.10
Convert, Edit, Or Compose Bitmap Images
quantum.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2020 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. You may
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 <float.h>
22 #include "magick/image.h"
23 #include "magick/semaphore.h"
24 
25 #if defined(__cplusplus) || defined(c_plusplus)
26 extern "C" {
27 #endif
28 
29 #define RoundToQuantum(quantum) ClampToQuantum(quantum)
30 
31 typedef enum
32 {
36 } EndianType;
37 
38 typedef enum
39 {
44 
45 typedef enum
46 {
52 
53 typedef enum
54 {
75  GrayPadQuantum, /* deprecated */
83 } QuantumType;
84 
85 typedef struct _QuantumInfo
87 
89 {
90 #if defined(MAGICKCORE_HDRI_SUPPORT)
91  return((Quantum) quantum);
92 #else
93  if (quantum <= 0.0f)
94  return((Quantum) 0);
95  if (quantum >= (MagickRealType) QuantumRange)
96  return(QuantumRange);
97  return((Quantum) (quantum+0.5f));
98 #endif
99 }
100 
101 #if (MAGICKCORE_QUANTUM_DEPTH == 8)
102 static inline unsigned char ScaleQuantumToChar(const Quantum quantum)
103 {
104 #if !defined(MAGICKCORE_HDRI_SUPPORT)
105  return((unsigned char) quantum);
106 #else
107  if ((IsNaN(quantum) != MagickFalse) || (quantum <= 0.0))
108  return(0);
109  if (quantum >= 255.0)
110  return(255);
111  return((unsigned char) (quantum+0.5));
112 #endif
113 }
114 #elif (MAGICKCORE_QUANTUM_DEPTH == 16)
115 static inline unsigned char ScaleQuantumToChar(const Quantum quantum)
116 {
117 #if !defined(MAGICKCORE_HDRI_SUPPORT)
118  return((unsigned char) (((quantum+128UL)-((quantum+128UL) >> 8)) >> 8));
119 #else
120  if ((IsNaN(quantum) != MagickFalse) || (quantum <= 0.0))
121  return(0);
122  if ((quantum/257.0) >= 255.0)
123  return(255);
124  return((unsigned char) (quantum/257.0+0.5));
125 #endif
126 }
127 #elif (MAGICKCORE_QUANTUM_DEPTH == 32)
128 static inline unsigned char ScaleQuantumToChar(const Quantum quantum)
129 {
130 #if !defined(MAGICKCORE_HDRI_SUPPORT)
131  return((unsigned char) ((quantum+MagickULLConstant(8421504))/
132  MagickULLConstant(16843009)));
133 #else
134  if ((IsNaN(quantum) != MagickFalse) || (quantum <= 0.0))
135  return(0);
136  if ((quantum/16843009.0) >= 255.0)
137  return(255);
138  return((unsigned char) (quantum/16843009.0+0.5));
139 #endif
140 }
141 #elif (MAGICKCORE_QUANTUM_DEPTH == 64)
142 static inline unsigned char ScaleQuantumToChar(const Quantum quantum)
143 {
144 #if !defined(MAGICKCORE_HDRI_SUPPORT)
145  return((unsigned char) (quantum/72340172838076673.0+0.5));
146 #else
147  if ((IsNaN(quantum) != MagickFalse) || (quantum <= 0.0))
148  return(0);
149  if ((quantum/72340172838076673.0) >= 255.0)
150  return(255);
151  return((unsigned char) (quantum/72340172838076673.0+0.5));
152 #endif
153 }
154 #endif
155 
157  GetQuantumEndian(const QuantumInfo *);
158 
160  SetQuantumDepth(const Image *,QuantumInfo *,const size_t),
161  SetQuantumEndian(const Image *,QuantumInfo *,const EndianType),
163  SetQuantumPad(const Image *,QuantumInfo *,const size_t);
164 
166  GetQuantumFormat(const QuantumInfo *);
167 
169  *AcquireQuantumInfo(const ImageInfo *,Image *),
171 
174 
175 extern MagickExport size_t
176  ExportQuantumPixels(const Image *,const CacheView *,const QuantumInfo *,
177  const QuantumType,unsigned char *magick_restrict,ExceptionInfo *),
178  GetQuantumExtent(const Image *,const QuantumInfo *,const QuantumType),
180  const unsigned char *magick_restrict,ExceptionInfo *);
181 
182 extern MagickExport unsigned char
183  *GetQuantumPixels(const QuantumInfo *);
184 
185 extern MagickExport void
191  SetQuantumQuantum(QuantumInfo *,const size_t),
192  SetQuantumScale(QuantumInfo *,const double);
193 
194 #if defined(__cplusplus) || defined(c_plusplus)
195 }
196 #endif
197 
198 #endif
#define magick_restrict
Definition: MagickCore.h:41
Definition: quantum.h:71
Definition: quantum.h:62
MagickDoubleType MagickRealType
Definition: magick-type.h:125
QuantumFormatType
Definition: quantum.h:45
Definition: quantum.h:59
MagickExport EndianType GetQuantumEndian(const QuantumInfo *quantum_info)
Definition: quantum.c:359
Definition: quantum.h:79
MagickExport MagickBooleanType SetQuantumFormat(const Image *image, QuantumInfo *quantum_info, const QuantumFormatType format)
Definition: quantum.c:765
Definition: quantum.h:48
Definition: quantum.h:66
Definition: quantum.h:50
#define MagickULLConstant(c)
Definition: magick-type.h:39
Definition: quantum.h:58
Definition: exception.h:102
Definition: quantum.h:67
Definition: quantum.h:75
Definition: image.h:361
Definition: quantum.h:34
Definition: quantum.h:35
Definition: quantum.h:33
Definition: cache-view.c:65
MagickExport MagickBooleanType SetQuantumEndian(const Image *image, QuantumInfo *quantum_info, const EndianType endian)
Definition: quantum.c:725
static Quantum ClampToQuantum(const MagickRealType quantum)
Definition: quantum.h:88
EndianType
Definition: quantum.h:31
Definition: image.h:152
size_t quantum
Definition: quantum-private.h:48
Definition: quantum.h:69
Definition: quantum.h:49
Definition: quantum.h:73
MagickExport size_t ExportQuantumPixels(const Image *image, const CacheView *image_view, const QuantumInfo *quantum_info, const QuantumType quantum_type, unsigned char *magick_restrict pixels, ExceptionInfo *exception)
Definition: quantum-export.c:3813
MagickBooleanType
Definition: magick-type.h:198
Definition: quantum.h:42
Definition: quantum.h:72
MagickExport MagickBooleanType SetQuantumDepth(const Image *image, QuantumInfo *quantum_info, const size_t depth)
Definition: quantum.c:661
Definition: quantum.h:80
Definition: quantum.h:57
Definition: quantum.h:78
Definition: quantum.h:47
MagickExport MagickBooleanType SetQuantumPad(const Image *image, QuantumInfo *quantum_info, const size_t pad)
Definition: quantum.c:905
MagickExport void SetQuantumAlphaType(QuantumInfo *quantum_info, const QuantumAlphaType type)
Definition: quantum.c:626
Definition: quantum.h:55
Definition: quantum.h:81
Definition: quantum.h:70
Definition: quantum.h:64
Definition: quantum.h:40
Definition: quantum.h:74
MagickExport void SetQuantumScale(QuantumInfo *quantum_info, const double scale)
Definition: quantum.c:1008
Definition: quantum.h:56
Definition: quantum.h:61
Definition: quantum.h:60
MagickExport unsigned char * GetQuantumPixels(const QuantumInfo *quantum_info)
Definition: quantum.c:490
Definition: quantum.h:68
MagickExport void SetQuantumMinIsWhite(QuantumInfo *quantum_info, const MagickBooleanType min_is_white)
Definition: quantum.c:943
MagickExport void SetQuantumImageType(Image *image, const QuantumType quantum_type)
Definition: quantum.c:804
Definition: quantum-private.h:45
#define IsNaN(a)
Definition: magick-type.h:221
Definition: quantum.h:65
Definition: magick-type.h:200
MagickExport QuantumFormatType GetQuantumFormat(const QuantumInfo *quantum_info)
Definition: quantum.c:388
unsigned short Quantum
Definition: magick-type.h:85
MagickExport void SetQuantumQuantum(QuantumInfo *quantum_info, const size_t quantum)
Definition: quantum.c:976
Definition: quantum.h:77
QuantumType
Definition: quantum.h:53
MagickExport size_t ImportQuantumPixels(Image *image, CacheView *image_view, const QuantumInfo *quantum_info, const QuantumType quantum_type, const unsigned char *magick_restrict pixels, ExceptionInfo *exception)
Definition: quantum-import.c:4009
Definition: quantum.h:82
Definition: quantum.h:63
Definition: quantum.h:41
#define MagickExport
Definition: method-attribute.h:80
Definition: quantum.h:76
MagickExport void GetQuantumInfo(const ImageInfo *image_info, QuantumInfo *quantum_info)
Definition: quantum.c:419
MagickExport QuantumInfo * AcquireQuantumInfo(const ImageInfo *image_info, Image *image)
Definition: quantum.c:109
QuantumAlphaType
Definition: quantum.h:38
MagickExport void SetQuantumPack(QuantumInfo *quantum_info, const MagickBooleanType pack)
Definition: quantum.c:870
#define QuantumRange
Definition: magick-type.h:86
MagickExport QuantumInfo * DestroyQuantumInfo(QuantumInfo *quantum_info)
Definition: quantum.c:214
MagickExport size_t GetQuantumExtent(const Image *image, const QuantumInfo *quantum_info, const QuantumType quantum_type)
Definition: quantum.c:307
MagickExport QuantumType GetQuantumType(Image *image, ExceptionInfo *exception)
Definition: quantum.c:522