Add costume image API

Author: adazem009

include/scratchcpp/costume.h

@@ -2,6 +2,7 @@
 
 #pragma once
 
+#include "iimageformat.h"
 #include "spimpl.h"
 
 #include "asset.h"
@@ -28,8 +29,22 @@ class LIBSCRATCHCPP_EXPORT Costume : public Asset
         int rotationCenterY() const;
         void setRotationCenterY(int newRotationCenterY);
 
+        unsigned int width() const;
+        unsigned int height() const;
+
+        double scale() const;
+        void setScale(double scale);
+
+        bool mirrorHorizontally() const;
+        void setMirrorHorizontally(bool mirror);
+
+        Rgb **bitmap() const;
+
         Broadcast *broadcast();
 
+    protected:
+        void processData(const char *data) override;
+
     private:
         spimpl::unique_impl_ptr<CostumePrivate> impl;
 };

src/scratch/costume.cpp

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include <scratchcpp/costume.h>
+#include <scratchcpp/scratchconfiguration.h>
 
 #include "costume_p.h"
 
@@ -11,6 +12,9 @@ Costume::Costume(const std::string &name, const std::string &id, const std::stri
     Asset(name, id, format),
     impl(spimpl::make_unique_impl<CostumePrivate>())
 {
+    // NOTE: image is always initialized, so there's no need for null checks
+    impl->image = ScratchConfiguration::createImageFormat(format);
+    impl->updateImage();
 }
 
 /*! Returns the reciprocal of the costume scaling factor for bitmap costumes. */
@@ -49,6 +53,56 @@ void Costume::setRotationCenterY(int newRotationCenterY)
     impl->rotationCenterY = newRotationCenterY;
 }
 
+/*! Returns the costume width. */
+unsigned int Costume::width() const
+{
+    return impl->image->width() * impl->scale;
+}
+
+/*! Returns the costume height. */
+unsigned int Costume::height() const
+{
+    return impl->image->height() * impl->scale;
+}
+
+/*! Returns the image scale. */
+double Costume::scale() const
+{
+    return impl->scale;
+}
+
+/*! Sets the image scale (this is automatically set by the sprite). */
+void Costume::setScale(double scale)
+{
+    if (impl->scale == scale)
+        return;
+
+    impl->scale = scale;
+    impl->updateImage();
+}
+
+/*! Returns true if the costume image is mirrored horizontally. */
+bool Costume::mirrorHorizontally() const
+{
+    return impl->mirrorHorizontally;
+}
+
+/*! Sets whether the costume image is mirrored horizontally (this is automatically set by the sprite). */
+void Costume::setMirrorHorizontally(bool mirror)
+{
+    if (impl->mirrorHorizontally == mirror)
+        return;
+
+    impl->mirrorHorizontally = mirror;
+    impl->updateImage();
+}
+
+/*! Returns the bitmap of the costume (an array of pixel rows). */
+Rgb **Costume::bitmap() const
+{
+    return impl->bitmap;
+}
+
 /*!
  * Returns the Broadcast linked with this costume.
  * \note This is used by the "switch backdrop to and wait" block.
@@ -57,3 +111,10 @@ Broadcast *Costume::broadcast()
 {
     return &impl->broadcast;
 }
+
+void Costume::processData(const char *data)
+{
+    impl->image->setData(data);
+    impl->freeImage();
+    impl->updateImage();
+}

src/scratch/costume_p.cpp

@@ -8,3 +8,52 @@ CostumePrivate::CostumePrivate() :
     broadcast("", "")
 {
 }
+
+CostumePrivate::~CostumePrivate()
+{
+    freeImage();
+}
+
+void CostumePrivate::updateImage()
+{
+    unsigned int scaledWidth = image->width() * scale;
+    unsigned int scaledHeight = image->height() * scale;
+
+    if (scaledWidth == 0 || scaledHeight == 0) {
+        freeImage();
+        return;
+    }
+
+    if (!bitmap || (scale != oldScale)) {
+        freeImage();
+        bitmap = static_cast<Rgb **>(malloc(sizeof(Rgb *) * scaledHeight));
+
+        for (unsigned int i = 0; i < scaledHeight; i++)
+            bitmap[i] = static_cast<Rgb *>(malloc(sizeof(Rgb) * scaledWidth));
+
+        oldScale = scale;
+        oldWidth = scaledWidth;
+        oldHeight = scaledHeight;
+    }
+
+    for (unsigned int i = 0; i < scaledHeight; i++) {
+        for (unsigned int j = 0; j < scaledWidth; j++) {
+            Rgb color = image->colorAt(mirrorHorizontally ? (scaledWidth - 1 - j) : j, i, scale);
+
+            // TODO: Apply graphics effects here
+
+            bitmap[i][j] = color;
+        }
+    }
+}
+
+void CostumePrivate::freeImage()
+{
+    if (bitmap) {
+        for (unsigned int i = 0; i < oldHeight; i++)
+            free(bitmap[i]);
+
+        free(bitmap);
+        bitmap = nullptr;
+    }
+}

src/scratch/costume_p.h

@@ -3,18 +3,32 @@
 #pragma once
 
 #include <scratchcpp/broadcast.h>
+#include <scratchcpp/iimageformat.h>
 
 namespace libscratchcpp
 {
 
+class IImageFormat;
+
 struct CostumePrivate
 {
         CostumePrivate();
         CostumePrivate(const CostumePrivate &) = delete;
+        ~CostumePrivate();
+
+        void updateImage();
+        void freeImage();
 
         double bitmapResolution = 1;
         int rotationCenterX = 0;
         int rotationCenterY = 0;
+        std::shared_ptr<IImageFormat> image;
+        Rgb **bitmap = nullptr;
+        double oldWidth = 0;
+        double oldHeight = 0;
+        double oldScale = 1;
+        double scale = 1;
+        bool mirrorHorizontally = false;
         Broadcast broadcast;
 };
 

test/assets/CMakeLists.txt

@@ -23,7 +23,9 @@ add_executable(
 target_link_libraries(
   costume_test
   GTest::gtest_main
+  GTest::gmock_main
   scratchcpp
+  scratchcpp_mocks
 )
 
 gtest_discover_tests(costume_test)