VC5Decompressor.h

Go to the documentation of this file.

/*
    RawSpeed - RAW file decoder.
 
    Copyright (C) 2018 Stefan Löffler
    Copyright (C) 2018 Roman Lebedev
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
 
#pragma once
 
#include "adt/Array1DRef.h"
#include "adt/Array2DRef.h"
#include "adt/DefaultInitAllocatorAdaptor.h"
#include "adt/Optional.h"
#include "bitstreams/BitStreamerMSB.h"
#include "codes/AbstractPrefixCode.h"
#include "codes/PrefixCodeLUTDecoder.h"
#include "codes/PrefixCodeVectorDecoder.h"
#include "common/BayerPhase.h"
#include "common/RawImage.h"
#include "common/SimpleLUT.h"
#include "decompressors/AbstractDecompressor.h"
#include "io/ByteStream.h"
#include <array>
#include <cstdint>
#include <memory>
#include <type_traits>
#include <utility>
#include <vector>
 
namespace rawspeed {
class ErrorLog;
 
const int MAX_NUM_PRESCALE = 8;
 
// Decompresses VC-5 as used by GoPro
 
enum class VC5Tag : int16_t {
  NoTag = 0x0, // synthetic, not an actual tag
 
  ChannelCount = 0x000c,
  ImageWidth = 0x0014,
  ImageHeight = 0x0015,
  LowpassPrecision = 0x0023,
  SubbandCount = 0x000E,
  SubbandNumber = 0x0030,
  Quantization = 0x0035,
  ChannelNumber = 0x003e,
  ImageFormat = 0x0054,
  MaxBitsPerComponent = 0x0066,
  PatternWidth = 0x006a,
  PatternHeight = 0x006b,
  ComponentsPerSample = 0x006c,
  PrescaleShift = 0x006d,
 
  LARGE_CHUNK = 0x2000,
  SMALL_CHUNK = 0x4000,
  UniqueImageIdentifier = 0x4004,
  LargeCodeblock = 0x6000,
 
  Optional = int16_t(0x8000U), // only signbit set
};
inline VC5Tag operator&(VC5Tag LHS, VC5Tag RHS) {
  using value_type = std::underlying_type_t<VC5Tag>;
  return static_cast<VC5Tag>(static_cast<value_type>(LHS) &
                             static_cast<value_type>(RHS));
}
inline bool matches(VC5Tag LHS, VC5Tag RHS) {
  // Are there any common bit set?
  return (LHS & RHS) != VC5Tag::NoTag;
}
inline bool is(VC5Tag LHS, VC5Tag RHS) {
  // Does LHS have all the RHS bits set?
  return (LHS & RHS) == RHS;
}
inline VC5Tag operator-(VC5Tag tag) {
  using value_type = std::underlying_type_t<VC5Tag>;
  // Negate
  return static_cast<VC5Tag>(-static_cast<value_type>(tag));
}
 
class VC5Decompressor final : public AbstractDecompressor {
  RawImage mRaw;
  ByteStream mBs;
 
  BayerPhase phase;
 
  static constexpr auto VC5_LOG_TABLE_BITWIDTH = 12;
  int outputBits;
  SimpleLUT<unsigned, VC5_LOG_TABLE_BITWIDTH> mVC5LogTable;
 
  using PrefixCodeDecoder =
      PrefixCodeLUTDecoder<VC5CodeTag, PrefixCodeVectorDecoder<VC5CodeTag>>;
 
  Optional<PrefixCodeDecoder> codeDecoder;
 
  void initPrefixCodeDecoder();
 
  void initVC5LogTable();
 
  static constexpr int numWaveletLevels = 3;
  static constexpr int numHighPassBands = 3;
  static constexpr int numLowPassBands = 1;
  static constexpr int numSubbands =
      numLowPassBands + (numHighPassBands * numWaveletLevels);
 
  struct {
    uint16_t iChannel = 0; // 0'th channel is the default
    Optional<uint16_t> iSubband;
    Optional<uint16_t> lowpassPrecision;
    Optional<int16_t> quantization;
 
    const uint16_t imgFormat = 4;
    const uint16_t patternWidth = 2;
    const uint16_t patternHeight = 2;
    const uint16_t cps = 1;
  } mVC5;
 
  struct BandData final {
    std::vector<int16_t, DefaultInitAllocatorAdaptor<int16_t>> storage;
    Array2DRef<int16_t> description;
 
    BandData(int width, int height)
        : description(Array2DRef<int16_t>::create(storage, width, height)) {}
  };
 
  class Wavelet final {
  public:
    int width;
    int height;
    int16_t prescale;
 
    struct AbstractBand {
      Wavelet& wavelet;
      Optional<BandData> data;
      virtual void anchor() const;
      explicit AbstractBand(Wavelet& wavelet_) : wavelet(wavelet_) {}
      virtual ~AbstractBand() = default;
      virtual void createDecodingTasks(ErrorLog& errLog,
                                       bool& exceptionThrown) noexcept = 0;
    };
    struct ReconstructableBand final : AbstractBand {
      bool clampUint;
      bool finalWavelet;
      struct {
        Optional<BandData> lowpass;
        Optional<BandData> highpass;
      } intermediates;
      explicit ReconstructableBand(Wavelet& wavelet_, bool clampUint_ = false,
                                   bool finalWavelet_ = false)
          : AbstractBand(wavelet_), clampUint(clampUint_),
            finalWavelet(finalWavelet_) {}
      void
      createLowpassReconstructionTask(const bool& exceptionThrown) noexcept;
      void
      createHighpassReconstructionTask(const bool& exceptionThrown) noexcept;
      void createLowHighPassCombiningTask(const bool& exceptionThrown) noexcept;
      void createDecodingTasks(ErrorLog& errLog,
                               bool& exceptionThrown) noexcept override;
    };
    struct AbstractDecodeableBand : AbstractBand {
      Array1DRef<const uint8_t> input;
      explicit AbstractDecodeableBand(Wavelet& wavelet_,
                                      Array1DRef<const uint8_t> input_)
          : AbstractBand(wavelet_), input(input_) {}
      [[nodiscard]] virtual BandData decode() const = 0;
      void createDecodingTasks(ErrorLog& errLog,
                               bool& exceptionThrown) noexcept final;
    };
    struct LowPassBand final : AbstractDecodeableBand {
      uint16_t lowpassPrecision;
      LowPassBand(Wavelet& wavelet_, ByteStream bs, uint16_t lowpassPrecision_);
      [[nodiscard]] BandData decode() const noexcept override;
    };
    struct HighPassBand final : AbstractDecodeableBand {
      const Optional<PrefixCodeDecoder>& decoder;
      int16_t quant;
      HighPassBand(Wavelet& wavelet_, Array1DRef<const uint8_t> input_,
                   const Optional<PrefixCodeDecoder>& decoder_, int16_t quant_)
          : AbstractDecodeableBand(wavelet_, input_), decoder(decoder_),
            quant(quant_) {}
      [[nodiscard]] BandData decode() const override;
    };
 
    static constexpr uint16_t maxBands = numLowPassBands + numHighPassBands;
    std::vector<std::unique_ptr<AbstractBand>> bands;
 
    void setBandValid(int band);
    [[nodiscard]] bool isBandValid(int band) const;
    [[nodiscard]] uint32_t getValidBandMask() const { return mDecodedBandMask; }
    [[nodiscard]] bool allBandsValid() const;
 
    static BandData reconstructPass(Array2DRef<const int16_t> high,
                                    Array2DRef<const int16_t> low) noexcept;
 
    static BandData combineLowHighPass(Array2DRef<const int16_t> low,
                                       Array2DRef<const int16_t> high,
                                       int descaleShift,
                                       bool clampUint /*= false*/,
                                       bool finalWavelet /*= false*/) noexcept;
 
    uint32_t mDecodedBandMask = 0;
  };
 
  struct Channel final {
    std::array<Wavelet, numWaveletLevels + 1> wavelets;
  };
 
  static constexpr int numChannels = 4;
  static constexpr int numSubbandsTotal = numSubbands * numChannels;
  static constexpr int numLowPassBandsTotal = numWaveletLevels * numChannels;
  std::array<Channel, numChannels> channels;
 
  static inline std::pair<int16_t /*value*/, unsigned int /*count*/>
  getRLV(const PrefixCodeDecoder& decoder, BitStreamerMSB& bits);
 
  void parseLargeCodeblock(ByteStream bs);
 
  template <BayerPhase p> void combineFinalLowpassBandsImpl() const noexcept;
 
  void combineFinalLowpassBands() const noexcept;
 
  void createWaveletBandDecodingTasks(bool& exceptionThrown) const noexcept;
 
  void decodeThread(bool& exceptionThrown) const noexcept;
 
  void parseVC5();
 
public:
  VC5Decompressor(ByteStream bs, const RawImage& img);
 
  void decode(unsigned int offsetX, unsigned int offsetY, unsigned int width,
              unsigned int height);
};
 
} // namespace rawspeed