From 6a025f165e3c14b3aea060139288f90eeed0f0a5 Mon Sep 17 00:00:00 2001
From: yeom <yeom>
Date: Thu, 14 Jul 2011 17:59:22 +0000
Subject: [PATCH] adding more annotations for mp3decoder

---
 .../Tests/ssJava/mp3decoder/BitReserve.java   |  2 +-
 .../src/Tests/ssJava/mp3decoder/Decoder.java  | 39 +++++++++++--------
 .../src/Tests/ssJava/mp3decoder/Header.java   |  1 +
 Robust/src/Tests/ssJava/mp3decoder/LOC.java   |  8 +++-
 .../ssJava/mp3decoder/LayerIDecoder.java      |  4 +-
 .../ssJava/mp3decoder/LayerIIIDecoder.java    | 16 +++++---
 .../src/Tests/ssJava/mp3decoder/Obuffer.java  |  8 ++--
 .../src/Tests/ssJava/mp3decoder/Player.java   | 29 ++++++++------
 .../Tests/ssJava/mp3decoder/SampleBuffer.java |  2 +-
 .../src/Tests/ssJava/mp3decoder/Subband.java  |  2 +-
 .../ssJava/mp3decoder/SynthesisFilter.java    |  2 +-
 11 files changed, 67 insertions(+), 46 deletions(-)

diff --git a/Robust/src/Tests/ssJava/mp3decoder/BitReserve.java b/Robust/src/Tests/ssJava/mp3decoder/BitReserve.java
index bd57b6ea..3c907a79 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/BitReserve.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/BitReserve.java
@@ -209,7 +209,7 @@ final class BitReserve
    /**
     * Rewind N bits in Stream.
 	*/
-   public void rewindNbits(int N)
+   public void rewindNbits(@LOC("IN") int N)
    {
  	  totbit -= N;	  	  
 	  buf_byte_idx -= N;
diff --git a/Robust/src/Tests/ssJava/mp3decoder/Decoder.java b/Robust/src/Tests/ssJava/mp3decoder/Decoder.java
index bcf918ba..46c87ba2 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/Decoder.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/Decoder.java
@@ -27,6 +27,7 @@
  * @version 0.0.7 12/12/99
  * @since	0.0.5
  */
+@LATTICE("ST,OUT,FIL,DE,O,EQ,PA,INIT")
 public class Decoder implements DecoderErrors
 {
 	static private final Params DEFAULT_PARAMS = new Params();
@@ -34,39 +35,39 @@ public class Decoder implements DecoderErrors
 	/**
 	 * The Bistream from which the MPEG audio frames are read.
 	 */
-	private Bitstream				stream;
+	@LOC("ST") private Bitstream				stream;
 	
 	/**
 	 * The Obuffer instance that will receive the decoded
 	 * PCM samples.
 	 */
-	private Obuffer			output;
+	@LOC("OUT") private Obuffer			output;
 		
 	/**
 	 * Synthesis filter for the left channel.
 	 */
-	private SynthesisFilter			filter1;
+	@LOC("FIL") private SynthesisFilter			filter1;
 	
 	/**
 	 * Sythesis filter for the right channel.
 	 */
-	private SynthesisFilter			filter2;	
+	@LOC("FIL") private SynthesisFilter			filter2;	
 			
 	/**
 	 * The decoder used to decode layer III frames.
 	 */
-	private LayerIIIDecoder			l3decoder;
-	private LayerIIDecoder			l2decoder;
-	private LayerIDecoder			l1decoder;
+	@LOC("DE") private LayerIIIDecoder			l3decoder;
+	@LOC("DE") private LayerIIDecoder			l2decoder;
+	@LOC("DE") private LayerIDecoder			l1decoder;
 	
-	private int						outputFrequency;
-	private int						outputChannels;
+	@LOC("O") private int						outputFrequency;
+	@LOC("O") private int						outputChannels;
 	
-	private Equalizer				equalizer = new Equalizer();
+	@LOC("EQ") private Equalizer				equalizer = new Equalizer();
 	
-	private Params					params;
+	@LOC("PA") private Params					params;
 	
-	private boolean					initialized;
+	@LOC("INIT") private boolean					initialized;
 		
 	
 	/**
@@ -129,7 +130,9 @@ public class Decoder implements DecoderErrors
 	 * 
 	 * @return A SampleBuffer containing the decoded samples.
 	 */
-	public Obuffer decodeFrame(Header header, Bitstream stream)
+	@LATTICE("O<DE,DE<TH,TH<IN,THISLOC=TH")
+	@RETURNLOC("O")
+	public Obuffer decodeFrame(@LOC("IN") Header header, @LOC("IN") Bitstream stream)
 	throws DecoderException
 	{
 	  // throw decoder initialization out of ssjava loop since it is invoked once
@@ -138,11 +141,11 @@ public class Decoder implements DecoderErrors
 	  //		    initialize(header,stream);
 	  //		}
 
-	  int layer = header.layer();
+	  @LOC("DELTA(TH)") int layer = header.layer();
 
 	  output.clear_buffer();
 
-	  FrameDecoder decoder = retrieveDecoder(header, stream, layer);
+	  @LOC("DE") FrameDecoder decoder = retrieveDecoder(header, stream, layer);
 
 	  decoder.decodeFrame();
 
@@ -214,10 +217,12 @@ public class Decoder implements DecoderErrors
 		return new DecoderException(errorcode, throwable);
 	}
 	
-	protected FrameDecoder retrieveDecoder(Header header, Bitstream stream, int layer)
+	@LATTICE("DE<IN,THISLOC=IN")
+	@RETURNLOC("DE")
+	protected FrameDecoder retrieveDecoder(@LOC("IN") Header header, @LOC("IN") Bitstream stream, @LOC("IN") int layer)
 		throws DecoderException
 	{
-		FrameDecoder decoder = null;
+		@LOC("DE") FrameDecoder decoder = null;
 		
 		// REVIEW: allow channel output selection type
 		// (LEFT, RIGHT, BOTH, DOWNMIX)
diff --git a/Robust/src/Tests/ssJava/mp3decoder/Header.java b/Robust/src/Tests/ssJava/mp3decoder/Header.java
index 456161f2..406aa479 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/Header.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/Header.java
@@ -358,6 +358,7 @@ public final class Header
 	/**
 	 * Returns Layer ID.
 	 */
+	@RETURNLOC("THIS")
 	public int layer() { return h_layer; }
 
 	/**
diff --git a/Robust/src/Tests/ssJava/mp3decoder/LOC.java b/Robust/src/Tests/ssJava/mp3decoder/LOC.java
index 3918fe50..0165516c 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/LOC.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/LOC.java
@@ -1,3 +1,7 @@
-public @interface LOC{
-    String value();
+public @interface LOC {
+  String value();
+}
+
+public @interface RETURNLOC {
+  String value();
 }
\ No newline at end of file
diff --git a/Robust/src/Tests/ssJava/mp3decoder/LayerIDecoder.java b/Robust/src/Tests/ssJava/mp3decoder/LayerIDecoder.java
index a1eec6e4..2ae6d5d8 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/LayerIDecoder.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/LayerIDecoder.java
@@ -188,7 +188,7 @@
 	 * Used for single channel mode
 	 * and in derived class for intensity stereo mode
 	 */
-     @LATTICE("_bottom_<L,S<L,L<H,H<SH,SH*,S*")
+     @LATTICE("S<L,L<H,H<SH,SH*,S*")
 	@METHODDEFAULT("OUT<V,V<SH,SH<IN,SH*,THISLOC=V,GLOBALLOC=IN")
 	static class SubbandLayer1 extends Subband
 	{
@@ -377,7 +377,7 @@
 	/**
 	 * Class for layer I subbands in stereo mode.
 	 */
-        @LATTICE("L<H,H<SH,SH*")
+     @LATTICE("S<L,L<H,H<SH,SH*,S*")
 	@METHODDEFAULT("OUT<V,V<SH,SH<IN,SH*,THISLOC=V,GLOBALLOC=IN")
 	static class SubbandLayer1Stereo extends SubbandLayer1
 	{
diff --git a/Robust/src/Tests/ssJava/mp3decoder/LayerIIIDecoder.java b/Robust/src/Tests/ssJava/mp3decoder/LayerIIIDecoder.java
index 116f32f1..7c58bd5a 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/LayerIIIDecoder.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/LayerIIIDecoder.java
@@ -71,7 +71,7 @@ final class LayerIIIDecoder implements FrameDecoder {
   @LOC("BR") private BitReserve br;
   @LOC("SI") private III_side_info_t si;
 
-  @LOC("SBT") private temporaire2[] III_scalefac_t;
+//  @LOC("SBT") private temporaire2[] III_scalefac_t;
   @LOC("SF") private temporaire2[] scalefac;
   // private III_scalefac_t scalefac;
 
@@ -101,11 +101,17 @@ final class LayerIIIDecoder implements FrameDecoder {
     k = new float[2][SBLIMIT * SSLIMIT];
     nonzero = new int[2];
 
+    //removes unnecessary aliases
     // III_scalefact_t
-    III_scalefac_t = new temporaire2[2];
-    III_scalefac_t[0] = new temporaire2();
-    III_scalefac_t[1] = new temporaire2();
-    scalefac = III_scalefac_t;
+//    III_scalefac_t = new temporaire2[2];
+//    III_scalefac_t[0] = new temporaire2();
+//    III_scalefac_t[1] = new temporaire2();
+//    scalefac = III_scalefac_t;
+    
+    scalefac=new temporaire2[2];
+    scalefac[0] = new temporaire2();
+    scalefac[1] = new temporaire2();
+    
     // L3TABLE INIT
 
     sfBandIndex = new SBI[9]; // SZD: MPEG2.5 +3 indices
diff --git a/Robust/src/Tests/ssJava/mp3decoder/Obuffer.java b/Robust/src/Tests/ssJava/mp3decoder/Obuffer.java
index 288bb32a..4f444c94 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/Obuffer.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/Obuffer.java
@@ -36,12 +36,12 @@
 /**
  * Base Class for audio output.
  */
-@LATTICE("B<T")
-@METHODDEFAULT("D<IN,D<C,C*")
+@LATTICE("")
+@METHODDEFAULT("D<IN,D<C,C*,THISLOC=D")
 public abstract class Obuffer
 {
-  @LOC("T") public static final int     OBUFFERSIZE = 2 * 1152;  // max. 2 * 1152 samples per frame
-  @LOC("T") public static final int   MAXCHANNELS = 2;        // max. number of channels
+ public static final int     OBUFFERSIZE = 2 * 1152;  // max. 2 * 1152 samples per frame
+ public static final int   MAXCHANNELS = 2;        // max. number of channels
 
   /**
    * Takes a 16 Bit PCM sample.
diff --git a/Robust/src/Tests/ssJava/mp3decoder/Player.java b/Robust/src/Tests/ssJava/mp3decoder/Player.java
index b0f23560..d898e912 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/Player.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/Player.java
@@ -32,23 +32,24 @@
 
 // REVIEW: the audio device should not be opened until the
 // first MPEG audio frame has been decoded. 
+@LATTICE("B<DE,DE<ST,HE<ST,ST<FR")
 public class Player
 {	  	
 	/**
 	 * The current frame number. 
 	 */
-	private int frame = 0;
+	@LOC("FR") private int frame = 0;
 	
 	/**
 	 * The MPEG audio bitstream. 
 	 */
 	// javac blank final bug. 
-	/*final*/ private Bitstream		bitstream;
+	/*final*/ @LOC("ST") private Bitstream		bitstream;
 	
 	/**
 	 * The MPEG audio decoder. 
 	 */
-	/*final*/ private Decoder		decoder; 
+	/*final*/ @LOC("DE") private Decoder		decoder; 
 	
 	/**
 	 * The AudioDevice the audio samples are written to. 
@@ -58,16 +59,16 @@ public class Player
 	/**
 	 * Has the player been closed?
 	 */
-	private boolean		closed = false;
+	@LOC("B") private boolean		closed = false;
 	
 	/**
 	 * Has the player played back all frames from the stream?
 	 */
-	private boolean		complete = false;
+	@LOC("B") private boolean		complete = false;
 
-	private int			lastPosition = 0;
+	@LOC("B") private int			lastPosition = 0;
 	
-	private Header header;
+	@LOC("HE") private Header header;
 	
 	/**
 	 * Creates a new <code>Player</code> instance. 
@@ -114,14 +115,16 @@ public class Player
 	 * @return	true if the last frame was played, or false if there are
 	 *			more frames. 
 	 */
-	public boolean play(int frames) throws JavaLayerException
+	@LATTICE("IN<T,IN*,THISLOC=T")
+	@RETURNLOC("IN")
+	public boolean play(@LOC("IN") int frames) throws JavaLayerException
 	{
-		boolean ret = true;
-		
+	    @LOC("IN") boolean ret = true;
+	    
 	     SSJAVA:
 		while (frames-- > 0 && ret)
 		{
-			ret = decodeFrame();			
+			 ret = decodeFrame();
 		}
 		/*
 		if (!ret)
@@ -206,6 +209,8 @@ public class Player
 	 * 
 	 * @return true if there are no more frames to decode, false otherwise.
 	 */
+	@LATTICE("O,THISLOC=O")
+	@RETURNLOC("O")
 	protected boolean decodeFrame() throws JavaLayerException
 	{		
 		try
@@ -220,7 +225,7 @@ public class Player
 //				return false;
 				
 			// sample buffer set when decoder constructed
-			SampleBuffer output = (SampleBuffer)decoder.decodeFrame(header, bitstream);
+			@LOC("O") SampleBuffer output = (SampleBuffer)decoder.decodeFrame(header, bitstream);
 																																					
 			//synchronized (this)
 			//{
diff --git a/Robust/src/Tests/ssJava/mp3decoder/SampleBuffer.java b/Robust/src/Tests/ssJava/mp3decoder/SampleBuffer.java
index 913b8b02..211a328c 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/SampleBuffer.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/SampleBuffer.java
@@ -140,7 +140,7 @@ public class SampleBuffer extends Obuffer
   /**
    * Write the samples to the file (Random Acces).
    */
-  public void write_buffer(int val)
+  public void write_buffer(@LOC("IN") int val)
   {
 
     //for (int i = 0; i < channels; ++i) 
diff --git a/Robust/src/Tests/ssJava/mp3decoder/Subband.java b/Robust/src/Tests/ssJava/mp3decoder/Subband.java
index dbfcd873..eff274d9 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/Subband.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/Subband.java
@@ -3,7 +3,7 @@
 /**
  * Abstract base class for subband classes of layer I and II
  */
-   @LATTICE("L<H")
+   @LATTICE("S<L,L<H")
 static abstract class Subband
 {
  /*
diff --git a/Robust/src/Tests/ssJava/mp3decoder/SynthesisFilter.java b/Robust/src/Tests/ssJava/mp3decoder/SynthesisFilter.java
index c1110cc7..dab977a3 100644
--- a/Robust/src/Tests/ssJava/mp3decoder/SynthesisFilter.java
+++ b/Robust/src/Tests/ssJava/mp3decoder/SynthesisFilter.java
@@ -159,7 +159,7 @@ final class SynthesisFilter
 	  samples[subbandnumber] = eq[subbandnumber]*sample;
   }
 
-  public void input_samples(float[] s)
+  public void input_samples(@LOC("V") float[] s)
   {
 	  for (int i=31; i>=0; i--)
 	  {		
-- 
2.34.1