Mirrors/eepp
1
0
Fork 0
mirror of https://github.com/SpartanJ/eepp.git synced 2026-09-22 13:01:05 +03:00
Code Issues Packages Projects Releases Wiki Activity

Optimize eterm Kitty graphics frame replacement

Browse Source 
- swap decoded frames into reusable image storage
  - recycle previous frame allocations for subsequent transfers
  - avoid full-frame copies during anonymous image replacement
  - extend tests to verify safe allocation reuse across frames
  - document eterm and eeiv in the project introduction
This commit is contained in:
Martín Lucas Golini
2026-09-04 18:45:10 -03:00
parent 7ed9b7c517
commit 0e9f2e832f
3 changed files with 29 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
.agent/rules/project-introduction.md
View File

@@ -1,6 +1,7 @@
# Project Architecture: eepp & ecode
This repository contains two primary components: a core framework (`eepp`) and an application built on top of it (`ecode`).
This repository contains the core framework (`eepp`) and several applications and tools built on
top of it, including `ecode`, `eterm`, and `eeiv`.
## 1. eepp (Core Framework)
@@ -12,6 +13,16 @@ This repository contains two primary components: a core framework (`eepp`) and a
* **Relationship:** `ecode` is built *using* the `eepp` GUI framework. It acts as the primary real-world consumer of `eepp`.
* **Goal:** Development on `ecode` is often used to test, improve, and drive new features in the underlying `eepp` library.
## 3. eterm (Terminal Emulator)
`eterm` is the repository's terminal emulator. Its name is always written in lowercase: `eterm`,
not `eTerm`. Its implementation lives under `src/modules/eterm/`.
## 4. eeiv (Image Viewer)
`eeiv` is the repository's image viewer. Its application entry point is
`src/tools/eeiv/eeiv.cpp`.
## Documentation & Code References
When working on this project, rely on the following resources to understand existing implementations:

10
src/modules/eterm/src/eterm/terminal/kittygraphicsprotocol.cpp
View File

@@ -663,11 +663,11 @@ KittyGraphicsHandleResult KittyGraphicsProtocol::finishTransfer( PendingTransfer
std::shared_ptr<std::vector<Uint8>> pixelStorage;
if ( existing != mImages.end() && existing->second.pixels.use_count() == 1 ) {
pixelStorage = existing->second.pixels;
pixelStorage->assign( pixels.begin(), pixels.end() );
if ( format == 24 )
recycleBuffer( pixels, mDecodedScratch );
else if ( format == 32 )
recycleBuffer( pixels, mDecodedScratch );
// The existing image is no longer referenced by a queued UI update. Exchange its backing
// allocation with the freshly decoded frame instead of copying the complete image. The old
// image allocation becomes the next transfer's decode buffer.
pixelStorage->swap( pixels );
recycleBuffer( pixels, mDecodedScratch );
} else {
pixelStorage = std::make_shared<std::vector<Uint8>>( std::move( pixels ) );
}

12
src/tests/unit_tests/eterm_tests.cpp
View File

@@ -1064,12 +1064,24 @@ UTEST( eterm, kitty_graphics_reuses_unreferenced_replacement_pixel_storage ) {
updates.clear();
const auto* storage = protocol.imagePixels( 91 );
ASSERT_TRUE( storage != nullptr );
const auto* firstAllocation = storage->data();
ASSERT_EQ( KittyGraphicsError::None,
protocol.handle( "a=t,f=24,s=2,v=1,i=91,q=2;BwgJCgsM" ).error );
EXPECT_TRUE( storage == protocol.imagePixels( 91 ) );
const std::vector<Uint8> expected{ 7, 8, 9, 10, 11, 12 };
EXPECT_TRUE( expected == *protocol.imagePixels( 91 ) );
ASSERT_TRUE( firstAllocation != protocol.imagePixels( 91 )->data() );
updates = protocol.takeUpdates();
ASSERT_EQ( static_cast<size_t>( 1 ), updates.size() );
updates.clear();
ASSERT_EQ( KittyGraphicsError::None,
protocol.handle( "a=t,f=24,s=2,v=1,i=91,q=2;DQ4PEBES" ).error );
EXPECT_TRUE( storage == protocol.imagePixels( 91 ) );
const std::vector<Uint8> recycledExpected{ 13, 14, 15, 16, 17, 18 };
EXPECT_TRUE( recycledExpected == *protocol.imagePixels( 91 ) );
EXPECT_TRUE( firstAllocation == protocol.imagePixels( 91 )->data() );
}
UTEST( eterm, kitty_graphics_rejects_shared_memory_transmission ) {