Move .aseprite encoder to dio library by dacap · Pull Request #5677 · aseprite/aseprite

dacap · 2026-02-26T11:43:13Z

This is a long-standing TODO of ase_format.cpp to move the C-like code to encode .aseprite files to the dio library just like the decoder was moved in the past.

aseprite-bot

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 135. Check the log or trigger a new build to see more.

aseprite-bot · 2026-02-26T11:47:36Z

-                                  header.ncolors));
+  std::unique_ptr<Sprite> sprite(
+    std::make_unique<Sprite>(ImageSpec(header.depth == 32 ? ColorMode::RGB :
+                                       header.depth == 16 ? ColorMode::GRAYSCALE :


warning: conditional operator is used as sub-expression of parent conditional operator, refrain from using nested conditional operators [readability-avoid-nested-conditional-operator]

header.depth == 16 ? ColorMode::GRAYSCALE : ^

Additional context

src/dio/aseprite_decoder.cpp:58: parent conditional operator here

std::make_unique<Sprite>(ImageSpec(header.depth == 32 ? ColorMode::RGB : ^

aseprite-bot

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 112. Check the log or trigger a new build to see more.

aseprite-bot · 2026-02-26T12:32:49Z

+  header->width = sprite->width();
+  header->height = sprite->height();
+  header->depth = (sprite->pixelFormat() == IMAGE_RGB       ? 32 :
+                   sprite->pixelFormat() == IMAGE_GRAYSCALE ? 16 :


warning: conditional operator is used as sub-expression of parent conditional operator, refrain from using nested conditional operators [readability-avoid-nested-conditional-operator]

sprite->pixelFormat() == IMAGE_GRAYSCALE ? 16 : ^

Additional context

src/dio/aseprite_encoder.cpp:162: parent conditional operator here

header->depth = (sprite->pixelFormat() == IMAGE_RGB ? 32 : ^

aseprite-bot · 2026-02-26T12:32:49Z

+  header->height = sprite->height();
+  header->depth = (sprite->pixelFormat() == IMAGE_RGB       ? 32 :
+                   sprite->pixelFormat() == IMAGE_GRAYSCALE ? 16 :
+                   sprite->pixelFormat() == IMAGE_INDEXED   ? 8 :


warning: conditional operator is used as sub-expression of parent conditional operator, refrain from using nested conditional operators [readability-avoid-nested-conditional-operator]

sprite->pixelFormat() == IMAGE_INDEXED ? 8 : ^

Additional context

src/dio/aseprite_encoder.cpp:163: parent conditional operator here

sprite->pixelFormat() == IMAGE_GRAYSCALE ? 16 : ^

aseprite-bot · 2026-02-26T12:32:50Z

+//////////////////////////////////////////////////////////////////////
+
+template<typename ImageTraits>
+static void write_raw_image_templ(FileInterface* f, const ScanlinesGen* gen)


warning: 'write_raw_image_templdoc::GrayscaleTraits' is a static definition in anonymous namespace; static is redundant here [readability-static-definition-in-anonymous-namespace]

static void write_raw_image_templ(FileInterface* f, const ScanlinesGen* gen) ^

this fix will not be applied because it overlaps with another fix

aseprite-bot

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 87. Check the log or trigger a new build to see more.

aseprite-bot

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 41. Check the log or trigger a new build to see more.

aseprite-bot · 2026-02-26T13:49:24Z

+  }
+}
+
+layer_t AsepriteEncoder::writeCels(AsepriteFrameHeader* frame_header,


warning: function 'writeCels' is within a recursive call chain [misc-no-recursion]

layer_t AsepriteEncoder::writeCels(AsepriteFrameHeader* frame_header, ^

Additional context

src/dio/aseprite_encoder.cpp:271: example recursive call chain, starting from function 'writeCels'

layer_t AsepriteEncoder::writeCels(AsepriteFrameHeader* frame_header, ^

src/dio/aseprite_encoder.cpp:297: Frame #1: function 'writeCels' calls function 'writeCels' here:

layer_index = writeCels(frame_header, ext_files, sprite, child, layer_index, frame); ^

src/dio/aseprite_encoder.cpp:297: ... which was the starting point of the recursive call chain; there may be other cycles

layer_index = writeCels(frame_header, ext_files, sprite, child, layer_index, frame); ^

aseprite-bot · 2026-02-26T13:49:24Z

+  }
+
+  const int cel_type = (link                      ? ASE_FILE_LINK_CEL :
+                        cel->layer()->isTilemap() ? delegate()->preferredTilemapCelType() :


warning: conditional operator is used as sub-expression of parent conditional operator, refrain from using nested conditional operators [readability-avoid-nested-conditional-operator]

cel->layer()->isTilemap() ? delegate()->preferredTilemapCelType() : ^

Additional context

src/dio/aseprite_encoder.cpp:661: parent conditional operator here

const int cel_type = (link ? ASE_FILE_LINK_CEL : ^

aseprite-bot · 2026-02-26T13:49:24Z

+
+    case ASE_FILE_LINK_CEL:
+      // Linked cel to another frame
+      write16(link->frame() - firstFrame);


warning: Called C++ object pointer is null [clang-analyzer-core.CallAndMessage]

write16(link->frame() - firstFrame); ^

Additional context

src/dio/aseprite_encoder.cpp:58: 'outputFrame' is equal to 0

if (outputFrame == 0) { ^

src/dio/aseprite_encoder.cpp:58: Taking true branch

if (outputFrame == 0) { ^

src/dio/aseprite_encoder.cpp:63: Assuming the condition is false

if (delegate()->preserveColorProfile()) ^

src/dio/aseprite_encoder.cpp:63: Taking false branch

if (delegate()->preserveColorProfile()) ^

src/dio/aseprite_encoder.cpp:71: Assuming the condition is false

(frame == delegate()->fromFrame() || ^

src/dio/aseprite_encoder.cpp:71: Left side of '||' is false

(frame == delegate()->fromFrame() || ^

src/dio/aseprite_encoder.cpp:73: Assuming the condition is false

sprite->palette(frame - 1)->countDiff(pal, &palFrom, &palTo) > 0)) { ^

src/dio/aseprite_encoder.cpp:70: Taking false branch

if ( // First frame or.. ^

src/dio/aseprite_encoder.cpp:87: Assuming the condition is false

if (frame == delegate()->fromFrame()) { ^

src/dio/aseprite_encoder.cpp:87: Taking false branch

if (frame == delegate()->fromFrame()) { ^

src/dio/aseprite_encoder.cpp:123: Calling 'AsepriteEncoder::writeCels'

writeCels(&frame_header, ext_files, sprite, sprite->root(), 0, frame); ^

src/dio/aseprite_encoder.cpp:278: Taking true branch

if (layer->isImage()) { ^

src/dio/aseprite_encoder.cpp:280: Assuming 'cel' is non-null

if (cel) { ^

src/dio/aseprite_encoder.cpp:280: Taking true branch

if (cel) { ^

src/dio/aseprite_encoder.cpp:281: Calling 'AsepriteEncoder::writeCelChunk'

writeCelChunk(frame_header, cel, static_cast<const LayerImage*>(layer), layer_index); ^

src/dio/aseprite_encoder.cpp:646: 'link' initialized here

const Cel* link = cel->link(); ^

src/dio/aseprite_encoder.cpp:650: Assuming 'link' is null

if (link && link->frame() < firstFrame) { ^

src/dio/aseprite_encoder.cpp:650: Left side of '&&' is false

if (link && link->frame() < firstFrame) { ^

src/dio/aseprite_encoder.cpp:661: 'link' is null

const int cel_type = (link ? ASE_FILE_LINK_CEL : ^

src/dio/aseprite_encoder.cpp:661: '?' condition is false

const int cel_type = (link ? ASE_FILE_LINK_CEL : ^

src/dio/aseprite_encoder.cpp:662: '?' condition is false

cel->layer()->isTilemap() ? delegate()->preferredTilemapCelType() : ^

src/dio/aseprite_encoder.cpp:673: Control jumps to 'case 1:' at line 695

switch (cel_type) { ^

src/dio/aseprite_encoder.cpp:696: Called C++ object pointer is null

write16(link->frame() - firstFrame); ^

aseprite-bot · 2026-02-26T13:49:24Z

+  }
+}
+
+void AsepriteEncoder::writePropertyValue(const UserData::Variant& value)


warning: function 'writePropertyValue' is within a recursive call chain [misc-no-recursion]

void AsepriteEncoder::writePropertyValue(const UserData::Variant& value) ^

Additional context

src/dio/aseprite_encoder.cpp:1172: example recursive call chain, starting from function 'writePropertyValue'

void AsepriteEncoder::writePropertyValue(const UserData::Variant& value) ^

src/dio/aseprite_encoder.cpp:1222: Frame #1: function 'writePropertyValue' calls function 'writePropertyValue' here:

writePropertyValue(v); ^

src/dio/aseprite_encoder.cpp:1222: ... which was the starting point of the recursive call chain; there may be other cycles

writePropertyValue(v); ^

aseprite-bot · 2026-02-26T13:49:24Z

+
+void AsepriteEncoder::writePropertyValue(const UserData::Variant& value)
+{
+  switch (value.type()) {


warning: switching on non-enum value without default case may not cover all cases [bugprone-switch-missing-default-case]

switch (value.type()) { ^

aseprite-bot · 2026-02-26T13:49:25Z

+      return ((b2 << 8) | b1); // Little endian
+    }
+    else
+      return 0;


warning: do not use 'else' after 'return' [readability-else-after-return]

Suggested change

return 0;

return 0;

aseprite-bot · 2026-02-26T13:49:25Z

+
+  uint32_t read32()
+  {
+    int b1 = read8();


warning: variable 'b1' of type 'int' can be declared 'const' [misc-const-correctness]

Suggested change

int b1 = read8();

int const b1 = read8();

aseprite-bot · 2026-02-26T13:49:26Z

+  uint32_t read32()
+  {
+    int b1 = read8();
+    int b2 = read8();


warning: variable 'b2' of type 'int' can be declared 'const' [misc-const-correctness]

Suggested change

int b2 = read8();

int const b2 = read8();

aseprite-bot · 2026-02-26T13:49:26Z

+  {
+    int b1 = read8();
+    int b2 = read8();
+    int b3 = read8();


warning: variable 'b3' of type 'int' can be declared 'const' [misc-const-correctness]

Suggested change

int b3 = read8();

int const b3 = read8();

aseprite-bot · 2026-02-26T13:49:26Z

+    int b1 = read8();
+    int b2 = read8();
+    int b3 = read8();
+    int b4 = read8();


warning: variable 'b4' of type 'int' can be declared 'const' [misc-const-correctness]

Suggested change

int b4 = read8();

int const b4 = read8();

Added Decoder::tell/seek() functions to reduce a little of noise from AsepriteDecoder code.

aseprite-bot

clang-tidy made some suggestions

aseprite-bot · 2026-02-26T14:04:47Z

+  }
+}
+
+void AsepriteEncoder::writePropertyValue(const UserData::Variant& value)


warning: function 'writePropertyValue' is within a recursive call chain [misc-no-recursion]

void AsepriteEncoder::writePropertyValue(const UserData::Variant& value) ^

Additional context

src/dio/aseprite_encoder.cpp:1178: example recursive call chain, starting from function 'writePropertyValue'

void AsepriteEncoder::writePropertyValue(const UserData::Variant& value) ^

src/dio/aseprite_encoder.cpp:1228: Frame #1: function 'writePropertyValue' calls function 'writePropertyValue' here:

writePropertyValue(v); ^

src/dio/aseprite_encoder.cpp:1228: ... which was the starting point of the recursive call chain; there may be other cycles

writePropertyValue(v); ^

aseprite-bot · 2026-02-26T14:04:47Z

+  virtual bool composeGroups() = 0;
+  virtual bool preserveColorProfile() = 0;
+  virtual bool cacheCompressedTilesets() = 0;
+  virtual int preferredCelType() { return ASE_FILE_COMPRESSED_CEL; }


warning: use of undeclared identifier 'ASE_FILE_COMPRESSED_CEL' [clang-diagnostic-error]

virtual int preferredCelType() { return ASE_FILE_COMPRESSED_CEL; } ^

aseprite-bot · 2026-02-26T14:04:47Z

+  virtual bool preserveColorProfile() = 0;
+  virtual bool cacheCompressedTilesets() = 0;
+  virtual int preferredCelType() { return ASE_FILE_COMPRESSED_CEL; }
+  virtual int preferredTilemapCelType() { return ASE_FILE_COMPRESSED_TILEMAP; }


warning: use of undeclared identifier 'ASE_FILE_COMPRESSED_TILEMAP' [clang-diagnostic-error]

virtual int preferredTilemapCelType() { return ASE_FILE_COMPRESSED_TILEMAP; } ^

aseprite-bot · 2026-02-26T14:04:47Z

+#include <cstdint>
+#include <cstring>
+
+#include "dio/file_interface.h"


warning: 'dio/file_interface.h' file not found [clang-diagnostic-error]

#include "dio/file_interface.h" ^

aseprite-bot · 2026-02-26T14:04:47Z

      return 0;
  }
+
+  void write_pixel(FileInterface* f, doc::TilemapTraits::pixel_t c)


warning: method 'write_pixel' can be made static [readability-convert-member-functions-to-static]

Suggested change

void write_pixel(FileInterface* f, doc::TilemapTraits::pixel_t c)

static void write_pixel(FileInterface* f, doc::TilemapTraits::pixel_t c)

aseprite-bot · 2026-02-26T14:04:47Z

      *address = ((b4 << 24) | (b3 << 16) | (b2 << 8) | b1);
    }
  }
+  void write_scanline(doc::TilemapTraits::address_t address, int w, uint8_t* buffer)


warning: method 'write_scanline' can be made static [readability-convert-member-functions-to-static]

Suggested change

void write_scanline(doc::TilemapTraits::address_t address, int w, uint8_t* buffer)

static void write_scanline(doc::TilemapTraits::address_t address, int w, uint8_t* buffer)

aseprite-bot · 2026-02-26T14:04:47Z

+
+size_t StdioFileInterface::writeBytes(uint8_t* buf, size_t n)
+{
+  size_t r = fwrite(buf, 1, n, m_file);


warning: variable 'r' of type 'size_t' (aka 'unsigned long') can be declared 'const' [misc-const-correctness]

Suggested change

size_t r = fwrite(buf, 1, n, m_file);

size_t const r = fwrite(buf, 1, n, m_file);

aseprite-bot reviewed Feb 26, 2026

View reviewed changes

dacap force-pushed the dio-refactor branch 2 times, most recently from 21b4c92 to b6d2b0e Compare February 26, 2026 12:30

aseprite-bot reviewed Feb 26, 2026

View reviewed changes

dacap force-pushed the dio-refactor branch from b6d2b0e to 15cfa30 Compare February 26, 2026 13:45

aseprite-bot reviewed Feb 26, 2026

View reviewed changes

dacap added 2 commits February 26, 2026 11:00

[dio] Move Decoder impl to header file (to prioritize inline code)

0c91366

Added Decoder::tell/seek() functions to reduce a little of noise from AsepriteDecoder code.

[dio] Replace doc:: by using namespace doc

157677b

dacap force-pushed the dio-refactor branch from 15cfa30 to a8dc663 Compare February 26, 2026 14:00

aseprite-bot reviewed Feb 26, 2026

View reviewed changes

[dio] Move .aseprite encoder code to dio library

a92804c

dacap force-pushed the dio-refactor branch from a8dc663 to a92804c Compare February 26, 2026 14:19

dacap marked this pull request as ready for review February 26, 2026 14:19

dacap merged commit a92804c into aseprite:beta Feb 26, 2026
12 checks passed

dacap deleted the dio-refactor branch February 26, 2026 14:25

	void write_pixel(FileInterface* f, doc::TilemapTraits::pixel_t c)
	static void write_pixel(FileInterface* f, doc::TilemapTraits::pixel_t c)

	void write_scanline(doc::TilemapTraits::address_t address, int w, uint8_t* buffer)
	static void write_scanline(doc::TilemapTraits::address_t address, int w, uint8_t* buffer)

	size_t r = fwrite(buf, 1, n, m_file);
	size_t const r = fwrite(buf, 1, n, m_file);

Uh oh!

Uh oh!

Conversation

dacap commented Feb 26, 2026

Uh oh!

aseprite-bot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aseprite-bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aseprite-bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aseprite-bot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aseprite-bot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!