/* <!-- copyright */
/*
 * aria2 - The high speed download utility
 *
 * Copyright (C) 2010 Tatsuhiro Tsujikawa
 *
 * 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.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
 */
/* copyright --> */
#ifndef D_STREAM_FILTER_H
#define D_STREAM_FILTER_H

#include "common.h"
#include <string>
#include "SharedHandle.h"

namespace aria2 {

class BinaryStream;
class Segment;

// Interface for basic decoding functionality.
class StreamFilter {
private:
  SharedHandle<StreamFilter> delegate_;
public:
  StreamFilter
  (const SharedHandle<StreamFilter>& delegate = SharedHandle<StreamFilter>());

  virtual ~StreamFilter();

  // init() must be called before calling decode().
  virtual void init() = 0;

  // Returns the number of bytes written to sink
  virtual ssize_t transform(const SharedHandle<BinaryStream>& out,
                            const SharedHandle<Segment>& segment,
                            const unsigned char* inbuf, size_t inlen) = 0;

  virtual bool finished() = 0;

  // The call of release() will free allocated resources.
  // After calling release(), the object can be reused by calling init().
  virtual void release() = 0;

  virtual const std::string& getName() const = 0;

  // Returns the number of input bytes processed in the last
  // tranfrom() invocation.
  virtual size_t getBytesProcessed() const = 0;

  virtual bool installDelegate(const SharedHandle<StreamFilter>& filter);

  SharedHandle<StreamFilter> getDelegate() const
  {
    return delegate_;
  }
};

} // namespace aria2

#endif // D_STREAM_FILTER_H