Terminal上の色のついたテキストを画像に再現するtextimgというコマンドをGoで作りました。なぜ作ったのか、と何ができるのか、について記載します。

なぜ作ったのか
使い方
実装
まとめ

なぜ作ったのか

シェル芸bot環境で色付きのテキストを画像に再現したかったからです。シェル芸bot環境にはImageMagickがインストールされています。また、テキストを画像に出力する処理を簡易にするためのimgoutというコマンドもあります。

ImageMagickで色のついたテキストを画像に変換するには、非常に複雑なオプションを組み合わせる必要があって、Twitterの文字数内では辛いものがあります。

Linux環境でテキストに色をつけるにはエスケープシーケンスを使用します。色のついたテキストを出力するコマンドもいくつかあってそれをそのまま画像に起こせたら楽しいかな、と考えたからです。

使い方

非常に単純な使用例は下記のとおりです。

textimg $'\x1b[31mRED\x1b[0m' -o out.png

red

より複雑な使用例は下記のとおりです。

seq 0 255 | while read -r i; do
  echo -ne "\x1b[48;5;${i}m$(printf %03d $i)"
  if [ $(((i+1) % 16)) -eq 0 ]; then
    echo
  fi
done | textimg -o 256_bg.png

アニメーションGIFにも対応しています。シェル芸bot環境での使用例は以下です。

https://t.co/FuYTzOOLk1 pic.twitter.com/Pvp1VZ7RLt
— シェル芸bot(停止しました) (@minyoruminyon) 2019年5月14日

使用しているコマンドのオプションの説明は以下のとおりです。

textimg -sal8 -d 6 -F 4

-s シェル芸botの画像出力先ディレクトリに画像を保存する(/images/t.gif)
-a アニメーションGIFとして画像を生成する
-l 8 1フレームの画像に何行テキストを使用するか
-d 6 アニメーションのフレームの待ちフレーム(delay)
-F 4 フォントサイズ

実装

エスケープシーケンスを含む文字列は以下のように分解・分類できる。

\x1b[1;31;42mRed foreground Green background\x[0mNormal

分解後
- \x1b[1;31;42m
  - 1 太字にする (文字装飾）
  - 31 文字色を赤にする（色変更）
  - 42 背景色を緑にする（色変更）
- Red foreground Green background (文字列)
- \x1b[0m 文字の装飾や色変更をもとに戻す (色変更)
- Normal (文字列)

このように文字列をエスケープシーケンスか、テキストかに分解し、エスケープシーケンスの中から着色に関係のある文字列か否かに分類している。

エスケープシーケンスとのマッチはそれぞれ以下の正規表現で取り出している。

色系：^\x1b\[[\d;]*m
色系以外：^\x1b\[\d*[A-HfSTJK]

画像描画では、文字列が来たときだけ画像変数にテキストを書き込み、それ以外の場合は書き込むテキストに指定する色や装飾の変更だけを行うのをひたすら繰り返すようにしている。

前述の文字列の場合は以下のような順序で処理をしています。

なにもしない(太字装飾は無視)
foregroundColor = red
backgroundColor = green
drawText("Red foreground Green background", foregroundColor, backgroundColor)
foregroundColor = defaultColor
backgroundColor = defaultColor
drawText("Normal", foregroundColor, backgroundColor)

※実装のイメージなので実際のコードの通りではないです(変数名とか)。

エスケープシーケンスなどの情報はBash tips: Colors and formatting (ANSI/VT100 Control sequences)を参考にした。

まとめ

Terminal上の色のついたテキストを画像に再現するtextimgというコマンドについて説明しました。

シェル芸bot環境に色のついたテキストを画像として再現できるようになってとても満足しています。

シェル芸botを使ってる方からもそれなりに気に入っていただけたようで、作って公開して少ししか経っていないのにスター数が一番多いリポジトリになりました。やはりそれなりに需要のあるものだったんですね。

ひとまずPNG生成できるようになって、アニメーションGIFも作れるようになってひとまず自分のほしかった機能はだいたい実装し終わりました。アップデートは何かバグが見つかったときとか、PRが来た時だけを考えています。

以上です。

次ログ

ゆるりと働いているSREの技術ブログのような何か。趣味の話も書く

Terminal上の色のついたテキストを画像に再現するコマンド(textimg)をGoで作った

なぜ作ったのか

使い方

実装

まとめ