path: root/src/JP2K_Codestream_Parser.cpp

/*
Copyright (c) 2004-2013, John Hurst
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
   derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*! \file    Codestream_Parser.cpp
    \version $Id$
    \brief   AS-DCP library, JPEG 2000 codestream essence reader implementation
*/

#include <KM_fileio.h>
#include <AS_DCP.h>
#include <JP2K.h>
#include <assert.h>
#include <KM_log.h>
using Kumu::DefaultLogSink;

//------------------------------------------------------------------------------------------

class ASDCP::JP2K::CodestreamParser::h__CodestreamParser
{
  ASDCP_NO_COPY_CONSTRUCT(h__CodestreamParser);

public:
  PictureDescriptor  m_PDesc;
  Kumu::FileReader   m_File;

  h__CodestreamParser()
  {
    memset(&m_PDesc, 0, sizeof(m_PDesc));
    m_PDesc.EditRate = Rational(24,1);
    m_PDesc.SampleRate = m_PDesc.EditRate;
  }

  ~h__CodestreamParser() {}

  Result_t OpenReadFrame(const std::string& filename, FrameBuffer& FB)
  {
    m_File.Close();
    Result_t result = m_File.OpenRead(filename);

    if ( ASDCP_SUCCESS(result) )
      {
	Kumu::fsize_t file_size = m_File.Size();

	if ( FB.Capacity() < file_size )
	  {
	    DefaultLogSink().Error("FrameBuf.Capacity: %u frame length: %u\n", FB.Capacity(), (ui32_t)file_size);
	    return RESULT_SMALLBUF;
	  }
      }

    ui32_t read_count;

    if ( ASDCP_SUCCESS(result) )
      result = m_File.Read(FB.Data(), FB.Capacity(), &read_count);

    if ( ASDCP_SUCCESS(result) )
      FB.Size(read_count);

    if ( ASDCP_SUCCESS(result) )
      {
	byte_t start_of_data = 0; // out param
	result = ParseMetadataIntoDesc(FB, m_PDesc, &start_of_data);

	if ( ASDCP_SUCCESS(result) )
	  FB.PlaintextOffset(start_of_data);
      }

    return result;
  }

  Result_t OpenReadFrame(const unsigned char * data, unsigned int size, FrameBuffer& FB)
  {
    if ( FB.Capacity() < size )
      {
        DefaultLogSink().Error("FrameBuf.Capacity: %u frame length: %u\n", FB.Capacity(), (ui32_t) size);
        return RESULT_SMALLBUF;
      }

    memcpy (FB.Data(), data, size);
    FB.Size(size);

    byte_t start_of_data = 0; // out param
    const Result_t result = ParseMetadataIntoDesc(FB, m_PDesc, &start_of_data);

    if ( ASDCP_SUCCESS(result) )
      FB.PlaintextOffset(start_of_data);

    return result;
  }
};

ASDCP::Result_t
ASDCP::JP2K::ParseMetadataIntoDesc(const FrameBuffer& FB, PictureDescriptor& PDesc, byte_t* start_of_data)
{
  Result_t result = RESULT_OK;
  Marker NextMarker;
  ui32_t i;
  const byte_t* p = FB.RoData();
  const byte_t* end_p = p + FB.Size();

  /* initialize optional items */

  PDesc.ExtendedCapabilities.N = JP2K::NoExtendedCapabilitiesSignaled;
  PDesc.Profile.N = 0;
  PDesc.CorrespondingProfile.N = 0;

  while ( p < end_p && ASDCP_SUCCESS(result) )
    {
      result = GetNextMarker(&p, NextMarker);

      if ( ASDCP_FAILURE(result) )
	{
	  result = RESULT_RAW_ESS;
	  break;
	}

      switch ( NextMarker.m_Type )
	{
	case MRK_SOD:
	  if ( start_of_data != 0 )
	    *start_of_data = p - FB.RoData();

	  p = end_p;
	  break;

	case MRK_SIZ:
	  {
	    Accessor::SIZ SIZ_(NextMarker);
	    PDesc.StoredWidth = SIZ_.Xsize();
	    PDesc.StoredHeight = SIZ_.Ysize();
	    PDesc.AspectRatio = Rational(SIZ_.Xsize(), SIZ_.Ysize());
	    PDesc.Rsize = SIZ_.Rsize();
	    PDesc.Xsize = SIZ_.Xsize();
	    PDesc.Ysize = SIZ_.Ysize();
	    PDesc.XOsize = SIZ_.XOsize();
	    PDesc.YOsize = SIZ_.YOsize();
	    PDesc.XTsize = SIZ_.XTsize();
	    PDesc.YTsize = SIZ_.YTsize();
	    PDesc.XTOsize = SIZ_.XTOsize();
	    PDesc.YTOsize = SIZ_.YTOsize();
	    PDesc.Csize = SIZ_.Csize();

	    if ( PDesc.Csize != 3 )
	      {
		DefaultLogSink().Error("Unexpected number of components: %u\n", PDesc.Csize);
		return RESULT_RAW_FORMAT;
	      }
	    
	    for ( i = 0; i < PDesc.Csize; i++ )
	      SIZ_.ReadComponent(i, PDesc.ImageComponents[i]);
	  }
	  break;

	case MRK_COD:
	  memset(&PDesc.CodingStyleDefault, 0, sizeof(CodingStyleDefault_t));

	  if ( NextMarker.m_DataSize > sizeof(CodingStyleDefault_t) )
	    {
	      DefaultLogSink().Error("Unexpectedly large CodingStyle data: %u\n", NextMarker.m_DataSize);
	      return RESULT_RAW_FORMAT;
	    }
	  
	  memcpy(&PDesc.CodingStyleDefault, NextMarker.m_Data, NextMarker.m_DataSize);
	  break;

	case MRK_QCD:
	  memset(&PDesc.QuantizationDefault, 0, sizeof(QuantizationDefault_t));

	  if ( NextMarker.m_DataSize < 3 ) // ( Sqcd = 8 bits, SPqcd = 8 bits ) == 2 bytes, error if not greater
	    {
	      DefaultLogSink().Error("No quantization signaled. QCD size=%s.\n", NextMarker.m_DataSize);
	      return RESULT_RAW_FORMAT;
	    }
	  
	  if ( NextMarker.m_DataSize > MaxDefaults )
	    {
	      DefaultLogSink().Error("Quantization Default length exceeds maximum %d\n", NextMarker.m_DataSize);
	      return RESULT_RAW_FORMAT;
	    }

	  memcpy(&PDesc.QuantizationDefault, NextMarker.m_Data, NextMarker.m_DataSize);
	  PDesc.QuantizationDefault.SPqcdLength = NextMarker.m_DataSize - 1;
	  break;

	case MRK_CAP:
	  {
	    Accessor::CAP CAP_(NextMarker);
	    
			PDesc.ExtendedCapabilities.Pcap = CAP_.pcap();

			PDesc.ExtendedCapabilities.N = CAP_.N();

			for (i32_t i = 0; i < CAP_.N(); i++) {

				PDesc.ExtendedCapabilities.Ccap[i] = CAP_.ccap(i);

			}

	  }
	  break;

		case MRK_PRF:
	  {
	    Accessor::PRF PRF_(NextMarker);

		ui16_t n = PRF_.N();

		if ( n > MaxPRFN )
	    {
	      DefaultLogSink().Error("Number (%d) of Pprf^i exceeds maximum supported\n", n);
	      return RESULT_RAW_FORMAT;
	    }

			PDesc.Profile.N = n;

			for(i32_t i = 0; i < n ; i++) {

				PDesc.Profile.Pprf[i] = PRF_.pprf(i+1);
			}
	  }
	  break;

		case MRK_CPF:
	  {
	    Accessor::CPF CPF_(NextMarker);

		ui16_t n = CPF_.N();

		if ( n > MaxCPFN )
	    {
	      DefaultLogSink().Error("Number (%d) of Pcpf^i exceeds maximum supported\n", n);
	      return RESULT_RAW_FORMAT;
	    }

			PDesc.CorrespondingProfile.N = n;

			for(i32_t i = 0; i < n; i++) {

				PDesc.CorrespondingProfile.Pcpf[i] = CPF_.pcpf(i+1);
			}
	  }
	  break;
		default:
	  break;

	}
    }

  return result;
}

//------------------------------------------------------------------------------------------

ASDCP::JP2K::CodestreamParser::CodestreamParser()
{
}

ASDCP::JP2K::CodestreamParser::~CodestreamParser()
{
}

// Opens the stream for reading, parses enough data to provide a complete
// set of stream metadata for the MXFWriter below.
ASDCP::Result_t
ASDCP::JP2K::CodestreamParser::OpenReadFrame(const std::string& filename, FrameBuffer& FB) const
{
  const_cast<ASDCP::JP2K::CodestreamParser*>(this)->m_Parser = new h__CodestreamParser;
  return m_Parser->OpenReadFrame(filename, FB);
}

// Opens the stream for reading, parses enough data to provide a complete
// set of stream metadata for the MXFWriter below.
ASDCP::Result_t
ASDCP::JP2K::CodestreamParser::OpenReadFrame(const unsigned char* data, unsigned int size, FrameBuffer& FB) const
{
  const_cast<ASDCP::JP2K::CodestreamParser*>(this)->m_Parser = new h__CodestreamParser;
  return m_Parser->OpenReadFrame(data, size, FB);
}

//
ASDCP::Result_t
ASDCP::JP2K::CodestreamParser::FillPictureDescriptor(PictureDescriptor& PDesc) const
{
  if ( m_Parser.empty() )
    return RESULT_INIT;

  PDesc = m_Parser->m_PDesc;
  return RESULT_OK;
}


//
// end Codestream_Parser.cpp
//