Implement Run-Length Buffering

[cmorman89]

Implement Run Length Buffering

Description

Run-length buffering needs to be implemented in the rendering pipeline to optimize how ANSI codes are handled. This will reduce the number of color transitions and improve rendering performance.

Goals:

• Reduce cursor movement and redundant ANSI codes.
• Group consecutive pixels with the same color into a single "run" for efficient output.
• Maintain cursor relocation as this will be important when updating only portions of the final image.
• Optionally implement adjacent RunBuffer detection to prevent a relocation if there is no need. May be a future issue.

Tasks:

1. Create a RunBuffer class to store contiguous pixel runs.
2. Add logic to RunBufferBuilder to detect color transitions and create runs.
3. Utilize a backbuffer to detect the color transitions.
4. Integrate into TerminalRenderer
5. Update demo.py if necessary to use a run-buffer. Reactivate animation.

[cmorman89]

Update Overview:

RunBuffer and RunBufferBuilder have been implemented as foundational changes. Integration into the rendering pipeline is pending.

---

Updated Features:

RunBuffer:

• Mainly a data-containing object (the actual run-length buffer data, specifically).
• The __repr__ method allows rendering the boundaries of the run-length buffers being produced within brackets ([ ]) and if it represents a Pixel (-) or None (_):
  • Examples: [______] and [------]

RunBufferBuilder:

• Constructs the RunBuffer object in-place while the renderer streams data from the render pipeline (Pixel objects and their rendered characters that will be printed to the terminal).
  • Buffers the pixel by keeping a record of the last color used and compares it to the current pixel's color.
  • If it is the same, RunBufferBuilder will continue to add to the RunBuffer.
  • If it is different, the old RunBuffer is returned (for immediate printing to the terminal) and a new RunBuffer is created to accept the latest pixel's data.

---

Updated Progress:

Goals:

Completed:

• ✅ Reduce cursor movement and redundant ANSI codes.
• ✅ Group consecutive pixels with the same color into a single "run" for efficient output.
• ✅ Maintain cursor relocation as this will be important when updating only portions of the final image.

Tasks:

Completed:

• ✅ Create a RunBuffer class to store contiguous pixel runs.
• ✅ Add logic to RunBufferBuilder to detect color transitions and create runs.
• ✅ Utilize a backbuffer to detect the color transitions.

Remaining:

• ⏳ Integrate into TerminalRenderer
• ⏳ Update demo.py if necessary to use a run-buffer. Reactivate animation.

---

New Issues/To Do Items:

⚠️RunBuffer : __repr__() Output Oversized:

• Low Priority
• This method has or causes a problem when new lines are involved in the buffer.
• Causes the ending bracket (]) to be outside the RunBuffer actual size. This gets overwritten by the next buffer, resulting in the apparent truncation of the representation of the prior RunBuffer object.
• Have not been able to easily resolve this error. I do not know if it is limited to the actual __repr__ method or a deeper issue in the RunBuffers that contain a new line (\n)

⚠️ Implement Adjacent RunBuffer Detection:

• Low Priority
• Prevent a cursor relocation from being issued if there is no need.

---

Summary:

The primary changes involve the addition of RunBuffer and RunBufferBuilder as a foundational step in improving efficiency and reducing redundancy in terminal rendering. These classes have been implemented but not yet integrated into the main rendering pipeline.