{"id":50143,"date":"2010-05-02T00:01:00","date_gmt":"2010-05-02T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2010\/05\/02\/hey-scripting-guy-weekend-scripter-converting-all-types-of-image-files-to-jpeg-format\/"},"modified":"2010-05-02T00:01:00","modified_gmt":"2010-05-02T00:01:00","slug":"hey-scripting-guy-weekend-scripter-converting-all-types-of-image-files-to-jpeg-format","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/hey-scripting-guy-weekend-scripter-converting-all-types-of-image-files-to-jpeg-format\/","title":{"rendered":"Hey, Scripting Guy! Weekend Scripter: Converting All Types of Image Files to JPEG Format"},"content":{"rendered":"

\"Bookmark<\/a><\/p>\n

 <\/p>\n

This week saw the kickoff and first week of the 2010 Scripting Games<\/a>. The Scripting Wife is in the midst of things, so we decided to give her a break and let her catch her breath. You can catch up with her progress by reviewing the articles in the archive<\/a>. <\/p>\n

Microsoft Scripting Guy Ed Wilson here. Yesterday<\/a>, I wrote a quick script that will convert a .png file to a .jpg file. As I was looking at it again, I decided that it would be pretty cool to expand upon it a little bit because I can see myself using it on a regular basis. In fact, it will convert .bmp or other image file formats to a .jpg format as well. If you use a different format enumeration value, it will save to image types besides .jpg.<\/p>\n

I created a function, added help to the function, and configured it in such a way that it accepts piped input. The resulting script is pretty useful, and the advanced function itself is ready to be copied into a profile or a module. <\/p>\n

ConvertTo-JpgFunction.ps1<\/strong><\/p>\n

#Requires -version 2.0
Param($path = “C:\\fso”)<\/p>\n

Function ConvertTo-Jpg
{
 <\/span><#
  <\/span>.Synopsis
    <\/span>Creates copies of images into jpg files. The new
    <\/span>image file has the same name as original, but new extension. New
    <\/span>images are automatically stored in same directory as originals.
   <\/span>.Example
    <\/span>ConvertTo-Jpg -sourceFile “C:\\fso\\image.png”
    <\/span>Creates image.jpg from image.png
   <\/span>.Example
    <\/span>Get-ChildItem -Path c:\\fso -Include *.png -Recurse | ConvertTo-Jpg
    <\/span>Creates .jpg images from all png images in c:\\fso directory
   <\/span>.Parameter SourceFile
    <\/span>The image file to be converted to JPG
   <\/span>.Inputs
    <\/span>[string]
   <\/span>.Outputs
    <\/span>[Drawing.Image]
   <\/span>.Notes
    <\/span>NAME:  <\/span>ConvertTo-Jpg
    <\/span>AUTHOR: Ed Wilson
    <\/span>AUTHOR BOOK: Windows PowerShell 2.0 Best Practices, Microsoft Press 2010
    <\/span>LASTEDIT: 1\/31\/2010
    <\/span>KEYWORDS: Weekend Scripter, Multimedia, Graphics
   <\/span>.Link
     <\/span>Http:\/\/www.ScriptingGuys.com
     <\/span>Http:\/\/www.bit.ly\/HSGBlog
 <\/span>#>
 <\/span>#Requires -Version 2.0
 <\/span>[CmdletBinding()]
 <\/span>param(
      <\/span>[Parameter(Mandatory = $True,valueFromPipeline=$true)]
      <\/span>$SourceFile
) #end param
 <\/span>BEGIN {
   <\/span>Try
     <\/span>{
      <\/span>$drawing = “system.drawing.image” -as [type]     <\/span>
      <\/span>$imageFormat = “System.Drawing.Imaging.ImageFormat” -as [type]                                                                        <\/span>
      <\/span>[reflection.assembly]::GetAssembly($drawing) | Out-Null
     <\/span>}
   <\/span>Catch [system.Exception]
     <\/span>{
      <\/span>“Assembly not loaded. Loading now.”
      <\/span>Add-Type -AssemblyName system.drawing
      <\/span>$imageFormat = “System.Drawing.Imaging.ImageFormat” -as [type]
     <\/span>}
    <\/span>} #end begin
 <\/span>PROCESS {
    <\/span>$saveFile = Join-Path -Path $_.directory -ChildPath ($_.BaseName + “.jpg”)
    <\/span>If(!(Test-Path -Path $saveFile))
      <\/span>{
       <\/span>$image = [drawing.image]::FromFile($sourceFile)
       <\/span>$image.Save($saveFile, $imageFormat::jpeg)
      <\/span>}
    <\/span>Else { “$saveFile already exists. Skipping …” }
   <\/span>} #end process
} #end function ConvertTo-Jpg<\/p>\n

# *** Entry Point to Script ***<\/p>\n

If(!$path) { “You must supply path to images for processing”;exit }
Get-ChildItem -Path $path -Include *.png -Recurse | ConvertTo-Jpg<\/font><\/font><\/p>\n

Keep in mind that in addition to the ConvertTo-Jpg<\/b> function, there is also code in the script itself. The script accepts command-line input that allows you to call the script and pass a folder for the parameter. The script then checks to see if the folder exists, and if it does, it calls Get-ChildItem<\/b> to retrieve all of the .png files in the folder, and then passes the collection to the ConvertTo-Jpg<\/b> function. The $path<\/b> parameter is assigned a default value of c:\\fso that probably will not exist on your computer. This is shown here:<\/p>\n

Param($path = “C:\\fso”)<\/font><\/font><\/p>\n

The entry point to the script is shown here:<\/p>\n

If(!$path) { “You must supply path to images for processing”;exit }
Get-ChildItem -Path $path -Include *.png -Recurse | ConvertTo-Jpg<\/font><\/font><\/p>\n

The help section of the ConvertTo-Jpg<\/b> function is seen here. Adding help tags to a function was discussed in a recent Hey, Scripting Guy! post<\/font><\/a>:<\/p>\n

<#
  <\/span>.Synopsis
    <\/span>Creates copies of images into jpg files. The new
    <\/span>image file has same name as original, but new extension. New
    <\/span>images are automatically stored in same directory as originals.
   <\/span>.Example
    <\/span>ConvertTo-Jpg -sourceFile “C:\\fso\\image.png”
    <\/span>Creates image.jpg from image.png
   <\/span>.Example
    <\/span>Get-ChildItem -Path c:\\fso -Include *.png -Recurse | ConvertTo-Jpg
    <\/span>Creates .jpg images from all png images in c:\\fso directory
   <\/span>.Parameter SourceFile
    <\/span>The image file to be converted to JPG
   <\/span>.Inputs
    <\/span>[string]
   <\/span>.Outputs
    <\/span>[Drawing.Image]
   <\/span>.Notes
    <\/span>NAME:  <\/span>ConvertTo-Jpg
    <\/span>AUTHOR: Ed Wilson
    <\/span>AUTHOR BOOK: Windows PowerShell 2.0 Best Practices, Microsoft Press 2010
    <\/span>LASTEDIT: 1\/31\/2010
    <\/span>KEYWORDS: WeekEnd Scripter, Multimedia, Graphics
   <\/span>.Link
     <\/span>Http:\/\/www.scriptingguys.com
     <\/span>Http:\/\/www.bit.ly\/hsgblog
 <\/span>#><\/font><\/font><\/p>\n

The next lines of code ensure the function is running on Windows PowerShell 2.0, turn on cmdlet binding, and define the $sourceFile<\/b> parameter as mandatory:<\/p>\n

#Requires -Version 2.0
 <\/span>[CmdletBinding()]
 <\/span>param(
      <\/span>[Parameter(Mandatory = $True,valueFromPipeline=$true)]
      <\/span>$SourceFile
) #end param<\/font><\/font><\/p>\n

The BEGIN<\/b> section of the function uses Try\/Catch<\/b> to ensure that the System.Drawing<\/b> .NET Framework assembly is loaded and the ImageFormat<\/b> type is created. These concepts were discussed yesterday. Try\/Catch<\/b> was discussed in a recent Hey, Scripting Guy! post<\/font><\/a>. To determine if the System.Drawing<\/b> .NET Framework assembly has been loaded, the GetAssembly<\/b> static method from the Reflection.Assembly<\/b> class is used. This method requires a type, and that is why the drawing<\/b> type is created. This section of the script is shown here:<\/p>\n

BEGIN {
   <\/span>Try
     <\/span>{
      <\/span>$drawing = “system.drawing.image” -as [type]     <\/span>
      <\/span>$imageFormat = “System.Drawing.Imaging.ImageFormat” -as [type]                                                                        <\/span>
      <\/span>[reflection.assembly]::GetAssembly($drawing) | Out-Null
    <\/span> <\/span>}
   <\/span>Catch [system.Exception]
     <\/span>{
      <\/span>“Assembly not loaded. Loading now.”
      <\/span>Add-Type -AssemblyName system.drawing
      <\/span>$imageFormat = “System.Drawing.Imaging.ImageFormat” -as [type]
     <\/span>}
    <\/span>} #end begin<\/font><\/font><\/p>\n

In the PROCESS<\/b> section of the function, the script uses the Join-Path<\/b> cmdlet to create the path to the new image file that will be created. It uses the directory<\/b> property from the current item on the pipeline for the parent path, and the basename<\/b> property to get the file name portion of the path. The .jpg file extension is concatenated onto the basename<\/b> property to complete the childpath<\/b>. The Test-Path<\/b> cmdlet is then used to see if the file already exists. If it does not, the image is converted to the new file format. This part of the script works the same as the script from yesterday. <\/p>\n

PROCESS {
    <\/span>$saveFile = Join-Path -Path $_.directory -ChildPath ($_.BaseName + “.jpg”)
    <\/span>If(!(Test-Path -Path $saveFile))
      <\/span>{
       <\/span>$image = [drawing.image]::FromFile($sourceFile)
       <\/span>$image.Save($saveFile, $imageFormat::jpeg)
      <\/span>}
    <\/span>Else { “$saveFile already exists. Skipping …” }
   <\/span>} #end process
} #end function ConvertTo-Jpg<\/font><\/span><\/p>\n

The results from running the script are seen in the following image.<\/p>\n

\"Image<\/font><\/a><\/p>\n

 <\/p>\n

The 2010 Scripting Games continue tomorrow. We will be revealing Events 6\u201310 tomorrow through Friday. If you want to know exactly what we will be looking at tomorrow, follow us on Twitter<\/a> or Facebook<\/a>. If you have any questions, send e-mail to us at scripter@microsoft.com<\/font><\/a> or post your questions on the Official Scripting Guys Forum<\/font><\/a>. See you tomorrow. Until then, peace.<\/p>\n

 <\/p>\n

Ed Wilson and Craig Liebendorfer, Scripting Guys<\/span><\/b><\/p>\n

 <\/p>\n","protected":false},"excerpt":{"rendered":"

  This week saw the kickoff and first week of the 2010 Scripting Games. The Scripting Wife is in the midst of things, so we decided to give her a break and let her catch her breath. You can catch up with her progress by reviewing the articles in the archive. Microsoft Scripting Guy Ed […]<\/p>\n","protected":false},"author":595,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[122,123,3,61,45],"class_list":["post-50143","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-graphics","tag-multimedia","tag-scripting-guy","tag-weekend-scripter","tag-windows-powershell"],"acf":[],"blog_post_summary":"

  This week saw the kickoff and first week of the 2010 Scripting Games. The Scripting Wife is in the midst of things, so we decided to give her a break and let her catch her breath. You can catch up with her progress by reviewing the articles in the archive. Microsoft Scripting Guy Ed […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/50143","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/595"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=50143"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/50143\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=50143"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=50143"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=50143"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}