Add videoCodec to/fromJson (#521)

strausr · web-flow · commit 5f78e218a409 · 2022-03-03T17:04:52.000+02:00
diff --git a/__TESTS_BUNDLE_SIZE__/bundleSizeTestCases.ts b/__TESTS_BUNDLE_SIZE__/bundleSizeTestCases.ts
@@ -74,7 +74,7 @@ const bundleSizeTestCases:ITestCase[] = [
   },
   {
     name: 'Import all of the SDK',
-    sizeLimitInKB: 126,
+    sizeLimitInKB: 127,
     importsArray: [
       importFromPackage('* as CloudinaryURLGEN')
     ]
@@ -88,7 +88,7 @@ const bundleSizeTestCases:ITestCase[] = [
   },
   {
     name: 'Import All Actions',
-    sizeLimitInKB: 53,
+    sizeLimitInKB: 54,
     importsArray: [
       importFromPackage('Actions')
     ]
diff --git a/__TESTS__/unit/fromJson/transcode.fromJson.test.ts b/__TESTS__/unit/fromJson/transcode.fromJson.test.ts
@@ -12,7 +12,9 @@ describe('transcode.fromJson', () => {
       {actionType: 'audioCodec', audioCodec: 'aac'},
       {actionType: 'audioFrequency', audioFrequencyType: 'freq8000'},
       {actionType: 'streamingProfile', profile: 'fullHd'},
-      {actionType: 'toAnimated', animatedFormat: 'gif', delay: 20, sampling: '4s'}
+      {actionType: 'toAnimated', animatedFormat: 'gif', delay: 20, sampling: '4s'},
+      {actionType: 'videoCodec', videoCodec: {videoCodecName: 'auto'}},
+      {actionType: 'videoCodec', videoCodec: {videoCodecName: 'h264', profile: 'baseline', level: 3.1}}
     ]});
 
     expect(transformation.toString()).toStrictEqual([
@@ -25,7 +27,9 @@ describe('transcode.fromJson', () => {
       'ac_aac',
       'af_8000',
       'sp_full_hd',
-      'dl_20,f_gif,fl_animated,vs_4s'
+      'dl_20,f_gif,fl_animated,vs_4s',
+      'vc_auto',
+      'vc_h264:baseline:3.1'
     ].join('/'));
   });
 });
diff --git a/__TESTS__/unit/toJson/transcode.toJson.test.ts b/__TESTS__/unit/toJson/transcode.toJson.test.ts
@@ -3,6 +3,9 @@ import {Transcode} from "../../../src/actions/transcode";
 import {AudioCodec} from "../../../src/qualifiers/audioCodec";
 import {AudioFrequency} from "../../../src/qualifiers/audioFrequency";
 import {AnimatedFormat} from "../../../src/qualifiers/animatedFormat";
+import {VideoCodec} from "../../../src/qualifiers/videoCodec";
+import {VideoCodecProfile} from "../../../src/qualifiers/videoCodecProfile";
+import {VideoCodecLevel} from "../../../src/qualifiers/videoCodecLevel";
 
 describe('Transcode toJson()', () => {
   it('transcode.keyframeInterval number', () => {
@@ -140,4 +143,44 @@ describe('Transcode toJson()', () => {
       ]
     });
   });
+
+  it('transcode.videoCodec', () => {
+    const transformation = new Transformation()
+      .addAction(Transcode.videoCodec(
+        VideoCodec.h264()
+      ));
+
+    expect(transformation.toJson()).toStrictEqual({
+      actions: [
+        {
+          actionType: 'videoCodec',
+          videoCodec: {
+            videoCodecName: 'h264'
+          }
+        }
+      ]
+    });
+  });
+
+  it('transcode.videoCodec advanced', () => {
+    const transformation = new Transformation()
+      .addAction(Transcode.videoCodec(
+        VideoCodec.h264()
+          .profile(VideoCodecProfile.baseline())
+          .level(VideoCodecLevel.vcl31())
+      ));
+
+    expect(transformation.toJson()).toStrictEqual({
+      actions: [
+        {
+          actionType: 'videoCodec',
+          videoCodec: {
+            videoCodecName: 'h264',
+            profile: 'baseline',
+            level:  3.1
+          }
+        }
+      ]
+    });
+  });
 });
diff --git a/src/actions/transcode/VideoCodecAction.ts b/src/actions/transcode/VideoCodecAction.ts
@@ -1,5 +1,8 @@
 import {Action} from "../../internal/Action.js";
 import {AdvVideoCodecType, VideoCodecType} from "../../qualifiers/videoCodecType/VideoCodecType.js";
+import {IVideoCodecActionModel} from "../../internal/models/ITranscodeActionModel.js";
+import {IActionModel} from "../../internal/models/IActionModel.js";
+import {VIDEO_CODEC_TO_TRANSFORMATION} from "../../qualifiers/videoCodec.js";
 
 /**
  * @extends SDK.Action
@@ -8,9 +11,37 @@ import {AdvVideoCodecType, VideoCodecType} from "../../qualifiers/videoCodecType
  * @see Visit {@link Actions.Transcode|Transcode} for an example
  */
 class VideoCodecAction extends Action {
+  protected _actionModel : IVideoCodecActionModel = {actionType: 'videoCodec'};
   constructor(videoCodecTypeQualifier : VideoCodecType | AdvVideoCodecType) {
     super();
+    this._actionModel.videoCodec = {videoCodecName: videoCodecTypeQualifier.getType()};
+
+    if(videoCodecTypeQualifier instanceof AdvVideoCodecType) {
+      if(videoCodecTypeQualifier.getProfile()) {
+        this._actionModel.videoCodec = {profile: videoCodecTypeQualifier.getProfile(), ...this._actionModel.videoCodec};
+      }
+
+      if(videoCodecTypeQualifier.getLevel()){
+        this._actionModel.videoCodec = {level: videoCodecTypeQualifier.getLevel(), ...this._actionModel.videoCodec};
+      }
+    }
+
     this.addQualifier(videoCodecTypeQualifier);
   }
+
+  static fromJson(actionModel: IActionModel): VideoCodecAction {
+    const {videoCodec} = (actionModel as IVideoCodecActionModel);
+
+    // 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(VIDEO_CODEC_TO_TRANSFORMATION[videoCodec.videoCodecName]);
+    //@ts-ignore
+    videoCodec.profile && new this(VIDEO_CODEC_TO_TRANSFORMATION[videoCodec.videoCodecName].profile(videoCodec.profile));
+
+    //@ts-ignore
+    videoCodec.level && new this(VIDEO_CODEC_TO_TRANSFORMATION[videoCodec.videoCodecName].level(videoCodec.level));
+
+    return result;
+  }
 }
 export {VideoCodecAction};
diff --git a/src/assets/CloudinaryMedia.ts b/src/assets/CloudinaryMedia.ts
@@ -1,11 +1,11 @@
 import {CloudinaryTransformable} from "./CloudinaryTransformable.js";
-import {Action} from "../internal/Action.js";
 import {videoEditType} from "../actions/videoEdit.js";
 import {LayerAction} from "../actions/layer/LayerAction.js";
 import {Transformation} from "../transformation/Transformation.js";
 import ICloudConfig from "../config/interfaces/Config/ICloudConfig.js";
 import IURLConfig from "../config/interfaces/Config/IURLConfig.js";
 import { cloneDeep } from '../internal/utils/cloneDeep.js';
+import {ITranscodeAction} from "../actions/transcode.js";
 
 
 /**
@@ -24,7 +24,7 @@ class CloudinaryMedia extends CloudinaryTransformable {
    * @param {Actions.Transcode} action
    * @return {this}
    */
-  transcode(action: Action): this {
+  transcode(action: ITranscodeAction): this {
     this.transformation.transcode(action);
     return this;
   }
diff --git a/src/assets/CloudinaryVideo.ts b/src/assets/CloudinaryVideo.ts
@@ -1,9 +1,9 @@
 import IURLConfig from "../config/interfaces/Config/IURLConfig.js";
-import {Action} from "../internal/Action.js";
 import {CloudinaryTransformable} from "./CloudinaryTransformable.js";
 import ICloudConfig from "../config/interfaces/Config/ICloudConfig.js";
 import {videoEditType} from "../actions/videoEdit.js";
 import {VideoTransformation} from "../transformation/VideoTransformation.js";
+import {ITranscodeAction} from "../actions/transcode.js";
 
 
 /**
@@ -23,7 +23,7 @@ class CloudinaryVideo extends CloudinaryTransformable {
    * @param {Actions.Transcode} action
    * @return {this}
    */
-  transcode(action: Action): this {
+  transcode(action: ITranscodeAction): this {
     this.transformation.transcode(action);
     return this;
   }
diff --git a/src/internal/fromJson.ts b/src/internal/fromJson.ts
@@ -55,6 +55,7 @@ import StreamingProfileAction from "../actions/transcode/StreamingProfile.js";
 import ToAnimatedAction from "../actions/transcode/ToAnimatedAction.js";
 import {FadeInEffectAction} from "../actions/effect/leveled/FadeIn.js";
 import {FadeOutEffectAction} from "../actions/effect/leveled/FadeOut.js";
+import {VideoCodecAction} from "../actions/transcode/VideoCodecAction.js";
 
 const ActionModelMap: Record<string, IHasFromJson> = {
   scale: ResizeScaleAction,
@@ -120,7 +121,8 @@ const ActionModelMap: Record<string, IHasFromJson> = {
   streamingProfile: StreamingProfileAction,
   toAnimated: ToAnimatedAction,
   fadeIn: FadeInEffectAction,
-  fadeOut: FadeOutEffectAction
+  fadeOut: FadeOutEffectAction,
+  videoCodec: VideoCodecAction
 };
 
 /**
diff --git a/src/internal/models/ITranscodeActionModel.ts b/src/internal/models/ITranscodeActionModel.ts
@@ -35,6 +35,10 @@ interface IToAnimatedActionModel extends IActionModel{
   delay?: number;
 }
 
+interface IVideoCodecActionModel extends IActionModel{
+  videoCodec?: {videoCodecName?: string; profile?: string; level?: string | number}
+}
+
 export {
   IKeyframeIntervalsActionModel,
   IFPSActionModel,
@@ -43,5 +47,6 @@ export {
   IAudioCodecActionModel,
   IAudioFrequencyActionModel,
   IStreamingProfileActionModel,
-  IToAnimatedActionModel
+  IToAnimatedActionModel,
+  IVideoCodecActionModel
 };
diff --git a/src/qualifiers/videoCodec.ts b/src/qualifiers/videoCodec.ts
@@ -77,5 +77,15 @@ function vp9():VideoCodecType {
   return new VideoCodecType('vp9');
 }
 
+export const VIDEO_CODEC_TO_TRANSFORMATION: Record<string, VideoCodecType | AdvVideoCodecType> = {
+  'auto': auto(),
+  'h264': h264(),
+  'h265': h265(),
+  'prores': proRes(),
+  'theora': theora(),
+  'vp8': vp8(),
+  'vp9': vp9()
+};
+
 const VideoCodec = { auto, h264, h265, proRes, theora, vp8, vp9};
 export {VideoCodec, auto, h264, h265, proRes, theora, vp8, vp9};
diff --git a/src/qualifiers/videoCodecType/VideoCodecType.ts b/src/qualifiers/videoCodecType/VideoCodecType.ts
@@ -6,10 +6,16 @@ import {Qualifier} from "../../internal/qualifier/Qualifier.js";
  * @memberOf Qualifiers.VideoCodec
  */
 class VideoCodecType extends Qualifier {
+  private _type: string;
   constructor(type: string) {
     super('vc');
+    this._type = type;
     this.addValue(type);
   }
+
+  getType(): string {
+    return this._type;
+  }
 }
 
 /**
@@ -26,6 +32,10 @@ class AdvVideoCodecType extends Qualifier{
     this._type = type;
   }
 
+  getType(): string{
+    return this._type;
+  }
+
   /**
    * @description Specifies the profile to use with the h264 codec.
    * @param {Qualifiers.VideoCodecProfile | string} profile Sets the profile of the video codec
@@ -37,6 +47,10 @@ class AdvVideoCodecType extends Qualifier{
     return this;
   }
 
+  getProfile(): string {
+    return this._prof;
+  }
+
   /**
    * @description Specifies the level to use with the h264 codec and specified profile.
    * @param {Qualifiers.VideoCodecLevel | number | string} lvl
@@ -48,6 +62,10 @@ class AdvVideoCodecType extends Qualifier{
     return this;
   }
 
+  getLevel(): number | string {
+    return this._lvl;
+  }
+
   /**
    * @description returns a toString representation of this qualifier
    * @return string;

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ const bundleSizeTestCases:ITestCase[] = [`
`74`	`74`	`},`
`75`	`75`	`{`
`76`	`76`	`name: 'Import all of the SDK',`
`77`		`- sizeLimitInKB: 126,`
	`77`	`+ sizeLimitInKB: 127,`
`78`	`78`	`importsArray: [`
`79`	`79`	`importFromPackage('* as CloudinaryURLGEN')`
`80`	`80`	`]`
`@@ -88,7 +88,7 @@ const bundleSizeTestCases:ITestCase[] = [`
`88`	`88`	`},`
`89`	`89`	`{`
`90`	`90`	`name: 'Import All Actions',`
`91`		`- sizeLimitInKB: 53,`
	`91`	`+ sizeLimitInKB: 54,`
`92`	`92`	`importsArray: [`
`93`	`93`	`importFromPackage('Actions')`
`94`	`94`	`]`