ojph_codestream.h

Go to the documentation of this file.

//***************************************************************************/
// This software is released under the 2-Clause BSD license, included
// below.
//
// Copyright (c) 2019, Aous Naman
// Copyright (c) 2019, Kakadu Software Pty Ltd, Australia
// Copyright (c) 2019, The University of New South Wales, Australia
//
// 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.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT
// HOLDER OR CONTRIBUTORS 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.
//***************************************************************************/
// This file is part of the OpenJPH software implementation.
// File: ojph_codestream.h
// Author: Aous Naman
// Date: 28 August 2019
//***************************************************************************/
 
 
#ifndef OJPH_CODESTREAM_H
#define OJPH_CODESTREAM_H
 
#include <cstdlib>
 
#include "ojph_arch.h"
#include "ojph_defs.h"
 
namespace ojph {
 
  //local prototyping
  namespace local {
    class codestream;
  };
 
  //defined elsewhere
  class param_siz;
  class param_cod;
  class param_qcd;
  class param_nlt;
  class comment_exchange;
  class mem_fixed_allocator;
  struct point;
  class line_buf;
  class outfile_base;
  class infile_base;
 
 
  class OJPH_EXPORT codestream
  {
  public:
    codestream();
 
    ~codestream();
 
    void restart();
 
    void set_planar(bool planar);
 
    void set_profile(const char* s);
 
    void set_tilepart_divisions(bool at_resolutions, bool at_components);
 
    bool is_tilepart_division_at_resolutions();
 
    bool is_tilepart_division_at_components();
 
    void request_tlm_marker(bool needed);
 
    bool is_tlm_requested();
 
    void write_headers(outfile_base *file,
                       const comment_exchange* comments = NULL,
                       ui32 num_comments = 0);
 
    line_buf* exchange(line_buf* line, ui32& next_component);
 
    void flush();
 
    void enable_resilience();             // before read_headers
 
    void read_headers(infile_base *file); // before resolution restrictions
 
    void restrict_input_resolution(ui32 skipped_res_for_data,
                                   ui32 skipped_res_for_recon); //before create
 
    void create();
 
    line_buf* pull(ui32 &comp_num);
 
    void close();
 
    param_siz access_siz();
 
    param_cod access_cod();
 
    param_qcd access_qcd();
 
    param_nlt access_nlt();
 
    bool is_planar() const;
 
  private:
    local::codestream* state;
  };
 
}
 
#endif // !OJPH_CODESTREAM_H