Home

📣 Welcome back! This fork has recently re-synced with the original on 2022-06-26. Changes have been made to important parts of the codebase. If you run into any problems, please check the Issues section or leave a message there.

As of a74b04b8 the manual duplex feature has been restored. Thanks for your patience!

About

Captdriver is a libre, open-source driver for Canon printers that only accept the proprietary Canon Advanced Printing Technology (CAPT) protocol and the associated compression formats. This includes many, but not all LBP Canon laser printers sold until the late 2000s.

Such printers were part of the Laser Shot or i-SENSYS range worldwide, depending on marketing region, and the Satera range in Japan. CAPT-only devices from the imageCLASS and imageRUNNER product lines have also been documented.

In CUPS terminology, captdriver acts both as a filter and a port monitor. It converts print data to a device-compatible format, while also monitoring the printer and coordinating print jobs as required by CAPT's full-time bi-directional operation.

Support for non-CAPT printers are beyond the scope of this project. CUPS has built-in support for PCL and IPP. Please check this list of other Canon printer-related projects if you have a device that uses CARPS or UFR.

Acknowledgements

This project is based on the works of Rildo Pragana, Nicolas Boichat, Benoit Bolsee, Alexey Galakhov, and Vitaliy Tomin.

Building and Installing Captdriver

This driver must be manually compiled and installed. To get started, go to the unified guide. The guide is written in a modular style to account for differences between operating systems or distros.

Also check out the Installation Examples, if it helps.

About This Fork

This fork was originally created to focus on maintaining LBP3000 support. It currently has three main goals:

1. Improve compatibility: enable use on a wider range of Linux distros and more operating systems and platforms.

   • This depends on solving a long-standing problem with the CUPS-libusb interface.

2. Enhance usability: implement missing features and make the driver truly suitable for end-users.

3. Enable automatic installation and get the driver included in mainstream distro package repositories once goals 1 & 2 are achieved.

Maintaining similarity with the original source tree is a priority.

Status

This fork has largely the same level of device support as Galakhov's original version. The driver is currently capable of handling most printing tasks but with two significant issues: the compatibility issues with the CUPS-libusb interface and long delays between pages.

Supported Devices and Hosts

The following printer-host-operating system combinations have been found to work:

• LBP2900
  • x86-64: Manjaro, Void Linux
  • ARMv7: Ubuntu 19.10, 20.04.2 LTS, 22.04
• LBP3000
  • x86-64: Debian 10.6, 10.7, Fedora 32
  • aarch64/ARMv8-A: Alpine Linux 3.12
• LBP3010
  • x86-64
    • undisclosed GNU/Linux system, probably Ubuntu, Arch Linux or Manjaro
    • FreeBSD (use the GxB branch, please see issue #20 for details)
• LBP3100/3108/3150
  • x86-64: Ubuntu Kylin (inferred, see issue #13 of the the original version)
  • Use Canon-LBP3010-3018-3050.ppd as the CUPS driver
• LBP6000/6018
  • x86-64: Kubuntu
  • Use Canon-LBP3010-3018-3050.ppd as the CUPS driver
  • Please see Issue #11 for details

All tests on ARM-based systems were run on Raspberry Pi computers.

BSD Support is currently being worked on in the GxB (GNU & BSD) branch. Please use this branch (git checkout 0.1.4.2-GxB) if you are using a BSD operating system like FreeBSD or OpenBSD.

Captdriver is not recommended for use with Fedora Silverblue or similar immutable operating systems, due to the need for manual modifications to operating system directories. A containerised version for immutable OSes has been planned.

End users with supported printers are welcome to try the driver, at their own risk. This software is licensed under the terms and conditions of the GNU General Public License, Version 3.

Wishlist

Better Reliability and Compatibility

Issues with CUPS' USB backend has been limiting compatibility to a rather narrow list of architecture-OS combinations. This issue is discussed in greater detail in the following conversations:

• https://github.com/mounaiban/captdriver/commit/18797c4c8edf916add31c09a2c527cf284021e14#r38572647
• https://github.com/mounaiban/captdriver/issues/8
• https://github.com/agalakhov/captdriver/issues/7

Finding a workaround for these compatibility problems is currently a top priority.

SCoA Support

Older devices made from the late 1990s to the early 2000s used a different compression algorithm, SCoA, which is distinct from the newer Hi-SCoA algorithm.

SCoA support is required by LBP810 and LBP1120.

While still unsupported in the original and this fork, there is an ongoing work to implement SCoA support:

• Oleg Sazonov's Fork hosts an ongoing WIP for SCoA support

• See Issue 33 and Issue 20 in the original repo for details

Please see the SCoA Specifications Page for technical information.

Miscellaneous Features

Drum cleaning, detection of service errors and Automatic Image Refinement are yet to be implemented.

Support for More Printers

The driver currently only recognises a few out of the many targeted printers. Help with widening support, adding missing features, improving reliability and testing is wanted, and would be greatly appreciated.

If you have a colour printer, your help is especially appreciated. Issue #10 is dedicated to discussions for CMYK/colour support.

Motivations

This Captdriver fork was originally created to enable printing to an LBP3000 from GNU/Linux distros like Fedora and Ubuntu. Attempts to install the original Canon driver were met with frustration; it was discovered later that support for the original driver has been lost in newer distros (Ubuntu 14.04 was the latest OS found to be compatible).

This project aims to produce a free and open-source alternative driver that will extend support for CAPT printers to newer GNU/Linux distros, more processor architectures like Arm, Power and RISC-V, and more operating systems beyond Linux (e.g. FreeBSD, OpenBSD, NetBSD).

Further Reading and Other Resources

Details of the CAPT format, including printer control protocols, status registers and compression algorithms are documented in the SPECS file. While incomplete and expected to contain errors and omissions, help with expanding it and making corrections is greatly appreciated.

Please also check out the following repositories:

• anticapt: Galakhov's original experiments in reverse-engineering Hi-SCOA compression

• Studycapt: a repository of diagnostic and miscellaneous programs for studying the CAPT protocol.