/*
 * Copyright (c) 2004 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef __SDIFHeader__
#define __SDIFHeader__

#include <CLAM/SDIFType.hxx>

namespace SDIF
{

	/**
	* Base header for all frames. 
	* The only frame that uses this header directly is the special 
	* OpeningFrame.
	*
	* @see DataFrameHeader
	*/

	class FrameHeader
	{
	public:
		//* Identifier indicating the kind of frame */
		TypeId mType;
		//* Size in bytes, of the frame, not including the type or size
		CLAM::TInt32 mSize;
	public:
		/** Create a new FrameHeader
		* @param type Identifier specifying the frame type
		*/
		FrameHeader(const TypeId& type, CLAM::TInt32 size);

		static CLAM::TInt32 SizeInFile(void)
		{
			return 
				sizeof(TypeId)+ // mType
				sizeof(CLAM::TInt32); // mSize
		}
	};

	/**
	*       An extension of FrameHeader, that is used for data frames.
	*       This is the header that is used for a Frame.
	*/
	class DataFrameHeader:public FrameHeader 
	{
	public:
		 //* Timestamp
		CLAM::TFloat64 mTime;
		//* Stream ID @see Stream
		CLAM::TInt32 mStreamId;
		//* Number of data matrixes in the frame. @see Matrix
		CLAM::TInt32 mnMatrices;
	public:
		/** Create a new DataFrameHeader
		* @param type Identifier specifying the frame type
		* @param time Timestamp of the frame
		* @param id Stream ID
		*/
		DataFrameHeader(const TypeId& type,CLAM::TFloat64 time=0.,CLAM::TInt32 id=0);

		static CLAM::TInt32 SizeInFile(void)
		{
			return 
				sizeof(CLAM::TFloat64)+ // mTime
				sizeof(CLAM::TInt32)+   // mStreamId
				sizeof(CLAM::TInt32);   // mnMatrices
		}
	};

	/** The header for each Matrix
	*/
	class MatrixHeader
	{
	public:
	
		//* Identifier indicating the matrix type
		TypeId mType;
		//* Identifier indicating the type of data in the matrix
		DataType mDataType;
		//* Number of rows in the matrix
		CLAM::TInt32 mnRows;
		//* Number of columns in the matrix
		CLAM::TInt32 mnColumns;

	public:
		/** Create a new MatrixHeader
		* @param type Identifier specifying the matrix type
		* @param dataType Identifier specifying the type of data type in the matrix
		* @param nRows Number of rows in the matrix
		* @param nColumns Number of rows in the matrix
		*/
		
		static CLAM::TInt32 SizeInFile(void)
		{
			return 
				sizeof(TypeId)+
				sizeof(CLAM::TInt32)+ // mDataType
				sizeof(CLAM::TInt32)+ // mnRows
				sizeof(CLAM::TInt32); // mnColumns
		}
		
		MatrixHeader()
		{
		}
		
		MatrixHeader(
			const TypeId& type,
			DataType dataType,
			CLAM::TInt32 nRows, CLAM::TInt32 nColumns);
	};

}

#endif

