scanline_interface.h

Go to the documentation of this file.

/*
 * Copyright 2013 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http:///www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


#ifndef PAGESPEED_KERNEL_IMAGE_SCANLINE_INTERFACE_H_
#define PAGESPEED_KERNEL_IMAGE_SCANLINE_INTERFACE_H_

#include <cstddef>
#include "pagespeed/kernel/base/basictypes.h"
#include "pagespeed/kernel/base/string.h"
#include "pagespeed/kernel/image/image_util.h"
#include "pagespeed/kernel/image/scanline_status.h"

namespace pagespeed {

namespace image_compression {

class ScanlineReaderInterface {
 public:
  ScanlineReaderInterface() {}
  virtual ~ScanlineReaderInterface() {}

  virtual bool Reset() = 0;

  virtual size_t GetBytesPerScanline() = 0;

  virtual bool HasMoreScanLines() = 0;

  virtual ScanlineStatus InitializeWithStatus(const void* image_buffer,
                                              size_t buffer_length) = 0;
  inline bool Initialize(const void* image_buffer, size_t buffer_length) {
    return InitializeWithStatus(image_buffer, buffer_length).Success();
  }

  virtual ScanlineStatus ReadNextScanlineWithStatus(
      void** out_scanline_bytes) = 0;

  inline bool ReadNextScanline(void** out_scanline_bytes) {
    return ReadNextScanlineWithStatus(out_scanline_bytes).Success();
  }

  virtual size_t GetImageHeight() = 0;

  virtual size_t GetImageWidth() = 0;

  virtual PixelFormat GetPixelFormat() = 0;

  virtual bool IsProgressive() = 0;

 private:
  
};

class ScanlineWriterInterface {
 public:
  ScanlineWriterInterface() {}
  virtual ~ScanlineWriterInterface() {}

  virtual ScanlineStatus InitWithStatus(const size_t width, const size_t height,
                                        PixelFormat pixel_format) = 0;
  inline bool Init(const size_t width, const size_t height,
                   PixelFormat pixel_format) {
    return InitWithStatus(width, height, pixel_format).Success();
  }

  virtual ScanlineStatus InitializeWriteWithStatus(const void* config,
                                                   GoogleString* const out) = 0;
  inline bool InitializeWrite(const void* config,
                              GoogleString* const out) {
    return InitializeWriteWithStatus(config, out).Success();
  }

  virtual ScanlineStatus WriteNextScanlineWithStatus(
      const void *scanline_bytes) = 0;
  inline bool WriteNextScanline(const void *scanline_bytes) {
    return WriteNextScanlineWithStatus(scanline_bytes).Success();
  }

  virtual ScanlineStatus FinalizeWriteWithStatus() = 0;
  inline bool FinalizeWrite() {
    return FinalizeWriteWithStatus().Success();
  }

 private:
  
};

}  

}  

#endif