package/inc/ThreadedDeflater.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_PACKAGE_THREADEDDEFLATER_HXX
  21 #define INCLUDED_PACKAGE_THREADEDDEFLATER_HXX
  22
  23 #include <com/sun/star/uno/Sequence.hxx>
  24 #include <com/sun/star/io/XInputStream.hpp>
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <comphelper/threadpool.hxx>
  27 #include <memory>
  28 #include <vector>
  29 #include <functional>
  30
  31 namespace ZipUtils
  32 {
  33 /// Parallel compression a stream using the libz deflate algorithm.
  34 ///
  35 /// Call deflateWrite() with the input stream and input/output processing functions.
  36 /// This will use multiple threads for compression on each batch of data from the stream.
  37 class ThreadedDeflater final
  38 {
  39     class Task;
  40     // Note: All this should be lock-less. Each task writes only to its part
  41     // of the data.
  42     std::vector<std::vector<sal_Int8>> outBuffers;
  43     std::shared_ptr<comphelper::ThreadTaskTag> threadTaskTag;
  44     css::uno::Sequence<sal_Int8> inBuffer;
  45     css::uno::Sequence<sal_Int8> prevDataBlock;
  46     std::function<void(const css::uno::Sequence<sal_Int8>&, sal_Int32)> maProcessOutputFunc;
  47     sal_Int64 totalIn;
  48     sal_Int64 totalOut;
  49     int zlibLevel;
  50
  51 public:
  52     // Unlike with Deflater class, bNoWrap is always true.
  53     ThreadedDeflater(sal_Int32 nSetLevel);
  54     ~ThreadedDeflater() COVERITY_NOEXCEPT_FALSE;
  55     void deflateWrite(const css::uno::Reference<css::io::XInputStream>& xInStream,
  56                       const std::function<void(const css::uno::Sequence<sal_Int8>&, sal_Int32)>&
  57                           rProcessInputFunc,
  58                       const std::function<void(const css::uno::Sequence<sal_Int8>&, sal_Int32)>&
  59                           rProcessOutputFunc);
  60     sal_Int64 getTotalIn() const { return totalIn; }
  61     sal_Int64 getTotalOut() const { return totalOut; }
  62
  63 private:
  64     void processDeflatedBuffers();
  65     void clear();
  66 };
  67
  68 } // namespace
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */