Scanner Access Now Easy

Last updated
SANE
Original author(s) David Mosberger-Tang
Andy Beck
Initial releaseNovember 27, 1996;26 years ago (1996-11-27) [1]
Stable release
1.1.1 / 19 January 2022;15 months ago (2022-01-19)
Repository
Operating system Microsoft Windows, Linux, UNIX, OS/2
License GNU GPLv2 or later [2] (frontend programs),
weakened [3] GPLv2 or later [4] (backend libraries),
Public domain [5] (SANE standard: API & network protocol) [6]
Website www.sane-project.org

Scanner Access Now Easy (SANE) is an open-source application programming interface (API) that provides standardized access to any raster image scanner hardware (flatbed scanner, handheld scanner, video- and still-cameras, frame grabbers, etc.). The SANE API is public domain. It is commonly used on Linux.

Contents

Architecture

SANE differs from TWAIN in that it is cleanly separated into "front ends" (user programs) and "back ends" (scanner drivers). Whereas a TWAIN driver handles the user interface as well as communications with the scanner hardware, a SANE driver only provides an interface with the hardware and describes a number of "options" which drive each scan. These options specify parameters such as the resolution of the scan, the scan area, colour model, etc. Each option has a name, and information about its type, units, and range or possible values (e.g., enumerated list). By convention there are several "well known" options that front ends can supply using convenient GUI interaction e.g., the scan area options can be set by dragging a rectangular outline over a preview image. Other options can be presented using GUI elements appropriate to their type e.g., sliders, drop-down lists, etc.

One consequence of this separation is that network scanning is easily implemented with no special handling in either the front ends or back ends. On a host with a scanner, the saned daemon runs and handles network requests. On client machines a "net" back end (driver) connects to the remote host to fetch the scanner options, and perform previews and scans. The saned daemon acts as a front end locally, but simply passes requests and data between the network connections and the local scanner. Similarly, the "net" back end passes requests and data between the local front end and the remote host.

Various types of unsupervised batch scanning are also possible with a minimum of support needed in the back end (driver). Many scanners support the attachment of document feeders which allow a large number of sheets of paper to be automatically scanned in succession. Using the SANE API, the front end simply has to "play back" the same set of options for each scan, driving the document feed in between scans to load the next sheet of paper. The front end only has to obtain the set of options from the user once.

Graphical user interfaces

Several user interfaces have been written to combine SANE with an easy user method of controlling it.

gscan2pdf

gscan2pdf is an interface for scanning documents to PDF on the GNOME desktop that uses SANE to communicate with the scanner. It is available under the GPL. It includes common editing tools, e.g., for rotating or cropping pages. It is also able to perform OCR using several optional OCR tools and save a searchable PDF. PDF files can be further downsampled upon saving. [7]

Simple Scan

Simple Scan (also called GNOME Document Scanner) Simple Scan (GNOME Document Scanner) 3.34.1.jpg
Simple Scan (also called GNOME Document Scanner)

Simple Scan is a simplified GUI using SANE that is intended to be easier to use and better integrate into the GNOME desktop than XSane. It was initially written for Ubuntu and is maintained by Robert Ancell of Canonical Ltd. for Linux. Simple Scan was first fielded as part of Ubuntu 10.04 Lucid Lynx and is also used in Lubuntu (until Lubuntu 18.04 LTS) and Xubuntu. It is now part of the GNOME project. [8] [9] [10] [11] [12] [13]

Skanlite

SkanLite Skanlite.png
SkanLite

Skanlite is a simple image scanning application, based on the KSane backend. Kåre Särs is the lead developer. [14] In KDE 4 Skanlite replaced Kooka of KDE 3 as default KDE scanning application. [15]

Skanlite is based on libksane, an interface provided by KDE for SANE libraries to control flatbed scanners. [16] It also works with networked scanners. [17]

SwingSane

SwingSane is a cross-platform, Java front end for SANE, written and maintained by Roland Quast. It is available for Microsoft Windows, Linux, Mac OS X and is licensed under the Apache 2.0 License. [18] The source code for the project can also be adapted for use with an existing Swing application. [19]

XSane

XSane is a graphical front end for SANE written by Oliver Rauch. It is available for Microsoft Windows, Linux, UNIX, and OS/2 and is licensed under the GNU General Public License (GPL). [20] The Windows version only allows a Windows computer to access a scanner that is attached to a Unix, OS/2 or Mac OS X network computer, but not generally to the local Windows computer. Only the "complete" sane-back-ends versions will possibly work with some scanner models connected locally. [21]

See also

Related Research Articles

<span class="mw-page-title-main">APT (software)</span> Free software package management system

Advanced package tool, or APT, is a free-software user interface that works with core libraries to handle the installation and removal of software on Debian, and Debian-based Linux distributions. APT simplifies the process of managing software on Unix-like computer systems by automating the retrieval, configuration and installation of software packages, either from precompiled files or by compiling source code.

<span class="mw-page-title-main">CUPS</span> Computer printing system

CUPS is a modular printing system for Unix-like computer operating systems which allows a computer to act as a print server. A computer running CUPS is a host that can accept print jobs from client computers, process them, and send them to the appropriate printer.

In software engineering, the terms frontend and backend refer to the separation of concerns between the presentation layer (frontend), and the data access layer (backend) of a piece of software, or the physical infrastructure or hardware. In the client–server model, the client is usually considered the frontend and the server is usually considered the backend, even when some presentation work is actually done on the server itself.

gPhoto Software

gPhoto is a set of software applications and libraries for use in digital photography. gPhoto supports not just retrieving of images from camera devices, but also upload and remote controlled configuration and capture, depending on whether the camera supports those features.

<span class="mw-page-title-main">Evince</span> Free software document viewer

Evince, also known as GNOME Document Viewer, is a free and open source document viewer supporting many document file formats including PDF, PostScript, DjVu, TIFF, XPS and DVI. It is designed for the GNOME desktop environment.

<span class="mw-page-title-main">GParted</span> Partition editor

GParted is a GTK front-end to GNU Parted and an official GNOME partition-editing application. GParted is used for creating, deleting, resizing, moving, checking, and copying disk partitions and their file systems. This is useful for creating space for new operating systems, reorganizing disk usage, copying data residing on hard disks, and mirroring one partition with another. It can also be used to format a USB drive.

<span class="mw-page-title-main">Poppler (software)</span>

Poppler is a free software utility library for rendering Portable Document Format (PDF) documents. Its development is supported by freedesktop.org. It is commonly used on Linux systems, and is used by the PDF viewers of the open source GNOME and KDE desktop environments.

<span class="mw-page-title-main">ClamTk</span> Computer antivirus software for Linux

ClamTk is a free software graphical interface for the ClamAV command line antivirus software program, for Linux desktop users. It provides both on-demand and scheduled scanning. The project was started by Dave Mauroni in February 2004 and remains under development.

<span class="mw-page-title-main">KDE Platform 4</span> Collection of software libraries and frameworks

KDE Platform 4 was a collection of libraries and software frameworks by KDE that served as technological foundation for KDE Software Compilation 4 distributed under the GNU Lesser General Public License (LGPL). KDE Platform 4 was the successor to KDElibs and the predecessor of KDE Frameworks. KDE Platform 4 is the only version of KDE Platform, and in 2013 it was replaced by KDE Frameworks 5.

HAL is a software subsystem for UNIX-like operating systems providing hardware abstraction.

<span class="mw-page-title-main">LinuxSampler</span> Music sampler

LinuxSampler is music sampler software under active development as of 2022, aiming to provide a pure software audio sampler with professional grade features comparable to both hardware and commercial software samplers, as well as to introduce new features not yet available by other samplers. Much of LinuxSampler is free software, but commercial reuse of some, such as the back-end, is restricted.

Strigi was a file indexing and file search framework adopted by KDE SC. Strigi was initiated by Jos van den Oever. Strigi's goals are to be fast, use a small amount of RAM, and use flexible backends and plug-ins. A benchmark as of January 2007 showed that Strigi is faster and uses less memory than other search systems, but it lacks many of their features. Like most desktop search systems, Strigi can extract information from files, such as the length of an audio clip, the contents of a document, or the resolution of a picture; plugins determine what filetypes it is capable of handling. Strigi uses its own Jstream system which allows for deep indexing of files. Strigi is accessible via Konqueror, or by clicking on its icon, after adding it to KDE's Kicker or GNOME Panel. The graphical user interface (GUI) is named Strigiclient.

<span class="mw-page-title-main">GIO (software)</span>

GIO is a library, designed to present programmers with a modern and usable interface to a virtual file system. It allows applications to access local and remote files with a single consistent API, which was designed "to overcome the shortcomings of GnomeVFS" and be "so good that developers prefer it over raw POSIX calls."

<span class="mw-page-title-main">Smuxi</span> IRC client

Smuxi is a cross-platform IRC client for the GNOME desktop inspired by Irssi. It pioneered the concept of separating the frontend client from the backend engine which manages connections to IRC servers inside a single graphical application.

<span class="mw-page-title-main">GNOME</span> Desktop environment for Linux and other Unix-like systems

GNOME, originally an acronym for GNU Network Object Model Environment, is a free and open-source desktop environment for Linux and other Unix-like operating systems.

<span class="mw-page-title-main">OCRFeeder</span>

OCRFeeder is an optical character recognition suite for GNOME, which also supports virtually any command-line OCR engine, such as CuneiForm, GOCR, Ocrad and Tesseract. It converts paper documents to digital document files and can serve to make them accessible to visually impaired users.

Back In Time is a backup application for Linux. It has versions that integrate favorably in GNOME and KDE SC 4 and is available directly from the repositories of many Linux distributions. Released under the terms of the GNU General Public License (GPL), it is free software.

Mir is a computer display server and, recently, a Wayland compositor for the Linux operating system that is under development by Canonical Ltd. It was planned to replace the currently used X Window System for Ubuntu; however, the plan changed and Mutter was adopted as part of GNOME Shell.

mpv (media player) Free and open-source media player software

mpv is free and open-source media player software based on MPlayer, mplayer2 and FFmpeg. It runs on several operating systems, including Unix-like operating systems and Microsoft Windows, along with having an Android port called mpv-android. It is cross-platform, running on ARM, PowerPC, x86/IA-32, x86-64, and MIPS architecture.

References

  1. History of SANE, 2001-11-20, sane-devel@lists.alioth.debian.org Mailing list, "The first entry in ChangeLog is from 1996-11-16. The first SANE standard I know is version 0.2 from 1996-11-17. SANE 0.1 seem to have been released around 1996-11-27. The first mail on sane-devel is from 1996-12-09."
  2. "license notice placed at the top in one of the source files of the project's said repository subsection, probably in each of its source files" . Retrieved November 26, 2017. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.[ permanent dead link ]
  3. "sane/sane-backends - SANE backends - scanner drivers" . Retrieved November 27, 2017.[ permanent dead link ]
  4. "license notice placed at the top in one of the source files of the project's said repository subsection, applies to most of its source files, some are set up like most, but without linking exception or with additional license constrains" . Retrieved November 26, 2017. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. ...  As a special exception, the authors of SANE give permission for additional uses of the libraries contained in this release of SANE. The exception is that, if you link a SANE library with other files to produce an executable, this does not by itself cause the resulting executable to be covered by the GNU General Public License. Your use of that executable is in no way restricted on account of linking the SANE library code into it. This exception does not, however, invalidate any other reasons why the executable file might be covered by the GNU General Public License. If you submit changes to SANE to the maintainers to be included in a subsequent release, you agree by submitting the changes that those changes may be distributed with this exception intact. If you write modifications of your own for SANE, it is your choice whether to permit this exception to apply to your modifications. If you do not wish that, delete this exception notice. This file implements a dynamic linking based SANE meta backend. It allows managing an arbitrary number of SANE backends by using dynamic linking to load backends on demand.[ permanent dead link ]
  5. "license notice file placed in project's repository root section" . Retrieved November 26, 2017. The standard is considered to be in the public domain. Anyone is free to implement SANE interface conforming applications or libraries in any way...[ permanent dead link ]
  6. "license notice file placed in project's repository root section" . Retrieved November 26, 2017. SANE consists of three parts each of which has its own licensing terms: * The frontend programs. These programs are generally protected by the GNU General Public License. (See file COPYING.) * The backend libraries. Most backend libraries are protected by the GNU General Public License (see file COPYING), but as an exception, it is permissible to link against such a library without affecting the licensing status of the program that uses the libraries. ... Note that not all of the backends apply the exception and that some have additional licensing constraints. ... * The SANE API and network protocol as put forth in the standard document. The standard is considered to be in the public domain. Anyone is free to implement SANE interface conforming applications or libraries in any way ...[ permanent dead link ]
  7. gscan2pdf (n.d.). "gscan2pdf - A GUI to produce PDFs or DjVus from scanned documents" . Retrieved 27 September 2011.
  8. Ancell, Robert (May 2010). "Simple Scan" . Retrieved 4 June 2010.
  9. Canonical Ltd. (2012). "Simple Scan Development Team" . Retrieved 8 March 2012.
  10. Canonical Ltd. (2012). "Packages by project series" . Retrieved 8 March 2012.
  11. UbuntuUpdates.org (April 2010). "Package simple-scan". Archived from the original on 26 July 2011. Retrieved 4 June 2010.
  12. OMG! Ubuntu! (December 2009). "Lucid to Get Scanning Tool "Simple Scan"" . Retrieved 4 June 2010.
  13. GNOME (21 March 2020). "Document Scanner". gitlab.gnome.org. Archived from the original on 25 October 2019. Retrieved 21 March 2020.
  14. Skanlite, Kde.org, retrieved 2012-08-23
  15. Kooka, Userbase.kde.org, 2012-06-10, retrieved 2012-08-23
  16. Skanlite handbook, Docs.kde.org, 2011-11-29, retrieved 2012-08-23
  17. Skanlite, Docs.kde.org, 2011-11-29, retrieved 2012-08-23
  18. Quast, Roland (February 2015). "SwingSane - graphical scanning frontend" . Retrieved 19 February 2015.
  19. Quast, Roland (n.d.). "SwingSane project files". GitHub . Retrieved 19 February 2015.
  20. Rauch, Oliver (February 2009). "XSane - graphical scanning frontend" . Retrieved 1 August 2019.
  21. Rauch, Oliver. "XSane WIN32 version". Archived from the original on 22 August 2017. Retrieved 24 October 2010.