JP2_Decoder.hh

Go to the documentation of this file.

/*  JP2_Decoder

HiROC CVS ID: JP2_Decoder.hh,v 1.16 2020/05/14 00:12:14 guym Exp

Copyright (C) 2007  Arizona Board of Regents on behalf of the
Planetary Image Research Laboratory, Lunar and Planetary Laboratory at
the University of Arizona.

This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License, version 2.1,
as published by the Free Software Foundation.

This library 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
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
*/

#ifndef _JP2_Decoder_
#define _JP2_Decoder_

#include    "Dimensions.hh"

//  Kakadu
#include    "jp2.h"
using namespace kdu_supp;

#include    <string>
#include    <ios>

namespace UA
{
namespace HiRISE
{
//  Forward reference.
class JP2_Decoder_Error;

class JP2_Decoder
{
public:
/*==============================================================================
    Constants:
*/
static const char* const
    ID;

static const char* const
    UUID_INFO_BOX_NAME;
static const char* const
    UUID_BOX_NAME;
#define UUID_SIZE   16

static const char* const
    URL_BOX_NAME;

static const int
    MIN_STRIPE_HEIGHT,
    MAX_STRIPE_HEIGHT;

static const int
    DECODER_EXCEPTION;

/*==============================================================================
    Constructors:
*/
JP2_Decoder ();

/*==============================================================================
    Accessors:
*/
//------------------------------------------------------------------------------
//  Input

std::string source () const
    {return JP2_Pathname;}

JP2_Decoder& source (const std::string& pathname);

Size_2D image_size () const
    {return Image_Size;}

unsigned int image_width () const
    {return Image_Size.Width;}

unsigned int image_height () const
    {return Image_Size.Height;}

unsigned int image_bands () const
    {return Image_Bands;}

unsigned int resolution_levels () const
    {return Resolution_Levels;}

unsigned int pixel_bytes () const
    {return Pixel_Bytes;}

unsigned int pixel_bits () const
    {return Pixel_Bits;}

bool signed_data () const
    {return Signed_Data;}

unsigned char* const producer_UUID () const
    {return UUID_Info_UUID;}

std::string URL () const
    {return UUID_Info_URL;}

//------------------------------------------------------------------------------
//  Output

std::string destination () const
    {return Image_Destination;}

JP2_Decoder& destination (const std::string& pathname)
    {Image_Destination = pathname; return *this;}

Size_2D rendered_size () const;

unsigned int rendered_width () const;

unsigned int rendered_height () const;

Rectangle image_region () const
    {return Image_Region;}

JP2_Decoder& image_region (const Rectangle& region);

JP2_Decoder& image_region (int x, int y, int width, int height);

unsigned int resolution_level () const
    {return Resolution_Level;}

JP2_Decoder& resolution_level (unsigned int level);

bool swap_pixel_bytes () const
    {return Swap_Pixel_Bytes;}

JP2_Decoder& swap_pixel_bytes (bool swap_data)
    {Swap_Pixel_Bytes = swap_data; return *this;}

unsigned long long bytes_written () const
    {return Bytes_Written;}

/*==============================================================================
    Decoder
*/
bool ready () const;

std::string reasons () const;

unsigned long long decode ();

void open ();

bool is_open () const;

unsigned long long write_image_data ();

void close ();

JP2_Decoder_Error* decoder_error () const;

/*============================================================================
    Image Data Writers:
*/
protected:

std::streamsize write_stripe
    (std::ostream& destination, std::streamoff file_offset,
        int band, int line, int lines, kdu_int16* buffer);

std::streamsize write_stripe
    (std::ostream& destination, std::streamoff file_offset,
        int band, int line, int lines, kdu_int32* buffer);

/*============================================================================
    Helpers:
*/
protected:

void
set_resolution_and_region
    (unsigned int level, const Rectangle& region);

/*==============================================================================
    Data Members:
*/
protected:
//------------------------------------------------------------------------------
//  Input:

std::string
    JP2_Pathname;

unsigned int
    Image_Bands;

Size_2D
    Image_Size;

unsigned int
    Pixel_Bytes;

unsigned int
    Pixel_Bits;

bool
    Signed_Data;

unsigned int
    Resolution_Levels;

unsigned char
    *UUID_Info_UUID;

std::string
    UUID_Info_URL;

//------------------------------------------------------------------------------
//  Output:

std::string
    Image_Destination;

Size_2D
    Rendered_Size;

Rectangle
    Image_Region;

unsigned int
    Resolution_Level;

bool
    Swap_Pixel_Bytes;

unsigned long long
    Bytes_Written;

private:
//------------------------------------------------------------------------------
//  Kakadu classes used during JP2 file rendering.

jp2_family_src
    *JP2_Stream;

jp2_source
    *JP2_Source;

kdu_codestream
    *JPEG2000_Codestream;


JP2_Decoder_Error
    *Decoder_Error;

};  //  Class JP2_Decoder


#ifndef DOXYGEN_PROCESSING
/*=*****************************************************************************
    JP2_Decoder_Error
*/
class JP2_Decoder_Error
:   public kdu_thread_safe_message
{
public:

void put_text (const char* message);
void flush (bool end_of_message = false);

std::string
    Message;
};
#endif  //  DOXYGEN_PROCESSING


}   //  namespace HiRISE
}   //  namespace UA
#endif