69

我目前正在学习 C++(来自 Java),并且正在尝试了解如何在 C++ 中正确使用 IO 流。

假设我有一个Image包含图像像素的类,并且我重载了提取运算符以从流中读取图像:

istream& operator>>(istream& stream, Image& image)
{
    // Read the image data from the stream into the image
    return stream;
}

所以现在我可以读取这样的图像:

Image image;
ifstream file("somepic.img");
file >> image;

但现在我想使用相同的提取运算符从自定义流中读取图像数据。假设我有一个文件,其中包含压缩形式的图像。因此,我可能不想使用 ifstream 来实现自己的输入流。至少我会在 Java 中这样做。在 Java 中,我会编写一个自定义类来扩展InputStream该类并实现该int read()方法。所以这很容易。用法如下所示:

InputStream stream = new CompressedInputStream(new FileInputStream("somepic.imgz"));
image.read(stream);

所以使用相同的模式也许我想在 C++ 中做到这一点:

Image image;
ifstream file("somepic.imgz");
compressed_stream stream(file);
stream >> image;

但也许这是错误的方式,不知道。扩展istream类看起来很复杂,经过一番搜索,我发现了一些关于扩展的提示streambuf。但是对于这样一个简单的任务,这个例子看起来非常复杂。

那么在 C++ 中实现自定义输入/输出流(或 streambufs?)的最佳方法是什么?

解决方案

有些人建议根本不使用 iostreams,而是使用迭代器、boost 或自定义 IO 接口。这些可能是有效的替代方案,但我的问题是关于 iostreams。接受的答案导致下面的示例代码。为了更容易阅读,没有标题/代码分离,并且导入了整个 std 命名空间(我知道这在实际代码中是一件坏事)。

这个例子是关于读取和写入垂直异或编码的图像。格式很简单。每个字节代表两个像素(每像素 4 位)。每一行都与前一行异或。这种编码为压缩图像做准备(通常会产生很多更容易压缩的 0 字节)。

#include <cstring>
#include <fstream>

using namespace std;

/*** vxor_streambuf class ******************************************/

class vxor_streambuf: public streambuf
{
public:
    vxor_streambuf(streambuf *buffer, const int width) :
        buffer(buffer),
        size(width / 2)
    {
        previous_line = new char[size];
        memset(previous_line, 0, size);
        current_line = new char[size];
        setg(0, 0, 0);
        setp(current_line, current_line + size);
    }

    virtual ~vxor_streambuf()
    {
        sync();
        delete[] previous_line;
        delete[] current_line;
    }

    virtual streambuf::int_type underflow()
    {
        // Read line from original buffer
        streamsize read = buffer->sgetn(current_line, size);
        if (!read) return traits_type::eof();

        // Do vertical XOR decoding
        for (int i = 0; i < size; i += 1)
        {
            current_line[i] ^= previous_line[i];
            previous_line[i] = current_line[i];
        }

        setg(current_line, current_line, current_line + read);
        return traits_type::to_int_type(*gptr());
    }

    virtual streambuf::int_type overflow(streambuf::int_type value)
    {
        int write = pptr() - pbase();
        if (write)
        {
            // Do vertical XOR encoding
            for (int i = 0; i < size; i += 1)
            {
                char tmp = current_line[i];
                current_line[i] ^= previous_line[i];
                previous_line[i] = tmp;
            }

            // Write line to original buffer
            streamsize written = buffer->sputn(current_line, write);
            if (written != write) return traits_type::eof();
        }

        setp(current_line, current_line + size);
        if (!traits_type::eq_int_type(value, traits_type::eof())) sputc(value);
        return traits_type::not_eof(value);
    };

    virtual int sync()
    {
        streambuf::int_type result = this->overflow(traits_type::eof());
        buffer->pubsync();
        return traits_type::eq_int_type(result, traits_type::eof()) ? -1 : 0;
    }

private:
    streambuf *buffer;
    int size;
    char *previous_line;
    char *current_line;
};


/*** vxor_istream class ********************************************/

class vxor_istream: public istream
{
public:
    vxor_istream(istream &stream, const int width) :
        istream(new vxor_streambuf(stream.rdbuf(), width)) {}

    virtual ~vxor_istream()
    {
        delete rdbuf();
    }
};


/*** vxor_ostream class ********************************************/

class vxor_ostream: public ostream
{
public:
    vxor_ostream(ostream &stream, const int width) :
        ostream(new vxor_streambuf(stream.rdbuf(), width)) {}

    virtual ~vxor_ostream()
    {
        delete rdbuf();
    }
};


/*** Test main method **********************************************/

int main()
{
    // Read data
    ifstream infile("test.img");
    vxor_istream in(infile, 288);
    char data[144 * 128];
    in.read(data, 144 * 128);
    infile.close();

    // Write data
    ofstream outfile("test2.img");
    vxor_ostream out(outfile, 288);
    out.write(data, 144 * 128);
    out.flush();
    outfile.close();

    return 0;
}
4

5 回答 5

68

在 C++ 中创建新流的正确方法是派生std::streambuf并覆盖underflow()读取操作和写入操作overflow()sync()操作。出于您的目的,您将创建一个过滤流缓冲区,该缓冲区将另一个流缓冲区(可能还有一个可以使用 从中提取流缓冲区的流rdbuf())作为参数,并根据该流缓冲区实现其自己的操作。

流缓冲区的基本轮廓是这样的:

class compressbuf
    : public std::streambuf {
    std::streambuf* sbuf_;
    char*           buffer_;
    // context for the compression
public:
    compressbuf(std::streambuf* sbuf)
        : sbuf_(sbuf), buffer_(new char[1024]) {
        // initialize compression context
    }
    ~compressbuf() { delete[] this->buffer_; }
    int underflow() {
        if (this->gptr() == this->egptr()) {
            // decompress data into buffer_, obtaining its own input from
            // this->sbuf_; if necessary resize buffer
            // the next statement assumes "size" characters were produced (if
            // no more characters are available, size == 0.
            this->setg(this->buffer_, this->buffer_, this->buffer_ + size);
        }
        return this->gptr() == this->egptr()
             ? std::char_traits<char>::eof()
             : std::char_traits<char>::to_int_type(*this->gptr());
    }
};

看起来如何underflow()完全取决于正在使用的压缩库。我使用的大多数库都保留了一个内部缓冲区,该缓冲区需要填充并保留尚未使用的字节。通常情况下,将解压缩挂钩到underflow().

创建流缓冲区后,您可以std::istream使用流缓冲区初始化一个对象:

std::ifstream fin("some.file");
compressbuf   sbuf(fin.rdbuf());
std::istream  in(&sbuf);

如果您要经常使用流缓冲区,您可能希望将对象构造封装到一个类中,例如icompressstream. 这样做有点棘手,因为基类std::ios是一个虚拟基类,并且是存储流缓冲区的实际位置。因此,在将指针传递给 a 之前构造流缓冲区std::ios需要跳过几个环节:它需要使用virtual基类。这是大致的样子:

struct compressstream_base {
    compressbuf sbuf_;
    compressstream_base(std::streambuf* sbuf): sbuf_(sbuf) {}
};
class icompressstream
    : virtual compressstream_base
    , public std::istream {
public:
    icompressstream(std::streambuf* sbuf)
        : compressstream_base(sbuf)
        , std::ios(&this->sbuf_)
        , std::istream(&this->sbuf_) {
    }
};

(我只是输入了这段代码,没有简单的方法来测试它是否合理正确;请注意拼写错误,但整体方法应该按照描述的方式工作)

于 2012-12-29T22:24:17.193 回答
8

boost(如果你对 C++ 很认真,你应该已经拥有它),有一个专门用于扩展和自定义 IO 流的库:boost.iostreams

特别是,它已经为一些流行格式(bzip2gzlibzlib)提供了解压缩流

如您所见,扩展 streambuf 可能是一项涉及的工作,但如果您需要,该库可以很容易地编写您自己的过滤 streambuf 。

于 2012-12-29T22:50:00.340 回答
4

不要,除非你想死于可怕的设计。IOstreams 是标准库中最糟糕的组件——甚至比语言环境还要糟糕。迭代器模型更有用,您可以使用 istream_iterator 从流转换为迭代器。

于 2012-12-29T22:23:47.763 回答
1

我同意@DeadMG,不建议使用 iostreams。除了糟糕的设计之外,性能通常比普通的老式 C 风格 I/O 更差。不过,我不会坚持使用特定的 I/O 库,而是创建一个具有所有必需操作的接口(抽象类),例如:

class Input {
 public:
  virtual void read(char *buffer, size_t size) = 0;
  // ...
};

然后,您可以为 CI/O、iostreammmap或其他任何东西实现此接口。

于 2012-12-30T14:34:48.207 回答
0

这样做可能是可能的,但我觉得这不是 C++ 中这个特性的“正确”用法。iostream >> 和 << 运算符用于相当简单的操作,例如编写 a 的“名称、街道、城镇、邮政编码” class Person,而不是用于解析和加载图像。使用 stream::read() 会更好 - 使用Image(astream);,并且您可以实现压缩流,如 Dietmar 所述。

于 2012-12-29T22:28:29.973 回答