/*

* cvs identifier:

*

* $Id: FileFormatWriter.java,v 1.13 2001/02/16 11:53:54 qtxjoas Exp $

*

* Class:                   FileFormatWriter

*

* Description:             Writes the file format

*

*

*

* COPYRIGHT:

*

* This software module was originally developed by Raphaël Grosbois and

* Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel

* Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David

* Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research

* Centre France S.A) in the course of development of the JPEG2000

* standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This

* software module is an implementation of a part of the JPEG 2000

* Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio

* Systems AB and Canon Research Centre France S.A (collectively JJ2000

* Partners) agree not to assert against ISO/IEC and users of the JPEG

* 2000 Standard (Users) any of their rights under the copyright, not

* including other intellectual property rights, for this software module

* with respect to the usage by ISO/IEC and Users of this software module

* or modifications thereof for use in hardware or software products

* claiming conformance to the JPEG 2000 Standard. Those intending to use

* this software module in hardware or software products are advised that

* their use may infringe existing patents. The original developers of

* this software module, JJ2000 Partners and ISO/IEC assume no liability

* for use of this software module or modifications thereof. No license

* or right to this software module is granted for non JPEG 2000 Standard

* conforming products. JJ2000 Partners have full right to use this

* software module for his/her own purpose, assign or donate this

* software module to any third party and to inhibit third parties from

* using this software module for non JPEG 2000 Standard conforming

* products. This copyright notice must be included in all copies or

* derivative works of this software module.

*

* Copyright (c) 1999/2000 JJ2000 Partners.

*  */

namespace CSJ2K.j2k.fileformat.writer

{

    using System;



    using CSJ2K.j2k.codestream;

    using CSJ2K.j2k.fileformat;

    using CSJ2K.j2k.io;



    /// <summary> This class writes the file format wrapper that may or may not exist around

    /// a valid JPEG 2000 codestream. This class writes the simple possible legal

    /// fileformat

    /// 

    /// </summary>

    /// <seealso cref="jj2000.j2k.fileformat.reader.FileFormatReader">

    /// 

    /// </seealso>

    internal class FileFormatWriter

    {

        #region Fields



        /// <summary>base length of Bits Per Component box </summary>

        private const int BPC_LENGTH = 8;



        /// <summary>Length of Colour Specification Box </summary>

        private const int CSB_LENGTH = 15;



        /// <summary>Length of File Type Box </summary>

        private const int FTB_LENGTH = 20;



        /// <summary>Length of Image Header Box </summary>

        private const int IHB_LENGTH = 22;



        /// <summary>Bits per component </summary>

        private int[] bpc;



        /// <summary>Flag indicating whether number of bits per component varies </summary>

        private bool bpcVaries;



        /// <summary>Length of codestream </summary>

        private int clength;



        /// <summary>The file from which to read the codestream and write file</summary>

        private BEBufferedRandomAccessFile fi;



        /// <summary>The name of the file from which to read the codestream and to write

        /// the JP2 file

        /// </summary>

        private System.String filename;



        /// <summary>Image height </summary>

        private int height;



        /// <summary>Number of components </summary>

        private int nc;



        /// <summary>Image width </summary>

        private int width;



        #endregion Fields



        #region Constructors



        /// <summary> The constructor of the FileFormatWriter. It receives all the

        /// information necessary about a codestream to generate a legal JP2 file

        /// 

        /// </summary>

        /// <param name="filename">The name of the file that is to be made a JP2 file

        /// 

        /// </param>

        /// <param name="height">The height of the image

        /// 

        /// </param>

        /// <param name="width">The width of the image

        /// 

        /// </param>

        /// <param name="nc">The number of components

        /// 

        /// </param>

        /// <param name="bpc">The number of bits per component

        /// 

        /// </param>

        /// <param name="clength">Length of codestream 

        /// 

        /// </param>

        public FileFormatWriter(System.String filename, int height, int width, int nc, int[] bpc, int clength)

        {

            this.height = height;

            this.width = width;

            this.nc = nc;

            this.bpc = bpc;

            this.filename = filename;

            this.clength = clength;



            bpcVaries = false;

            int fixbpc = bpc[0];

            for (int i = nc - 1; i > 0; i--)

            {

                if (bpc[i] != fixbpc)

                    bpcVaries = true;

            }

        }



        #endregion Constructors



        #region Methods



        #region Public Methods



        /// <summary> This method writes the Bits Per Component box

        /// 

        /// </summary>

        /// <exception cref="java.io.IOException">If an I/O error ocurred.

        /// 

        /// </exception>

        public virtual void writeBitsPerComponentBox()

        {

            // Write box length (LBox)

            fi.writeInt(BPC_LENGTH + nc);



            // Write a Bits Per Component box (TBox)

            fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.BITS_PER_COMPONENT_BOX);



            // Write bpc fields

            for (int i = 0; i < nc; i++)

            {

                fi.writeByte(bpc[i] - 1);

            }

        }



        /// <summary> This method writes the Colour Specification box

        /// 

        /// </summary>

        /// <exception cref="java.io.IOException">If an I/O error ocurred.

        /// 

        /// </exception>

        public virtual void writeColourSpecificationBox()

        {

            // Write box length (LBox)

            fi.writeInt(CSB_LENGTH);



            // Write a Bits Per Component box (TBox)

            fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.COLOUR_SPECIFICATION_BOX);



            // Write METH field

            fi.writeByte(CSJ2K.j2k.fileformat.FileFormatBoxes.CSB_METH);



            // Write PREC field

            fi.writeByte(CSJ2K.j2k.fileformat.FileFormatBoxes.CSB_PREC);



            // Write APPROX field

            fi.writeByte(CSJ2K.j2k.fileformat.FileFormatBoxes.CSB_APPROX);



            // Write EnumCS field

            if (nc > 1)

                fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.CSB_ENUM_SRGB);

            else

                fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.CSB_ENUM_GREY);

        }



        /// <summary> This method writes the Contiguous codestream box

        /// 

        /// </summary>

        /// <param name="cs">The contiguous codestream

        /// 

        /// </param>

        /// <exception cref="java.io.IOException">If an I/O error ocurred.

        /// 

        /// </exception>

        public virtual void writeContiguousCodeStreamBox(byte[] cs)

        {

            // Write box length (LBox)

            // This value is set to 0 since in this implementation, this box is

            // always last

            fi.writeInt(clength + 8);



            // Write contiguous codestream box name (TBox)

            fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.CONTIGUOUS_CODESTREAM_BOX);



            // Write codestream

            for (int i = 0; i < clength; i++)

                fi.writeByte(cs[i]);

        }



        /// <summary> This method reads the codestream and writes the file format wrapper and

        /// the codestream to the same file

        /// 

        /// </summary>

        /// <returns> The number of bytes increases because of the file format

        /// 

        /// </returns>

        /// <exception cref="java.io.IOException">If an I/O error ocurred.

        /// 

        /// </exception>

        public virtual int writeFileFormat()

        {

            byte[] codestream;



            try

            {

                // Read and buffer the codestream

                fi = new BEBufferedRandomAccessFile(filename, "rw+");

                codestream = new byte[clength];

                fi.readFully(codestream, 0, clength);



                // Write the JP2_SINATURE_BOX

                fi.seek(0);

                fi.writeInt(0x0000000c);

                fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.JP2_SIGNATURE_BOX);

                fi.writeInt(0x0d0a870a);



                // Write File Type box

                writeFileTypeBox();



                // Write JP2 Header box

                writeJP2HeaderBox();



                // Write the Codestream box

                writeContiguousCodeStreamBox(codestream);



                fi.close();

            }

            catch (System.Exception e)

            {

                throw new System.ApplicationException("Error while writing JP2 file format(2): " + e.Message + "\n" + e.StackTrace);

            }

            if (bpcVaries)

                return 12 + FTB_LENGTH + 8 + IHB_LENGTH + CSB_LENGTH + BPC_LENGTH + nc + 8;

            else

                return 12 + FTB_LENGTH + 8 + IHB_LENGTH + CSB_LENGTH + 8;

        }



        /// <summary> This method writes the File Type box

        /// 

        /// </summary>

        /// <exception cref="java.io.IOException">If an I/O error ocurred.

        /// 

        /// </exception>

        public virtual void writeFileTypeBox()

        {

            // Write box length (LBox)

            // LBox(4) + TBox (4) + BR(4) + MinV(4) + CL(4) = 20

            fi.writeInt(FTB_LENGTH);



            // Write File Type box (TBox)

            fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.FILE_TYPE_BOX);



            // Write File Type data (DBox)

            // Write Brand box (BR)

            fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.FT_BR);



            // Write Minor Version

            fi.writeInt(0);



            // Write Compatibility list

            fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.FT_BR);

        }



        /// <summary> This method writes the Image Header box

        /// 

        /// </summary>

        /// <exception cref="java.io.IOException">If an I/O error ocurred.

        /// 

        /// </exception>

        public virtual void writeImageHeaderBox()

        {

            // Write box length

            fi.writeInt(IHB_LENGTH);



            // Write ihdr box name

            fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.IMAGE_HEADER_BOX);



            // Write HEIGHT field

            fi.writeInt(height);



            // Write WIDTH field

            fi.writeInt(width);



            // Write NC field

            fi.writeShort(nc);



            // Write BPC field

            // if the number of bits per component varies write 0xff else write

            // number of bits per components

            if (bpcVaries)

                fi.writeByte(0xff);

            else

                fi.writeByte(bpc[0] - 1);



            // Write C field

            fi.writeByte(CSJ2K.j2k.fileformat.FileFormatBoxes.IMB_C);



            // Write UnkC field

            fi.writeByte(CSJ2K.j2k.fileformat.FileFormatBoxes.IMB_UnkC);



            // Write IPR field

            fi.writeByte(CSJ2K.j2k.fileformat.FileFormatBoxes.IMB_IPR);

        }



        /// <summary> This method writes the JP2Header box

        /// 

        /// </summary>

        /// <exception cref="java.io.IOException">If an I/O error ocurred.

        /// 

        /// </exception>

        public virtual void writeJP2HeaderBox()

        {

            // Write box length (LBox)

            // if the number of bits per components varies, a bpcc box is written

            if (bpcVaries)

                fi.writeInt(8 + IHB_LENGTH + CSB_LENGTH + BPC_LENGTH + nc);

            else

                fi.writeInt(8 + IHB_LENGTH + CSB_LENGTH);



            // Write a JP2Header (TBox)

            fi.writeInt(CSJ2K.j2k.fileformat.FileFormatBoxes.JP2_HEADER_BOX);



            // Write image header box

            writeImageHeaderBox();



            // Write Colour Bpecification Box

            writeColourSpecificationBox();



            // if the number of bits per components varies write bpcc box

            if (bpcVaries)

                writeBitsPerComponentBox();

        }



        #endregion Public Methods



        #endregion Methods

    }

}