Merge pull request #25 from blenderskool/cli

Pigmnts CLI 0.1.2

Author: blenderskool

.gitignore

@@ -1,3 +1,4 @@
 /target
 **/*.rs.bk
-pkg
+pkg
+*.cbor

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "pigmnts-cli"
-version = "0.1.1"
+version = "0.1.2"
 authors = ["Akash Hamirwasia"]
 edition = "2018"
 description = "Generate a color palette from an image using WebAssesmbly"
@@ -16,6 +16,12 @@ termion = "1.5.5"
 prettytable-rs = "0.8.0"
 pigmnts = { path = "lib" }
 reqwest = { version = "0.10", features = ["blocking"] }
+serde_cbor = "0.11.1"
+lazy_static = "^1.4.0"
+
+[build-dependencies]
+serde_json = "^1.0.52"
+serde_cbor = "^0.11.1"
 
 [[bin]]
 name = "pigmnts"

Cargo.toml

@@ -33,6 +33,7 @@ FLAGS:
     -l, --lab          Enable L*AB output of colors
     -q, --quiet        Suppress the normal output [aliases: silent]
     -r, --rgb          Enable RGB output of colors
+    -n, --name         Nearest name for the color
     -V, --version      Prints version information
 
 OPTIONS:
@@ -47,10 +48,14 @@ OPTIONS:
 - `pigmnts pic-1.jpg -rxdl`  
   Generate a palette of 5 colors from pic-1.jpg and show the RGB code, hex code, dominance, LAB code for each color in the palette.
 
+- `pigmnts pic-1.jpg --count 10 --name --hex`  
+  Generate a palette of 10 colors from pic-1.jpg and show the name, hex code for each color in the palette.
+
 - `pigmnts pic-1.jpg pic-2.jpg -sxq`  
   Generate a palette of 5 colors from pic-1.jpg and pic-2.jpg. For each color in the palette show the HSL code, hex code in `quiet` mode.
 
 
+
 ## Contributing
 This repository is a Cargo workspace that includes the development of both core Pigmnts library and the CLI.
 
@@ -60,4 +65,5 @@ This repository is a Cargo workspace that includes the development of both core
 
 
 ## License
-Pigmnts is [MIT Licensed](https://github.com/blenderskool/pigmnts/blob/master/LICENSE.md)
+Pigmnts is [MIT Licensed](https://github.com/blenderskool/pigmnts/blob/master/LICENSE.md)  
+The dataset for color names used in Pigmnts CLI is taken from https://github.com/meodai/color-names

README.md

@@ -0,0 +1,13 @@
+extern crate serde_cbor;
+extern crate serde_json;
+
+use std::fs::File;
+
+fn main() {
+  // This dataset has been taken from https://github.com/meodai/color-names
+  let color_names_file = File::open("./data/colornames.bestof.min.json").unwrap();
+  let color_names: serde_json::Value = serde_json::from_reader(color_names_file).unwrap();
+
+  let dest_file = File::create("./data/colornames.cbor").unwrap();
+  serde_cbor::to_writer(dest_file, &color_names).unwrap();
+}

build.rs

@@ -7,6 +7,10 @@ extern crate termion;
 extern crate image;
 extern crate pigmnts;
 extern crate reqwest;
+#[macro_use]
+extern crate lazy_static;
+
+pub mod utils;
 
 use clap::{App, Arg};
 use spinners::{Spinner, Spinners};
@@ -17,7 +21,7 @@ use image::GenericImageView;
 use pigmnts::{Pixels, color::{LAB, RGB, HSL}, weights, pigments_pixels};
 
 /// Creates a vector of strings with elements added conditonally
-/// 
+///
 /// # Example
 /// ```
 /// let myvec = conditional_vec![
@@ -40,11 +44,11 @@ macro_rules! conditional_vec {
 }
 
 /// Creates a color palette from image
-/// 
+///
 /// Image is loaded from `image_path` and a palette of `count` colors are created
 fn pigmnts(image_path: &str, count: u8) -> Result<(Vec<(LAB, f32)>, u128), Box<dyn std::error::Error>> {
     let mut img;
-    
+
     if image_path.starts_with("http://") || image_path.starts_with("https://") {
         let mut res = reqwest::blocking::get(image_path)?;
         let mut buf: Vec<u8> = vec![];
@@ -54,28 +58,27 @@ fn pigmnts(image_path: &str, count: u8) -> Result<(Vec<(LAB, f32)>, u128), Box<d
     else {
         img = image::open(image_path)?;
     }
-    
+
     img = img.resize(512, 512, image::imageops::FilterType::CatmullRom);
-    
+
     // Start a timer
     let now = Instant::now();
-    
+
     let pixels: Pixels = img
         .pixels()
         .map(|(_, _, pix)| LAB::from_rgb(pix[0], pix[1], pix[2]))
         .collect();
-    
+
     let weightfn = weights::resolve_mood(&weights::Mood::Dominant);
     let mut output = pigments_pixels(&pixels, count, weightfn, None);
-    
+
     // Sort the output colors based on dominance
     output.sort_by(|(_, a), (_, b)| b.partial_cmp(a).unwrap());
-    
+
     return Ok((output, now.elapsed().as_millis()));
 }
 
 fn main() {
-    
     let matches = App::new("Pigmnts")
         .version(env!("CARGO_PKG_VERSION"))
         .author(env!("CARGO_PKG_AUTHORS"))
@@ -119,22 +122,27 @@ fn main() {
             .short("d")
             .long("dominance")
             .help("Enable dominance percentage of colors"))
+        .arg(Arg::with_name("name")
+            .short("n")
+            .long("name")
+            .help("Enable nearest names of colors"))
         .get_matches();
-    
+
     let image_paths = matches.values_of("input").unwrap();
     let mut counts = values_t!(matches, "count", u8).unwrap_or(Vec::new());
     let is_quiet = matches.is_present("quiet");
     let is_rgb = matches.is_present("rgb");
     let is_hsl = matches.is_present("hsl");
     let is_lab = matches.is_present("lab");
     let is_dom = matches.is_present("dominance");
+    let is_name = matches.is_present("name");
     let mut is_hex = matches.is_present("hex");
-    
+
     // Hex format is enabled when other formats are disabled
     if !is_rgb && !is_hsl & !is_lab {
         is_hex = true;
     }
-    
+
     // Fill the default count value (5) for every input file if not specified
     loop {
         let diff: i8 = image_paths.len() as i8 - counts.len() as i8;
@@ -144,40 +152,41 @@ fn main() {
             break;
         }
     }
-    
+
     // Enumerate through each image_path and generate palettes
     for (i, image_path) in image_paths.enumerate() {
-        
+
         if is_quiet {
             // Quiet mode only shows the result separated by ':'
-            
+
             let (result, _) = pigmnts(image_path, counts[i])
                 .unwrap_or_else(|err| {
                     eprintln!("Problem creating palette: {}", err);
                     process::exit(1);
                 });
-            
+
             for (color, dominance) in result.iter() {
                 let rgb = RGB::from(color);
-                
+
                 let record = conditional_vec![
                     is_hex => rgb.hex(),
                     is_rgb => rgb,
                     is_hsl => HSL::from(color),
                     is_lab => color,
-                    is_dom => dominance * 100.0
+                    is_dom => dominance * 100.0,
+                    is_name => utils::near_color_name(color)
                 ];
-                
+
                 println!("{}", record.join(":"));
             }
-            
+
         } else {
-            
+
             print!("{}{}Creating a palette of ", color::Fg(color::White), style::Bold);
             print!("{}{} ", color::Fg(color::Blue), counts[i]);
             print!("{}colors from ", color::Fg(color::White));
             println!("{}{}{}", color::Fg(color::Blue), image_path, style::Reset);
-            
+
             // Show the spinner in the terminal
             let sp = Spinner::new(Spinners::Dots, String::default());
             let (result, time) = pigmnts(image_path, counts[i])
@@ -191,11 +200,11 @@ fn main() {
                     );
                     process::exit(1);
                 });
-            
+
             // Stop the spinner
             sp.stop();
             println!();
-            
+
             let mut table = Table::new();
             table.set_format(
                 format::FormatBuilder::from(*format::consts::FORMAT_CLEAN)
@@ -204,6 +213,7 @@ fn main() {
             );
             let titles = conditional_vec![
                 true => "",  // Title for color preview
+                is_name => "Name",
                 is_hex => "Hex",
                 is_rgb => "RGB",
                 is_hsl => "HSL",
@@ -218,10 +228,11 @@ fn main() {
                         .collect()
                 )
             );
-            
+
             for (color, dominance) in result.iter() {
                 let rgb = RGB::from(color);
                 let values = conditional_vec![
+                    is_name => utils::near_color_name(color),
                     is_hex => rgb.hex(),
                     is_rgb => rgb,
                     is_hsl => HSL::from(color),
@@ -232,16 +243,16 @@ fn main() {
                     // Color preview is added
                     format!("{}  {}", color::Bg(color::Rgb(rgb.r, rgb.g, rgb.b)), style::Reset)
                 ];
-                
+
                 for value in values.iter() {
                     record.add_cell(cell!(value));
                 }
-                
+
                 table.add_row(record);
             }
             table.printstd();
             println!();
-            
+
             println!(
                 "{}{}✓ Success!{} Took {}ms",
                 color::Fg(color::Green),
@@ -251,5 +262,4 @@ fn main() {
             );
         }
     }
-    
 }

data/colornames.bestof.min.json

@@ -0,0 +1,33 @@
+extern crate serde_cbor;
+
+use pigmnts::color::{LAB, RGB};
+use std::collections::HashMap;
+
+/// Coverts a hex string to RGB color
+fn hex_to_rgb(s: &str) -> RGB {
+  let hex = s.replace("#", "").to_lowercase();
+
+  let hex_num = usize::from_str_radix(&hex, 16).unwrap();
+  return RGB {
+      r: (hex_num >> 16) as u8,
+      g: ((hex_num >> 8) & 0x00FF) as u8,
+      b: (hex_num & 0x0000_00FF) as u8,
+  };
+}
+
+lazy_static! {
+  static ref COLOR_NAMES: (Vec<String>, Vec<LAB>) = {
+      let data: HashMap<String, String> = serde_cbor::from_slice(include_bytes!("../data/colornames.cbor")).unwrap();
+      let values: Vec<LAB> = data
+          .iter()
+          .map(|(val, _)| LAB::from(&hex_to_rgb(val)))
+          .collect();
+
+      return (data.values().cloned().collect(), values);
+  };
+}
+
+/// Returns nearest name of a color
+pub fn near_color_name(color: &LAB) -> &String {
+  return &COLOR_NAMES.0[color.nearest(&COLOR_NAMES.1).0];
+}