refreshwww.fff138.com

SwitcherProductsProtocolsManualSoftwareVersion071806308JUNE2011CERTIFICATECertificateNumber:510040.
001TheQualitySystemof:GrassValleyUSA,LLCanditsGrassValleyAffiliatesHeadquarters:400ProvidenceMineRoadNevadaCity,CA95945UnitedStates15655SWGreystoneCt.
Beaverton,OR97006UnitedStatesBrunnenweg9D-64331WeiterstadtGermanyKapittelweg104827HGBredaTheNederlands2300So.
DeckerLakeBlvd.
SaltLakeCity,UT84119UnitedStatesIncludingitsimplementation,meetstherequirementsofthestandard:ISO9001:2008Scope:Thedesign,manufactureandsupportofvideoandaudiohardwareandsoftwareproductsandrelatedsystems.
ThisCertificateisvaliduntil:June14,2012ThisCertificateisvalidasof:December23,2010Certifiedforthefirsttime:June14,2000H.
PierreSalléPresidentKEMA-RegisteredQualityThemethodofoperationforqualitycertificationisdefinedintheKEMAGeneralTermsAndConditionsForQualityAndEnvironmentalManagementSystemsCertifications.
Integralpublicationofthiscertificateisallowed.
KEMA-RegisteredQuality,Inc.
4377CountyLineRoadChalfont,PA18914Ph:(215)997-4519Fax:(215)997-3809CRT001042108AccreditedBy:ANABSwitcherProductsProtocolsManualSoftwareVersion071806308JUNE20114SwitcherProducts—ProtocolsManualContactingGrassValleyCopyrightGrassValleyUSA,LLC.
Allrightsreserved.
ThisproductmaybecoveredbyoneormoreU.
S.
andforeignpatents.
GrassValleyWebSiteThewww.
grassvalley.
comwebsiteoffersthefollowing:OnlineUserDocumentation—Currentversionsofproductcatalogs,brochures,datasheets,orderingguides,planningguides,manuals,andreleasenotesin.
pdfformatcanbedownloaded.
FAQDatabase—SolutionstoproblemsandtroubleshootingeffortscanbefoundbysearchingourFrequentlyAskedQuestions(FAQ)database.
SoftwareDownloads—Downloadsoftwareupdates,drivers,andpatches.
InternationalSupportCentersFrance24x7+80080802020or+33148252020UnitedStates/Canada24x7+18005478949or+15304784148LocalSupportCenters(availableduringnormalbusinesshours)AsiaHongKong,Taiwan,Korea,Macau:+85225313058IndianSubcontinent:+912224933476SoutheastAsia/Malaysia:+60378053884SoutheastAsia/Singapore:+6563791313China:+8610660159450Japan:+81354846868AustraliaandNewZealand:+611300721495Central/SouthAmerica:+551155093443MiddleEast:+97142996440NearEastandAfrica:+80080802020or+33148252020EuropeBelarus,Russia,Tadzikistan,Ukraine,Uzbekistan:+70952580924225Switzerland:+4114878002S.
Europe/Italy-Roma:+390687203528-Milan:+390248414658S.
Europe/Spain:+34915120350Benelux/Belgium:+32(0)23349030Benelux/Netherlands:+31(0)356238421N.
Europe:+4545968870Germany,Austria,EasternEurope:+496150104444UK,Ireland,Israel:+441189230499SwitcherProducts—ProtocolsManual5ContentsContentsSection1—TallyProtocol.
9Introduction9KalypsoSystemOverview9ZodiakSystemOverview.
9KayenneSystemOverview10TallyBackgroundInformation10TallyTypes11OutputTally11On-airTally.
11Look-aheadTally11IsoTally12SelectionTally.
12TallyCalculationBasics12KeyerModifications12TransitionMixerModifications.
13InternalandExternalProcessingLoops.
13TallySystem.
13Names14TallyRelayOutputs14SerialTally15ChangingTallyPortSerialSettings15Kalypso&ZodiakContributionTallyProtocol16SourceIDs.
17MEContributionInformation18ExternalProcessingContributionInformation.
19StillStoreContributionInformation.
20OutputContributionInformation.
21KalypsoSystems21ZodiakSystems22SourceNames.
23Update.
25CommandCodesandInstanceSummary25MessageStructure26CommunicationSpecifics.
26MessageParsingandProcessing.
28KayenneContributionTallyProtocol30MessageStructureandSummary30SourceIDs.
31MEContributionInformation32eDPMContributionInformation.
35ImageStoreContributionInformation.
36OutputStatus36SourceNames.
37Update.
38MessageParsingandProcessing.
39Section2—EditorProtocol.
41Kalypso/ZodiakEditorProtocol416SwitcherProducts—ProtocolsManualContentsIntroduction.
41SerialDataWordDescription41EditorProtocolAccess42BreakCharacter.
42AddressByte44Command/MessageBlockStructure.
44ByteCount45EffectsAddressByte.
45CommandCodeByte45StatusReplies.
46ErrorDetection46EditorCommands47Introduction.
47CommandUsage48ApplicationExamples48SourceBus(C1–C4)Commands.
50KalypsoEffectsAddresses.
51ZodiakEffectsAddresses.
52KalypsoSourceNumbers53ZodiakSourceNumbers54SourceSelect(C0)Command55KalypsoEffectsAddresses.
55ZodiakEffectsAddresses.
57PreviewBus(E2)Command57SourceNumbers57SplitKey(E4,E5,E6,E7,E9andEA)Commands58KalypsoEffectsAddresses.
58ZodiakEffectsAddresses.
58SourceNumbers59PushbuttonSelectandControl(C6,C7andFB)Commands.
59KalypsoEffectsAddresses.
60ZodiakEffectsAddresses.
60KalypsoPushbuttonNumbers61ZodiakPushbuttonNumbers62WipePattern(C8)Command63KalypsoEffectsAddresses.
63ZodiakEffectsAddresses.
63WipeNumbers.
64TransitionMode(CA)Command65KalypsoEffectsAddresses.
65ZodiakEffectsAddresses.
65ModeByte—M/E66ModeByte—DSK(ZodiakOnly)66AutoandKeyTransitionRate(CCandCD)Commands.
67KalypsoEffectsAddresses.
68ZodiakEffectsAddresses.
68TransitionRate.
68LearnandRecallE-MEMRegister(DAandDB)Commands71KalypsoEffectsAddresses.
72ZodiakEffectsAddresses.
73LearnModeByte73RecallModeByte.
74Registers754000Bit-MaskFormat.
75SwitcherProducts—ProtocolsManual7ContentsKalypsoBit-MaskFormat76ZodiakBit-MaskFormat.
77SaveandLoadData(5FandDF)Commands.
78EffectsAddresses78RegNumber78Name78SaveandLoadStatus(6DandED)Commands82EffectsAddresses82StatusMessage82TimelineControl(4E,4F,CE,andCF)Commands83KalypsoEffectsAddresses834000Bit-MaskFormat84KalypsoBit-MaskFormat84ZodiakBit-MaskFormat.
85DataFieldFormat86AllStop(F2)Command88KalypsoEffectsAddresses88ZodiakEffectsAddresses89SoftwareVersion(6CandEC)Commands90EffectsAddress.
90ModelNumber.
90VersionNumber.
90SwitcherModelFeatures91Section3—PeripheralBusIIProtocol93Introduction93Overview93SystemDescription93E-MEMSystemInteraction(Learns,Recalls)94TriggerInteractions.
95CommandTimingandFrameAccuracy96ProtocolDescription96HardwareInterface96CommandStructure97ControlledDeviceIdentification98Commands99LearnCommand99RecallCommand100TriggerCommand.
101QueryCommand.
102QueryResponse102ReadCommand103WriteCommand104WriteResponse.
104Section4—DPMCPLProtocol.
105Introduction105GeneralBackgroundaboutSwitcher/DPMIntegration.
105SwitcherConfiguration106GeneralProtocolNotes106MessageTiming.
107Init/Online.
1088SwitcherProducts—ProtocolsManualContentsSourceSelection109Near/FarandFront/Back.
109SourceHold110Tally110ActivityCheck111RunningEffects.
112Subscription.
112MessageFormat113MessageTokens114Set115Subscribe115ParameterService116Unsubscribe116Issue117ParameterArticle118SendEvent119ReturnCode.
120Parameters.
121OtherCommandSpecifics122TransmissionMediaandProtocols123Examples124Section5—RouterProtocol129Introduction.
129NativeProtocol129Commands130Section6—StillStoreImageFileFormat.
131Introduction.
131StillStoreHardware131ImageStorageMechanism131MetadataFileFormatVersionsandKalypsoSoftwareReleases.
133VideoConversion133ShapedVideo134SDImageDataFileFormat.
136SDFullSizeFileFormat/SizeCalculations137SDFencedImageFileSizeCalculations138HDImageDataFileFormat139HDFullSizeFileFormat/SizeCalculations.
140HDFencedImageFileSizeCalculations.
141ImageMetadataFileFormat.
141LineRate.
142StillStoreOutputControl143OutputCropandPosition144OutputFreezeMode.
144MarkIn/Out145Loops.
145KeyOffset.
145Index.
147SwitcherProducts—ProtocolsManual9Section1TallyProtocolIntroductionThissectiondescribesthetallymechanismsavailableontheKalypsoandKayenneVideoProductionCenterandtheZodiakDigitalProductionSwitchersystems.
Thesesystems(genericallycalled"switcher")areeachequippedwithaclassictallyrelaysystem,butalsohaveaserialtallyinter-facetoprovidemorein-depthstatusthansimpleon/offairinformation.
Technicaldetailsoftheserialtallyprotocolusedtoreporttallyinformationarepresentedlaterinthissection.
KalypsoSystemOverviewAKalypsosystemprovides64tallyrelaysthatcloseinresponsetotallysta-tuses,andanadditional64relaysmaybeaddedasanoption.
Thetallyserialportalsooutputscurrentsystemtallyinformation.
Kalypsosystemsareavailablein4-MEand2-MEmodels.
TheMEsareidenticaltooneanother,withoneactingasaPGMPSTbank.
EachMEhasfourkeyers,twobackgroundbuses,twoutilitybuses,twopreviewout-puts,andfourprogramoutputs.
AKalypsosystemhas46programmablesystemoutputs(Outputs39and40arenotprogrammable).
Anauxbusoutputcanbeconfiguredasavideo/keypair.
TheKalypsoStillStoreoptionhastwoinputsandeightoutputs.
ZodiakSystemOverviewAZodiaksystemprovides32tallyrelays.
Thetallyserialportalsooutputscurrentsystemtallyinformation.
Zodiaksystemsareavailableina3-MEmodel(threefullyfunctionalMEs,oneactingasPGMPST)anda2.
5-MEmodel(2MEsandPGMPST).
EachMEhasfourkeyers,twobackgroundbuses,oneutilitybus,onepreviewoutput,andoneprogramoutput.
ThePGMPST-DSKbankisequipped10SwitcherProducts—ProtocolsManualSection1—TallyProtocolwiththreedownstreamkeyers(onthe3-MEmodelanadditionalfourMEkeyersareavailable,makingatotalofseven),andhastwoprogramandtwopreviewoutputs.
ManyoftheZodiaksystem's26outputsarededicated,and13auxbusesareavailable.
ZodiaksystemoutputpairingisdifferentfromthatonKalypsosystems.
TheZodiakStillStorehastwoinputsandfouroutputs.
KayenneSystemOverviewAKayennesystemprovides24talliesrelaysperinstalledMEboard.
Smaller4-RUKayenneframessupportupto48relaytallies.
Larger8-RUKayenneframessupportupto96relaytallies.
Kayennesystemshaveamodulardesignavailableindifferentconfigura-tions,ranginginsizefrom1.
5MEto4.
5MEs.
Fromaprotocolperspective,aKayennecanhaveupto5MEs(whichincludestheME50).
Kayennesystemshave6keyersperME.
KayennesystemsalsosupportanImageStorecapableof6inputandoutputchannels,andafloatingeDPMeffectssystem.
KayenneSourceIDsareintherangeof1-146(Kalypsowaslimitedto128).
ThemessagesyncalgorithmemployedisdifferentfromKalypsobecausesourceIDscanhavevaluesgreaterthan128.
Thesizeofthecontributiontallyis303bytes(Kalypsowas223bytes).
TallyBackgroundInformationThissubsectiondescribeswhataswitcherdoesintermsoftallycalcula-tions,andmaybeusefulforpersonsdesigningatallycomputerthatusesserialtallyinformation.
Thetallysystemofaproductionswitcherprovidesstatustodevicesandtheiroperators.
Themostbasicstatusiswhetherornotthedeviceisonair,butotherstatusescanalsobeprovidedbythetallysystem.
Forexample,theKalypsosystemhasfourprogramoutputsonitsPGMPSTbank.
Thetallysystemisnotaffectedwhenoneoftheadditionaloutputsissimplya"cleanfeed"versionofthemainprogramoutput.
However,customizedfeedswhichdepartfromtheprogramoutputarepossible.
Thesecustom-izedoutputsmayincludesourceswhicharenotpresentonthemainprogramoutput.
Forexample,theswitchermayautomaticallysubstitutea"private"cameraforawideshot.
Thetallysystemprovideswaystoprop-erlytallythesespecialsituations.
SwitcherProducts—ProtocolsManual11TallyBackgroundInformationTallyTypesTallyrequirementscangobeyondsimpleon/offairindicationforeachsource.
Thissectiondescribesthetypesoftallyinformationwhichcanbeprovidedviatheswitchertallyrelaysortheserialprotocol.
Theswitcherperformsfivetallycalculations:on-airtally,plusfourothercustomerspecifiedcalculations.
Eachcalculationmaybecustomizedbyselectingthetallytypeandwhichbusescontributetothetally.
Therearethreebasictypesoftallycalculationsandtwospecificderivativesforthe"outputtally"type.
OutputTallyOutputtallyindicateswhichsourcescontributetoaspecificoutputorgroupofoutputs(maximumoffouroutputs).
On-airandlook-aheadtallyarespecificcasesofoutputtally.
Outputtallyneedsastartingpointfortallycalculations.
Thecustomercanselectoneormoreoutputswhichwillbeincludedinthetallycalculation.
Anysourceswhichappearonthoseoutputswillbetallied.
On-airTallyOn-airtallyindicateswhetherasourceisonoroffair.
Thisinformationismostoftenusedtoprovidecameratallysothecameraoperatorandthetalentknowwhenthecameraisincludedontheprogramoutput(s)oftheproductionswitcher.
Itisaspecialcaseofoutputtally.
Itisprovidedasaseparatetypetoeasetallyconfiguration.
Theswitcherhasmorethanoneoutputwhichmaybeonair(e.
g.
,allfourprogramoutputsofthePGMPSTbankmayhavedifferentsourcecontribu-tions).
Onairtallyincludessourceswhichcontributetoanyoftheseout-puts.
On-airtallyhadnoconfiguration.
IttalliesanysourcewhichcontributestoanyofthefourPGMPSTprogramoutputs.
Look-aheadTallyLook-aheadtallyissimilartoOn-airtallybutisbasedontheselectionmadeontheswitcher'smainPRESETbus.
Itisintendedtoindicatewhichsourceswillbeonairifaprogram-presettransitionisperformed.
Look-aheadtallyisalsoaspecialcaseofoutputtally.
Itisprovidedasaseparatetypetoeasetallyconfiguration.
Look-aheadtallyhasnoconfiguration.
Ittalliesanysourcewhichcontributestothelook-aheadstateforanyofthefourprogramoutputsofthePGMPSTbank.
12SwitcherProducts—ProtocolsManualSection1—TallyProtocolIsoTallyIsotallyindicateswhichsourcescontributetoaspecificpointintheswitchervideopathwhetherornotthosesourcescontributetotheprogramoutput.
Forexample,anMEisotallyindicateswhatsourcescontributetooneormoreofanME'sprogramoutputs.
IsotallyissimilartooutputtallyexceptthatthetallycalculationisspecifiedintermsoftheMEoutputsnotonphysicaloutputsoftheswitcher.
Infact,theMEoutputsdonothavetobemappedtophysicaloutputsinordertogenerateMEIsotally.
SelectionTallySelectiontallyindicateswhatsourceisselectedonaparticularbusorbuses.
Selectiontallydoesnotfollowreentriesorfactorinbusvisibility.
Thebusesneednotbeonairforthesourcestocontributetothisinformation.
Selectiontallyrequiresspecifyingwhichbusesoftheswitchershouldbeincludedinthetallycalculation.
TallyCalculationBasicsTallystatusprovidesinformationaboutswitchersourcesbasedonthevideocompositeatsomepointinthevideopath.
Thissectiondescribesthemechanismsusedwithintheswitchertocalculatetallyrelayclosures.
Theinformationisalsousefulwheninterpretingthe"contributiontally"datadescribedlater.
ManysourcesmaybecombinedateachMEoftheswitcherandMEbankscanbereentered.
Inordertocalculatetallystatus,thevideoandkeypathsmustbetracedbackwardsfromthevideooutputthroughallMEs,keyersandexternalprocessingequipment(e.
g.
,aDVE)totheprimarysources.
Ateachstageinthevideopath,tallycalculationsmusttakeintoconsider-ationwhetherornotaparticularbuscontributestothecompositeandwhatsourceisselectedonthebus.
Iftheselectionisaprimarysource,theendofthatbranchhasbeenfound.
However,iftheselectionisareentry(eitheranotherMEorinternal(e.
g.
,framestore)orexternalprocessing(DVE),thetracemustcontinueinordertofindsourceswhichcontributetothatpro-cessingblock'soutput.
Calculationsmustincludebothvideoandkeypathsthroughtheswitcher.
KeyerModificationsKeyersmodifythevideoandkeysignalsandaffecttallycalculations.
Thekeyercaneitherusetheincomingvideoorreplaceitwithamatte.
Inaddition,thekeysignalcanbederivedeitherfromtheincomingvideo,SwitcherProducts—ProtocolsManual13TallySystemincomingkeysignalorawipepatterngenerator.
Thevideoinputcontrib-utestothekeyifitisusedaseitherthefillorasthekeysource.
Thekeyinputcontributestothekeyifitisusedasthekeysource.
Anopacitysettingof0%negatesallcontributionsofthekeyer.
Theprocessedcutsignalorthemaskingsignalsmayalsochangevideocon-tribution.
Iftheresultofkeyprocessingproducesacompletelytransparent(i.
e.
,cutsignalis0fortheentireraster),thevideosignalisnotcontributingtothekeyoutput.
ThiscalculationisnormallynotconsideredsinceitrequiresrealtimesamplingofthecutsignalandexistingkeyprocessorASICsdonotincludethecalculations.
Allofthesefactorsarecombinedintoasingleflagwithinthecontributiontallypacket.
TransitionMixerModificationsThetransitionmixersmodifythecontributionofallinputstoanMEbank.
Ifthemixermakesaninputtransparent,thereisnocontributiontothemixeroutputforthatinput.
Separatecontributionflagsareprovidedforeachpathintoamixer.
Eachmixer(theKalypsosystemhasfourperME,forexample)hasitsownsetofcontributionflagsinthecontributiontallypacket.
InternalandExternalProcessingLoopsImagesprocessedbyDVEs,framestoresorotherdevicesmustalsoreceiveaccuratetally.
Sincethesedeviceshavetheabilitytomaketheirincomingvideoinvisible,theircurrentstatemustbeincludedintheswitchertallycalculations.
Forexample,iftheDVEpositionsanimagecompletelyoffscreenortheframestoreisfrozen,theon-airtallyforthatsourceshouldgoaway(assumingitisn'tonairviasomeotherpath).
TallySystemTherearemanyinputs,outputsandpathsthroughaproductionswitcher.
Thetallysystemmustbecapableofdeterminingwhichsourcescontributetoaspecifiedoutputregardlessofcontributionstootheroutputs.
Inessence,theremaybemultipletallypathsthroughtheswitcherjustastherearemultiplevideopaths.
Itisessentialtomaintaintallyindependencebackthougheachvideoprocessingpathoftheswitcherandexternalgear(e.
g.
,DVE).
14SwitcherProducts—ProtocolsManualSection1—TallyProtocolForthisreason,eachdevicewhichprocessesvideomustbuilda"contribu-tionmap"whichindicateswhichofitsinputsarevisibleonorcontributestoeachoutput.
Becausethevideopaththroughtheswitcherisknown,thetallysystemcanthentraceeachoutputbackthroughallpathsandfindallcontributingsources.
Thesetofcontributingsourcesforeachoutputislikelytobedifferent,butcanbetalliedindependently.
Withthismechanism,mosttallymodesareadegeneratecaseofOutputTally.
On-airtallyisOutputTallyforthePGMPSTProgramoutput.
Look-aheadtallyisOutputTallyforthePGMPSTPreviewoutput.
Ifmorethanoneprogramoutputexists,forexample,thefourprogram-mablecleanfeedoutputsofthePGMPSTbank,contributionscanbecom-binedaftertracingeachpathfromoutputbacktoallinputs.
NamesAlltallyinformationisnumberbasedtokeepmessagesshortandminimizecommunicationtime.
Sourcenamesareprovidedthroughaseparatemech-anismbecausetheychangelessfrequentlyandrequireahigherbandwidthtotransfer.
SourcenamesnamethesourceIDsincludingreentries.
TallyRelayOutputsTheKalypsosystemprovides64tallyoutputsaspartofthestandardsystem.
Asecondcardcanbeaddedforatotalof128tallyrelayswithintheframe.
TheZodiaksystemhas32tallyrelayswithnoadditionalcardsavail-able.
OnaKalypsoorZodiaksystem,tallyrelayscanbeconfiguredfordifferenttallycalculationsingroupsof32.
Forexample,onaKalypsosystemonegroupcanprovideon-airtallywhileanothergroupcanprovidebusisotally.
Eachtallyrelaywithinthegroupcanbeassociatedwithoneofthe128sources.
Inthepreviousexample,on-airtallycanbesetupforany32ofthe128Kalypsosourcesusingthefirstgroup.
Thesecondgroupcouldprovidebusisotallyforthesamesetof32sourcesoracompletelydifferentset.
Inmanysituations,32on-airclosureswillbesufficient.
Whenthisisnotthecase,additionalgroupscanalsobeconfiguredforon-airtallycalculationsandmappedtodifferentsources.
Byusingallfourtallygroupsforon-airtally,all128Kalypsosourcescanbetallied.
NoteAtthetimeofpublication,switchertallyrelayswerehard-codedtocorre-spondone-to-onetosystemsources.
ThetallyrelayforanysourcevisibleonanyoftheoutputsofthePGMPSTbankwillclose.
Programmabletallyrelays,asreferencedhere,areunderdevelopment.
Checkthedocumentationofyourcurrentswitchersoftwareversiontodeterminewhattallyrelaypro-grammingcapabilitiesareavailable.
SwitcherProducts—ProtocolsManual15SerialTallySerialTallyTheswitcherprovidesaserialtallyinterfacethatprovidesthenecessaryinformationtotraceanytallypathwithintheswitcher.
TheserialprotocolisbasedonRS-422asynchronousserialcommunicationsat76.
8kb,8databits,1stopbit,andnoparityasadefault.
Otherbaudrates(9600,19,200,38,400,57,600,and115,200)andoddorevenparityselectionscanbeselectedforcontributiontallybutthelowerratesreducethroughputandhencelatencyinreportingtally.
76.
8kb/fieldwithnoparityyieldsabout128charactersperfieldandwasassumedforalltransmissiontimesunlessotherwisenoted.
At9600baudandevenoroddparity,thelinkonlysupports14charactersperfield,makingthelinkvirtuallyuselessforrealtimetally(contributiontallywouldrequire16fieldstotransmit).
SeeTable10onpage26forspecifictiminginformation.
Theserialtallyinterfaceusesbinaryprotocolswitheasilyidentifiablemessageboundaries.
Allcommunicationisfromtheswitcherframetotheexternaldevice.
Multiplelistenerscanbeconnectedtothisport.
Externaldevicesshouldnottransmitinformationoneitherpairofthelink.
Theswitcherdoesnotlistentothisport,itonlyspeaks.
Thecontributiontallyinformationiscurrentlyoutputtoport5ontheKalypsosystem,andport2ontheZodiaksystem.
Theabilitytoconfigureswitcherserialportsfordifferentpurposesiscurrentlyunderdevelop-ment.
ChangingTallyPortSerialSettingsAtthetimeofpublication,theswitcherdoesnothaveamenutochangeserialportsettings.
Thecontributiontallybaudratecanbechangedbyeditingthetextfile"mfPorts.
cfg"locatedintherootoftheframe'sharddisk.
ThefilecanbeFTPedtoaworkstation,editedwithanytexteditorandFTPedback.
Theframecanthenberesettoactivatethenewbaudrate.
Ifthefileisnotrecognizedduringframebootup,adefaultwillbecreatedreplacinganexistingone.
Thedefaultuses76.
8Kb.
Thefollowingsampleindicateswhatthefileshouldlooklikefor115.
2KbonaKalypsosystem.
PORT5:115200,N,8,1;(Port:X:BaudRate,Parity,DataBits,StopBits)PORT5:identifieswhichportwillbeaffectedbytheremaininginformationontheline.
Currentlyonlythetallycontributionport(port5onKalypso,port2onZodiak)canbesetusingthismechanism.
Respectively,theremainingcommaseparatedinformationis:BaudRate:9600,19200,38400,57600,76800or115200Parity:Nfornone,OforoddorE16SwitcherProducts—ProtocolsManualSection1—TallyProtocolNumberofDataBits:mustbe8NumberofStopBits:1(typical)or2.
Thesemicolonindicatesacommentseparatorcausingtherestofthelinetobeignoredbytheparser.
Kalypso&ZodiakContributionTallyProtocolContributiontallymakesitpossibletodeterminewhichsourcesandpro-cessingblocks(anMEorDVE)contributetotheimageatanypointinthevideopath.
On-airtally,forexampleidentifieswhichsourcescontributeinsomewaytothemainprogramoutputoftheswitcher.
ME2isotallystartsatME2'smainprogramoutput.
RefertoTallyCalculationBasicsonpage12andTallySystemonpage13formoredetails.
Contributiontallyconsistsofapproximately220bytesofinformation.
Becausebandwidthislimitedtoapproximately128bytesperfieldat76.
8kb,thisinformationisbrokenintosmallermessages.
Thisallowssendingchangesatahigherprioritythanunchanginginformation.
Evenwithprioritizedupdates,thereisnoguaranteethatallchangeswillbecom-municatedwithinonefield.
SeeTable10onpage26forspecifictiminginformation.
Contributionmessagesindicatewhichsourcesareselectedonbusesfeedingtheprocessingblock(oroutput)andwhichofthoseinputscon-tributetoaprocessingblock'soutput.
Inthecaseswhereaprocessingblockhasseveraloutputs,aseparatecontributionmapisincludedforeachoutput.
ContributiontallyforexternalprocessingblockssuchasaDVEalsoliststhesourceIDsforthisblock'soutput(s)sothatreentrypathsthroughexternaldevicescanbeidentifiedandfollowed.
Contributionmessagecodesstartat0x8withaninstanceIDgraterthanorequaltoone.
Thisinsuresthatcommandcharactervalueisalwaysabove128soitisrecognizedasacommandcode.
Commandcodes0xEand0xFarenotusedbutarereserved.
Contributioninformationforeachprocessingblockissentasaseparatemessage.
Informationforswitcheroutputsissentinsixmessagesofeightoutputseach.
Allportionsofthesystemareincludedinthecontributiondumpeveniftheyareinactive.
Inactiveblockswillcontaindatawhichindicatesinactivestatusforallinputstotheprocessingblock.
Inaddition,thatblock'soutputswillneverappearasselectionsonanybusoftheswitcher.
SwitcherProducts—ProtocolsManual17Kalypso&ZodiakContributionTallyProtocolSourceIDsValidsourceIDsusedinthisprotocolrangefrom1-128.
SourceIDsintherangeof93-128originatewithintheswitcherandneverchange.
OnKalypsosystems,sourceIDsintherangeof1-92representexternalsources,includinganyexternalprocessingblocks.
ZodiaksystemshavethesamerangeofexternalsourceIDs,buthavefewerexternalphysicalinputs.
Asourcevalueof0indicatestheinputorbusisnotinuse,ortoindicatethatanexternalDVEisbeingusedinaneffectssendloop.
Inthiscase,theDVE'scontributioninformationisincludedintheME'scontributioninfor-mationandadditionaltallycalculationsarenotnecessary.
NofurthertallycanbecalculatedforsourceIDsofzero,anditshouldnotbecountedasaprimaryinput.
Tallyissourcebased.
Whichphysicalinputsareusedisnotfactoredintotallyinformation.
Table1summarizessourceIDsforMEreentriesandinternalsources.
Notethatsomesourcesarenotavailableonsomeswitchermodels.
Table1.
SourceIDsSourceIDReentrySourceIDReentry93ME1PGMA94aaZodiakSystemsdonothavethesesources.
ME1PGMB95aME1PGMC96aME1PGMD97ME1PVWA98aME1PVW299bb2-MEKalypsoSystemsdonothavethesesources.
ME2PGMA100abME2PGMB101abME2PGMC102abME2PGMD103bME2PVWA104abME2PVW2105bcc2.
5-MEZodiakSystemsdonothavethesesources.
ME3PGMA106abME3PGMB107abME3PGMC108abME3PGMD109bcME3PVWA110abME3PVW2111Pgm-PstPGMA112Pgm-PstPGMB113aPgm-PstPGMC114aPgm-PstPGMD115Pgm-PstPVWA116Pgm-PstPVW2117aTestSignal118Black119Background1120Background2121StillStore1122StillStore2123StillStore3124StillStore4125aStillStore5126aStillStore6127aStillStore7128aStillStore818SwitcherProducts—ProtocolsManualSection1—TallyProtocolMEContributionInformationKalypsosystemshaveupto4MEs.
EachMEhas12inputbuses(4video/keypairs,2backgroundsand2utilitybuses),4programoutputs(PGMA–PGMD)andtwopreviewoutputs.
PVWAisalwaysassociatedwithPGMA.
PVW2isselectableasthepreviewforPGMB,CorD.
Previewoutputcontributiondependsonthepreviewmodeselectedandactivekeyer"holdtopreviews"or"showkeys".
Contributioninformationispro-videdforallsixrealoutputsandforthelook-aheadstateofthefourprogramoutputs.
"LAP"contributionalwaysindicateswhattheprogramcontributioninformationwouldbefollowingamaintransition.
ZodiaksystemMEshaveonlyoneutilitybus,andonlyoneprogramandonepreviewoutput.
Contributioninformationforthesewillbegenerated,butnonewillbegeneratedforutility2whichisnotpresent.
Contributioninformationformissinginputsandoutputswillalwaysbefalse.
OnaZodiak2.
5-MEsystem,PGMPST-DSKhasthreedownstreamkeyersandnoutilitybuses,andtwoprogramandtwopreviewoutputs.
ZodiakPGMPST-DSKisreportedasPgm-Pst.
Itwillonlyreportkeys1-3ascon-tributingtothecomposite,andonlyshowPGMAandBoutputsactive.
ME3isnotactive.
OnaZodiak3-MEsystem,PGMPSTfeedsthedownstreamkeyerandisreportedasME3.
TheDSKisreportedasPgm-Pst,andhasthreedown-streamkeyers,noutilitybuses,andnoBbus.
TheDSKhastwoprogramandtwopreviewoutputs.
TheKeyerbuses"inuse"flagsindicatewhetherornotthecutandfillwouldbevisibleifthekeyerwascontributingtoanoutput.
TheContribu-tionflagsindicatewhetherornotthekeyercontributestotheoutput.
Theseflagsneedtobecombined(ANDed)todetermineifakeyercutorfillbusisactuallycontributingtotheoutput.
Thiswasdonetolimitsizeofthemessagewithouteliminatinginformation.
ThesourceinformationindicateswhichsourceisfeedingtheMEinputs.
Thesemaybeprimarysourcesorreentries.
SourcesandinuseflagsapplytoalloutputsfromanME,butcontributioninformationmaybedifferentforeachoutput.
RefertoTable2onpage19.
SwitcherProducts—ProtocolsManual19Kalypso&ZodiakContributionTallyProtocolExternalProcessingContributionInformationExternalvideoprocessingblockssuchasDVEsmustbeincludedforaccu-ratetallycalculations.
Thisprotocolsupportsuptotwoexternalprocessingblocks,eachwithuptofourinputpairsandsixoutputs.
Externalprocessingblocksuseprimaryinputsforreentrypaths.
TheoutputsourceIDsidentifythesepaths.
ThesesourceIDsshouldbetreatedjustlikeanMEreentry.
OutputcontributionmapsandreentrysourceIDsareprovidedforthe6outputs.
Table2.
MEContributionb7b6b5b4b3b2b1b0NotesMEContribution(0x8)MEIDMEIDs1–ME12–ME23–ME34–Pgm-PstSourceIDsME1ME2ME3Pgm-PstMEContribution(0x8)MEIDKey1FillSource(1–128)Key4CutKey4FillKey3CutKey3FillKey2CutKey2FillKey1CutKey1FillKeyerbusesinuseKey1CutSource(1–128)Key4Key3Key2Key1Util2Util1BAPGMAContribution9399105111Key2FillSource(1–128)Key4Key3Key2Key1Util2Util1BAPGMBContribution94100106112Key2CutSource(1–128)Key4Key3Key2Key1Util2Util1BAPGMCContribution95101107113Key3FillSource(1–128)Key4Key3Key2Key1Util2Util1BAPGMDContribution96102108114Key3CutSource(1–128)Key4Key3Key2Key1Util2Util1BALAPAContributionKey4FillSource(1–128)Key4Key3Key2Key1Util2Util1BALAPBContributionKey4CutSource(1–128)Key4Key3Key2Key1Util2Util1BALAPCContributionASource(1–128)Key4Key3Key2Key1Util2Util1BALAPDContributionBSource(1–128)Key4Key3Key2Key1Util2Util1BAPVWAContribution97103109115Utility1Source(1–128)Key4Key3Key2Key1Util2Util1BAPVW2Contribution98104110116Utility2Source(1–128)20SwitcherProducts—ProtocolsManualSection1—TallyProtocolTheinputmodeflagsindicatewhethertheBsideofaninputpairisaninde-pendentvideosignalorlinkedtotheAsideastheinput'skey.
RefertoTable3.
StillStoreContributionInformationTheKalypsointernalstillstorehas8outputs.
Outputscanbeconfiguredinpairsastwoindependentoutputsorasavideo-keypair.
TheOutputModeflagsidentifytheconfigurationforeachoutputpair.
TheZodiakinternalstillstorehasonlyfouroutputs,sostillstorecontribu-tioninformationwillonlybevalidforoutputs1-4.
Contributioninforma-tionforoutputs5-8willalwaysbefalse.
Table3.
ExternalProcessingContributionb7b6b5b4b3b2b1b0NotesExternalProcContribution(0x9)ExtProcIDExtProcID1–DPM12–DPM2ExternalProcContribution(0x9)ExtProcIDInput4BInput4AInput3BInput3AInput2BInput2AInput1BInput1AOutput1ContributionOutput1Source(1–128)Output1reentryIDInput4BInput4AInput3BInput3AInput2BInput2AInput1BInput1AOutput2ContributionOutput2Source(1–128)Output2reentryIDInput4BInput4AInput3BInput3AInput2BInput2AInput1BInput1AOutput3ContributionOutput3Source(1–128)Output3reentryIDInput4BInput4AInput3BInput3AInput2BInput2AInput1BInput1AOutput4ContributionOutput4Source(1–128)Output4reentryIDInput4BInput4AInput3BInput3AInput2BInput2AInput1BInput1AOutput5ContributionOutput5Source(1–128)Output5reentryIDInput4BInput4AInput3BInput3AInput2BInput2AInput1BInput1AOutput6ContributionOutput6Source(1–128)Output6reentryID0Input4BInput3BInput2BInput1BInputMode0–Video1–KeyInput1ASource(1–128)Input1BSource(1–128)Input2ASource(1–128)Input2BSource(1–128)Input3ASource(1–128)Input3BSource(1–128)Input4ASource(1–128)Input4BSource(1–128)SwitcherProducts—ProtocolsManual21Kalypso&ZodiakContributionTallyProtocolTheKalypsoandZodiakinternalstillstorehastwoinputs.
Theycanbeconfiguredastwoindependentvideoinputsorasavideo-keypair.
TheInputModeflagindicateswhichmodetheinputsareoperatingin.
TheRecordflagsindicatewhetherornottheinputisinuse.
Ifaninputisgrabbingaframeorrecordingananimation,thebitwillbe1.
Anactiverecordflagisessentiallyabeginningpointfortallyregardlessofstillstoreoutputusagesincetheindicatedsourceisbeingrecordedonthestillstore'sharddisk.
RefertoTable4.
OutputContributionInformationKalypsoSystemsKalypsohas46programmableoutputs(Outputs39and40arededicatedtoBlackandTestandreportthesesourceIDs).
AnoutputcanbeprogrammedaseitheranauxbusorasadedicatedoutputforanME,etc.
Fromatallystandpoint,theonlydifferenceiswhatsourceisselectedontheoutput.
Adedicatedoutputwon'tchangesourceswhileanauxbusmight.
Thatis,thetallyprotocolwon'tindicatewhattheoutputisbeingusedfor(dedicatedoutputorauxbus)andthereceiveroftheinformationshouldn'tcare.
Itmaybenecessarytoidentifywhichphysicaloutputsarestartingpointsfortallycalculations.
Outputstatusiscommunicatedin6messagesof8outputseach.
Forexample,statusforoutput10wouldbesentasoutput2inthesecondblock.
Theon-airflagsindicatewhetherornottheswitcherconsiderstheoutputtobeonair.
Thisinformationcanbehardcoded,ormaybebasedonstatusfromsomeexternaldevice.
Forexample,thePgm-PstPGMAoutputisthemainprogramoutputandisnormallyassumedtobeonair.
ThefeedtoanisorecordermayutilizeaGPIinput(runningstatusviatheswitcher-VTRcontrolinterface)sothatoutputisonaironlywhentheVTRisinrecord.
Tallycalculationsmaychoosetoignoretheseflags.
Outputsusedasauxbusesmaybepairedinordertodeliveravideo-keypairtoanexternaldevice.
TheOutputModeflagsindicatewhetherthetwoTable4.
StillStoreContributionb7b6b5b4b3b2b1b0NotesStillStoreContribution(0xA)1OnlyoneinstanceofStillStorecontributionStillStoreContribution(0xA)1Input1Source(1–128)Input2Source(1–128)0Output7/8ModeOutput5/6ModeOutput3/4ModeOutput1/2ModeInputModeInput2RecInput1RecMode0–Video-video1–Video-key22SwitcherProducts—ProtocolsManualSection1—TallyProtocolbusesofapairareindependent(video-video)outputsorarebeingusedasavideo-keypair.
RefertoTable5.
ZodiakSystemsManyZodiakoutputsarehardwiredtoMEoutputs.
Theseoutputswillnotbereportedintallycontributioninformation.
Theremainingoutputsareprogrammableasauxbuses(singlebusesorauxbuspairs).
ZodiakoutputpairingisdifferentfromKalypso.
Notethatauxbusnumbersmaynotcor-respondtoauxoutputnumberssincethisassignmentisconfigurable.
OutputmessagesareorganizedtoputZodiak'seffectssendbusesonthesameoutputIDsasusedforKalypsoeffectssendbuses.
Zodiakauxoutputs6-13(Zodiak'seffectssendoutputs)arereportedasoutputs41-48(Kalypso'seffectssendoutputs).
Zodiak'sswitchedpreviewisalsoreportedasOutput6.
(Table6).
Table5.
OutputContributionb7b6b5b4b3b2b1b0NotesOutputsStatus(0xB)BlockIDBlockID1–Outputs1-82–Outputs9-163–Outputs17-244–Outputs25-325–Outputs33-40a6–Outputs41-48baOutputs39and40arenotprogrammableandarealwaysBlackandTest,respectively.
bOutputs41through48aretheeffectssendoutputs.
OutputsStatus(0xB)BlockIDOutput1Source(1–128)0000Out7/8Out5/6Out3/4Out1/2Mode0–Video-video1–Video-keyOutput2Source(1–128)Out8Out7Out6Out5Out4Out3Out2Out1On-airOutput3Source(1–128)Output4Source(1–128)Output5Source(1–128)Output6Source(1–128)Output7Source(1–128)Output8Source(1–128)SwitcherProducts—ProtocolsManual23Kalypso&ZodiakContributionTallyProtocolSourceNamesSwitchersourcenamesarenotreallypartoftally,butoftenprovidevalu-ableinformationtodeviceswhichutilizeswitchertallyinformation.
Sourcenamesarelimitedtotwelvecharactersandeachissentinitsownmessagealongwiththesource'sID.
Sourcenamesarenotnecessarilyunique.
Thatis,twosourcescouldhavethesamename.
Theswitchersupportsanoptionalnicknameforeachsourceaswellasthefullsourcename.
Nicknamesareashortenedversionofthefullsourcenameintendedfordisplayswithlimitedspace.
Theseareblankifunde-finedinwhichcasethefullsourcenameshouldbeused.
Theswitchersupportsthenotionofaliasingsourcenames,i.
e.
,replacinggenericnamesfornamesmorespecifictotheintendedusageofthesource.
Whenaliasesareactivatedinsuitepreferences,thetallysystemreportsaliases.
Otherwise,thecontributiontallyreportsengineeringsourcenames.
ThenamesetIDindicateswhichnamesetisbeingreported.
Table6.
ZodiakOutputAssignmentsOutputSignal1AuxOutput1(Asideifpairedwithauxoutput2)2AuxOutput2(Bsideifpairedwithauxoutput1)3AuxOutput3(Asideifpairedwithauxoutput4)4AuxOutput4(Bsideifpairedwithauxoutput3)5AuxOutput5(can'tbepaired)6SwitchedPreview7-8unused(reportedassourceID0)9-40unused,notreported41AuxOutput6(effectssend-Asideifpairedwithauxoutput7)42AuxOutput7(effectssend-Bsideifpairedwithauxoutput6)43AuxOutput8(effectssend-Asideifpairedwithauxoutput9)44AuxOutput9(effectssend-Bsideifpairedwithauxoutput8)45AuxOutput10(effectssend-Asideifpairedwithauxoutput11)46AuxOutput11(effectssend-Bsideifpairedwithauxoutput10)47AuxOutput12(effectssend-Asideifpairedwithauxoutput13)48AuxOutput13(effectssend-Bsideifpairedwithauxoutput12)24SwitcherProducts—ProtocolsManualSection1—TallyProtocolCharactersarelimitedto7-bitASCII.
Namesshorterthan12charactersareleftjustifiedandnull(0)filled.
ThemessageformatisindicatedinTable7.
Table7.
SourceNamesb7b6b5b4b3b2b1b0NotesSourceName(0xC)NamesetIDNamesetID1–Name&Nickname2–AliasSourceName(0xC)NamesetIDSourceID(1–128)0NameCharacter1Left-mostcharacter0NameCharacter20NameCharacter30NameCharacter40NameCharacter50NameCharacter60NameCharacter70NameCharacter80NameCharacter90NameCharacter100NameCharacter110NameCharacter12Right-mostcharacter0NicknameCharacter1Left-mostcharacter0NicknameCharacter20NicknameCharacter30NicknameCharacter40NicknameCharacter50NicknameCharacter6Right-mostcharacterSwitcherProducts—ProtocolsManual25Kalypso&ZodiakContributionTallyProtocolUpdateUpdatemessagesinformthereceiverofcriticalstatechanges.
Initializeindicatesthestartofswitchertallyprocessing(thebeginningoflife).
DataConsistentindicatesthatalltallypacketsareuptodate.
Sinceupdatesforonechangemayspanseveralpackets,toavoidtallyingsourcesimproperly,tallycalculationsshouldonlybeperformedwhendataisconsistent(allupdateshavebeensent).
SeeTable8.
RefertoCommandCodesandInstanceSummaryfortheuseofthesemessages.
CommandCodesandInstanceSummaryRefertoTable9foralistofthevalidcommandcodesandvalidinstanceIDsforeachcommand,andmessagelengths.
Table8.
UpdateMessagesb7b6b5b4b3b2b1b0NotesUpdate(0xD)UpdateIDUpdateID1–Initialize2–DataConsistentUpdate(0xD)UpdateIDTable9.
CommandCodeandInstanceCommandCodeInstancesMessageLengthDataOnlyWithCommandMEContribution(0x8)1–ME12–ME23–ME34–Pgm-Pst2325ExternalProcContribution(0x9)1–DPM12–DPM22123StillStoreContribution(0xA)n/a35OutputsStatus(0xB)1–Outputs1-82–Outputs9-163–Outputs17-244–Outputs25-325–Outputs33-406–Outputs41-481012SourceName(0xC)1=Name&Nickname2=Alias1921Update(0xD)1–Initialize2–DataConsistent02unused(0xE)unused(0xF)26SwitcherProducts—ProtocolsManualSection1—TallyProtocolMessageStructureMessagesstartwithamessagecode.
Messagecodesarerepeatedtwiceinordertoprovidepositiveidentificationofthemessagestart.
Databytescouldmatchavalidmessagecode,howeverthemessageshavebeenlaidoutsuchthatnotwoconsecutivedatabyteshavevaluesabove128.
Sinceallmessagecodecharactersareabove128,itisnotpossibleformessagedatatoduplicatetherepeatedmessagecode.
CommunicationSpecificsWhentheswitcherbeginssendingtallyinformation,itwillissueanIni-tializecommand,thensendalltallypacketsasfastaspossible.
AfterallpacketshavebeensentaDataConsistentmessageissent.
Duringidletimes(nochanges),onebackgroundcontributionupdatewillbesentatthefrequencyspecifiedinTable10followedbyaDataConsistentmessage.
Allinstancesofallmessagecodesarealwayssentregardlessofwhichportionsoftheswitcherarecurrentlyactive.
Thesourcenamesetissentonenameatatime.
All128sourcenamesaresentinorderandtheprocessrepeats.
BackgroundcontributionupdatesandthesourcenamemessagesarespacedoutandinterleavedasshowninTable10.
Remainingserialband-widthisusedforcontributionchangeupdates,ifany.
Whenchangesoccur,manymessagesmayberequiredtocommunicatethechange.
Attheendofthestreamofpackets,aDataConsistentmessagewillbesent.
TheswitcherwillinsurethatdataisinconsistentfornolongerthanindicatedinTable10.
Table10.
CommunicationSpecificsCategoryFieldRateBaudRate9,60019,20038,40057,60076,800115,200Cycleperiod(fields)60Hz20105432Backgroundcontributionrefresh(fields)26013065523926Backgroundcontributionrefresh(sec)4.
3292.
1651.
0820.
8660.
6490.
433Sourcenamerefresh(fields)85342721317112885Sourcenamerefresh(sec)14.
2087.
1043.
5522.
8422.
1311.
421Maxdatainconsistenttime(sec)0.
3330.
1670.
0830.
0670.
0500.
033Cycleperiod(fields)50Hz1684322Backgroundcontributionrefresh(fields)20810452392626Backgroundcontributionrefresh(sec)4.
1602.
0801.
0400.
7800.
5200.
520Sourcenamerefresh(fields)6833411711288585Sourcenamerefresh(sec)13.
6536.
8273.
4132.
5601.
7071.
707Maxdatainconsistenttime(sec)0.
3200.
1600.
0800.
0600.
0400.
040SwitcherProducts—ProtocolsManual27Kalypso&ZodiakContributionTallyProtocolThecycleperiodisthetime(infields)ittakestosendonebackgroundcon-tributionupdateandthreesourcenamemessages.
Remainingtimewithinacycleisusedtosendcontributionchanges.
Ifnochangesneedtobesent,thelinkgoesidleduringacycle.
Bydesign,thecycleperiodisalsothetimeittakestosendallcontributionmessages.
Thisisthemaximumtimecontributioninformationwillbeinconsistent.
Dataisinconsistentwhentallychangesoccurandmorethanonemessagemustbesenttocommunicateallchanges.
Backgroundcontributionrefreshisthetimeittakestocompletelysendallcontributionmessagesasbackgroundupdates.
Thistellsthetallysystemdesignerhowlongitwilltakefortheirsystemtosyncuptotheswitchershouldtheyconnectaftertheswitcherisupandidle.
Sourcenamerefreshisthetimeittakestosendallsourcenamemessages.
28SwitcherProducts—ProtocolsManualSection1—TallyProtocolMessageParsingandProcessingMessagecoderecognitionandparsingcanusethefollowingalgorithm:messageCode=INVALIDlastChar=0bytesReceived=0dataConsistent=FALSErepeatforevercurrentChar=nextbyteoninputstream//messageheader–setupfornewmessageif(currentChar>128&¤tChar==lastChar)messageCode=currentChar>>4//messagecodeis4MSBsinstance=currentChar&0xF//instanceis4LSBsbytesReceived=0if(messageCode==UPDATE)switch(instance)//instanceisreallyupdatetypecaseINITIALIZE:invalidateAllData()dataConsistent=FALSEbreakcaseDATA_CONSISTENT:if(allDataValid())dataConsistent=TRUEprocessTally()breakendswitch//preventtallyprocessingwhilereceivingtallyupdates//butsourcenameupdatesshouldn'tpreventtallycalcselseif(messageCodeclearAllData2MEcontribution(1)3MEcontribution(2)4MEcontribution(3)5MEcontribution(4)6MEcontribution(5)7DPMcontribution(1)8SScontribution(1)9Outputstatus(1)10Outputstatus(2)11Outputstatus(3)12Outputstatus(4)13Outputstatus(5)14Outputstatus(6)15SourceName(1-146)16Update(2)"Dataconstant"->processTally40SwitcherProducts—ProtocolsManualSection1—TallyProtocolMessagecoderecognitionandparsingcanusethefollowingalgorithm:thisByte=0;LOOP(forever){lastByte=thisByte;thisByte=read();if((thisByte&lastByte&0xF0)==0xF0){commandCode=lastByte&0xF;instanceID=thisByte&0xF;//checkforupdate/initializeif(commandCode==0xD)&&(instanceID==0x1)clearalldata.
//checkforupdate/dataconsistentif(commandCode==0xD)&&(instanceID==0x2)processTally()//readinmessageaccordingtocommandCodeelsereadmessagedatabytesforspecifiedinstance.
}}SwitcherProducts—ProtocolsManual41Section2EditorProtocolAvideoeditingsystemusestheswitchereditorporttoexercisereal-timecontrolovertheswitcher'sfunctions.
Theeditorisreallyanexternalcom-puterthatcaninputandoutputfunctions.
Suchfunctionsselectcros-spoints,performautotransitions,orperformE-MEM(EffectsMemory)registerrecalls,tonamejustafewpossibilities.
RefertotheappropriateswitcherUserManualfordefinitionsandexplanationsofswitcherfunc-tionsandfeatures.
Kalypso/ZodiakEditorProtocolIntroductionThissectiondescribestheEditorprotocolanditserrorhandlingasusedbyKalypsoandZodiaksystems.
ThisKalypso/ZodiakEditorprotocolisbasedontheGrassValleyGroupModel4000switcherprotocol,usedbytheModel4000,3000,and2200GrassValleyGroupswitchers,butcommandshavebeenextendedtosupportKalypsoandZodiakfeatures.
SerialDataWordDescriptionTheserialdatawordcontainselevenbits,asshowninFigure1:Figure1.
SerialDataWordDData,8Bits,LSBFirstStartBit,AlwaysZeroParityBitPreviousCharacter'sStopBitStopBit,AlwaysOneNextCharacter'sStartBit11BitsCharacterLength0D1D2D3D4D5D6D7P8063_02_01_r042SwitcherProducts—ProtocolsManualSection2—EditorProtocolEditorProtocolAccessThisEditorprotocolisbasedupon,butnotidenticalto,theproposedSMPTE(SocietyofMotionPictureandTelevisionEngineers)DigitalControlInterface,whichestablishesameansfortheorderlyflowofdataoveraserialbus.
ThemajorcomponentsoftheprotocolareshowninFigure2anddiscussedinthefollowingparagraphs.
Figure2.
ComponentsoftheEditorInterfaceProtocolBreakCharacterThemaincomponentoftheEditorprotocolisa1-1/2character-length"break.
"Abreakconsistsofaspacingorlogicallow(0)conditionontheserialbus(seeFigure2-2)followedbyaminimumoftwobit-timesofmarking(logic1)condition.
TheBusController(editor)transmitsabreaktotheswitcher,forewarningofanimpendingmessage(Figure3).
Figure3.
BreakCharacterThebreakforcesalltributaries,orlisteners(suchastheswitcher'seditorport),fromthe"Idle"stateintothe"Active"state.
AbreakcanbesentonlybytheEditController.
Whentheswitcherreceivesthebreak,itceasesallbuscommunications,resetsanycommunicationerrorcondition,andpre-parestoreceiveanaddress(Figure4).
BreakCharacterAddressByteCommand/MessageBlocks0350-061BitTime(26S@38.
4KBaud)SpacingData,17to20BitTimesSMPTEBreakCharacterMarkingData,2orMoreBitTimesFirstCharacterofAddressByte8063_02_02_r0SwitcherProducts—ProtocolsManual43Kalypso/ZodiakEditorProtocolFigure4.
EditorProtocolStateDiagramEditorSerialPort"Idle"StatePowerOnorResetReceivedValidBreakReceivedInvalidPollAddressReceivedPollAddress(31H)ReceivedValidSelectAddress(30H)ReceiveRequestReceiveCommandInvalidCommandorTimeOutReceivedCommunicationErrororTimeOutReceivedInvalidSelectAddress,CommunicationError,orTimeOutReceivedValidBreakEditorSerialPort"Active"StateEditorSerialPort"Selected"StateTransmitDataRequestedTransmitProtocolErrorProcessCommand,TransmitProtocolAcceptTransmitNegativeAcknowledgeEditorSerialPortinAnyStateEditorSerialPortTransmitsAcknowledgeByte8063_02_04_r1TransmitAcknowledgeByte44SwitcherProducts—ProtocolsManualSection2—EditorProtocolAddressByteOncethebreakhasbeenreceived,theEditorprotocoladvancestotheactivestateandbeginsexpectingaone-byteaddress.
Theswitcherwillrespondtotheswitcheraddress30H(Hexadecimal),whentransmittedbytheEditcontroller.
Afterreceivingtheaddress,theEditorprotocolacceptscommand/messageblocktransmissionscontainingcommands,datarequests,andotherdatadirectedtowardtheswitcher.
Aslongascommu-nicationerrorsdonotoccur,theEditorprotocolcanskipthebreak/addresssequenceduringtheremainderofthetransmissions.
Command/messageblockscanbesentrepeatedly,oneafteranother,withoutbreakinterrup-tions.
Theaddressisonebytelonganddirectedtoaspecifictributary.
Ifthereceivedaddressmatchesthetributary'sassignedaddress,thetributaryadvancestotheSelectedstateandawaitsinstructions.
Theaddressoftheswitcherisfixedas30H.
Inresponsetotheaddress,the3000transmitsanacknowledgmentbyteof84Htothecontroller,indicatingthechangeinstatustothe"Selected"State.
Ifanaddressof31Hisreceived,theswitchertransmitsanacknowledgmentbyteof84Htothecontroller,butstaysinthe"Active"State.
Iftheaddressdoesnotmatch,thetributarydropsoffthebus(goesIdle)andawaitsanotherbreak.
Command/MessageBlockStructureIntheSelectedstate,theEditorprotocolreceivescommand/messageblocksthatdirectswitcheroperations.
ThebasicmessagestructureisshowninFigure5.
Figure5.
MessageStructureThemaximumlengthofamessageis255bytesplusthebytecountbyte.
Atabaudrateof38,400,themaximumlengthcommand/messagetakesmorethan4fieldstocomplete.
TheEditorprotocolcanhandledatacontinuously,receivingacontiguousstreamofcommand/messageblocks.
SuchanabilityenablesmultipleswitcheroperationstobeperformedwithoutconstantcyclingthroughtheMessageBytesEffectsAddr.
ByteCommandCodeByteByteCountByteMaximumSize255Bytes0350-09SwitcherProducts—ProtocolsManual45Kalypso/ZodiakEditorProtocolbreak/addresssequence.
Responses(handshakesorreaddata)arereturnedinthesameorderasthecommand/messageblocksarereceived.
ByteCountThecommand/messageblockcanrangeinsizefromtwoto256bytes.
Thefirstbyteoftheblockcontainsthebytecount.
Abytecountconsistsofthetotalnumberofsubsequentbytesintheblock;validbytecountvaluesrangefrom01HtoFFH(1to255).
Afterreceivingavalidbytecount(01HtoFFH)andthepropernumberofdatabytes(1to255),theswitcherexe-cutesthecommand.
EffectsAddressByteThesecondbyteofthecommand/messageblockistheeffectsaddressbyte,typicallyreferredtoasEX.
Thisbyteidentifiesthedesired"effectbank"withintheswitcherwheretheassociatedcommandwillgo.
ValidEffectsAddressesforeachcommandarespecifiedlaterinthismanual.
CommandCodeByteThecommandcodeisthethirdbyteofthecommand/messageblock.
Commandcodesfallintotwobroadcategories:requestsandcommands.
Onlyonecommandisallowedinanycommand/messageblock.
Likewise,onlyoneresponseisembeddedinanycommand/messageblock.
RequestsRequestsinterrogatethestatusofthespecifiedoperationalparameteroftheswitcher.
Whentheeditorissuesareadcommand/messageblock,theswitcherrespondsbysendingthecurrentstatusoftherequestedopera-tionalparameter(s)backtotheeditor.
Thisstatusinformationisreturnedintheformatofthewritecommand/messageblock.
Byechoingthewriteformat,theeditorcanlatersendresponsestoarequesttotheswitcherandcauseexecutionofthatfunction.
CommandsCommandsareusedbytheeditortochangeoperationalparameter(s)orinitiateafunctionwithintheswitcher.
46SwitcherProducts—ProtocolsManualSection2—EditorProtocolStatusRepliesTheswitcherrespondstoacommandbysendingatwo-bytestatusmessagetotheeditor.
Thefirstbyteisthebytecountwhichis01H,andthesecondbyteistheswitcher'sresponsetothecommand.
Thetwomostcommonresponsesare80H(commandaccepted)and40H(protocolerror)asshownin(Figure6).
Figure6.
StatusReplyMessageThestatusbitsaredescribedbelow.
NotethattheCommandAcceptbitandProtocolErrorbitcannotbothbeset.
IfCommandAcceptistrue,thecommandisforwardedtothespecifiedeffectssystem.
OnlytheCommandCodeByte,ByteCountByte,andtheEffectAddressBytearecheckedforvalidity.
Itdoesnotmeanthattheswitcherexecutedthecommandcorrectly.
IfProtocolErroristrue,anillegalfunctionmayhavebeenrequested.
ErrorDetectionErrordetectionisanormalpartofthecommunicationprocess.
Communi-cationor"handshaking"errorscantakemanyforms,suchasparityerrors,framingerrors,ordataoverrunerrors.
WhentheEditorprotocoldetectscommunicationerrors,itrespondswithanegativeacknowledgebyteof85Handthenabortsallcommunications.
Anyremainingun-executedcom-mandsarediscardedaftertheerrorindicationoccurs.
Inordertoresumecommunication,theeditormusttransmitabreak/addresssequencetoreturnthechanneltotheSelectstate.
Ifanerrorisdetectedduringthereceiptofthetributaryaddress,theEditorprotocoldropsbackintotheIdlestatewithouttransmittingthe85HNegativeAcknowledgebyte.
Ingeneral,itispreferablefortheeditortowaituntilitreceivestheCommandAcceptresponsebeforesendinganewcommand,althoughitispossibletosendacontinuousstreamofcommandswithoutwaitingforrepliesaftereachone.
76543210BitBit1=ProtocolError1=CommandAcceptedXX0000008063_02_03_r0SwitcherProducts—ProtocolsManual47EditorCommandsEditorCommandsIntroductionThissectiondescribestheeditorcommandsetusedbytheKalypsoVideoProductionCenterandtheZodiakDigitalProductionSwitcherwhenusingtheKalypso/Zodiakeditorprotocol.
TheseinterfacecommandsfollowtheModel4000interfaceclosely,andaredesignedtorespondtoexistingModel4000commandsfromaneditor(withafewexceptions-suchasE-MEMtransfer).
CommandshavebeenextendedtoprovideaccesstoKalypsoandZodiakfeatures,likeKeyer3and4,whichdonotexistontheModel4000.
ThisallowsanexistingModel4000editorinterfacetobeusefulwithoutmodification,orexpandedtoaccessnewswitcherfunctionality.
InthissectiontheKalypsoandZodiaksystemsaregenericallycalled"switcher"whenthesamecommandsareused.
Whendifferencesinthecommandsforthesemodelsexist,thedifferencesareindicatedwithnotesorwithseparatelabeledtables.
NotethefollowingforbothKalypsoandZodiakswitchers:TheE-MEMdatatransfercommandshavebeenreplacedwithSaveandLoadcommands.
InsteadoftransferringdataovertheRS-422seriallinetheLoadandSavecommandstransfersdatatoandfromfileslocatedontheswitcher'sinternalharddrive.
Thesefilesmaybetransferredfromtheswitcher'sharddrivetotheeditorusingFTPoveranethernetconnection.
TheE3(Mask)commandisnotimplemented.
Maskbusesdonotexistontheswitcher,insteadtheUtilitybusesareusedformasking.
TheE8(Layered)commandisnotimplemented.
Splitlayeredmodeisnotaccessible.
Accessisprovidedtoall128switchersources(seeCommandC0,C1).
NotethefollowingforKalypsosystemsonly:E-MEMLevelsareuseddifferentlyinKalypsothanintheModel4000.
TheEffectsAddressinthisprotocolrefertoKalypsoE-MEMenablegroupsasidentifiedbythedefaultnames.
KalypsomaybeconfiguredtoassignanyE-MEMleveltoanyenablegroup.
ThisprotocolassumesthattheenablegroupwillbereferencedeveniftheE-MEMlevelsassignedmaychange.
Accessisprovidedtonewbuses:K3,K4,U1,U,andAuxBus1–46(seeCommandC0,C1).
Accessisprovidedtosecondarywipegenerator(seeCommandC8)AccessisprovidedtoPrimaryandSecondaryM/EpartitionswhenKalypsoisinsplitmode(viaeffectaddress).
48SwitcherProducts—ProtocolsManualSection2—EditorProtocolNotethefollowingforZodiaksystemsonly:Accessisprovidedtonewbuses:K3,K4,U1,andAuxBus1–13(seeCommandC0,C1).
AccesstoDSKtransitiondoesn'tworkwithexisting4000code.
Editorprotocolcommandsaredetailedintablespresentedonthefollowingpages.
Addresses,bytecounts,importantnames,andsupportingdetailsarelistedforeachcommand.
Referencestopushbuttonsareshownincapitalletters,usingthelegendsastheyappearonaControlPanel.
ControlPanelsectionnamesareshownininitialcapitals.
NoteAllvalueswithintablesarehexadecimalunlessotherwiseindicatedbythenotation"decimal.
"CommandUsageTheappropriatecommandtousemaybedeterminedbyreferringtoTable20.
ApplicationExamplesSeveralexamplesofserialcommunicationsusingtheswitcherEditorInter-faceareprovidedonthefollowingpagesinthesectionsappropriatetothecommands.
Ingeneral,"Transmit"referstocommunicationfromtheeditortotheswitcherand"Receive"referstocommunicationfromtheswitchertotheeditor.
Refertospecificcommandtablesfordetailsontheseexam-ples.
Table20.
CommandUseSummaryPurposeCommand(s)BasicSourceControlSourceBus(C1–C4)Commands–page50SourceSelect(C0)Command–page55PreviewBus(E2)Command–page57SplitKey(E4,E5,E6,E7,E9andEA)Commands–page58TosimulatethepressingofcertainbuttonsPushbuttonSelectandControl(C6,C7andFB)Commands–page59SelectionofWipePatternsWipePattern(C8)Command–page63ControlofTransitionmodepushbuttonsTransitionMode(CA)Command–page65SettransitionratesAutoandKeyTransitionRate(CCandCD)Commands–page67E-MEMlearnsandrecallsLearnandRecallE-MEMRegister(DAandDB)Commands–page71E-MEMandConfigurationSaveandLoadDataSaveandLoadData(5FandDF)Commands–page78SaveandLoadStatus(6DandED)Commands–page82TimelinecontrolformultiplekeyframeeffectsTimelineControl(4E,4F,CE,andCF)Commands–page83CommandsforgeneralusebyaneditorAllStop(F2)Command–page88SoftwareVersion(6CandEC)Commands–page90SwitcherProducts—ProtocolsManual49EditorCommandsExample1:BringingtheEditorInterfaceintoaReadyStateExample2:HowtoSetCrosspoint#6,ARow,Mix/Effects2Example3:HowtoPerformaDSKAutoTransition(ZodiakOnly)Table21.
TransmitBreakAddressBRK30Table22.
ReceiveStatus84Table23.
TransmitByteCountExAddressCommandData0302C106Table24.
ReceiveByteCountStatus0180Table25.
SetDSKElements(DSK1,DSK2,DSK3)FunctionByteCountExAddressCommandDataDSK10404C6020EDSK20404C60210DSK20404C6022BTable26.
SetDSLLinkOnforActiveM/EFunctionByteCountExAddressCommandDataDSKLINK04EXC60230Table27.
SetMixTransitionTypeonM/EFunctionByteCountExAddressCommandDataMIX04EXC60206Table28.
TriggerAutoTransitionFunctionByteCountExAddressCommandDataAUTOTRANS04EXC60206Table29.
PerformSingleDSKTransition–CutorMixFunctionByteCountExAddressCommandDataDSK1CUT0404FB0223DSK1MIX0404C6022450SwitcherProducts—ProtocolsManualSection2—EditorProtocolSourceBus(C1–C4)CommandsTheSourceBuscommandsenabletheeditortoselectanysourceonabusspecifiedbytheeffectsaddress,andthecommandcode.
Table30.
SourceBusCommandsFunctionByteCountEffectsAddressCommandCodeMessageBKGDA/AUX03EXC1Source#BKGDB03EXC2Source#KEY1/DSK103EXC3Source#KEY2/DSK203EXC4Source#SwitcherProducts—ProtocolsManual51EditorCommandsKalypsoEffectsAddressesValideffectsaddressesfortheSourceBuscommandsusedbytheKalypsosystemareasindicatedinTable31.
Table31.
KalypsoEffectsAddresses-SourceBusCommandsEffectsAddressAssignmentEffectsAddressAssignmentEffectsAddressAssignmentEffectsAddressAssignmentAccessibleModel4000Code00PGM-PST07Mix/Effects3SecondaryPartitiona12AuxBus4A19AuxBus7B01Mix/Effects10CAuxBus1A13AuxBus4B1AAuxBus8A02Mix/Effects20DAuxBus1B14AuxBus5A1BAuxBus8B03Mix/Effects30EAuxBus2A15AuxBus5B1CAuxBus9A04PGM-PSTSecondaryPartitionaaNeweffectsaddressassignmentassociatedwithKalypso.
0FAuxBus2B16AuxBus6A1DAuxBus9B05Mix/Effects1SecondaryPartitiona10AuxBus3A17AuxBus6B----06Mix/Effects2SecondaryPartitiona11AuxBus3B18AuxBus7A----KalypsoCode40AuxBus1A57AuxBus12B6EAuxBus24A85AuxBus35B41AuxBus1B58AuxBus13A6FAuxBus24B86AuxBus36A42AuxBus2A59AuxBus13B70AuxBus25A87AuxBus36B43AuxBus2B5AAuxBus14A71AuxBus25B88AuxBus37A44AuxBus3A5BAuxBus14B72AuxBus26A89AuxBus37B45AuxBus3B5CAuxBus15A73AuxBus26B8AAuxBus38A46AuxBus4A5DAuxBus15B74AuxBus27A8BAuxBus38B47AuxBus4B5EAuxBus16A75AuxBus27B8CAuxBus39A48AuxBus5A5FAuxBus16B76AuxBus28A8DAuxBus39B49AuxBus5B60AuxBus17A77AuxBus28B8EAuxBus40A4AAuxBus6A61AuxBus17B78AuxBus29A8FAuxBus40B4BAuxBus6B62AuxBus18A79AuxBus29B90AuxBus41A4CAuxBus7A63AuxBus18B7AAuxBus30A91AuxBus41B4DAuxBus7B64AuxBus19A7BAuxBus30B92AuxBus42A4EAuxBus8A65AuxBus19B7CAuxBus31A93AuxBus42B4FAuxBus8B66AuxBus20A7DAuxBus31B94AuxBus43A50AuxBus9A67AuxBus20B7EAuxBus32A95AuxBus43B51AuxBus9B68AuxBus21A7FAuxBus32B96AuxBus44A52AuxBus10A69AuxBus21B80AuxBus33A97AuxBus44B53AuxBus10B6AAuxBus22A81AuxBus33B98AuxBus45A54AuxBus11A6BAuxBus22B82AuxBus34A99AuxBus45B55AuxBus11B6CAuxBus23A83AuxBus34B9AAuxBus46A56AuxBus12A6DAuxBus23B84AuxBus35A9BAuxBus46B52SwitcherProducts—ProtocolsManualSection2—EditorProtocolZodiakEffectsAddressesValideffectsaddressesfortheC1–C4SourceBuscommandsusedbytheZodiaksystemareasindicatedinTable32.
Table32.
ZodiakEffectsAddresses-SourceBusCommandsEffectsAddressAssignmentEffectsAddressAssignmentEffectsAddressAssignmentEffectsAddressAssignmentAccessible4000Code00PGM-PST0DAuxBus1B13AuxBus4B19AuxBus7B01Mix/Effects10EAuxBus2A14AuxBus5A1AAuxBus8A02Mix/Effects20FAuxBus2B15AuxBus5B1BAuxBus8B03Mix/Effects310AuxBus3A16AuxBus6A1CAuxBus9A04DSKaaFunctionassociatedonlywithZodiak.
11AuxBus3B17AuxBus6B1DAuxBus9B0CAuxBus1A12AuxBus4A18AuxBus7A----ZodiakCode40AuxBus1A47AuxBus4B4EAuxBus8A54AuxBus11A41AuxBus1B48AuxBus5A4FAuxBus8B55AuxBus11B42AuxBus2A49AuxBus5B50AuxBus9A56AuxBus12A43AuxBus2B4AAuxBus6A51AuxBus9B57AuxBus12B44AuxBus3A4BAuxBus6B52AuxBus10A58AuxBus13A45AuxBus3B4CAuxBus7A53AuxBus10B59AuxBus13B46AuxBus4A4DAuxBus7BSwitcherProducts—ProtocolsManual53EditorCommandsKalypsoSourceNumbersValidsourcenumbersforallbusesusedbyKalypsosystemsareprovidedinTable33.
Table33.
KalypsoCommonSourceNumbersforallbusesSourceNameHexadecimalDecimalSourceNameHexadecimalDecimalSourceNameHexadecimalDecimalSourceNameHexadecimalDecimalAccessibleModel4000CodeSource1011Source150F15Source291D29Source432B43Source2022Source161016Source301E30Source442C44Source3033Source171117Source311F31Source452D45Source4044Source181218Source322032Source462E46Source5055Source191319Source332133Source472F47Source6066Source201420Source342234Source483048Source7077Source211521Source352335ME1PGMA3149Source8088Source221622Source362436ME2PGMA3250Source9099Source231723Source372537ME3PGMA3351Source100A10Source241824Source382638ME4PGMA3452Source110B11Source251925Source392739ME1PVWA3553Source120C12Source261A26Source402840ME2PVWA3654Source130D13Source271B27Source412941ME3PVWA3755Source140E14Source281C28Source422A42ME4PVWA3856KalypsoCodeME1PGMB3957Bkgnd14B75Source575D93Source756F111ME2PGMB3A58Bkgnd24C76Source585E94Source7670112ME3PGMB3B59StillStore14D77Source595F95Source7771113ME4PGMB3C60StillStore24E78Source606096Source7872114ME1PGMC3D61StillStore34F79Source616197Source7973115ME2PGMC3E62StillStore45080Source626298Source8074116ME3PGMC3F63StillStore55181Source636399Source8175117ME4PGMC4064StillStore65282Source6464100Source8276118ME1PGMD4165StillStore75383Source6565101Source8377119ME2PGMD4266StillStore85484Source6666102Source8478120ME3PGMD4367Source495585Source6767103Source8579121ME4PGMD4468Source505686Source6868104Source867A122ME1PVW24569Source515787Source6969105Source877B123ME2PVW24670Source525888Source706A106Source887C124ME3PVW24771Source535989Source716B107Source897D125ME4PVW24872Source545A90Source726C108Source907E126Test4973Source555B91Source736D109Source917F127Black4A74Source565C92Source746E110Source928012854SwitcherProducts—ProtocolsManualSection2—EditorProtocolZodiakSourceNumbersValidsourcenumbersforallbusesusedbyZodiaksystemsareprovidedinTable34.
Table34.
ZodiakCommonSourceNumbersforallBusesSourceNameHexadecimalDecimalSourceNameHexadecimalDecimalSourceNameHexadecimalDecimalSourceNameHexadecimalDecimalAccessibleModel4000CodeSource1011Source150F15Source291D29Source432B43Source2022Source161016Source301E30Source442C44Source3033Source171117Source311F31Source452D45Source4044Source181218Source322032Source462E46Source5055Source191319Source332133Source472F47Source6066Source201420Source342234Source483048Source7077Source211521Source352335ME1PGMA3149Source8088Source221622Source362436ME2PGMA3250Source9099Source231723Source372537ME3PGMA3351Source100A10Source241824Source382638DSKPGMA3452Source110B11Source251925Source392739ME1PVWA3553Source120C12Source261A26Source402840ME2PVWA3654Source130D13Source271B27Source412941ME3PVWA3755Source140E14Source281C28Source422A42DSKPVWA3856ZodiakCodeDSKPGMB3957Source545A90Source6767103Source8074116DSKPVWB3A58Source555B91Source6868104Source8175117Black4A74Source565C92Source6969105Source8276118Bkgnd14B75Source575D93Source706A106Source8377119Bkgnd24C76Source585E94Source716B107Source8478120StillStore14D77Source595F95Source726C108Source8579121StillStore24E78Source606096Source736D109Source867A122StillStore34F79Source616197Source746E110Source877B123StillStore45080Source626298Source756F111Source887C124Source495585Source636399Source7670112Source897D125Source505686Source6464100Source7771113Source907E126Source515787Source6565101Source7872114Source917F127Source525888Source6666102Source7973115Source9280128Source535989SwitcherProducts—ProtocolsManual55EditorCommandsSourceSelect(C0)CommandTheSourceBuscommandenablestheeditortoselectanySourceonabusspecifiedbytheeffectsaddress,andthecommandcode.
ThiscommandincludescompatibilityofcommandsC1,C2,C3andC4.
KalypsoEffectsAddressesValideffectsaddressesusedbyKalypsosystemsfortheCOSourceBuscommandaredefinedinTable36onpage56.
Table35.
SourceBusCommandFunctionByteCountEffectsAddressCommandCodeMessageSourceBus03EXC0Source#56SwitcherProducts—ProtocolsManualSection2—EditorProtocolTable36.
KalypsoEffectsAddresses-SourceSelectCommandEffectsAddressAssignmentEffectsAddressAssignmentEffectsAddressAssignmentEffectsAddressAssignment00PGM-PSTA2BMix/Effects3Key256AuxBus12A79AuxBus29B01Mix/Effects1A2CPGM-PSTKey2SecondaryPartition57AuxBus12B7AAuxBus30A02Mix/Effects2A2DMix/Effects1Key2SecondaryPartition58AuxBus13A7BAuxBus30B03Mix/Effects3A2EMix/Effects2Key2SecondaryPartition59AuxBus13B7CAuxBus31A04PGM-PSTASecondaryPartition2FMix/Effects3Key2SecondaryPartition5AAuxBus14A7DAuxBus31B05Mix/Effects1ASecondaryPartition30PGM-PSTKey35BAuxBus14B7EAuxBus32A06Mix/Effects2ASecondaryPartition31Mix/Effects1Key35CAuxBus15A7FAuxBus32B07Mix/Effects3ASecondaryPartition32Mix/Effects2Key35DAuxBus15B80AuxBus33A08PGM-PSTB33Mix/Effects3Key35EAuxBus16A81AuxBus33B09Mix/Effects1B38PGM-PSTKey45FAuxBus16B82AuxBus34A0AMix/Effects2B39Mix/Effects1Key460AuxBus17A83AuxBus34B0BMix/Effects3B3AMix/Effects2Key461AuxBus17B84AuxBus35A0CPGM-PSTBSecondaryPartition3BMix/Effects3Key462AuxBus18A85AuxBus35B0DMix/Effects1BSecondaryPartition40AuxBus1A63AuxBus18B86AuxBus36A0EMix/Effects2BSecondaryPartition41AuxBus1B64AuxBus19A87AuxBus36B0FMix/Effects3BSecondaryPartition42AuxBus2A65AuxBus19B88AuxBus37A10PGM-PSTU143AuxBus2B66AuxBus20A89AuxBus37B11Mix/Effects1U144AuxBus3A67AuxBus20B8AAuxBus38A12Mix/Effects2U145AuxBus3B68AuxBus21A8BAuxBus38B13Mix/Effects3U146AuxBus4A69AuxBus21B8CAuxBus39A18PGM-PSTU247AuxBus4B6AAuxBus22A8DAuxBus39B19Mix/Effects1U248AuxBus5A6BAuxBus22B8EAuxBus40A1AMix/Effects2U249AuxBus5B6CAuxBus23A8FAuxBus40B1BMix/Effects3U24AAuxBus6A6DAuxBus23B90AuxBus41A20PGM-PSTKey14BAuxBus6B6EAuxBus24A91AuxBus41B21Mix/Effects1Key14CAuxBus7A6FAuxBus24B92AuxBus42A22Mix/Effects2Key14DAuxBus7B70AuxBus25A93AuxBus42B23Mix/Effects3Key14EAuxBus8A71AuxBus25B94AuxBus43A24PGM-PSTKey1SecondaryPartition4FAuxBus8B72AuxBus26A95AuxBus43B25Mix/Effects1Key1SecondaryPartition50AuxBus9A73AuxBus26B96AuxBus44A26Mix/Effects2Key1SecondaryPartition51AuxBus9B74AuxBus27A97AuxBus44B27Mix/Effects3Key1SecondaryPartition52AuxBus10A75AuxBus27B98AuxBus45A28PGM-PSTKey253AuxBus10B76AuxBus28A99AuxBus45B29Mix/Effects1Key254AuxBus11A77AuxBus28B9AAuxBus46A2AMix/Effects2Key255AuxBus11B78AuxBus29A9BAuxBus46BSwitcherProducts—ProtocolsManual57EditorCommandsZodiakEffectsAddressesValideffectsaddressesusedbyZodiaksystemsfortheC0SourceBuscommandaredefinedinTable37.
PreviewBus(E2)CommandThePreviewBuscommandenablestheeditortoselectanySourceonthepreviewprimarybus.
SourceNumbersValidSourcenumbersareshowninTable33onpage53andTable34onpage54.
Table37.
ZodiakEffectsAddresses-SourceSelectCommandEffectsAddressAssignmentEffectsAddressAssignmentEffectsAddressAssignmentEffectsAddressAssignment00PGM-PSTA22Mix/Effects2Key140AuxBus1A4DAuxBus7B01Mix/Effects123Mix/Effects3Key141AuxBus1B4EAuxBus8A02Mix/Effects228PGM-PSTKey242AuxBus2A4FAuxBus8B03Mix/Effects329Mix/Effects1Key243AuxBus2B50AuxBus9A04DSK12AMix/Effects2Key244AuxBus3A51AuxBus9B05DSK22BMix/Effects3Key245AuxBus3B52AuxBus10A06DSK330PGM-PSTKey346AuxBus4A53AuxBus10B08PGM-PSTB31Mix/Effects1Key347AuxBus4B54AuxBus11A10PGM-PSTU132Mix/Effects2Key348AuxBus5A55AuxBus11B11Mix/Effects1U133Mix/Effects3Key349AuxBus5B56AuxBus12A12Mix/Effects2U138PGM-PSTKey44AAuxBus6A57AuxBus12B13Mix/Effects3U139Mix/Effects1Key44BAuxBus6B58AuxBus13A20PGM-PSTKey13AMix/Effects2Key44CAuxBus7A59AuxBus13B21Mix/Effects1Key13BMix/Effects3Key4Table38.
SourceBusCommandFunctionByteCountEffectsAddressCommandCodeMessagePreviewBus0306E2Source#58SwitcherProducts—ProtocolsManualSection2—EditorProtocolSplitKey(E4,E5,E6,E7,E9andEA)CommandsThesecommandsallowaneditortousetheSplitKeyfeatureoftheswitcher.
Therearetwomodesforselectingthekeysource:AutoSelectmodeusesthekeysourceassignedtotheselectedfillsource.
VideoSelectmodeusestheselectedfillvideoasthekeysource.
KalypsoEffectsAddressesValideffectsaddressesusedbyKalypsosystemsfortheSplitKeycommandaredefinedinTable40.
ZodiakEffectsAddressesValideffectsaddressesusedbyZodiaksystemsfortheSplitKeycommandaredefinedinTable41.
Table39.
SplitKeyCommandsFunctionByteCountEffectsAddressCommandCodeMessageKey104EXE6FillSource#,KeySource#Key204EXE7FillSource#,KeySource#Key304EXE9FillSource#,KeySource#Key404EXEAFillSource#,KeySource#DSK1aaUsedonZodiaksystemsonly0404E4FillSource#,KeySource#DSK2a0404E5FillSource#,KeySource#DSK3a0404E9FillSource#,KeySource#Table40.
KalypsoEffectsAddresses-SplitKeyCommandsEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304PGM-PSTSecondaryPartitionaaNewassignmentassociatedwithKalypso.
05Mix/Effects1SecondaryPartitiona06Mix/Effects2SecondaryPartitiona07Mix/Effects1SecondaryPartitionaTable41.
ZodiakEffectsAddresses-SplitKeyCommandsEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304DSKaaNewassignmentassociatedwithZodiak.
SwitcherProducts—ProtocolsManual59EditorCommandsSourceNumbersValidSourcenumbersareshowninTable33onpage53andTable34onpage54.
Thefillsourceisavalidsourceinhex.
TheformatoftheKeySourcebyteisprovidedinTable42.
PushbuttonSelectandControl(C6,C7andFB)CommandsThePushbuttonSelectcommand(FB)isacommandthatperformsa"push"ofthespecifiedpushbuttonnumber,justasifthebuttonhadactu-allybeenpressedatthecontrolpanel.
ThePushbuttoncommandsturnthedesignatedpushbutton"on"(C6)or"off"(C7).
Thesecommandsarevalidwithallpushbuttons.
Table42.
KeySourceByteFormatBit76543210Combinationof7bitsmakesvalidsources(00Hto7FH)withspecialcase:00is80H0=AutoSelectMode,1=VideoSelectModeTable43.
PushbuttonSelectandControlCommandsFunctionByteCountEffectsAddressCommandCodeMessagePB/L#ON04EXC6PB/L#High,PB/L#LowPB/L#OFF04EXC7PB/L#High,PB/L#LowPB/L#PRESS04EXFBPB/L#High,PB/L#Low60SwitcherProducts—ProtocolsManualSection2—EditorProtocolKalypsoEffectsAddressesValideffectsaddressesusedbyKalypsosystemsforthePushbuttonControlcommandsaredefinedinTable44.
ZodiakEffectsAddressesValideffectsaddressesusedbyZodiaksystemsforthePushbuttonControlcommandsaredefinedinTable45.
Table44.
KalypsoEffectsAddresses-PushbuttonSelectandControlEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects30BMasterE-MEM04PGM-PSTSecondaryPartitionaaNeweffectsaddressassignmentassociatedwithKalypso.
05Mix/Effects1SecondaryPartitiona06Mix/Effects2SecondaryPartitiona07Mix/Effects3SecondaryPartitionaTable45.
ZodiakEffectsAddresses-PushbuttonSelectandControlEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304DSKaaFunctionassociatedonlywithZodiak.
0BMasterE-MEMSwitcherProducts—ProtocolsManual61EditorCommandsKalypsoPushbuttonNumbersKalypsosystempushbuttonnumberssupportedbythesecommandsarespecifiedinTable46onpage61.
NoteInvalidpushbuttonnumberswillbeignored.
Toinsurethatatleastonetran-sitionelementison,theeditorshouldturnonthedesiredtransitionelement(e.
g.
,Bkgd,Key1,etc.
)beforeturningoffunwantedones.
Normally,Transi-tionWipe1willuseComplex1andTransitionWipe2willuseComplex2,but,thisisnotarequirement.
ItmaybeimpossiblefortheeditcontrollertoselectthewipepatterniftheoperatorhaschangedthisassociationfromtheUI.
Table46.
KalypsoPushbuttonNumbersM/EPushbuttonsMasterE-MEM/EffectsEdit/EffectsRunPushbuttonsNumberFunctionPressOn/OffNumberFunctionPressOn/OffM/E0201HCutX0502HENABLEM/E1aX0202HAutoTranX0503HENABLEM/E2aX0203HPresetBlackX0504HENABLEM/E3aX0206HMixX0501HENABLEPGM-PSTaX0207HA/BBkgdX0507HENABLEMISC1aX0208HPriWipeX0510HENABLEMISC2aX0204HSecWipeaaNewpushbuttonfunctionassociatedwithKalypso.
X0511HENABLEMISC3aX022DHUserTrans1aX0512HENABLEMISC4aX022EHUserTrans2aX0513HENABLEMISC5aX022FHUserTrans3aX0514HENABLEMISC6aX020EHKey1XX0515HENABLEMISC7aX0210HKey2XX0508HENABLEDPMaX022BHKey3aXX050CHENABLEALLX022CHKey4aXX0516HStillStoreGrpAaX0212HKeyPriorityXX0517HStillStoreGrpBaX0213HTriggeraXX0518HStillStoreGrpCaX0223HKey1CutX0544HPrevKFaXbbEffectsaddressesareirrelevantandwillbeignored.
Alleffectsaddresseswillbetreatedas0X0B.
0224HKey1MixX0545HNextKFaXb0225HKey2CutX0560HRewaXb0026HKey2MixX0561HHoldInputsaXb0227HKey3CutaX0562HRevaXX0228HKey3MixaX0563HAutoRunaXXX0229HKey4CutaX0564HStopNextaXX022AHKey4MixaX0565HRunaXX1607HWipe1Direction-NormalX0580HAutoRecallaXX1608HWipe1Direction-ReverseX1687HWipe2Direction-NormalX1688HWipe2Direction-ReverseX62SwitcherProducts—ProtocolsManualSection2—EditorProtocolZodiakPushbuttonNumbersZodiaksystempushbuttonnumberssupportedbythesecommandsarespecifiedinTable47onpage62.
NoteInvalidpushbuttonnumberswillbeignored.
Toinsurethatatleastonetran-sitionelementison,theeditorshouldturnonthedesiredtransitionelement(e.
g.
,Bkgd,Key1,etc.
)beforeturningoffunwantedones.
Normally,Transi-tionWipe1willuseComplex1andTransitionWipe2willuseComplex2,but,thisisnotarequirement.
ItmaybeimpossiblefortheeditcontrollertoselectthewipepatterniftheoperatorhaschangedthisassociationfromtheUI.
Table47.
ZodiakPushbuttonNumbersM/EPushbuttonsMasterE-MEM/EffectsEdit/EffectsRunPushbuttonsNumberFunctionPressOn/OffNumberFunctionPressOn/OffM/E0201HCutX022AHKey4MixaX0202HAutoTranX0230HDSKLINKX0203HPresetBlackX1607HWipe1Direction-NormalX0206HMixX1608HWipe1Direction-ReverseX0207HA/BBkgdX1687HWipe2Direction-NormalX0208HPriWipeX1688HWipe2Direction-ReverseX0209HDSK1X0502HENABLEM/E1aX020BHDSK2X0503HENABLEM/E2aX0211HDSK3X0504HENABLEM/E3aX0204HSecWipeaaNewpushbuttonfunctionassociatedwithZodiak.
X0501HENABLEPGM-PSTaX022DHUserTrans1aX0505HENABLEDSKX022EHUserTrans2aX0507HENABLEMISC1aX022FHUserTrans3aX0510HENABLEMISC2aX020EHKey1XX0511HENABLEMISC3aX0210HKey2XX0508HENABLEDPMaX022BHKey3aXX050CHENABLEALLX022CHKey4aXX0544HPrevKFaXbbEffectsaddressesareirrelevantandwillbeignored.
Alleffectsaddresseswillbetreatedas0X0B.
0212HKeyPriorityXX0545HNextKFaXb0213HTriggeraXX0560HRewaXb0223HKey1Cut/DSK1CutaX0561HHoldInputsaXb0224HKey1Mix/DSK1MixaX0562HRevaXX0225HKey2Cut/DSK2CutaX0563HAutoRunaXXX0026HKey2Mix/DSK2MixaX0564HStopNextaXX0227HKey3Cut/DSK3CutaX0565HRunaXX0228HKey3Mix/DSK3MixaX0580HAutoRecallaXX0229HKey4CutaXSwitcherProducts—ProtocolsManual63EditorCommandsWipePattern(C8)CommandTheWipePatterncommandselectsthespecifiedTransitionWipe1orTran-sitionWipe2patternforanM/E.
OnlyoneTransitionWipe1andoneTran-sitionWipe2patterncanbeactiveatatimeforeachM/E.
KalypsoEffectsAddressesValideffectsaddressesusedbyKalypsosystemsfortheWipePatterncommandaredefinedinTable49.
ZodiakEffectsAddressesValideffectsaddressesusedbyZodiaksystemsfortheWipePatterncommanddefinedinTable50.
Table48.
WipePatternCommandFunctionByteCountEffectsAddressCommandCodeMessageWipePattern03EXC8Wipe#Table49.
KalypsoEffectsAddresses-WipePatternCommandEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304PGM-PSTSecondaryPartitionaaNeweffectsaddressassignmentassociatedwithKalypso.
05Mix/Effects1SecondaryPartitiona06Mix/Effects2SecondaryPartitiona07Mix/Effects3SecondaryPartitionaTable50.
ZodiakEffectsAddresses-WipePatternCommandEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects364SwitcherProducts—ProtocolsManualSection2—EditorProtocolWipeNumbersWipenumbersrangefrom00Hto41H,correspondingtodecimalnumbers0through65.
TheformatoftheWipeNumberbyteisprovidedinTable51.
Thesevenleastsignificantbits(WWWWWWW)representthewipenumberinhexadecimal.
WhentheP/Sbitisa0,theeditorselectsaTransi-tionWipe1Pattern;however,whentheP/Sbitisa1,theeditorselectsaTransitionWipe2Pattern.
TheKeyerWipegeneratorsarenotaccessible.
02244123452244632547426485274962850729518305293153103254113355123456133557143658153759163860173961184062194163204264214365Table51.
WipeNumberByteFormatBit76543210P/SWWWWWWWTable52.
WipePatternNamesandHexadecimalNumbersWipePatternNameHexadecimalNumberWipePatternNameHexadecimalNumberWipePatternNameHexadecimalNumberVertical00HPOINTLT16H8PTSTAR–Large2CHT/LCorner01HSQUARE17H8PTSTAR–Small2DHPOINTDN02HCROSS18HSLITSCAN2EHCIRCLE03HVSAWTOOTH19HVZIGZAG2FHDIAGLT04HHSAWTOOTH1AHVSCAN30HTRIANGLE05H5PTSTAR1BHHX-CROSS31HCLOCK06HHEART1CHVX-CROSS32HARROW07HHSCAN1DHVSNOWFALL33HHEXAGON08HHSPLIT1EHHSNOWFALL34HSPIRAL09HB/LCORNER1FHVQUADSPIRAL35HHORIZONTAL0AHPOINTUP20HDIAGZIGZAG36HT/RCORNER0BHDIAMOND21HHQUADSPIRAL37HPOINTRT0CHDUALDIAGONAL22HT/BZIGZAG38HELLIPSE0DHDOUBLEHSAWTOOTH23HL/RZIGZAG39HDIAGRT0EHDOUBLEVSAWTOOTH24HCHECKERBOARD3AHPENTAGON0FH4X3RECTANGLE25HEXTERNAL3BHDUALCLOCK10HSMALLRANDOM26HUSER13CHDIAGONALCROSS11HLARGERRANDOM27HUSER23DHOCTAGON12H3PTSTAR28HUSER33EHHZIGZAG13H4PTSTAR29HUSER43FHVSPLIT14H6PTSTAR–Small2AHUSER540HB/RCORNER15H6PTSTAR–Large2BHUSER641HSwitcherProducts—ProtocolsManual65EditorCommandsTransitionMode(CA)CommandTheTransitionModecommandsetsupthemodeforthe"nexttransition"thatwilloccur.
KalypsoEffectsAddressesValideffectsaddressesusedbyKalypsosystemsfortheTransitionModecommandaredefinedinTable54.
ZodiakEffectsAddressesValideffectsaddressesusedbyZodiaksystemsfortheTransitionModecommanddefinedinTable55.
Table53.
TransitionModeCommandFunctionByteCountEffectsAddressCommandCodeMessageTransitionMode03EXCAModeTable54.
KalypsoEffectsAddresses-TransitionModeCommandEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304PGM-PSTSecondaryPartitionaaNeweffectsaddressassignmentassociatedwithKalypso.
05Mix/Effects1SecondaryPartitiona06Mix/Effects2SecondaryPartitiona07Mix/Effects3SecondaryPartitionaTable55.
ZodiakEffectsAddresses-TransitionModeCommandEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304DSKaaFunctionassociatedonlywithZodiak.
66SwitcherProducts—ProtocolsManualSection2—EditorProtocolModeByte—M/ETheformatoftheTransitionModebyteforanM/EasusedbybothKalypsoandZodiaksystemsisprovidedinTable56.
ModeByte—DSK(ZodiakOnly)TheformatoftheTransitionModebytefortheDSKasusedbyZodiaksystemsisprovidedinTable57.
Table56.
TransitionModeByteFormat–M/EBit765432100XXX0XXX1=KEY2on1=KEY1on1=BKGDon1=KeyPriorityon1=Key4onaaNewbitassignmentassociatedwithKalypsoandZodiak1=Key3onaTable57.
TransitionModeByteFormat–DSKBit765432100XXX0XXX1=DSK2on1=DSK1on1=BKGDon1=KeyPriorityon1=DSK3onaaNewbitassignmentassociatedwithZodiakSwitcherProducts—ProtocolsManual67EditorCommandsAutoandKeyTransitionRate(CCandCD)CommandsTheTransitionRatecommandssettheratesusedbytheswitchertoperformatransition.
Theycanalsocauseatransitiontotakeplacebysettingthe"executebit.
"The"nexttransition"whichwilloccurshouldhavebeenpreviouslyselected,eithermanuallyatthepanelorbysendingaTransitionModecommand.
Fivetransitionratesmaybesetintheswitcher:Autotransitionrate,Key1transitionrate,Key2transitionrate,Key3transitionrate,andKey4transitionrate.
Whichrateisuseddependson:The"nexttransition"whichhasbeenselected,andTheeffectsaddress.
Thetransitionratesthataresetdependontheeffectsaddressandthekeyerbitsintheunitsdigitoftheratedata.
TheeffectsaddressspecifieswhichM/E.
Thekeyerbitscontrolwhichofthekeyertransitionratesarealsoset.
TheAutoTransitionRatecommandisprimarilyintendedtosettheautotransitionratebutcanalsosettheKey1,2,3andKey4transitionrates.
Iftheexecutebitisset,theautotransitionwillbeperformed.
TheKeytransi-tionratecommandonlysetsKeytransitionrates.
PGM–PST/DSK(ZodiakOnly)OnZodiaksystems,thetransitionratedependsonthestateofthe"nexttransition".
IfthenexttransitionissetonlytoBackground,thentheautotransitionrateisused.
ifthenexttransitionissettoDSK1,DSK2,orDSK3,orallthree,thenthekeytransitionrateisused.
IfBackgroundandDSK1,DSK2,orDSK3isselected,thentheBackground(PGM–PST)transitionhasprecedenceovertheDSKtransitionandtheautotransitionrateisused.
Table58.
AutoandKeyTransitionRateCommandsFunctionByteCountEffectsAddressCommandCodeMessageAutoTransitionRate05EXCCHDTNUNKeyTransitionRate05EXCDHDTNUN68SwitcherProducts—ProtocolsManualSection2—EditorProtocolKalypsoEffectsAddressesValideffectsaddressesusedbyKalypsosystemsfortheAutoTransitionRatecommandaredefinedinTable59.
ZodiakEffectsAddressesValideffectsaddressesusedbyZodiaksystemsfortheAutoTransitionRatecommandaredefinedinTable60.
TransitionRateTransitionratesarespecifiedinnumbersofframes.
Totranslateatransitionrateinsecondstonumberofframes,usethefollowingformulae:NTSCFrameRate=(transitiontimeinseconds)x(30frames/second)PALFrameRate=(transitiontimeinseconds)x(25frames/second)Example:AfoursecondAUTOTRANwouldhaveaframerateof120framesintheNTSCstandard(4secondsx30frames/second=120frames).
ForthePALstandard,substitute25frames/secondtoarriveatframerateof100frames.
Table59.
KalypsoEffectsAddresses-AutoTransitionRateCommandEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304PGM-PSTSecondaryPartitionaaNeweffectsaddressassignmentassociatedwithKalypso.
05Mix/Effects1SecondaryPartitiona06Mix/Effects2SecondaryPartitiona07Mix/Effects3SecondaryPartitionaTable60.
ZodiakEffectsAddresses-AutoTransitionRateCommandEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304DSKaaFunctionassociatedonlywithZodiak.
SwitcherProducts—ProtocolsManual69EditorCommandsThecommandspecifiestheautotransitionrateintermsofframesrangingfrom000to999.
Specifytheautotransitionrateinthecommandbysup-plyingthreedatabytes:HD—ThehundredsdigitinBCD.
TheMSBisthe"execute"bit.
TN—ThetensdigitinBCD.
UN—TheunitsdigitinBCD.
ThefourMSBsarecontrolbitstoselectKey1,2,3andKey4ratesinadditiontotheautotransitionrate.
TheformatoftheHDbyteisprovidedinTable61.
TheformatoftheTNbyteisprovidedinTable62.
Table61.
HDByteFormatBit76543210X000XXXXCombinationof4bitsmakesHundredsdigitsRatevalueof0through9inBCD(0000to1001)0=Setrateonly,donotperformthetransition1=SetrateandperformtheautotransitionTable62.
TNByteFormatBit765432100000XXXXCombinationof4bitsmakesTensdigitsRatevalueof0through9inBCD(0000to1001)70SwitcherProducts—ProtocolsManualSection2—EditorProtocolTheformatoftheUNbyteisprovidedinTable63.
Table63.
UNByteFormatBitaaIfbits4,5,6and7aresetto1,orareallzero,thenallKeyrateswillbeset.
Ifbits4,5,6and7areallzero,commandCCwillsetnoKeyrates;commandCDwillsetallKeyrates.
76543210XXXXXXXXCombinationof4bitsmakesUnitsdigitsRatevalueof0through9inBCD(0000to1001)1=SetKey3/DSK3ratealsobbNewbitassignmentassociatedwithKalypsoandZodiak.
1=SetKey4ratealsob1=SetKey1/DSK1ratealso1=SetKey2/DSK2ratealsoSwitcherProducts—ProtocolsManual71EditorCommandsLearnandRecallE-MEMRegister(DAandDB)CommandsTheLearnE-MEMRegistercommandisacommandthatcausestheEffectsAddressstatedatainthespecifiedE-MEMregistertobestoredor"learned"intotheE-MEMregisterspecifiedintheModebyte.
ThiscommandhasthesameeffectasmanuallypressingtheLRNbuttonandthenselectinganE-MEMregisternumber(0through99).
ThecommandalsosupportslearninganEffectsDissolveintoaregister.
TheRecallE-MEMcommand,whensent,causesthestatedatainthespec-ifiedE-MEM(EffectsMemory)registertoberecalled,thuschangingthecurrentstateoftheswitchertothestoredsettingsforthegiveneffectsaddresses.
ThiscommandperformsthesameactionasmanuallyrecallinganE-MEMregisternumberof0through99.
Controlbitsmaybesettoforceorinhibittherecalloftheregisterasaneffectsdissolve.
Additionally,controlbitsmaybeusedtoforceorinhibittherunningofaneffectwhichcontainsmultiplekeyframes,andtherecalloflearnedenablespriortotherecalloftheregister.
NoteDonotsendthiscommandmorethanoncepervideoframe.
Alsonotethatanewrecallcommandreceivedbytheswitcherwilloverrideanyrecallthatisstillinprogressforaneffectsaddress.
Table64.
LearnandRecallE-MEMRegisterCommandsFunctionByteCountEffectsAddressCommandCodeMessageLearnE-MEMRegister04EXDAMode,RegisterNumber06FFDAMode,RegisterNumber,2-byteBit-Mask,4000Format06FEDAMode,RegisterNumber,2-byteBit-Mask,SwitcherFormatRecallE-MEMRegister04EXDBMode,RegisterNumber06FFDBMode,RegisterNumber,2-byteBit-Mask,4000Format06FEDBMode,RegisterNumber,2-byteBit-Mask,SwitcherFormat72SwitcherProducts—ProtocolsManualSection2—EditorProtocolKalypsoEffectsAddressesValideffectsaddressesusedbyKalypsosystemsfortheLearnandRecallE-MEMRegistercommandsaredefinedinTable65.
Table65.
KalypsoEffectsAddresses–LearnandRecallE-MEMRegisterCommandsEffectsAddressAssignmentEffectsAddressAssignmentAccessibleModel4000Code00PGM-PSTKalypsoCodeE0PGM-PSTSecondaryPartition01Mix/Effects1E1Mix/Effects1SecondaryPartition02Mix/Effects2E2Mix/Effects2SecondaryPartition03Mix/Effects3E3Mix/Effects3SecondaryPartition06MiscellaneousE5Miscellaneous107DPM1E6Miscellaneous20BAllenabledlevelsE7Miscellaneous3FFAllspecifiedlevelsintheBit-MaskaaTheeditormaylearn/recallaspecificEffectsAddressormaylearn/recallalllevelscurrentlyenabledonthecontrolpanel.
IftheEffectsAddressisFFthenthelevelstobelearned/recalledarespecifiedina4000type2-byteBit-Mask.
E8Miscellaneous4FEKalypsoBit-MaskbbNeweffectsaddressassignmentforKalypso,forusewithKalypsotype2-byteBit-Mask.
E9Miscellaneous5EAMiscellaneous6EBMiscellaneous7ECDPMEDStillStoreAEEStillStoreBEFStillStoreCSwitcherProducts—ProtocolsManual73EditorCommandsZodiakEffectsAddressesValideffectsaddressesusedbyZodiaksystemsfortheLearnandRecallE-MEMRegistercommandsaredefinedinTable66.
Toenablelevels,useC6orC7commands.
Forexample,toenabletheDSKlevelusethevaluesgiveninTable67.
LearnModeByteTheModebyteallowsanE-MEMlearnwithEffectsDissolve.
TheformatoftheLearnModebyteisprovidedinTable68.
Table66.
ZodiakEffectsAddresses–LearnandRecallE-MEMRegisterCommandsEffectsAddressAssignmentEffectsAddressAssignmentAccessibleModel4000Code00PGM-PSTZodiakCodeE5Miscellaneous101Mix/Effects1E6Miscellaneous202Mix/Effects2E7Miscellaneous303Mix/Effects3ECDPM04DSKaaNeweffectsaddressassignmentassociatedwithZodiak.
06Miscellaneous107DPM0BAllenabledlevelsFFAllspecifiedlevelsintheBit-MaskbbTheeditormaylearn/recallaspecificEffectsAddressormaylearn/recallalllevelscurrentlyenabledonthecontrolpanel.
IftheEffectsAddressisFFthenthelevelstobelearned/recalledarespecifiedina4000type2-byteBit-Mask.
FEZodiakBit-MaskccNeweffectsaddressassignmentforZodiak,forusewithZodiaktype2-byteBit-Mask.
Table67.
EnableLevelsFunctionByteCountExAddressCommandDataENABLEDSK04OBC60505Table68.
LearnModeByteFormatBitaaSettingBit6toonecausesanEffectsDissolvetoautomaticallyoccurwhenthespecifiedE-MEMreg-isterisrecalled.
765432100X0000001=LearnwithEffectsDissolve74SwitcherProducts—ProtocolsManualSection2—EditorProtocolRecallModeByteTheModebyteallowsanE-MEMrecallwithEffectsDissolve,AutoRecall,andRun,eitherseparatelyortogether.
TheModebytetakesprecedenceovertheSwitcherbuttontallies.
Themodebytelooksatfouroperations:ForcetheRun/AutoRecall/EffectsDissolve/SequenceoperationInhibittheRun/AutoRecall/EffectsDissolve/SequenceoperationOperateaccordingtocurrentSwitcherpanelsettingsTheformatoftheRecallModebyteisprovidedinTable69.
EffectsDissolve,Sequence,AutoRecall,andRuneachhaveaForcebitandanInhibitbit.
IftheForcebitison,theactionisperformedirrespectiveofthestateoftheswitcher.
IftheInhibitbitison,theactionisnotperformed,irrespectiveofthestateoftheswitcher.
Ifbothbitsareoff,thentheactionisperformedaccordingtotheswitcherstate,thatis,whathasbeenrecalledfromE-MEM,modifiedbythecurrentstateofthepanel.
(RefertoTable70.
)SettingBit5toonerecallsanE-MEMregisterandrunsanykeyframesstoredinthatregister.
ThishasthesameeffectaspushingtheAUTORUNpushbuttonandthenrecallinganE-MEMregisterfromthecontrolpanel.
SettingBit1toonerecallsanE-MEMwhichdoesnotrun,irrespectiveofthestateoftheAUTORUNbutton.
IfbothBits5and1aresettozero,thentheE-MEMisrecalledandwillrunonlyiftheAUTORUNbuttonison.
Table69.
RecallModeByteFormatBit76543210XXXXXXXX1=RecallE-MEMRegisterandInhibitAutoRecall1=RecallE-MEMRegisterandInhibitaRun1=RecallE-MEMRegisterandInhibitEffectsDissolve1=RecallE-MEMRegisterandInhibitSequence1=RecallE-MEMRegisterandForceAutoRecall1=RecallE-MEMRegisterandForceRun1=RecallE-MEMRegisterandForceEffectsDissolve1=RecallE-MEMRegisterandStartSequenceTable70.
Force/InhibitBitsForceInhibitAction10Performaction01Inhibitaction00Actaccordingtopanelstateandregistercontents11InvalidSwitcherProducts—ProtocolsManual75EditorCommandsSettingBit6toonerecallsanEffectsDissolveintoanE-MEMregister.
ThishasthesameeffectaspushingtheEFFDISpushbuttonandthenrecallinganE-MEMregisterfromthecontrolpanel.
SettingBit2preventstheEffectsdissolvefromtakingplaceirrespectiveofwhethertheeffectwaslearnedwithEffectsDissolveon,ortheEffectsDissolvebuttonwaspressedpriortosendingtheRecallE-MEMcommand.
IfbothBits6and2arezero,thentheEffectsDissolvewilloccuriftheeffectwaslearnedwithEffectsDissolveon,oriftheEffectsDissolvebuttonison(hasjustbeenpressed).
AutoRecalliscontrolledbythebitsinthesamemannerasAutoRun,describedabove.
ItispossibletocombineForcebitstoautomaticallyrunaregisterstartingwithaneffectsdissolveaftertheenabledlevelshavebeenrecalled.
RegistersValidE-MEMregistersare00through99(00H–63H).
TheformatoftheEffectsRegisterNumberbyteisprovidedinTable71.
4000Bit-MaskFormatThetwo-bytebitmaskallowstheeditortospecifyanycombinationofeffectsaddresses00through7FF.
TheLSB(bit0)representsthefirstaddress,andbit10representstheDPM4address.
Thetopbitsare"don'tcare.
"ThisisusedwiththeFFEffectsAddress.
Table71.
EffectsRegisterNumberByteFormatBit765432100XXXXXXXCombinationof7bitsmakesvaluesusedforEffectsRegister00H–63H76SwitcherProducts—ProtocolsManualSection2—EditorProtocolKalypsoBit-MaskFormatThetwo-bytebitmaskusedbyKalypsosystemsallowstheeditortospecifyanycombinationofeffectsaddresses00through7FFF.
TheLSB(bit0)rep-resentsthefirstaddress,andbit15representstheStillStoreCaddress.
The4bitis"don'tcare.
"ThisformatisusedwiththeFEEffectsAddress.
Table72.
4000TypeEffectsAddressesByteFormatBit1514131211109876543210PGM-PSTMixMix/Effects1Mix/Effects2Mix/Effects3DSK(ZodiakOnly)Miscellaneous(MISC)DPM1Table73.
KalypsoEffectsAddressesByteFormatBit1514131211109876543210XPGM-PSTMixMix/Effects1Mix/Effects2Mix/Effects3Miscellaneous(MISC)1Miscellaneous(MISC)2Miscellaneous(MISC)3Miscellaneous(MISC)4Miscellaneous(MISC)5Miscellaneous(MISC)6Miscellaneous(MISC)7DPMStillStoreAStillStoreBStillStoreCSwitcherProducts—ProtocolsManual77EditorCommandsZodiakBit-MaskFormatThetwo-bytebitmaskallowstheeditortospecifyanycombinationofeffectsaddresses00through7FF.
TheLSB(bit0)representsthefirstaddress,andbit10representstheDPM4address.
Thetopbitsare"don'tcare.
"ThisformatisusedwiththeFEEffectsAddress.
Table74.
ZodiakEffectsAddressesByteFormatBit1514131211109876543210PGM-PSTMixMix/Effects1Mix/Effects2Mix/Effects3DSKMiscellaneous(MISC)DPM78SwitcherProducts—ProtocolsManualSection2—EditorProtocolSaveandLoadData(5FandDF)CommandsAneditormayrequesttheswitchertosaveanE-MEMregistertoadiskfileontheswitcherusingaspecifiedfilename.
AtalatertimetheeditormayrequestthatthediskfilebeloadedtoaspecifiedE-MEMregister.
Thereisaseparatemessagetypeforeachoftheseoperations.
ThemessagespecifiestheE-MEMregisternumberandanoptionfieldfollowedbyanulltermi-natedtextfilename.
TheeffectsaddressspecifieswhetherE-MEMdataorconfiguration(eithersuiteprefsoruserprefs)aresavedorloaded.
An"Ack"isreturnedifavalidcommandisreceived.
UseStatusRequestCommand(6D)todetermineifthefileoperationissuccessful.
EffectsAddressesValideffectsaddressesfortheSaveandLoadDatacommandsdefinedinTable76arenew.
RegNumberThevalueinthisbyteisaregisternumberfrom0to99(decimal).
NameThenameisanullterminatedstringfrom1to250byteslongthatspecifyapathnamefortheE-MEMfiletobeloadedorsaved.
Thenamespecifiedisappendedtothestring"C:\EMEM\"toformthecompletepathname.
Iftheeditorsuppliesnoname(asinglezerobyte)theEditorprotocolusesadefaultnameof"EDITOR",sothatthecompletepathnameontheswitcheris"C:\EMEM\EDITOR".
Thefilenameisautomaticallygeneratedbytheswitcherandisoftheform"REGnnn.
EMM",wherennnisthedecimalregisternumber.
Table75.
SaveandLoadDataCommandsFunctionByteCountEffectsAddressCommandCodeMessageSaveData06HtoFFHEX5FRegNumber,Opt(2bytes),Name(upto250bytes)LoadData06HtoFFHEXDFRegNumber,Opt(2bytes),Name(upto250bytes)Table76.
EffectsAddresses-SaveandLoadDataCommandsEffectsAddressAssignmentByteFormatReferenceSaveOptionLoadOption0BAllE-MEMLevelsTable77Table831BSourceMemTable78Table841CRMemTable79Table851DSystemConfigTable80Table861ESuitePrefsTable81Table871FUserPrefsTable82Table88SwitcherProducts—ProtocolsManual79EditorCommandsExamples090B5F00000041424300MakesKalypsosaveE-MEMregister0tothefollowingfile:"C"\EMEM\ABC\REG000.
EMM"090BDF63000041424300MakesKalypsoloadthefollowingfiletoE-MEMregister99:"C"\EMEM\ABC\REG099.
EMM"060B5F010000MakesKalypsosavetoE-MEMregister1thefollowingfile:"C"\EMEM\EDITOR\REG001.
EMM"80SwitcherProducts—ProtocolsManualSection2—EditorProtocolSaveOptionByteFormatsTable77.
E-MEM(0B)Bit151413121110987654321000000000000000XX1=Don'tOverwrite;0=ForceOverwrite1=AllLevelsLearned;0=AllLevelsEnabledTable78.
SourceMem(1B)Bit1514131211109876543210000000000000000X1=Don'tOverwrite;0=ForceOverwriteTable79.
RMem(1C)Bit1514131211109876543210000000000000000X1=Don'tOverwrite;0=ForceOverwriteTable80.
SystemConfig(1D)Bit1514131211109876543210000000000000000X1=Don'tOverwrite;0=ForceOverwriteTable81.
SuitePrefs(1E)Bit1514131211109876543210000000000000000X1=Don'tOverwrite;0=ForceOverwriteTable82.
UserPrefs(1F)Bit1514131211109876543210000000000000000X1=Don'tOverwrite;0=ForceOverwriteSwitcherProducts—ProtocolsManual81EditorCommandsLoadOptionByteFormatsTable83.
E-MEM(0B)Bit151413121110987654321000000000000000XX0=Load;1=RecallafterLoad1=AllLevelsLearned;0=AllLevelsEnabledTable84.
SourceMem(1B)Bit15141312111098765432100000000000000000Table85.
RMem(1C)Bit15141312111098765432100000000000000000Table86.
SystemConfig(1D)Bit15141312111098765432100000000000000000Table87.
SuitePrefs(1E)Bit151413121110987654321000000000000XXXX0Opt1NoOptionsarecurrentlydefined.
Opt2Opt3Opt4Table88.
UserPrefs(1F)Bit151413121110987654321000000000000XXXX0Opt1NoOptionsarecurrentlydefined.
Opt2Opt3Opt482SwitcherProducts—ProtocolsManualSection2—EditorProtocolSaveandLoadStatus(6DandED)CommandsTheswitcherwillrespondwithaStatusResponsemessageonreceiptofaStatusRequestcommand.
Thestatuscodereflectsthecurrentstateoffileoperations.
EffectsAddressesValideffectsaddressesfortheSaveandLoadStatuscommandaredefinedinTable90.
(ThisisnewcodegeneratedforKalypsoandZodiaksystems.
)StatusMessageValidStatuscodefortheSaveandLoadcommandsaredefinedinTable91.
(ThisisnewcodegeneratedforKalypsoandZodiaksystems.
)Table89.
SaveandLoadStatusCommandsFunctionByteCountEffectsAddressCommandCodeMessageStatusRequest02EX6DNoneStatusResponse04EXEDStatus(2bytes)Table90.
EffectsAddresses-SaveandLoadStatusCommandEffectsAddressAssignment0BAllE-MEMLevels1BSourceMem1CRMem1DSystemConfig1ESuitePrefs1FUserPrefsTable91.
StatusCodes-SaveandLoadStatusMessage0Idle1Error2Loading3SavingSwitcherProducts—ProtocolsManual83EditorCommandsTimelineControl(4E,4F,CE,andCF)CommandsTheTimelineControlcommandsallowtheeditortomanipulateaspecifiedeffect'stimeline.
Thecontrollingdevicemayreadthecurrentposition,writeanewposition,ortrimthecurrentpositionbyaspecifiedamount.
Allpositionsortrimsaremeasuredasafieldcount.
Theswitcher'sresponsetotheReadTimelinecommandistheSetTimelinecommand.
FunctionKalypsoEffectsAddressesValideffectsaddressesusedbyKalypsosystemsfortheTimelineControlcommandsaredefinedinTable65.
Table92.
TimelineControlCommandsByteCountEffectsAddressCommandCodeMessageReadTimelineTime(1)02EX4ENoneSetTimelineTime(2)06EXCE4bytevalue08FFCEValue+2bytebitmask08FECEValue+2bytebitmaskKalypsoformatTrimTimelineTime(2)06EXCF4bytevalue08FFCFTrimvalue+2bytebitmask08FECFTrimvalue+2bytebitmaskKalypsoformatRunTimeline(2)06EX4F4bytevalue08FF4FSpeedvalue+2bytebitmask08FE4FSpeedvalue+2bytebitmaskKalypsoformatTable93.
KalypsoEffectsAddresses–TimelineControlcommandsEffectsAddressAssignmentEffectsAddressAssignmentAccessibleModel4000Code00PGM-PSTKalypsoCodeE0PGM-PSTSecondaryPartition01Mix/Effects1E1Mix/Effects1SecondaryPartition02Mix/Effects2E2Mix/Effects2SecondaryPartition03Mix/Effects3E3Mix/Effects3SecondaryPartition06MiscellaneousE5Miscellaneous107DPM1E6Miscellaneous20BMasterTimeline(allenabledlevels)E7Miscellaneous3FFAllspecifiedlevelsintheBit-MaskaaUsethe4000style2-byteBit-Mask,E8Miscellaneous4FEKalypsoBit-MaskbbNeweffectsaddressassignmentassociatedwithKalypsotype2-byteBit-Mask.
E9Miscellaneous5EAMiscellaneous6EBMiscellaneous7ECDPMEDStillStoreAEEStillStoreBEFStillStoreC84SwitcherProducts—ProtocolsManualSection2—EditorProtocol4000Bit-MaskFormatThetwo-bytebitmaskallowstheeditortospecifyanycombinationofeffectsaddresses00through7FF.
TheLSB(bit0)representsthefirstaddress,andbit10representstheDPM4address.
Thetopbitsare"don'tcare.
"ThisformatisusedwiththeFFEffectsAddress.
KalypsoBit-MaskFormatThetwo-bytebitmaskusedbyKalypsosystemsallowstheeditortospecifyanycombinationofeffectsaddresses00through7FFF.
TheLSB(bit0)rep-Table94.
4000TypeEffectsAddresses-ByteFormatBit1514131211109876543210PGM-PSTMix/Effects1Mix/Effects2Mix/Effects3DSK(ZodiakOnly)Miscellaneous(MISC)DPM1SwitcherProducts—ProtocolsManual85EditorCommandsresentsthefirstaddress,andbit14representstheStillStoreCaddress.
The4bitis"don'tcare.
"ThisformatisusedwiththeFEEffectsAddress.
ZodiakBit-MaskFormatThetwo-bytebitmaskusedbyZodiaksystemsallowstheeditortospecifyanycombinationofeffectsaddresses00through7FFF.
TheLSB(bit0)rep-Table95.
KalypsoEffectsAddresses-ByteFormatBit1514131211109876543210PGM-PSTMixMix/Effects1Mix/Effects2Mix/Effects3Miscellaneous(MISC)1Miscellaneous(MISC)2Miscellaneous(MISC)3Miscellaneous(MISC)4Miscellaneous(MISC)5Miscellaneous(MISC)6Miscellaneous(MISC)7DPMStillStoreAStillStoreBStillStoreC86SwitcherProducts—ProtocolsManualSection2—EditorProtocolresentsthefirstaddress,andbit12representstheDPMaddress.
ThisformatisusedwiththeFEEffectsAddress.
DataFieldFormatAlltimedata(fieldcount)andspeeddataisspecifiedtobebinarydatainS15.
16format.
Thelowertwobytesspecifyafractionalfieldvalue.
Thetopmostbitisthesignbitandthenext15bitsrepresentwholefieldvalues.
Notethefollowingexamples.
+1field:00010000–1field:FFFF0000+1(unity)speed:00010000–1/2speed:FFFF8000SettingtheRunTimeforaspeedofzeroisthesameassendingaSTOPcom-mand.
Theeditorisallowedtowriteanegativefieldcountortotriminanegativedirectionwhichresultsinanegativefieldcount.
Ineithercasetheresultistodisplayanegativetimecodeinthemenuandpositionthevideoatthe1stTable96.
ZodiakEffectsAddressesByteFormatBit1514131211109876543210PGM-PSTMixMix/Effects1Mix/Effects2Mix/Effects3DSKMiscellaneous(MISC)1Miscellaneous(MISC)2Miscellaneous(MISC)3DPMSwitcherProducts—ProtocolsManual87EditorCommandskeyframe.
Thevideowillremainatthatpositionuntiloneofthefollowingoccurs:TheeffectrunslongenoughforthefieldcounttopasszeroTheeditorsuccessivelytrimsthefieldcountinapositivedirectionuntilzeroispassedTheeditorwritesapositive,non-zerofieldcounttotheswitcherNoteKalypsoandZodiakcurrentlyignorethespeedparameterintheTimelineRuncommand.
Runalwayscausestheeffecttorunat+100%speed.
Examples080CCFFFFF00000780==>TrimallDPMlevelsby–1field.
080CCE001E0000000E==>Setthe3M/Esto30fields.
080C4F00010000000E==>Runtheeffectsforall3M/Es.
88SwitcherProducts—ProtocolsManualSection2—EditorProtocolAllStop(F2)CommandTheALLSTOPcommandisissuedtosetalloraspecificpartoftheswitchertoaknownstate.
Thecommandcausesthefollowingfunctionstooccur:AnyongoingKEYMIXisstopped,AnongoingAUTOTRAN(Transition)isstopped,AnongoingEFFDIS(EffectsDissolve)isstopped,AnongoingSEQ(Sequence)isstopped,Theleverarmsaresettoalimit,ThetransitiontypeissettoMIX,ThetransitionmodeissettoBKGD,AllKeysareremoved,StopEffectRun,andTheSourceselectionsremainunchanged.
KalypsoEffectsAddressesValideffectsaddressesusedbyKalypsosystemsfortheAllStopcommandaredefinedinTable98.
Table97.
AllStopCommandFunctionByteCountEffectsAddressCommandCodeMessageWrite03EXF2FFTable98.
KalypsoEffectsAddresses-AllStopCommandEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304PGM-PSTSecondaryPartitionaaNeweffectsaddressassignmentassociatedwithKalypso.
05Mix/Effects1SecondaryPartitiona06Mix/Effects2SecondaryPartitiona07Mix/Effects3SecondaryPartitiona0BAllLevelsSwitcherProducts—ProtocolsManual89EditorCommandsZodiakEffectsAddressesValideffectsaddressesusedbyZodiaksystemsfortheAllStopcommandaredefinedinTable99.
Table99.
ZodiakEffectsAddresses-AllStopCommandEffectsAddressAssignment00PGM-PST01Mix/Effects102Mix/Effects203Mix/Effects304DSK0BAllLevels90SwitcherProducts—ProtocolsManualSection2—EditorProtocolSoftwareVersion(6CandEC)CommandsTheswitcherwillrespondwithaSoftwareVersionResponsemessageonreceiptofaRequestSoftwareVersioncommand.
Theresponsewillbereturnedtwofieldsaftertherequestisreceived.
TheVersionstringisASCIITextoftheformat:.
.
,e.
g.
,2.
0.
0B19EffectsAddressThevalidEffectsAddressfortheSoftwareVersioncommandisdefinedinTable101.
ModelNumberModelnumbersareasdefinedinTable102.
VersionNumberThesoftwareVersionnumbercomprisesaMajorVersionnumber,aMinorVersionnumber,andtwofix-levelparameters.
TheMajorVersionandTable100.
SoftwareVersionCommandsFunctionByteCountEffectsAddressCommandCodeMessageRequestSoftwareVersion02EX6CNoneSoftwareVersionResponse04HtoFFhEXECModelnumber,versionstringTable101.
EffectsAddress-SoftwareVersionCommandEffectsAddressAssignment00PGM-PSTTable102.
ModelNumbersModelNumberMeaning013000-2023000-3034000-2A044000-2B054000-3062200-2072200-2i08Kalypso3-M/E+PP09Kalypso2-M/E+PP0AKalypso1-M/E+PP0BKalypso0-M/E+PP0CZodiak2.
5-M/E0DZodiak3-M/ESwitcherProducts—ProtocolsManual91EditorCommandsMinorVersionareeachrepresentedasatwo-byteASCIIcharacter,andthetwofix-levelparametersareeachrepresentedasaone-byteASCIIchar-acter.
SwitcherModelFeaturesThefollowingisabriefsummaryofthefeaturesassociatedwiththevariousswitchermodels.
Table103.
SwitcherModelSummaryModelSelectButtonsInputs/SourcesM/EsPGM-PST/DSKOther3000-21664inputs2YesComposite3000-32434000-2B162Component4000-2A242Component,layeredmodeonDSK4000-3243Component2200-2162No2200-2i162Component,KrystalcontrolKalypso3-M/E+PP(Kalypso4-M/E)32128sources3Yes/NoComponentKalypso2-M/E+PPTBD2Kalypso1-M/E+PP(Kalypso2-M/E)241Kalypso0-M/E+PPTBD0Zodiak2.
5-M/E242.
5Yes/YesZodiak3-M/E24392SwitcherProducts—ProtocolsManualSection2—EditorProtocolSwitcherProducts—ProtocolsManual93Section3PeripheralBusIIProtocolIntroductionThissectiondescribesthePeripheralBusII(PBusII)serialprotocolandrelatedcommands,whichcanbeusedtoallowamaster(controlling)devicetocontrolexternal(controlled)devicesthatsupporttheprotocol.
ControllingdevicesabletousethePeripheralBusIIprotocolincludetheKalypsoVideoProductionCenterandtheZodiakDigitalProductionSwitcher.
Inthissectionthesedevicesarereferredtobythegenericterm"switcher".
EarlierGrassValleyGroupswitchers(Model200,250,3000,4000,and2200)alsousethePeripheralBusIIprotocol,actingascontrollingdevices.
However,someveryearlyGrassValleyGroupswitchers(Model300,1600/1680)useadifferentprotocol(calledthePeripheralprotocol),whichisincompatiblewiththePeripheralBusIIprotocoldescribedhere.
Programmingacontrolleddevicetocommunicateproperlywiththeswitcherrequiresathoroughunderstandingoftheprotocolandtheavail-ablecommands.
Controlleddevicesmaybeprogrammedtosupportdif-ferentsetsoftheavailablePBusIIcommands.
OverviewSystemDescriptionThePeripheralBusIIsystemconsistsofasinglecontrollingdevice(theswitcher)andupto24peripheralcontrolleddevicesconnectedtoaserialbus(Figure7).
Thecontrollingdevicecommunicateswithcontrolleddevicesviaaserialconnection.
Alldevicesonthebusmustoperateatthesamebaudrate,parity,andcommunicationstandard(RS-485).
94SwitcherProducts—ProtocolsManualSection3—PeripheralBusIIProtocolFigure7.
PeripheralBusSystemBlockDiagramExampleE-MEMSystemInteraction(Learns,Recalls)Theswitchercanbesettoaddressaparticularcontrolleddevice,suchasacharactergenerator,duringE-MEMlearnsandrecalls.
WhenaswitchereffectislearnedintoanE-MEMregister,theswitchersendsacommandovertheperipheralbustothecontrolleddevicetellingittolearnitscurrentstatusintoamemoryregisterofitsown.
Later,whenthesameswitcherE-MEMregisterisrecalled,theswitcherwillsendacommandovertheperipheralbustoinstructthecontrolleddevicetorecalltheeffectthatitpreviouslyhadstoredinitsmemory.
Thecontrolleddeviceshouldstorethelearnedinformationinnonvolatilememory.
Theswitcherdoesnotkeeptrackofwhathasbeenlearnedonthecontrolleddevice,anddoesnotaskforcontrolleddevicelearnorrecallinformation.
Forkeyframedeffectsinacontrolleddevice(likeaDPM),learningthecurrentstatusmaynotbesufficient.
Inthiscase,thecontrolleddeviceshouldassociateitscurrenteffectnumberwiththeregisternumbersentinSerialPortXMITRCVControllingDevice(Switcher)XMITRCVXMITRCV8063_02_05_r3Peripherial0VTRPeripheralDeviceVideoOutputstoSwitcherVideoInputsControlledDevicesNOTE:ControllingDeviceRCVandControlledDeviceXMITareonlyusedforRead,Write,andQueryCommands,whicharenotusedbyKalypsoorZodiaksystems.
RS-485PeripheralBusPeripherial1CharGenXMITRCVXMITRCVPeripherial22DPMPeripherial23StillStoreSerialPortSerialPortSerialPortSerialPortSwitcherProducts—ProtocolsManual95OverviewtheLearncommand.
WhenaRecallcommandisreceived,thecontrolleddeviceshouldlookuptheeffectthatwasactiveatthetimeandrecallthateffect.
Forexample,ifthecontrollingdevicesendsalearn5commandandthecontrolleddevice'scurrenteffectis37,thenwhenthecontrollingdevicesendsarecall5command,thecontrolleddeviceshouldrecallitseffect37.
ThecrossreferencebetweenPBusIIregisternumbersandthecontrolleddevice'seffectnumbershouldberetainedinnonvolatilememoryandsomeprovisionforsavingthisinformationtodiskfortransporttoanothersystemshouldbeprovided.
GrassValleyGroupswitchersusePBusIIeffectnumbers0through99,cor-respondingtotheswitcher'sE-MEMregisternumbers0through99.
Thecontrolleddevicemustprovidestorageforall100PBusIIeffectnumberswheninterfacingtoaGrassValleyGroupswitcher.
GrassValleyGroupswitchersneversendlearnorrecallcommandsforregisternumbersabove99(0x63).
Somecontrolleddevices(e.
g.
,Kaleidoscope)runeffecttimelinesaspartoftheRecallcommand.
Wedonotrecommendthispractice,oratleastsug-gestsauserpreferencebeavailableonthecontrolleddevicetocontrolrunningtheeffectonRecall.
Ingeneral,thecontrolleddeviceshouldfirstrecallaneffectandpreparetorunitwhenaRecallisreceived.
ATriggershouldthenbeemployedtocausetheeffecttorun.
TriggerInteractionsTheswitchercanalsobesettosendtriggerstocontrolleddevicesovertheperipheralbus.
TriggersactlikeGPIs.
Theycantriggeranycontrolleddevicefunctionthathasbeenprogrammedforcontrolviatheperipheralbus.
Theswitchercansendatriggertoacontrolleddevicewhenitrecallsaneffect(thetriggerisonthefirstkeyframe),orthetriggercanbeplacedanywhereontheswitchereffect'stimelinetosendtriggersduringtherunningofaneffect.
Itisimportanttounderstandthepurposeoftriggersrelativetorecalls.
AperipheralbusRecallcanbesentwhenthecontrollingdevicerecallsoneofitseffects.
TheRecallinstructsthecontrolleddevicetorecallanappropriateeffectorreturntoaspecificstate.
Triggersareintendedtocausesomeactivitytooccurwithinthecontrolleddevice.
Anexampleofusingrecallsandtriggersishavingacontrolleddevicethatfeedsvideototheswitcherselectanoutputsignalwhenaspecificswitchereffectisrecalled(aRecallcommandissentouttheperipheralbus),andthenchangeitsoutputatspecifictimeswhentheswitcherrunstheeffect(sendTriggercommandsatspecifickeyframes).
ThePeripheralBusIIprotocoldoesnotdefineorrecommendwhichfunc-tionisassociatedwithaspecifictriggernumber.
ItisrecommendedthataDigitalVideoEffectssystemimplementRun,Rewind,andStoptriggersat96SwitcherProducts—ProtocolsManualSection3—PeripheralBusIIProtocolminimum.
ADigitalDiskRecordershouldimplementPlay,StopandCueatminimum,anduseRecallcommandstoloadclips.
CommandTimingandFrameAccuracyItispossibletousethePeripheralBusIIprotocolforframeaccuratecontrol,butthisisnotguaranteedunderallconditions.
PBusIIusesaserialinter-connectandthecommandsarelong.
Itispossibletosaturatetheseriallinkwithcommandsespeciallyatlowerbaudrates,makingthelinknon-deter-ministic.
Forexample,arecallcommandis11characters.
At9600baudthissupportsonly16charactersperfield,sufficientforonlyonecommandperfield.
At38.
4Kb,thereislinkbandwidthtosupport64charactersperfield,enoughtosendthreerecallandthreetriggercommands.
Itistheresponsibilityofthecontrollingdevicetooutputcommandsatanappropriatetimesothecontrolleddevicescanrespondinsyncwithotheractivitiesofthesystem.
Thecontrollingdeviceshouldprovideandspecifydeterministicresponsestotriggersandrecalls.
ProtocolDescriptionThePeripheralBusIIprotocolprovidesameansfororderlycommunica-tionbyacontrollingdevicetoupto24peripheralcontrolleddevicesonaserialdatabus.
HardwareInterfaceCommunicationsfollowtheRS-485standardat9.
6,19.
2,38.
4k,56.
7,76.
8Kb,or115.
2KBaudwitheven,odd,ornoparity.
RS-485isaderivativeofRS-422thatspecifiescontrolleddevicesmustdisabletheirtransmitdriverswhennotsendinginformation.
Thisisrequiredbecauseallcontrolleddevicesshareacommonconnection(Figure7onpage94).
RS-422maybeusedinsteadofRS-485onlyifasinglelineisconnectedfromthecontrollingdevice'stransmittertoallthecontrolleddevices'receiversandthecontrolleddevices'transmitterlinesarecompletelydisconnected.
Thisconfigurationpreventsthecontrollingdevicefromreceivinginforma-tionfromthecontrolleddevices.
ThisdisruptsRead,Write,andQueryfunctions,butthesecommandsarenotsentbyKalypsoorZodiaksystems(ofGrassValleyGroupswitchers,onlytheModel200/250usesthesecom-mands).
Alldevicesconnectedtotheperipheralbusmustbesettoexactlythesamecommunicationsstandard.
Therecommendedsettingsare38.
Kbaudandnoparity.
SwitcherProducts—ProtocolsManual97ProtocolDescriptionCommandStructureThePeripheralBusIIprotocolincludessixtypesofmessages:ThreeareessentialforafullyfunctionalPBusIIinterface,andthreeareoptional.
Learn,Recall,Trigger,Query(optional)Read(optional),andWrite(optional).
TheperipheralinterfacecommandsethasbeenconstructedfromASCIIcharacters.
Thispermitsthecommandstobedisplayedonaconventionalcomputerterminal.
Additionally,theASCIIcharactersusedforcommandcodesaredifferentfromthoseusedfordatainordertosimplifythecon-trolleddevicesoftwareandhelppreventcodingerrors.
Eachmessagesentoutontheperipheralbushasathreepartformat.
AuniqueASCIIcharacterservingasakeywordissentfirst,additionaldatafollows,andfinallyacarriagereturnterminatesthemessage.
Inordertoeliminateproblemscausedbyinterleavingspacesandlinefeedsthatmayhavebeeninsertedforreadability,thosecharactersareignoredinmessageparsingbyboththecontrollingandcontrolleddevices.
Twenty-threeASCIIcharacterscomprisethecompletesetofcharactersavailable.
SevenASCIIcharactersrepresentkeywords,and16charactersrepresentdata(Table104).
Table104.
PeripheralBusIIASCIICharactersCategoryCharacterHexDescriptionKeywordL4CLearnR52RecallT54TriggerQ51QueryS53ReadW57WriteandReadResponse0DEndorMessageData1-930-39A-F41-4698SwitcherProducts—ProtocolsManualSection3—PeripheralBusIIProtocolControlledDeviceIdentificationBecausethecontrollingdevicecommunicateswithmultiplecontrolleddevices,amechanismisrequiredtospecifywhichdeviceaparticularcommandisintendedfor.
Itisalsodesirabletobeabletosendthesamecommandtomultipledevicessimultaneously.
PBusIIcommandsemployasix-bytefieldofASCIIcharacters(dddddd)representingsixhexnumberstospecifywhichcontrolleddevicesaretoreceivethecommand.
Thesixhexnumbersrepresentabinary24bitmap.
Asetbit(1)inthemapmeansthecontrolleddeviceassignedtothatbitnumberisincluded,anda(0)bitmeansthecontrolleddeviceisnotincluded(seeFigure8).
Figure8.
ControlledDeviceSelectionDataInterpretation8063_02_06_r2DecimalControlledDeviceNumbers0-23BinaryMapIndicatingWhichoftheDevicesAreSelectedHexadecimalNumbersEquivalenttoBindaryMapNumbers6-ByteASCIICharacterFieldEquivalenttoHexadecimalNumbersIdentifyingSelectedDevices232221201110E4519181716010043415141312001023211109800000307654000113132101000838SwitcherProducts—ProtocolsManual99CommandsCommandsNoteTheKalypsoandZodiaksystemsusetheLearn,Recall,andTriggercom-mands.
TheQuery,Read,andWritecommandsandresponsesarenotusedbythesesystems,butcommanddescriptionsforthemareincludedinthisdocumentforcompleteness.
LearnCommandThecontrollingdevicesendsaLearncommandtoaselectedcontrolleddevicetocausethecontrolleddeviceto"learn"itscurrentstatusormul-tiplekeyframeeffect.
Thecontrolleddevice'sresponsetotheLearncommandshouldbetostoreinitsownmemorywhateverdataisneededinorderforittorecallitscurrentsetupatsomelatertime.
Nofurtherresponsefromthecontrolleddeviceisrequired.
TheformatoftheLearncommandis:LddddddrrrThefirstbyteistheASCIIkeywordforLearn,L(4CH).
Nextasix-bytefieldofASCIIcharacters(dddddd)actsasabitmapthatidentifieswhichcontrolleddevicesareincludedintheLearn(seeFigure8onpage98).
Nextthecontrollingdevicesendsathree-bytefieldofASCIIcharacters(rrr)representingahexnumberthatidentifiesthehexregisternumber(000H-FFFH)fromwhichthecontrollingdevicewillrecallthelearnedeffect.
Acarriagereturnendsthemessage.
100SwitcherProducts—ProtocolsManualSection3—PeripheralBusIIProtocolRecallCommandThecontrollingdevicesendsaRecallcommandtoaselectedcontrolleddevicetocausethecontrolleddeviceto"recall"apreviouslystoredeffect.
ThecontrollingdevicewouldsendtheRecallcommandsometimeinadvanceoftheverticalintervalinwhichthecontrollingdevicewillactuallyperformtheRecall.
Thecontrolleddevice'sresponsetotheRecallcommandshouldbetorecallfromitsownmemorythespecifiedeffect.
Nofurtherresponsefromthecontrolleddeviceisrequired.
TheformatforaRecallcommandis:RddddddrrrThefirstbyteistheASCIIkeywordforRecall,R(52H).
Nextasix-bytefieldofASCIIcharacters(dddddd)actsasabitmapthatidentifieswhichcontrolleddevicesareincludedintheRecall(seeFigure8onpage98).
Nextthecontrollingdevicesendsathree-bytefieldofASCIIcharacters(rrr)representingahexnumberthatidentifiesthehexregisternumberfromwhichthecontrollingdevicewillrecallthelearnedeffect(000H-FFFH).
Acarriagereturnendsthemessage.
SwitcherProducts—ProtocolsManual101CommandsTriggerCommandThecontrollingdevicesendsaTriggercommandtoaselectedcontrolleddevicetocausethecontrolleddevicetolunchorrunaneventwhichhaspreviouslybeenreadied.
Anexampleofthisisaninterfacetoacharactergeneratorwhereadiskread,whoseexecutiontimeisunpredictable,recallsthetextofacreditrollsequence.
ThiseventisthenfollowedbyapreciselytimedTriggercommandwhichcausesthecreditrolltobegin.
TheTriggercommandwouldbesenteitheraspartofaregisterrecall,whenatriggerkeyframeisencounteredonaneffecttimeline,orastheresultofsomemanualoperationonthepanel.
WheninvokedaspartofaRecallcommand,theTriggercommandissenttotheselectedcontrolleddevicepriortotheverticalintervalinwhichthecontrollingdevicewillactuallyperformtheRecall.
Noresponsetothemessageisrequiredofthecontrolleddeviceotherthantolaunchthedesiredevent.
TheformatforaTriggercommandis:TddddddgThefirstbyteistheASCIIkeywordforTrigger,T(54H).
Nextasix-bytefieldofASCIIcharacters(dddddd)actsasabitmapthatidentifieswhichcontrolleddevicesareincludedintheTrigger(seeFigure8onpage98).
NextthecontrollingdevicesendstheASCIIcharacter(g)representingahexnumberthatcorrespondstothecontrolleddevicefunctionwhichthecontrollingdevicewantsthecontrolleddevicetolaunch(0H-FH).
Acarriagereturnendsthemessage.
102SwitcherProducts—ProtocolsManualSection3—PeripheralBusIIProtocolQueryCommandThecontrollingdevicesendsaQuerycommandtotheselectedcontrolleddevicetodeterminewhetheritisconnectedtothebusandoperating.
TheselectedcontrolleddeviceshouldreturnaQueryresponsewithinfour(4)televisionfields.
Ifnoresponseisreceivedwithinthattime,thecontrollingdevicewillassumethatthecontrolleddeviceisnotconnectedorisunabletoanswerduetominimumimplementationoftheprotocol.
TheformatoftheQuerycommandis:QddThefirstbyteistheASCIIkeywordforQuery,Q(51H).
Nextatwo-bytefieldofASCIIcharacters(dd)representingahexnumberissentthatcorrespondstothecontrolleddevicenumber(00H-17H).
Acarriagereturnendsthemessage.
QueryResponseAcontrolleddevicesendsaQueryresponsetothecontrollingdeviceinresponsetoaQuery.
TheQueryresponsemustbereturnedwithinfour(4)televisionfields,otherwisethecontrollingdevicewillassumethatthecon-trolleddeviceisnotthereorisnotcapableofresponding.
InordertoprovidetheQueryresponse,thecontrolleddevicemustenableitsRS-485drivers,transmittheresponse,andthendisableitsdrivers.
Itisessentialthatthecontrolleddevicedothiscleanly,withthedriverenabledonlylongenoughtotransmitthemessage.
Itisalsoveryimportantthatthecontrolleddeviceleaveitsdriversdisabledatallothertimes.
TheformatfortheQueryResponseis:Q[devicetype]ThefirstbyteistheASCIIkeywordforQuery,Q(51H),thesameastheQuerycommand.
NextanASCIIalphanumericfieldofupto16charactersissent.
Thesecharacters,whicharetreatedasrawdata,identifythedevice.
Forexample,"GVGHORBUS35"indicatesaGrassValleyGroupHorizonroutingswitcherbusnumber35.
Acarriagereturnendsthemessage.
SwitcherProducts—ProtocolsManual103CommandsReadCommandThecontrollingdevicesendsaReadcommandtoaselectedcontrolleddevicetorequestthecontentsofthecontrolleddevice'sregister.
Thecon-trolleddevicerespondswithaWriteresponse(seepage104).
Ifthereisnoreplyfromthecontrolleddevicewithinfour(4)televisionfields,thecon-trollingdeviceassumesthatthedeviceisnotcapableofexecutingthecom-mand.
TheformatoftheReadcommandis:RddrrrThefirstbyteistheASCIIkeywordforRead,R(52H).
Nextatwo-bytefieldofASCIIcharacters(dd)representingahexnumberissentthatcorrespondstothecontrolleddevicenumber(00H-17H).
NextthreeASCIIcharacters(rrr)aretransmitted,representingthehexnumberoftheregisterwhichthecontrollingdevicewantstoread(000H-FFFH)Acarriagereturnendsthemessage.
104SwitcherProducts—ProtocolsManualSection3—PeripheralBusIIProtocolWriteCommandThecontrollingdevicesendsaWritecommandtotheselectedcontrolleddeviceinordertotransmitdatatothecontrolleddevice.
TheformatoftheWritecommandis:Wddrrr[regdata]ThefirstbyteistheASCIIkeywordforWrite,W(57H).
Nextatwo-bytefieldofASCIIcharacters(dd)representingahexnumberissentthatcorrespondstothecontrolleddevicenumber(00H-17H).
NextthreeASCIIcharactersaretransmittedwhichrepresentthehexnumberoftheregisterwhichthecontrollingdevicewantstowriteto(000H-FFFH).
Nexttheregisternumber,upto16ASCIIcharacters,whicharetreatedasrawdata,maybesent.
Acarriagereturnendsthemessage.
WriteResponseAcontrolleddevicesendsaWriteresponsetothecontrollingdeviceinresponsetoaReadcommand.
TheWriteresponsemustbereturnedwithinfour(4)televisionfields,otherwisethecontrollingdevicewillassumethatthecontrolleddeviceisnotthereorisnotcapableofresponding.
InordertoprovidetheWriteresponse,thecontrolleddevicemustenableitsRS-485drivers,transmittheresponse,andthendisableitsdrivers.
Itisessentialthatthecontrolleddevicedothiscleanly,withthedriverenabledonlylongenoughtotransmitthemessage.
Itisalsoveryimportantthatthecontrolleddeviceleaveitsdriversdisabledatallothertimes.
TheformatoftheWriteresponseis:Wddrrr[regdata]ThefirstbyteistheASCIIkeywordforWrite,W(57H),thesameastheWritecommand.
Nextatwo-bytefieldofASCIIcharacters(dd)representingahexnumberissentthatcorrespondstothecontrolleddevicenumber(00H-17H).
NextthreeASCIIcharacters(rrr)aretransmittedrepresentingthehexnumberoftheregisterwhosecontentsaretoberead(000H-FFFH).
Nextupto16ASCIIcharactersmaybesent.
Thecontrollingdevicewilltreatthesecharactersasrawdata.
Acarriagereturnendsthemessage.
SwitcherProducts—ProtocolsManual105Section4DPMCPLProtocolIntroductionThissectiondescribestheControlPointLanguage(CPL)protocolthatcanbeusedbetweenaKalypsoorZodiakDigitalProductionswitcher("switcher")andanexternaldigitalpicturemanipulator("DPM").
Theinterfacesupportseffectrecallandrun(includingtheswitcher'srunleverarm),controlofswitcherauxbusesbytheDPMwhenusedasinputselectors,andonairtallyinvolvingtheDPM.
GeneralBackgroundaboutSwitcher/DPMIntegrationTheswitcher/DPMintegrationinvolvesthefollowingfunctions:EffectsonboththeswitcherandtheDPMcanbetriggeredandrununderusercontrolfromtheswitcherpanel.
TheDPMeffectnumbercanbeanynumberintherangeofDPMeffects,andthenumber(nottheeffectitself)isstoredintheswitcher'sE-MEMregisterwhenaLEARNoperationisdoneattheswitcher.
Whenaregisterisrecalledattheswitcher,thiseffectnumberwillbesenttotheDPMforeffectrecall.
DPMsourceselectioncanbeprovidedbytheswitcher'sauxbuses.
OneauxbuspaircanbeassignedtoeachDPMchannelinamulti-channelconfiguration.
Switcherauxbusessupportfieldaccuratefront/backsourceswitchingfortheDPM.
NoteSourceschangesaresynchronizedtoverticalintervalbytheswitcher.
There-forethisinterfacedoesnotsupportfront/backswitchingfornonplanareffectssuchaspageturns.
106SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolNoteTheswitcherreliesonthekeyhalfofanauxbuspairtobeconnectedtothesametransformingchannelasitsvideohalf.
Thisinterfacemakesnoprovi-sionforuseofthekeysideofaswitcher'sauxbustofeedasecondvideochannel.
Whilebasicfunctionalitycanbeachievedinthismode,functionssuchaseffectssend,front/backswitchingandtallywillnotfunctionproperly.
GrassValleyGroupacceptsnoresponsibilityforinterfaceswhichdonotadheretothisconstraint.
Theterm"Tally,"asusedhere,meansthattheswitchercanreceiveamessagefromtheDPMindicatingwhethertheDPMison-screenornot,andtheswitchercanusethisinformationtotallysourcesfeedingtheDPM,providingproperpanelandcameratally.
NoteTheDPMinformstheswitcherwhetherornotitsimageisonscreenwithoutregardtowhethertheDPMitselfisonair.
Theswitchercomputestheon-airtallybasedontheon/offscreeninformationandwhetherornottheDPMoutputisonair.
Distinguishingbetweentheterms"source"and"input":"Sourcemap-ping"providesalevelofindirectionbetweentheswitcher'sphysicalinputsandasourceselectionpanelbutton.
Input20couldbemappedtobutton1.
"Input"wouldthenrefertothephysicalentity,and"source"tothebuttonandtowhatisstoredaspartoftheswitcher'seffect.
SourceinformationexchangedwiththeDPMisthelogical"source"formoftheinformationthatisused—notthephysicalinput.
Theswitchertrans-latesthisinternallytoaphysicalinput.
NoteTheterm"crosspoint"canbemisleading,meaningbothsourceandinputatdifferenttimes.
Inthisdocumentation,thetermcrosspointreferstotheactualswitchingmatrixusedinroutingsignals.
SwitcherConfigurationInorderforthisinterfacetofunctionasexpected,theswitchermustbecon-figuredproperly.
ConfigurationdetailsarecoveredintheseparateInstalla-tionandServiceManualoftheswitchermodelinvolved.
GeneralProtocolNotesTheprotocolusedforthisinterfaceisdesignedaroundsettingvaluesandreceivingstatus(values).
Asubscriptionmechanismprovidesforstatusupdateswhenchangesoccurprovidingmoretimelydeliveryofinforma-tionwithoutconstantandfrequentpolling.
SwitcherProducts—ProtocolsManual107MessageTimingTheinterfaceisnotdesignedasapurecontrollingdevice/controlleddevicerelationship;boththeswitcherandDPMhaveresponsibilityforpartofthecommunicationsandfunctionmoreaspeers:TheswitcherforwardssourceselectionbuttonpressestotheDPMandorchestratesrunningeffects;theDPMsendsvideo,key,andfront/backinformationtotheswitchertocontrolauxbuses.
ThisprotocolisderivedfromoneusedforinternalcommunicationsbetweentheGrassValleyGroupKrystalDigitalPictureManipulatorcontrolpanelandeffectmanagerviaanethernetconnection.
Muchofthemessagestructureistosupportcommunicationsbetweenmultiplepanelsandmultipleeffectmanagersbutwasretainedforconsistency.
TheKrystalpaneltoeffectmanagercommunicationsisnotdescribedinthisdocument.
TheformatofmessagesisdescribedinMessageFormatonpage113.
MessagespecificsaredescribedinParametersonpage121andOtherCommandSpecificsonpage122.
DatacommunicationsspecificsaredescribedinTransmissionMediaandPro-tocolsonpage123.
CommunicationsexamplesarecontainedinExamplesonpage124.
MessageTimingThetimingofsomemessagesiscriticalinorderfortheswitcherandDPMtoperforminlockstep.
Theseareconsideredrealtimemessages.
TheruncontrolmessagessentbytheswitchertotheDPMmustbeactedoninafixednumberofvideofieldsfromwhentheyaresentbytheswitcher.
Adelayadjustmentisprovidedtocompensateforvariationsindevices.
SourcechangessentbytheDPMtotheswitcherwillbeprocessedsothatthevideowillchangeatthebeginningofthenextfield.
Allothermessagesdonothaveadeterministicrequirementandarepro-cesseddifferentlywithintheswitcher.
Transmissionofrealtimemessagesshouldbegivenpriorityoverthenon-deterministicones.
Themaximumpacketsizewaschosentoallowforinterleavinghighprioritymessageswhenseverallowprioritymessagesareawaitingtransmission.
NoteThelastpacketcontainingrealtimemessagessentbytheDPMinafieldmustcompletetransmission3millisecondsbeforetheendofthefield.
(13.
6mSfromthestartofthefieldfor525/60or22mSfor625/50.
)Norealtimemes-sagesshouldbesenttotheswitcherduringthisend-of-fieldperiod.
Trans-missionsduringthistimecandisturbcriticalprocesseswithintheswitcherandcausetheprogramvideooutputoftheswitchertoglitchrandomly.
108SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolInit/OnlineThissectiondescribesthesequenceusedonstartupcommunications.
ADPMmustrespondandperformtheindicatedstepsinordertoachieveareliableconnectionwiththeswitcher.
IftheSwitcherisreset,oritsDPMportconfigurationischanged:1.
Theswitchersendsoutthemessage:SEND_EVENT,EID_ONLINE(15)ThistellstheDPMthattheswitcherjustcameon-line.
2.
TheDPMacknowledgesthismessagewiththeRETURN_CODEmessageechoingthereturnIDfromtheswitcher'sSEND_EVENTmessage:val=OK(0).
(Theswitcherignoresthereturnvalue.
)3.
TheswitcherthenrequeststheDPMsystemname(bysubscribingtoit):SUBSCRIBE,IMMEDIATE,PID_SYSTEM_NAME4.
TheDPMsendsitsname:ISSUE,PARAMETER_ARTICLE,PID_SYSTEM_NAME5.
Oncetheswitcherreceivesthesystemnamemessage(canbeanynametext)theswitchersendssubscriptionmessagesforalloftheparameterslistedbelowAppendixB.
NoteOthersubscriptionsmaybesolicitedaswell,butmaybesafelyignored.
TheirstatusisusedonlyforKrystalandKaleidoscopeinterfaces.
6.
TheDPMreturnsISSUEmessagescontainingthevaluesforallofthesubscribedparameters.
Fromthenon,anychangestoanyoftheseparameterswillresultinnewissuemessagesbeingsenttotheswitcher.
NoteTheswitcherdoesnotpollforchanges.
Itreliesonthesubscriptionsregis-teredduringinitializationtoprovideitwithtimelyupdatestoparametricchanges.
IftheDPMisresetoritsswitcherinterfaceisreconfigured,thesequenceis:1.
TheDPMsendsoutthemessage:SEND_EVENT,eventEID_ONLINEThistellstheswitcherthattheDPMjustcameon-line.
2.
Theswitcheracknowledgesreceivingtheon-linemessagebysendingtheRETURN_CODEmessage:(themessageheader'sreturnIDissetto0)val=EID_ONLINE(15).
thensendsoutamessagecancellingallsubscriptions:UNSUBSCRIBE,CLEAR_SUBSCRIPTIONS3.
Theswitcherthentakesovertheinitializationprocesswithstep3above.
SwitcherProducts—ProtocolsManual109SourceSelectionSourceSelectionTherearemultiplepartstothesourceselectionpartoftheinterface.
Whentheoperatormakesaselectionontheauxrowofthecontrolpanel(orviaaremoteauxpanel),theswitchersendsamessagetotheDPMwiththevideoorkeysource,neverboth.
TheswitcherreliesontheDPM'suseofsourcememorytoselecttheappropriatekeysource.
Essentially,theswitcherissimplytellingtheDPMthatanoperatorpressedabutton.
ItisuptotheDPMtoprocessthisinformationisanexpectedmanner.
Theswitcherwillsendaselectionforthefrontsource,thebacksourceorbothdependingonthenear/farselectionmadefromtheswitcher'sAUXBUSmenu.
ThefollowingSETcommandscommunicatethisinformationtotheDPM.
Thesemessagesincludefront/backinformationinthedeviceIDfield.
Thechannelbitissetintheupper16bits.
Thelower16bitsindicateifthefrontorbacksideisbeingset(1=back).
Thesefieldsaredefinedasbitmapssothatmultiplechannelsmaybesetatonce.
Howeverinpractice,asourcesetcommandappliestoonlyonechannelatatime.
PID_VIDEO_SOURCEPID_KEY_SOURCENoteTheswitcherdoesnotmakeauxbusselectionsasadirectresultofanauxrowbuttonpress.
IftheDPMdoesnotrespondtothesourcemessage,theswitcher'sauxbussourcewillnotchange.
Asanindependentmechanism,theDPMsendsmessageswiththevideoandkeysources,andthefront/backstatusperchannel.
TheyareseparateSETmessages,withthecontentoftheseparameters:PID_FRONT_VIDEO_SOURCE_LIST(for8channels)PID_BACK_VIDEO_SOURCE_LISTPID_FRONT_KEY_SOURCE_LISTPID_BACK_KEY_SOURCE_LISTPID_FRONT_BACK_SELECT_LISTTheDPMmustsendsourceinformationonchanges.
Sendingatregularintervals(e.
g.
,every-field)isacceptableandcanimproverecoveryshouldthelinkbeinterrupted.
Near/FarandFront/BackTheswitcherdifferentiatesbetweensidesofaplanartransformintwodif-ferent,butrelatedways:110SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocol"Front"isthesideofthepictureplanewhichwouldbevisibleifnorotationisappliedtothetransformation;"back"istheoppositeside.
"Near"isthesidewhichisvisible;"far"isthesidewhichisnotvisible.
Whennorotationisapplied,Near=FrontandFar=Back.
Useofnearandfarallowtheoperatortochangesourcesandinsurethechangeiseitherseen(near)ornotseen(far)regardlessofthepicture'srota-tionamount.
Inorderfortheswitchertosortoutnearandfar,itmustbeprovidedwithfront/backinformationfromtheDPM.
Front/Backinformationtellstheswitcherwhichsideisvisible,thatis,whichisthenearside.
Selectionsintheswitcher'sAUXBUSmenuallowdelegationoftheauxselectorrowtoeithernearorfarorboth.
Therowwillchangeanddisplaytheselectedside.
IfBOTHisselected,thenearsideisdisplayedandaselec-tionwillcauseachangeinboththefrontandbacksides.
TheAUXBUSmenudisplaysboththeDPM'sfrontandbacksources,thecurrentauxselectorrowdelegation(near/far)andwhichsidetheDPMhasreportedasthenearside(front/back).
IftheDPMdoesnotfullyimplementthefrontandbacksourceselectionandfront/backflag,theswitcherwillnotbeabletoproperlyresolvenear/far.
Whilethesystemwillstillfunction,theinformationdisplayedtotheusermaybeincorrect.
SourceHoldOnKalypsosystems,holdscanbeimposedtopreventsourceselectionsfromchangingaseffectsarerecalledorrun.
TwowaystodothisinvolveselectingtheHoldbuttontotherightofthesourcebuttons,orholdingdownasourcebuttononabus.
AuxbusesassignedtoaDPMareactuallycon-trolledbytheDPM,nottheKalypsosystem.
Inordertoprovidethesamelevelofholdcontrolfortheseauxbuses,theKalypsosystemtakescontrolofanauxbusbackfromtheDPMwhenthatbushasaholdimposeduponit.
Whenthebusisbeingheldbyeithermechanism,theKalypsosystemmakesthesourceselectionandignoresanysourcechangesforthatbussentbytheDPM.
TheDPMisstillinformedofsourceselectionsmadefromtheKalypsosystemviathenormalmechanisms.
TallyTheswitchersubscribesforPID_VIDEO_ON_AIRandPID_KEY_ON_AIRinformationfromtheDPM.
TheDPMmustcomputewhetherachannel'simageisonscreenornotandupdatethesesubscriptionswhennecessary.
SwitcherProducts—ProtocolsManual111ActivityCheckNoteTheparameterIDusedforonscreeninformationisthesameastheoneusedtocommunicateonairinformationfromtheswitchertotheDPM.
ThiscaneasilyleadtoconfusionsincethesamePIDisusedfordifferentmeanings.
Indeterminingon/offscreen,thefollowinginformationshouldtakeintoconsideration:locationrelativetotheoutputrasteroftheDPM(e.
g.
,offscreen)imagesize(e.
g.
,reducedtozerosize)rotation(e.
g.
,exactlyonedge)transparencyanyotherprocessingortransformwhichmayaffectvisibilityAdditionalfactorsincludeactualuseoftheincomingsignal.
Ifthevideosignalisreplacedbyamattefill,itsincomingvideoisnotonscreen.
Ifthekeyinputisnotuseditisnotonscreen.
Ifinstead,thevideosignalisusedinaselfkey,thenthevideoisonscreenevenifthevideoisamatte.
OtherfactorsmayexistdependingonthefunctionalityoftheDPM.
Inaddition,theDPMmaysubscribetotheDPM'sonairstatus.
Thisinfor-mationtellstheDPMwhetherornottheswitcherhastheDPMvideoorkeyonair.
TheDPMshouldnotincorporatethisinformationintheonscreenstatusitsendstotheswitcher.
ActivityCheckTheactivitycheckprovidesamechanismfortheswitchertodetectalinkfailure(disconnectedcable,etc.
)orapatching/routingadifferentDPMtotheswitcher.
TheswitcherperiodicallytestsforlinkactivitybysendingoutaSubscribeImmediatecommandfortheDPM'sethernetaddress.
Ifnoresponseisreceived,theswitchernotesthetime-out.
Whenaresponseisreceivedafteratimeout,theswitcherassumesthatsubscriptionissuesorotherupdatescouldhavebeenmissedandreestablishescommunicationsasiftheswitcherhadbeenreset.
Iflinkactivityispresent,theswitcherlooksatthevaluereturnedfromtheDPM.
Ifitisdifferentthanthelastresponse,theswitcherassumesadif-ferentDPMisnowconnectedandreestablishescommunicationsasifithadbeenreset.
112SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolThevaluewhichtheDPMreturnsisunimportant.
However,ifmultipleDPMsexistinafacilityitisagoodideatoreportdifferentvaluesfromeachonetoallowtheswitchertodetectachangeinDPMconnections.
Theactivitycheckisoptional.
TheinterfacebehavesnormallyeveniftheDPMneverrespondstotheswitcher'squery.
However,theswitcherwillnotbeabletorecoverfromlinkfailures,patchingorroutingwithoutaresetfromoneofthetwodevices.
TheswitcherqueriestheDPMapproximatelyevery20seconds.
RunningEffectsDuringinitialization,theswitchersubscribesfortheDPM'scurrenteffectnumber.
Whenaswitchereffectislearned,theDPM'scurrenteffectnumberisstoredaspartoftheeffect.
Whenthateffectisrecalledattheswitcher(DPM1levelenabled),theswitcherwillsendoutacommandtorecalltheDPMeffect.
(SET,PID_CURRENT_EFFECT).
Atthetimeoftherecall,theswitcheralsoissuesaSET,PID_EFFECT_POSITION.
ThetimevaluesentiszeroifREVERSEontheswitcherE-MEMeffectmemorysystemisturnedoff;ortotheendingtimeoftheswitcher'seffectifREVERSEison.
Asaneffectisrunning,theswitchersendsoutcommandseveryfieldtotheDPMtoSETtheeffectposition(PID_EFFECT_POSITION).
ThissamemechanismsupportsrunsviatheRUNbuttonaswellastheswitcher'srunleverarm.
Othertimepositioningcontrolsontheswitcherpanel(PREVKF,NEXTKF,REWIND,etc.
alsoresultinthesendingofaneweffectpositiontotheDPM.
Inthisway,theDPMexactlyfollowsthetimelineoftheswitcher'seffect.
SubscriptionStatusinformationisgatheredindirectlyasaresultofa"subscription"request.
Therequesttellstheotherdevicewheretosendchangestothespecifiedparameter.
Thechangesaredeliveredtotherequestorinan"issue"messagewhichmaycontainseveralparameter"articles".
Manyarticlesmaybecontainedinonesubscription.
Consideramagazinesub-scription:Thereadersubscribestothemagazineandwhenevernewinfor-mationisavailable,anewissueisdeliveredtothereadershome.
Thereaderdoesnothavetospecificallyrequesteachnewissueofthemagazine.
The"subscribeimmediate"mechanismislikerequestingatrialmagazineissue-youonlygetone.
Subscriptionsmaybecanceledatanytime.
Therequestorcanalsomodifythetermsofdeliveryatwill.
SwitcherProducts—ProtocolsManual113MessageFormatTheswitchersubscribestoinformationusingseveralrequestIDs.
ItisimportantfortheDPMtoincludetheproperrequestIDinthestatusupdateissuemessages.
DifferentparameterarticlesmaybesentinthesameissueaslongasthesubscriptionsforallthedatahadthesamerequestID.
ArticlesdestinedfordifferentrequestIDsmustbeplacedinseparateissuemessages.
Itisalsoimportanttolimitissuemessagestolessthan256bytesorthemessagewillbediscardedbytheswitcher.
MessageFormatAbinaryprotocolwithvariable-lengthmessagesisused.
Multiplemes-sagesmaybedeliveredinasinglepacket.
Toaccommodateapacketthatmaycontainmultiplevariable-lengthmessages,eachmessageisprecededbyamessageheader.
AsshowninFigure9,themessageheaderiscom-prisedoffivefields.
TheVersionfieldisusedtoidentifytheprotocolversionandallowschangesintheprotocolwhileprovidingcompatibilitywitholderimple-mentations.
Currently,onlyversion1hasbeenspecified.
TheTokenfieldidentifiesthemessage.
TheReturnIDisauniquecommandidentifier,thatisusedinconjunctionwiththeReturnCodemessage.
Ifacontrolpointdesirestoknowtheresultofissuingacommand,itplacesanon-zerovalueintheReturnIDfield.
TheReturnIDandthecommandreturncodearesentbacktothecontrolpoint,intheformofaReturnCodestatusmessage.
ThesendershouldmanagethereturnID'svaluetoavoidreceivingmultiplereturncodemessageswiththesamereturnID.
NoteTheswitcherviolatesthisutilizationofthereturnID.
TheswitcherdoesnotrespondwithReturnCodemessagesevenifthereturnIdisnonzero.
TheswitcheralwaysrespondstoaSendEventOn-linemessageswithaReturnCodemessageevenifthereturnIDiszero.
ItinsertsazeroreturnIDintothatReturnCodemessageandsetsthedatavaluetoEID_ONLINE(=15)insteadofOKorFAILURE.
TheswitcherdoesspecifyanonzeroreturnIDinitsSendEventOn-linemessageandexpectstheDPMtoechothatreturnIDinaReturnCodemes-sage,howevertheswitcherignoresthedatavalue.
OnlycommandsmayrequestaReturnCodemessageviatheReturnIDfield.
StatusmessagesmustinsertanullreturnID.
114SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolFigure9.
MessageFormatTheDataSizefieldspecifiesthesizeoftheMessageDatainbytes.
Itisthisfieldwhichallowsvariable-lengthmessagestobepassed.
TheHeaderChecksumprovidesthemechanismbywhichmessageintegrityandalign-mentcanbeverified.
Thisisextremelyimportantwhenparsingpacketswithmultiplemessages.
Thealgorithmusedwithversion1oftheprotocolisasimplesummationofthemessageheaderinformation.
Thisalgorithmisshownbelow.
HeaderChecksum=Version+Token+ReturnID+DataSizeAllmessagesarenetwork-byteordered(i.
e.
mostsignificantbytetrans-mittedfirst)withamaximumpacketsizeof256bytes.
Allmessageswillfitwithinthispacketsize,althoughcaremustbetakentoinsuresubscriptionresponseissuesarepackedbasedonthismaximum.
Whenconstructingpackets(HDLCframes)whichcontainmultiplemes-sages,eachmessagemustbepaddedtoguarantee32-bitalignment.
MessageTokensThevaluesassignedtoeachmessagetokenareenumeratedinTable105.
Othermessagevaluesaretreatedasanerrorbytheswitcher.
Thefollowingsectionsidentifythemessagesusedfortheswitcher/DPMinterface.
Itprovidesabriefoverviewofeachmessage,aswellasdetailsthecontentsofeachmessage.
Table105.
MessageTokensTokenValueSendEvent5Set6Subscribe8Unsubscribe10Issue16ReturnCode17TokenReturnIDDataSizeHeaderChecksumMessageMessageHeaderData2bytesFieldSize8063_07_09_r02bytes2bytes4bytesVariable-lengthVersion2bytesSwitcherProducts—ProtocolsManual115MessageFormatSetTheSetcommandisusedtosetaparametertoaspecificvalue.
Asshownonthefollowingpage,theSetcommanddataconsistsoffourfields.
TheparameterID("PID")isusedtouniquelyidentifytheparameterwhichistobeset.
Theflagsfieldspecifieshowaparameteristobeset.
Azerointhisfieldindicatesthatanabsolutesetistobeperformed(i.
e.
theparameterissettothespecifiedvalue)andistheonlyvalidvalueforthisparameter.
Thedevicefieldcontainsafourbyteidentifierthatfurtherqualifiestheparametertobeset.
Typically,thedevicefieldidentifieswhichchannelistobemodified.
RefertoParametersonpage121foracompleteparameterlistthatincludeseachparameterIDandparametertype(short,long,float,string,etc.
),aswellasthedevicesassociatedwitheachparameter.
SubscribeThesubscribecommandisusedtosolicitinformationfromadevice.
Thisinformationisdeliveredintheformofasubscriptionissue1.
Asubscriptionissueissentafterreceivingasubscriptionrequestandthereafterwhentherequestedinformationchanges.
Asshownbelow,theSubscribecommanddataconsistsofarequestaddress,arequestID,aserialnumber,aserviceID,subscribeflags,andoptionalservicespecificdata.
Table106.
SetCommandDataFieldSizeValueParameterID2bytesrefertoAppendixBFlags2bytes0=AbsoluteDevice4bytesrefertoAppendixBValuevariablerefertoAppendixB1.
RefertoIssueonpage117foracompletedescriptionofasubscriptionissue.
Table107.
SubscribeCommandDataFieldSizeValueRequestAddress16bytes(notused)RequestID2bytesany(requestor'schoice)echoedinIssuemessageSerialNumber2bytesany(requestor'schoice)ServiceID2bytes3=ParameterServiceFlags2bytes0=normalservice1=SubscribeImmediate2=ReplaceService3=combinationof1&2ServiceDatavariablerefertoParameterServicebelow116SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolTherequestaddressfieldspecifieswheretherequestedinformationistobedelivered.
ThisfieldisonlyusedwhensubscribingtoinformationviaKrystal'sethernetinterfaceandisunusedforHDLCcommunications.
TherequestIDisauser-definedsubscriptionrequestidentifier.
Itisusedinconjunctionwiththerequestaddresstouniquelyidentifyasubscription.
BecausetherequestIDissentbackaspartofthesubscriptionissue,itiscommonlyusedforsubscriptionissueroutingwithinacontrolpoint.
Theserialnumberisalsosentbacktoacontrolpointaspartofasubscriptionissue.
Acontrolpointcanusethisfieldtoqualifyasubscriptionissue.
Forexample,whenacontrolpointchangesasubscription,itshouldmodifytheserialnumberfromitspreviousstate.
Ifasubscriptionissueisreceivedthatcontainstheoldserialnumber,thenthatissueshouldbediscarded.
TheserviceIDidentifiesthedesiredsubscriptionservice.
Onlyparameterserviceissupportedfortheswitcher/DPMinterface.
Theparameterserviceisusedtoobtainand/ormonitorthepresentvalueofoneormoreparameters.
TheflagsfieldmodifiesthebehavioroftheSubscribecommand.
Whenthesubscribeimmediateflagisset,therequestedinformationisreturnedimmediately.
Inessence,theinformationisreturnedonceuponrequestwithoutfurtherupdates.
Thereplaceserviceflagisusedtoreplaceacurrentservicesubscription(identifiedbyrequestaddress,requestID,andserviceID)withanewrequest.
Forexample,onecouldreplaceanexistingparameterservicesubscriptionwithanewgroupofparameters.
NoteSubscribeimmediateresultsinonlyoneissuewiththecurrentvalue(s).
Asubscriptionforchangesisnotactivated.
ParameterServiceTheparameterIDfieldidentifiestheparameterofinterest1.
Thisisfollowedbyapadfieldwhich32-bitalignstheDevicefield.
TheDevicefieldfurtherqualifiestheparameterorgroupofparametersbeingrequested.
Insomeinstances,thedevicefieldcon-tainsamaskwhichmaybeusedtorequesttheparametervalueofeachdevicespecifiedinthemask.
Forotherparameters,asep-arateparameterservicerequestisnecessary2.
UnsubscribeTheunsubscribecommandcancelsallorpartofasubscription.
Asonemightexpect,thesamecommanddatanecessarytosubscribetoaservice,Table108.
ParameterServiceDataFieldSizeValueParameterID2bytesrefertoAppendixBalignmentpad2bytesanyDevice4bytesrefertoAppendixB1.
RefertoParametersonpage121foracompletelistofparametersusedforthisinterface.
2.
RefertoParametersonpage121forthedevicetypesassociatedwitheachparameter.
SwitcherProducts—ProtocolsManual117MessageFormatisalsoneededtounsubscribefromit.
TheprimarydifferencebetweentheSubscribeandUnsubscribecommanddataisthevaluethattheflagsfieldmayassume.
Asshownbelow,theUnsubscribecommandflagsmaybesettooneoffourvalues.
Withnoflagsset,theUnsubscribecommandcancelsthespecifiedserviceinformation.
Forexample,whenunsubscribingfromaselectgroupofparameters,onlythoseparametersidentifiedintheparameterservicedatawillbecancelled.
Whenthecancelserviceflagisset,thesubscriptionasso-ciatedwiththespecifiedrequestaddress,requestID,andserviceIDiscan-celled.
Itshouldbenotedthatacontrolpointcanhavemorethanonesubscriptiontothesameservice.
Thiscanbeaccomplishedbyusingadif-ferentrequestIDwitheachservicerequest.
Thecancelserviceflagwillnotcancelallsubscriptionstothespecifiedservice,butonlytheoneassociatedwiththegivenrequestaddressandrequestID.
ThecancelsubscriptionflagisusedtocancelallsubscriptionservicesassociatedwiththespecifiedrequestaddressandrequestID.
Theclearsubscriptionsflagisusedtoclearallsubscriptionsassociatedwithacontrolpoint.
Finally,theclearallsub-scriptionsflagisusedtoclearoutallcontrolpointsubscriptions,includingthoseforothercontrolpoints.
IfanyoneoftheUnsubscribeflagsisset,theservicespecificdataisignored.
IssueAnIssuestatusmessageissenttoacontrolpointastheresultofasubscrip-tionrequest(asubscribecommand)orachangeinthevalueofaparameterwithanactivesubscription.
Whenarequestisreceived,anissueisdeliv-eredtothesubscribingcontrolpoint.
AnotherissueisnotdelivereduntilTable109.
UnsubscribeCommandData:FieldSizeValueRequestAddress16bytes(notused)RequestID2bytesany(requestor'schoice)echoedinIssuemessageSerialNumber2bytesany(requestor'schoice)ServiceID2bytes3=ParameterServiceFlags2bytes1=CancelService2=CancelSubscription4=ClearSubscriptions8=ClearAllSubscriptions118SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocoltherequestedinformationchanges.
Asshownonthefollowingpage,therearefivefieldsofdataassociatedwiththeIssuestatusmessage.
RequestIDTherequestIDisauserdefinedrequestidentifier.
ItispassedinthedataportionoftheSubscribecommandandissentbacktoacontrolpointaspartoftheIssue.
TherequestIDistypicallyusedbyacontrolpointtorouteissuedatatothecorrecthandler.
Theserialnumberfieldprovidesthemechanismbywhichunwantedissuedatacanbeignored1.
ThisfieldisfollowedbytheserviceIDfield.
TheserviceIDspecifiesthetypeofissue.
Onlyparameterissuesaresupportedfortheswitcher/DPMinterface.
TheserviceIDisfollowedbyapadfieldwhich32-bitalignstheservicedata.
Theservicedataitselfcontainsservicespecificinformation.
ParameterArticleTheparametersubscriptionservicedataconsistsofoneormoreparameterarticles.
Eacharticlecontainsthevalueofoneparameter.
MultiplearticlesmaybeincludedinthesameissueaslongastherequestaddressandrequestIDforallarticlesarethesame.
RememberthattherequestaddressandIDareprovidedbytherequestingcontrolpointandmustbereturnedwiththeissue.
Thedataassociatedwitheachparameterarticleisshownbelow.
TheparameterIDfieldidentifieswhichparameteriscontainedinthearticle.
Thepadfield32-bitalignsthedevicefield.
Thedevicefielditselfidentifiesthedeviceassociatedwiththespecifiedparameter.
Thelastfieldcontainstheparametervalue.
Inordertoaccommodateparametersofvaryingsize,thevaluefieldisvariablelength.
WhenparameterserviceTable110.
IssueMessageData:FieldSizeValue2bytesmatchesRequestIDofSubscribemessageSerialNumber2bytesany(requestor'schoice)ServiceID2bytes3=ParameterArticlealignmentpad2bytesanyServiceDatavariablerefertoParameterArticlesectionbelow1.
RefertotheSubscribecommandformoreinformation.
Table111.
ParameterArticleDataFieldSizeValueParameterID2bytesrefertoAppendixBalignmentpad2bytesanyDevice4bytesrefertoAppendixBParametervaluevariablerefertoAppendixBSwitcherProducts—ProtocolsManual119MessageFormatissuecontainsmorethanoneparameterarticle,eacharticleis32-bitalignedwithinthepacket.
1Tomaximizelinkbandwidth,articlesshouldbecombinedintoasingleissuewheneverpossible.
However,thispracticeshouldnotdelaydeliveryofanarticle.
Thatis,ifnomorearticlesrequiredelivery,sendapartiallyfilledissue.
Whenalargenumberofsubscriptionsareactiveandmanyparametersaresimultaneouslychangingvalue,itiseasytoexceedthemaximumpacketsize.
Whenaddinganarticletoanexistingissuewouldexceedthemaximumpacketsize,thearticlemustbeaddedtoanewissuemessage.
SendEventThiscommandsendsaneventtotheotherdevice.
Aneventisaninput,withoutlastingstate,whichisusedtotriggersomeaction.
Asshownbelow,therearethreeSendEventcommanddatafields.
TheeventID("EID")fielduniquelyidentifiestheevent.
Thepadfield32-bitalignsthedevicefield.
Thelastfieldcontainsafour-bytedeviceidentifierwhichfurtherqualifiestheeventtobetriggered.
TheonlySendEventusedfortheswitcher/DPMinterfaceistoinstructtheotherdevicetoactivatecommunications.
1.
RefertoParametersonpage121formoreinformationconcerningparameters.
Table112.
SendEventCommandDataFieldSizeValueEventID2bytes15=OnLinealignmentpad2bytesanyDevice4bytesanyValuevariableany120SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolNoteSeethepointslistedbelow:TheswitcherviolatesthisutilizationofthereturnID.
TheswitcherdoesnotrespondwithReturnCodemessagesevenifthereturnIdinthecommandsentbytheDPMisnonzero.
TheswitcheralwaysrespondstoaSendEventOn-linemessageswithaReturnCodemessageevenifthereturnIDiszero.
ItinsertsazeroreturnIDintothatReturnCodemessageandsetsthedatavaluetoEID_ONLINE(=15)insteadofSUCCESSorFAILURE.
TheswitcherdoesspecifyanonzeroreturnIDinitsSendEventOn-linemessageandexpectstheDPMtoechothatreturnIDinaReturnCodemessage,howevertheswitcherignoresthedatavalue.
ReturnCodeTheReturnCodemessagereturnstheresultofacommand.
AllcommandsreturnanOKorERRORstatus.
AreturncodemessageissenttoacontrolpointonlyifthereturnIDfield,inthemessageheader,containsanon-zerovalue.
Asshownbelow,thereisonefieldofdataassociatedwiththeReturnCodemessage.
Thisfieldcontainsthereturncodeitself.
Also,thereturnIDsentwiththecommandisreturnedinthemessageheaderoftheReturnCodemessage.
ThisisparticularlyimportantifacontrolpointissendingmultiplecommandsandneedsthereturnIDtomatchaReturnCodemessagetoitscommand.
NoteRefertothenoteunderSendEventabove.
Table113.
ReturnCodeMessageDataFieldSizeValueReturncodevalue4bytes0=OK/Success0xFFFFFFFF=Error/FailureSwitcherProducts—ProtocolsManual121ParametersParametersThisappendixoutlinesthoseparameterssupportedfortheswitcher/DPMinterface.
Aparameterisavaluethatmaybemodifiedandhaslastingstate.
ParametersaresentviatheSETcommand.
WhenbuildingaSetcommand,theparameterID,itsassociateddevice,andtheparametervaluemustbespecified.
Inaddition,aparameter'svaluemaybeobtainedviathesubscription/issuemechanism.
Table114onpage122isacompletelistoftheparametersintabularform.
Thislistincludesthenameofeachparameterusedinthisdocument,thePID'snumericvalue,itsassociateddevices,andthetypeofeachparameterwithitsacceptablerange.
Bytesandcharsare8-bitvalues,shortsare16-bitvalues,longsare32-bitvalues.
"s15.
16"isasigned32-bitfixedpointvaluewhere1.
0=0x00010000(0.
0=0x00000000,-1.
0=0xFFFF0000,0.
5=0x00008000,etc.
).
Booleanisa16-bitvaluewheretrueoron=1andfalseoroff=0.
Valuesareindecimalunlessprecededby0xindicatinghexadecimal.
ThelasttwocolumnsindicatewhosendsandreceiveswhichcommandsassociatedwitheachPID.
"Tx"meansthedevicetransmitsthemessage;"Rx"meansthatdevicereceivesthemessage.
"SUB"indicatessubscribeappendorreplacemessages.
"SUB-I"indicatessubscribeimmediatemes-sages.
122SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolOtherCommandSpecificsThebulkofthecommunicationsusedfortheswitcher/DPMinterfaceisviaparametricinterchange,asindicatedinAppendixB.
Thissectiontabulatesothercommandsusedbytheswitcher/DPMinterface.
Currently,theonlyothercommunicationsistheexchangeofanonlineeventwhilecommunicationsareinitiated.
TheDPMmusttransmitanon-Table114.
Switcher/DPMParametersParameterNameIDDeviceType/RangeSwitcherDPMPID_FRONT_VIDEO_SOURCE_LIST810Channelbitmap:0x00000001=Chan10x00000002=Chan20x00000004=Chan30x00000008=Chan40x00000010=Chan50x00000020=Chan60x00000040=Chan70x00000080=Chan8(typicallyORedtoaddressseveralchannelsatonce)8bytesChan1first1-48all8bytesmustbesentevenifbitnotsetindevicemapRxSETTxSETPID_VIDEO_BACK_SOURCE_LIST813PID_FRONT_KEY_SOURCE_LIST811PID_BACK_KEY_SOURCE_LIST814PID_FRONT_BACK_SELECT_LIST8168bytes(asabove)Chan1first0=front1=backPID_VIDEO_SOURCE2642Channelbitmap:0x00010000=Chan10x00020000=Chan20x00040000=Chan30x00080000=Chan40x00100000=Chan50x00200000=Chan60x00400000=Chan70x00800000=Chan8ORedwithBacksidebitmap:0x00000001=Chan10x00000002=Chan20x00000004=Chan30x00000008=Chan40x00000010=Chan50x00000020=Chan60x00000040=Chan70x00000080=Chan8(refertotext)short1-48TxSETRxSETPID_KEY_SOURCE2643PID_VIDEO_ON_SCREEN819Channelbitmap(refertosourcelistparametersabove)1boolean(appliestoallchannelsspecifiedindevicefield)TxSUBRxISSUERxSUBTxISSUEPID_KEY_ON_SCREEN820PID_VIDEO_ON_AIR(optional)819RxSUBTxISSUETxSUBRxISSUEPID_KEY_ON_AIR(optional)820PID_CURRENT_EFFECT8860=EffectManagershortanyvalueTxSUBRxISSUETxSETRxSUBTxISSUERxSETPID_EFFECT_POSITION8750=EffectManagers15.
16inframesTxSETRxSETPID_SYSTEM_NAME9170=EffectManagerexactly16charsnoterminatingnullpadwithspacesTxSUBRxISSUERxSUB-ITxISSUERxSUBTxISSUEoptional:TxSUB-IRxISSUEPID_ETHERNET_ADDRESS(optional-refertoActivityCheckdescription)30470=EffectManagerlong(refertotext)TxSUB-IRxISSUERxSUB-ITxISSUESwitcherProducts—ProtocolsManual123TransmissionMediaandProtocolslineeventandrespondtoonesentbytheswitcherwithanappropriatereturncodemessage.
TransmissionMediaandProtocolsTheswitcher/DPMinterfaceisdesignedasapoint-to-pointlink.
MessagesaredeliveredinanHDLC-likeframeconsistingofan8-bitopeningflag,avariable-lengthdatafield,a16-bitCRC,andan8-bitclosingflag.
Withinthetransmissionframe,messagesaredeliveredviathedatafield.
A307.
2KbaudFM0synchronousseriallinkwithimbeddedclockisusedfordeterministiccommunications.
Datarateandframeformatarenotadjustable.
HDLCisasynchronousprotocolwithbuilt-inmechanismsforerrordetectionandpacketdetection.
NotallUARTssupportthisprotocol.
Thosethatdohandlethepacketiza-tion,zerostuffingandCRCinsertion/detection.
AMotorola68302alongwitha68195areusedintheswitcherforthisinterface.
AMotorola68360orZilog8030or8530alsosupportthisprotocol.
Unlikeasynchronousprotocols,communicationsisframe(packet)based.
Atransmitunderrunisnotpermittedinasynchronousprotocolandwillabortthetransmissionoftheframeandthereceiverwilldiscardit.
Thephysicalconnectionbetweentheswitcherandthedigitaleffectdevice(DPM)ispointtopointwithtwoRS-422pairs,oneforeachdirection.
TheconnectorprovidedforthisinterfaceisafemaleDB-9.
Itislocatedontherearoftheswitcherframeandlabeled"A1".
Thepinoutisshownbelow.
Table115.
ReturnCodeMessageDataFunctionPinTx+(switchertoDPM)3Tx-8Rx+(DPMtoswitcher)7Rx-2Ground1,4,6,9124SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolExamplesThefollowingareexamplesofswitchermessagestoandfromtheDPM.
Allvaluesareinhex.
Thesemi-colonafter2ormorebytesisjustusedasasep-aratortogivethenameofthatfieldandanyotherexplanatoryinformation.
(Valuesareinhexadecimal)Example1DPM->switcher,RETURN_CODE:0001;Version0011;Msgtoken,RETURN_CODE0000;ReturnId0004;DataSize00000016;Headerchecksum0000000F;ReturncodeExample2Switcher->DPM,UNSUBSCRIBE0001;Version000a;Msgtoken,UNSUBSCRIBE0000;ReturnId0018;DataSize00000023;Headerchecksum00000000000000000000000000000000;16bytesrqstAddr0000;RqstId0000;Serialnumber0003;ServiceId,PARAMETER_SERVICE0004;flags,CLEAR_SUBSCRIPTIONSExample3Switcher->DPM,SUBSCRIBE0001;Version0008;Msgtoken,SUBSCRIBE0000;ReturnId0020;DataSize00000029;Headerchecksum00000000000000000000000000000000;16bytesrqstAddr0000;RqstId0000;Serialnumber0003;ServiceId,PARAMETER_SERVICE0002;flags,REPLACE_SERVICE0395;ParamId,PID_SYSTEM_NAME0000;padding00000000;Device,EFFECT_MANAGERSwitcherProducts—ProtocolsManual125ExamplesExample4DPM->Switcher,SETfrontvideosource0001;Version0006;Msgtoken,SET0000;ReturnId0010;DataSize00000017;Headerchecksum032A;ParamId,PID_FRONT_VIDEO_SOURCE_LIST0000;flags,ABSOLUTE00000005;Device,logicalchannel1andlogicalchannel30700090000000000;8channelsworthofsourceinformation;;onlychannel1andchannel3arerelevant.
Example5DPM->Switcher,SETfrontkeysource0001;Version0006;Msgtoken,SET0000;ReturnId0010;DataSize00000017;Headerchecksum032B;ParamId,PID_FRONT_KEY_SOURCE_LIST0000;flags,ABSOLUTE00000005;Device,logicalchannel1andlogicalchannel30F00090000000000;8channelsworthofsourceinformation;;onlychannel1andchannel3arerelevant.
Example6DPM->Switcher,SETfront/backselect0001;Version0006;Msgtoken,SET0000;ReturnId0010;DataSize00000017;Headerchecksum0330;ParamId,PID_FRONT_BACK_SELECT_LIST0000;flags,ABSOLUTE00000005;Device,logicalchannel1andlogicalchannel30000010000000000;8channelsworthofsourceinformation;;onlychannel1andchannel3arerelevant.
;00=frontvisible:01-backvisible126SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolExample7DPM->Switcher,ISSUE0001;Version0010;Msgtoken,ISSUE0000;ReturnId0020;DataSize00000031;Headerchecksum0000;RqstId0000;SerialNumber0003;ServiceId,PARAMETER_SERVICE0000;padding0395;ParamId,PID_SYSTEM_NAME0000;padding00000000;Device,EFFECT_MANAGER16-bytesystemnameinASCIIExample8Switcher->DPM,SUBSCRIBEtomorethanoneParamIdinonemessage0001;Version0008;Msgtoken,SUBSCRIBE0000;ReturnId0028;DataSize00000031;Headerchecksum00000000000000000000000000000000;16bytesrqstAddr0001;RqstId0000;Serialnumber0003;ServiceId,PARAMETER_SERVICE0000;flags,APPEND_SERVICE0333;ParamId,PID_VIDEO_ON_AIR0000;padding000000FF;Device,8channels0334;ParamId,PID_KEY_ON_AIR0000;padding000000FF;Device,8channelsSwitcherProducts—ProtocolsManual127ExamplesExample9Switcher->DPM,SETanewvideosource0001;Version0006;Msgtoken,SET0000;ReturnId000C;DataSize00000013;Headerchecksum0A52;ParamId,PID_VIDEO_SOURCE0000;flags,ABSOLUTE00010001;Device,logicalchannel1,visibleside(sourcememorydeviceusesmasktoindicateside)000B;Source110000;padding128SwitcherProducts—ProtocolsManualSection4—DPMCPLProtocolSwitcherProducts—ProtocolsManual129Section5RouterProtocolIntroductionTheKalypsoVideoProductionCenterandtheZodiakDigitalProductionSwitchercanbeconnectedwithaGrassValleyGroupSMS7000routingsystemforcontroloftherouter.
Thissectiongivesanoverviewofthisinter-face.
Commandsusedbythisprotocolforthispurposewillbeidentifiedbutnotdescribedindetail.
AcompletedescriptionoftheprotocolandalltheavailablecommandsisavailableintheseparateRoutingProductsPro-tocolManual.
AKalypsosystemcaninterfacewitharoutertoaccomplishtwodifferentandcompletelyseparatefunctions:RouterControl,consistingofuserinitiatedPanel,Menu,andR-MEMcontrolofroutersourceselectionsforspecificrouterdestinations.
EmergencyBypassoptionoperationwhichinvolvessourceselectionforspecificrouterdestinations.
AZodiaksystemsupportsRouterControl,aslistedabove,butdoesnotsupportEmergencyBypass.
NativeProtocolBothrouterfeaturesinterfacetoaGrassValleyGroupSMS-7000routingsystemusingNativeProtocol.
NativeprotocolsupportsEthernetandserialphysicalconnections.
TheRouterControlfeatureemploysEthernet,andtheEmergencyBypassoptionemploysRS-422serialconnections.
130SwitcherProducts—ProtocolsManualSection5—RouterProtocolCommandsThefollowingNativeProtocolcommandsareusedforRouterControlandtheEmergencyBypassoption.
SeetheseparateRoutingProductsProtocolManualfordetailsaboutusingtheseandothercommands.
Table116.
NativeProtocolCommandsNameFunctionBKIsetbackgroundrefreshintervalQNSquerysourcenameQNDquerydestinationnameQNLquerylevelQDnamequerydestinationstatusTDnamenametakePRnamelevelprotectUPnamelevelunprotectBKEOnturnlevel4acknowledgeonSwitcherProducts—ProtocolsManual131Section6StillStoreImageFileFormatIntroductionThisdocumentdescribesthefileformatsusedbytheKalypsoClassicandZodiaksystemstillstores,andbytheKalypsoHD/Duosystemstillstores.
ExperienceddevelopersshouldbeabletoutilizethisinformationtowriteapplicationsthatconvertimagesandanimationstoandfromtheKalypsoandZodiakproductionswitchersystems.
StillStoreHardwareTheKalypsoClassicandZodiaksystemssupportSDformats(525and625lines).
Thestillstorehardwaresuppliedwiththesesystemssupportsonlythosetwoformats.
TheKalypsoHDsystemsincesoftwareversion10.
0supportseitherHDformats(1080iand720p)orSDformats(525and625lines).
TheKalypsoDuosystemusesthesamehardware,butisrestrictedtooperatinginonlytheSDmodes.
TheKalypsoHDandDuosystemsstoreandretrieveSDstillstoreimagesof525and625linesinthesameformatasdocumentedfortheKalypsoClassicandZodiakstillstore.
ImageStorageMechanismKalypsoClassicandZodiaksystemstillstorevideo(andkey)datacon-formstoCCIR601specifications,butispackedinaparticularorderthatmatchesthestillstorehardwarememoryorganization.
WhilemanygraphicsapplicationscancreateCCIR601videodata,nonepackdataintheorderexpectedbythestillstore.
TheKalypsoHDsystemstillstorevideo(andkey)dataconformstoSMPTE274M(1920x1080,including1080I@30Hz,29.
9Hz,25Hz)andSMPTE296M(1280x720,including720P@59.
9Hzand60Hz).
TheaboveconsiderationsregardingdatapackingorderalsoappliestoHDimages.
132SwitcherProducts—ProtocolsManualSection6—StillStoreImageFileFormatKalypsoandZodiakstillstoresystemsuseapairoffilestodescribeanimageratherthanembeddinginformationabouttheimageintoasinglefile.
SinceFTPistheprimaryinterfacetothestillstore,itisnotpossibletotransferpartofafile.
Aseparate"metadata"fileprovidesrapidaccesstoinformationabouttheimagewithouttransferringtheimageitself.
Stillstore"images"refertooneofthefollowing:VideoonlystillVideopluskeystillVideoonlyanimationVideopluskeyanimationInmanycases,thestillstoresuppliessmall,animatediconsorbugs.
Toincreaseefficiency,imagesdonothavetobeafulltelevisionframe.
Duringthecaptureprocess,theimagecanbe"fenced"toa1/2x1/2,1/3x1/3,or1/5x1/5ofthefullsizeimage.
Onlythefencedregioniswrittentothefile.
OnZodiaksystems,theanimationandfencingfeatureswereimplementedinZodiakRelease3software.
EarlierZodiaksoftwareversionssupportedonlyfullsizestillimages.
Eachimagehasanidentifierhandle.
Thishandlemustbeuniquewithinadirectoryfromwhichthestillstoreloadsimages.
ADOSstandard8.
3filenameandextensionexpresstheimagehandleandbindthedataandmeta-datafilestogether.
Aseparateimagename(storedinthemetadatafile)isusedfordisplaypurposes.
Imagefilesnameshaveaspecificformat:MetadatafilesareoftheformI000nnnn.
gvaDatafilesareoftheformI000nnnn.
gviThefirstfourcharactersaretheletterIfollowedbythreezeros.
Thelastfourcharactersrepresenttheimagehandle:anumberbetween0001and2000(0001–0050forZodiakversion2).
Leadingzerosmustbeincluded.
Thestillstorematchesimageandmetadatafilesaccordingtotheirfilenames.
Iftheinformationcontainedinthefilepairdisagree,theimagewillnotloadproperly.
Themetadatafilehasspacefortheimagehandle,butthisfieldisunused.
Theimagehandlecontainedinthefilenameissufficienttoidentifytheimage.
Inordertocreateastillstoreimage,theapplicationmustbeabletoconvertthegraphicsdataintoCCIR601,SMPTE274M,orSMPTE296Mformat,packitintheproperorderandwriteittothedatafile.
Italsomustgenerateametadatafilethataccuratelydescribesthecontentsofthematchingdatafile.
Themetadatafileofanexistingimagealsoholdsthekeytounpackthematchingimagedatashouldtheapplicationwishtoingestanimagecreatedbythestillstore.
SwitcherProducts—ProtocolsManual133IntroductionThevaluesdescribedinthisdocumentareshownasnormally(bigendian)orderedbytes,butarewrittentotheimagefilesinlittleendianorder.
MetadataFileFormatVersionsandKalypsoSoftwareReleasesTheimagemetadatafileformathasevolvedsincethestillstorewasfirstreleased.
Thisformatisnowatversion6,andonlythismetadataversionisdescribedinthisAPI.
KalypsoRelease7andZodiakRelease2aretheearliestsoftwarereleasesthatsupporttheversion6metadataformat.
ImagescreatedusingthisAPIwillonlybeusableonKalypsoorZodiaksystemsrunningtheseorhigherreleasesofsoftware.
TheZodiakRelease2softwarehasnotimplementedtheanimationorfencingfeatures,butthesefeaturesaresupportedinZodiakRelease3.
ImagesthatuseolderformatmetadatawillneedtoberesavedusingaKalypsoorZodiaksystemrunningsoftwarethatsupportstheversion6metadataformatbeforeanapplicationbasedonthisAPIwillbeabletoaccesstheimages.
Metadatacontentsmustreflectthecontentofthematchingdatafileorthestillstorewillhaveproblemsreadingtheimage.
Inseverecases,suchparsingerrorscouldresultinastillstoreorframemainprocessorcrash.
VideoConversionMostgraphicsapplicationsproduce"video"asred,greenandbluecompo-nents.
Analphachannelissometimesincludedtocontroltransparencyofthegraphicinafinalcomposite.
Graphicssystemsdonotnecessarilygen-erateimagesofthepropersizefordirectusebyvideosystems.
Inaddition,pixelsinthevideodomainarenotsquare.
Thestillstorealsoexpectsinter-lacedvideo.
Itmaybenecessarytocrop,aspectratioconvert,interlaceorotherwisemanipulatetheimagespatiallytoconformtothevideoraster.
Thealphachannelshouldbetreatedasablackandwhitevideosignalandscaledaccordingly.
ThestillstoreacceptsvideoasY,CrandCb.
Anoptional"key"signal(ablacktowhitesignal)maybeincluded.
Thekeycorrelatestothealphachannel.
SDandHDimagesusedifferentcolorimetry.
SDusesITU-RBT601whileHDusesBT709.
134SwitcherProducts—ProtocolsManualSection6—StillStoreImageFileFormatForSDformatsCCIR601definesthebasicvideosignallevelsusedbythestillstoreandtheconversionbetweenRGBandY,Cr,Cbas:Y=0.
299R+0.
587G+0.
114BCr=0.
713(R-Y)=0.
500R-0.
419G-0.
081BCb=0.
564(B-Y)=0.
500B-0.
169R-0.
331GForHDformatsSMPTE274M(1920x1080)and296M(1280x720)specify:Y=0.
2126R+0.
7152G+0.
0722BCr=(0.
5/(1-0.
2126))*(R-Y)Cb=(0.
5/(1-0.
0722)*(B-Y)Inaddition,headroomisspecifiedforovershootandundershoot.
BlackisaYcodewordof64WhiteisaYcodewordof940CrandCbsitonapedestalof512toavoidnegativenumbersandhasarangeof±448aboutthiscentralvalue.
Thesefactorsneedtobetakenintoaccountwhenscalingvalues.
CrandCbarehalfthebandwidthofY.
ProperfilteringshouldbeappliedduringRGBtoY,Cr,Cbconversiontoavoidaliasing.
HalftheCrandCbsamplesarethendiscarded.
CrandCbarebothderivedfromthesamesample(first,third,fifth,etc.
).
Inaddition,codewordsbelow4andabove1019arereservedforsyncandcontrolwords.
TheY,Cr,andCbvaluesmustbelimitedaccordingly.
WhileCCIR601,SMPTE274MandSMPTE296Mspecifiespixelsperlineandthenumberoflinesperfield,SMPTERP-187doesabetterjobofdefiningthings.
RP-187specifiesimagesintermsofa"cleanaperture"(whattheendimagewillbecroppedto)anda"productionaperture.
"Thestillstorestorestheentireproductionaperture.
However,croppingandpositioningisdonein"screenunits"(alsodefinedinRP-187)thatarebasedoncleanaperture.
Notethatscreenunitsaredifferentfor4:3and16:9aspectratios.
ShapedVideoModernvideoproductionequipmentusuallysupportstwomechanismsoftransferringvideobetweenequipment.
Themostcommonapproachusedinalldigitalenvironmentsisknownas"shapedvideo"becausethevideoproducedbyonedevicehasalreadybeenmodifiedbyitsaccompanyingkey.
Thereceivingdevice"cutsahole"inthebackgroundimageandaddstheincomingvideotoitwithoutfurtherprocessing.
SwitcherProducts—ProtocolsManual135IntroductionWhendistributionpathswerepredominatelyanalog,thisapproachdidnotworkwell.
Blacklevelerrorsandnoisecouldcorruptthebackgroundpor-tionsofthefinalcomposite,sothevideooutputbyonedevicewasdividedbyitsownkeysignal("unshaped")sothatthereceivingdevicecouldreapplythatkeysignal,eliminatingtheopportunityforsignalerrorstocorruptthebackground.
Thestillstoreacceptseither"shaped"or"unshaped"videoforvideo+keypairs.
Whenastillstoreoutputisselectedonakeyer,thestillstorenotifiesthekeyerwhichmodetooperatein.
Ifthemodeissetincorrectly,thecom-positewillnotlookright.
Partofthemetadataidentifiesifthevideoisshapedorifitneedstobeshapedpriortocompositing(unshaped).
Theapplicationgeneratingtheimagefileisresponsibleforsettingthisflagcorrectly.
Ingeneral,theoutputofagraphicssystemthatproducesred,green,blueandalphachannelswillbeproducingshapedvideo.
Ashapedvideosignalisblackeverywhereoutsidethealphaarea.
Insidethealphaarea,itshouldreduceinamplitudeastheimagebecomesmoretransparent.
136SwitcherProducts—ProtocolsManualSection6—StillStoreImageFileFormatSDImageDataFileFormatTheKalypsoandZodiakSDstillstoreimagedataformatreflectstheorga-nizationofthestillstorememoryusedtorasterizeimages.
Thisisarawdatafilewithoutanyheadersorembeddedinformation–justthepixels(andalsoinsomecases"pad"bytesof"0"tofilltheremainingportionofalineorafield).
Thestillstoreexpectsaspecificorganizationofinformationinthisfilebasedonthecontentsofthemetadatafile.
Six10-bitvideo(orkey)pixels(twelvevalues:YplushalfbandwidthCbandCr)arepackedintofour32-bitvaluesasshowninTable117:Table117.
SDStillStoreImageDataNotethatthesamplenumbersforCbandCrshowonlyoddnumberedsamples.
Thisisbasedondiscardinghalfofthefullbandwidthchromi-nancesamples(theevennumberedsamples).
IfCbandCrhavealreadybeendownsampled,donotdiscardsamples.
Allimagesmustbegininfield1oftheframeandincludebothfields.
Incompletelines(halflineblankingatthetoporbottomofthescreen)mustbeextendedwithactivepixels(blackisOK).
CbandCrwordsshouldbesetto512(nocolor)forblackandwhitevideoorkeysignals.
Whereakeysignalexists,aframe(twofields)ofvideoisfollowedbyaframeofkey.
Whentheimageisavideoonlyanimation,framesarestackedbacktoback.
Whentheimageisavideo+keyanimation,videoandkeyareinterleaved.
Thatisvideofield1,videofield2,keyfield1,keyfield2,videofield3,etc.
Table118onpage137showstheamountofinformationwrittentothedatafileperframe:8063_04_08_r03122211211210DWORD0Cb3Cr100Cb1DWORD1Cr5Cb500Cr3DWORD2Y3Y200Y1DWORD3Y6Y500Y4SwitcherProducts—ProtocolsManual137SDImageDataFileFormatNoteValuesforPixelsperLineandLinesinField1/Field2areactivevideopixelsonly.
Totalbytesperframeincludespadbytes.
SDFullSizeFileFormat/SizeCalculationsVerticalandhorizontalimagestartpointsaredefinedinCCIR601.
AfullscreenimageintheKalypsostillstoreisequivalenttotheproductionaper-turedefinedinSMPTERP-187.
Eachlineofafullscreenimage,consistsof720pixelspackedinto1920bytesasdescribedabove,followedby128padbytessothateachlineoccupies0x800bytes.
A525/60field1contains244lines.
A525/60field2contains243lines.
Bothfieldsarepaddedsuchthateachoccupies0x80000bytesandaframeoccu-pies0x100000bytes(1,048,576).
Bothfieldsfora625/50imagecontain288lines.
625/50fieldsarenotpaddedwithadditionallines.
Eachfieldinafullraster625/50imageis0x90000bytessoaframeis0x120000bytes(1,179,648).
Table118.
SDFormatDataAmountsFrameRateFenceSizePixelsperLineBytesperLineLinesPixelGroupsperLineTotalBytesperFrameField1Field2525/60Full7201920244243301,048,5761/436096012212115234,2401/9240640818110103,6801/251443844848636,864625/50Full7201920288288301,179,6481/436096014414415276,4801/9240640969610122,8801/251443845757643,776138SwitcherProducts—ProtocolsManualSection6—StillStoreImageFileFormatTable119andTable120showfilelayoutfor525/60and625/50images.
SDFencedImageFileSizeCalculationsAfencedregionmuststartwithapixelcontainingco-sitedcolordifferencesamples.
Table119.
525/60FormatFieldLineStartAddressEndofActiveVideoAddressEndofLineAddressField110x00000x077f0x07ff20x08000x0f7f0x0fff30x10000x177f0x17ff40x18000x1f7f0x1fff.
.
.
2420x788000x78f7f0x78fff2430x790000x7977f0x797ff244(lastactivelineoffield1)0x798000x79f7f0x79fffunused0x7a000unused0x7ffffField210x800000x8077f0x807ff20x808000x80f7f0x80fff30x810000x8177f0x817ff40x818000x81f7f0x81fff.
.
.
2420xf88000xf8f7f0xf8fff243(lastactivelineoffield2)0xf90000xf977f0xf97ffunused0xf9800unused0xfffffTable120.
625/50FormatFieldLineStartAddressEndofActiveVideoAddressEndofLineAddressField110x00000x077f0x07ff20x08000x0f7f0x0fff30x10000x177f0x17ff40x18000x1f7f0x1fff.
.
.
2870x8f0000x8f77f0x8f7ff2880x8f8000x8ff7f0x8ffffField210x900000x9077f0x907ff20x908000x90f7f0x90fff30x910000x9177f0x917ff40x918000x91f7f0x91fff.
.
.
2870x11f0000x11f77f0x11f7ff2880x11f8000x11ff7f0x11ffffSwitcherProducts—ProtocolsManual139HDImageDataFileFormatNopaddingoccursattheendoftheline.
Theonlypaddingoccursattheendoffield2fora525/601/4sizeimage.
Thatfieldispaddedtothesamelengthasfield1(122lines)byaddingoneline.
RefertoTable118onpage137forspecificfencedregionsizes.
HDImageDataFileFormatFourteen10-bitvideo(orkey)pixels(28values,14Yplus14halfband-widthCbandCr)arepackedintoapixelgroupconsistingofnine32-bitvaluesasshowninTable121.
Table121.
HDStillStoreImageDataPixelGroupTableTable122showstheamountofinformationwrittentothedatafileperframe.
Table122.
HDFormatDataAmountsImageFormatFenceSizePixelsperLineBytesperLineLinesperFrame(Field1)(Field2)PixelGroupsPerLineTotalBytesperFrame1080i(Interlaced)Full192049685405401385,365,4401/410082592270270721,399,6801/9672172818018048622,0801/25392100810810828217,728720p(progressive)Full12803312720922,384,6401/4672172836048622,0801/9448115224032276,4801/252666841441998,496DWORD4DWORD3DWORD2DWORD0DWORD1DWORD8287Unused8063_04_07_r0Y14Cr13Y13280279270269260259256DWORD7DWORD6DWORD5255Y13Cb13Y12Cr11250249240239230229224223Cr11Y11Cb11Y10220219210209200199192191Y10Cr9Y9Cb9190189180179170169160159Y8Cr7Y7Cb7150149140139130129128127Cb7Y6Cr5Y5120119110109100999695Y5Cb5Y4Cr39089807970696463Cr3Y3Cb3Y26059504940393231Y2Cr1Y1Cb1302920191090140SwitcherProducts—ProtocolsManualSection6—StillStoreImageFileFormatHDFullSizeFileFormat/SizeCalculationsVerticalandhorizontalimagestartpointsaredefinedinSMPTE274MandSMPTE296M.
AfullscreenimageintheKalypsoHDstillstoreisequiva-lenttotheproductionaperturedefinedinSMPTERP-187.
Eachlineofafull-screen1080iimageconsistsof1920activeand12inactivepixelspackedinto4968bytesasdescribedintablesTable121andTable122.
Thereare1372/14activepixelgroups(1920pixels)and12/14ofthelastpixelgroup(12pixels,whichcontaininactivevideo)perline(apixelgroupcontains14pixels).
Therearenopaddinglinesbetweenfields.
Eachlineofafull-screen720pimageconsistsof1280activeand8inactivepixelspackedinto3312bytesasdescribedinthetables.
Thereare916/14activepixelgroups(1280pixels)and8/14ofthelastpixelgroup(8pixels,whichcontainsinactivevideo)perline.
Therearenopaddinglinesattheendoftheframe.
Thepixelgroupsofallthefencedimagesizesarefullypacked.
RefertoTable123andTable124forlayoutsof1080iand720pformats.
Table123.
1080iFormatFieldLineStartAddressAddressofLastByteofLineField110x00x136720x13680x26cf30x26d00x3a3740x3a380x4d9f…5380x28b5280x28c88f5390x28c8900x28dbf75400x28dbf80x28ef5fField210x28ef600x2902c7…5400x51cb580x51debfTable124.
720pFormatLineStartAddressAddressofLastByteofLine10x00xcef20xcf00x19df30x19e00x26ef40x26d00x33bf…7190x2449200x24560f7200x2456100x2462ffSwitcherProducts—ProtocolsManual141ImageMetadataFileFormatHDFencedImageFileSizeCalculationsAfencedregionmuststartwithapixelcontainingco-sitedcolordifferencesamples.
Table122onpage139showsthesizesoffencedimages.
Eachgroup(of14pixelsin36bytes)ineachfencedsizeiscompletelyfilled,whichiswhyalineat1/4fencesizehasmorethan1/2thenumberofpixelsinafull-sizeimageline.
ImageMetadataFileFormatThemetadatafileprovidesinstructionsnecessaryforthestillstoretoreadtheimagedatafile.
Italsocontainsinstructionsonhowtheimageshouldbeoutputfromthestillstore(andhowitshouldappearintheimagebrowser).
ThemetadatafileformathasevolvedsignificantlysincethefirststillstoreimplementationinKalypso.
Thisformatisnowatversion6,andonlythisversionisdescribedhere.
SeeMetadataFileFormatVersionsandKalypsoSoftwareReleasesonpage133formoreinformation.
Table125indicatesthesizeoffset,andcontentsofeachdatafield.
Sizeisinbits,andalsoindicateswhethertheparameterissignedorunsigned.
E.
g.
,Uint16isa16-bitunsignedvalue,Int32isasigned32-bitvalue.
Floatvaluesare32-bitvaluesinIEEE754format(ANSI/IEE754-1985).
Offsetisinbytesfromthebeginningofthefileinhexadecimal.
Table125.
ImageMetadataOffsetSizeParameterValue/Comment0x00UInt16magicNumber0x5ADF0x02UInt16metatataVersion6(don'tcontinueprocessingifnotversion6)0x04UInt32imageHandle0(notused)SeediscussionaboveinIntroduction.
0x0881charactersfileName[81]0's(notused)0x5981charactersimageName[81]Nullterminatedcharacterstring.
Charactersafterfirstnullareignored.
Seediscus-sionaboveinIntroduction.
0xAAUInt16imageType3forsingleframevideoonly4forsingleframekeyonly(notused)5forsingleframevideo+key6formultipleframevideoonly7formultipleframekeyonly(notused)8formultipleframevideo+keyfillimagedatafilewithappropriateinformation0xACUInt16imageLineRate1for525/602for625/503+1*26+[(linerate)*28]for720p4+[(linerate)*28]for1080i(linerateoptional,seeLineRatediscussionfordetails)0xAEUInt16pad10(compilergeneratedstructurealignmentfiller)0xB0Int32aspectRatio16x90for4:3(seeOutputCropandPositiondiscussion)1for16:9forsupportedHDlinerates720pand1080i142SwitcherProducts—ProtocolsManualSection6—StillStoreImageFileFormatPadparameterspad1andpad2arefillersgeneratedbythecompilertoalignthenextparametertoa16or32bitboundary.
Thesepadsmustbeincludedinthefilebuttheirvalueisunimportant.
Metadatafilesarewrittenas512bytesregardlessofthesizeoftheactiveinformation.
Pad3fillsoutthemessageto512bytes.
Valuesarenotimpor-tantbutdummyvaluesmustbeincludedinthefile.
LineRateForoffset0xac:imageLineRate,the26bit,bit6,isthe"progressivescan"bit.
Forratesotherthan525and625,theuppereightbitsofthe16-bitimage-LineRatefieldcanoptionallybeusedtoexpresstheoriginalframerate.
The0xB4Int32fenceSize0forfullscreen1for1/2x1/22for1/3x1/33for1/5x1/5Fillimagedatafilewithappropriateinformation.
SeediscussionaboveinImageDataFileFormatsection.
0xB8floatoutputCropRightControlscroppingofimagewhenloadedtotheoutputofthefromstillstore.
SeediscussionbelowinCropsandPositionsection.
0xBCfloatoutputCropLeft0xC0floatoutputCropTop0xC4floatoutputCropBottom0xC8floatoutputVertPosControlspositionofimagewhenloadedtotheoutputofthestillstore.
Seediscus-sionbelowinCropandPositionsection.
0xCCfloatoutputHorizPos0xD0Int32outputFreezeModeControlshowfrozenimageisdisplayedbythestillstore.
0todisplaycompleteframe1todisplayfield1withinterpolatedfield1forfield22todisplayfield2withinterpolatedfield2forfield13todisplayfield1inbothfields(replicate)4todisplayfield2inbothfields(replicate)0xD4Int8shapedVideo0forunshapedorvideoonly1forshapedvideoSeediscussionaboveinShapedVideosection.
0xD5Int8pad20(compilergeneratedstructurealignmentfiller)0xD6Int16clipLengthNumberofframesstoredindatafile.
Stillshavealengthof10xD8Int16markInFramePlaybackstartingframenumber(0isfirstframeinfile)0xDAInt16markOutFramePlaybackendingframe(numberoftheframeAFTERlastonetobeplayed)0xDCInt16vidKeyOffsetTemporaloffsetforkeyinframes(notused).
Fillwith0s.
0xDEInt16loopFromFrameNumberoflastframeinaloopedregion.
0xE0Int16loopToFrameNumberoffirstframeincludedinloopedregion.
0xE2Int16loopCountNumberoftimesloopedregionisrepeated.
0-norepeat(playloopedregiononce)1-32767repeatloopregionthisnumberoftimes-1loopforeverAvalueof1saysrepeattheloopedregiononce,i.
e.
,playittwice.
0xE4Int32dwLowDateTimeDateandtimeofimagemodificationinWin32(MFC)format(notused).
InsertWin32formatteddateandtimeorfillwith0s.
0xE8Int32dwHighDateTime0xEC276characterspad3[276]0s(forconsistent512bytefilesizeregardlessofversion)Table125.
ImageMetadata-(continued)OffsetSizeParameterValue/CommentSwitcherProducts—ProtocolsManual143ImageMetadataFileFormatstillstoredoesnotusethislinerateitselfasitisunabletointerpolatelineratesifthisratediffersfromtheratethatthesystemiscurrentlysetto.
Howeverthisinformationispreservedforfutureuseorforinformationpurposes.
23.
97Hzor24Hzwouldberepresentedby24.
25Hzwouldberepresentedby25.
29.
97or30.
0Hzwouldberepresentedby30.
47.
95or48Hzwouldberepresentedby48.
50Hzwouldberepresentedby5059.
94or60Hzwouldberepresentedby60.
Example:720pat60Hzframeratewouldbe:60*2860(decimal)inupper8bits1*26ProgressiveScanbitinbit631280x720imageformatExample:1080iat29.
97Hzframeratewouldbe:30*2830(decimal)inupper8bits41920x1080imageformatRefertoTable126forarepresentationofthebitarrangement.
StillStoreOutputControlWhenimagesarecreated(especiallywhentheyarefencedorwhenanani-mationislooped),theauthormakesdecisionsabouthowtheimageshouldappearwhenoutputfromthestillstore.
Asetof"output"parametersintheimagemetadatafileconveytheseinstructionstothestillstore.
Theswitcheroperatorhastheopportunitytochangethesesettingsiftheydon'tworkforaspecificsituation,butthemetadatavaluesprovideastartingpointforthoseadjustments.
Table126.
0xACImageLineRateDetail15141312111009080706050403020100FrameRateReservedProg.
BitImageFormat24=24or23.
97Hz30=30or29.
97Hz48=48or47.
95Hz50=50Hz60=60or59.
94Hz00=interlace1=progressive1=525/602=625/503=1280x7204=1920x1080144SwitcherProducts—ProtocolsManualSection6—StillStoreImageFileFormatOutputCropandPositionCroppingdetermineswhatportionoftheimageisoutputbythestillstore.
Positioningrelocatestheimagerelativetoscreencenter.
Theseparametersdonotaffectthecontentsoftheimagedatafile.
Theyonlyaffecthowthestillstorepresentstheimagewhenloadedtoanoutput.
Valuesareinscreenunitsrelativetoscreencenter.
Screenunitsarebasedonthe"cleanaperture"asdefinedinSMPTERP-187.
Thestillstorecapturesandoutputsaproductionaperturebydefault.
ThevaluesshowninTable127placethecropedgesatthepointsdefinedbySMPTEastheproductionaperture,essentiallydisablingthecrop.
Thespecifiedvalueswillsetthecropexactlyattheproductionaperture,butthisisthemiddleoftheshapededge.
Foranuncroppedimage,cropsneedtobesetoutsidethesevalues.
Note16:9modeisnotcurrentlysupportedforSDformats.
AllSDimages,regard-lessoftheiractualaspectratioshoulduse4:3screenunitnumbersandsettheaspectRatio16x9parameterto0.
OutputFreezeModeWhenthestillstoreisdisplayingastillorastoppedanimation,theusercansetthestillstoretodisplayacompleteframeorrestrictoutputtooneofthetwofields.
Frameoutputisidealforstillssincefullverticalbandwidthisused.
However,iftheimagecontainsmotion(aswouldbethecaseforananimationorastillgrabbedfrommovingvideo),frameoutputmayhavetoomuchjitter.
Selectingoneofthefieldmodeswilleliminatethejitterattheexpenseofverticalbandwidth.
Fieldinterpolatemodespresenttheselectedfieldduringitsdisplayperiodandinterpolatetheotherfieldbyaveragingadjacentlinesfromtheselectedfield.
Fieldreplicatemodessimplyoutputtheselectedfieldduringbothfieldtimes.
Table127.
ImageFormatAspectRatioLeftEdgeRightEdgeTopEdgeBottomEdge525/604:3-4.
07+4.
07+3.
08-3.
0816:9625/504:3-4.
17+4.
17+3.
05-3.
0516:91280x720or1920x108016:9-16.
27216.
2729.
1125-9.
1125SwitcherProducts—ProtocolsManual145ImageMetadataFileFormatMarkIn/OutWhenananimationiscaptured,extraneousmaterialbeforeorafterthedesiredsegmentisoftenincluded.
Themarkinandoutpointsinstructthestillstoretostartandendplaybackatspecificpoints.
Theframespriortotheinpointandaftertheoutpointarenotplayed.
Notethatthestillstoreactuallyplaysuptotheframebeforethemarkoutframenumber.
Themarkoutframeisnotplayed.
LoopsAnimationsoftenarerepetitiveinnature.
Thatis,theentireanimation(oraportionofit)repeats.
Inordertosavestoragespace,thestillstorepermitstheserepeatedregionstobeincludedonlyonceinananimationfile.
Meta-datainstructionscontrolwherealooprepeatoccursandhowmanytimesthatsegmentisrepeated.
TheloopFrompointisthelastframeinaloopedregion.
TheloopTopointisthefirstframeinaloopedregion.
TheloopCountisthenumberoftimesthesegmentisrepeated.
Whentheanimationbeginsplayback,itstartsatthemarkinpointandplaystotheloopfrompoint.
Ifarepeatisenabled,playbackthenjumpstotheloopToframenumberandcontinuesplayback.
ThenumberoftimesloopFromisencounteredismonitored.
WhenthiscountmatchesloopCount,thestillstoredoesnotjumpbacktotheloopTopointandplaystothemarkoutpoint.
AspecialcaseofloopCount(-1)allowstheloopregiontorepeatforever.
NotethatloopFromisnormallyafterloopTo.
IfloopToissetafterloop-From,andloopCountisnotzero,thestillstorewilljumpfromtheloop-FrompointtotheloopTopointthenplaytothemarkoutpoint.
Norepeatsoccur,butthematerialbetweenloopFromandloopToisskipped.
KeyOffsetVideo+keyimagesareoftencapturedintwopasses,oneforthevideoandoneforthekey.
Foranimations,temporalalignmentofthevideoandkeycomponentsmaybedifficultinatwo-passcapture.
ThekeyOffsetparam-eterallowsthetimingofthekeysignaltobeslippedrelativetothevideosothatthetwoplaybackinsynceveniftheyarecapturedoutofsync.
Animationsthataregeneratedratherthancapturedwillprobablynothavevideotokeysyncproblemsandwillnotneedtoadjustkeyoffset.
Butthekeyoffsetmayneedtobeconsideredwhenimportingstillstoreanimationsthatwerecapturedonthestillstore.
Thisparameterisnotcurrentlyimplemented,andshouldbesetto0.
Thismeansatthistimethevideoandkeyportionsofavideopluskeyanimationmustbetemporallyaligned.
146SwitcherProducts—ProtocolsManualSection6—StillStoreImageFileFormatSwitcherProducts—ProtocolsManual147IndexSymbols.
gvifileStillStoreformat132AActivitycheck,DigitalEffectsI/F111AddressByte44AllStopCommand88EffectsAddresses88,89AutoandKeyTransitionRateCommands67EffectsAddresses68TransitionRate68BBaudRatechangingtallyportsetting15baudratesserialtally15BreakCharacter42BusController42ByteCount45ByteFormatEffectsAddressesTimelineControlCommands84,85EffectsAddresses,LearnandRecallE-MEMRegisterCommands76,77,86EffectsRegisterNumber,LearnandRecallE-MEMRegisterCommands75KeySource,SplitKeyCommands59LearnMode,LearnandRecallE-MEMRegisterCommands73LoadOption,SaveandLoadDataCommandsE-MEM81RMem81SourceMem81SuitePrefs81SystemConfig81UserPrefs81RecallMode,LearnandRecallE-MEMRegisterCommands74SaveOption,SaveandLoadDataCommandsE-MEM80RMem80SourceMem80SuitePrefs80SystemConfig80UserPrefs80TransitionModeCommand66TransitionRateHDbyte,AutoandKeyTransitionRateCommands69TransitionRateTNbyte,AutoandKeyTransitionRateCommands69TransitionRateUNbyte,AutoandKeyTransitionRateCommands70CCCIR601StillStoreformat131colorimetryStillStore133CommandAcceptbit46CommandCodeByte45command/messageblock44Command/MessageBlockStructure44Commands45AllStop88AutoandKeyTransitionRate67Learn(PBusII)99LearnandRecallE-MEMRegister71PreviewBus57PushbuttonSelectandControl59Query(PBusII)102Read(PBusII)103Recall(PBusII)100SaveandLoadData78SaveandLoadStatus82SoftwareVersion90SourceBus50SourceSelect55SplitKey58TimelineControl83TransitionMode65148SwitcherProducts—ProtocolsManualIndexTrigger(PBusII)101WipePattern63Write(PBusII)104communicationerrors46ContributionTallyCommunications26ExternalProcessing19Kalypso16Kayenne30Zodiak16ContributionTallyCommandCodesKalypso25Zodiak25ContributionTallyMessageParsingKalypso28Kayenne39Zodiak28ContributionTallyMessageStructureKalypso26Kayenne30Zodiak26ContributionTallyOutputStatusKayenne36cropStillStoreformat144DDataFieldFormat,TimelineControlCommands86datafileStillStoreformat132DigitalControlInterface42DigitalEffectsInterfaceActivityCheck111Examples124–127GeneralBackground105GeneralProtocolNotes106MessageFormat113,116Issue117ParameterArticle118ReturnCode120SendEvent119Set115Subscribe115Unsubscribe116MessageTiming107OtherCommandSpecifics122Parameters121RunningEffects112SourceSelection109Near/FarFront/Back109SourceHold110Subscription112Tally106,110TransmissionMediaandProtocols123documentationonline4EeDPMContributionTallyKayenne35EffectsAddressByte45EffectsAddressesAllStopCommand88,89AutoandKeyTransitionRateCommands68LearnandRecallE-MEMRegisterCommands72,73LearnandRecallE-MEMRegisterCommandsByteFormat76,77,86PushbuttonSelectandControlCommands60SaveandLoadDataCommands78SaveandLoadStatusCommands82SourceBusCommands51,52SourceSelectCommand56,57SplitKeyCommands58TimelineControlCommands83TransitionModeCommand65WipePatternCommand63E-MEMandPBusII94Errordetection46Examples,DigitalEffectsInterface124–127ExternalProcessing,ContributionTally19FFAQdatabase4fencedimageStillStoreformat132frameaccuratecontrolPBusII96frequentlyaskedquestions4FTPSwitcherProducts—ProtocolsManual149IndexStillStoreformat132GGrassValleywebsite4gvafileStillStoreformat132Hhandshaking46HDfilesizeStillStoreformat139HDimagedataStillStoreformat139IimagehandleStillStoreformat132ImageStoreContributionTallyKayenne36IsoTally12KKaleidoscopePBusII95KayenneContributionTally30keyoffsetStillStoreformat145KeyerModifications12LLearnPBusII99LearnandRecallE-MEMRegisterCommands71EffectsAddresses72,73Registers75linerateHDStillStore142Look-aheadTally11loopsStillStoreformat145MM/EContributionTallyKalypso18Kayenne32Zodiak18markin/outStillStoreformat145MessageFormatDigitalEffectsI/F113Issue117ParameterArticle118ReturnCode120SendEvent119Set115Subscribe115Unsubscribe116metadataStillStoreformat141metadatafileStillStoreformat132ModeByte,TransitionModeCommand66ModeByte-DSK,TransitionModeCommand66ModelNumbers,SoftwareVersionCommands90NNames14NTSCTransitionRate68OOn-airTally11onlinedocumentation4OtherCommandSpecifics,DigitalEffectsI/F122OutputContributionTallyKalypso21Zodiak22outputcontrolStillStoreformat143outputfreezeStillStoreformat144OutputTally11150SwitcherProducts—ProtocolsManualIndexPpackeddataStillStoreformat131pairedfilesStillStoreformat132PALTransitionRate68Parameters,DigitalEffectsI/F121PBusIIcommandstructure97controlleddeviceidentification98effectnumbers95E-MEM94frameaccuratecontrol96hardwareinterface96Kaleidoscope95Learn99messages97protocol93Query102QueryResponse102Read103Recall100systemdescription93Trigger95,101Write104WriteResponse104PeripheralBusIIseealsoPBusIIPeripheralprotocol93pixelgroupHDStillStore139positionStillStoreformat144PreviewBusCommand57SourceNumbers57ProcessingLoops13progressivescanbitHDStillStore142ProtocolErrorbit46PushbuttonSelectandControlCommands59EffectsAddresses60PushbuttonNumbers61,62QQueryPBusII102QueryresponsePBusII102RReadPBusII103ReadyState49RecallPBusII100Requests45RunningEffects,DigitalEffectsI/F112SSaveandLoadDataCommands78EffectsAddresses78LoadOptionByteFormats81Name78RegNumber78SaveOptionByteFormats80SaveandLoadStatusCommands82EffectsAddresses82StatusMessage82SDfilesizeStillStoreformat136SDimagedataStillStoreformat136SelectionTally12serialdataword41SerialInterfaceProtocolState43SerialTally15shapedvideoStillStoreformat134SMTPTE274M&296MStillStoreformat131softwaredownloadfromweb4SoftwareVersionCommands90ModelNumbers90VersionNumber90SourceIDs14names14SourceBusCommands50EffectsAddresses51,52SourceNumbers53,54SwitcherProducts—ProtocolsManual151IndexSourceIDContributionTallyKalypso17Zodiak17SourceNameContributionTallyKalypso23Kayenne37Zodiak23SourceNumbersPreviewBusCommand57SourceBusCommands53,54SplitKeyCommands59SourceSelectCommand55EffectsAddresses56,57SourceSelectionHold110Near/FarFront/Back109SplitKeyCommands58EffectsAddresses58SourceNumbers59statusmessage46StatusMessage,SaveandLoadStatusCommands82StatusReplies46StillStorecolorimetry133StillStoreContributionTallyKalypso20Zodiak20StillStoreformat.
gvafile132.
gvifile132CCIR601131changes133crop144datafile132fencedimage132FTP132HDfilesize139HDimagedata139HDpixelgroup139imagehandle132keyoffset145linerateforHD142loops145markin/out145metadata141metadatafile132outputcontrol143outputfreeze144packeddata131pairedfiles132position144progressivescanbitforHD142SDfilesize136SDimagedata136shapedvideo134SMTPTE274M&296M131softwarereleasecompatibility133videoconversion133StillStorehardwaretypes131SubscribeParameterService116Subscription,DigitalEffectsI/F112SwitcherModelFeaturesSummary91switchermodelssupporting93TTallyBackgroundInformation10CalculationBasics12Iso12KalypsoSystemOverview9KayenneSystemOverview10Look-ahead11On-air11Output11RelayOutputs14Selection12Serial15System13Types11ZodiakSystemOverview9TallyPortchangingserialsettings15TallySourceIDsKayenne31Tally,DigitalEffectsI/F110TimelineControlCommands83DataFieldFormat86EffectsAddresses83TransitionMixerModifications13TransitionModeCommand65EffectsAddresses65ModeByte66ModeByte-DSK66152SwitcherProducts—ProtocolsManualIndexTransitionRate68TransmissionMediaandProtocols,DigitalEffectsI/F123TriggerPBusII95PBusII101UUpdateContributionTallyKalypso25Kayenne38Zodiak25VVersionNumberSoftwareVersionCommands90videoconversionStillStoreformat133Wwebsitedocumentation4websiteFAQdatabase4websiteGrassValley4websitesoftwaredownload4WipePatternCommand63EffectsAddresses63WipeNumbers64WritePBusII104WriteResponsePBusII104