2018-08-12 18:07:22 +00:00
|
|
|
#ifndef QPDF_STREAM_HH
|
|
|
|
#define QPDF_STREAM_HH
|
2008-04-29 12:55:25 +00:00
|
|
|
|
2012-06-21 17:47:41 +00:00
|
|
|
#include <qpdf/Types.h>
|
2008-04-29 12:55:25 +00:00
|
|
|
|
|
|
|
#include <qpdf/QPDFObjectHandle.hh>
|
2020-12-23 11:12:49 +00:00
|
|
|
#include <qpdf/QPDFStreamFilter.hh>
|
2022-08-02 20:35:04 +00:00
|
|
|
#include <qpdf/QPDFValue.hh>
|
2020-12-23 11:12:49 +00:00
|
|
|
|
|
|
|
#include <functional>
|
|
|
|
#include <memory>
|
2008-04-29 12:55:25 +00:00
|
|
|
|
|
|
|
class Pipeline;
|
|
|
|
class QPDF;
|
|
|
|
|
2022-08-02 20:35:04 +00:00
|
|
|
class QPDF_Stream: public QPDFValue
|
2008-04-29 12:55:25 +00:00
|
|
|
{
|
|
|
|
public:
|
2022-06-16 16:45:04 +00:00
|
|
|
virtual ~QPDF_Stream() = default;
|
|
|
|
static std::shared_ptr<QPDFObject> create(
|
2022-04-02 21:14:10 +00:00
|
|
|
QPDF*,
|
2022-07-23 18:44:11 +00:00
|
|
|
QPDFObjGen const& og,
|
2022-04-02 21:14:10 +00:00
|
|
|
QPDFObjectHandle stream_dict,
|
|
|
|
qpdf_offset_t offset,
|
|
|
|
size_t length);
|
2022-06-16 16:45:04 +00:00
|
|
|
virtual std::shared_ptr<QPDFObject> shallowCopy();
|
2008-04-29 12:55:25 +00:00
|
|
|
virtual std::string unparse();
|
2022-05-07 11:53:45 +00:00
|
|
|
virtual JSON getJSON(int json_version);
|
2018-02-16 22:25:27 +00:00
|
|
|
virtual void setDescription(QPDF*, std::string const&);
|
2008-04-29 12:55:25 +00:00
|
|
|
QPDFObjectHandle getDict() const;
|
2018-02-02 23:21:34 +00:00
|
|
|
bool isDataModified() const;
|
2020-12-27 00:45:01 +00:00
|
|
|
void setFilterOnWrite(bool);
|
|
|
|
bool getFilterOnWrite() const;
|
2008-04-29 12:55:25 +00:00
|
|
|
|
2019-01-07 02:18:36 +00:00
|
|
|
// Methods to help QPDF copy foreign streams
|
|
|
|
qpdf_offset_t getOffset() const;
|
|
|
|
size_t getLength() const;
|
2022-04-09 18:35:56 +00:00
|
|
|
std::shared_ptr<Buffer> getStreamDataBuffer() const;
|
|
|
|
std::shared_ptr<QPDFObjectHandle::StreamDataProvider>
|
2022-04-02 21:14:10 +00:00
|
|
|
getStreamDataProvider() const;
|
2019-01-07 02:18:36 +00:00
|
|
|
|
2010-08-02 22:17:01 +00:00
|
|
|
// See comments in QPDFObjectHandle.hh for these methods.
|
2022-04-02 21:14:10 +00:00
|
|
|
bool pipeStreamData(
|
|
|
|
Pipeline*,
|
|
|
|
bool* tried_filtering,
|
|
|
|
int encode_flags,
|
|
|
|
qpdf_stream_decode_level_e decode_level,
|
|
|
|
bool suppress_warnings,
|
|
|
|
bool will_retry);
|
2022-04-09 18:35:56 +00:00
|
|
|
std::shared_ptr<Buffer> getStreamData(qpdf_stream_decode_level_e);
|
|
|
|
std::shared_ptr<Buffer> getRawStreamData();
|
2022-04-02 21:14:10 +00:00
|
|
|
void replaceStreamData(
|
2022-04-09 18:35:56 +00:00
|
|
|
std::shared_ptr<Buffer> data,
|
2022-04-02 21:14:10 +00:00
|
|
|
QPDFObjectHandle const& filter,
|
|
|
|
QPDFObjectHandle const& decode_parms);
|
2010-08-05 19:04:22 +00:00
|
|
|
void replaceStreamData(
|
2022-04-09 18:35:56 +00:00
|
|
|
std::shared_ptr<QPDFObjectHandle::StreamDataProvider> provider,
|
2022-02-08 14:18:08 +00:00
|
|
|
QPDFObjectHandle const& filter,
|
|
|
|
QPDFObjectHandle const& decode_parms);
|
2022-04-02 21:14:10 +00:00
|
|
|
void
|
2022-04-09 18:35:56 +00:00
|
|
|
addTokenFilter(std::shared_ptr<QPDFObjectHandle::TokenFilter> token_filter);
|
2022-05-07 15:12:15 +00:00
|
|
|
JSON getStreamJSON(
|
|
|
|
int json_version,
|
2022-05-07 17:33:45 +00:00
|
|
|
qpdf_json_stream_data_e json_data,
|
2022-05-07 15:12:15 +00:00
|
|
|
qpdf_stream_decode_level_e decode_level,
|
|
|
|
Pipeline* p,
|
|
|
|
std::string const& data_filename);
|
2008-04-29 12:55:25 +00:00
|
|
|
|
2022-04-24 13:05:50 +00:00
|
|
|
void replaceDict(QPDFObjectHandle const& new_dict);
|
2012-07-21 13:00:06 +00:00
|
|
|
|
2020-12-23 11:12:49 +00:00
|
|
|
static void registerStreamFilter(
|
|
|
|
std::string const& filter_name,
|
|
|
|
std::function<std::shared_ptr<QPDFStreamFilter>()> factory);
|
|
|
|
|
2010-08-05 20:20:52 +00:00
|
|
|
// Replace object ID and generation. This may only be called if
|
|
|
|
// object ID and generation are 0. It is used by QPDFObjectHandle
|
|
|
|
// when adding streams to files.
|
2022-07-23 18:44:11 +00:00
|
|
|
void setObjGen(QPDFObjGen const& og);
|
2010-08-05 20:20:52 +00:00
|
|
|
|
2017-08-28 21:05:34 +00:00
|
|
|
protected:
|
|
|
|
virtual void releaseResolved();
|
|
|
|
|
2008-04-29 12:55:25 +00:00
|
|
|
private:
|
2022-06-16 16:45:04 +00:00
|
|
|
QPDF_Stream(
|
|
|
|
QPDF*,
|
2022-07-23 18:44:11 +00:00
|
|
|
QPDFObjGen const& og,
|
2022-06-16 16:45:04 +00:00
|
|
|
QPDFObjectHandle stream_dict,
|
|
|
|
qpdf_offset_t offset,
|
|
|
|
size_t length);
|
2010-09-05 15:00:44 +00:00
|
|
|
static std::map<std::string, std::string> filter_abbreviations;
|
2022-04-02 21:14:10 +00:00
|
|
|
static std::
|
|
|
|
map<std::string, std::function<std::shared_ptr<QPDFStreamFilter>()>>
|
|
|
|
filter_factories;
|
2010-09-05 15:00:44 +00:00
|
|
|
|
2022-04-02 21:14:10 +00:00
|
|
|
void replaceFilterData(
|
|
|
|
QPDFObjectHandle const& filter,
|
|
|
|
QPDFObjectHandle const& decode_parms,
|
|
|
|
size_t length);
|
|
|
|
bool filterable(
|
|
|
|
std::vector<std::shared_ptr<QPDFStreamFilter>>& filters,
|
|
|
|
bool& specialized_compression,
|
|
|
|
bool& lossy_compression);
|
2022-04-23 22:03:44 +00:00
|
|
|
void warn(
|
|
|
|
qpdf_error_code_e error_code,
|
|
|
|
qpdf_offset_t offset,
|
|
|
|
std::string const& message);
|
2018-02-16 22:25:27 +00:00
|
|
|
void setDictDescription();
|
2008-04-29 12:55:25 +00:00
|
|
|
|
|
|
|
QPDF* qpdf;
|
2022-07-23 18:44:11 +00:00
|
|
|
QPDFObjGen og;
|
2020-12-27 00:45:01 +00:00
|
|
|
bool filter_on_write;
|
2008-04-29 12:55:25 +00:00
|
|
|
QPDFObjectHandle stream_dict;
|
2012-06-21 23:32:21 +00:00
|
|
|
qpdf_offset_t offset;
|
2012-06-20 15:20:57 +00:00
|
|
|
size_t length;
|
2022-04-09 18:35:56 +00:00
|
|
|
std::shared_ptr<Buffer> stream_data;
|
|
|
|
std::shared_ptr<QPDFObjectHandle::StreamDataProvider> stream_provider;
|
|
|
|
std::vector<std::shared_ptr<QPDFObjectHandle::TokenFilter>> token_filters;
|
2008-04-29 12:55:25 +00:00
|
|
|
};
|
|
|
|
|
2018-08-12 18:07:22 +00:00
|
|
|
#endif // QPDF_STREAM_HH
|