Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

mark YUV encodings as deprecated #247

Open
wants to merge 3 commits into
base: rolling
Choose a base branch
from
Open

mark YUV encodings as deprecated #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7da816a
mark encodings YUV422 and YUV422_YUY2 as deprecated
christianrauch May 11, 2024
e6c33f7
replace deprecated encodings in encoding test
christianrauch May 11, 2024
771ab2f
ignore deprecation warning inside the encoding header
christianrauch May 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions sensor_msgs/include/sensor_msgs/image_encodings.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,11 @@ const char BAYER_GRBG16[] = "bayer_grbg16";
// https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/pixfmt-packed-yuv.html#id1
// fourcc: UYVY
const char UYVY[] = "uyvy";
[[deprecated("use sensor_msgs::image_encodings::UYVY")]]
const char YUV422[] = "yuv422"; // deprecated
// fourcc: YUYV
const char YUYV[] = "yuyv";
[[deprecated("use sensor_msgs::image_encodings::YUYV")]]
const char YUV422_YUY2[] = "yuv422_yuy2"; // deprecated

// YUV 4:2:0 encodings with an 8-bit depth
Expand All @@ -120,13 +122,16 @@ const std::regex cv_type_regex("(8|16|32|64)(U|S|F)C([0-9]*)");
// Utility functions for inspecting an encoding string
static inline bool isColor(const std::string & encoding)
{
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
return encoding == RGB8 || encoding == BGR8 ||
encoding == RGBA8 || encoding == BGRA8 ||
encoding == RGB16 || encoding == BGR16 ||
encoding == RGBA16 || encoding == BGRA16 ||
encoding == YUV422 || encoding == YUV422_YUY2 ||
christianrauch marked this conversation as resolved.
Show resolved Hide resolved
encoding == UYVY || encoding == YUYV ||
encoding == NV21 || encoding == NV24;
#pragma GCC diagnostic pop
}

static inline bool isMono(const std::string & encoding)
Expand Down Expand Up @@ -189,6 +194,8 @@ static inline int numChannels(const std::string & encoding)
return (m[3] == "") ? 1 : std::atoi(m[3].str().c_str());
}

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
if (encoding == YUV422 ||
encoding == YUV422_YUY2 ||
encoding == UYVY ||
Expand All @@ -198,6 +205,7 @@ static inline int numChannels(const std::string & encoding)
{
return 2;
}
#pragma GCC diagnostic pop

throw std::runtime_error("Unknown encoding " + encoding);
return -1;
Expand Down Expand Up @@ -241,6 +249,8 @@ static inline int bitDepth(const std::string & encoding)
return std::atoi(m[0].str().c_str());
}

#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
if (encoding == YUV422 ||
encoding == YUV422_YUY2 ||
encoding == UYVY ||
Expand All @@ -250,6 +260,7 @@ static inline int bitDepth(const std::string & encoding)
{
return 8;
}
#pragma GCC diagnostic pop

throw std::runtime_error("Unknown encoding " + encoding);
return -1;
Expand Down
8 changes: 4 additions & 4 deletions sensor_msgs/test/test_image_encodings.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ TEST(sensor_msgs, NumChannels)
ASSERT_EQ(sensor_msgs::image_encodings::numChannels("64FC"), 1);
ASSERT_EQ(sensor_msgs::image_encodings::numChannels("64FC3"), 3);
ASSERT_EQ(sensor_msgs::image_encodings::numChannels("64FC10"), 10);
ASSERT_EQ(sensor_msgs::image_encodings::numChannels("yuv422"), 2);
ASSERT_EQ(sensor_msgs::image_encodings::numChannels("yuv422_yuy2"), 2);
ASSERT_EQ(sensor_msgs::image_encodings::numChannels("uyvy"), 2);
ASSERT_EQ(sensor_msgs::image_encodings::numChannels("yuyv"), 2);
}

TEST(sensor_msgs, bitDepth)
Expand All @@ -68,6 +68,6 @@ TEST(sensor_msgs, bitDepth)
ASSERT_EQ(sensor_msgs::image_encodings::bitDepth("64FC"), 64);
ASSERT_EQ(sensor_msgs::image_encodings::bitDepth("64FC3"), 64);
ASSERT_EQ(sensor_msgs::image_encodings::bitDepth("64FC10"), 64);
ASSERT_EQ(sensor_msgs::image_encodings::bitDepth("yuv422"), 8);
ASSERT_EQ(sensor_msgs::image_encodings::bitDepth("yuv422_yuy2"), 8);
ASSERT_EQ(sensor_msgs::image_encodings::bitDepth("uyvy"), 8);
ASSERT_EQ(sensor_msgs::image_encodings::bitDepth("yuyv"), 8);
}