android/Bitmap.h

Go to the documentation of this file.

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
 
#ifndef META_OCEAN_PLATFORM_ANDROID_BITMAP_H
#define META_OCEAN_PLATFORM_ANDROID_BITMAP_H
 
#include "ocean/platform/android/Android.h"
#include "ocean/platform/android/ScopedJNIObject.h"
 
#include "ocean/base/Frame.h"
 
#include <android/bitmap.h>
 
namespace Ocean
{
 
namespace Platform
{
 
namespace Android
{
 
/**
 * This class implements bitmap functions.
 * @ingroup platformandroid
 */
class OCEAN_PLATFORM_ANDROID_EXPORT Bitmap
{
    public:
 
        /**
         * Converts an Android bitmap to an Ocean frame.
         * The Android bitmap must have format ANDROID_BITMAP_FORMAT_RGBA_8888.
         * @param env The JNI environment, must be valid
         * @param bitmap The Android bitmap to convert, must be valid
         * @param copyData True, to copy the bitmap data; False, to use the bitmap data directly
         * @return The resulting Ocean frame, an invalid frame if the conversion failed
         */
        static Frame toFrame(JNIEnv* env, jobject bitmap, const bool copyData = true);
 
        /**
         * Converts a frame with pixel format FORMAT_RGBA32 to an Android bitmap.
         * @param env The JNI environment, must be valid
         * @param rgbaFrame The frame to convert, with pixel format FORMAT_RGBA32, must be valid
         * @return The resulting Android bitmap, nullptr if the conversion failed
         */
        static ScopedJObject toBitmap(JNIEnv* env, const Frame& rgbaFrame);
 
        /**
         * Translates an Android bitmap format to an Ocean pixel format.
         * @param format The Android bitmap format to translate
         * @return The corresponding Ocean pixel format, FORMAT_UNDEFINED if unknown
         */
         static FrameType::PixelFormat translateFormat(const AndroidBitmapFormat format);
 
         /**
          * Translates an Ocean pixel format to an Android bitmap format.
          * @param pixelFormat The Ocean pixel format to translate
          * @return The corresponding Android bitmap format, ANDROID_BITMAP_FORMAT_NONE if unknown
          */
         static AndroidBitmapFormat translateFormat(const FrameType::PixelFormat pixelFormat);
};
 
}
 
}
 
}
 
#endif // META_OCEAN_PLATFORM_ANDROID_BITMAP_H