Merge pull request #124 from ynput/enhancement/YN-1004-tiff-format-for-Extract-Image

Extract Image: Add tif support

Author: BigRoy

client/ayon_photoshop/api/extension.zxp

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<ExtensionManifest ExtensionBundleId="io.ynput.PS.panel" ExtensionBundleVersion="1.1.14" Version="7.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+<ExtensionManifest ExtensionBundleId="io.ynput.PS.panel" ExtensionBundleVersion="1.1.15" Version="7.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <ExtensionList>
     <Extension Id="io.ynput.PS.panel" />
   </ExtensionList>

client/ayon_photoshop/api/extension/CSXS/manifest.xml

@@ -65,14 +65,14 @@ function getLayerTypeWithName(layerName) {
 
 function getLayers() {
     /**
-     * Get json representation of list of layers. 
+     * Get json representation of list of layers.
      * Much faster this way than in DOM traversal (2s vs 45s on same file)
-     * 
+     *
      * Format of single layer info:
      *      id :    number
      *      name:   string
      *      group:  boolean - true if layer is a group
-     *      parents:array - list of ids of parent groups, useful for selection 
+     *      parents:array - list of ids of parent groups, useful for selection
      *          all children layers from parent layerSet (eg. group)
      *      type:   string - type of layer guessed from its name
      *      visible:boolean - true if visible
@@ -81,14 +81,14 @@ function getLayers() {
         return '[]';
     }
     var ref1 = new ActionReference();
-    ref1.putEnumerated(charIDToTypeID('Dcmn'), charIDToTypeID('Ordn'), 
+    ref1.putEnumerated(charIDToTypeID('Dcmn'), charIDToTypeID('Ordn'),
                        charIDToTypeID('Trgt'));
     var count = executeActionGet(ref1).getInteger(charIDToTypeID('NmbL'));
 
     // get all layer names
     var layers = [];
     var layer = {};
-    
+
     var parents = [];
     for (var i = count; i >= 1; i--) {
       var layer = {};
@@ -98,8 +98,8 @@ function getLayers() {
       var desc = executeActionGet(ref2);  // Access layer index #i
       var layerSection = typeIDToStringID(desc.getEnumerationValue(
                                           stringIDToTypeID('layerSection')));
-      
-      layer.id = desc.getInteger(stringIDToTypeID("layerID")); 
+
+      layer.id = desc.getInteger(stringIDToTypeID("layerID"));
       layer.name = desc.getString(stringIDToTypeID("name"));
       layer.color_code = typeIDToStringID(desc.getEnumerationValue(stringIDToTypeID('color')));
       layer.group = false;
@@ -108,16 +108,16 @@ function getLayers() {
       layer.visible = desc.getBoolean(stringIDToTypeID("visible"));
       var blendMode = desc.getEnumerationValue(stringIDToTypeID("mode"));
       layer.blend_mode = typeIDToStringID(blendMode);
-      //log(" name: " + layer.name + " groupId " + layer.groupId + 
+      //log(" name: " + layer.name + " groupId " + layer.groupId +
       //" group " + layer.group);
       if (layerSection == 'layerSectionStart') { // Group start and end
-        parents.push(layer.id); 
-        layer.group = true;                    
+        parents.push(layer.id);
+        layer.group = true;
       }
       if (layerSection == 'layerSectionEnd') {
         parents.pop();
         continue;
-      } 
+      }
       layers.push(JSON.stringify(layer));
     }
      try{
@@ -145,10 +145,10 @@ function setVisible(layer_id, visibility){
     var ref = new ActionReference();
     ref.putIdentifier(stringIDToTypeID("layer"), layer_id);
     desc.putReference(stringIDToTypeID("null"), ref);
-    
-    executeAction(visibility?stringIDToTypeID("show"):stringIDToTypeID("hide"), 
+
+    executeAction(visibility?stringIDToTypeID("show"):stringIDToTypeID("hide"),
                   desc, DialogModes.NO);
-    
+
 }
 
 function setLayersVisibility(visibilityMap) {
@@ -166,14 +166,14 @@ function setLayersVisibility(visibilityMap) {
 
 function getHeadline(){
     /**
-     *  Returns headline of current document with metadata 
-     * 
+     *  Returns headline of current document with metadata
+     *
      **/
     if (documents.length == 0){
         return '';
     }
     var headline = app.activeDocument.info.headline;
-    
+
     return headline;
 }
 
@@ -182,7 +182,7 @@ function isSaved(){
 }
 
 function save(){
-    /** Saves active document **/        
+    /** Saves active document **/
     return app.activeDocument.save();
 }
 
@@ -304,13 +304,13 @@ function getLayerBlendMode(layer_id) {
 
 function saveAs(output_path, ext, as_copy){
     /** Exports scene to various formats
-     * 
-     * Currently implemented: 'jpg', 'png', 'psd'
-     * 
+     *
+     * Currently implemented: 'jpg', 'png', 'psd', 'tga', 'exr', 'psb', and 'tif'.
+     *
      * output_path - escaped file path on local system
      * ext - extension for export
      * as_copy - create copy, do not overwrite
-     * 
+     *
      * */
     var saveName = output_path;
     var saveOptions;
@@ -373,7 +373,12 @@ function saveAs(output_path, ext, as_copy){
         if (ext === 'psb') {
             return savePSB(output_path);
         }
-
+        // For TIF/TIFF, ensure saveOptions is properly initialized
+        if (ext === 'tif' || ext === 'tiff') {
+            saveOptions = new TiffSaveOptions();
+            saveOptions.alphaChannels = true;
+            saveOptions.imageCompression = TIFFEncoding.TIFFLZW;
+        }
         return doc.saveAs(new File(saveName), saveOptions, as_copy);
     }
     finally {
@@ -465,7 +470,7 @@ function imprint(payload){
      *  Sets headline content of current document with metadata. Stores
      *  information about assets created through AYON.
      *  Content accessible in PS through File > File Info
-     * 
+     *
      **/
     app.activeDocument.info.headline = payload;
 }
@@ -484,7 +489,7 @@ function getSelectedLayers(doc) {
 
     var selLayers = [];
     _grp = groupSelectedLayers(doc);
-  
+
     var group = doc.activeLayer;
     var layers = group.layers;
 
@@ -501,7 +506,7 @@ function getSelectedLayers(doc) {
         layer.name = layers[i].name;
         long_names =_get_parents_names(group.parent, layers[i].name);
         var t = layers[i].kind;
-        if ((typeof t !== 'undefined') && 
+        if ((typeof t !== 'undefined') &&
             (layers[i].kind.toString() == 'LayerKind.NORMAL')){
             layer.group = false;
         }else{
@@ -511,9 +516,9 @@ function getSelectedLayers(doc) {
 
         selLayers.push(layer);
     }
-  
+
     _undo();
-  
+
     return JSON.stringify(selLayers);
 };
 
@@ -527,7 +532,7 @@ function selectLayers(selectedLayers){
     var desc12 = new ActionDescriptor();
     var id55 = charIDToTypeID( "null" );
     var ref9 = new ActionReference();
-    
+
     var existing_layers = JSON.parse(getLayers());
     var existing_ids = [];
     for (var y = 0; y < existing_layers.length; y++){
@@ -539,7 +544,7 @@ function selectLayers(selectedLayers){
        if(existing_ids.toString().indexOf(id)>=0){
            layers[i] = charIDToTypeID( "Lyr " );
            ref9.putIdentifier(layers[i], id);
-       }       
+       }
     }
     desc12.putReference( id55, ref9 );
     var id58 = charIDToTypeID( "MkVs" );
@@ -551,38 +556,38 @@ function groupSelectedLayers(doc, name) {
     /**
      * Groups selected layers into new group.
      * Returns json representation of Layer for server to consume
-     * 
+     *
      * Args:
      *     doc(activeDocument)
      *     name (str): new name of created group
      **/
     if (doc == null){
         doc = app.activeDocument;
     }
-    
+
     var desc = new ActionDescriptor();
     var ref = new ActionReference();
     ref.putClass( stringIDToTypeID('layerSection') );
     desc.putReference( charIDToTypeID('null'), ref );
     var lref = new ActionReference();
-    lref.putEnumerated( charIDToTypeID('Lyr '), charIDToTypeID('Ordn'), 
+    lref.putEnumerated( charIDToTypeID('Lyr '), charIDToTypeID('Ordn'),
                         charIDToTypeID('Trgt') );
     desc.putReference( charIDToTypeID('From'), lref);
     executeAction( charIDToTypeID('Mk  '), desc, DialogModes.NO );
-    
+
     var group = doc.activeLayer;
     if (name){
         // Add special character to highlight group that will be published
         group.name = name;
-    }   
+    }
     var layer = {};
     layer.id = group.id;
     layer.name = name; // keep name clean
-    layer.group = true; 
+    layer.group = true;
 
     layer.long_name = _get_parents_names(group, name);
 
-    return JSON.stringify(layer);        
+    return JSON.stringify(layer);
 };
 
 /**
@@ -648,26 +653,26 @@ function mergeAllLayerSets(parentSetId) {
 function importSmartObject(path, name, link){
     /**
      *  Creates new layer with an image from 'path'
-     *  
+     *
      *      path: absolute path to loaded file
      *      name: sets name of newly created laye
-     *  
+     *
      **/
     var desc1 = new ActionDescriptor();
     desc1.putPath( app.charIDToTypeID("null"), new File(path) );
     link = link || false;
     if (link) {
-        desc1.putBoolean( app.charIDToTypeID('Lnkd'), true );  
+        desc1.putBoolean( app.charIDToTypeID('Lnkd'), true );
     }
 
-    desc1.putEnumerated(app.charIDToTypeID("FTcs"), app.charIDToTypeID("QCSt"), 
-                       app.charIDToTypeID("Qcsa"));                     
+    desc1.putEnumerated(app.charIDToTypeID("FTcs"), app.charIDToTypeID("QCSt"),
+                       app.charIDToTypeID("Qcsa"));
     var desc2 = new ActionDescriptor();
-    desc2.putUnitDouble(app.charIDToTypeID("Hrzn"), 
+    desc2.putUnitDouble(app.charIDToTypeID("Hrzn"),
                         app.charIDToTypeID("#Pxl"), 0.0);
-    desc2.putUnitDouble(app.charIDToTypeID("Vrtc"), 
+    desc2.putUnitDouble(app.charIDToTypeID("Vrtc"),
                         app.charIDToTypeID("#Pxl"), 0.0);
-    
+
     desc1.putObject(charIDToTypeID("Ofst"), charIDToTypeID("Ofst"), desc2);
     executeAction(charIDToTypeID("Plc " ), desc1, DialogModes.NO);
 
@@ -678,14 +683,14 @@ function importSmartObject(path, name, link){
     }
     var layer = {}
     layer.id = currentActivelayer.id;
-    layer.name = currentActivelayer.name;                        
-    return JSON.stringify(layer);     
+    layer.name = currentActivelayer.name;
+    return JSON.stringify(layer);
 }
 
 function replaceSmartObjects(layer_id, path, name){
     /**
      *  Updates content of 'layer' with an image from 'path'
-     *  
+     *
      **/
 
     var desc = new ActionDescriptor();
@@ -696,12 +701,12 @@ function replaceSmartObjects(layer_id, path, name){
     desc.putPath(charIDToTypeID('null'), new File(path) );
     desc.putInteger(charIDToTypeID("PgNm"), 1);
 
-    executeAction(stringIDToTypeID('placedLayerReplaceContents'), 
-                  desc, DialogModes.NO );       
+    executeAction(stringIDToTypeID('placedLayerReplaceContents'),
+                  desc, DialogModes.NO );
     var currentActivelayer = app.activeDocument.activeLayer;
     if (name){
         currentActivelayer.name = name;
-    }                  
+    }
 }
 
 function createGroup(name){
@@ -712,14 +717,14 @@ function createGroup(name){
     group = app.activeDocument.layerSets.add();
     // Add special character to highlight group that will be published
     group.name = name;
-       
+
     return group.id;  // only id available at this time :|
 }
 
-function deleteLayer(layer_id){          
+function deleteLayer(layer_id){
     /***
      * Deletes layer by its layer_id
-     * 
+     *
      * layer_id (int)
      **/
     var d = new ActionDescriptor();
@@ -761,16 +766,16 @@ function saveEXR(savePath) {
 function savePSB(output_path){
     /***
      * Saves file as .psb to 'output_path'
-     * 
+     *
      * output_path (str)
      **/
     var desc1 = new ActionDescriptor();
     var desc2 = new ActionDescriptor();
-    desc2.putBoolean( stringIDToTypeID('maximizeCompatibility'), true );        
-    desc1.putObject( charIDToTypeID('As  '), charIDToTypeID('Pht8'), desc2 );        
-    desc1.putPath( charIDToTypeID('In  '), new File(output_path) );       
-    desc1.putBoolean( charIDToTypeID('LwCs'), true );        
-    executeAction( charIDToTypeID('save'), desc1, DialogModes.NO );      
+    desc2.putBoolean( stringIDToTypeID('maximizeCompatibility'), true );
+    desc1.putObject( charIDToTypeID('As  '), charIDToTypeID('Pht8'), desc2 );
+    desc1.putPath( charIDToTypeID('In  '), new File(output_path) );
+    desc1.putBoolean( charIDToTypeID('LwCs'), true );
+    executeAction( charIDToTypeID('save'), desc1, DialogModes.NO );
 }
 
 function close(){
@@ -780,13 +785,13 @@ function close(){
 function renameLayer(layer_id, new_name){
     /***
      * Renames 'layer_id' to 'new_name'
-     * 
+     *
      * Via Action (fast)
-     * 
+     *
      * Args:
      *    layer_id(int)
      *    new_name(str)
-     * 
+     *
      * output_path (str)
      **/
     doc = app.activeDocument;

client/ayon_photoshop/api/extension/host/index.jsx

@@ -28,7 +28,7 @@ class ExtractImage(
     label = "Extract Image"
     hosts = ["photoshop"]
     families = ["image"]
-    formats = ["png", "jpg", "tga", "exr"]
+    formats = ["png", "jpg", "tga", "exr", "tif"]
     settings_category = "photoshop"
     optional = False
 
@@ -89,8 +89,9 @@ def process(self, context):
                         stub.get_active_document_name()
                     )
                     workfile_extension = workfile_extension.strip(".")
-
+                    self.log.debug(f"Extracting formats {self.formats} for {instance}")
                     for extension in self.formats:
+                        self.log.debug(f"Extracting {extension} for {instance}")
                         repre_filename = f"{file_basename}_{suffix}.{extension}"
                         files[extension] = repre_filename