adding more annotations for mp3decoder
authoryeom <yeom>
Thu, 14 Jul 2011 17:59:22 +0000 (17:59 +0000)
committeryeom <yeom>
Thu, 14 Jul 2011 17:59:22 +0000 (17:59 +0000)
Robust/src/Tests/ssJava/mp3decoder/BitReserve.java
Robust/src/Tests/ssJava/mp3decoder/Decoder.java
Robust/src/Tests/ssJava/mp3decoder/Header.java
Robust/src/Tests/ssJava/mp3decoder/LOC.java
Robust/src/Tests/ssJava/mp3decoder/LayerIDecoder.java
Robust/src/Tests/ssJava/mp3decoder/LayerIIIDecoder.java
Robust/src/Tests/ssJava/mp3decoder/Obuffer.java
Robust/src/Tests/ssJava/mp3decoder/Player.java
Robust/src/Tests/ssJava/mp3decoder/SampleBuffer.java
Robust/src/Tests/ssJava/mp3decoder/Subband.java
Robust/src/Tests/ssJava/mp3decoder/SynthesisFilter.java

index bd57b6ea834aba884c534609fd6ce316b90f1d1e..3c907a79d76d2cd3e1dc12619d4ad1e899a02f2c 100644 (file)
@@ -209,7 +209,7 @@ final class BitReserve
    /**\r
     * Rewind N bits in Stream.\r
        */\r
    /**\r
     * Rewind N bits in Stream.\r
        */\r
-   public void rewindNbits(int N)\r
+   public void rewindNbits(@LOC("IN") int N)\r
    {\r
          totbit -= N;            \r
          buf_byte_idx -= N;\r
    {\r
          totbit -= N;            \r
          buf_byte_idx -= N;\r
index bcf918bafb884aa6d74688586a0c13ec080d5d15..46c87ba278af1a9478ab60afce26257752107ad1 100644 (file)
@@ -27,6 +27,7 @@
  * @version 0.0.7 12/12/99\r
  * @since      0.0.5\r
  */\r
  * @version 0.0.7 12/12/99\r
  * @since      0.0.5\r
  */\r
+@LATTICE("ST,OUT,FIL,DE,O,EQ,PA,INIT")\r
 public class Decoder implements DecoderErrors\r
 {\r
        static private final Params DEFAULT_PARAMS = new Params();\r
 public class Decoder implements DecoderErrors\r
 {\r
        static private final Params DEFAULT_PARAMS = new Params();\r
@@ -34,39 +35,39 @@ public class Decoder implements DecoderErrors
        /**\r
         * The Bistream from which the MPEG audio frames are read.\r
         */\r
        /**\r
         * The Bistream from which the MPEG audio frames are read.\r
         */\r
-       private Bitstream                               stream;\r
+       @LOC("ST") private Bitstream                            stream;\r
        \r
        /**\r
         * The Obuffer instance that will receive the decoded\r
         * PCM samples.\r
         */\r
        \r
        /**\r
         * The Obuffer instance that will receive the decoded\r
         * PCM samples.\r
         */\r
-       private Obuffer                 output;\r
+       @LOC("OUT") private Obuffer                     output;\r
                \r
        /**\r
         * Synthesis filter for the left channel.\r
         */\r
                \r
        /**\r
         * Synthesis filter for the left channel.\r
         */\r
-       private SynthesisFilter                 filter1;\r
+       @LOC("FIL") private SynthesisFilter                     filter1;\r
        \r
        /**\r
         * Sythesis filter for the right channel.\r
         */\r
        \r
        /**\r
         * Sythesis filter for the right channel.\r
         */\r
-       private SynthesisFilter                 filter2;        \r
+       @LOC("FIL") private SynthesisFilter                     filter2;        \r
                        \r
        /**\r
         * The decoder used to decode layer III frames.\r
         */\r
                        \r
        /**\r
         * The decoder used to decode layer III frames.\r
         */\r
-       private LayerIIIDecoder                 l3decoder;\r
-       private LayerIIDecoder                  l2decoder;\r
-       private LayerIDecoder                   l1decoder;\r
+       @LOC("DE") private LayerIIIDecoder                      l3decoder;\r
+       @LOC("DE") private LayerIIDecoder                       l2decoder;\r
+       @LOC("DE") private LayerIDecoder                        l1decoder;\r
        \r
        \r
-       private int                                             outputFrequency;\r
-       private int                                             outputChannels;\r
+       @LOC("O") private int                                           outputFrequency;\r
+       @LOC("O") private int                                           outputChannels;\r
        \r
        \r
-       private Equalizer                               equalizer = new Equalizer();\r
+       @LOC("EQ") private Equalizer                            equalizer = new Equalizer();\r
        \r
        \r
-       private Params                                  params;\r
+       @LOC("PA") private Params                                       params;\r
        \r
        \r
-       private boolean                                 initialized;\r
+       @LOC("INIT") private boolean                                    initialized;\r
                \r
        \r
        /**\r
                \r
        \r
        /**\r
@@ -129,7 +130,9 @@ public class Decoder implements DecoderErrors
         * \r
         * @return A SampleBuffer containing the decoded samples.\r
         */\r
         * \r
         * @return A SampleBuffer containing the decoded samples.\r
         */\r
-       public Obuffer decodeFrame(Header header, Bitstream stream)\r
+       @LATTICE("O<DE,DE<TH,TH<IN,THISLOC=TH")\r
+       @RETURNLOC("O")\r
+       public Obuffer decodeFrame(@LOC("IN") Header header, @LOC("IN") Bitstream stream)\r
        throws DecoderException\r
        {\r
          // throw decoder initialization out of ssjava loop since it is invoked once\r
        throws DecoderException\r
        {\r
          // throw decoder initialization out of ssjava loop since it is invoked once\r
@@ -138,11 +141,11 @@ public class Decoder implements DecoderErrors
          //                initialize(header,stream);\r
          //            }\r
 \r
          //                initialize(header,stream);\r
          //            }\r
 \r
-         int layer = header.layer();\r
+         @LOC("DELTA(TH)") int layer = header.layer();\r
 \r
          output.clear_buffer();\r
 \r
 \r
          output.clear_buffer();\r
 \r
-         FrameDecoder decoder = retrieveDecoder(header, stream, layer);\r
+         @LOC("DE") FrameDecoder decoder = retrieveDecoder(header, stream, layer);\r
 \r
          decoder.decodeFrame();\r
 \r
 \r
          decoder.decodeFrame();\r
 \r
@@ -214,10 +217,12 @@ public class Decoder implements DecoderErrors
                return new DecoderException(errorcode, throwable);\r
        }\r
        \r
                return new DecoderException(errorcode, throwable);\r
        }\r
        \r
-       protected FrameDecoder retrieveDecoder(Header header, Bitstream stream, int layer)\r
+       @LATTICE("DE<IN,THISLOC=IN")\r
+       @RETURNLOC("DE")\r
+       protected FrameDecoder retrieveDecoder(@LOC("IN") Header header, @LOC("IN") Bitstream stream, @LOC("IN") int layer)\r
                throws DecoderException\r
        {\r
                throws DecoderException\r
        {\r
-               FrameDecoder decoder = null;\r
+               @LOC("DE") FrameDecoder decoder = null;\r
                \r
                // REVIEW: allow channel output selection type\r
                // (LEFT, RIGHT, BOTH, DOWNMIX)\r
                \r
                // REVIEW: allow channel output selection type\r
                // (LEFT, RIGHT, BOTH, DOWNMIX)\r
index 456161f2e39d58c109817866c17e837f9d00f74b..406aa4795f7c8d06f03cde62b0c2b82ac1db99ea 100644 (file)
@@ -358,6 +358,7 @@ public final class Header
        /**\r
         * Returns Layer ID.\r
         */\r
        /**\r
         * Returns Layer ID.\r
         */\r
+       @RETURNLOC("THIS")\r
        public int layer() { return h_layer; }\r
 \r
        /**\r
        public int layer() { return h_layer; }\r
 \r
        /**\r
index 3918fe50d2de8d5a821e9fca0f0cfc37bbdf1352..0165516c00356f58ac7030bd490e8945a3d0d982 100644 (file)
@@ -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
 }
\ No newline at end of file
index a1eec6e4e54b0f1e0e57de4e6387a8b87903fb80..2ae6d5d8d76d6e0e55e2c60ee4cd07f8d8d7ae75 100644 (file)
         * Used for single channel mode
         * and in derived class for intensity stereo mode
         */
         * 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
        {
        @METHODDEFAULT("OUT<V,V<SH,SH<IN,SH*,THISLOC=V,GLOBALLOC=IN")
        static class SubbandLayer1 extends Subband
        {
        /**
         * Class for layer I subbands in stereo mode.
         */
        /**
         * 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
        {
        @METHODDEFAULT("OUT<V,V<SH,SH<IN,SH*,THISLOC=V,GLOBALLOC=IN")
        static class SubbandLayer1Stereo extends SubbandLayer1
        {
index 116f32f11bbde5020c52d447c7724b349f7320cd..7c58bd5a69d0fc9b8aa4c25cb456a9b29910f279 100644 (file)
@@ -71,7 +71,7 @@ final class LayerIIIDecoder implements FrameDecoder {
   @LOC("BR") private BitReserve br;
   @LOC("SI") private III_side_info_t si;
 
   @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;
 
   @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];
 
     k = new float[2][SBLIMIT * SSLIMIT];
     nonzero = new int[2];
 
+    //removes unnecessary aliases
     // III_scalefact_t
     // 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
     // L3TABLE INIT
 
     sfBandIndex = new SBI[9]; // SZD: MPEG2.5 +3 indices
index 288bb32ae47dc6d2ac959b3fb8b69cc19c552d84..4f444c941e0755efed009fd9d9e8e34f7d87c9ef 100644 (file)
 /**
  * Base Class for audio output.
  */
 /**
  * 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
 {
 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.
 
   /**
    * Takes a 16 Bit PCM sample.
index b0f2356088df75a59dfb3aa96e022c5d92812c0e..d898e9124f6f7e8d4411d4dce6628fcbe4b436cf 100644 (file)
 \r
 // REVIEW: the audio device should not be opened until the\r
 // first MPEG audio frame has been decoded. \r
 \r
 // REVIEW: the audio device should not be opened until the\r
 // first MPEG audio frame has been decoded. \r
+@LATTICE("B<DE,DE<ST,HE<ST,ST<FR")\r
 public class Player\r
 {              \r
        /**\r
         * The current frame number. \r
         */\r
 public class Player\r
 {              \r
        /**\r
         * The current frame number. \r
         */\r
-       private int frame = 0;\r
+       @LOC("FR") private int frame = 0;\r
        \r
        /**\r
         * The MPEG audio bitstream. \r
         */\r
        // javac blank final bug. \r
        \r
        /**\r
         * The MPEG audio bitstream. \r
         */\r
        // javac blank final bug. \r
-       /*final*/ private Bitstream             bitstream;\r
+       /*final*/ @LOC("ST") private Bitstream          bitstream;\r
        \r
        /**\r
         * The MPEG audio decoder. \r
         */\r
        \r
        /**\r
         * The MPEG audio decoder. \r
         */\r
-       /*final*/ private Decoder               decoder; \r
+       /*final*/ @LOC("DE") private Decoder            decoder; \r
        \r
        /**\r
         * The AudioDevice the audio samples are written to. \r
        \r
        /**\r
         * The AudioDevice the audio samples are written to. \r
@@ -58,16 +59,16 @@ public class Player
        /**\r
         * Has the player been closed?\r
         */\r
        /**\r
         * Has the player been closed?\r
         */\r
-       private boolean         closed = false;\r
+       @LOC("B") private boolean               closed = false;\r
        \r
        /**\r
         * Has the player played back all frames from the stream?\r
         */\r
        \r
        /**\r
         * Has the player played back all frames from the stream?\r
         */\r
-       private boolean         complete = false;\r
+       @LOC("B") private boolean               complete = false;\r
 \r
 \r
-       private int                     lastPosition = 0;\r
+       @LOC("B") private int                   lastPosition = 0;\r
        \r
        \r
-       private Header header;\r
+       @LOC("HE") private Header header;\r
        \r
        /**\r
         * Creates a new <code>Player</code> instance. \r
        \r
        /**\r
         * Creates a new <code>Player</code> instance. \r
@@ -114,14 +115,16 @@ public class Player
         * @return      true if the last frame was played, or false if there are\r
         *                      more frames. \r
         */\r
         * @return      true if the last frame was played, or false if there are\r
         *                      more frames. \r
         */\r
-       public boolean play(int frames) throws JavaLayerException\r
+       @LATTICE("IN<T,IN*,THISLOC=T")\r
+       @RETURNLOC("IN")\r
+       public boolean play(@LOC("IN") int frames) throws JavaLayerException\r
        {\r
        {\r
-               boolean ret = true;\r
-               \r
+           @LOC("IN") boolean ret = true;\r
+           \r
             SSJAVA:\r
                while (frames-- > 0 && ret)\r
                {\r
             SSJAVA:\r
                while (frames-- > 0 && ret)\r
                {\r
-                       ret = decodeFrame();                    \r
+                        ret = decodeFrame();\r
                }\r
                /*\r
                if (!ret)\r
                }\r
                /*\r
                if (!ret)\r
@@ -206,6 +209,8 @@ public class Player
         * \r
         * @return true if there are no more frames to decode, false otherwise.\r
         */\r
         * \r
         * @return true if there are no more frames to decode, false otherwise.\r
         */\r
+       @LATTICE("O,THISLOC=O")\r
+       @RETURNLOC("O")\r
        protected boolean decodeFrame() throws JavaLayerException\r
        {               \r
                try\r
        protected boolean decodeFrame() throws JavaLayerException\r
        {               \r
                try\r
@@ -220,7 +225,7 @@ public class Player
 //                             return false;\r
                                \r
                        // sample buffer set when decoder constructed\r
 //                             return false;\r
                                \r
                        // sample buffer set when decoder constructed\r
-                       SampleBuffer output = (SampleBuffer)decoder.decodeFrame(header, bitstream);\r
+                       @LOC("O") SampleBuffer output = (SampleBuffer)decoder.decodeFrame(header, bitstream);\r
                                                                                                                                                                                                                                                                                                        \r
                        //synchronized (this)\r
                        //{\r
                                                                                                                                                                                                                                                                                                        \r
                        //synchronized (this)\r
                        //{\r
index 913b8b02bcdc1e6535199029645d042c56a8324e..211a328cb70d5f7a1ab5a345478ca673f4bb2544 100644 (file)
@@ -140,7 +140,7 @@ public class SampleBuffer extends Obuffer
   /**
    * Write the samples to the file (Random Acces).
    */
   /**
    * 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) 
   {
 
     //for (int i = 0; i < channels; ++i) 
index dbfcd873a2727861431907e71793aa722ccd273a..eff274d9bba0e7c4ea890e3345b5ca0f1fed2095 100644 (file)
@@ -3,7 +3,7 @@
 /**
  * Abstract base class for subband classes of layer I and II
  */
 /**
  * Abstract base class for subband classes of layer I and II
  */
-   @LATTICE("L<H")
+   @LATTICE("S<L,L<H")
 static abstract class Subband
 {
  /*
 static abstract class Subband
 {
  /*
index c1110cc72dca07f5e9eeba4bb8c0a261fcdd419d..dab977a3ef42ba693b788f3eada1781af65a66e4 100644 (file)
@@ -159,7 +159,7 @@ final class SynthesisFilter
          samples[subbandnumber] = eq[subbandnumber]*sample;\r
   }\r
 \r
          samples[subbandnumber] = eq[subbandnumber]*sample;\r
   }\r
 \r
-  public void input_samples(float[] s)\r
+  public void input_samples(@LOC("V") float[] s)\r
   {\r
          for (int i=31; i>=0; i--)\r
          {             \r
   {\r
          for (int i=31; i>=0; i--)\r
          {             \r