// -----------------------------------------
// SoundScribe (TM) and related software.
// 
// Copyright (C) 2007-2011 Vannatech
// http://www.vannatech.com
// All rights reserved.
// 
// This source code is subject to the MIT License.
// http://www.opensource.org/licenses/mit-license.php
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
// -----------------------------------------

using System;
using System.Runtime.InteropServices;

namespace CoreAudioTests.Common
{
    /// <summary>
    /// A variable-length structure that describes a data format.
    /// </summary>
    /// <remarks>
    /// MSDN Reference: http://msdn.microsoft.com/en-us/library/ff561656.aspx
    /// Note: This item is external to CoreAudio API, and is defined in the Windows Kernel Streaming API.
    /// </remarks>
    [StructLayout(LayoutKind.Sequential)]
    public struct KSDATAFORMAT
    {
        /// <summary>
        /// Specifies the size, in bytes, of the KSDATAFORMAT structure.
        /// </summary>
        public UInt32 FormatSize;

        /// <summary>
        /// Reserved, must be set to zero.
        /// </summary>
        public UInt32 Flags;

        /// <summary>
        /// Specifies the sample size of the data, for fixed sample sizes, or zero, if the format has a variable sample size.
        /// </summary>
        public UInt32 SampleSize;

        /// <summary>
        /// Reserved for system use. Drivers must set this member to zero.
        /// </summary>
        public UInt32 Reserved;

        /// <summary>
        /// Specifies the general format type.
        /// </summary>
        public Guid MajorFormat;

        /// <summary>
        /// Specifies the subformat of a general format type.
        /// </summary>
        public Guid SubFormat;

        /// <summary>
        /// Specifies additional data format type information.
        /// </summary>
        public Guid Specifier;
    }
}