Dactyloidae/image/decoders/nsJPEGDecoder.h
Martok e96122ede2 Issue #2073 - m-c 523950: Discard decoded frames of very large GIF animations (squashed)
Controlled by image.animated.decode-on-demand.threshold-kb, default 256MB

Includes squashed bugfixes/regressions:
 - m-c 1444537: Shutting down the decode pool should make animated decoders bail early
 - m-c 1628606: Make sure to mark the surface cache entry available before sending the frame complete notification
 - m-c 1502275: Skip recreating the decoder after redecode errors if an animated image is reset
 - m-c 1443232: Don't insert frames into our AnimationFrameBuffer that we consider in error and unusable
2023-01-10 07:30:36 +08:00

125 lines
3.2 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_image_decoders_nsJPEGDecoder_h
#define mozilla_image_decoders_nsJPEGDecoder_h
#include "RasterImage.h"
// On Windows systems, RasterImage.h brings in 'windows.h', which defines INT32.
// But the jpeg decoder has its own definition of INT32. To avoid build issues,
// we need to undefine the version from 'windows.h'.
#undef INT32
#include "Decoder.h"
#include "nsIInputStream.h"
#include "nsIPipe.h"
#include "qcms.h"
extern "C" {
#include "jpeglib.h"
}
#include <setjmp.h>
namespace mozilla {
namespace image {
typedef struct {
struct jpeg_error_mgr pub; // "public" fields for IJG library
jmp_buf setjmp_buffer; // For handling catastropic errors
} decoder_error_mgr;
typedef enum {
JPEG_HEADER, // Reading JFIF headers
JPEG_START_DECOMPRESS,
JPEG_DECOMPRESS_PROGRESSIVE, // Output progressive pixels
JPEG_DECOMPRESS_SEQUENTIAL, // Output sequential pixels
JPEG_DONE,
JPEG_SINK_NON_JPEG_TRAILER, // Some image files have a
// non-JPEG trailer
JPEG_ERROR
} jstate;
class RasterImage;
struct Orientation;
class nsJPEGDecoder : public Decoder
{
public:
virtual ~nsJPEGDecoder();
DecoderType GetType() const override { return DecoderType::JPEG; }
virtual void SetSampleSize(int aSampleSize) override
{
mSampleSize = aSampleSize;
}
void NotifyDone();
protected:
nsresult InitInternal() override;
LexerResult DoDecode(SourceBufferIterator& aIterator,
IResumable* aOnResume) override;
nsresult FinishInternal() override;
protected:
Orientation ReadOrientationFromEXIF();
void OutputScanlines(bool* suspend);
private:
friend class DecoderFactory;
// Decoders should only be instantiated via DecoderFactory.
nsJPEGDecoder(RasterImage* aImage, Decoder::DecodeStyle aDecodeStyle);
enum class State
{
JPEG_DATA,
FINISHED_JPEG_DATA
};
LexerTransition<State> ReadJPEGData(const char* aData, size_t aLength);
LexerTransition<State> FinishedJPEGData();
StreamingLexer<State> mLexer;
public:
struct jpeg_decompress_struct mInfo;
struct jpeg_source_mgr mSourceMgr;
decoder_error_mgr mErr;
jstate mState;
uint32_t mBytesToSkip;
const JOCTET* mSegment; // The current segment we are decoding from
uint32_t mSegmentLen; // amount of data in mSegment
JOCTET* mBackBuffer;
uint32_t mBackBufferLen; // Offset of end of active backtrack data
uint32_t mBackBufferSize; // size in bytes what mBackBuffer was created with
uint32_t mBackBufferUnreadLen; // amount of data currently in mBackBuffer
JOCTET * mProfile;
uint32_t mProfileLength;
qcms_profile* mInProfile;
qcms_transform* mTransform;
bool mReading;
const Decoder::DecodeStyle mDecodeStyle;
uint32_t mCMSMode;
int mSampleSize;
};
} // namespace image
} // namespace mozilla
#endif // mozilla_image_decoders_nsJPEGDecoder_h