Feature/add trim & volume json (#504)

Author: Nir Maoz

__TESTS__/unit/fromJson/videoEditTrim.fromJson.test.ts

@@ -0,0 +1,38 @@
+import {fromJson} from "../../../src/internal/fromJson";
+import {ITrimActionModel} from "../../../src/internal/models/ITrimActionModel";
+
+describe('videoEdit.trim fromJson', () => {
+  it('Should generate TrimAction from model', () => {
+    const trimModel: ITrimActionModel = {
+      actionType: 'trimVideo',
+      duration: '30%',
+    };
+
+    const transformation = fromJson({actions: [trimModel]});
+
+    expect(transformation.toString()).toStrictEqual('du_30p');
+  });
+
+  it('Should generate ConcatenateAction with transition from model', () => {
+    const trimModel: ITrimActionModel = {
+      actionType: 'trimVideo',
+      startOffset: 3,
+      endOffset: 5,
+    };
+
+    const transformation = fromJson({actions: [trimModel]});
+    expect(transformation.toString()).toStrictEqual('eo_5,so_3');
+  });
+
+  it('Should generate ConcatenateAction with ImageSource and transition from model', () => {
+    const trimModel: ITrimActionModel = {
+      actionType: 'trimVideo',
+      startOffset: 3,
+      duration: 5,
+    };
+
+    const transformation = fromJson({actions: [trimModel]});
+
+    expect(transformation.toString()).toStrictEqual('du_5,so_3');
+  });
+});

__TESTS__/unit/fromJson/volume.fromJson.test.ts

@@ -0,0 +1,45 @@
+import {fromJson} from "../../../src/internal/fromJson";
+import {IVolumeActionModel} from "../../../src/internal/models/IVolumeActionModel";
+
+describe('videoEdit.volume fromJson', () => {
+  it('Should generate VolumeAction with percentage from model', () => {
+    const trimModel: IVolumeActionModel = {
+      actionType: 'volume',
+      volumeValue: {
+        mode: "percent",
+        value: 10
+      }
+    };
+
+    const transformation = fromJson({actions: [trimModel]});
+
+    expect(transformation.toString()).toStrictEqual('e_volume:10');
+  });
+
+  it('Should generate VolumeAction with decibels from model', () => {
+    const trimModel: IVolumeActionModel = {
+      actionType: 'volume',
+      volumeValue: {
+        mode: "decibels",
+        value: 10
+      }
+    };
+
+    const transformation = fromJson({actions: [trimModel]});
+
+    expect(transformation.toString()).toStrictEqual('e_volume:10db');
+  });
+
+  it('Should generate VolumeAction with mute from model', () => {
+    const trimModel: IVolumeActionModel = {
+      actionType: 'volume',
+      volumeValue: {
+        mode: "mute",
+      }
+    };
+
+    const transformation = fromJson({actions: [trimModel]});
+
+    expect(transformation.toString()).toStrictEqual('e_volume:mute');
+  });
+});

__TESTS__/unit/toJson/videoEditTrim.toJson.test.ts

@@ -0,0 +1,53 @@
+import {Transformation} from '../../../src';
+import {VideoEdit} from "../../../src/actions";
+
+describe('videoEdit.trim toJson', () => {
+  it('videoEdit.trim with duration', () => {
+    const transformation = new Transformation()
+      .videoEdit(VideoEdit.trim()
+        .duration('30%')
+      );
+    expect(transformation.toJson()).toStrictEqual({
+      actions: [
+        {
+          actionType: 'trimVideo',
+          duration: '30%',
+        }
+      ]
+    });
+  });
+
+  it('videoEdit.trim with startOffset and endOffset', () => {
+    const transformation = new Transformation()
+      .videoEdit(VideoEdit.trim()
+        .startOffset(3)
+        .endOffset(5)
+      );
+    expect(transformation.toJson()).toStrictEqual({
+      actions: [
+        {
+          actionType: 'trimVideo',
+          startOffset: 3,
+          endOffset: 5,
+        }
+      ]
+    });
+  });
+
+  it('videoEdit.trim with startOffset and duration', () => {
+    const transformation = new Transformation()
+      .videoEdit(VideoEdit.trim()
+        .startOffset(3)
+        .duration(5)
+      );
+    expect(transformation.toJson()).toStrictEqual({
+      actions: [
+        {
+          actionType: 'trimVideo',
+          startOffset: 3,
+          duration: 5,
+        }
+      ]
+    });
+  });
+});

__TESTS__/unit/toJson/volume.toJson.test.ts

@@ -0,0 +1,55 @@
+import {Transformation} from '../../../src';
+import {VideoEdit} from "../../../src/actions";
+import {byDecibels, byPercent, mute} from "../../../src/qualifiers/volume";
+
+describe('videoEdit.trim toJson', () => {
+  it('videoEdit.volume with decibels', () => {
+    const transformation = new Transformation()
+      .videoEdit(VideoEdit.volume(byDecibels(10))
+      );
+    expect(transformation.toJson()).toStrictEqual({
+      actions: [
+        {
+          actionType: 'volume',
+          volumeValue: {
+            mode: 'decibels',
+            value: 10
+          }
+        }
+      ]
+    });
+  });
+
+  it('videoEdit.volume with percent', () => {
+    const transformation = new Transformation()
+      .videoEdit(VideoEdit.volume(byPercent(10))
+      );
+    expect(transformation.toJson()).toStrictEqual({
+      actions: [
+        {
+          actionType: 'volume',
+          volumeValue: {
+            mode: 'percent',
+            value: 10
+          }
+        }
+      ]
+    });
+  });
+
+  it('videoEdit.volume with mute', () => {
+    const transformation = new Transformation()
+      .videoEdit(VideoEdit.volume(mute())
+      );
+    expect(transformation.toJson()).toStrictEqual({
+      actions: [
+        {
+          actionType: 'volume',
+          volumeValue: {
+            mode: 'mute'
+          }
+        }
+      ]
+    });
+  });
+});

src/actions/videoEdit/TrimAction.ts

@@ -1,5 +1,7 @@
 import {Action} from "../../internal/Action.js";
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
+import {ITrimActionModel} from "../../internal/models/ITrimActionModel.js";
+import {IActionModel} from "../../internal/models/IActionModel.js";
 
 /**
  * @description Class for shortening a video to the specified range.
@@ -8,8 +10,13 @@ import {Qualifier} from "../../internal/qualifier/Qualifier.js";
  * @see Visit {@link Actions.VideoEdit|VideoEdit} for an example
  */
 class TrimAction extends Action {
+  protected _actionModel: ITrimActionModel;
+
   constructor() {
     super();
+    this._actionModel = {
+      actionType: 'trimVideo'
+    };
   }
 
   /**
@@ -32,6 +39,7 @@ class TrimAction extends Action {
    * @return {this}
    */
   startOffset(offset: string|number): this {
+    this._actionModel.startOffset = +offset;
     return this.addQualifier(new Qualifier('so', this.parseVal(offset)));
   }
 
@@ -44,6 +52,7 @@ class TrimAction extends Action {
    * @return {this}
    */
   endOffset(offset: string|number): this {
+    this._actionModel.endOffset = +offset;
     return this.addQualifier(new Qualifier('eo', this.parseVal(offset)));
   }
 
@@ -56,8 +65,29 @@ class TrimAction extends Action {
    * @return {this}
    */
   duration(duration: string|number): this {
+    this._actionModel.duration = duration;
     return this.addQualifier(new Qualifier('du', this.parseVal(duration)));
   }
+
+  static fromJson(actionModel: IActionModel): TrimAction {
+    const {duration, startOffset, endOffset} = (actionModel as ITrimActionModel);
+    // We are using this() to allow inheriting classes to use super.fromJson.apply(this, [actionModel])
+    // This allows the inheriting classes to determine the class to be created
+    const result = new this();
+    if (duration != null){
+      result.duration(duration);
+    }
+
+    if (startOffset != null){
+      result.startOffset(startOffset);
+    }
+
+    if (endOffset != null){
+      result.endOffset(endOffset);
+    }
+
+    return result;
+  }
 }
 
 export default TrimAction;

src/actions/videoEdit/VolumeAction.ts

@@ -1,6 +1,12 @@
 import {Action} from "../../internal/Action.js";
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
 import {QualifierValue} from "../../internal/qualifier/QualifierValue.js";
+import {IActionModel} from "../../internal/models/IActionModel.js";
+import {
+  IVolumeActionModel,
+  IVolumeByPercentModel,
+  IVolumeValueModel
+} from "../../internal/models/IVolumeActionModel.js";
 
 /**
  * @description Class to Controls the volume of an audio or video file.
@@ -9,11 +15,38 @@ import {QualifierValue} from "../../internal/qualifier/QualifierValue.js";
  * @see Visit {@link Actions.VideoEdit|VideoEdit} for an example
  */
 class VolumeAction extends Action {
+  protected _actionModel: IVolumeActionModel;
+
   constructor(volumeValue: string | number) {
     super();
+    let volumeValueModel: unknown = {mode: 'mute'};
+    if (volumeValue !== 'mute') {
+      volumeValueModel = {
+        mode: (`${volumeValue}`.endsWith('db') ? 'decibels' : 'percent'),
+        value: +(`${volumeValue}`.replace('db', ''))
+      };
+    }
+
+    this._actionModel = {
+      actionType: 'volume',
+      volumeValue: volumeValueModel as IVolumeValueModel
+    };
+
     const qualifierValue = new QualifierValue(['volume', volumeValue]).setDelimiter(':');
     this.addQualifier(new Qualifier('e', qualifierValue));
   }
+
+  static fromJson(actionModel: IActionModel): VolumeAction {
+    const {volumeValue} = (actionModel as IVolumeActionModel);
+    const {mode} = volumeValue;
+    const value = mode === 'mute' ? mode : (volumeValue as IVolumeByPercentModel).value;
+    const suffix = (mode === 'mute' || mode === "percent") ? '' : 'db';
+
+
+    // We are using this() to allow inheriting classes to use super.fromJson.apply(this, [actionModel])
+    // This allows the inheriting classes to determine the class to be created
+    return new this(`${value}${suffix}`);
+  }
 }
 
 export default VolumeAction;

src/internal/fromJson.ts

@@ -43,6 +43,8 @@ import {DeliveryDPRAction} from "../actions/delivery/DeliveryDPRAction.js";
 import ConcatenateAction from "../actions/videoEdit/ConcatenateAction.js";
 import {ITransformationModel} from "./models/ITransformationModel.js";
 import {PreviewAction} from "../actions/videoEdit/PreviewAction.js";
+import TrimAction from "../actions/videoEdit/TrimAction.js";
+import VolumeAction from "../actions/videoEdit/VolumeAction.js";
 
 const ActionModelMap: Record<string, IHasFromJson> = {
   scale: ResizeScaleAction,
@@ -95,7 +97,9 @@ const ActionModelMap: Record<string, IHasFromJson> = {
   brightness: EffectActionWithLevel,
   gamma: EffectActionWithLevel,
   concatenate: ConcatenateAction,
-  preview: PreviewAction
+  preview: PreviewAction,
+  trimVideo: TrimAction,
+  volume: VolumeAction
 };
 
 /**

src/internal/models/ITrimActionModel.ts

@@ -0,0 +1,7 @@
+import {IActionModel} from "./IActionModel.js";
+
+export interface ITrimActionModel extends IActionModel{
+  duration?: string | number;
+  startOffset?: number;
+  endOffset?: number;
+}

src/internal/models/IVolumeActionModel.ts

@@ -0,0 +1,21 @@
+import {IActionModel} from "./IActionModel.js";
+
+export interface IVolumeByDecibelsModel{
+  mode: 'decibels'
+  value: number;
+}
+
+export interface IVolumeByPercentModel{
+  mode: 'percent'
+  value: number;
+}
+
+export interface IVolumeMuteModel{
+  mode: 'mute'
+}
+
+export type IVolumeValueModel = IVolumeByDecibelsModel | IVolumeByPercentModel | IVolumeMuteModel;
+
+export interface IVolumeActionModel extends IActionModel{
+  volumeValue: IVolumeValueModel
+}