PCL
EndianConversions.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/EndianConversions.h - Released 2024-06-18T15:48:54Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_EndianConversions_h
53 #define __PCL_EndianConversions_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/Math.h>
60 
61 namespace pcl
62 {
63 
64 // ----------------------------------------------------------------------------
65 
77 {
78  return (x << 8) | (x >> 8);
79 }
80 
88 {
89  return (RotL( x, 8 ) & 0x00ff00ffu) | (RotR( x, 8 ) & 0xff00ff00u);
90 
91 }
92 
100 {
101  return (uint64( BigToLittleEndian( uint32( x ) ) ) << 32) | uint64( BigToLittleEndian( uint32( x >> 32 ) ) );
102 }
103 
111 template <typename T> inline T LittleToBigEndian( T x )
112 {
113  return BigToLittleEndian( x );
114 }
115 
116 // ----------------------------------------------------------------------------
117 
118 union __pcl_endian_check__ { uint32 w; uint8 b[ sizeof( uint32 ) ]; };
119 
120 constexpr __pcl_endian_check__ __pcl_endian_check_sample__ = { 0xdeadbeef };
121 
122 #ifdef __clang__
123 
124 inline bool IsLittleEndianMachine()
125 {
126  return __pcl_endian_check_sample__.b[0] == 0xef;
127 }
128 
129 inline bool IsBigEndianMachine()
130 {
131  return __pcl_endian_check_sample__.b[0] == 0xde;
132 }
133 
134 #else
135 
136 // Clang fails here with "read of member 'b' of union with active member 'w' is
137 // not allowed in a constant expression".
138 
144 constexpr bool IsLittleEndianMachine()
145 {
146  return __pcl_endian_check_sample__.b[0] == 0xef;
147 }
148 
154 constexpr bool IsBigEndianMachine()
155 {
156  return __pcl_endian_check_sample__.b[0] == 0xde;
157 }
158 
159 #endif // __clang__
160 
161 // ----------------------------------------------------------------------------
162 
163 } // pcl
164 
165 #endif // __PCL_EndianConversions_h
166 
167 // ----------------------------------------------------------------------------
168 // EOF pcl/EndianConversions.h - Released 2024-06-18T15:48:54Z
uint16 BigToLittleEndian(uint16 x)
constexpr bool IsBigEndianMachine()
constexpr bool IsLittleEndianMachine()
T LittleToBigEndian(T x)
T RotL(T x, uint32 n) noexcept
Definition: Math.h:1330
T RotR(T x, uint32 n) noexcept
Definition: Math.h:1351
unsigned long long uint64
Definition: Defs.h:682
unsigned short uint16
Definition: Defs.h:654
unsigned char uint8
Definition: Defs.h:642
unsigned int uint32
Definition: Defs.h:666
PCL root namespace.
Definition: AbstractImage.h:77