[Dirac-commits] soc_javadec_adam/src/org/bbc/dirac/app DiracPlayer.java, 1.3, 1.4 DecMain.java, 1.4, 1.5 TestPlayer.java, 1.2, 1.3 ImageDrawer.java, 1.1, 1.2 Diracplet.java, 1.1, 1.2

[Adam D. <ad...@us...>]

Update of /cvsroot/dirac/soc_javadec_adam/src/org/bbc/dirac/app
In directory sc8-pr-cvs12.sourceforge.net:/tmp/cvs-serv4066/src/org/bbc/dirac/app

Modified Files:
	DiracPlayer.java DecMain.java TestPlayer.java ImageDrawer.java 
	Diracplet.java 
Log Message:
Documentation related changes. Added license stuff and Javadoc stuff.

Index: TestPlayer.java
===================================================================
RCS file: /cvsroot/dirac/soc_javadec_adam/src/org/bbc/dirac/app/TestPlayer.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** TestPlayer.java	17 Jul 2006 12:40:02 -0000	1.2
--- TestPlayer.java	20 Aug 2006 19:42:59 -0000	1.3
***************
*** 4,9 ****
   * Created on 12 July 2006, 18:36
   *
!  * To change this template, choose Tools | Template Manager
!  * and open the template in the editor.
   */
  
--- 4,37 ----
   * Created on 12 July 2006, 18:36
   *
!  ***** BEGIN LICENSE BLOCK *****
!  *
!  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
!  *
!  * The contents of this file are subject to the Mozilla Public License
!  * Version 1.1 (the "License"); you may not use this file except in compliance
!  * with the License. You may obtain a copy of the License at
!  * http://www.mozilla.org/MPL/
!  *
!  * Software distributed under the License is distributed on an "AS IS" basis,
!  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
!  * the specific language governing rights and limitations under the License.
!  *
!  * This code ported from the C++ implementation of Dirac by Adam Davison.
!  *
!  * The creators of the C++ implementation are listed in the original code and 
!  * they own the Copyright (C) 2004. All Rights Reserved.
!  *
!  * Alternatively, the contents of this file may be used under the terms of
!  * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
!  * Public License Version 2.1 (the "LGPL"), in which case the provisions of
!  * the GPL or the LGPL are applicable instead of those above. If you wish to
!  * allow use of your version of this file only under the terms of the either
!  * the GPL or LGPL and not to allow others to use your version of this file
!  * under the MPL, indicate your decision by deleting the provisions above
!  * and replace them with the notice and other provisions required by the GPL
!  * or LGPL. If you do not delete the provisions above, a recipient may use
!  * your version of this file under the terms of any one of the MPL, the GPL
!  * or the LGPL.
!  * ***** END LICENSE BLOCK *****
   */
  
***************
*** 16,22 ****
  import java.awt.*;
  import javax.swing.*;
  /**
!  *
!  * @author Adam
   */
  public class TestPlayer {
--- 44,51 ----
  import java.awt.*;
  import javax.swing.*;
+ 
  /**
!  * A non-interactive test player, useful for repetitive debugging, mostly
!  * obsoleted by DiracPlayer.
   */
  public class TestPlayer {

Index: DiracPlayer.java
===================================================================
RCS file: /cvsroot/dirac/soc_javadec_adam/src/org/bbc/dirac/app/DiracPlayer.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** DiracPlayer.java	8 Aug 2006 10:59:53 -0000	1.3
--- DiracPlayer.java	20 Aug 2006 19:42:59 -0000	1.4
***************
*** 4,9 ****
   * Created on 13 July 2006, 15:37
   *
!  * To change this template, choose Tools | Template Manager
!  * and open the template in the editor.
   */
  
--- 4,37 ----
   * Created on 13 July 2006, 15:37
   *
!  ***** BEGIN LICENSE BLOCK *****
!  *
!  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
!  *
!  * The contents of this file are subject to the Mozilla Public License
!  * Version 1.1 (the "License"); you may not use this file except in compliance
!  * with the License. You may obtain a copy of the License at
!  * http://www.mozilla.org/MPL/
!  *
!  * Software distributed under the License is distributed on an "AS IS" basis,
!  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
!  * the specific language governing rights and limitations under the License.
!  *
!  * This code ported from the C++ implementation of Dirac by Adam Davison.
!  *
!  * The creators of the C++ implementation are listed in the original code and 
!  * they own the Copyright (C) 2004. All Rights Reserved.
!  *
!  * Alternatively, the contents of this file may be used under the terms of
!  * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
!  * Public License Version 2.1 (the "LGPL"), in which case the provisions of
!  * the GPL or the LGPL are applicable instead of those above. If you wish to
!  * allow use of your version of this file only under the terms of the either
!  * the GPL or LGPL and not to allow others to use your version of this file
!  * under the MPL, indicate your decision by deleting the provisions above
!  * and replace them with the notice and other provisions required by the GPL
!  * or LGPL. If you do not delete the provisions above, a recipient may use
!  * your version of this file under the terms of any one of the MPL, the GPL
!  * or the LGPL.
!  * ***** END LICENSE BLOCK *****
   */
  
***************
*** 17,23 ****
  import org.bbc.dirac.decoder.*;
  import org.bbc.dirac.lib.porting.*;
  /**
!  *
!  * @author Adam
   */
  public class DiracPlayer implements DiracDecoderListener {
--- 45,53 ----
  import org.bbc.dirac.decoder.*;
  import org.bbc.dirac.lib.porting.*;
+ 
  /**
!  * A small test app which creates a window and allows you to open .drc files and view the decoded
!  * output. Most of the functionality is provided by JDiracDecoder, a swing control which allows
!  * applications to quickly include Dirac decoding in any swing context.
   */
  public class DiracPlayer implements DiracDecoderListener {
***************
*** 68,71 ****
--- 98,105 ----
      }
      
+     /**
+      * Callback that handles the process of opening a file and starting decoding.
+      * @param f The file to open
+      */
      public void openFile(File f) {
          FileInputStream fis = null;
***************
*** 91,101 ****
--- 125,147 ----
      }
      
+     /**
+      * Main function which creates a DiracPlayer object
+      * @param args Ignored
+      */
      public static void main(String[] args) {
          DiracPlayer dp = new DiracPlayer();
      }
  
+     /**
+      * Callback from decoder to say that the sequence is done
+      * @param sp Parameters of the sequence which just finished
+      */
      public void sequenceEnded(SeqParamsStruct sp) {
      }
  
+     /**
+      * Callback from the decoder to say that a sequence has started.
+      * @param sp Sequence Parameters of sequence starting now
+      */
      public void sequence(SeqParamsStruct sp) {
          int w = sp.getWidth();

Index: Diracplet.java
===================================================================
RCS file: /cvsroot/dirac/soc_javadec_adam/src/org/bbc/dirac/app/Diracplet.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** Diracplet.java	7 Aug 2006 15:31:13 -0000	1.1
--- Diracplet.java	20 Aug 2006 19:42:59 -0000	1.2
***************
*** 4,9 ****
   * Created on 31 July 2006, 13:34
   *
!  * To change this template, choose Tools | Template Manager
!  * and open the template in the editor.
   */
  
--- 4,37 ----
   * Created on 31 July 2006, 13:34
   *
!  ***** BEGIN LICENSE BLOCK *****
!  *
!  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
!  *
!  * The contents of this file are subject to the Mozilla Public License
!  * Version 1.1 (the "License"); you may not use this file except in compliance
!  * with the License. You may obtain a copy of the License at
!  * http://www.mozilla.org/MPL/
!  *
!  * Software distributed under the License is distributed on an "AS IS" basis,
!  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
!  * the specific language governing rights and limitations under the License.
!  *
!  * This code ported from the C++ implementation of Dirac by Adam Davison.
!  *
!  * The creators of the C++ implementation are listed in the original code and 
!  * they own the Copyright (C) 2004. All Rights Reserved.
!  *
!  * Alternatively, the contents of this file may be used under the terms of
!  * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
!  * Public License Version 2.1 (the "LGPL"), in which case the provisions of
!  * the GPL or the LGPL are applicable instead of those above. If you wish to
!  * allow use of your version of this file only under the terms of the either
!  * the GPL or LGPL and not to allow others to use your version of this file
!  * under the MPL, indicate your decision by deleting the provisions above
!  * and replace them with the notice and other provisions required by the GPL
!  * or LGPL. If you do not delete the provisions above, a recipient may use
!  * your version of this file under the terms of any one of the MPL, the GPL
!  * or the LGPL.
!  * ***** END LICENSE BLOCK *****
   */
  
***************
*** 18,23 ****
  
  /**
!  *
!  * @author Adam
   */
  public class Diracplet extends JApplet {
--- 46,51 ----
  
  /**
!  * Class which demonstrates the absolute minimum amount of code required to implement a dirac decoding
!  * applet.
   */
  public class Diracplet extends JApplet {

Index: ImageDrawer.java
===================================================================
RCS file: /cvsroot/dirac/soc_javadec_adam/src/org/bbc/dirac/app/ImageDrawer.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** ImageDrawer.java	13 Jul 2006 11:21:20 -0000	1.1
--- ImageDrawer.java	20 Aug 2006 19:42:59 -0000	1.2
***************
*** 4,9 ****
   * Created on 12 July 2006, 21:13
   *
!  * To change this template, choose Tools | Template Manager
!  * and open the template in the editor.
   */
  
--- 4,37 ----
   * Created on 12 July 2006, 21:13
   *
!  ***** BEGIN LICENSE BLOCK *****
!  *
!  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
!  *
!  * The contents of this file are subject to the Mozilla Public License
!  * Version 1.1 (the "License"); you may not use this file except in compliance
!  * with the License. You may obtain a copy of the License at
!  * http://www.mozilla.org/MPL/
!  *
!  * Software distributed under the License is distributed on an "AS IS" basis,
!  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
!  * the specific language governing rights and limitations under the License.
!  *
!  * This code ported from the C++ implementation of Dirac by Adam Davison.
!  *
!  * The creators of the C++ implementation are listed in the original code and 
!  * they own the Copyright (C) 2004. All Rights Reserved.
!  *
!  * Alternatively, the contents of this file may be used under the terms of
!  * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
!  * Public License Version 2.1 (the "LGPL"), in which case the provisions of
!  * the GPL or the LGPL are applicable instead of those above. If you wish to
!  * allow use of your version of this file only under the terms of the either
!  * the GPL or LGPL and not to allow others to use your version of this file
!  * under the MPL, indicate your decision by deleting the provisions above
!  * and replace them with the notice and other provisions required by the GPL
!  * or LGPL. If you do not delete the provisions above, a recipient may use
!  * your version of this file under the terms of any one of the MPL, the GPL
!  * or the LGPL.
!  * ***** END LICENSE BLOCK *****
   */
  
***************
*** 11,17 ****
  
  import java.awt.*;
  /**
!  *
!  * @author Adam
   */
  public class ImageDrawer extends Canvas {
--- 39,45 ----
  
  import java.awt.*;
+ 
  /**
!  * Little class for rendering a changing image to the screen.
   */
  public class ImageDrawer extends Canvas {

Index: DecMain.java
===================================================================
RCS file: /cvsroot/dirac/soc_javadec_adam/src/org/bbc/dirac/app/DecMain.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** DecMain.java	13 Jul 2006 11:21:20 -0000	1.4
--- DecMain.java	20 Aug 2006 19:42:59 -0000	1.5
***************
*** 4,9 ****
   * Created on 03 July 2006, 20:00
   *
!  * To change this template, choose Tools | Template Manager
!  * and open the template in the editor.
   */
  
--- 4,37 ----
   * Created on 03 July 2006, 20:00
   *
!  ***** BEGIN LICENSE BLOCK *****
!  *
!  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
!  *
!  * The contents of this file are subject to the Mozilla Public License
!  * Version 1.1 (the "License"); you may not use this file except in compliance
!  * with the License. You may obtain a copy of the License at
!  * http://www.mozilla.org/MPL/
!  *
!  * Software distributed under the License is distributed on an "AS IS" basis,
!  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
!  * the specific language governing rights and limitations under the License.
!  *
!  * This code ported from the C++ implementation of Dirac by Adam Davison.
!  *
!  * The creators of the C++ implementation are listed in the original code and 
!  * they own the Copyright (C) 2004. All Rights Reserved.
!  *
!  * Alternatively, the contents of this file may be used under the terms of
!  * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
!  * Public License Version 2.1 (the "LGPL"), in which case the provisions of
!  * the GPL or the LGPL are applicable instead of those above. If you wish to
!  * allow use of your version of this file only under the terms of the either
!  * the GPL or LGPL and not to allow others to use your version of this file
!  * under the MPL, indicate your decision by deleting the provisions above
!  * and replace them with the notice and other provisions required by the GPL
!  * or LGPL. If you do not delete the provisions above, a recipient may use
!  * your version of this file under the terms of any one of the MPL, the GPL
!  * or the LGPL.
!  * ***** END LICENSE BLOCK *****
   */
  
***************
*** 20,26 ****
  import javax.swing.*;
  import java.awt.*;
  /**
!  *
!  * @author Adam
   */
  public class DecMain {
--- 48,55 ----
  import javax.swing.*;
  import java.awt.*;
+ 
  /**
!  * Ported from the original C++ implementation of a decoder app. Now obsoleted by DiracDecoder and
!  * JDiracDecoder. So don't use it.
   */
  public class DecMain {