home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 2000 November: Tool Chest / Dev.CD Nov 00 TC Disk 1.toast / Sample Code / Java / JavaRadioStation / Source / com / apple / jens / radio / Throttle.java < prev    next >
Encoding:
Java Source  |  2000-09-28  |  4.8 KB  |  118 lines  |  [TEXT/CWIE]
  1. /*
  2.     File:        Throttle.java
  3.     
  4.     Author:        Jens Alfke <jens@apple.com>
  5.  
  6.     Disclaimer:    IMPORTANT:  This Apple software is supplied to you by Apple Computer, Inc.
  7.                 ("Apple") in consideration of your agreement to the following terms, and your
  8.                 use, installation, modification or redistribution of this Apple software
  9.                 constitutes acceptance of these terms.  If you do not agree with these terms,
  10.                 please do not use, install, modify or redistribute this Apple software.
  11.  
  12.                 In consideration of your agreement to abide by the following terms, and subject
  13.                 to these terms, Apple grants you a personal, non-exclusive license, under Apple’s
  14.                 copyrights in this original Apple software (the "Apple Software"), to use,
  15.                 reproduce, modify and redistribute the Apple Software, with or without
  16.                 modifications, in source and/or binary forms; provided that if you redistribute
  17.                 the Apple Software in its entirety and without modifications, you must retain
  18.                 this notice and the following text and disclaimers in all such redistributions of
  19.                 the Apple Software.  Neither the name, trademarks, service marks or logos of
  20.                 Apple Computer, Inc. may be used to endorse or promote products derived from the
  21.                 Apple Software without specific prior written permission from Apple.  Except as
  22.                 expressly stated in this notice, no other rights or licenses, express or implied,
  23.                 are granted by Apple herein, including but not limited to any patent rights that
  24.                 may be infringed by your derivative works or by other works in which the Apple
  25.                 Software may be incorporated.
  26.  
  27.                 The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO
  28.                 WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
  29.                 WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  30.                 PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
  31.                 COMBINATION WITH YOUR PRODUCTS.
  32.  
  33.                 IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
  34.                 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  35.                 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  36.                 ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
  37.                 OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT
  38.                 (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN
  39.                 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40.                 
  41.     Change History (most recent first):
  42.  
  43. */
  44.  
  45.  
  46. package com.apple.jens.radio;
  47.  
  48.  
  49. /** A simple bandwidth manager that attempts to keep the current thread in sync with
  50.     a "clock" such as the timing of MP3 data.
  51.     This is used by Transmitter and by DJ implementations to keep themselves all running
  52.     at the proper (bit-) rate so they don't trip over each other. */
  53. public class Throttle {
  54.  
  55.     public Throttle( String name ) {
  56.         fName = name;
  57.         resetTime();
  58.     }
  59.     
  60.     
  61.     /** Moves the target time ahead by a certain number of milliseconds,
  62.         If the target time hasn't been reached yet, sleep until it's reached.
  63.         If the target time is already past, start logging messages. */
  64.     public void addTime( long millis ) throws InterruptedException {
  65.         fTarget += millis;
  66.         long snooze = fTarget - System.currentTimeMillis();
  67.         if( snooze > 0 ) {
  68.             // Ahead of schedule, so sleep:
  69.             Radio.LOG(3,fName,"Snoozing for "+snooze+"ms to match MP3 bitrate");
  70.             Thread.sleep(snooze);
  71.         } else {
  72.             // Behind schedule, uh-oh:
  73.             long slip = -snooze;
  74.             // If the slip is >100ms and has changed more than 10% since the last warning,
  75.             // send another warning:
  76.             if( slip > 100 && (fSlip==0 || Math.abs(slip-fSlip)/(float)fSlip >= 0.10) ) {
  77.                 Radio.LOG(1,fName,"I'm now "+(-snooze)+"ms behind schedule!");
  78.                 fSlip = slip;
  79.             }
  80.             if( slip > kMaxSlippage ) {
  81.                 // If the slip gets great enough, forget about it and start with a clean
  82.                 // state, otherwise the Transmitter will spend the rest of its life
  83.                 // fruitlessly trying to catch up.
  84.                 resetTime();
  85.                 fSlip = 0;
  86.                 Radio.LOG(1,fName,"...time to clean the slate and ignore the accumulated slip.");
  87.             }
  88.         }
  89.     }
  90.     
  91.     
  92.     /** Resets the target time to the current time.
  93.         This can be used to make sync stop logging messages
  94.         if the thread has fallen irreversably behind. */
  95.     public void resetTime( ) {
  96.         fTarget = System.currentTimeMillis();
  97.     }
  98.     
  99.     
  100.     private final String fName;
  101.     
  102.     /** The target time we're supposed to be at (as of the last call to addTime) */
  103.     private long fTarget;
  104.     
  105.     /** The amount of the last slip logged to the console */
  106.     private long fSlip;
  107.     
  108.     
  109.     // CONSTANTS:
  110.     
  111.     
  112.     /** Max milliseconds that the Transmitter can fall behind where it ought to be;
  113.         if this is exceeded, the Transmitter will forget about the accumulated slippage and start
  114.         its timing over again with a clean slate. */
  115.     public static final int kMaxSlippage = 2000;
  116.     
  117. }
  118.