Add documentation and image formats dropdown

Author: datazuul

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to this repository
+
+## Testing
+
+Please test the application with your cameras and report success/failure under <https://github.com/datazuul/eazy-bookscanner/discussions/categories/show-and-tell>
+
+## Based on
+
+* Canon Hack Development Kit (on camera): <https://chdk.fandom.com/wiki/CHDK>
+* CHDK-PTP-Java: Our fork <https://github.com/datazuul/CHDK-PTP-Java> of <https://github.com/acamilo/CHDK-PTP-Java>
+
+## Development
+
+Development was done
+
+* JDK: OpenJDK 11.0.8
+* Build: Apache Maven 3
+* IDE: Apache NetBeans 12.1
+* Snapshot Libraries (clone them, too for local build/customization):
+
+  * CHDK-PTP-Java: <https://github.com/datazuul/CHDK-PTP-Java>
+
+Make sure source code at least compiles with `mvn clean install`.
+
+This software is based on [Apache NetBeans Platform ](http://netbeans.apache.org/kb/docs/platform/index.html).
+Main part of application is in submodule `application` and is easy to understand if you are familiar with [Swing](https://docs.oracle.com/javase/tutorial/uiswing/index.html).

README.md

@@ -1,8 +1,40 @@
-# datazuul-bookscanner
+# Eazy BookScanner
 
 OpenSource Book Scanner application for digitizing books with two cameras.
 Usage for two digital cameras like described at <http://diybookscanner.org/>.
 
-Supports:
+![Screenshot GUI Eazy BookScanner](./screenshot-20201221.jpg)
+
+## Features
+
+* Supported output image formats: JPG, TIF, PNG
+* Setup Mode: take unsaved test pictures for adjusting/exchanging left/right camera, image rotation and zoom before starting production shots with save
+* Synchronous two camera shots
+
+## Requirements
+
+* Java 1.8 or above
+
+## Supported cameras
 
 * CHDK Canon Digital cameras
+
+```
+WARNING: Using this software is at your own risk!
+
+See also https://chdk.fandom.com/wiki/FAQ:
+"CHDK comes with no warranty for any use; you use it at your own risk."
+```
+
+Successfully tested on:
+
+|Camera Vendor (Id)|Product (Id)|Operating System|Java Version|
+|-----|-----|-----|-----|
+|Canon (0x04a9)|A2200 (0x322a)|Linux (Debian GNU/Linux 10)|OpenJDK 11.0.8|
+|Canon (0x04a9)|A2200 (0x322a)|Linux (Ubuntu 20.04.1 LTS) |OpenJDK 11.0.4|
+
+Happy book scanning!
+
+## Feedback
+
+Please start discussions here: <https://github.com/datazuul/eazy-bookscanner/discussions>

core/src/main/java/com/datazuul/bookscanner/core/ThumbnailsAndScanPanel.form

@@ -66,6 +66,16 @@
             </Property>
           </Properties>
         </Component>
+        <Component class="javax.swing.JComboBox" name="formatNamesDropdown">
+          <Properties>
+            <Property name="model" type="javax.swing.ComboBoxModel" editor="org.netbeans.modules.form.editors2.ComboBoxModelEditor">
+              <StringArray count="0"/>
+            </Property>
+          </Properties>
+          <AuxValues>
+            <AuxValue name="JavaCodeGenerator_TypeParameters" type="java.lang.String" value="&lt;String&gt;"/>
+          </AuxValues>
+        </Component>
         <Component class="javax.swing.JCheckBox" name="setupModeCheckbox">
           <Properties>
             <Property name="background" type="java.awt.Color" editor="org.netbeans.beaninfo.editors.ColorEditor">
@@ -74,6 +84,7 @@
             <Property name="selected" type="boolean" value="true"/>
             <Property name="text" type="java.lang.String" value="Setup Mode"/>
             <Property name="toolTipText" type="java.lang.String" value="uncheck to start saving images into project folder"/>
+            <Property name="alignmentX" type="float" value="1.0"/>
           </Properties>
           <Events>
             <EventHandler event="stateChanged" listener="javax.swing.event.ChangeListener" parameters="javax.swing.event.ChangeEvent" handler="setupModeCheckboxStateChanged"/>

core/src/main/java/com/datazuul/bookscanner/core/ThumbnailsAndScanPanel.java

@@ -10,15 +10,20 @@
 import com.datazuul.bookscanner.core.devices.CameraFactory;
 import com.datazuul.bookscanner.core.workers.CaptureAndSaveWorker;
 import java.awt.Adjustable;
-import java.awt.Color;
 import java.awt.Component;
 import java.awt.event.AdjustmentEvent;
 import java.awt.event.AdjustmentListener;
 import java.awt.image.BufferedImage;
 import java.io.File;
+import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Iterator;
+import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import javax.imageio.ImageIO;
+import javax.imageio.ImageWriter;
+import javax.swing.DefaultComboBoxModel;
 import javax.swing.JScrollBar;
 import javax.swing.JScrollPane;
 import javax.usb.UsbDisconnectedException;
@@ -52,6 +57,16 @@ public ThumbnailsAndScanPanel() {
     initCameras();
     targetDirectory = System.getProperty("user.home"); // default
     projectDirectoryPathLabel.setText(targetDirectory);
+    
+    String[] formatNames = new String[]{"jpg", "tif", "png"};
+    List<String> supportedFormatNames = new ArrayList<>();
+    for (String formatName : formatNames) {
+      Iterator<ImageWriter> imageWritersByFormatName = ImageIO.getImageWritersByFormatName(formatName);
+      if (imageWritersByFormatName.hasNext()) {
+        supportedFormatNames.add(formatName);
+      }
+    }
+    formatNamesDropdown.setModel(new DefaultComboBoxModel(supportedFormatNames.toArray()));
 
     if (cam1 != null && cam2 != null) {
       leftCamera = cam1;
@@ -154,6 +169,7 @@ private void initComponents() {
     projectDirectoryLabel = new javax.swing.JLabel();
     chooseDirectory = new javax.swing.JButton();
     projectDirectoryPathLabel = new javax.swing.JLabel();
+    formatNamesDropdown = new javax.swing.JComboBox<>();
     setupModeCheckbox = new javax.swing.JCheckBox();
     thumbnailsScrollPane = new javax.swing.JScrollPane();
     thumbnailsContainerPanel = new javax.swing.JPanel();
@@ -190,10 +206,13 @@ public void actionPerformed(java.awt.event.ActionEvent evt) {
     projectDirectoryPathLabel.setPreferredSize(new java.awt.Dimension(500, 20));
     directoryPanel.add(projectDirectoryPathLabel);
 
+    directoryPanel.add(formatNamesDropdown);
+
     setupModeCheckbox.setBackground(new java.awt.Color(255, 255, 0));
     setupModeCheckbox.setSelected(true);
     setupModeCheckbox.setText("Setup Mode");
     setupModeCheckbox.setToolTipText("uncheck to start saving images into project folder");
+    setupModeCheckbox.setAlignmentX(1.0F);
     setupModeCheckbox.addChangeListener(new javax.swing.event.ChangeListener() {
       public void stateChanged(javax.swing.event.ChangeEvent evt) {
         setupModeCheckboxStateChanged(evt);
@@ -345,6 +364,7 @@ private void setupModeCheckboxStateChanged(javax.swing.event.ChangeEvent evt) {/
   private javax.swing.JButton chooseDirectory;
   private javax.swing.JPanel directoryPanel;
   private javax.swing.JButton exchangeScanPanelsBtn;
+  private javax.swing.JComboBox<String> formatNamesDropdown;
   private com.datazuul.bookscanner.core.ScanPanel leftScanPanel;
   private javax.swing.JPanel middlePanel;
   private javax.swing.JLabel projectDirectoryLabel;
@@ -375,8 +395,9 @@ private void shoot() {
         // create new thumbnailPanel to be filled
         ThumbnailsPanel thumbnailsPanel = new ThumbnailsPanel();
 
-        String imageFormat = "png";
-        String filenameExtension = ".png";
+        String selectedFormat = (String) formatNamesDropdown.getSelectedItem();
+        String imageFormat = selectedFormat;
+        String filenameExtension = "." + selectedFormat;
         String leftFilename = "image-" + StringUtils.leftPad(String.valueOf(leftNumber), 5, '0') + filenameExtension;
         String rightFilename = "image-" + StringUtils.leftPad(String.valueOf(rightNumber), 5, '0') + filenameExtension;