Merge pull request #213 from tv2/SOF-1420/sendSchemaDesignValuesToCas…

…parCG

feat: SOF-1420 send schema design values to CasparCG

src/tv2-common/__tests__/frame-time.spec.ts

@@ -197,7 +197,7 @@ describe('CreateTiming', () => {
 				enable: {
 					start: 0
 				},
-				lifespan: PieceLifespan.OutOnShowStyleEnd
+				lifespan: PieceLifespan.OutOnRundownChange
 			})
 		)
 	})

src/tv2-common/__tests__/gfx-schema-generator.spec.ts

@@ -0,0 +1,245 @@
+import { IShowStyleUserContext, TSR } from 'blueprints-integration'
+import { anyNumber, anything, instance, mock, verify, when } from 'ts-mockito'
+import {
+	CasparCgGfxDesignValues,
+	TableConfigGfxSchema,
+	TableConfigGfxSetup,
+	TableConfigItemGfxDefaults
+} from 'tv2-common'
+import { SharedGraphicLLayer } from 'tv2-constants'
+import { GfxSchemaGenerator } from '../cues/gfx-schema-generator'
+import { DveLoopGenerator } from '../helpers/graphics/caspar/dve-loop-generator'
+import { MockContextBuilder } from './mock-context-builder'
+
+// tslint:disable:no-object-literal-type-assertion
+describe('GfxSchemaGenerator', () => {
+	describe('createTimelineObjectsFromGfxDefaults', () => {
+		it('has no schema configured - notifies about error', () => {
+			const context = new MockContextBuilder()
+				.setGfxDefaults({
+					DefaultSchema: { label: 'someSchema' }
+				} as TableConfigItemGfxDefaults)
+				.build()
+
+			const core = mock<IShowStyleUserContext>()
+			when(context.core).thenReturn(instance(core))
+
+			const testee = createTestee()
+
+			const result = testee.createBaselineTimelineObjectsFromGfxDefaults(instance(context))
+			expect(result).toBeTruthy()
+
+			verify(core.notifyUserError(anything())).once()
+		})
+
+		function createTestee(dveLoopGenerator?: DveLoopGenerator) {
+			if (!dveLoopGenerator) {
+				dveLoopGenerator = mock(DveLoopGenerator)
+				when(dveLoopGenerator.createCasparCgDveLoopsFromCue(anything(), anything(), anyNumber())).thenReturn([])
+			}
+			return new GfxSchemaGenerator(instance(dveLoopGenerator))
+		}
+
+		it('has schema configured, but no match from default schema - notifies about error', () => {
+			const context = new MockContextBuilder()
+				.setGfxDefaults({
+					DefaultSchema: { value: 'someSchema' }
+				} as TableConfigItemGfxDefaults)
+				.setGfxSchemaTemplates([
+					{
+						GfxSchemaTemplatesName: 'someOtherSchema'
+					}
+				] as TableConfigGfxSchema[])
+				.build()
+
+			const core = mock<IShowStyleUserContext>()
+			when(context.core).thenReturn(instance(core))
+
+			const testee = createTestee()
+			const result = testee.createBaselineTimelineObjectsFromGfxDefaults(instance(context))
+			expect(result).toBeTruthy()
+
+			verify(core.notifyUserError(anything())).once()
+		})
+
+		it('has correctly configured schema - does not notify about error', () => {
+			const schemaId = 'someSchemaId'
+			const context = new MockContextBuilder()
+				.setGfxDefaults({
+					DefaultSchema: { value: schemaId }
+				} as TableConfigItemGfxDefaults)
+				.setGfxSchemaTemplates([
+					{
+						_id: schemaId,
+						GfxSchemaTemplatesName: 'SomeSchema',
+						CasparCgDesignValues: '[{}]'
+					}
+				] as TableConfigGfxSchema[])
+				.build()
+
+			const core = mock<IShowStyleUserContext>()
+			when(context.core).thenReturn(instance(core))
+
+			const testee = createTestee()
+			const result = testee.createBaselineTimelineObjectsFromGfxDefaults(instance(context))
+			expect(result).toBeTruthy()
+
+			verify(core.notifyUserError(anything())).never()
+		})
+
+		describe('graphicsType is "VIZ"', () => {
+			it('creates Viz timelineObject', () => {
+				const schemaName = 'someSchema'
+				const vizTemplateName = 'someVizTemplate'
+				const ovlShowName = 'someOvlName'
+				const context = new MockContextBuilder()
+					.setGraphicsType('VIZ')
+					.setGfxDefaults({
+						DefaultSchema: { label: schemaName }
+					} as TableConfigItemGfxDefaults)
+					.setGfxSchemaTemplates([
+						{
+							GfxSchemaTemplatesName: schemaName,
+							CasparCgDesignValues: '[{}]',
+							VizTemplate: vizTemplateName
+						}
+					] as TableConfigGfxSchema[])
+					.setSelectedGfxSetup({
+						OvlShowName: ovlShowName
+					} as TableConfigGfxSetup)
+					.build()
+				const testee = createTestee()
+
+				const result = testee.createBaselineTimelineObjectsFromGfxDefaults(instance(context))
+				const schemaTimelineObject = result.find(
+					(timelineObject) => timelineObject.layer === SharedGraphicLLayer.GraphicLLayerSchema
+				)
+				expect(schemaTimelineObject).toBeTruthy()
+				const vizSchema = schemaTimelineObject as TSR.TimelineObjVIZMSEElementInternal
+				expect(vizSchema.classes).toContain(vizTemplateName)
+				expect(vizSchema.content.deviceType).toBe(TSR.DeviceType.VIZMSE)
+				expect(vizSchema.content.type).toBe(TSR.TimelineContentTypeVizMSE.ELEMENT_INTERNAL)
+				expect(vizSchema.content.templateName).toBe(vizTemplateName)
+				expect(vizSchema.content.showName).toBe(ovlShowName)
+			})
+
+			it('creates casparCg dve loop timelineObjects', () => {
+				const schemaName = 'someSchema'
+				const context = new MockContextBuilder()
+					.setGraphicsType('VIZ')
+					.setGfxDefaults({
+						DefaultSchema: { label: schemaName }
+					} as TableConfigItemGfxDefaults)
+					.setGfxSchemaTemplates([
+						{
+							GfxSchemaTemplatesName: schemaName,
+							CasparCgDesignValues: '[{}]'
+						}
+					] as TableConfigGfxSchema[])
+					.build()
+
+				const casparCgDveLoopTimelineObjects: TSR.TimelineObjCCGMedia[] = [
+					{
+						id: 'id1'
+					},
+					{
+						id: 'id2'
+					}
+				] as TSR.TimelineObjCCGMedia[]
+
+				const dveLoopGenerator = mock(DveLoopGenerator)
+				when(dveLoopGenerator.createCasparCgDveLoopsFromCue(anything(), anything(), anyNumber())).thenReturn(
+					casparCgDveLoopTimelineObjects
+				)
+
+				const testee = createTestee(dveLoopGenerator)
+				const result = testee.createBaselineTimelineObjectsFromGfxDefaults(instance(context))
+
+				verify(dveLoopGenerator.createCasparCgDveLoopsFromCue(anything(), anything(), anyNumber())).called()
+				expect(result.includes(casparCgDveLoopTimelineObjects[0])).toBeTruthy()
+				expect(result.includes(casparCgDveLoopTimelineObjects[1])).toBeTruthy()
+			})
+		})
+
+		describe('graphicsType is "HTML"', () => {
+			it('creates CasparCG timelineObject', () => {
+				const schemaName = 'someSchema'
+				const vizTemplateName = 'someVizTemplate'
+				const casparCgDesignValues: CasparCgGfxDesignValues[] = [
+					{
+						name: 'designName',
+						backgroundLoop: 'someBackgroundLoop',
+						properties: {
+							attribute1: 'value1',
+							attribute2: 'value2',
+							attribute3: 'value3'
+						}
+					}
+				]
+				const context = new MockContextBuilder()
+					.setGraphicsType('HTML')
+					.setGfxDefaults({
+						DefaultSchema: { label: schemaName }
+					} as TableConfigItemGfxDefaults)
+					.setGfxSchemaTemplates([
+						{
+							GfxSchemaTemplatesName: schemaName,
+							CasparCgDesignValues: JSON.stringify(casparCgDesignValues),
+							VizTemplate: vizTemplateName
+						}
+					] as TableConfigGfxSchema[])
+					.build()
+				const testee = createTestee()
+
+				const result = testee.createBaselineTimelineObjectsFromGfxDefaults(instance(context))
+				const schemaTimelineObject = result.find(
+					(timelineObject) => timelineObject.layer === SharedGraphicLLayer.GraphicLLayerSchema
+				)
+				expect(schemaTimelineObject).toBeTruthy()
+				const casparCgSchema = schemaTimelineObject as TSR.TimelineObjCCGTemplate
+				expect(casparCgSchema.classes).toContain(vizTemplateName)
+				expect(casparCgSchema.content.deviceType).toBe(TSR.DeviceType.CASPARCG)
+				expect(casparCgSchema.content.type).toBe(TSR.TimelineContentTypeCasparCg.TEMPLATE)
+				expect(casparCgSchema.content.templateType).toBe('html')
+				expect(casparCgSchema.content.data.designs).toStrictEqual(casparCgDesignValues)
+			})
+
+			it('creates casparCg dve loop timelineObjects', () => {
+				const schemaName = 'someSchema'
+				const context = new MockContextBuilder()
+					.setGraphicsType('HTML')
+					.setGfxDefaults({
+						DefaultSchema: { label: schemaName }
+					} as TableConfigItemGfxDefaults)
+					.setGfxSchemaTemplates([
+						{
+							GfxSchemaTemplatesName: schemaName,
+							CasparCgDesignValues: '[{}]'
+						}
+					] as TableConfigGfxSchema[])
+					.build()
+
+				const casparCgDveLoopTimelineObjects: TSR.TimelineObjCCGMedia[] = [
+					{
+						id: 'id1'
+					},
+					{
+						id: 'id2'
+					}
+				] as TSR.TimelineObjCCGMedia[]
+
+				const dveLoopGenerator = mock(DveLoopGenerator)
+				when(dveLoopGenerator.createCasparCgDveLoopsFromCue(anything(), anything(), anyNumber())).thenReturn(
+					casparCgDveLoopTimelineObjects
+				)
+
+				const testee = createTestee(dveLoopGenerator)
+				const result = testee.createBaselineTimelineObjectsFromGfxDefaults(instance(context))
+
+				verify(dveLoopGenerator.createCasparCgDveLoopsFromCue(anything(), anything(), anyNumber())).called()
+				expect(result.includes(casparCgDveLoopTimelineObjects[0])).toBeTruthy()
+				expect(result.includes(casparCgDveLoopTimelineObjects[1])).toBeTruthy()
+			})
+		})
+	})
+})

src/tv2-common/__tests__/mock-context-builder.ts

@@ -0,0 +1,62 @@
+import { mock, when } from 'ts-mockito'
+import {
+	ShowStyleContext,
+	TableConfigGfxSchema,
+	TableConfigGfxSetup,
+	TableConfigItemGfxDefaults,
+	TV2ShowStyleConfig
+} from 'tv2-common'
+
+// tslint:disable:no-object-literal-type-assertion
+/**
+ * A builder class to create mocks for ShowStyleContext.
+ * To make this useful to as many as possible all defaults should be empty or as close to empty as possible.
+ * Feel free to add more setters methods as needed.
+ */
+export class MockContextBuilder {
+	private gfxDefaults: TableConfigItemGfxDefaults[] = []
+	private gfxSchemaTemplates: TableConfigGfxSchema[] = []
+	private selectedGfxSetup: TableConfigGfxSetup = {
+		_id: '',
+		Name: '',
+		HtmlPackageFolder: ''
+	}
+	private graphicsType: 'HTML' | 'VIZ' = 'HTML'
+
+	public build(): ShowStyleContext {
+		const context = mock<ShowStyleContext>()
+
+		when(context.config).thenReturn({
+			showStyle: {
+				GfxDefaults: this.gfxDefaults,
+				GfxSchemaTemplates: this.gfxSchemaTemplates
+			},
+			studio: {
+				GraphicsType: this.graphicsType
+			},
+			selectedGfxSetup: this.selectedGfxSetup
+		} as TV2ShowStyleConfig)
+
+		return context
+	}
+
+	public setGfxDefaults(gfxDefault: TableConfigItemGfxDefaults): MockContextBuilder {
+		this.gfxDefaults = [gfxDefault]
+		return this
+	}
+
+	public setGfxSchemaTemplates(gfxSchemaTemplates: TableConfigGfxSchema[]): MockContextBuilder {
+		this.gfxSchemaTemplates = gfxSchemaTemplates
+		return this
+	}
+
+	public setSelectedGfxSetup(selectedGfxSetup: TableConfigGfxSetup): MockContextBuilder {
+		this.selectedGfxSetup = selectedGfxSetup
+		return this
+	}
+
+	public setGraphicsType(graphicsType: 'HTML' | 'VIZ'): MockContextBuilder {
+		this.graphicsType = graphicsType
+		return this
+	}
+}

src/tv2-common/blueprintConfig.ts

@@ -31,9 +31,10 @@ export interface TableConfigItemGfxTemplate {
 }
 
 export interface TableConfigItemGfxDesignTemplate {
+	_id: string
 	INewsName: string
 	INewsStyleColumn: string
-	/** Name of the Viz template trigering design change. For HTML graphics it coresponds to a CSS class. */
+	/** Name of the Viz template triggering design change. For HTML graphics it corresponds to a CSS class. */
 	VizTemplate: string
 }
 
@@ -45,18 +46,20 @@ export interface TableConfigItemGfxShowMapping {
 
 export interface TableConfigItemGfxDefaults {
 	DefaultSetupName: { value: string; label: string }
-	DefaultSchema: string
-	DefaultDesign: string
+	DefaultSchema: { value: string; label: string }
+	DefaultDesign: { value: string; label: string }
 }
 
 export interface TableConfigItemAdLibTransitions {
 	Transition: string
 }
 
 export interface TableConfigGfxSchema {
+	_id: string
 	GfxSchemaTemplatesName: string
 	INewsSkemaColumn: string
 	VizTemplate: string
+	CasparCgDesignValues: string
 }
 
 export interface TableConfigGfxSetup {
@@ -67,6 +70,12 @@ export interface TableConfigGfxSetup {
 	FullShowName?: string
 }
 
+export interface CasparCgGfxDesignValues {
+	name: string
+	properties: Record<string, string>
+	backgroundLoop: string
+}
+
 export interface ProcessedStudioConfig {
 	sources: SourceMapping
 	mediaPlayers: MediaPlayerConfig // Atem Input Ids
@@ -180,6 +189,7 @@ export interface TV2ShowstyleBlueprintConfigBase {
 	LYDConfig: TableConfigItemValue
 	GfxSchemaTemplates: TableConfigGfxSchema[]
 	GfxSetups: TableConfigGfxSetup[]
+	GfxShowMapping: TableConfigItemGfxShowMapping[]
 	GfxDefaults: TableConfigItemGfxDefaults[]
 }
 

src/tv2-common/cueTiming.ts

@@ -48,7 +48,7 @@ export function getLifeSpan(mode: 'B' | 'S' | 'O'): PieceLifespan {
 		case 'S':
 			return PieceLifespan.OutOnSegmentEnd
 		case 'O':
-			return PieceLifespan.OutOnShowStyleEnd
+			return PieceLifespan.OutOnRundownChange
 	}
 }
 

src/tv2-common/cues/gfx-schema-generator-facade.ts

@@ -0,0 +1,8 @@
+import { DveLoopGenerator } from '../helpers/graphics/caspar/dve-loop-generator'
+import { GfxSchemaGenerator } from './gfx-schema-generator'
+
+export abstract class GfxSchemaGeneratorFacade {
+	public static create(): GfxSchemaGenerator {
+		return new GfxSchemaGenerator(new DveLoopGenerator())
+	}
+}