{"id":26,"date":"2024-04-20T10:15:39","date_gmt":"2024-04-20T18:15:39","guid":{"rendered":"https:\/\/tonybhimani.com\/programming-blog\/?p=26"},"modified":"2024-04-24T12:47:28","modified_gmt":"2024-04-24T20:47:28","slug":"php-imagemagick-to-crop-square-and-pad-an-image","status":"publish","type":"post","link":"https:\/\/www.tonybhimani.com\/programming-blog\/php-imagemagick-to-crop-square-and-pad-an-image\/","title":{"rendered":"PHP + ImageMagick to Crop, Square, and Pad an Image"},"content":{"rendered":"\r\n

This isn’t anything new as there are plenty of scripts and tools out there to accomplish the given goal, but sometimes it’s easier to implement your own solution. Frankly, I got tired of manually editing images that followed the same formatting guidelines so I wrote this script to speed up the conversion process. I used PHP, however any language like Python, Ruby, etc would work as long as it can execute shell commands. If you have a plugin extension for ImageMagick then that would be a better option, but I didn’t want to bother with PECL.<\/p>\r\n\r\n\r\n\r\n

The use case here is I have a bunch of given product images of varying sizes and pixel paddings i.e. empty surrounding solid color space. For each image I’d load it in GIMP, run a crop to remove the excess padding, take the higher of the two values (width or height), multiply it by a scale factor and round up, edit the canvas width and height to that new value, center the image content, drop in a new white background layer, bring the original layer to the top, merge down, save to overwrite the image. This is a very painful manual process and batch processing images should be easier — hence this script.<\/p>\r\n\r\n\r\n\r\n

Before you try it it, keep in mind I was doing this on Windows so the executable names may vary for ImageMagick on Linux or Mac. It’s been a while since I’ve used it on Linux and I vaguely remember the tool being called convert<\/strong>. Running that program of the same name on Windows wanted to modify my hard disk. Yikes! ImageMagick’s install location is in my environment variables so there are no paths in the script. Also, I didn’t include any error checking like if images don’t get generated. Feel free to add that yourself.<\/p>\r\n\r\n\r\n\r\n

Run it from the command line and pass in the image filename (local or url) as the first argument. The second argument, image output filename, is optional.<\/p>\r\n

\r\nC:\\Users\\Tony> php -f process_image.php image.jpg\r\n<\/pre>\r\n
It currently works on a single image. Yes, I know, that does contradict my earlier statement of batch processing, but I was in a rush. I’ll make an update and do a follow-up post soon.<\/s><\/p>\r\n\r\n\r\n
\r\n<?php\r\n\r\n\/*******************************************************\r\n\r\n\tVIA IMAGEMAGICK\r\n\t\tCROP THE EXCESS SPACE AROUND THE IMAGE\r\n\t\tCALCULATE NEW WIDTH & HEIGHT FROM SCALE\r\n\t\tRE-FIT THE IMAGE TO NEW SIZE WITH PADDING\r\n\r\n*******************************************************\/\r\n\r\n\/\/ get input filename\r\n$img1 = $argv[1];\r\nif (!$img1) die("Specify input local image or url\\n");\r\n\r\n\/\/ get output filename\r\n$img2 = $argv[2];\r\n\r\n\/\/ path info\r\n$path_parts = pathinfo($img1);\r\n$basename = $path_parts["basename"];\r\n$filename = $path_parts["filename"];\r\n$extension = $path_parts["extension"];\r\n\r\n\/\/ input filename\r\necho "input file => ";\r\necho $img1;\r\necho "\\n";\r\n\r\n\/\/ only checking for http(s) prefix\r\nif (preg_match("\/^https?:\\\/\\\/\/i", $img1)) {\r\n\t$data = file_get_contents($img1);\r\n\tfile_put_contents($basename, $data);\r\n\t$img1 = $basename;\r\n}\r\n\r\n\/\/ output filename not set\r\nif (!$img2) $img2 = sprintf("%s_out.%s", $filename, $extension);\r\n\r\n\/\/ temp names\r\n$tmp1 = sprintf("%s_tmp1.%s", $filename, $extension);\r\n$tmp2 = sprintf("%s_tmp2.%s", $filename, $extension);\r\n\r\n\/\/ scale factor\r\n$scale_factor = 1.125;\r\n\r\n\/\/ first crop\r\n$crop = sprintf('magick %s -fuzz 1%% -trim +repage %s', $img1, $tmp1);\r\n$result = shell_exec($crop);\r\n\r\n\/\/ then get size\r\n$identify = sprintf('identify -ping -format "%%[width] %%[height]" %s', $tmp1);\r\n$result = shell_exec($identify);\r\n\r\n\/\/ width x height\r\n$dimensions = @explode(" ", $result);\r\n\r\n\/\/ see dimensions\r\necho "dimensions => ";\r\necho sprintf("%sx%s", $dimensions[0], $dimensions[1]);\r\necho "\\n";\r\n\r\n\/\/ bigger of the two\r\n$max_size = max($dimensions);\r\necho "max size => ";\r\necho $max_size;\r\necho "\\n";\r\n\r\n\/\/ scale factor from above\r\necho "scale factor => ";\r\necho $scale_factor;\r\necho "\\n";\r\n\r\n\/\/ calculate new size (width and height will be the same)\r\n$new_size = ceil(($max_size * $scale_factor) \/ 10) * 10;\r\necho "new size => ";\r\necho $new_size;\r\necho "\\n";\r\n\r\n\/\/ make new image\r\n$make = sprintf('magick %s -background White -gravity center -extent %sx%s %s', $tmp1, $new_size, $new_size, $img2);\r\n$result = shell_exec($make);\r\n\r\n\/\/ remove temp file\r\nunlink($tmp1);\r\n\r\n\/\/ output filename\r\necho "output file => ";\r\necho $img2;\r\necho "\\n";\r\n\r\n?>\r\n<\/pre><\/pre>\r\n\r\n\r\n\r\n
Update 4\/24\/2024<\/strong><\/p>\r\n
Here is a quick and dirty wrapper script — I decided to leave the original as is. You can pass it a file containing a list of image filenames and\/or URLs as the only argument. It’s going to use the default generated output names, but you could upgrade it. CSV, JSON, or another format where you could specify both the input and output filenames.<\/p>\r\n
\r\nC:\\Users\\Tony> php -f image_batch.php list.txt\r\n<\/pre>\r\n\r\n\r\n
\r\n<?php\r\n\r\n\/*******************************************************\r\n\r\n\tWRAPPER SCRIPT FOR BATCH PROCESSING IMAGES\r\n\r\n*******************************************************\/\r\n\r\n\/\/ list of images input file\r\n$batch_file = $argv[1];\r\nif (!$batch_file) die("Specify list of images input file\\n");\r\n\r\n\/\/ read in the image filenames \/ urls to an array\r\n$images = file($batch_file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);\r\n\r\n\/\/ shell exec the image processing script\r\nforeach ($images as $image) {\r\n\techo shell_exec(sprintf("php -f process_image.php %s", $image));\r\n\techo "\\n";\r\n}\r\n\r\n?>\r\n<\/pre><\/pre>\r\n\r\n\r\n
Resources:<\/strong><\/p>\r\n