FELICS_Line_Cache.hh

Go to the documentation of this file.

/*  HiRISE FELICS Line Cache

PIRL CVS ID: FELICS_Line_Cache.hh,v 1.13 2026/07/22 17:30:39 guym Exp

Copyright (C) 2004-2020 Arizona Board of Regents on behalf of the Lunar and
Planetary Laboratory at the University of Arizona.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
*/
#ifndef _HiRISE_FELICS_Line_Cache_
#define _HiRISE_FELICS_Line_Cache_

#include <cstddef>   // for NULL, brought in for Cache.hh
#include    <iostream>
#include    <string>

// PIRL
#include "Cache.hh"

// UA::HIRISE
#include "Line_Cache.hh"

extern "C" {
 int
decompress
   (
   char        *compressed,
   unsigned int   amount,
   char        *decompressed,
   unsigned int   width,
   unsigned int   height
   );
}

namespace UA
{
namespace HiRISE
{
//  Forward references
class Image_Line;

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

static const int
    SYNC_BYTES;

static const u_int_8
    SYNC_PATTERN[];

static const int
    SYNC_BYTE_FACTOR;

static const int
    MAX_LINES_PER_BLOCK;

static const int
    MIN_GAP_BYTES;

/*==============================================================================
    Constructors
*/
explicit FELICS_Line_Cache (Image_Line& image_line, std::istream& stream);

private:
FELICS_Line_Cache ();
FELICS_Line_Cache (const FELICS_Line_Cache&);
FELICS_Line_Cache& operator= (const FELICS_Line_Cache&);

public:
/*==============================================================================
    Accessors
*/
virtual unsigned long long bytes_read () const;

virtual bool compressed_data () const
    {return true;}

virtual unsigned long long compressed_bytes () const
    {return Compressed_Bytes;}

virtual unsigned long long decompressed_bytes () const
    {return Decompressed_Bytes;}

virtual Line_Cache& source (std::istream& stream);

virtual std::istream& source () const;

/*==============================================================================
    Manipulators
*/
virtual bool refill (unsigned long max_amount = (unsigned long)-1);

/*  Resets the cache to its empty state.

    The local Cache and the parent Line_Cache are reset. The number of
    {@link compressed_bytes() compressed bytes} and {@link
    decompressed_bytes() decompressed bytes} processed are reset to zero.

    @see    Line_Cache::reset()
*/
virtual void reset ();

/*==============================================================================
    FELICS Algorithm
*/
static int
decompress
    (
    char            *compressed,
    unsigned int    amount,
    char            *decompressed,
    unsigned int    width,
    unsigned int    height
    );

/*==============================================================================
    Utility Functions
*/
static bool is_sync (void* data_at);

/*==============================================================================
    Cache Management
*/
private:

class PIRL::Cache
    Data_Cache;

long long
    Compressed_Bytes;

long long
    Decompressed_Bytes;

};  //  class FELICS_Line_Cache

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