Compust

Site do projeto e documentação

Compust é um compositor independente para X11, escrito em Rust, ainda experimental, voltado ao Xorg e ao XLibre. A proposta é construir uma alternativa pequena e compreensível ao picom, com animações suaves, desfoque de fundo e transparência.

O compositor combina as janelas dos aplicativos para formar a imagem final da área de trabalho. O Compust funciona sobre um servidor X já em execução, junto ao seu gerenciador de janelas. Ele não inicia nem substitui o Xorg/XLibre, não organiza as janelas e não oferece uma sessão Wayland nativa.

Estado atual: quinta beta, versão 0.3.0-beta.2, para testes controlados. Testes automatizados de pixels rodam no Xvfb, e há sessões registradas em três máquinas. Um desktop AMD com gráficos Radeon Vega e Xorg rodou o código desta beta, com i3 e nas verificações de recursos dos dois renderizadores; um desktop AMD com Radeon RX 9060 XT e XLibre rodou a 0.3.0-beta.1 com cinco gerenciadores de janelas, e um laptop Intel com Xorg rodou as betas anteriores. Outros drivers, servidores e gerenciadores de janelas ainda precisam de testes da comunidade. Seus recursos e desempenho são documentados apenas para as cargas e os ambientes registrados. O guia da beta explica como instalar, voltar ao compositor anterior e relatar problemas. Os marcos abaixo mostram o que está pronto, e o marco 1.0 do roteiro de desenvolvimento define o que uma versão estável ainda exige. Seu estado e prioridades ordenam o que vem a seguir.

Marcos e ambientes verificados

Cada linha leva ao seu registro.

A maioria das sessões em hardware usa as janelas sintéticas do probe em vez de aplicativos. O laptop Intel e as sessões XLibre do desktop com Radeon Vega foram registrados antes do trabalho de renderização; desde então, esse desktop foi registrado no Xorg com o main. Sombras, regras de foco controlado e suspensão em tela cheia agora têm um registro de cenas fixas nos dois pintores na RX 9060 XT sem gerenciador de janelas; os outros casos de regras têm testes automatizados. Monitores com taxas diferentes foram conferidos com HDMI-1 a 60 Hz e DP-2 a 180 Hz em XRender e GL. O desfoque ponderado também foi conferido visualmente nos menus do Brave. Drivers NVIDIA, XLibre com Intel, outros gerenciadores de janelas, mais de dois monitores e HDR não foram testados. A matriz de compatibilidade traz as versões e os limites de cada registro.

O que já funciona

A abertura e o fechamento de janelas usam uma transição de opacidade com curva smoothstep, inclusive quando uma janela é fechada durante a animação de abertura. A transparência combina o conteúdo ARGB do aplicativo, _NET_WM_WINDOW_OPACITY e a opacidade global configurada. Janelas translúcidas podem desfocar o conteúdo atrás delas. O desfoque reduz repetidamente pela metade a área atrás da janela com amostragem bilinear e depois a amplia de volta, operações que servidores com aceleração por GPU mantêm na GPU. As janelas podem projetar sombras suaves, que ficam desligadas até que shadow_radius seja definido. Seus cantos podem ser arredondados, junto com as sombras e o desfoque atrás delas, quando corner_radius é definido. Regras por janela definem a opacidade, o desfoque, a duração do fade e a sombra das janelas escolhidas por classe, tipo, título ou foco.

O Compust acompanha empilhamento, movimento, redimensionamento, formato das janelas, atualizações de conteúdo e pixmaps de papel de parede. Os pixmaps nomeados são preservados durante a animação de fechamento. A janela de composição tem região de entrada vazia, permitindo que os cliques cheguem aos aplicativos. Um compositor existente nunca é substituído automaticamente.

“Suporte moderno a X11” é um objetivo incremental de compatibilidade, não uma promessa de implementar todas as extensões. A disponibilidade de Present não comprova ausência de tearing em todos os drivers. A cópia direta com XRender não é sincronizada com o intervalo vertical do monitor.

Se um envio Present for rejeitado com BadMatch e os buffers originais de renderização continuarem válidos, o Compust registra um aviso e usa cópia direta via XRender até reiniciar. Após uma mudança RandR, o Compust recria seus buffers sem esperar por uma apresentação pendente, porque uma reconfiguração de monitores em hardware AMD descartou os eventos de conclusão dela. Se o Present não informar nada sobre um envio em um segundo, o Compust também recria seus buffers e repinta, para que uma notificação perdida não congele a tela. O servidor ainda pode exibir depois um envio dos buffers substituídos, até mesmo após o quadro novo; quando ele informa um, o Compust exibe de novo seu quadro atual. Os demais erros de protocolo mantêm seus tratamentos existentes.

Instalação

O Open Build Service gera pacotes x86_64 para Debian, Ubuntu, Linux Mint, Fedora e openSUSE Tumbleweed a partir da pré-versão 0.3.0-beta.2, e roda a suíte de testes em cada build. As notas de empacotamento dizem qual é o snapshot. O pacote instala apenas o programa compust e a documentação dele: nenhuma entrada de inicialização automática e nenhuma alteração na configuração do seu desktop.

Arch Linux e derivados

Ainda não há pacote para Arch, então compile a partir do código-fonte. Os mesmos comandos valem para derivados que usam pacman, como CachyOS, EndeavourOS e Manjaro.

sudo pacman -S --needed git rust
git clone https://github.com/hashdefault/compust.git
cd compust
cargo build --release --locked
sudo install -Dm755 target/release/compust /usr/local/bin/compust

O pacote rust do Arch é mais novo que o 1.95 exigido. Se você usa rustup em vez desse pacote, o Cargo usa o toolchain 1.95.0 fixado pelo repositório. Para atualizar depois, rode git pull e repita os dois últimos comandos.

Debian, Ubuntu e Linux Mint

Um único repositório serve aos três. O pacote é gerado no Debian 13 e só precisa da glibc 2.34; ele foi instalado no Debian 13, no Ubuntu 22.04 e 24.04 e no Linux Mint 22.

sudo apt install curl gnupg
sudo install -d -m 0755 /etc/apt/keyrings
curl -fsSL https://download.opensuse.org/repositories/home:hashdefault/Debian_13/Release.key | gpg --dearmor | sudo tee /etc/apt/keyrings/compust.gpg > /dev/null
echo 'deb [signed-by=/etc/apt/keyrings/compust.gpg] https://download.opensuse.org/repositories/home:/hashdefault/Debian_13/ /' | sudo tee /etc/apt/sources.list.d/compust.list
sudo apt update
sudo apt install compust

O repositório se chama Debian_13 também no Ubuntu e no Mint.

Fedora e derivados

Há repositórios para o Fedora 43 e o 44. rpm -E %fedora mostra o número da sua versão, então o comando escolhe o repositório correspondente. Derivados que usam dnf e se baseiam nessas versões devem funcionar da mesma forma; eles não foram testados.

sudo dnf config-manager addrepo --from-repofile="https://download.opensuse.org/repositories/home:/hashdefault/Fedora_$(rpm -E %fedora)/home:hashdefault.repo"
sudo dnf install compust

openSUSE Tumbleweed

sudo zypper addrepo https://download.opensuse.org/repositories/home:/hashdefault/openSUSE_Tumbleweed/home:hashdefault.repo
sudo zypper refresh
sudo zypper install compust

Depois de instalar

Confira o servidor e inicie o Compust na sua sessão X11, depois de encerrar o compositor que já atende aquela tela:

compust --diagnose
compust

Para partir da configuração de exemplo, copie compust.example.toml para ~/.config/compust/compust.toml. O arquivo está no repositório, e os pacotes o instalam em /usr/share/doc; dpkg -L compust ou rpm -ql compust mostra onde. A seção Configuração descreve as opções, e o guia da beta explica como voltar ao compositor anterior e relatar problemas.

Compilar e executar

Você precisa de Linux, Rust 1.95.0 (selecionado pelo arquivo de toolchain), Cargo, um linker C e um servidor X com as extensões obrigatórias. Se usa rustup, confira se ~/.cargo/bin está no PATH. A conexão X11 usa a implementação Rust do x11rb; não é necessário instalar cabeçalhos de desenvolvimento da Xlib. Quem for testar a beta pode baixar um binário verificado, como explica o guia da beta.

git clone https://github.com/hashdefault/compust.git
cd compust
cargo build --release --locked
./target/release/compust --help
./target/release/compust --diagnose
./target/release/compust --config compust.example.toml

Execute na sua sessão X11 depois de encerrar o compositor que atende aquela tela. --diagnose apenas consulta as extensões e pode ser executado com outro compositor ativo. Use --display :1 para escolher outro servidor; sem essa opção, são usados DISPLAY e a autenticação Xauthority habitual. Encerre com Ctrl+C ou SIGTERM. O Compust não instala inicialização automática nem modifica a configuração da área de trabalho.

Para experimentar de forma isolada, inicie um servidor aninhado e execute o Compust e um aplicativo X11 nesse display:

Xephyr :99 -screen 1280x720 -ac -nolisten tcp &
DISPLAY=:99 ./target/release/compust --config compust.example.toml
# Em outro terminal:
DISPLAY=:99 xterm

Escolha um número de display livre. O exemplo desativa a autenticação apenas no servidor local de teste e não abre uma porta TCP. Xephyr e xterm são pacotes separados. A suíte automatizada usa Xvfb e escolhe os números de display automaticamente.

Configuração

O arquivo de exemplo contém todas as opções. Sem --config, o Compust lê o primeiro compust/compust.toml que encontrar em $XDG_CONFIG_HOME (por padrão ~/.config) e depois em cada diretório de $XDG_CONFIG_DIRS (por padrão /etc/xdg); se não houver arquivo, valem os padrões internos. Campos desconhecidos e valores fora do intervalo geram erro antes da conexão com o X11.

O Compust recarrega a configuração sem reiniciar quando o arquivo é salvo, depois que ele fica um décimo de segundo sem mudar, e ao receber SIGUSR1, por exemplo com pkill -USR1 -x compust; a 0.3.0-beta.1 recarrega apenas com SIGUSR1. Ele observa os diretórios dos arquivos que leria e o arquivo para o qual um link simbólico aponta, então editores que salvam substituindo o arquivo também o recarregam. Um diretório de configuração criado depois que o Compust inicia é lido com SIGUSR1 ou numa reinicialização. A recarga lê o mesmo arquivo que uma reinicialização leria. Se esse arquivo não puder ser lido ou for inválido, o Compust registra um aviso e mantém as opções atuais. opacity, max_fps, unredirect_fullscreen, as opções de sombra e a opacidade, o desfoque e a sombra dados por regras valem a partir do próximo quadro, também para janelas já abertas. Um novo fade_ms, global ou em uma regra, vale para toda abertura e todo fechamento iniciados depois, inclusive de janelas já abertas; fades em andamento terminam com a duração anterior. Uma mudança em blur_radius, vsync ou backend substitui o renderizador assim que o quadro em apresentação termina.

opacity = 100
fade_ms = 180
blur_radius = 4
shadow_radius = 0
shadow_offset_x = 0
shadow_offset_y = 0
shadow_opacity = 50
corner_radius = 0
max_fps = 120
vsync = true
backend = "xrender"
unredirect_fullscreen = false

O desfoque é aplicado atrás de janelas translúcidas ou ARGB, com a força com que cada pixel da janela é opaco: a margem transparente de sombra em volta do menu de um navegador quase não recebe desfoque, e o desfoque surge e some com a janela. Se o servidor não oferecer filtragem bilinear, o Compust registra um aviso e continua sem desfoque. max_fps não força redesenhos quando nada muda; o loop de eventos acorda no máximo uma vez por segundo durante a inatividade para observar sinais de encerramento e de recarga.

Sombras

As sombras chegaram na 0.3.0-beta.2; a 0.3.0-beta.1 rejeita essas opções. Com shadow_radius acima de zero, as janelas projetam uma sombra preta: o retângulo da janela, deslocado pelo offset e desfocado até sumir ao longo do raio. A sombra fica em volta da janela, nunca embaixo dela, de modo que uma janela translúcida não escurece por causa da própria sombra, e ela surge e some com a janela.

Uma janela projeta sombra quando seu tipo é normal, dialog, utility, splash ou toolbar. Desktops, docks, menus, dicas de ferramenta, notificações, caixas de combinação e ícones de arrastar não projetam. Também não projeta a janela que não declara tipo e que o gerenciador de janelas não controla, como uma barra de status ou o menu de um toolkit antigo, nem a que declara em _GTK_FRAME_EXTENTS margens para uma sombra própria, como fazem as janelas GTK com decoração do lado do cliente. shadow em uma regra decide para as janelas que ela escolhe, nos dois sentidos. Uma janela com formato não retangular nunca projeta sombra, porque a sombra seria a do seu retângulo envolvente.

Em um gerenciador de janelas tiling, a sombra de cada janela cai sobre as vizinhas. Uma regra com window_type = "normal" e shadow = false deixa as sombras para diálogos e outras janelas flutuantes que declaram seu tipo.

Cantos arredondados

Os cantos arredondados chegaram na 0.3.0-beta.2; a 0.3.0-beta.1 rejeita a opção. Com corner_radius acima de zero, as janelas que projetam sombra têm os cantos arredondados com esse raio, suavizados em cada pixel que um arco cruza, e suas sombras e o desfoque atrás delas acompanham os arcos. Menus, dicas de ferramenta, docks, desktops e notificações continuam quadrados, assim como uma janela que reserva margens para a própria decoração em _GTK_FRAME_EXTENTS, uma janela com formato próprio e uma janela que o gerenciador de janelas mostra em tela cheia em _NET_WM_STATE, à qual a suspensão da composição em tela cheia continua se aplicando. O corner_radius de uma regra arredonda ou deixa quadradas as janelas que ela escolhe, seja qual for o tipo delas, e um raio nunca passa da metade do lado menor de uma janela.

corner_radius = 10

# Terminais quadrados.
[[rules]]
wm_class = "Alacritty"
corner_radius = 0

A borda X que um gerenciador de janelas como o Xmonad desenha acompanha os dois arcos dos cantos: o arco interno recua pela largura da borda. Nos cantos, o Compust usa como cor o pixel da borda no canto superior esquerdo da janela, preservando uma borda X uniforme. Um gerenciador que pinta cores diferentes em cada lado não consegue preservar todas essas cores nos cantos. Com um gerenciador de janelas lado a lado, os cantos de cada janela mostram o que está abaixo deles; uma regra com window_type = "normal" e corner_radius = 0 mantém quadradas as janelas lado a lado.

Suspensão da composição em tela cheia

Com unredirect_fullscreen = true, o Compust para de compor enquanto uma janela esconde todo o resto: a janela do topo, quando é opaca, não tem formato nem cantos arredondados e cobre a tela inteira. As janelas passam a desenhar direto na tela, como sem compositor, o que poupa a um jogo ou vídeo em tela cheia a cópia feita pelo Compust. A composição volta assim que isso deixa de valer: outra janela aparece acima dela, como um menu ou uma notificação, ou ela se move, encolhe, fica translúcida ou fecha. Sombras, desfoque e fades voltam junto.

Um único overlay cobre todos os monitores; por isso, com vários monitores, uma janela que ocupa um deles não cobre a tela e continua composta. Como as sombras, esta opção chegou na 0.3.0-beta.2.

Regras por janela

Cada tabela [[rules]] escolhe janelas e muda opções para elas. As regras vêm depois das opções globais, porque o TOML coloca toda tabela depois das chaves simples.

# Terminais com 90% de opacidade.
[[rules]]
wm_class = "Alacritty"
opacity = 90

# Dicas de ferramenta sem desfoque atrás e sem fades.
[[rules]]
window_type = "tooltip"
blur = false
fade_ms = 0

# Notificações com sombra, que o tipo delas deixaria de fora.
[[rules]]
window_type = "notification"
shadow = true

# Janelas que não são a ativa com 85% de opacidade.
[[rules]]
window_type = "normal"
focused = false
opacity = 85

Uma regra precisa de ao menos um dos quatro primeiros campos, que escolhem janelas, e de ao menos um dos cinco últimos, que ela define. O texto precisa ser idêntico, inclusive em maiúsculas e minúsculas, e a janela precisa corresponder a todos os campos pelos quais a regra escolhe. Cada opção vem da primeira regra correspondente que a define, então regras específicas vêm antes das amplas; assim, true em uma regra mantém o desfoque de janelas para as quais uma regra posterior o desliga. Rode xprop e clique em uma janela para ver seus WM_CLASS, _NET_WM_WINDOW_TYPE e _NET_WM_NAME.

O Compust lê essas propriedades da janela do aplicativo, dentro da moldura do gerenciador de janelas, e as lê de novo quando mudam, como quando um título muda. Uma janela que não declara nenhum tipo conhecido pelo Compust é dialog quando é transitória para outra janela e o gerenciador de janelas a controla, e normal nos demais casos, como determina a EWMH. Uma propriedade ausente ou malformada não corresponde a nenhum texto. Uma janela em fechamento mantém as regras que tinha enquanto o fade termina.

focused acompanha o _NET_ACTIVE_WINDOW da raiz, no qual o gerenciador de janelas indica a janela de aplicativo ativa; a moldura em volta dessa janela recebe o foco junto com ela. Uma regra com focused = false também corresponde a menus, dicas de ferramenta e docks, então uma regra feita para esmaecer janelas inativas costuma trazer também window_type = "normal". Em um gerenciador de janelas que não define essa propriedade, toda janela conta como focada, e uma regra assim não muda nada. Openbox 3.6.1, i3 4.25.1, bspwm 0.9.12 e dwm 6.8 a definem; o Xmonad 0.18.1 só a define com XMonad.Hooks.EwmhDesktops. Como as sombras, focused está no main e entra na próxima beta.

./target/release/compust --check-config --config compust.example.toml
./target/release/compust --check-config  # informa qual arquivo seria lido
RUST_LOG=compust=debug ./target/release/compust

Testes e contribuições

Instale Xvfb (xvfb no Debian/Ubuntu, xorg-server-xvfb no Arch) e execute:

cargo fmt --all -- --check
cargo clippy --locked --workspace --all-targets --all-features -- -D warnings
cargo test --locked --workspace

Cada cenário de integração inicia seu próprio Xvfb e um processo real do Compust. Os testes observam os pixels renderizados e o protocolo, sem simular o servidor. Use XVFB=/caminho/para/Xvfb para indicar outro executável. COMPUST_ARTIFACTS=artifacts cargo test --test x11 salva algumas cenas em PPM para inspeção. Os testes do crate de GPU desenham no dispositivo EGL de software do Mesa e são pulados sem ele; COMPUST_GPU_TESTS=1, como na CI, transforma isso em falha. COMPUST_GPU_DISPLAY=:0 cargo test --test gpu confere o compartilhamento por DRI3 com a GPU de um servidor real usando apenas pixmaps fora da tela.

Contribuições em português brasileiro ou inglês são bem-vindas. Comece pelo guia de contribuição, pela arquitetura ou pelo roteiro. Relatos sobre drivers, falhas reproduzíveis, documentação e medições de desempenho também ajudam.

Limitações atuais

O protótipo repinta apenas a área da tela que mudou, e cada janela desfocada guarda seu fundo desfocado até que algo abaixo dela mude, o que a desfoca de novo em toda a sua área de alcance. No desktop AMD/XLibre registrado, uma janela translúcida em tela cheia com desfoque manteve 60 quadros por segundo enquanto o Xorg usava cerca de 4% de um núcleo. Janelas escondidas atrás de janelas opacas não são pintadas. O renderizador de GPU opcional (registrado em um desktop) desenha os mesmos quadros que o XRender com diferença de até dois níveis de cor, com CPU total parecida ali, maior quando janelas são redimensionadas, e cerca de 62 MiB a mais de memória para o driver GL. O marco de renderização mediu esses custos; seus primeiros registros registram cargas do Compust em uma máquina antes das mudanças na repintura; os registros seguintes medem suas próprias mudanças de renderização. As sombras são pretas, e janelas com formato não projetam nenhuma; seus pixels, regras de foco e suspensão em tela cheia estão registrados em uma tela AMD/XLibre nos dois pintores. A suspensão da composição em tela cheia exige uma janela sobre a raiz inteira, então nunca vale para um monitor entre vários. Esse registro usa janelas sintéticas; aplicativos reais em tela cheia ainda precisam de validação. Não há cantos arredondados, animações de movimento ou escala nem compatibilidade com arquivos do picom.

O marco planejado de Animações de janelas no roteiro amplia o fade existente com pop, slide e curvas, escolhidos por janela; o binário atual não aceita seus exemplos de configuração. Os cantos arredondados, primeiras tarefas do marco de Cantos arredondados, chegaram na 0.3.0-beta.2; os dois renderizadores os desenham na tela AMD/Xorg registrada. O marco planejado de Opacidade de janelas ativas e inativas acrescenta opções globais para a opacidade e o escurecimento das janelas ativas e inativas, que as regras pelo foco já aproximam, e suaviza a opacidade quando o foco muda; o binário atual não aceita suas opções.

Um processo atende uma tela X; uma raiz com vários monitores é composta como uma única superfície. Agendamento independente por monitor, HDR/gerenciamento de cores, VRR, importação DMA-BUF, sincronização explícita e extensões exclusivas do XLibre não estão implementados ou certificados. O hotplug físico foi verificado apenas no desktop AMD/XLibre registrado e no laptop Intel/Xorg registrado. Wayland nativo está fora do escopo atual.

Contexto e licença

O projeto se inspira no modelo de compositor independente do picom, cuja origem inclui o Compton. O picom já oferece animações e efeitos; a contribuição pretendida pelo Compust é uma implementação acessível em Rust, com melhorias medidas ao longo do desenvolvimento. Este repositório contém uma implementação nova, não uma tradução do código do picom.

Referências: x11rb, compositores na especificação EWMH e XLibre. Licença MIT.