Writer.h

Go to the documentation of this file.

/***************************************************************************
    Writer.h - base class for writers, providing a C++ stream interface
                             -------------------
    begin                : Sun Aug 23 2009
    copyright            : (C) 2009 by Thomas Eschenbacher
    email                : Thomas Eschenbacher <thomas.eschenbacher@gmx.de>

 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef KWAVE_WRITER_H
#define KWAVE_WRITER_H

#include "config.h"

#include <QtGlobal>
#include <QObject>

#include "libkwave/InsertMode.h"
#include "libkwave/SampleSink.h"

namespace Kwave
{
    class SampleArray;
    class SampleReader;

    class Q_DECL_EXPORT Writer: public Kwave::SampleSink
    {
        Q_OBJECT
    public:

        Writer();

        explicit Writer(Kwave::InsertMode mode,
                        sample_index_t left = 0, sample_index_t right = 0);

        virtual ~Writer() Q_DECL_OVERRIDE;

        virtual Writer &operator << (const Kwave::SampleArray &samples);

        virtual Writer &operator << (const sample_t &sample);

        inline Writer &operator << (Writer &(*modifier)(Writer &))
        {
            return modifier(*this);
        }

        Writer &operator << (Kwave::SampleReader &reader);

        virtual bool write(const Kwave::SampleArray &buffer,
                           unsigned int &count) = 0;

        inline bool flush() { return write(m_buffer, m_buffer_used); }

        virtual bool eof() const;

        virtual bool done() const Q_DECL_OVERRIDE { return eof(); }

        inline sample_index_t first() const { return m_first; }

        inline sample_index_t last() const {
            return ((m_mode == Kwave::Append) ?
                (m_last + m_buffer_used) : m_last);
        }

        inline sample_index_t position() const { return m_position; }

        inline Kwave::InsertMode mode() const { return m_mode; }

    signals:

        void sigSamplesWritten(sample_index_t);

        void proceeded();

    public slots:

        void input(Kwave::SampleArray data);

    protected:

        sample_index_t m_first;

        sample_index_t m_last;

        Kwave::InsertMode m_mode;

        sample_index_t m_position;

        Kwave::SampleArray m_buffer;

        unsigned int m_buffer_size;

        unsigned int m_buffer_used;

    };

}

Kwave::Writer &flush(Kwave::Writer &s) Q_DECL_EXPORT;

#endif /* KWAVE_WRITER_H */

//***************************************************************************
//***************************************************************************