nokiacontinuoustuneplayer.java

J2ME MIDP_Example_Applications

// Copyright 2002 Nokia Corporation.
//
// THIS SOURCE CODE IS PROVIDED 'AS IS', WITH NO WARRANTIES WHATSOEVER,
// EXPRESS OR IMPLIED, INCLUDING ANY WARRANTY OF MERCHANTABILITY, FITNESS
// FOR ANY PARTICULAR PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE
// OR TRADE PRACTICE, RELATING TO THE SOURCE CODE OR ANY WARRANTY OTHERWISE
// ARISING OUT OF ANY PROPOSAL, SPECIFICATION, OR SAMPLE AND WITH NO
// OBLIGATION OF NOKIA TO PROVIDE THE LICENSEE WITH ANY MAINTENANCE OR
// SUPPORT. FURTHERMORE, NOKIA MAKES NO WARRANTY THAT EXERCISE OF THE
// RIGHTS GRANTED HEREUNDER DOES NOT INFRINGE OR MAY NOT CAUSE INFRINGEMENT
// OF ANY PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OWNED OR CONTROLLED
// BY THIRD PARTIES
//
// Furthermore, information provided in this source code is preliminary,
// and may be changed substantially prior to final release. Nokia Corporation
// retains the right to make changes to this source code at
// any time, without notice. This source code is provided for informational
// purposes only.
//
// Nokia and Nokia Connecting People are registered trademarks of Nokia
// Corporation.
// Java and all Java-based marks are trademarks or registered trademarks of
// Sun Microsystems, Inc.
// Other product and company names mentioned herein may be trademarks or
// trade names of their respective owners.
//
// A non-exclusive, non-transferable, worldwide, limited license is hereby
// granted to the Licensee to download, print, reproduce and modify the
// source code. The licensee has the right to market, sell, distribute and
// make available the source code in original or modified form only when
// incorporated into the programs developed by the Licensee. No other
// license, express or implied, by estoppel or otherwise, to any other
// intellectual property rights is granted herein.


package example.postcard;

import java.util.*;
import com.nokia.mid.sound.Sound;


// A vendor specific sound effects class that uses
// the Nokia UI API's class com.nokia.mid.sound.

class NokiaContinuousTunePlayer
    extends ContinuousTunePlayer
{
    private volatile boolean isPaused = false;
    private Sound sound = null;
    private byte[] music = null; // ringing tone


    protected NokiaContinuousTunePlayer()
    {
        try
        {
            // A '1/32 rest' defined in Smart Messaging Ringing Tone format.
            music = convertHexToBinary("024A3A804020242800");
        }
        catch(Exception e)
        {
            // hex format exception: no music
            music = null;
        }
    }


    boolean hasSoundSupport()
    {
        return true;
    }


    void stop()
    {
        synchronized(this)
        {
            isPaused = true;
        }

        if (sound != null)
        {
            sound.stop();
        }
    }


    void restart()
    {
        synchronized(this)
        {
            isPaused = false;  // Enable Sounds to be played.
        }

        if (sound != null)
        {
            playContinuously();
        }
    }


    void playContinuously()
    {
        if (!isPaused && (music != null))
        {
            try
            {
                if (sound == null)
                {
                    sound = new Sound(music, Sound.FORMAT_TONE);

                    // One could use setGain to set a default volume.
                }
                else
                {
                    sound.stop();
                    sound.init(music, Sound.FORMAT_TONE);
                }
                sound.play(0); // 0 = continuous play
            }
            catch(Exception e)
            {
                // If anything goes wrong, just don't play anything.
                // e.g. invalid music
            }
        }
    }


    // Convert hexadecimal-encoded binary data to raw binary

    private static byte[] convertHexToBinary(String hexData)
        throws Exception
    {
        if ( hexData.length() % 2 != 0 )
        {
            throw new Exception("Must be an even number of hex digits" );
        }
        byte[] binaryData = new byte[hexData.length() / 2 ];
        for (int i = 0; i < binaryData.length; ++i)
        {
            String byteStr = hexData.substring(i*2, i*2+2);
            // Integer.parseInt accepts a leading minus, whereas we don't,
            // so we must check for it first
            if (byteStr.charAt( 0 ) == '-')
            {
                throw new Exception("Invalid hex digit: -");
            }
            int value;
            try
            {
                value = Integer.parseInt(byteStr, 16);
            }
            catch (NumberFormatException e)
            {
                throw new Exception( "Invalid hex digits: " + byteStr);
            }
            binaryData[i] = (byte)value;
        }
        return binaryData;
    }


    void setTune(String string)
        throws Exception
    {
        music = convertHexToBinary(string);
    }
}