toApcSequence method

String toApcSequence({
  1. int chunkSize = 4096,
  2. bool compress = false,
})

Encodes the Kitty Graphics APC upload (a=t,f=...) and virtual placement (a=p,U=1) sequences for CLI terminals.

When compress is true (and format is 32), the RGBA payload is compressed with zlib (o=z). chunkSize must be a positive multiple of 4.

Implementation

String toApcSequence({int chunkSize = 4096, bool compress = false}) {
  if (chunkSize <= 0 || chunkSize % 4 != 0) {
    throw ArgumentError.value(
      chunkSize,
      'chunkSize',
      'must be a positive multiple of 4',
    );
  }
  final useZlib = compress && format == 32;
  final bytesToSend = useZlib
      ? Uint8List.fromList(zlib.encode(rgbaPixels))
      : rgbaPixels;
  final encoded = base64Encode(bytesToSend);
  final compFlag = useZlib ? ',o=z' : '';
  final header =
      'a=t,f=$format$compFlag,s=$pixelWidth,v=$pixelHeight,i=$imageId,q=2';

  final sb = StringBuffer();
  _writeApcChunks(sb, header, encoded, chunkSize);
  sb.write('\x1b_Ga=p,U=1,i=$imageId,c=$gridCols,r=$gridRows,q=2\x1b\\');
  return sb.toString();
}