include/vcl/pngread.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_PNGREAD_HXX
  21 #define INCLUDED_VCL_PNGREAD_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <vcl/bitmapex.hxx>
  25 #include <memory>
  26 #include <vector>
  27
  28 namespace vcl
  29 {
  30 class PNGReaderImpl;
  31
  32 class VCL_DLLPUBLIC PNGReader
  33 {
  34     std::unique_ptr<PNGReaderImpl> mpImpl;
  35
  36 public:
  37     /* the PNG chunks are read within the c'tor, so the stream will
  38     be positioned at the end of the PNG */
  39     explicit PNGReader(SvStream& rStream);
  40     ~PNGReader();
  41
  42     /* an empty preview size hint (=default) will read the whole image
  43     */
  44     BitmapEx Read();
  45
  46     // retrieve every chunk that resides inside the PNG
  47     struct ChunkData
  48     {
  49         sal_uInt32 nType = 0;
  50         std::vector<sal_uInt8> aData;
  51     };
  52     const std::vector<ChunkData>& GetChunks() const;
  53 };
  54
  55 } // end namespace vcl
  56
  57 #endif // INCLUDED_VCL_PNGREAD_HXX
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */