GLCanvas Printing WIP - Add TestTiledPrintingGearsAWT

3 files changed, 340 insertions, 31 deletions

diff --git a/src/jogl/classes/com/jogamp/opengl/util/RandomTileRenderer.java b/src/jogl/classes/com/jogamp/opengl/util/RandomTileRenderer.java
index 4fcf0b6cc..be73ec4d5 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/RandomTileRenderer.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/RandomTileRenderer.java
@@ -74,9 +74,10 @@ public class RandomTileRenderer extends TileRendererBase {
      * @throws IllegalArgumentException is tile x/y are < 0 or tile size is <= 0x0                              
      */
     public void setTileRect(int tX, int tY, int tWidth, int tHeight) throws IllegalStateException, IllegalArgumentException {
+        /** FIXME 
         if( 0 > tX || 0 > tX ) {
             throw new IllegalArgumentException("Tile pos must be >= 0/0");        
-        }
+        } */
         if( 0 >= tWidth || 0 >= tHeight ) {
             throw new IllegalArgumentException("Tile size must be > 0x0");        
         }
diff --git a/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java b/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java
index 4f3f1a8bb..4cf3807c4 100644
--- a/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java
+++ b/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java
@@ -704,7 +704,7 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
             System.err.println("GLCanvas.sizeChanged: ("+getThreadName()+"): "+width+"x"+height+" - surfaceHandle 0x"+Long.toHexString(nsH));
             // Thread.dumpStack();
         }            
-        if( validateGLDrawable() ) {
+        if( validateGLDrawable() && !printActive ) {
             final GLDrawableImpl _drawable = drawable;
             if( ! _drawable.getChosenGLCapabilities().isOnscreen() ) {
                 final RecursiveLock _lock = lock;
@@ -740,20 +740,23 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
       }
       return singleAWTGLPixelBufferProvider;
   }
-  private boolean animatorPaused = false;
-  private RandomTileRenderer tileRenderer;
+  private boolean printActive = false;
+  private boolean printAnimatorPaused = false;
+  private RandomTileRenderer printRenderer;
   private Graphics2D printGraphics;
   private int printWidth = 0;
   private int printHeight = 0;
-  public void setupPrint (final int printWidth, final int printHeight) {
-      this.printWidth = printWidth;
-      this.printHeight = printHeight;      
+  public void setupPrint (final double scaleX, final double scaleY) {
+      printActive = true;
+      // this.printWidth = scaleX;
+      // this.printHeight = scaleY;      
   }  
   private void initPrint() {
+      printActive = true;
       final GLAnimatorControl animator =  helper.getAnimator();
       if( animator.isAnimating() ) {
           animator.pause();
-          animatorPaused = true;
+          printAnimatorPaused = true;
       }
       if( 0 >= printWidth ) {
           printWidth = getWidth();
@@ -761,7 +764,9 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
       if( 0 >= printHeight ) {
           printHeight = getHeight();
       }
-      System.err.println("AWT print.init: "+printWidth+"x"+printHeight+", animatorPaused "+animatorPaused);
+      System.err.println("AWT print.init: printSize "+printWidth+"x"+printHeight+", canvasSize "+getWidth()+"x"+getWidth()+
+                         ", drawableSize "+drawable.getWidth()+"x"+drawable.getHeight()+
+                         ", animatorPaused "+printAnimatorPaused);
       {
           final RenderingHints rHints = printGraphics.getRenderingHints();
           final Set<Entry<Object, Object>> rEntries = rHints.entrySet();
@@ -777,9 +782,9 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
       System.err.println(" move "+aTrans.getTranslateX()+" x "+aTrans.getTranslateY());
       
       final SingleAWTGLPixelBufferProvider printBufferProvider = getSingleAWTGLPixelBufferProvider();     
-      tileRenderer = new RandomTileRenderer();
-      tileRenderer.setImageSize(printWidth, printHeight);
-      tileRenderer.attachToAutoDrawable(this);      
+      printRenderer = new RandomTileRenderer();
+      printRenderer.setImageSize(printWidth, printHeight);
+      printRenderer.attachToAutoDrawable(this);      
       final int componentCount;
       if( isOpaque() ) {
           // w/o alpha
@@ -799,8 +804,8 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
           public void display(GLAutoDrawable drawable) {
               final GL gl = drawable.getGL();
               final GLPixelAttributes pixelAttribs = printBufferProvider.getAttributes(gl, componentCount);
-              final int tileWidth = tileRenderer.getParam(TileRendererBase.TR_CURRENT_TILE_WIDTH);
-              final int tileHeight = tileRenderer.getParam(TileRendererBase.TR_CURRENT_TILE_HEIGHT);
+              final int tileWidth = printRenderer.getParam(TileRendererBase.TR_CURRENT_TILE_WIDTH);
+              final int tileHeight = printRenderer.getParam(TileRendererBase.TR_CURRENT_TILE_HEIGHT);
               AWTGLPixelBuffer pixelBuffer = printBufferProvider.getSingleBuffer(pixelAttribs);
               if( null != pixelBuffer && pixelBuffer.requiresNewBuffer(gl, tileWidth, tileHeight, 0) ) {
                   pixelBuffer.dispose();
@@ -808,14 +813,14 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
               }
               if ( null == pixelBuffer ) {
                   pixelBuffer = printBufferProvider.allocate(gl, pixelAttribs, tileWidth, tileHeight, 1, true, 0);
-                  tileRenderer.setTileBuffer(pixelBuffer);
+                  printRenderer.setTileBuffer(pixelBuffer);
               }
                             
               final BufferedImage cpuVFlipImage = cpuVFlipImageStore[0];
               if( null == cpuVFlipImage || pixelBuffer.width > cpuVFlipImage.getWidth() || pixelBuffer.height > cpuVFlipImage.getHeight() ) {
                   cpuVFlipImageStore[0] = new BufferedImage(pixelBuffer.width, pixelBuffer.height, pixelBuffer.image.getType());
               }
-              System.err.println("XXX tile-pre "+tileRenderer); // FIXME
+              System.err.println("XXX tile-pre "+printRenderer); // FIXME
           }
           @Override
           public void reshape(GLAutoDrawable drawable, int x, int y, int width, int height) {}
@@ -832,8 +837,8 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
               // blitting Note that we could avoid this copy in the cases
               // where !offscreenDrawable.isGLOriented(),
               // but that's the software rendering path which is very slow anyway.
-              final int tileHeight = tileRenderer.getParam(TileRendererBase.TR_CURRENT_TILE_HEIGHT);
-              final AWTGLPixelBuffer pixelBuffer = (AWTGLPixelBuffer) tileRenderer.getTileBuffer();
+              final int tileHeight = printRenderer.getParam(TileRendererBase.TR_CURRENT_TILE_HEIGHT);
+              final AWTGLPixelBuffer pixelBuffer = (AWTGLPixelBuffer) printRenderer.getTileBuffer();
               final BufferedImage srcImage = pixelBuffer.image;
               final BufferedImage dstImage = cpuVFlipImageStore[0];
               final int[] src = ((DataBufferInt) srcImage.getRaster().getDataBuffer()).getData();
@@ -852,37 +857,38 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
           @Override
           public void reshape(GLAutoDrawable drawable, int x, int y, int width, int height) {}
       };      
-      tileRenderer.setGLEventListener(preTileGLEL, postTileGLEL);
-      System.err.println("AWT print.init: "+tileRenderer);
+      printRenderer.setGLEventListener(preTileGLEL, postTileGLEL);
+      System.err.println("AWT print.init: "+printRenderer);
   }
   public void releasePrint() {
-      System.err.println("AWT print.release: "+tileRenderer);
-      tileRenderer.detachFromAutoDrawable();
-      tileRenderer = null;
+      System.err.println("AWT print.release: "+printRenderer);
+      printRenderer.detachFromAutoDrawable();
+      printRenderer = null;
       this.printGraphics = null;
       singleAWTGLPixelBufferProvider = null;
-      final GLAnimatorControl animator =  animatorPaused ? helper.getAnimator() : null;
+      final GLAnimatorControl animator =  printAnimatorPaused ? helper.getAnimator() : null;
       if( null != animator ) {
           animator.resume();
       }
-      animatorPaused = false;
+      printAnimatorPaused = false;
+      printActive = false;
   }
   
   @Override
   public void print(Graphics graphics) {
       this.printGraphics = (Graphics2D)graphics;
-      if( null == tileRenderer ) {
+      if( null == printRenderer ) {
         initPrint();
       }
-      if( null != tileRenderer ) {
+      if( null != printRenderer ) {
           final Rectangle clip = graphics.getClipBounds();
-          System.err.println("AWT print0.1: "+clip+", "+tileRenderer);
-          tileRenderer.setTileRect(clip.x, clip.y, clip.width, clip.height);
+          System.err.println("AWT print0.1: "+clip+", "+printRenderer);
+          printRenderer.setTileRect(clip.x, clip.y, clip.width, clip.height);
       }
-      System.err.println("AWT print0.2: "+tileRenderer);      
+      System.err.println("AWT print0.2: "+printRenderer);      
       // super.print(graphics);
       display();
-      System.err.println("AWT print0.X: "+tileRenderer);
+      System.err.println("AWT print0.X: "+printRenderer);
   }
     
   @Override
diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/tile/TestTiledPrintingGearsAWT.java b/src/test/com/jogamp/opengl/test/junit/jogl/tile/TestTiledPrintingGearsAWT.java
new file mode 100644
index 000000000..657217462
--- /dev/null
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/tile/TestTiledPrintingGearsAWT.java
@@ -0,0 +1,302 @@
+/**
+ * Copyright 2013 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ * 
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ * 
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+ 
+package com.jogamp.opengl.test.junit.jogl.tile;
+
+import javax.media.opengl.*;
+
+import com.jogamp.opengl.util.Animator;
+import javax.media.opengl.awt.GLCanvas;
+import com.jogamp.newt.event.awt.AWTKeyAdapter;
+import com.jogamp.newt.event.awt.AWTWindowAdapter;
+import com.jogamp.newt.event.TraceKeyAdapter;
+import com.jogamp.newt.event.TraceWindowAdapter;
+
+import com.jogamp.opengl.test.junit.jogl.demos.gl2.Gears;
+import com.jogamp.opengl.test.junit.util.UITestCase;
+import com.jogamp.opengl.test.junit.util.QuitAdapter;
+
+import java.awt.BorderLayout;
+import java.awt.Button;
+import java.awt.Dimension;
+import java.awt.Frame;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.Panel;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.print.PageFormat;
+import java.awt.print.Paper;
+import java.awt.print.Printable;
+import java.awt.print.PrinterException;
+import java.awt.print.PrinterJob;
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.lang.reflect.InvocationTargetException;
+
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.AfterClass;
+import org.junit.Test;
+import org.junit.FixMethodOrder;
+import org.junit.runners.MethodSorters;
+
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
+public class TestTiledPrintingGearsAWT extends UITestCase implements Printable {
+    static GLProfile glp;
+    static int width, height;
+    static boolean waitForKey = false;
+
+    @BeforeClass
+    public static void initClass() {
+        if(GLProfile.isAvailable(GLProfile.GL2)) {
+            glp = GLProfile.get(GLProfile.GL2);
+            Assert.assertNotNull(glp);
+            width  = 640;
+            height = 480;
+        } else {
+            setTestSupported(false);
+        }
+        // Runtime.getRuntime().traceInstructions(true);
+        // Runtime.getRuntime().traceMethodCalls(true);
+    }
+
+    @AfterClass
+    public static void releaseClass() {
+    }
+    
+    final double mmPerInch = 25.4;
+    final double a0WidthMM = 841.0;
+    final double a0HeightMM = 1189.0;
+    final double a0WidthInch = a0WidthMM / mmPerInch;
+    final double a0HeightInch = a0WidthMM / mmPerInch;
+    
+    /** Helper to pass desired DPI value ! **/
+    int printDPI = 72;
+    
+    @Override
+    public int print(Graphics g, PageFormat pf, int page) throws PrinterException {
+        if (page > 0) { // We have only one page, and 'page' is zero-based
+            return NO_SUCH_PAGE;
+        }
+        
+        final Paper paper = pf.getPaper();
+        final double paperWWidthInch = paper.getWidth() / 72.0;
+        final double paperWHeightInch = paper.getHeight() / 72.0;
+        final double paperIWidthInch = paper.getImageableWidth() / 72.0;
+        final double paperIHeightInch = paper.getImageableHeight() / 72.0;
+        final double paperWWidthMM = paperWWidthInch * mmPerInch;
+        final double paperWHeightMM = paperWHeightInch * mmPerInch;
+        final double paperIWidthMM = paperIWidthInch * mmPerInch;
+        final double paperIHeightMM = paperIHeightInch * mmPerInch;
+        
+        final double pfWWidthInch = pf.getWidth() / 72.0; 
+        final double pfWHeightInch = pf.getHeight() / 72.0;
+        final double pfIWidthInch = pf.getImageableWidth() / 72.0;; 
+        final double pfIHeightInch = pf.getImageableHeight() / 72.0;
+        final double pfWWidthMM = pfWWidthInch * mmPerInch; 
+        final double pfWHeightMM = pfWHeightInch * mmPerInch;
+        final double pfIWidthMM = pfIWidthInch * mmPerInch; 
+        final double pfIHeightMM = pfIHeightInch * mmPerInch;
+        
+        System.err.println("PF: Paper whole size "+Math.round(paperWWidthMM)+" x "+Math.round(paperWHeightMM)+" mm, "+Math.round(paperWWidthInch)+" x "+Math.round(paperWHeightInch)+" inch");
+        System.err.println("PF: Paper image size "+paper.getImageableX()+" / "+paper.getImageableY()+" "+Math.round(paperIWidthMM)+" x "+Math.round(paperIHeightMM)+" mm, "+Math.round(paperIWidthInch)+" x "+Math.round(paperIHeightInch)+" inch");
+        System.err.println("PF: Page  whole size "+Math.round(pfWWidthMM)+" x "+Math.round(pfWHeightMM)+" mm, "+Math.round(pfWWidthInch)+" x "+Math.round(pfWHeightInch)+" inch");
+        System.err.println("PF: Page  image size "+pf.getImageableX()+" / "+pf.getImageableY()+" "+Math.round(pfIWidthMM)+" x "+Math.round(pfIHeightMM)+" mm, "+Math.round(pfIWidthInch)+" x "+Math.round(pfIHeightInch)+" inch");
+        System.err.println("PF: Page orientation "+pf.getOrientation());
+        
+        /**
+         * User (0,0) is typically outside the imageable area, so we must
+         * translate by the X and Y values in the PageFormat to avoid clipping
+         */
+        Graphics2D g2d = (Graphics2D)g;
+        
+        final int xScaleComp = (int) Math.round(printDPI/72.0);
+        final int yScaleComp = (int) Math.round(printDPI/72.0);
+
+        System.err.println("DPI: "+printDPI+", scaleComp "+xScaleComp+"/"+xScaleComp);
+        glCanvas.setupPrint(xScaleComp, yScaleComp);
+        
+        final int frameWidth = frame.getWidth();
+        final int frameHeight= frame.getHeight();
+        
+        if( xScaleComp != 1 || yScaleComp != 1 ) {
+            final double xScale = 72.0/printDPI;
+            final double yScale = 72.0/printDPI;
+            
+            final int frameWidthS = frameWidth*xScaleComp;
+            final int frameHeightS = frameHeight*yScaleComp;
+            
+            System.err.println("DPI: "+printDPI+", scale "+xScale+"/"+yScale+", frame: "+frameWidth+"x"+frameHeight+" -> "+frameWidthS+"x"+frameHeightS);
+            frame.setSize(frameWidthS, frameHeightS);            
+            
+            // double xMargin = (pf.getImageableWidth() - img.getWidth()*xScale)/2;
+            // double yMargin = (pf.getImageableHeight() - img.getHeight()*yScale)/2;
+            // g2d.translate(pf.getImageableX() + xMargin, pf.getImageableY() + yMargin);        
+            g2d.scale(xScale , yScale );            
+        }
+        g2d.translate(pf.getImageableX(), pf.getImageableY());
+        
+        frame.printAll(g);
+        
+        if( xScaleComp != 1 || yScaleComp != 1 ) {
+            System.err.println("DPI: reset frame size "+frameWidth+"x"+frameHeight);
+            frame.setSize(frameWidth, frameHeight);
+        }
+        glCanvas.releasePrint();
+
+        /* tell the caller that this page is part of the printed document */
+        return PAGE_EXISTS;
+    }
+
+    private Frame frame;
+    private GLCanvas glCanvas;
+
+    protected void runTestGL(GLCapabilities caps) throws InterruptedException, InvocationTargetException {
+        glCanvas = new GLCanvas(caps);
+        Assert.assertNotNull(glCanvas);        
+        Dimension glc_sz = new Dimension(width, height);
+        glCanvas.setMinimumSize(glc_sz);
+        glCanvas.setPreferredSize(glc_sz);
+        glCanvas.setSize(glc_sz);
+        
+        final Gears gears = new Gears();
+        glCanvas.addGLEventListener(gears);
+        
+        final ActionListener print72DPIAction = new ActionListener() {
+            public void actionPerformed(ActionEvent e) {
+                 PrinterJob job = PrinterJob.getPrinterJob();
+                 job.setPrintable(TestTiledPrintingGearsAWT.this);
+                 boolean ok = job.printDialog();
+                 if (ok) {
+                     try {
+                         printDPI = 72; // default
+                         job.print();
+                     } catch (PrinterException ex) {
+                         ex.printStackTrace();
+                     }
+                 }
+            } };
+        final ActionListener print300DPIAction = new ActionListener() {
+            public void actionPerformed(ActionEvent e) {
+                 PrinterJob job = PrinterJob.getPrinterJob();
+                 job.setPrintable(TestTiledPrintingGearsAWT.this);
+                 boolean ok = job.printDialog();
+                 if (ok) {
+                     try {
+                         printDPI = 300;
+                         job.print();
+                     } catch (PrinterException ex) {
+                         ex.printStackTrace();
+                     }
+                 }
+            } };
+        final Button print72DPIButton = new Button("72dpi");
+        print72DPIButton.addActionListener(print72DPIAction);
+        final Button print300DPIButton = new Button("300dpi");
+        print300DPIButton.addActionListener(print300DPIAction);
+            
+        frame = new Frame("Gears AWT Test");
+        Assert.assertNotNull(frame);
+        frame.setLayout(new BorderLayout());
+        Panel printPanel = new Panel();
+        printPanel.add(print72DPIButton);
+        printPanel.add(print300DPIButton);
+        frame.add(printPanel, BorderLayout.NORTH);
+        frame.add(glCanvas, BorderLayout.CENTER);
+        frame.setTitle("Tiles AWT Print Test");
+        
+        Animator animator = new Animator(glCanvas);
+        QuitAdapter quitAdapter = new QuitAdapter();
+
+        new AWTKeyAdapter(new TraceKeyAdapter(quitAdapter)).addTo(glCanvas);
+        new AWTWindowAdapter(new TraceWindowAdapter(quitAdapter)).addTo(frame);
+
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                frame.pack();
+                frame.setVisible(true);
+            }});
+        animator.setUpdateFPSFrames(60, System.err);        
+        animator.start();
+
+        while(!quitAdapter.shouldQuit() && animator.isAnimating() && ( 0 == duration || animator.getTotalFPSDuration()<duration )) {
+            Thread.sleep(100);
+        }
+
+        Assert.assertNotNull(frame);
+        Assert.assertNotNull(glCanvas);
+        Assert.assertNotNull(animator);
+
+        animator.stop();
+        Assert.assertEquals(false, animator.isAnimating());
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                frame.setVisible(false);
+            }});
+        Assert.assertEquals(false, frame.isVisible());
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                final Frame _frame = frame;
+                frame = null;
+                _frame.remove(glCanvas);
+                glCanvas = null;
+                _frame.dispose();
+            }});
+    }
+
+    @Test
+    public void test01() throws InterruptedException, InvocationTargetException {
+        GLCapabilities caps = new GLCapabilities(glp);
+        runTestGL(caps);
+    }
+
+    static long duration = 500; // ms
+
+    public static void main(String args[]) {
+        for(int i=0; i<args.length; i++) {
+            if(args[i].equals("-time")) {
+                i++;
+                try {
+                    duration = Integer.parseInt(args[i]);
+                } catch (Exception ex) { ex.printStackTrace(); }
+            } else if(args[i].equals("-wait")) {
+                waitForKey = true;
+            }
+        }
+        if(waitForKey) {
+            BufferedReader stdin = new BufferedReader(new InputStreamReader(System.in));
+            System.err.println("Press enter to continue");
+            try {
+                System.err.println(stdin.readLine());
+            } catch (IOException e) { }
+        }
+        org.junit.runner.JUnitCore.main(TestTiledPrintingGearsAWT.class.getName());
+    }
+}