sixelcrop's Introduction

sixelcrop

Crop sixel images in sixel-space!

sixelcrop is a Python library and command line tool to crop sixel images

Installation

pipx install sixelcrop
# OR
pip install sixelcrop

Usage

Command Line

usage: sixelcrop [--help] [-x int] [-y int] [-w int] [-h int] [--no-private-colors] Path

Crop a sixel image in sixel space

positional arguments:
  Path                  Path to sixel image file (use '-' to read data from standard input)

options:
  --help
  -x int, --left int    The offset of the left edge of the target region
  -y int, --top int     The offset of the top edge of the target region
  -w int, --width int   The width of the target region
  -h int, --height int  The height of the target region
  --no-private-colors   Do not use private colors for each graphic

Example:

curl https://www.python.org/static/img/[email protected] | img2sixel | sixelcrop -x 10 -y 15 -w 120 -h 125 -

Python API

import sys
from sixelcrop import sixelcrop

with open("snake.six") as f:
    data = f.read()

sys.stdout.write(sixelcrop(data, x=300, y=50, w=200, h=150))

License

sixelcrop is distributed under the terms of the MIT license.

sixelcrop's People

Contributors

Stargazers

Watchers

sixelcrop's Issues

issues with sixel not from libsixel

I just tested your lib with various inputs - works pretty nice with images coming from img2sixel.

Still I think you make some assumptions about the sixel layout, that are not strictly given by the format:

Colors get scrambled, when running with --high-color switch of img2sixel. Background here - color registers may change at any time again. The question where to apply which color is typically bound to indexed (terminal mode) vs. immediately coloring (printer mode). Most terminals as of today do the printer mode here, only older ones (vt340, xterm) do the real shared palette indexed thing.
Most of older sixels here dont work out of the box. It seems that I can get most working by setting an explicit height argument. Some still fail due to rigged right side of sixel bands though. In general sixel is a canvas print protocol, thus you cannot expect width/height to be set upfront and all bands to fullfill the correct width, instead you'd have to trace the cursor movements with its pixel coloring for the area of interest. (The size assumptions you made here are more a result of how the libsixel encoder typically shapes things, but that not required by the format spec.)