shattered_machine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9dfe9b876f9e7becbce16bfd223a2e4fabede7d81b0b1ab9f1a6dbfed77931ec
+  data.tar.gz: ab812b93fc168c2fb8baf1624c8d40ff6f765ae5e850a7419d93a3dc6e64f38a
+SHA512:
+  metadata.gz: abd2a55f1217e645cb88f9f5c81e9ae6fdcbf39016225d9b54ceabdbfe5f2a6d5d967ec500b14b1ba81b4b0d1a2f6a514b3d578ffa3b6110ff42d6cb6fcc583c
+  data.tar.gz: 108b1a08f80418a52f9c6df0f7cbf27fd7b0f76e1643c6f5f3ae0fd5ec0eb023e668593e0feff9955cff9da5d85b58722cc3ee5b112d68992582f3e723722e3c

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+.idea
+*.log
+tmp/
+.ruby-version
+.bundle
+vendor
+Gemfile.lock
+coverage
+doc/file.README.html
+shattered_machine-0.0.1.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.yardoc/checksums

@@ -0,0 +1,14 @@
+lib/shattered_machine.rb 5501f4ff757917169b063b04806ee16c0aa5ab2c
+lib/shattered_machine/io.rb 02fface2a883b962a3c27ffba497af8aad184993
+lib/shattered_machine/slim.rb 071024bd045684c8fcaa81499e924156f4b4df78
+lib/shattered_machine/brush.rb d0c27748daffefd4b40ecee2feff395d1dd3a1da
+lib/shattered_machine/defect.rb b2402bad054d51847fd3b83d597014e8e97a2fe8
+lib/rusty_engine/rusty_engine.rb 17b075a2fc7fe87c63721eab953059b26ce01210
+lib/shattered_machine/sampler.rb 7bf247a9ef6b34836cd45920f66122a786095a9e
+lib/shattered_machine/exchange.rb fad77d3d75ee0652ec0ba2166f2ace56ef533bd3
+lib/shattered_machine/glitcher.rb 071744286d68720fe47d7dfae2e033fdcff1cf69
+lib/shattered_machine/converter.rb da5eeda73917386592612d0834a7c4d4467d5df2
+lib/shattered_machine/transpose.rb 48a77c39cca754c222dd7719b4febc110da63c7a
+lib/shattered_machine/change_byte.rb 445fc0f28fe02eaf83e711e1d616862128a86be4
+lib/shattered_machine/pixel_sorter.rb 383dcd25a9f9253ce15b1849ae849ea94144757c
+lib/shattered_machine/wrong_filter.rb 22131fb22b4bcda10b1251f3266801770e71861f

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'ffi'
+gem 'pnglitch'
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,9 @@
+ The MIT License (MIT)
+
+Copyright © 2021 Flo Girardo
+
+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,51 @@
+# Shattered Machine
+
+The Shattered Machine is a gem that aim to create glitched png images easily. 
+
+## Features
+
+- Converter : Convert a single jpg images or a directory full of jpg image into png
+- Seven algorithms : Seven different alogirithm with their own settings giving you lots of freedom to mess with your images
+- Sampler : Giving you a quick overview of all algorithms effect on your image
+- Folder glitching : Glitch easily all png images contained in a folder
+
+## Usage/Examples
+### Glitcher
+
+```ruby
+require 'shattered_machine'
+
+io = ShatteredMachine::Io.new( 'input_image.png', 'output_folder', 'output_filename')
+ShatteredMachine::Glitcher.new('Slim', io).call
+```
+
+### Sampler
+
+```ruby
+require 'shattered_machine'
+
+io = ShatteredMachine::Io.new( 'input_image.png', 'output_folder', 'output_filename')
+ShatteredMachine::Sampler.new(io).call
+```
+
+### Converter
+
+```ruby
+require 'shattered_machine'
+
+io = ShatteredMachine::Io.new( 'input_image.jpg', 'output_folder', 'output_filename')
+ShatteredMachine::Converter.new(io).call
+```
+
+## Development
+The Shattered Machine using two main libraries for glitching : 
+- [pnglitch](https://github.com/ucnv/pnglitch)
+- [rusty engine](https://framagit.org/Radoteur/rusty_engine)
+
+The rusty engine is written in rust and a compiled version for Windows, Mac os and Linux is already included in the gem. 
+To install the needed dependencies you need to install the [Ruby language](https://www.ruby-lang.org/en/) and [Bundler](https://bundler.io/). 
+
+Then run `bundle install` to fetch the needed gems.
+
+### Specs
+This project uses [Rspec](https://rspec.info/) for writting specs, to run them simply run `bundle rspec`

data/doc/ShatteredMachine.html

@@ -0,0 +1,135 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: ShatteredMachine
+  
+    &mdash; Documentation by YARD 0.9.26
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "ShatteredMachine";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index (S)</a> &raquo;
+    
+    
+    <span class="title">ShatteredMachine</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: ShatteredMachine
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/shattered_machine.rb<span class="defines">,<br />
+  lib/shattered_machine/io.rb,<br /> lib/shattered_machine/slim.rb,<br /> lib/shattered_machine/brush.rb,<br /> lib/shattered_machine/defect.rb,<br /> lib/rusty_engine/rusty_engine.rb,<br /> lib/shattered_machine/sampler.rb,<br /> lib/shattered_machine/exchange.rb,<br /> lib/shattered_machine/glitcher.rb,<br /> lib/shattered_machine/converter.rb,<br /> lib/shattered_machine/transpose.rb,<br /> lib/shattered_machine/change_byte.rb,<br /> lib/shattered_machine/pixel_sorter.rb,<br /> lib/shattered_machine/wrong_filter.rb</span>
+</dd>
+  </dl>
+  
+</div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="ShatteredMachine/RustyEngine.html" title="ShatteredMachine::RustyEngine (module)">RustyEngine</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ShatteredMachine/Brush.html" title="ShatteredMachine::Brush (class)">Brush</a></span>, <span class='object_link'><a href="ShatteredMachine/ChangeByte.html" title="ShatteredMachine::ChangeByte (class)">ChangeByte</a></span>, <span class='object_link'><a href="ShatteredMachine/Converter.html" title="ShatteredMachine::Converter (class)">Converter</a></span>, <span class='object_link'><a href="ShatteredMachine/Defect.html" title="ShatteredMachine::Defect (class)">Defect</a></span>, <span class='object_link'><a href="ShatteredMachine/Exchange.html" title="ShatteredMachine::Exchange (class)">Exchange</a></span>, <span class='object_link'><a href="ShatteredMachine/Glitcher.html" title="ShatteredMachine::Glitcher (class)">Glitcher</a></span>, <span class='object_link'><a href="ShatteredMachine/Io.html" title="ShatteredMachine::Io (class)">Io</a></span>, <span class='object_link'><a href="ShatteredMachine/PixelSorter.html" title="ShatteredMachine::PixelSorter (class)">PixelSorter</a></span>, <span class='object_link'><a href="ShatteredMachine/Sampler.html" title="ShatteredMachine::Sampler (class)">Sampler</a></span>, <span class='object_link'><a href="ShatteredMachine/Slim.html" title="ShatteredMachine::Slim (class)">Slim</a></span>, <span class='object_link'><a href="ShatteredMachine/Transpose.html" title="ShatteredMachine::Transpose (class)">Transpose</a></span>, <span class='object_link'><a href="ShatteredMachine/WrongFilter.html" title="ShatteredMachine::WrongFilter (class)">WrongFilter</a></span>
+    
+  
+</p>
+
+  
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.0.1</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Sun May 23 13:30:10 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-2.6.6).
+</div>
+
+    </div>
+  </body>
+</html>

data/doc/ShatteredMachine/Brush.html

@@ -0,0 +1,375 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: ShatteredMachine::Brush
+  
+    &mdash; Documentation by YARD 0.9.26
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "ShatteredMachine::Brush";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (B)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../ShatteredMachine.html" title="ShatteredMachine (module)">ShatteredMachine</a></span></span>
+     &raquo; 
+    <span class="title">Brush</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Class: ShatteredMachine::Brush
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">ShatteredMachine::Brush</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/shattered_machine/brush.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Brush pixels of a given png image. The logic for the brush come from the Rusty Engine.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(input_image, output_image)  &#x21d2; boolean </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Status of brush.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(options = {})  &#x21d2; Brush </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Brush.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>(options = {})  &#x21d2; <tt><span class='object_link'><a href="" title="ShatteredMachine::Brush (class)">Brush</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns a new instance of Brush.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>options</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>options for brush algorithm</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+10
+11
+12
+13
+14
+15</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/shattered_machine/brush.rb', line 10</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='ivar'>@direction</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:direction</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='symbol'>:horizontal_inverted</span>
+  <span class='ivar'>@probability</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:probability</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>18</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+  <span class='ivar'>@min_pixels</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:min_pixels</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>1</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+  <span class='ivar'>@max_pixels</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:max_pixels</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>10</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="call-instance_method">
+  
+    #<strong>call</strong>(input_image, output_image)  &#x21d2; <tt>boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns status of brush.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>input_image</span>
+      
+      
+        <span class='type'>(<tt>string</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>path for image</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>output_image</span>
+      
+      
+        <span class='type'>(<tt>string</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>path for output brushed image</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>status of brush</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+20
+21
+22
+23
+24
+25
+26</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/shattered_machine/brush.rb', line 20</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_input_image'>input_image</span><span class='comma'>,</span> <span class='id identifier rubyid_output_image'>output_image</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ruby_to_rust_directions'>ruby_to_rust_directions</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>horizontal:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>vertical:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+                              <span class='label'>horizontal_inverted:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>3</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+                              <span class='label'>vertical_inverted:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>4</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
+  <span class='const'><span class='object_link'><a href="RustyEngine.html" title="ShatteredMachine::RustyEngine (module)">RustyEngine</a></span></span><span class='period'>.</span><span class='id identifier rubyid_brush'>brush</span><span class='lparen'>(</span><span class='id identifier rubyid_input_image'>input_image</span><span class='comma'>,</span> <span class='id identifier rubyid_output_image'>output_image</span><span class='comma'>,</span> <span class='ivar'>@probability</span><span class='comma'>,</span> <span class='ivar'>@min_pixels</span><span class='comma'>,</span>
+                    <span class='ivar'>@max_pixels</span><span class='comma'>,</span> <span class='id identifier rubyid_ruby_to_rust_directions'>ruby_to_rust_directions</span><span class='lbracket'>[</span><span class='ivar'>@direction</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Sun May 23 13:30:11 2021 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.26 (ruby-2.6.6).
+</div>
+
+    </div>
+  </body>
+</html>