vil_png.h

Go to the documentation of this file.

// This is core/vil/file_formats/vil_png.h
#ifndef vil_png_file_format_h_
#define vil_png_file_format_h_
//:
// \file
// \author   awf@robots.ox.ac.uk
// \date 17 Feb 00
//
//\verbatim
//  Modifications
//  3 October 2001 Peter Vanroose - Implemented get_property("top_row_first")
// 13 November 2002 Ian Scott - Converted to vil
//\endverbatim

#include <vil/vil_file_format.h>
#include <vil/vil_image_resource.h>

struct vil_png_structures;

//: Portable network graphics, http://www.cdrom.com/pub/png
class vil_png_file_format : public vil_file_format
{
 public:
  char const* tag() const override;
  vil_image_resource_sptr make_input_image(vil_stream* vs) override;
  vil_image_resource_sptr make_output_image(vil_stream* vs,
                                                    unsigned nx,
                                                    unsigned ny,
                                                    unsigned nplanes,
                                                    enum vil_pixel_format) override;
};

//: Generic image implementation for PNG files
class vil_png_image : public vil_image_resource
{
  vil_stream* vs_;
  int width_;
  int height_;
  int components_;
  int bits_per_component_;
  vil_pixel_format format_;

  bool read_header();
  bool write_header();

  friend class vil_png_file_format;
  vil_png_structures* p_;
 public:

  vil_png_image(vil_stream* is);
  vil_png_image(vil_stream* is, unsigned ni,
                unsigned nj, unsigned nplanes,
                vil_pixel_format format);
  ~vil_png_image() override;

  //: Dimensions:  planes x width x height x components
  unsigned nplanes() const override { return components_;}
  unsigned ni() const override { return width_; }
  unsigned nj() const override { return height_; }

  enum vil_pixel_format pixel_format() const override {return format_;}

  //: Create a read/write view of a copy of this data.
  // \return 0 if unable to get view of correct size.
  vil_image_view_base_sptr get_copy_view(unsigned i0, unsigned ni,
                                                 unsigned j0, unsigned nj) const override;

  //: Put the data in this view back into the image source.
  bool put_view(const vil_image_view_base& im, unsigned i0, unsigned j0) override;

  char const* file_format() const override;
  bool get_property(char const *tag, void *prop = nullptr) const override;
};

#endif // vil_png_file_format_h_