sjpeg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e32ff2496989f7fdcf440d48449f1c9253a2ede2c910d6640a67d8273dc522be
+  data.tar.gz: 05ccb039b8365498d0ddd00538d8f11a3c98a06b302ee3e6b766b30c10e418e2
+SHA512:
+  metadata.gz: 7943af367aee41ff9d5709449a51e9bf4e8345c02ce0ed7edfa149195ab7959b51751cf7088456115171cc875ab0266341a8f9a606fae8d2de25134cc7276e3e
+  data.tar.gz: 8c1f4951720b943c9c12020d32259f5c38d1c287a9360408bac99e550ffacda0b75d4813f8f41c66b694b9cdd2376687628ede91e5ae484bbce7c7fc5162c963

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+.rspec_status
+Makefile

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sjpeg.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    sjpeg (0.1.0)
+      ffi
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ffi (1.11.1)
+    rake (10.5.0)
+    rake-compiler (1.0.8)
+      rake
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rake-compiler
+  rspec (~> 3.0)
+  sjpeg!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Stefano Verna
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Sjpeg
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sjpeg`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sjpeg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sjpeg
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stefanoverna/sjpeg.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# ruby-sjpeg

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::ExtensionTask.new "sjpeg" do |ext|
+  ext.lib_dir = "lib/sjpeg"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sjpeg"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/sjpeg/bit_writer.cc

@@ -0,0 +1,122 @@
+// Copyright 2017 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.
+//
+//  Utility for writing bits
+//
+// Author: Skal (pascal.massimino@gmail.com)
+
+#include "bit_writer.h"
+
+#include <string.h>
+
+#include "sjpeg.h"
+
+namespace sjpeg {
+
+///////////////////////////////////////////////////////////////////////////////
+// MemorySink
+
+MemorySink::MemorySink(size_t expected_size)
+    : buf_(nullptr), pos_(0), max_pos_(0) {
+  // The following call can fail, with no harm: it'll be reported during the
+  // next call to Commit() if needed (we don't want to fail in a constructor).
+  (void)Commit(0, expected_size, &buf_);
+}
+
+MemorySink::~MemorySink() { Reset(); }
+
+void MemorySink::Reset() {
+  delete[] buf_;
+  buf_ = nullptr;
+  pos_ = 0;
+  max_pos_ = 0;
+}
+
+void MemorySink::Release(uint8_t** buf_ptr, size_t* size_ptr) {
+  *buf_ptr = buf_;
+  *size_ptr = pos_;
+  buf_ = nullptr;
+  Reset();
+}
+
+bool MemorySink::Commit(size_t used_size, size_t extra_size, uint8_t** data) {
+  pos_ += used_size;
+  assert(pos_ <= max_pos_);
+  size_t new_size = pos_ + extra_size;
+  if (new_size > max_pos_) {
+  // TODO(skal): the x2 growth is probably over-shooting. Need to tune
+  // depending on use-case (ie.: what is the expected average final size?)
+    new_size += 256;
+    if (new_size < 2 * max_pos_) {
+      new_size = 2 * max_pos_;
+  }
+    uint8_t* const new_buf = new (std::nothrow) uint8_t[new_size];
+    if (new_buf == nullptr) return false;
+
+    if (pos_ > 0) memcpy(new_buf, buf_, pos_);
+  delete[] buf_;
+  buf_ = new_buf;
+    max_pos_ = new_size;
+  }
+  *data = buf_ + pos_;
+  return true;
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// Sink factories
+
+std::shared_ptr<ByteSink> MakeByteSink(std::string* const output) {
+  return std::shared_ptr<ByteSink>(new (std::nothrow) StringSink(output));
+}
+
+// specialization for vector<uint8_t>
+template<>
+std::shared_ptr<ByteSink> MakeByteSink(std::vector<uint8_t>* const output) {
+  return std::shared_ptr<ByteSink>(new (std::nothrow) VectorSink(output));
+}
+
+///////////////////////////////////////////////////////////////////////////////
+// BitWriter
+
+BitWriter::BitWriter(ByteSink* const sink) : sink_(sink), buf_(nullptr) {
+  nb_bits_ = 0;
+  bits_ = 0x00000000U;
+  byte_pos_ = 0;
+}
+
+void BitWriter::Flush() {
+  // align and pad the bitstream
+  // nb_pad is the number of '1' bits we need to insert to reach a byte-aligned
+  // position. So nb_pad is 1,2..,7 when nb_bits_= 7,...2,1
+  const int nb_pad = (-nb_bits_) & 7;
+  if (nb_pad) {
+    PutBits((1 << nb_pad) - 1, nb_pad);
+  }
+  FlushBits();
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+void BitCounter::AddBits(const uint32_t bits, size_t nbits) {
+  size_ += nbits;
+  bit_pos_ += nbits;
+  bits_ |= bits << (32 - bit_pos_);
+  while (bit_pos_ >= 8) {
+    size_ += ((bits_ >> 24) == 0xff) ? 8 : 0;
+    bits_ <<= 8;
+    bit_pos_ -= 8;
+  }
+}
+
+}   // namespace sjpeg

data/ext/sjpeg/bit_writer.h

@@ -0,0 +1,169 @@
+// Copyright 2017 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.
+//
+//  Utility for writing bits
+//
+// Author: Skal (pascal.massimino@gmail.com)
+
+#ifndef SJPEG_BIT_WRITER_H_
+#define SJPEG_BIT_WRITER_H_
+
+#include <assert.h>
+#include <stdint.h>
+#include <string.h>   // for memcpy
+
+#include <string>
+#include <vector>
+
+#include "sjpeg.h"
+
+namespace sjpeg {
+
+///////////////////////////////////////////////////////////////////////////////
+// Memory-Sink
+
+class MemorySink : public ByteSink {
+ public:
+  explicit MemorySink(size_t expected_size);
+  virtual ~MemorySink();
+  virtual bool Commit(size_t used_size, size_t extra_size, uint8_t** data);
+  virtual bool Finalize() { /* nothing to do */ return true; }
+  virtual void Reset();
+  void Release(uint8_t** buf_ptr, size_t* size_ptr);
+
+ private:
+  uint8_t* buf_;
+  size_t pos_, max_pos_;
+};
+
+///////////////////////////////////////////////////////////////////////////////
+// Sink for generic container
+//   Container must supply .resize() and [], and be byte-based.
+
+template<class T> class Sink : public ByteSink {
+ public:
+  explicit Sink(T* const output) : ptr_(output), pos_(0) {}
+  virtual ~Sink() {}
+  virtual bool Commit(size_t used_size, size_t extra_size, uint8_t** data) {
+    pos_ += used_size;
+    assert(pos_ <= ptr_->size());
+    ptr_->resize(pos_ + extra_size);
+    if (ptr_->size() != pos_ + extra_size) return false;
+    *data = extra_size ? reinterpret_cast<uint8_t*>(&(*ptr_)[pos_]) : nullptr;
+    return true;
+  }
+  virtual bool Finalize() { ptr_->resize(pos_); return true; }
+  virtual void Reset() { ptr_->clear(); }
+
+ protected:
+  T* const ptr_;
+  size_t pos_;
+};
+
+typedef Sink<std::string> StringSink;
+typedef Sink<std::vector<uint8_t> > VectorSink;
+
+///////////////////////////////////////////////////////////////////////////////
+// BitWriter
+
+class BitWriter {
+ public:
+  explicit BitWriter(ByteSink* const sink);
+
+  // Verifies the that output buffer can store at least 'size' more bytes.
+  // Also flushes the previously written data.
+  bool Reserve(size_t size) {
+    const bool ok = sink_->Commit(byte_pos_, size, &buf_);
+    if (!ok) sink_->Reset();
+    byte_pos_ = 0;
+    return ok;
+  }
+
+  // Make sure we can write 24 bits by flushing the past ones.
+  // WARNING! There's no check for buffer overwrite. Use Reserve() before
+  // calling this function.
+  void FlushBits() {
+    // worst case: 3 escaped codes = 6 bytes
+    while (nb_bits_ >= 8) {
+      const uint8_t tmp = bits_ >> 24;
+      buf_[byte_pos_++] = tmp;
+      if (tmp == 0xff) {   // escaping
+        buf_[byte_pos_++] = 0x00;
+      }
+      bits_ <<= 8;
+      nb_bits_ -= 8;
+    }
+  }
+  // Writes the sequence 'bits' of length 'nb_bits' (less than 24).
+  // WARNING! There's no check for buffer overwrite. Use Reserve() before
+  // calling this function.
+  void PutBits(uint32_t bits, int nb) {
+    assert(nb <= 24 && nb > 0);
+    assert((bits & ~((1 << nb) - 1)) == 0);
+    FlushBits();    // make room for a least 24bits
+    nb_bits_+= nb;
+    bits_ |= bits << (32 - nb_bits_);
+  }
+  // Append one byte to buffer. FlushBits() must have been called before.
+  // WARNING! There's no check for buffer overwrite. Use Reserve() before
+  // calling this function.
+  // Also: no 0xff escaping is performed by this function.
+  void PutByte(uint8_t value) {
+    assert(nb_bits_ == 0);
+    buf_[byte_pos_++] = value;
+  }
+  // Same as multiply calling PutByte().
+  void PutBytes(const uint8_t* buf, size_t size) {
+    assert(nb_bits_ == 0);
+    assert(buf != NULL);
+    assert(size > 0);
+    memcpy(buf_ + byte_pos_, buf, size);
+    byte_pos_ += size;
+  }
+
+  // Handy helper to write a packed code in one call.
+  void PutPackedCode(uint32_t code) { PutBits(code >> 16, code & 0xff); }
+
+  // Write pending bits, and align bitstream with extra '1' bits.
+  void Flush();
+
+  // To be called last.
+  bool Finalize() { return Reserve(0) && sink_->Finalize(); }
+
+ private:
+  ByteSink* sink_;
+
+  int nb_bits_;      // number of unwritten bits
+  uint32_t bits_;    // accumulator for unwritten bits
+  size_t byte_pos_;  // write position, in bytes
+  uint8_t* buf_;     // destination buffer (don't access directly!)
+};
+
+// Class for counting bits, including the 0xff escape
+struct BitCounter {
+  BitCounter() : bits_(0), bit_pos_(0), size_(0) {}
+
+  void AddPackedCode(const uint32_t code) { AddBits(code >> 16, code & 0xff); }
+  void AddBits(const uint32_t bits, size_t nbits);
+  size_t Size() const { return size_; }
+
+ private:
+  uint32_t bits_;
+  size_t bit_pos_;
+  size_t size_;
+};
+
+}   // namespace sjpeg
+
+#endif    // SJPEG_BIT_WRITER_H_