sd/source/ui/slidesorter/cache/SlsCacheCompactor.cxx

   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 #include <memory>
  21 #include "SlsCacheCompactor.hxx"
  22
  23 #include "SlsBitmapCompressor.hxx"
  24 #include "SlsBitmapCache.hxx"
  25
  26 #include <rtl/ustring.hxx>
  27 #include <sal/log.hxx>
  28 #include <officecfg/Office/Impress.hxx>
  29 #include <utility>
  30
  31 using namespace ::com::sun::star::uno;
  32
  33 namespace {
  34
  35 /** This is a trivial implementation of the CacheCompactor interface class.
  36     It ignores calls to RequestCompaction() and thus will never decrease the
  37     total size of off-screen preview bitmaps.
  38 */
  39 class NoCacheCompaction
  40     : public ::sd::slidesorter::cache::CacheCompactor
  41 {
  42 public:
  43     NoCacheCompaction (
  44         ::sd::slidesorter::cache::BitmapCache& rCache,
  45         sal_Int32 nMaximalCacheSize)
  46         : CacheCompactor(rCache, nMaximalCacheSize)
  47     {}
  48
  49     virtual void RequestCompaction() override { /* Ignored */ };
  50
  51 protected:
  52     virtual void Run() override { /* Do nothing */ };
  53 };
  54
  55 /** This implementation of the CacheCompactor interface class uses one of
  56     several bitmap compression algorithms to reduce the number of the bytes
  57     of the off-screen previews in the bitmap cache.  See the documentation
  58     of CacheCompactor::Create() for more details on configuration properties
  59     that control the choice of compression algorithm.
  60 */
  61 class CacheCompactionByCompression
  62     : public ::sd::slidesorter::cache::CacheCompactor
  63 {
  64 public:
  65     CacheCompactionByCompression (
  66         ::sd::slidesorter::cache::BitmapCache& rCache,
  67         sal_Int32 nMaximalCacheSize,
  68         std::shared_ptr< ::sd::slidesorter::cache::BitmapCompressor> pCompressor);
  69
  70 protected:
  71     virtual void Run() override;
  72
  73 private:
  74     std::shared_ptr< ::sd::slidesorter::cache::BitmapCompressor>  mpCompressor;
  75 };
  76
  77 } // end of anonymous namespace
  78
  79 namespace sd::slidesorter::cache {
  80
  81 ::std::unique_ptr<CacheCompactor> CacheCompactor::Create (
  82     BitmapCache& rCache,
  83     sal_Int32 nMaximalCacheSize)
  84 {
  85     static const char sNone[] = "None";
  86
  87     std::shared_ptr<BitmapCompressor> pCompressor;
  88     OUString sCompressionPolicy = officecfg::Office::Impress::MultiPaneGUI::SlideSorterBar::PreviewCache::CompressionPolicy::get();
  89     if (sCompressionPolicy == sNone)
  90         pCompressor = std::make_shared<NoBitmapCompression>();
  91     else if (sCompressionPolicy == "Erase")
  92         pCompressor = std::make_shared<CompressionByDeletion>();
  93     else if (sCompressionPolicy == "ResolutionReduction")
  94         pCompressor = std::make_shared<ResolutionReduction>();
  95     else // default: "PNGCompression"
  96         pCompressor = std::make_shared<PngCompression>();
  97
  98     ::std::unique_ptr<CacheCompactor> pCompactor;
  99     OUString sCompactionPolicy = officecfg::Office::Impress::MultiPaneGUI::SlideSorterBar::PreviewCache::CompactionPolicy::get();
 100     if (sCompactionPolicy == sNone)
 101         pCompactor.reset(new NoCacheCompaction(rCache,nMaximalCacheSize));
 102     else // default: "Compress"
 103         pCompactor.reset(new CacheCompactionByCompression(rCache, nMaximalCacheSize, std::move(pCompressor)));
 104
 105     return pCompactor;
 106 }
 107
 108 void CacheCompactor::RequestCompaction()
 109 {
 110     if ( ! mbIsCompactionRunning && ! maCompactionTimer.IsActive())
 111         maCompactionTimer.Start();
 112 }
 113
 114 CacheCompactor::CacheCompactor(
 115     BitmapCache& rCache,
 116     sal_Int32 nMaximalCacheSize)
 117     : mrCache(rCache),
 118       mnMaximalCacheSize(nMaximalCacheSize),
 119       maCompactionTimer("sd CacheCompactor maCompactionTimer"),
 120       mbIsCompactionRunning(false)
 121 {
 122     maCompactionTimer.SetTimeout(100);
 123     maCompactionTimer.SetInvokeHandler(LINK(this,CacheCompactor,CompactionCallback));
 124 }
 125
 126 IMPL_LINK_NOARG(CacheCompactor, CompactionCallback, Timer *, void)
 127 {
 128     mbIsCompactionRunning = true;
 129
 130     try
 131     {
 132         Run();
 133     }
 134     catch (const css::uno::RuntimeException&)
 135     {
 136     }
 137     catch (const css::uno::Exception&)
 138     {
 139     }
 140
 141     mbIsCompactionRunning = false;
 142 }
 143
 144 } // end of namespace ::sd::slidesorter::cache
 145
 146 namespace {
 147
 148 //===== CacheCompactionByCompression ==========================================
 149
 150 CacheCompactionByCompression::CacheCompactionByCompression (
 151     ::sd::slidesorter::cache::BitmapCache& rCache,
 152     sal_Int32 nMaximalCacheSize,
 153     std::shared_ptr< ::sd::slidesorter::cache::BitmapCompressor> pCompressor)
 154     : CacheCompactor(rCache,nMaximalCacheSize),
 155       mpCompressor(std::move(pCompressor))
 156 {
 157 }
 158
 159 void CacheCompactionByCompression::Run()
 160 {
 161     if (mrCache.GetSize() <= mnMaximalCacheSize)
 162         return;
 163
 164     SAL_INFO("sd.sls", __func__ << ": bitmap cache uses too much space: " << mrCache.GetSize() << " > " << mnMaximalCacheSize);
 165
 166     ::sd::slidesorter::cache::BitmapCache::CacheIndex aIndex (
 167         mrCache.GetCacheIndex());
 168     for (const auto& rpIndex : aIndex)
 169     {
 170         if (rpIndex == nullptr)
 171             continue;
 172
 173         mrCache.Compress(rpIndex, mpCompressor);
 174         if (mrCache.GetSize() < mnMaximalCacheSize)
 175             break;
 176     }
 177     mrCache.ReCalculateTotalCacheSize();
 178     SAL_INFO("sd.sls", __func__ << ":    there are now " << mrCache.GetSize() << " bytes occupied");
 179 }
 180
 181 } // end of anonymous namespace
 182
 183 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */