SlimDXc_Jun2010(VC++2008)/source/multimedia/WaveFormatExtensible.h

   1 /*
   2 * Copyright (c) 2007-2010 SlimDX Group
   3 *
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy
   5 * of this software and associated documentation files (the "Software"), to deal
   6 * in the Software without restriction, including without limitation the rights
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8 * copies of the Software, and to permit persons to whom the Software is
   9 * furnished to do so, subject to the following conditions:
  10 *
  11 * The above copyright notice and this permission notice shall be included in
  12 * all copies or substantial portions of the Software.
  13 *
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20 * THE SOFTWARE.
  21 */
  22 #pragma once
  23
  24 #include "WaveFormat.h"
  25
  26 namespace SlimDX
  27 {
  28         namespace Multimedia
  29         {
  30                 public ref class WaveFormatExtensible : WaveFormat, System::ICloneable, System::IEquatable<WaveFormatExtensible^>
  31                 {
  32                 private:
  33                         short unionData;
  34
  35                 internal:
  36                         virtual System::Object^ Clone2() override = System::ICloneable::Clone
  37                         {
  38                                 return Clone();
  39                         }
  40
  41                         static WaveFormatExtensible^ FromBase( const WAVEFORMATEX *format );
  42                         WaveFormatExtensible( const WAVEFORMATEXTENSIBLE &format );
  43
  44                 public:
  45                         WaveFormatExtensible();
  46
  47                         property Speakers ChannelMask;
  48                         property System::Guid SubFormat;
  49
  50                         property short ValidBitsPerSample
  51                         {
  52                                 short get() { return unionData; }
  53                                 void set( short value ) { unionData = value; }
  54                         }
  55
  56                         property short SamplesPerBlock
  57                         {
  58                                 short get() { return unionData; }
  59                                 void set( short value ) { unionData = value; }
  60                         }
  61
  62                         virtual array<System::Byte>^ GetBytes() override;
  63
  64                         /// <summary>
  65                         /// Clones the instance and returns a new object containing the same values.
  66                         /// </summary>
  67                         /// <returns>A new <see cref="WaveFormatExtensible"/> object containing the same values as the current instance.</returns>
  68                         WaveFormatExtensible^ Clone() new;
  69
  70                         /// <summary>
  71                         /// Tests for equality between two objects.
  72                         /// </summary>
  73                         /// <param name="left">The first value to compare.</param>
  74                         /// <param name="right">The second value to compare.</param>
  75                         /// <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  76                         static bool operator == ( WaveFormatExtensible^ left, WaveFormatExtensible^ right );
  77
  78                         /// <summary>
  79                         /// Tests for inequality between two objects.
  80                         /// </summary>
  81                         /// <param name="left">The first value to compare.</param>
  82                         /// <param name="right">The second value to compare.</param>
  83                         /// <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
  84                         static bool operator != ( WaveFormatExtensible^ left, WaveFormatExtensible^ right );
  85
  86                         /// <summary>
  87                         /// Returns the hash code for this instance.
  88                         /// </summary>
  89                         /// <returns>A 32-bit signed integer hash code.</returns>
  90                         virtual int GetHashCode() override;
  91
  92                         /// <summary>
  93                         /// Returns a value that indicates whether the current instance is equal to a specified object.
  94                         /// </summary>
  95                         /// <param name="obj">Object to make the comparison with.</param>
  96                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
  97                         virtual bool Equals( System::Object^ obj ) override;
  98
  99                         /// <summary>
 100                         /// Returns a value that indicates whether the current instance is equal to the specified object.
 101                         /// </summary>
 102                         /// <param name="other">Object to make the comparison with.</param>
 103                         /// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
 104                         virtual bool Equals( WaveFormatExtensible^ other );
 105
 106                         /// <summary>
 107                         /// Determines whether the specified object instances are considered equal.
 108                         /// </summary>
 109                         /// <param name="value1">The first value to compare.</param>
 110                         /// <param name="value2">The second value to compare.</param>
 111                         /// <returns><c>true</c> if <paramref name="value1"/> is the same instance as <paramref name="value2"/> or
 112                         /// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
 113                         static bool Equals( WaveFormatExtensible^ value1, WaveFormatExtensible^ value2 );
 114                 };
 115         }
 116 }