modules/vendor-api-nokia/src/main/java/com/nokia/mid/sound/Sound.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package com.nokia.mid.sound;
  11
  12 import cc.squirreljme.runtime.cldc.annotation.Api;
  13 import cc.squirreljme.runtime.cldc.annotation.ApiDefinedDeprecated;
  14 import cc.squirreljme.runtime.cldc.debug.Debugging;
  15 import javax.microedition.media.Manager;
  16 import javax.microedition.media.MediaException;
  17
  18 /**
  19  * Provides an interface for playing digitized audio along with simple sounds.
  20  *
  21  * All implementations must support tone based sounds.
  22  *
  23  * @since 2022/02/03
  24  */
  25 @ApiDefinedDeprecated
  26 @Api
  27 public class Sound
  28 {
  29         /** A simple tone based sound. */
  30         @Api
  31         @ApiDefinedDeprecated
  32         public static final int FORMAT_TONE = 1;
  33
  34         /** A digitized waveform audio. */
  35         @Api
  36         @ApiDefinedDeprecated
  37         public static final int FORMAT_WAVE = 5;
  38
  39         /** A sound is playing. */
  40         @Api
  41         @ApiDefinedDeprecated
  42         public static final int SOUND_PLAYING = 0;
  43
  44         /** A sound is stopped. */
  45         @Api
  46         @ApiDefinedDeprecated
  47         public static final int SOUND_STOPPED = 1;
  48
  49         /** A sound is not initialized. */
  50         @Api
  51         @ApiDefinedDeprecated
  52         public static final int SOUND_UNINITIALIZED = 3;
  53
  54         @Api
  55         @ApiDefinedDeprecated
  56         public Sound(byte[] __data, int __type)
  57         {
  58                 this.init(__data, __type);
  59         }
  60
  61         @Api
  62         @ApiDefinedDeprecated
  63         public Sound(int __freq, long __duration)
  64         {
  65                 this.init(__freq, __duration);
  66         }
  67
  68         @Api
  69         @ApiDefinedDeprecated
  70         public int getGain()
  71         {
  72                 throw Debugging.todo();
  73         }
  74
  75         @Api
  76         @ApiDefinedDeprecated
  77         public int getState()
  78         {
  79                 throw Debugging.todo();
  80         }
  81
  82         @Api
  83         @ApiDefinedDeprecated
  84         public void init(byte[] __data, int __type)
  85         {
  86                 Debugging.todoNote("init(%p, %d)", __data, __type);
  87                 throw new IllegalArgumentException("TODO");
  88         }
  89
  90         /**
  91          * Plays a simple tone through the device speaker.
  92          *
  93          * @param __freq The frequency to play the sound at.
  94          * @param __duration The duration in milliseconds to play the sound for.
  95          * @throws IllegalArgumentException If the frequency is not within range
  96          * of what the device support, or the duration is zero or negative.
  97          * @see Manager#playTone(int, int, int)
  98          * @since 2022/02/03
  99          */
 100         @Api
 101         @ApiDefinedDeprecated
 102         public void init(int __freq, long __duration)
 103                 throws IllegalArgumentException
 104         {
 105                 // {@squirreljme.error AI01 Invalid frequency and/or duration.}
 106                 if (__freq < 0 || __duration <= 0)
 107                         throw new IllegalArgumentException("AI01");
 108
 109                 try
 110                 {
 111                         Manager.playTone(__freq,
 112                                 (int)Math.min(__duration, Integer.MAX_VALUE), 100);
 113                 }
 114                 catch (MediaException e)
 115                 {
 116                         // {@squirreljme.error AI02 Sound out of range or failed to
 117                         // properly play.}
 118                         throw new IllegalArgumentException("AI02", e);
 119                 }
 120         }
 121
 122         @Api
 123         @ApiDefinedDeprecated
 124         public void play(int __loop)
 125         {
 126                 throw Debugging.todo();
 127         }
 128
 129         @Api
 130         @ApiDefinedDeprecated
 131         public void release()
 132         {
 133                 throw Debugging.todo();
 134         }
 135
 136         @Api
 137         @ApiDefinedDeprecated
 138         public void resume()
 139         {
 140                 throw Debugging.todo();
 141         }
 142
 143         @Api
 144         @ApiDefinedDeprecated
 145         public void setGain(int __gain)
 146         {
 147                 throw Debugging.todo();
 148         }
 149
 150         @Api
 151         @ApiDefinedDeprecated
 152         public void setSoundListener(SoundListener __listener)
 153         {
 154                 throw Debugging.todo();
 155         }
 156
 157         @Api
 158         @ApiDefinedDeprecated
 159         public void stop()
 160         {
 161                 throw Debugging.todo();
 162         }
 163
 164         @Api
 165         @ApiDefinedDeprecated
 166         public static int getConcurrentSoundCount(int __type)
 167         {
 168                 throw Debugging.todo();
 169         }
 170
 171         @Api
 172         @ApiDefinedDeprecated
 173         public static int[] getSupportedFormats()
 174         {
 175                 throw Debugging.todo();
 176         }
 177 }