Scanner Access Now Easy
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.
Original author(s) | David Mosberger-Tang Andy Beck |
---|---|
Initial release | November 27, 1996[1] |
Stable release | 1.1.1
/ 19 January 2022 |
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 |
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 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 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
- Image and Scanner Interface Specification (ISIS) – Open industry standard interface
- TWAIN – Software API for local drivers that are bundled with control GUI
- Windows Image Acquisition (WIA) – Proprietary API from Microsoft
References
- 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."
- "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.
- "sane/sane-backends - SANE backends - scanner drivers". Retrieved November 27, 2017.
- "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.
- "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...
- "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 ...
- gscan2pdf (n.d.). "gscan2pdf - A GUI to produce PDFs or DjVus from scanned documents". Retrieved 27 September 2011.
- Ancell, Robert (May 2010). "Simple Scan". Retrieved 4 June 2010.
- Canonical Ltd. (2012). "Simple Scan Development Team". Retrieved 8 March 2012.
- Canonical Ltd. (2012). "Packages by project series". Retrieved 8 March 2012.
- UbuntuUpdates.org (April 2010). "Package simple-scan". Archived from the original on 26 July 2011. Retrieved 4 June 2010.
- OMG! Ubuntu! (December 2009). "Lucid to Get Scanning Tool "Simple Scan"". Retrieved 4 June 2010.
- GNOME (21 March 2020). "Document Scanner". gitlab.gnome.org. Archived from the original on 25 October 2019. Retrieved 21 March 2020.
- Skanlite, Kde.org, retrieved 2012-08-23
- Kooka, Userbase.kde.org, 2012-06-10, retrieved 2012-08-23
- Skanlite handbook, Docs.kde.org, 2011-11-29, retrieved 2012-08-23
- Skanlite, Docs.kde.org, 2011-11-29, retrieved 2012-08-23
- Quast, Roland (February 2015). "SwingSane - graphical scanning frontend". Retrieved 19 February 2015.
- Quast, Roland (n.d.). "SwingSane project files". GitHub. Retrieved 19 February 2015.
- Rauch, Oliver (February 2009). "XSane - graphical scanning frontend". Retrieved 1 August 2019.
- Rauch, Oliver. "XSane WIN32 version". Archived from the original on 22 August 2017. Retrieved 24 October 2010.