src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18 using Native = Interop.AudioEffect;
  19
  20 namespace Tizen.Multimedia
  21 {
  22     /// <summary>
  23     /// Provides the ability to control the audio effects for <see cref="Multimedia.Player"/>.
  24     /// </summary>
  25     public class AudioEffect
  26     {
  27         private readonly EqualizerBand[] _bands;
  28
  29         internal AudioEffect(Player owner)
  30         {
  31             Player = owner;
  32
  33             bool available = false;
  34
  35             Native.EqualizerIsAvailable(Player.Handle, out available).
  36                 ThrowIfFailed("Failed to initialize the AudioEffect");
  37
  38             IsAvailable = available;
  39
  40             if (IsAvailable == false)
  41             {
  42                 return;
  43             }
  44
  45             int count = 0;
  46             Native.GetEqualizerBandsCount(Player.Handle, out count).
  47                 ThrowIfFailed("Failed to initialize the AudioEffect");
  48
  49             int min = 0;
  50             int max = 0;
  51             Native.GetEqualizerLevelRange(Player.Handle, out min, out max).
  52                 ThrowIfFailed("Failed to initialize the AudioEffect");
  53
  54             Count = count;
  55             BandLevelRange = new Range(min, max);
  56
  57             _bands = new EqualizerBand[count];
  58         }
  59
  60         /// <summary>
  61         /// Gets a <see cref="EqualizerBand"/> at the specified index.
  62         /// </summary>
  63         /// <param name="index">The index of the band to get.</param>
  64         /// <exception cref="ObjectDisposedException">The <see cref="Player"/> has already been disposed of.</exception>
  65         /// <exception cref="ArgumentOutOfRangeException">
  66         ///     index is less than zero.\n
  67         ///     -or-\n
  68         ///     index is equal to or greater than <see cref="Count"/>.
  69         /// </exception>
  70         public EqualizerBand this[int index]
  71         {
  72             get
  73             {
  74                 Log.Debug(PlayerLog.Tag, PlayerLog.Enter);
  75                 Player.ValidateNotDisposed();
  76
  77                 if (index < 0 || Count <= index)
  78                 {
  79                     throw new ArgumentOutOfRangeException(nameof(index), index,
  80                         $"Valid index is 0 <= x < { nameof(Count) } ");
  81                 }
  82
  83                 if (_bands[index] == null)
  84                 {
  85                     _bands[index] = new EqualizerBand(this, index);
  86                 }
  87                 Log.Info(PlayerLog.Tag, "get equalizer band : " + _bands[index]);
  88                 return _bands[index];
  89             }
  90         }
  91
  92         /// <summary>
  93         /// Clears the equalizer effect.
  94         /// </summary>
  95         /// <exception cref="ObjectDisposedException">The <see cref="Player"/> has already been disposed of.</exception>
  96         public void Clear()
  97         {
  98             Log.Debug(PlayerLog.Tag, PlayerLog.Enter);
  99             Player.ValidateNotDisposed();
 100
 101             Native.EqualizerClear(Player.Handle).
 102                 ThrowIfFailed("Failed to clear equalizer effect");
 103             Log.Debug(PlayerLog.Tag, PlayerLog.Leave);
 104         }
 105
 106         /// <summary>
 107         /// Get the number of items.
 108         /// </summary>
 109         public int Count { get; }
 110
 111         /// <summary>
 112         /// Get the band level range of the bands in dB.
 113         /// </summary>
 114         public Range BandLevelRange { get; }
 115
 116         /// <summary>
 117         /// Gets the value whether the AudioEffect is available or not.
 118         /// </summary>
 119         public bool IsAvailable { get; }
 120
 121         /// <summary>
 122         /// Gets the player that this AudioEffect belongs to.
 123         /// </summary>
 124         public Player Player { get; }
 125     }
 126 }