Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement synchronized output for urwid images #80

Merged
merged 10 commits into from
Mar 6, 2023
Merged

Implement synchronized output for urwid images #80

merged 10 commits into from
Mar 6, 2023

Conversation

AnonymouX47
Copy link
Owner

@AnonymouX47 AnonymouX47 commented Mar 4, 2023 •
edited
Loading

Partially implements #79
See also: #73

  • Moves automatic image clearing into UrwidImageScreen.draw_screen().
  • Removes UrwidImageJanitor in favour of UrwidImageScreen.
  • Adds support for synchronized output to UrwidImageScreen.
    • Reduces/Eliminates image flickering/tearing on supporting terminal emulators.

@AnonymouX47
feat: Add control sequences for synced output
2eb1cab 
Refs: https://gist.github.com/christianparpart/d8a62cc1ab659194337d73e399004036
@AnonymouX47
feat: Add auto image clear to UrwidImageScreen
dbd4d8b 
- Add: Incorporate automatic image clearing into
  `UrwidImageScreen.draw_screen()`.

Seems to be a more appropriate place for the functionality.
@AnonymouX47
feat: Add synced output to UrwidImageScreen
900b987 
- Add: Implement support for terminal synchronized output in
  `UrwidImageScreen`.

Reduces/Eliminates image flickering/tearing.
@AnonymouX47 AnonymouX47 added new New feature implementation urwid Related to the urwid image widgets/canvas labels Mar 4, 2023
@AnonymouX47 AnonymouX47 added this to the 0.6.0 milestone Mar 4, 2023
@AnonymouX47 AnonymouX47 force-pushed the synced-output-urwid branch from 18e3087 to 900b987 Compare March 4, 2023 20:14
@AnonymouX47
docs: Update UrwidImageScreen docstring
2dbd0ab
@AnonymouX47
refactor: Remove UrwidImageJanitor
2f8fa25 
- Change: Retire `UrwidImageJanitor` in favour of `UrwidImageScreen`.
@AnonymouX47
test: Migrate tests for UrwidImageJanitor
4b88a0a 
- Change: Migrate tests for `UrwidImageJanitor` to `UrwidImageScreen`.
@AnonymouX47
test: Add tests for urwid screen synced output
11743e5
@AnonymouX47
refactor: Optimize UrwidImageScreen image clear
aa6c1de 
- Change: Improve shard canvas inspection by first checking if it's an
  `UrwidImageCanvas` before performing any other check or operation on
  it.
- Change: If images to be cleared include an iterm2-style image, then
  just clear all at once and skip per-widget clear for any kitty images.
@AnonymouX47
docs: Update UrwidImageScreen docstring
797661e
@AnonymouX47
chore: Update CHANGELOG for #80
8d524c6
@AnonymouX47 AnonymouX47 force-pushed the main branch 3 times, most recently from 7e13f6a to 941f3e9 Compare March 5, 2023 22:21
@AnonymouX47
Copy link
Owner Author

AnonymouX47 commented Mar 5, 2023 •
edited
Loading

@danschwarz Please, can you help test it out? 🙏🏾

@danschwarz
Copy link

Removed UrwidImageJanitor and the toot image11 branch works fine with the new code.
Testing so far:

  1. Windows Terminal - no image support, uses ANSI graphics, works fine no problems.
  2. Kitty - flicker free scrolling with the largest image sizes I've tested
  3. Wezterm - flicker free scrolling
  4. Kitty over a slower ssh link to a remote server - still no flicker

👍

@AnonymouX47
Copy link
Owner Author

That's great!

@AnonymouX47 AnonymouX47 merged commit 9cebc2d into main Mar 6, 2023
@AnonymouX47 AnonymouX47 deleted the synced-output-urwid branch March 6, 2023 02:27
AnonymouX47 added a commit that referenced this pull request Mar 26, 2023
@AnonymouX47
feat: Sync UrwidImageScreen with lock_tty()
8e360c7 
- Add: Synchronize the following I/O methods of `UrwidImageScreen`
  with `.utils.lock_tty()`:

  - `get_available_raw_input()`
  - `flush()`
  - `write()`

Refs: #73, #80
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
new New feature implementation urwid Related to the urwid image widgets/canvas
Projects
None yet
Milestone
0.6.0
Development

Successfully merging this pull request may close these issues.
2 participants
@AnonymouX47 @danschwarz