Home

Vela CineCast®

1. 2 Software Installation 2 Svstem Requirements 1 T Trick Modes 00000 8 U Unicode 2 224 e 7 V Video Monitor o oooccococ o o 2 Virtual Memory Paging 2 W Windows 2000 1 2 Windows NT 000 1 2 Index
2. SOURCE PrimarySelect Select Primary Audio source MODE PrimaryStereo Select Primary Stereo mode SOURCE SecondarySelect Select Secondary Audio source MODE SecondaryStereo Select Secondary Stereo mode BOOL SwapLRChn Swap Left Right channels for each source SHORT FadeTime Transition time for fade between clips BYTE VideoSwitch Switch video source Return Value See page 120 for FUNC_STATUS definition Comments e This command is supported only by the CineCast Quad Pro e Video switching requires both channels to be genlocked to the same genlock source VideoSwitch is defined as 0x0 No change 0x2 Video is switched to MPEG output 0x3 Video is switched to MPEG output of adjacent channel pair e See page 122 for MODE definition e See page 126 for SOURCE definition e See page 128 for for Fade Time Table Listing of Public Functions 14 CineCast API Developer s Guide Version 2 6 AVFade C Methods BOOLEAN Cinecast AVFade SOURCE PrimAudio SOURCE SecAudio BOOL EnableVideo BOOL EnableAudio BOOL FadeToBlack SELECT VideoSource BYTE FadeVideo BYTE FadeAudio BOOLEAN binline BYTE Mode Description This function provides both audio and video fading capability Parameters SOURCE PrimAudio Select Primary Audio source SOURCE SecAudio Select Secondary Audio source BOOL EnableVideo Enable Video Switch BOOL EnableAudio Enable Audio Switch BOOL FadeToBlack Fade to black during transi
3. BOOL Enable TRUE Enable FALSE Disable WaitForCondition Return Value See page 120 for FUNC_STATUS definition Comments e Use WAITFORCONDITION for synchronous wait Listing of Public Functions Chapter 2 API Development 35 ErrorMask C Calls FUNC STATUS ErrorMask SHORT Port MPEG ERROR MASK Error FUNC STATUS ErrorMaskinlined SHORT Port MPEG_ERROR_MASK Error BOOL binline BYTE Mode C Methods FUNC_STATUS CDecoder ErrorMask MPEG_ERROR_MASK Error FUNC_STATUS CCinecast ErrorMask MPEG_ERROR_MASK Error BOOL binline BYTE Mode Description This function will return MPEG ERROR bit mask which indicates the latest MPEG Stream or Hardware errors encountered Parameters SHORT Port Port number of decoder to accept the command MPEG ERROR MASK Error Structure storing the error mask BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC_STATUS definition Comments e The Error Mask will be cleared every time this function is called This allows the user to poll and check for changes in the state Use this function to monitor Recovered Data Genlock Sync Lip Sync SCSI Not Ready SCSI Time Out End Of Data signal SCSI Write Protect SCSI Unit Attention Microcode Changed signal and Wait For 2 Frames signal e See
4. AC 3 Dolby Digital e DecodeOrder is defined as 0x0 Auto 0x1 MPEG 0x2 AC 3 Dolby and Dolby Digital are trademarks of Dolby Laboratories Listing of Public Functions 86 CineCast API Developer s Guide Version 2 6 SessionActive C Call BOOL SessionActive SHORT Port C Method BOOL CDecoder SessionActive Description Returns Active status of the current playback thread Parameters SHORT Port Port number of decoder to accept the command Return Value TRUE Playback thread active FALSE Playback thread inactive Comments None Listing of Public Functions Chapter 2 API Development 87 SetEventLevel C Call VOID SetEventLevel SHORT Port DEBUG_LEVEL Level C Method VOID CDecoder SetEventLevel DEBUG_LEVEL Level Description Sets the Event Log to the desired level of messaging to aid in debugging of applications Parameters SHORT Port Port number of decoder to accept the command DEBUG_LEVEL Level Desired level of debug messages Return Value None Comments e Function will accept 0 as a DISABLE option e See page 119 for DEBUG_LEVEL definition Listing of Public Functions 88 CineCast API Developer s Guide Version 2 6 SetMpegPath C Call FUNC STATUS SetMpegPath SHORT Port LPCSTR NewPath C Method FUNC STATUS CDecoder SetMpegPath LPCSTR NewPath Description This function will set the default path of the clip location Par
5. API Development 41 Flushinline C Call FUNC STATUS Flushinline SHORT Port C Method FUNC STATUS CDecoder Flushinline Description Flushes all inline commands previously sent Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions 42 CineCast API Developer s Guide Version 2 6 FrameAdvance C Calls FUNC STATUS FrameAdvance SHORT Port FUNC STATUS FrameAdvanceCC SHORT Port DWORD Frames FUNC STATUS FrameAdvanceCclnlined SHORT Port DWORD Frames BOOL binline BYTE Mode C Methods FUNC_STATUS CDecoder FrameAdvance FUNC STATUS CCinecast FrameAdvance DWORD Frames BOOL binline BVTE Mode Description Advances the video one frame at a time Parameters SHORT Port Port number of decoder to accept the command DWORD Frames Number of frames to advance BOOL binline FALSE Commands are executed immediatelv TRUE Commands will remain pending until the specific event occurs BXTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC STATUS definition Comments e CineCast Quad Pro decoders advance the given number frames Listing of Public Functions Chapter 2 API Development 43 FrameFreeze C Call FUNC_STATUS FrameFreeze SHORT Port C Method FUNC STATUS CDecoder FrameFreeze Descripti
6. BOOL ErrRcvv STREAM Stream UCHAR PreBlack DWORD FrameCount WORD PostBlack TRIGGER TrgEvent BYTE Chroma UCHAR Control C Methods FUNC_STATUS CDecoder MpegPlay BOOL Trigger BOOL Pause BOOL MidStrm BOOL ErrRcvy STREAM Stream UCHAR PreBlack DWORD FrameCount WORD PostBlack FUNC STATUS CCinecast MpegPlay BOOL Trigger BOOL Pause BOOL MidStrm BOOL ErrRcvv STREAM Stream UCHAR PreBlack DWORD FrameCount WORD PostBlack FUNC STATUS CCinecast MpegPlay BOOL Trigger BOOL Pause BOOL MidStrm BOOL ErrRcvy STREAM Stream UCHAR PreBlack DWORD FrameCount WORD PostBlack TRIGGER TrgEvent BYTE Chroma UCHAR Control Description Starts decoder playback Parameters SHORT Port Port number of decoder to accept the command BOOL Trigger TRUE External trigger start FALSE Immediate playback BOOL Pause TRUE Pause on non black video frame FALSE Immediate playback BOOL MidStrm TRUE Search for next valid sequence header FALSE Immediate playback BOOL ErrRcvv TRUE Automatically pause when data underflow FALSE Stop playback go to black when data underflows STREAM Stream Stream type of clip UCHAR PreBlack Number of black frames to display before clip start DWORD FrameCount Number of frames to play back Listing of Public Functions Chapter 2 API Development 63 WORD PostBlack Number of black frames to displav after clip end TRIGGER TrgEvent Source for event to start plavback
7. C Method FUNC STATUS CCinecast AudioGain WORD PrimaryAudio WORD SecondarvAudio BOOL PrimarvHeadroom BOOL SecondarvHeadroom BOOL binline BVTE Mode Description Adjusts audio gain control Parameters SHORT Port Port number of decoder to accept the command WORD PrimarvAudio Primarv Audio gain level in dB WORD Secondarv Audio Secondarv Audio gain level in dB BOOL PrimarvHeadroom TRUE 20dB FALSE 18dB BOOL SecondarvHeadroom TRUE 20dB FALSE 18dB BOOL binline FALSE Commands are executed immediatelv TRUE Commands will remain pending until the specific event occurs BXTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC STATUS definition Comments e This command is supported only by the CineCast Quad Pro Listing of Public Functions Chapter 2 API Development 13 AVChannelSelect C Call FUNC STATUS AVChannelSelect SHORT Port SOURCE PrimarySelect MODE PrimaryStereo SOURCE SecondarySelect MODE SecondaryStereo BOOL SwapLRChn SHORT FadeTime BYTE VideoSwitch C Method FUNC_STATUS CCinecast AVChannelSelect SOURCE PrimarySelect MODE PrimaryStereo SOURCE SecondarySelect MODE SecondaryStereo BOOL SwapLRChn SHORT FadeTime BYTE VideoSwitch Description Controls output selection for the two audio outputs primary and secondary from six possible sources Parameters SHORT Port Port number of decoder to accept the command
8. Discrete Out 1 on BOOL Svnci TRUE Change on Vsvnc FALSE Change immediately BOOL GPOut2 TRUE Discrete Out 2 on BOOL Sync2 TRUE Change on Vsync FALSE Change immediately BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC_STATUS definition Comments e This command is supported only by the CineCast Quad Pro Listing of Public Functions Chapter 2 API Development 91 SetSettings C Call BOOL SetSettings SHORT Port SETTINGS pSettings C Methods BOOL CDecoder SetSettings SETTINGS pSettings BOOL CSCSI SetSettings SETTINGS pSettings BOOL CCinecast SetSettings SETTINGS pSettings Description This function will store the decoder settings in Memory Parameters SHORT Port Port number of decoder to accept the command Return Value TRUE if set succeeds FALSE if set fails Comments e Use this function along with GETSETTINGS SAVESETTINGS and RESTORESET TINGS to make the decoder settings persistent between executions INITIALIZE must be called to effect the settings onto the decoder Listing of Public Functions 92 CineCast API Developer s Guide Version 2 6 SetVideoPassThrough C Call FUNC STATUS SetVideoPassThrough SHORT Port VIDEO PASS MODE mode C Method FUNC STATUS CSCSI
9. Download new decoder firmware microcode svnch Sets the Event Log to the desired level of messaging Returns Active State of Firmware Upgrade Download new decoder firmware microcode asvnch Returns Result of Firmware Upgrade Set the video standard output to NTSC or PAL Enable the audio on the second channel Generate color bar test pattern and audio tone Turn video on or off Reset the MPEG buffer pointers Detects transition between clips Enable WaitForCondition at the end of plavback Enable field freeze for Pause or Pause on Underrun Flush all inline commands previously sent Enable frame freeze for Pause or Pause on Underrun Enable decoder to synchronize to a genlock input source Mute audio output Reset the decoder s audio and video circuits Set decoder to standalone mode with no genlock input Notify of playback decoder events Listing of Public Functions AVTransportPacketld ErrorMask GetMpegPath LastPlayBackError PlaybackStarted ReadyForNextVideo SetMpegPath 112 CineCast API Developer s Guide Version 2 6 NCR Play BackToBackVideo Playback selected clip following the current video MpegPlay v Start decoder playback NoBlack Enable seamless transition between clips NonStop Enable the current video clip to repeat Plav v Plavback selected clip Stop Stop the current video clip plaving NCR Trick Mode FastMotion Play the current video clip in fast motion FrameAdvance Advance the video on
10. Li A SS oe Gre Leeds Rec the beat a hs 1 Operating SYSTEM wick cee ed le Ll en dine Bae HEE ae ae 1 Supported Development Systems 0 0000 1 System Requirements 0000 1 Decoder Installation 00 2 Software Installation eee 2 Customer Support 3 Chapter 2 API Development oooooococ nn 5 CineCast SDK QRA 6 kk ea keia hira aiana e i E aia 7 Listing of Public Functions sasas saaana 11 AudioChannelFade 0 000 eee eee eens 11 AudioGaini l sala A ed oh ae 12 AVChannelSelect ecos ci eed a ee a es aes ae 13 AN i To l e tise che shy ative A peste cede eben 14 AV Stream cia cd ee SES lara har i snd see oon dies ae ke SS 15 PN SYIICI id e A a ad ati il so vi na 16 AVTransportPacketld LL cece ee eae 17 BackgroundColor 6 18 BackToBackVideo e eee eens 19 BlacklLe Velas casa a a A SA oN Ba i le ible oS 21 Blank st AT ie Gath ia g a e ka a nt 22 Blankkevelteza i 01 a A A AY oe 23 Butterkeset 1 fic A cin ti bad ai cet ad ad ma fama ch A be 24 ClosedCaptionReorder L L 25 DataUnderlowErrorCount ena 26 DecoderDetect ecc a a ad des tadas 27 DecoderShutdoWN oooooo na 28 DefaultResolution curo ro a A as alaba 29 DefaultVideoStandard 0 0 0 0 cc eee eens 30 EnableFreezeOnLast 0 0 0 0 cc eee eens 31 EnableGUISignali i Ar eh ee ei deed a A ees 32 Table of Contents iv CineCast API Developer s Guide Version 2 6 EnablePlavbackSignal L L
11. State of GPIN2 Comments None Listing of Public Functions Chapter 2 API Development 47 GainU C Call FUNC STATUS GainU SHORT Port SHORT Data C Method FUNC STATUS CSCSI GainU SHORT Data Description Sets the GainU Level to the desired point Parameters SHORT nPort Port number of decoder to accept the command SHORT Data Range is 0x00 to OxFF Return Value See page 120 for FUNC_STATUS definition Comments e Use of this command may drastically reduce picture quality Only experi enced users should attempt to customize the NTSC PAL video Consult with Vela for additional information Listing of Public Functions 48 CineCast API Developer s Guide Version 2 6 GainV C Call FUNC_STATUS GainV SHORT Port SHORT Data C Method FUNC_STATUS CSCSI GainV SHORT Data Description Sets the GainV Level to the desired point Parameters SHORT nPort Port number of decoder to accept the command SHORT Data Range is 0x00 to OxFF Return Value See page 120 for FUNC_STATUS definition Comments e Use of this command may drastically reduce picture quality Only experi enced users should attempt to customize the NTSC PAL video Consult with Vela for additional information Listing of Public Functions Chapter 2 API Development 49 Genlock C Calls FUNC STATUS Genlock SHORT Port BOOL AutoSwitch FUNC STATUS GenlockCC SHORT Port BOOL AutoSwitch SELECT Sou
12. method was called For example CDecoder Channel Channel Open 3 Channel Initialize Channel Play Clip ErrorRecovery Midstream Pause Trigger Type PreBlack CineCast SDK Q amp A 10 CineCast API Developer s Guide Version 2 6 Frames PostBlack Offset BOOL Freeze TRUE USHORT WhichFrame 5 USHORT Repeat 5 Channel Stop Freeze Channel PauseVideo Channel FastMotion WhichFrame Channel SlowMotion WhichFrame Repeat Channel FrameAdvance Channel Resume This will assign Port 3 decoder to Decoder through Open 3 Initialize and then Play the clip 5 How do I get back the decoder to its factory state For C interface implementation FactorySettings Port Initialize Port For C interface implementation Channel FactorySettings Channel Initialize 6 What does the sample code show Three sample applications are included in the installation The VC directory contains a Visual Studio 6 0 Unicode playback application using the C interface The VB directory contains a Visual Basic 6 0 playback application using the C interface The ConsoleCpp directory includes a console application using the C interface CineCast SDK Q amp A Chapter 2 API Development 11 Listing of Public Functions AudioChannelFade C Methods FUNC_STATUS Cinecast AudioChannelFade SOURCE PrimarySelect MODE PrimaryStereo SOURCE SecondarySelect MODE Secondary Stereo BOOL SwapLR
13. 0x05 AUDIOI PID 0x06 AUDIO2 PID 0x07 AUDIO1 PID SEQ 0x86 AUDIO2 PID SEQ 0x87 PID TXPE typedef struct PRODUCT DATA UCHAR Vendor 8 UCHAR ID 16 UCHAR Revision 4 UCHAR Serial 16 PRODUCT_TYPE PPRODUCT_TYPE typedef struct REVISION DATA BYTE Decoder_Firmware_Revision 4 BYTE SCSI Programmable_Logic_Revision 4 BYTE MPEG_Programmable_Hardware_Revision 4 BYTE SCSI_Controller_Hardware_Revision 4 BYTE SCSI_Controller_Firmware_Revision 4 BYTE MPEG_Decoder_Hardware_Revision 4 BYTE Hardware_Revision 4 BYTE Res2 0 5 BYTE Model 1 BYTE Second_Audio 1 BYTE Genlock 1 BYTE Res3_0 3 BYTE Firmware_Build_Data 8 REVISION_TYPE PREVISION TXPE Definitions 124 CineCast API Developer s Guide Version 2 6 typedef enum SELECT OWN CHNI ADJ SELECT typedef struct SETTINGS Generic VIDEO_RESOLUTION Resolution DefaultResolution BOOLEAN FrameFreeze FrameFreeze FieldFreeze DWORD Mpegdecode ErrorMask BOOLEAN Seamless NoBlack UCHAR PreBlack MpegPlayO WORD PostBlack STREAM StreamType BOOLEAN Trigger TRIGGER TriggerEvent BOOLEAN AutoSwitch Genlock BOOLEAN Genlock SCSI 1 2 4 8 VIDEO STANDARD Videostd DefaultVideoStandard BYTE Course AVSynchQ BYTE Medium BYTE Fine BOOLEAN ErrorRecovery MpegPlay PlayO BackToBack Video BOOLEAN Freeze StopO BOOLEAN
14. EnablePlayCallback EnablePlaybackSignal BOOLEAN SoftTrigger MpegPlay PlayQ BackToBack Video BYTE LogLevel SetEventLevel BYTE PassMode SetVideoPassThrough BYTE Volume VolumeControl BYTE Channel SHORT BlackLevel BlackLevel Definitions Chapter 2 API Development 125 SHORT BlankLevel SHORT GainU SHORT GainV AUDIO FUNC AFunc AUDIO DATA AData CineCast Quad Pro COLORMODE ColorMode BYTE Y BYTE Cb BYTE Cr DWORD BGColor BOOLEAN Temporal BOOLEAN Pal Setup Dynamic BOOLEAN AudioChannelFade SOURCE PrimarySelect MODE PrimaryStereo SOURCE SecondarySelect MODE SecondaryStereo BOOLEAN SwapLRChn SHORT FadeTime BYTE VideoSwitch WORD PrimaryAudio WORD SecondaryAudio BOOLEAN PrimaryHeadroom BlankLevel GainUQ GainV SwitchAudio BackgroundColor ClosedCaptionReorder DefaultResolution AudioChannelFade AudioGain BOOLEAN SecondaryHeadroom BOOLEAN FreezeFrame SELECT GenlockSource BOOLEAN LTC BOOLEAN VITC BYTE OutputSource WORD LineField1 WORD LineField2 BOOLEAN SecChnEnable BufferReset Genlock LtcVitcTimeCode SecondChannel Definitions 126 CineCast API Developer s Guide Version 2 6 BXTE DecodeOrder BOOLEAN AG3 BOOLEAN GPOutI SetOutputDiscrete BOOLEAN Syncel BOOLEAN GPOut2 BOOLEAN Sync2 BYTE SlowSpeed SlowMotion
15. Hour SMPTE Hour SHORT Minute SMPTE Minute SHORT Seconds SMPTE Second SHORT Frames SMPTE Frame Return Value TRUE if playback thread ready to accept another clip FALSE if playback has not transitioned to the next clip Comments e SMPTE time codes can be read from three different sources 1 LTC Output time code 2 MPEG GOP Header SMPTE time code 3 LTC Input time code e See page 127 for TCSRC definition Listing of Public Functions 78 CineCast API Developer s Guide Version 2 6 ReadvForNextVideo C Call BOOL ReadvForNextVideo SHORT Port C Method BOOL CDecoder ReadvForNextVideo Description Returns BOOL to indicate plavback thread can accept the next video in a plavlist Parameters SHORT Port Port number of decoder to accept the command Return Value Not vet documented Comments e Use this function to monitor the playback thread during the implementation of a playlist e Use SETNEXTVIDEO to cue next clip Listing of Public Functions Chapter 2 API Development 79 RestoreSettings C Call BOOL RestoreSettings SHORT Port C Methods BOOL CDecoder RestoreSettings BOOL CSCSI RestoreSettings BOOL CCinecast RestoreSettings Description This function will retrieve the previously saved decoder settings stored in the Registry Parameters SHORT Port Port number of decoder to accept the command Return Value TRUE if restore succeeds FALSE if restore fail
16. Return Value See page 120 for FUNC_STATUS definition Comments e CineCast Quad Pro version of Fast Motion only has one speed Listing of Public Functions 38 CineCast API Developer s Guide Version 2 6 FieldFreeze C Call FUNC STATUS FieldFreeze SHORT Port C Method FUNC STATUS CDecoder FieldFreeze Description Enables field freeze when using the Pause or Pause on Underrun Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC_STATUS definition Comments e Use FRAMEFREEZE to pause on frame instead of field Listing of Public Functions Chapter 2 API Development 39 FifoBufferStatus C Call BYTE FifoBufferStatus SHORT Port C Method BYTE CDecoder FifoBufferStatus Description Returns MPEG Decoder Status Page 30h value of Fifo Buffer Status Parameters SHORT Port Port number of decoder to accept the command Return Value Fifo Buffer Status Comments None Listing of Public Functions 40 CineCast API Developer s Guide Version 2 6 FlushChannelBuffer C Call FUNC STATUS FlushChannelBuffer SHORT Port Description Stops plavback after all data in the decoder s buffers is used Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC STATUS definition Comments e Equivalent to RESET BUFFER 0x21 Listing of Public Functions Chapter 2
17. SetVideoPassThrough BOOL AdjChn Description Switches the decoder output from MPEG digital video to analog genlock video Parameters BOOL AdjChn SHORT Port Port number of decoder to accept the command VIDEO PASS MODE mode Next Vertical Sync External Trigger End of Playback Video only Return Value See page 120 for FUNC_STATUS definition Comments e Not supported by CineCast Quad Pro e See page 127 for VIDEO PASS MODE definition Listing of Public Functions Chapter 2 API Development 93 SetYuvMode C Call FUNC_STATUS SetYuvMode SHORT Port YUV_TYPE Yuv C Method FUNC_STATUS CSCSI SetYuvMode YUV_TYPE Vuv Description Changes the output mode to Betacam YUV SVHS or RGB PAL NTSC will be detected by the decoder when it parses the MPEG stream Parameters SHORT Port Port number of decoder to accept the command YUV_TYPE Yuv Set mode to Betacam YUV SVHS or RGB Return Value See page 120 for FUNC_STATUS definition Comments e Only valid for SCSI 2 YUV enabled decoders e See page 128 for YUV_TYPE definition Listing of Public Functions 94 CineCast API Developer s Guide Version 2 6 SlowMotion C Calls FUNC STATUS SlowMotion SHORT Port USHORT which USHORT repeat FUNC STATUS SlowMotionCC SHORT Port BYTE Speed FUNC STATUS SlowMotionCCInlined SHORT Port BYTE Speed BOOL binline BYTE Mode C Methods FUNC_STATUS CDecoder SlowMotion USHORT SlowWhich
18. StandAlone SetEventLevel e CSCSI Initialize calls the following functions CDecoder Initialize DefaultVideoStandard AVSynch VolumeControl BlackLevel BlankLevel GainUQ GainV e CCinecast Initialize calls the following functions CDecoder Initialize BackgroundColor ClosedCaptionReorder DefaultResolution Ltc VitcTimeCode SecondChannel SetOutputDiscrete AudioGain Listing of Public Functions 58 CineCast API Developer s Guide Version 2 6 IsNonStop C Call BOOLEAN IsNonStop SHORT Port C Method FUNC STATUS CDecoder IsNonStop Description Returns last NonStop value Parameters SHORT Port Port number of decoder to accept the command Return Value BOOLEAN TRUE I FALSE Comments None Listing of Public Functions Chapter 2 API Development 59 LastDecoderCommand C Call DWORD LastDecoderCommand SHORT Port C Method DWORD CDecoder LastDecoderCommand Description Returns MPEG Decoder Status Page 30h value of last decoder command Parameters SHORT Port Port number of decoder to accept the command Return Value Last decoder command Comments None Listing of Public Functions 60 CineCast API Developer s Guide Version 2 6 LastPlayBackError C Call FUNC_STATUS LastPlayBackError SHORT Port Description Returns the FUNC_STATUS return code from the last playback thread Parameters SHORT Port Port number of decoder
19. VCR Trick Mode DWORD SkipFrames FrameAdvance WORD FastWhich FastMotion WORD SlowWhich SlowMotion WORD SlowRepeat TCSRC TCSource ReadTimeCode BYTE Chroma MpegPlay SETTINGS PSETTINGS typedef enum _SOURCE IBM Crvstall Crystal2 AdjIBM AdjCrvstall AdjCrystal2 SOURCE typedef enum STREAM AutoDetect 0x00 System 0x10 VideoElm 0x11 AudioElm 0x12 Program 0x20 Transport 0x28 VideoPES 0x21 Definitions Chapter 2 API Development 127 AudioPES 0x22 STREAM typedef enum _TCSRC LTCOut GOP LTCIn TCFrames TCSRC typedef enum _TRIGGER GPINI 0x0 GPIN2 0x1 LTCIN 0x2 EOPLAY 0x4 TRIGGER typedef enum VIDEO PASS MODE DISABLED VERTICAL_SYNC TRIGGER_LOW PLAYBACK VIDEO_ONLY VIDEO_PASS_MODE typedef enum _VIDEO_RESOLUTION NTSC_601 0 NTSC SIE PAL 601 NTSC HALF DI PAL HALF DI PAL SIF VIDEO RESOLUTION Definitions 128 CineCast API Developer s Guide Version 2 6 typedef enum VIDEO STANDARD NTSC60hz 0x3 NTSC 4 43 60HZ CCIR 13 5MHZ NTSC50hz 0x4 NTSC 4 43 50HZ CCIR 13 5MHZ NTSC M60hz OxD NTSC M 60HZ CCIR 13 5MHZ PAL_BGS50hz 0x85 PAL B G 4 43 50HZ CCIR 13 5MHZ PAL_M60hz 0x09 PAL M 60HZ CCIR 13 5MHZ PAL_N50hz Ox8A PAL N 50HZ CCIR 13 5MHZ PAL_N50hzCmb 0x86 VIDEO STANDARD typedef enum XUV TXPE SMPTE MO
20. ee RE Bed Pe a 99 TestPattem sii ces A ein Sod he a A tak Man Me ee ee haa 100 TIMECOQE 4 5 8 A a eR L 101 TrickModeFrameCount 1 0 0 0 000 eee eee 102 UnderFlowBit lt lt occ 24 ik een eae Be e ee eae ech 103 UpgradeActive 0 2 0 0 eens 104 UpgradeFirmWare L 105 UpgradeResult eee 106 UnusedFiFoDataAfterStop eee 107 VideoLevel socios a e Ga asa f g lat fa a aa Sa 108 VolumeControl fa is ia cua dd lo tA SEA dd dia tas 109 WaitForCondition 0 00 00 eee eee 110 Table of Contents vi CineCast API Developer s Guide Version 2 6 CLASSICDecoder i sas i A in al ABE GOD ON he 111 CLASSEESGSI si a A a a da a ae 115 GLASSTE INEe AStis i ia a TA A a ee a e Res 116 Definitions xi Bus ts ee Seas a a IA A ree oes 118 Peace l Aw ele e a t ant ive Leas rangement ate eres AUDIO_DATA 118 bi isa Sebi Rater eat tha dean NA AUDIO_FUNC 118 Mac dai deo adore eh roe et eee Pee ae ek AV STREAM CMD 118 l pe se A ea ter MANN IT BOARD INFO TVPE PBOARD INFO TVPE 119 E E E EE E EET E oak eae hes COLORMODE 119 O a a Ma LL KAT a ah hon aa ae dene DEBUG LEVEL 119 bla A a cece a ES DECODER TVPE PDECODER TVPE 119 DECODER STATE MASK PDECODER STATE MASK 120 a RA S FUNC_STATUS PFUNC STATUS 121 A st i DL_TYPE PDL_TYPE 121 l AN MPEG_ERROR_MASK 122 l e a A ET ATA AS MODE 122 Mn die dighad Rea ares MPEG_FILE_DETAILS PMPEG_FILE_DETAILS 122 A PID_TYPE 123 E A a oy PRODUCT_T
21. l a ee PO eR ee 67 Pausevideo 4 atte misa bare ea dl Bia sedne Me ee bata alka ib E E Ele 68 Play aaa tans eda dace sath k a fe oan Wide a a aaan E Be 69 PlaybackStamted iii r wet sibtu Sa e gute an tue ee oi a ace ein dete Shen 71 PAY B ridad a g e fen l 72 Table of Contents Table of Contents v ProdlUctinto sa epee asa NED A a Ba A as 73 Qu eveBit Assisi A he eee at a Aa 74 ReadAudiolevel ic rocio aia B dd 75 ReadFrameCouMt i a 76 ReadTimeCodes airan ss ODN a alee ee id 77 ReadyForNextVideo LLL LL 78 RestoreSettings cb ARA rd dada di Sales 79 RESUME vous Il EA AA A Bu A A A d be a t 80 ResumeNormal sis sea si A g aj ee ae ae EE da 81 ResumePlaviziii ini i dt da a ok 82 Revisionintoi s util baka adi Eee att 83 SaveSettin si ii iii Aa haa 84 Se ondcChanneli 2 2080 os hs A be siti da ak ds 85 SOSSIONACIV O a aa 86 SetEventkevelliii reese ee oine dto Did wd bald daa elo g ab do ade 87 SetMpegPath ria AAA a A 88 SetNextVideo 20 Ma lado liada a dd ad ace od 89 SetOutputDiscrete i tocata a ee 90 SEISSMINGS css halo eae ce nd Pad dete dads Goo b oie ead wees 91 SetVideoPassThrough ee 92 SetYUVMode 0 2 tet ol Be Kid Adel isba ed hdd Acie gale Aho eh 93 SIOWMOUON ast isa ees od ha ol ier ied ig dhs da ee ee ee BS 94 SOMRESEL iii E a Pa ee 95 StandAlone s sisien ee te ey ha a 96 SlOP ante inte eee ane ine he ee eee ae ee ee 97 SubcarrierPhase coins iia Pee eS ee 98 SWItCHAUGIO 2 esc ood Goh eee
22. 33 EnableWaitForCondition ooooccocoooono omo 34 ErrOorMaski 1 ss Lada da dt Sea 35 Factory Settings iz ra isnt os et eens it da ia 36 FastMotion vege airida alta B eM oR tna a Seed Mee ae ed Blane 37 FieldFreeze ais wets id dd Ke ii il in and 38 FifoBufferStatus eee eee eee k 39 FlushChannelBuffer 0 0 0 0 0c ccc eee eee eee 40 FIUSHINNING xa ina rati aie oes Oe ON ee ARR id Sana JE 41 FrameAdvan e si l innu a A A AS Re 42 FrameFreeze xi issa ta alada A f B 43 FrameReport coito oP ee ee id eE a 44 GPINTB 24 6 nta diabetes la da 45 GPIN2 Bit otitis a A A a ar eee 46 E A RA 47 Gain 2 Ata a ta ot a ae ae 48 Genlock ys 224 Hc Pact yl lees Ae hoa katie oad ool te He Raed Mee 49 GenlockTIMInG evito pe eek ak is Peed Paes Ss wie Gee 50 GetMPEGFIlSIDTO 3 0 3 5 00t000o gd be kin odie dh be a chars low Roo Le 51 GetMpegPathy 2 ee cee ok b g ab en Pee i ae ee a 52 GetProductlD ss sie 241 ia ioe rodas ile oa 53 GetSettings i i i see ee ee ee A en a a Ta u 54 GetState iia a A a a i Oh eh eee os 55 HorizontalPhase 0 0 cee eee eee 56 Initi li e 323 Dee A TA 57 ISNONStOP ie i hee Geer ee ee ha Rey eee ae 58 LastDecoderCommand o 59 LastPlayBackError 0 0 a aa a e e a Aa E a 60 EteVite TimeCode 20 iii a Da Mh eee 61 MpegPlaw iii a a a E A E E Ga a a ai 62 Mute citas Sha hae A a ee AN 64 NoBlack prendi ik a a A A REGIE Se 65 NONSTOP aen i en hd eae een Ae Pee eae Reel 66 PALB ler Mode coi
23. ATUS definition Comments e Use ENABLEWAITFORCONDITION for asynchronous use of WAITFORCONDITION Listing of Public Functions Chapter 2 API Development 111 CLASS CDecoder Overview The CDecoder class is a base class used to create CScsi and CCinecast classes This class provides the generic and common methods for all decoders The class by itself is will allow playback on any decoder In order to be able to use function ality of the other decoders it is suggested that you use CScsi for SCSI1 SCSI2 SCSIx4 and SCSIx8 decoders While CCinecast class is to be used for only with the CineCast Quad Pro SDI decoders PUBLIC Interface CDecoder v virtual CDecoder CDecoder v Open v Close v Initialize v GetSettings v SetSettings v RestoreSettings v SaveSettings v Setup ProgramDecoder SetEventLevel UpgradeActive UpgradeFirmWare UpgradeResult Setup Static DefaultResolution SecondChannel TestPattern Setup Dynamic Blank BufferReset v EnablePlaybackSignal EnableWaitForCondition FieldFreeze Flushinline FrameFreeze Genlock v Mute SoftReset StandAlone WaitForCondition Class Constructor Class Destructor Open decoder channel device Close decoder channel device Initialize decoder based on the saved settings Return decoder settings stored in the Registrv Store decoder settings in Memorv Retrieve decoder settings stored in the Registrv Store decoder settings in the Registrv
24. BXTE Chroma 4 2 0 or 4 2 2 chroma format UCHAR Control Default 0 Return Value See page 120 for FUNC_STATUS definition Comments e A BUFFERRESET followed by at least 500 k of data written to the decoder must occur before MPEGPLAY may be issued e Do not use in conjunction with PLAY e Chroma is defined as 0x0 IBM 0x1 4 2 0 0x2 4 2 2 e See page 126 for STREAM definition e See page 127 for TRIGGER definition Listing of Public Functions 64 CineCast API Developer s Guide Version 2 6 Mute C Calls FUNC STATUS Mute SHORT Port BOOL Enabled FUNC STATUS Mutelnlined SHORT Port BOOL Enabled BOOL binline BYTE Mode C Methods FUNC_STATUS CDecoder Mute BOOL Enabled FUNC_STATUS CCinecast Mute BOOL Enabled BOOL binline BYTE Mode Description Mutes audio output Parameters SHORT Port Port number of decoder to accept the command BOOL Enabled TRUE Enable FALSE Disable Mute BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 65 NoBlack C Call FUNC STATUS NoBlack SHORT Port UCHAR Seamless C Method FUNC STATUS CDecoder NoBlack UCHAR Seamless Description Enables seaml
25. CSI path id SCSI bus target id SCSI bus logical unit number BOARD INFO TVPE PBOARD INFO TXPE typedef enum COLORMODE Black Blue UserDefined COLORMODE typedef enum DEBUG LEVEL DISABLE CLEAR COARSE MEDIUM FINE DEBUG LEVEL typedef enum _DECODER_TYPE SCSLISA SCSI2_ISA SCSI 4X SCSI 8X DEC SGSI SCSI CC DECODER_TYPE PDECODER_TYPE Definitions 120 CineCast API Developer s Guide Version 2 6 typedef union DECODER STATE MASK volatile ULONG Mask struct unsigned Idle 1 unsigned Playing 1 unsigned Pause 1 unsigned Resume 1 unsigned Stop 1 unsigned Preload 1 unsigned Reset 1 unsigned Mute 1 unsigned UnMute 1 unsigned Test 1 unsigned Slow 1 unsigned Fast 1 unsigned Frame_Advance 1 unsigned Abort_Video 1 unsigned dummy 19 E Il 0 H I Il 4 Il 8 0X10 0x20 0x40 0x40 0x100 0x200 0x400 0x800 DECODER_STATE_MASK PDECODER_STATE_MASK typedef enum _FUNC_STATUS SUCCESSFUL FAILURE CREATE_FILE_ERROR CLOSE_HANDLE_ERROR INVALID_PORT INCORRECT_PORT IOCTL_FAILURE INVALID_BUFFER_LENGTH INVALID FILE TYPE GET FILE SIZE ERROR CREATE FILE MAPPING ERROR MAP VIEW OF FILE ERROR Definitions Chapter 2 API Development 121 END OF FILE READ FILE ERROR NO DECODERS FOUND NULL DECODER BUFFER NO MOVIE FILE NO PLAV THREA
26. Chn SHORT FadeTime BYTE VideoSwitch BOOLEAN binlined BYTE Mode Description This function controls output selection for the two outputs primary and secondary from four possible sources Parameters SOURCE PrimarySelect Select Primary Audio source MODE PrimaryStereo Select Primary Stereo mode SOURCE SecondarySelect Select Secondary Audio source MODE SecondaryStereo Select Secondary Stereo mode BOOL SwapLRChn Swap Left Right channels for each source SHORT FadeTime Transition time for fade between clips BYTE VideoS witch Switch video source BOOLEAN blnline BYTE Mode Return Value See page 120 for FUNC_STATUS definition Comments e This command is supported only by the CineCast Quad Pro e Video switching requires both channels to be genlocked to the same genlock source VideoSwitch is defined as 0x0 No change 0x2 Video is switched to MPEG output 0x3 Video is switched to MPEG output of adjacent channel pair e See page 122 for MODE definition e See page 126 for SOURCE definition e See page 128 for for Fade Time Table Listing of Public Functions 12 CineCast API Developer s Guide Version 2 6 AudioGain C Calls FUNC STATUS AudioGain SHORT Port WORD PrimaryAudio WORD Sec ondarvAudio BOOL PrimarvHeadroom BOOL SecondarvHeadroom FUNC STATUS AudioGaininlined SHORT Port WORD PrimarvAudio WORD SecondarvAudio BOOL PrimarvHeadroom BOOL SecondarvHeadroom BOOL binline BVTE Mode
27. D VIDEO STOP UNABLE TO ALLOC MEM SET FILE POINTER ERROR END OF PLAV INVALID VENDOR INVALID ID UNKNOWN DECODER INVALID MICRO FILE NO PLAV LIST NO MPEG INFO INVALID PLAV LIST INVALID DRIVER VIDEO ABORT INVALID STATE INVALID DECODER COMMAND PLAVBACK ACTIVE INVALID PARAMETER PLAVBACK FAILED WRITE FILE ERROR LAST FUNC STATUS FUNC STATUS PFUNC STATUS typedef enum DL TXPE CHECK FILE 0x4 BURN_FLASH 0x5 DL_TYPE PDL_TYPE Definitions 122 CineCast API Developer s Guide Version 2 6 typedef union ERROR MASK DWORD Mask struct BYTE Res0 BYTE dummy l 2 BYTE Genlock_Loss 1 BYTE Collision 1 BYTE Audio_Channel_Buffer 1 BYTE Audio_Video_Mpeg_Decode 1 BYTE Audio_Video_Channel_Buffer 1 BYTE Lip Svnc 1 BYTE dummy 3 MPEG_ERROR_MASK typedef enum _SMODE Stereo Left Right MODE typedef struct PCHAR szFileName ULONG StreamType ULONG BitRate ULONG FrameCount SHORT HSize SHORT VSize BYTE FrameRateCode ULONG FileKBSize DWORDLONG FileSize pointer to file name SYSTEM PROGRAM TRANSPORT etc Mbps Frame count in file horizontal resolution 704 etc Vertical resolution 480 etc frame code is 4 2997 File Kilobyte Size size of file MPEG FILE DETAILS PMPEG FILE DETAILS Definitions Chapter 2 API Development 123 typedef enum _PID_TYPE VIDEO PID
28. DE 0x00 BETA_MODE 0x01 BETA700_MODE 0x02 SVHS_MODE 0x04 RGB_MODE 0x08 YUV_TYPE Fade Time Table Fade Time Value Total Fade Time Fade Time Value Total Fade Time in msec in msec 1 21 4 msec 9 192 0 msec 2 42 6 msec 10 213 4 msec 3 64 0 msec 11 234 6 msec 4 85 4 msec 12 256 0 msec 5 106 6 msec 13 277 4 msec 6 128 0 msec 14 298 6 msec 7 149 4 msec 15 320 0 msec 8 170 6 msec 16 341 4 msec Note Nominal fade time will be 128 msec fade time Definitions Index A Audio Amplifier 2 Cc CD ROM Drive 2 Customer Support 3 D Decoder Installation 2 Default Settings 10 Definitions 0 00 118 F Factory Settings 10 Fade Time Table 128 H Header Files 0 7 l IDE Hard Drive 1 Inline Commands 6 InLine Mode 0 6 L Library Files 00000 7 M Microsoft Visual Basic 1 Microsoft Visual C 1 O Operating Svstem 1 P Paging Filossera A 2 PCIBUS sta da ida aai 1 Pentium 1 1 Playback Process Flow 6 Public Functions 5 11 Q Q amp A Section o ooooooooooo 7 R RAM Requirements 1 S Sample Code 00000 10 SCSI 2 Hard Drive
29. Listing of Public Functions 96 CineCast API Developer s Guide Version 2 6 StandAlone C Call FUNC STATUS StandAlone SHORT Port C Method FUNC STATUS CDecoder StandAlone Description Enables the decoder to standalone mode without svnchronizing to a genlock input source Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC STATUS definition Comments e Use GENLOCK to enable synchronizing to a genlock input source Listing of Public Functions Chapter 2 API Development 97 Stop C Calls FUNC STATUS Stop SHORT Port BOOL Freeze FUNC STATUS Stoplnlined SHORT Port BOOL Freeze BOOL binline BYTE Mode C Methods FUNC STATUS CDecoder Stop BOOL Freeze FUNC_STATUS CCinecast Stop BOOL Freeze BOOL binline BYTE Mode Description Stops the video clip that is currently playing Parameters SHORT Port Port number of decoder to accept the command BOOL Freeze TRUE Stop the video on the last frame BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions 98 CineCast API Developer s Guide Version 2 6 SubcarrierPhase C Methods BOOLEAN SCSI SetSubcarrierPhase SHORT Data Desc
30. OL CCinecast SaveSettings Description This function will store the decoder settings in the Registry Parameters SHORT Port Port number of decoder to accept the command Return Value TRUE if save succeeds FALSE if save fails Comments e Use this function along with GETSETTINGS SETSETTINGS and RESTORESET TINGS to make the decoder settings persistent between executions INITIALIZE must be called to effect the settings onto the decoder Listing of Public Functions Chapter 2 API Development 85 SecondChannel C Call FUNC STATUS SecondChannelCC SHORT Port BOOL Enable BYTE De codeOrder BOOL AC3 C Methods FUNC_STATUS CDecoder SecondChannel BOOL Enable FUNC_STATUS CSCSI SecondChannel BOOL Enable FUNC_STATUS CCinecast SecondChannel BOOL Enable BYTE DecodeOrder BOOL AC3 Description Enables the audio on the second channel Parameters SHORT Port Port number of decoder to accept the command BOOL Enable TRUE Enable second audio channel BYTE DecodeOrder Audio decode mode BOOL AC3 TRUE for as is downmix FALSE for downmix to two channels Return Value See page 120 for FUNC_STATUS definition Comments e Note that second channel audio decode is not currently supported by firmware e CineCast Quad Pro version of second channel audio The IBM MPEG decod er can only decode 2 channel MPEG Audio The second channel audio decoder can decode either two channel MPEG or Dolby
31. Play MPEG file Play Get port playback status GetState Resume playback Trick Modes Pause Fast Slow Resume Frame Stop PlayBit Exit Figure 2 1 Recommended Process Flow Chapter 2 API Development 7 CineCast SDK Q8A 1 What include header files do I use A For C interface implementation include typedefs h ttinclude CCmds h The typedefs h file includes descriptions of all the type definitions required by the CineCast decoders The CCmds h file includes descriptions for all the CineCast C commands available for the CineCast decoders B For C interface implementation include typedefs h ttinclude CDecoder h The CDecoder h file describes the base interface class which supports all CineCast decoders C For CineCast Prime and 8 Channel decoders SCSI 1 SCSI 2 SCSIx8 specific methods include CCScsi h D For CineCast Quad and Quad Pro decoders SCSIx4 specific methods include CCineCast h E For CineCast High Definition decoders SCSI HD specific methods include CCineCastHD h 2 What library files do I link with The CineCast SDK is implemented in a single Dynamic Link Library CineCastU dll The U in the filename refers to the library as Unicode aware All calls to the library using strings require the strings to be Unicode defined The project should i
32. RODUCT TVPE product PBOARD INFO TVPE board C Method FUNC STATUS CDecoder Productinfo PPRODUCT TVPE product PBOARD INFO TVPE board Description Returns product and SCSI board information on the selected decoder Parameters SHORT Port Port number of decoder to accept the command PPRODUCT_TYPE product Product information PBOARD_INFO_TYPE board SCSI board information Return Value See page 120 for FUNC_STATUS definition Comments e See page 123 for PPRODUCT_TYPE definition e See page 118 for PROARD_INFO_TYPE definition Listing of Public Functions 74 CineCast API Developer s Guide Version 2 6 QueueBit C Call BOOL QueueBit SHORT Port C Method BOOL CDecoder QueueBit Description Returns MPEG Decoder Status Page 30h value of Queue Bit Parameters SHORT Port Port number of decoder to accept the command Return Value Queue Bit Comments e Set after a buffer reset is received cleared only after playback has started Listing of Public Functions Chapter 2 API Development 75 ReadAudioLevel C Call FUNC_STATUS ReadAudioLevel SHORT Port BYTE PrimRightLevel BYTE PrimLeftLevel BYTE SecRightLevel BYTE SecLeftLevel C Method FUNC_STATUS CCinecast ReadAudioLevel BYTE PrimRightLevel BYTE PrimLeftLevel BYTE SecRightLevel BYTE SecLeftLevel Description Returns Audio Level Mode Page 35h with the latest averaged audio levels for each output audi
33. See page 120 for FUNC_STATUS definition Comments e If Offset is non zero MidStream boolean must be set to TRUE e Microcode is defined as 0x0 IBM 0x1 4 2 0 0x2 4 2 2 e See page 126 for STREAM definition e See page 127 for TRIGGER definition Listing of Public Functions Chapter 2 API Development 71 PlavbackStarted C Call BOOL PlaybackStarted SHORT Port C Method BOOL CDecoder PlaybackStarted Description Returns BOOL to indicate data has been pre loaded and MPEGPLAY issued Parameters SHORT Port Port number of decoder to accept the command Return Value Not yet documented Comments e Use this to monitor the playback thread during the implementation of a playlist e Use READYFORNEXTVIDEO to determine when to issue SETNEXTVIDEO Listing of Public Functions 72 CineCast API Developer s Guide Version 2 6 PlavBit C Call BOOL PlavBit SHORT Port C Method BOOL CDecoder PlayBit Description Returns MPEG Decoder Status Page 30h value of Plav Bit Parameters SHORT Port Port number of decoder to accept the command Return Value Plav Bit Comments e Use this function to determine if decoder is still playing a clip Note that if Error Recovery is enabled the PLAYBIT will return TRUE even when playback has terminated Listing of Public Functions Chapter 2 API Development 73 Productinfo C Call FUNC STATUS Productinfo SHORT Port PP
34. See page 121 for DL_TYPE definition Listing of Public Functions 106 CineCast API Developer s Guide Version 2 6 UpgradeResult C Call BOOL UpgradeResult SHORT Port C Method BOOL CDecoder UpgradeResult Description Returns result of firmware upgrade Parameters SHORT Port Port number of decoder to accept the command Return Value TRUE Passed FALSE Failed Comments e Use this function along with UPGRADEACTIVE and UPGRADEFIRMWARE to monitor the asynchronous download of firmware data Listing of Public Functions Chapter 2 API Development 107 UnusedFiFoDataAfterStop C Call BYTE UnusedFiFoDataAfterStop SHORT Port C Method BYTE CDecoder UnusedFiFoDataAfterStop Description Returns MPEG Decoder Status Page 30h value of unused FiFo data after Stop Parameters SHORT Port Port number of decoder to accept the command Return Value Unused FiFo data after Stop Comments None Listing of Public Functions 108 CineCast API Developer s Guide Version 2 6 VideoLevel C Call FUNC_STATUS VideoLevel SHORT Port WORD Level BOOL Up C Method FUNC_STATUS CSCSI VideoLevel WORD Level BOOL Up Description Modifies the video reference level Parameters SHORT Port Port number of decoder to accept the command WORD Level Increment Decrement Level BOOL Up Direction of change TRUE Up FALSE Down Return Value See page 120 for FUNC_STATUS definition Co
35. T Port C Method BOOL CDecoder UnderFlowBit Description Returns MPEG Decoder Status Page 30h value of UnderFlow Bit Parameters SHORT Port Port number of decoder to accept the command Return Value UnderFlow Bit Comments None Listing of Public Functions 104 CineCast API Developer s Guide Version 2 6 UpgradeActive C Call BOOL UpgradeActive SHORT Port C Method BOOL CDecoder UpgradeActive Description Returns Active State of Firmware Upgrade Parameters SHORT Port Port number of decoder to accept the command Return Value TRUE Active FALSE Inactive Comments e Use this function along with UPGRADEFIRMWARE and UPGRADERESULT to monitor the asynchronous download of firmware data Listing of Public Functions Chapter 2 API Development 105 UpgradeFirmWare C Call BOOL UpgradeFirmWare SHORT Port PCHAR sFileName DL_TYPE Mode C Method BOOL CDecoder UpgradeFirmWare PCHAR sFileName DL_TYPE Mode Description This function downloads new decoder firmware microcode over the SCSI bus to the decoder asynchronously Parameters SHORT Port Port number of decoder to accept the command PCHAR sFileName Path and filename to the firmware binary file DL_TYPE Mode CHECK_FILE 0X4 BURN FLASH 0X5 Return Value Not yet documented Comments e Use this function along with UPGRADEACTIVE and UPGRADERESULT to monitor the asynchronous download of firmware data
36. US CSCSI AVSynch BYTE Coarse BYTE Medium BYTE Fine Description This function will set the thresholds for the synchronization of video and audio Parameters SHORT Port Port number of decoder to accept the command BYTE coarse Set Video Frame threshold BYTE med Set Audio Access Unit threshold BYTE fine Set Audio Sample Rate Return Value See page 120 for FUNC_STATUS definition Comments e See MPEG Audio Video Synchronization in the appropriate decoder user manual for explanation of settings Listing of Public Functions Chapter 2 API Development 17 AVTransportPacketld C Call FUNC_STATUS AVTransportPacketld SHORT Port PID_TYPE PidAv ULONG PidValue C Method FUNC_STATUS CDecoder AVTransportPacketld PID_TYPE PidAv ULONG PidValue Description This function allows the user to specify the transport packet IDs for video and audio to be decoded Parameters SHORT Port Port number of decoder to accept the command PID_TYPE PidAv Type of PID to be set for Video Audio Primary Secondary and Sequence ULONG Pid Value Value to be set for PID selection Return Value See page 120 for FUNC_STATUS definition Comments e See page 123 for PID_TYPE definition Listing of Public Functions 18 CineCast API Developer s Guide Version 2 6 BackgroundColor C Call FUNC STATUS BackgroundColor SHORT Port COLORMODE Mode BYTE V BVTE Cb BVTECr C Method FUNC STATUS CCinec
37. USHORT SlowRepeat FUNC_STATUS CCinecast SlowMotion BYTE Speed BOOL binline BYTE Mode Description Plays the current video clip in slow motion Parameters SHORT Port Port number of decoder to accept the command USHORT which How often a frame should be skipped 0 15 USHORT repeat A single frame is repeated 0 15 BYTE Speed Rate of display 0 7 BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC_STATUS definition Comments e CineCast Quad Pro version of slow motion only uses a speed rate of 0 7 Listing of Public Functions Chapter 2 API Development 95 SoftReset C Calls FUNC STATUS SoftReset SHORT Port FUNC STATUS SoftResetinlined SHORT Port BOOL binline BYTE Mode C Methods FUNC_STATUS CDecoder SoftReset FUNC_STATUS CCinecast SoftReset BOOL binline BYTE Mode Description Resets the decoder s audio and video circuits Parameters SHORT Port Port number of decoder to accept the command BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC_STATUS definition Comments e Forces the screen to black
38. Vela CineCast API Developer s Guide Version 2 6 An Application Programming Interface handbook for Vela s CineCast line of SCSI 2 MPEG 2 decoders that run on the Microsoft Windows operating system Includes support for the following Vela SCSI 2 MPEG 2 audio video decoders e CineCast Prime e CineCast Quad Pro e CineCast Quad e CineCast HD e CineCast 8 Channel AVela Document Part Number 9050 2016 Copyright 2002 Vela LP All rights reserved This manual is written and published by Vela LP Vela Vela reserves the right to make changes to this manual and to the product s represented without notice No portion of this manual may be copied reproduced or transcribed without the express written authorization of Vela CineCast is a trademark of Vela LP All other brand names product names or trademarks appearing in this manual are registered to the respective companies or organizations that own the names or trademarks Returns must be accompanied by an authorized RMA number obtained from Vela Vela OEM Products Division 5733 Myerlake Circle Clearwater FL 33760 2804 Phone 727 507 5300 Fax 727 507 5311 World Wide Web http www vela com Shipping Mailing Address 5733 Myerlake Circle Clearwater FL 33760 2804 Printed in the United States of America 6 02 CCAPI 0204 006 Table of Contents LISE OT FIQUICS ii A e edad ete a ee vii Chapter 1 Getting Started ii ce eee A eee le ee 1 introduictioni
39. YPE PPRODUCT_TYPE 123 koemebar tad dd sieb toe acon cine REVISION_TYPE PREVISION_TYPE 123 A NS ra E dd ae a feet SELECT 124 VS DA ual alex cane oda SETTINGS PSETTINGS 126 A a Boat o dad do Se ter ot SOURCE 126 PA A A E STREAM 127 A e ON gt TCSRC 127 o A TRIGGER 127 A bb f he SAN aos Sdn in dik tothe nian iba ei VIDEO PASS MODE 127 a a A AA Ea VIDEO RESOLUTION 127 oca Eras dias A DA sae sume ri eS Nera ta A A E VIDEO STANDARD 128 PA A O ia di eo YUV_TYPE 128 Fade Time Table cocina A a aa 128 dex i A at a 129 Table of Contents List of Figures Chapter 1 Getting Started Chapter 2 API Development Figure 2 1 Recommended Process Flow List of Figures Chapter 1 Getting Started Introduction Welcome to version 2 6 of the Vela Application Programming Interface API for the Vela CineCast line of SCSI 2 audio video decoders This guide is applicable to all CineCast SCSI 2 products except where noted This document is primarily intended for application developers designing digital video delivery systems This chapter discusses system requirements and installation issues Chapter 2 describes in some detail a number of various functions and routines that the typical application developer uses in his or her development efforts Operating System e Microsoft Windows 2000 or Windows NT 4 0 NT Service Pack 6a or later Supported Development Systems e Microsoft Visual C 6 0 e Micr
40. al TRUE Temporal reference order FALSE Bit Order Return Value See page 120 for FUNC STATUS definition Comments e This command is supported only by the CineCast Quad Pro Listing of Public Functions 26 CineCast API Developer s Guide Version 2 6 DataUnderflowErrorCount C Call WORD DataUnderflowErrorCount SHORT Port C Method WORD CDecoder DataUnderflowErrorCount Description Returns MPEG Decoder Status Page 30h value of Data Underflow Error Count Parameters SHORT Port Port number of decoder to accept the command Return Value Data Underflow Error Count Comments None Listing of Public Functions Chapter 2 API Development 27 DecoderDetect C Call SHORT DecoderDetect VOID Description Opens the device driver and returns the number of MPEG decoders installed in the svstem Return Value Number of decoder boards detected A value of 1 indicates the device driver and DLL are incompatible Comments e If no decoder is detected make sure the device driver has been properly installed Follow the instructions provided in the appropriate user manual for your decoder Listing of Public Functions 28 CineCast API Developer s Guide Version 2 6 DecoderShutdown C Call void DecoderShutdown SHORT ChannelCount Description Closes each MPEG decoder device opened Parameters SHORT ChannelCount Total number of decoders returned by DECODERDETECT Return Value Non
41. alue N A Comments None CDecoder C Method CDecoder CDecoder Description Issues a CLOSE and releases attached resources Parameters N A Return Value N A Comments None Listing of Public Functions 114 CineCast API Developer s Guide Version 2 6 Open C Method FUNC STATUS CDecoder Open SHORT Port Description Function opens device name attached to the selected port The default if no port is provided will be to assign the next available port number Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC STATUS definition Comments To create a decoder port order different than the SCSI ID and LUN sequence issue CDecoder Open Port with port numbers in the sequence desired Close C Method FUNC_STATUS CDecoder Close BOOL Save Description Method saves persistent properties closes the channel and makes the port available Parameters BOOL Save Save persistent values to the Registry via SAVEREGISTRY Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 115 CLASS CSCSI Overview The CSCSI class is a derived class from CDecoder This class provides the com mon valid methods for all for SCSI1 SCSI2 SCSIx4 and SCSIx8 decoders PUBLIC Interface CSCSI v virtual CSCSI Class Constructor CSCSI Class Destructor Op
42. ameters SHORT Port Port number of decoder to accept the command LPCSTR Path Path of last decoder clip Return Value See page 120 for FUNC STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 89 SetNextVideo C Call BOOL SetNextVideo SHORT Port LPCSTR Movie Description This function will plavback a selected video immediatelv following the video now plaving Parameters SHORT Port Port number of decoder to accept the command LPCSTR Movie Name of video clip Return Value TRUE Plavback thread accepted next clip FALSE Plavback thread rejected next clip Comments e Functionally equivalent to BACKTOBACKVIDEO NOBLACK disabled will cause MPEGPLAY to be issued for each clip e Use PLAYBACKSTARTED to determine when to check for READYFORNEXTVIDEO Listing of Public Functions 90 CineCast API Developer s Guide Version 2 6 SetOutputDiscrete C Calls FUNC STATUS SetOutputDiscrete SHORT Port BOOL GPOuti BOOL Sync1 BOOL GPOut2 BOOL Svnc2 FUNC STATUS SetOutputDiscretelnlined SHORT Port BOOL GPOuti BOOL Sync1 BOOL GPOut2 BOOL Sync2 BOOL binline BYTE Mode C Method FUNC_STATUS CCinecast SetOutputDiscrete BOOL GPOuti BOOL Sync1 BOOL GPOut2 BOOL Sync2 BOOL binline BYTE Mode Description Selects OutputDiscrete and when to change state Parameters SHORT Port Port number of decoder to accept the command BOOL GPQ0utl TRUE
43. ast BackgroundColor COLORMODE Mode BYTE Y BYTE Cb BYTE Cr Description Outputs the specified color during idle Parameters SHORT Port Port number of decoder to accept the command COLORMODE Mode Background color mode BYTE Y Color value for Y component BYTE Cb Color value for Cb component BYTE Cr Color value for Cr component Return Value See page 120 for FUNC_STATUS definition Comments e Whenever the decoder is idle i e playback not active the decoder outputs black If Set Background Color is sent the decoder will output the specified color The default is Black and can be optionally set to blue or any color specified by the user e See page 119 for COLORMODE definition Listing of Public Functions Chapter 2 API Development 19 BackToBackVideo C Call FUNC STATUS BackToBackVideo SHORT Port CHAR Clip BOOL Error Recoverv BOOL Midstream BOOL Pause BOOL Trigger STREAM Tvpe UCHAR PreBlack ULONG Frames WORD PostBlack TRIGGER TriggerSource BVTE Microcode DWORDLONG Offset C Method FUNC STATUS CDecoder BackToBackVideo CHAR Clip BOOL ErrorRe coverv BOOL Midstream BOOL Pause BOOL Trigger STREAM Tvpe UCHAR PreBlack ULONG Frames WORD PostBlack TRIGGER Trig gerSource BYTE Microcode DWORDLONG Offset Description This function will playback a selected clip immediately following the video now playing Parameters SHORT Port Port number of decoder to accept t
44. definition Comments e Issue SOFTRESET command to terminate the command Listing of Public Functions Chapter 2 API Development 101 TimeCode C Call FUNC STATUS TimeCode SHORT Port SHORT Hour SHORT Minute SHORT Seconds SHORT Frames C Method FUNC STATUS CCinecast TimeCode SHORT Hour SHORT Minute SHORT Seconds SHORT Frames Description Sets SMPTE time code for next command Parameters SHORT Port Port number of decoder to accept the command SHORT Hour Hour to set SHORT Minute Minute to set SHORT Seconds Second to set SHORT Frames Frame to set Return Value See page 120 for FUNC_STATUS definition Comments e This command is supported only by the CineCast Quad Pro e Use in conjunction with LTCVITCTIMECODE Listing of Public Functions 102 CineCast API Developer s Guide Version 2 6 TrickModeFrameCount C Call FUNC STATUS TrickModeFrameCount SHORT Port DWORD Frames C Method FUNC STATUS CCinecast TrickModeFrameCount DWORD Frames Description Sets frame count for next trick mode command Parameters SHORT Port Port number of decoder to accept the command DWORD Frames Desired frame count to activate trick mode Return Value See page 120 for FUNC STATUS definition Comments e This command is supported only by the CineCast Quad Pro Listing of Public Functions Chapter 2 API Development 103 UnderFlowBit C Call BOOL UnderFlowBit SHOR
45. dio connector pinout information and tvpical audio cable configurations Setup Note The svstem should be set up so that the virtual memorv file page file svs is on the drive containing the Windows operating svstem Paging files must not be set on the drive s containing the MPEG encoded video files since the operat ing svstem will perform paging when there is not enough memorv to start or complete a process or in the process of general housekeeping Paging will generally take over disk I O activity during this time and will frequently and momentarilv halt the transfer of MPEG files to the decoder board Therefore MPEG files should be kept on a separate drive for greatest efficiencv Decoder Installation If not alreadv installed refer to the installation and user manual for vour Vela CineCast decoder for complete information and instructions on proper installation Software Installation Be sure to review the readme files on the svstem software CD ROM for the verv latest information on installation and performance issues Vela CineCast Software Development Kit system software installation is a relatively straightforward process Follow the instructions in your particular CineCast decoder ver 2 6 user manual for installation of both CineCast system software and the SDK If you did not receive a hard copy manual the document is available in PDF form on the Vela System Software CD ROM that accompanied either the decoder or t
46. e Comments None Listing of Public Functions Chapter 2 API Development 29 DefaultResolution C Calls FUNC STATUS DefaultResolution SHORT Port VIDEO RESOLUTION Resolution FUNC STATUS DefaultResolutionCC SHORT Port BOOL Pal C Methods FUNC_STATUS CDecoder DefaultResolution VIDEO RESOLUTION Resolution FUNC STATUS CCinecast DefaultResolution BOOL Pal Description Sets the video standard output to NTSC or PAL The definition can also be set to C601 SIF and Half D1 The display resolution may be set to 704x480 352x240 and 720x576 Parameters SHORT Port Port number of decoder to accept the command VIDEO_RESOLUTION Resolution Selected resolution to display BOOL Pal Flag TRUE for PAL FALSE for NTSC Return Value See page 120 for FUNC_STATUS definition Comments e See page 127 for VIDEO RESOLUTION definition Listing of Public Functions 30 CineCast API Developer s Guide Version 2 6 DefaultVideoStandard C Call FUNC STATUS DefaultVideoStandard SHORT Port VIDEO STANDARD VideoStd C Method FUNC_STATUS CSCSI DefaultVideoStandard VIDEO_STANDARD VideoStd Description Sets NTSC or PAL standards Parameters SHORT Port Port number of decoder to accept the command VIDEO STANDARD video_std NTSC60hz NTSC50hz NTSC_M60hz PAL_BG50hz PAL M60hz PAL_N50hz Return Value See page 120 for FUNC_STATUS definition Comments e See page 128 for VIDEO STANDARD defi
47. e frame at a time PauseVideo Pause the current video clip playing Resume Resume the video clip paused in slow or fast motion ResumeNormal Resume the video clip paused ResumePlay Resume the video clip in slow or fast motion SlowMotion Play the current video clip in slow motion Status DataUnderflowErrorCount Returns Data Underflow Error Count FifoBufferStatus Returns Fifo Buffer Status FrameReport Returns Frame Reporting GetProductID Returns decoder type GetState Returns decoder state LastDecoderCommand Returns Last Decoder Command PlayBit Returns Play Bit Productinfo Returns Product and SCSI Board information QueueBit Returns Queue Bit ReadFrameCount Read back number of frames displayed Revisioninfo Returns the Revision Page SessionActive Returns Active status of the current playback thread UnderFlowBit Returns UnderFlow bit UnusedFiFoDataAfterStop Returns Unused FiFo data after Stop Clip AVStreamld Selects which audio and video stream IDs to decode Specify the Transport Packet IDs Returns latest MPEG or Hardware errors encountered Returns default path clip location Returns return code from the last playback thread Returns Flag indicating MpegPlay issued Returns Flag if playback thread can accept next video Sets default path clip location Listing of Public Functions Chapter 2 API Development 113 CDecoder C Method CDecoder CDecoder Description Initializes private members Parameters N A Return V
48. en v Open decoder channel device Close v Close decoder channel device Initialize v Initialize decoder based on the saved settings GetSettings v SetSettings v RestoreSettings v SaveSettings v Return decoder settings stored in the Registry Store decoder settings in Memory Retrieve decoder settings stored in the Registry Store decoder settings in the Registry Setup Static DefaultVideoStandard Set NTSC or PAL standards SetYuvMode Set output mode to Betacam YUV SVHS RGB Setup Dynamic AVSynch Set thresholds for the Audio Video synchronization PALBufferMode Set decoder s buffer MPEG mode for PAL SetVideoPassThrough Switch output from digital to analog genlock video SwitchAudio Select and setup audio output VideoLevel Modify the video reference level VolumeControl Modify attenuation of the audio output BlackLevel Set the Black Level to the desired point BlankLevel Set the Blank Level to the desired point GainU Set the GainU Level to the desired point GainV Set the GainV Level to the desired point Listing of Public Functions 116 CineCast API Developer s Guide Version 2 6 CLASS CCinecast Overview The CCinecast class is a derived class from CDecoder This class provides the common valid methods for CineCast Quad Pro SDI decoders PUBLIC Interface CCinecast v virtual CCinecast CCinecast Open v Close v Initialize v GetSettings v SetSettings v RestoreSettings v SaveSettin
49. ept the command SHORT Data Range is 0 to OxIF Return Value See page 120 for FUNC STATUS definition Comments e Use of this command may drastically reduce picture quality Only experi enced users should attempt to customize the NTSC PAL video Consult with Vela for additional information Listing of Public Functions 22 CineCast API Developer s Guide Version 2 6 Blank C Calls Export FUNC STATUS Blank SHORT Port BOOL On Export FUNC STATUS Blankinlined SHORT Port BOOL On BOOL binline BYTE Mode C Methods Export FUNC_STATUS CDecoder Blank BOOL On Export FUNC_STATUS CCinecast Blank BOOL BlankOn BOOL binline BYTE Mode Description This function will turn the video on or off Playback of the video clip will continue unaffected even if the video is not visible Parameters SHORT Port Port number of decoder to accept the command BOOL On TRUE Blank the screen FALSE Turn the screen back on BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 23 BlankLevel C Call FUNC_STATUS BlankLevel SHORT Port SHORT Data C Method FUNC_STATUS CSCSI BlankLevel SHORT Data Description Sets the Blank Level
50. ess transition between clips Parameters SHORT Port Port number of decoder to accept the command UCHAR Seamless 1 No black between videos 2 Pre and Post black values will be used Return Value See page 120 for FUNC STATUS definition Comments e This option eliminates any black between plavbacks NOBLACK disabled will cause MPEGPLAY to be issued for each clip Listing of Public Functions 66 CineCast API Developer s Guide Version 2 6 NonStop C Call FUNC STATUS NonStop SHORT Port BOOL Loop C Method FUNC STATUS CDecoder NonStop BOOL Loop Description Enables the current video clip to repeat from the beginning when the end of the current file is reached or when the maximum frame count has plaved Parameters SHORT Port Port number of decoder to accept the command BOOL Loop TRUE Enable looping FALSE Disable looping Return Value See page 120 for FUNC STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 67 PALBufferMode C Call FUNC STATUS PALBufferMode SHORT Port BOOL flag C Method FUNC STATUS CSCSI PALBufferMode BOOL PalBufferFlag Description Changes the decoder s buffer MPEG mode for PAL Parameters SHORT Port Port number of decoder to accept the command BOOL flag TRUE for PAL FALSE for NTSC Return Value See page 120 for FUNC_STATUS definition Comments e Not supported by CineCast Quad Pro List
51. ethod FUNC STATUS CDecoder GetProductID PDECODER TVPE this decoder Description This function will return the decoder tvpe Parameters SHORT Port Port number of decoder to accept the command PDECODER_TYPE this decoder Decoder model Return Value See page 120 for FUNC_STATUS definition Comments e See page 119 for PDECODER_TYPE definition Listing of Public Functions 54 CineCast API Developer s Guide Version 2 6 GetSettings C Calls BOOL GetSettings SHORT Port SETTINGS pSettings C Methods BOOL CSCSI GetSettings SETTINGS pSettings BOOL CCinecast GetSettings SETTINGS pSettings Description This function will return the decoder settings stored in the Registry Parameters SHORT Port Port number of decoder to accept the command SETTINGS pSettings Decoder Settings Return Value Not yet documented Comments e Use this function along with RESTORESETTINGS SETSETTINGS and SAVESETTINGS to make the decoder settings persistent between executions e See page 124 for SETTINGS definition Listing of Public Functions Chapter 2 API Development 55 GetState C Call FUNC STATUS GetState SHORT Port DECODER STATE MASK state C Method FUNC STATUS CDecoder GetState DECODER STATE MASK state Description This function will return the decoder state Parameters SHORT Port Port number of decoder to accept the command DECODER STATE MASK state State o
52. f the decoder Return Value See page 120 for FUNC STATUS definition Comments e Use this function to determine the software state of the selected decoder e See page 120 for DECODER STATE MASK definition Listing of Public Functions 56 CineCast API Developer s Guide Version 2 6 HorizontalPhase C Method FUNC_STATUS SCSI HorizontalPhase SHORT Data Description This function will set the Horizontal Phase to the desired point Parameters SHORT Data Range for SCSI is 0x00 to OxFF Range for SCSI 2 and SCSI 4 is 0x0000 to 0x07FF Return Value See page 120 for FUNC_STATUS definition Comments e Function works for SCSI 2 and SCSI 4 only e Use of this command may drastically reduce picture quality Only experi enced users should attempt to customize the NTSC PAL video Consult with Vela for additional information Listing of Public Functions Chapter 2 API Development 57 Initialize C Calls FUNC STATUS Initialize SHORT Port C Methods FUNC_STATUS CSCSI Initialize FUNC_STATUS CCinecast Initialize Description This function will initialize the decoder based on the saved settings stored in the Registry Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC_STATUS definition Comments e CDecoder Initialize calls the following functions DefaultResolution ErrorMask FrameFreeze FieldFreeze NoBlack Genlock
53. gs v Setup Static BackgroundColor ClosedCaptionReorder DefaultResolution Setup Dynamic AVChannelSelect AudioGain Blank BufferReset Genlock LtcVitcTimeCode Mute SecondChannel SetOutputDiscrete SoftReset TimeCode TrickModeFrameCount VCR Play MpegPlay v Play v VCR Trick Mode FastMotion FrameAdvance PauseVideo ResumeNormal SlowMotion Class Constructor Class Destructor Open decoder channel device Close decoder channel device Initialize decoder based on the saved settings Return decoder settings stored in the Registry Store decoder settings in Memory Retrieve decoder settings stored in the Registry Store decoder settings in the Registry Output the specified color during idle Closed Caption based on bit stream or display order Set the video standard output to NTSC or PAL Control output selection for the two audio outputs Adjust audio gain control Turn video on or off Reset the MPEG buffer pointers Enable decoder to synchronize to a genlock input source Configure LTC Output and VITC Insertion extraction Mute audio output Enable the audio on the second channel Select Output Discrete and when to change state Reset the decoder s audio and video circuits Set SMPTE time code for next command Set frame count for next trick mode command Start decoder playback Playback selected clip Stop the current video clip playing Play the current video clip in fast motion Advance the video one frame at a
54. he command CHAR Clip Name of video clip BOOL ErrorRecovery TRUE Automatically pause when data underflows FALSE Stop playback and go to black BOOL Midstream TRUE Search for next valid sequence header FALSE Immediate playback BOOL Pause TRUE Pause on non black video frame FALSE Immediate playback BOOL Trigger TRUE Wait for external trigger FALSE Immediate playback STREAM Type Stream type of clip SHORT PreBlack Option for number of black frames to display before clip start ULONG Frames Number of frames to playback WORD PostBlack Option for number of black frames to display after clip end TRIGGER TriggerSource Source for event to start playback BYTE Microcode Chroma Microcode to load DWORDLONG Offset Midstream start offset Return Value See page 120 for FUNC_STATUS definition Listing of Public Functions 20 CineCast API Developer s Guide Version 2 6 Comments e NOBLACK disabled will cause MPEGPLAY to be issued for each clip e Microcode is defined as 0x0 IBM 0x1 4 2 0 0x2 4 2 2 e See page 126 for STREAM definition e See page 127 for TRIGGER definition Listing of Public Functions Chapter 2 API Development 21 BlackLevel C Call FUNC STATUS BlackLevel SHORT Port SHORT Data C Method FUNC STATUS CSCSI BlackLevel SHORT Data Description Sets the Black Level to the desired point Parameters SHORT Port Port number of decoder to acc
55. his SDK Hardware drivers are automatically installed under Windows NT 4 0 Instructions for installing them under Windows 2000 can be found in the above referenced installation and user manual Decoder Installation Chapter 1 Getting Started 3 Customer Support In the event of questions or problems with the Vela Application Programming Interface materials or this manual do not hesitate to contact Vela Training and Support e Phone 727 507 5301 e E mail supportO vela com e World Wide Web http www vela com Customer Support Chapter 2 API Development The following functions used in this section pertain to Vela CineCast SCSI 2 MPEG 2 decoders designed and manufactured bv Vela LP AudioChannelFade AudioGain AVChannelSelect AVFade AVStreamlD AVSynch AVTransportPacketlD BackgroundColor BackToBackVideo BlackLevel Blank BlankLevel BufferReset ClosedCaptionReorder DataUnderflowErrorCount DecoderDetect DecoderShutdown DefaultResolution DefaultVideoStandard EnableFreezeOnLast EnableGUISignal EnablePlaybackSignal EnableWaitForCondition ErrorMask FactorySettings FastMotion FieldFreeze FifoBufferStatus FlushChannelBuffer Flushinline FrameAdvance FrameFreeze FrameReport GPIN1Bit GPIN2Bit GainU GainV Genlock GenlockTiming GetMPEGFilelnfo GetMpegPath GetProductID GetSettings GetState HorizontalPhase Initialize IsNonStop LastDecoderCommand LastPlayBackError LtcVitcTimeCode MpegP
56. idstream BOOL Pause BOOL Trigger STREAM Type UCHAR PreB lack ULONG Frames WORD PostBlack DWORDLONG Offset FUNC_STATUS CCinecast Play CHAR Clip BOOL ErrorRecovery BOOL Midstream BOOL Pause BOOL Trigger STREAM Type UCHAR PreB lack ULONG Frames WORD PostBlack TRIGGER TriggerSource BYTE Microcode DWORDLONG Offset Description This function creates the playback thread which pre loads data to the decoder issues MPEGPLAY loads the rest of the data and monitors the state of the clip and decoder Parameters SHORT Port Port number of decoder to accept the command CHAR Clip Name of video clip BOOL ErrorRecovery TRUE Automatically pause when data underflow FALSE Stop playback and go to black BOOL Midstream TRUE Search for next valid sequence header FALSE Immediate playback BOOL Pause TRUE Pause on non black video frame FALSE Immediate playback BOOL Trigger TRUE Wait for external trigger FALSE Immediate playback Listing of Public Functions 70 CineCast API Developer s Guide Version 2 6 STREAM Type Stream type of clip SHORT PreBlack Option for number of black frames to display before start of clip ULONG Frames Number of frames to play back WORD PostBlack Option for number of black frames to display after clip end TRIGGER TriggerSource Source for event to start playback BYTE Microcode Chroma microcode to load DWORD Offset Byte offset into file Return Value
57. ing of Public Functions 68 CineCast API Developer s Guide Version 2 6 PauseVideo C Calls FUNC STATUS PauseVideo SHORT Port C Methods FUNC_STATUS CDecoder PauseVideo FUNC_STATUS CCinecast PauseVideo BOOL binline BYTE Mode Description Pauses the video clip that is currently being played Parameters SHORT Port Port number of decoder to accept the command BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 69 Plav C Calls FUNC STATUS Plav SHORT Port CHAR Clip BOOL ErrorRecoverv BOOL Midstream BOOL Pause BOOL Trigger STREAM Tvpe UCHAR PreB lack ULONG Frames WORD PostBlack DWORDLONG Offset FUNC_STATUS PlayCC SHORT Port CHAR Clip BOOL ErrorRecovery BOOL Midstream BOOL Pause BOOL Trigger STREAM Type UCHAR PreBlack ULONG Frames WORD PostBlack TRIGGER TriggerSource BYTE Microcode DWORDLONG Offset C Methods FUNC_STATUS CDecoder Play CHAR Clip BOOL ErrorRecovery BOOL Midstream BOOL Pause BOOL Trigger STREAM Type UCHAR PreB lack ULONG Frames WORD PostBlack TRIGGER TriggerSource BYTE Microcode DWORDLONG Offset FUNC_STATUS CCinecast Play CHAR Clip BOOL ErrorRecovery BOOL M
58. lay Mute NoBlack NonStop PALBufferMode PauseVideo Play PlaybackStarted PlayBit Productinfo QueueBit ReadAudioLevel ReadFrameCount ReadTimeCode ReadyForNextVideo RestoreSettings Resume ResumeNormal ResumePlav Revisioninfo SaveSettings SecondChannel SessionActive SetEventLevel SetMpegPath SetNextVideo SetOutputDiscrete SetSettings SetVideoPassThrough SetYuvMode SlowMotion SoftReset StandAlone Stop SubcarrierPhase SwitchAudio TestPattern TimeCode TrickModeFrameCount UnderFlowBit UpgradeActive UpgradeFirmWare UpgradeResult UnusedFiFoDataAfterStop VideoLevel VolumeControl WaitForCondition 6 CineCast API Developer s Guide Version 2 6 NOTE Where indicated some inline functions are supported oniv bv the CineCast Quad Pro decoder Inline commands are not executed immediatelv but are executed inline Inline commands will remain pending until the specific event occurs as defined in InLine Mode InLine Mode determines by what event the inlined command is activat ed InLine Mode is defined as 0x0 MPEG Data Mode default 0x1 Output SMPTE Time Code Mode 0x2 Input LTC Time Code Mode 0x3 Frame Count Mode 0x4 Playback Start 0x5 Playback End 0x6 GPIN1 Active 0x7 GPIN1 Inactive 0x8 GPIN2 Active 0x9 GPIN2 Inactive Below is a recommended playback process flow for general use Obtain list of valid ports for playback DecoderDetect Select an MPEG playback file
59. mments e Not supported by CineCast Quad Pro e Use of this command may drastically reduce picture quality Only experi enced users should attempt to customize the NTSC PAL video Consult with Vela for additional information Listing of Public Functions Chapter 2 API Development 109 VolumeControl C Call FUNC_STATUS VolumeControl SHORT Port BYTE Level BYTE Channel C Method FUNC_STATUS CSCSI VolumeControl BYTE Level BYTE Channel Description Modifies attenuation of the audio output Parameters SHORT Port Port number of decoder to accept the command BYTE Level Attenuation level 0 127 BYTE Channel Channel selection for Stereo 0x0 Left 0x1 or Right 0x2 Return Value See page 120 for FUNC_STATUS definition Comments e Channel is defined as 0x0 Stereo 0x1 Left 0x2 AC 3 e Not supported by CineCast Quad Pro Listing of Public Functions 110 CineCast API Developer s Guide Version 2 6 WaitForCondition C Call FUNC_STATUS WaitForCondition SHORT Port WORD TimeOut CHAR Complete C Method FUNC STATUS CDecoder WaitForCondition WORD TimeOut CHAR Complete Description Notifies the host of plavback decoder events Parameters SHORT Port Port number of decoder to accept the command WORD TimeOut Expiration time 1 60 second for NTSC 1 50 second for PAL CHAR Complete Option to signal on two or zero frames left Return Value See page 120 for FUNC_ST
60. n 2 6 ResumePlay C Call FUNC_STATUS ResumePlay SHORT Port C Method FUNC_STATUS CDecoder ResumePlay Description Resumes the video clip that currently is in slow motion or fast forward mode Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 83 Revisioninfo C Call FUNC STATUS Revisioninfo SHORT Port PREVISION TVPE Revision C Method FUNC STATUS CDecoder Revisioninfo PREVISION TVPE Revision Description This function retrieves the Revision Page from the decoder This includes infor mation on the various revision codes for hardware firmware and mach versions Parameters SHORT Port Port number of decoder to accept the command PREVISION_TYPE Revision Hardware Firmware Mach Version information Return Value See page 120 for FUNC_STATUS definition Comments e A Test Unit Ready will be issued if the Inquiry fails This will ensure that the information to be received from the decoder is valid Function retrieves the firmware machware SCSI and MPEG versions of the decoder board e See page 123 for PREVISION_TYPE definition Listing of Public Functions 84 CineCast API Developer s Guide Version 2 6 SaveSettings C Call BOOL SaveSettings SHORT Port C Methods BOOL CDecoder SaveSettings BOOL CSCSI SaveSettings BO
61. nclude the Mib directory in the link tab CineCastU lib is the link library used to interface with CineCastU dll 3 How do I detect and or enable the decoders on my system For C interface implementation FUNC_STATUS rc SUCCESSFUL SHORT decoderNum DecoderDetect for int i 0 i lt decoderNum i CineCast SDK Q amp A 8 CineCast API Developer s Guide Version 2 6 rc Initialize DecoderDetect enables the device driver and return the number of MPEG decoders installed in the system Now any C function may be used as long as a valid Port number 0 n 1 as the first parameter of the function For C interface implementation CDecoder Channel SHORT m_DecoderCount FUNC_STATUS rc SUCCESSFUL m_DecoderCount DecoderCount Channel new CDecoder Im DecoderCount for inti 0 i lt m_DecoderCount amp amp rc SUCCESSFUL i Channell i new CDecoder rc Channel i gt Open if rc SUCCESSFUL rc Channel i gt Initialize The DecoderCount returns the number of decoders attached to the local SCSI host adapter Channel is an array of base class CDecoder objects After creating each object Open method makes the decoder accessible and Initialize places the decoder hardware into the last selected mode For any given entry in Channel Channel gt Open x where x is a selected port enables the programmer to swap the order of the decoders So instead of the
62. nition Listing of Public Functions Chapter 2 API Development 31 EnableFreezeOnLast C Call FUNC_STATUS EnableFreezeOnLast SHORT Port BOOL Flag Description Enables BufferReset function to freeze frame on the last decoded picture of the MPEG stream Parameters SHORT Port Port number of decoder to accept the command BOOL Flag TRUE Freeze Last Frame FALSE Fade to black Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions 32 CineCast API Developer s Guide Version 2 6 EnableGUISignal C Call FUNC_STATUS EnableGUISignal SHORT Port BOOL Enable void Callback SHORT Port C Method FUNC_STATUS CDecoder EnableGUISignal BOOL Enable void Callback Description During playlist supplied vpl playback this feature will report at the transi tion between the present clip and next clip via a supplied callback function Parameters SHORT Port Port number of decoder to accept the command BOOL Enable Flag TRUE Enabled FALSE Disabled void Callback SHORT nPort Pointer to callback function when status return is encountered Return Value See page 120 for FUNC_STATUS definition Comments e Note that C Callback does not require a port since the CDecoder object has a port number assigned to it Listing of Public Functions Chapter 2 API Development 33 EnablePlaybackSignal C Call FUNC_STATUS EnablePla
63. o channel Parameters SHORT Port Port number of decoder to accept the command BYTE PrimRightLevel Primary Right Audio Level BYTE PrimLeftLevel Primary Left Audio Level BYTE SecRightLevel Secondary Right Audio Level BYTE SecLeftLevel Secondary Left Audio Level Return Value See page 120 for FUNC_STATUS definition Comments e This command is supported only by the CineCast Quad Pro Listing of Public Functions 76 CineCast API Developer s Guide Version 2 6 ReadFrameCount C Call DWORD ReadFrameCount SHORT Port C Method DWORD CDecoder ReadFrameCount Description Reads back number of frames displayed Parameters SHORT Port Port number of decoder to accept the command Return Value Number of frames decoded so far Comments e The frame count is valid only during playback Reading the value while the decoder is idle or during transition between two videos will result in indetermi nate results Listing of Public Functions Chapter 2 API Development 77 ReadTimeCode C Call FUNC STATUS ReadTimeCode SHORT Port TCSRC Source SHORT Hours SHORT Minutes SHORT Seconds SHORT Frames C Method FUNC STATUS CCinecast ReadTimeCode TCSRC Source SHORT Hours SHORT Minutes SHORT Seconds SHORT Frames Description Reads SMPTE time code for next command Parameters SHORT Port Port number of decoder to accept the command TCSRC Source LTCOut GOP LTCIn SHORT
64. on Enables frame freeze when using the Pause or Pause on Underrun Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC_STATUS definition Comments e Use FIELDFREEZE to pause on field instead of frame Listing of Public Functions 44 CineCast API Developer s Guide Version 2 6 FrameReport C Call DWORD FrameReport SHORT Port C Method DWORD CDecoder FrameReport Description Returns MPEG Decoder Status Page 30h value of Frame Reporting Parameters SHORT Port Port number of decoder to accept the command Return Value Frame Reporting Comments None Listing of Public Functions Chapter 2 API Development 45 GPIN1Bit C Call BOOL PreLoadBit SHORT Port C Method BOOL CCinecast PreLoadBit Description Indicates that the decoder is loading data into the MPEG hardware but playback has not begun Parameters SHORT Port Port number of decoder to accept the command Return Value State of PreLoad Bit Comments e Preload is cleared when playback starts Listing of Public Functions 46 CineCast API Developer s Guide Version 2 6 GPIN2Bit C Call BOOL GPIN2Bit SHORT Port C Method BOOL CCinecast GPIN2Bit Description Returns MPEG Decoder Status Page 30h the state of the general purpose input discrete 2 Parameters SHORT Port Port number of decoder to accept the command Return Value
65. osoft Visual BasiciM 6 0 Svstem Requirements Proper operation of CineCast SCSI 2 decoders requires the following minimum system configuration IMPORTANT The PC system must be Windows certified by the system manufacturer in order for Vela to guarantee proper operation of its products See your dealer for details on Windows certification e IBM compatible personal computer with PCI bus support and a Pentium processor 200 MHz or faster e Minimum of 32MB RAM memory e Microsoft Windows 2000 or Windows NT 4 0 SP 6a or later SCSI or IDE hard drive for Windows operating system an IDE drive is recommended to prevent possible conflicts NOTE All trademarks brand names or product names appearing in this publication are registered to the respective companies or organizations that own the names or trade marks CineCast is a registered trademark of Vela LP Introduction 2 CineCast API Developer s Guide Version 2 6 e A separate SCSI 2 hard drive for MPEG file storage and transfer The drive must support a minimum sustained data rate of 10Mbps and must not contain the operating svstem See Setup Note at the end of this bulleted list e CD ROM Drive e Floppy disc drive 3 4 inch e Video monitor or television receiver with video input connector e Audio amplifier not required if audio input connector is available on the video monitor or television receiver See illustrations at the end of this chapter for au
66. page 122 for MPEG_ERROR_MASK definition Listing of Public Functions 36 CineCast API Developer s Guide Version 2 6 FactorvSettings C Call BOOL FactorySettings SHORT Port C Methods BOOL CDecoder FactorySettings BOOL CSCSI FactorySettings BOOL CCinecast FactorySettings Description This function will restore the decoder settings in the Registry to the original factory settings Parameters SHORT Port Port number of decoder to accept the command Return Value TRUE if save succeeds FALSE if save fails Comments e Exercise caution as all previous settings will be lost INITIALIZE must be called to effect the settings onto the decoder Listing of Public Functions Chapter 2 API Development 37 FastMotion C Calls FUNC STATUS FastMotion SHORT Port USHORT Which FUNC STATUS FastMotionCC SHORT Port FUNC STATUS FastMotionCcCinlined SHORT Port BOOL binline BVTE Mode C Methods FUNC_STATUS CDecoder FastMotion USHORT Which FUNC_STATUS CCinecast FastMotion BOOL binline BYTE Mode Description Plays the current video clip in fast motion by skipping frames Parameters SHORT Port Port number of decoder to accept the command USHORT Which Number of frames to skip BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated
67. rce C Methods FUNC_STATUS CCinecast Genlock BOOL AutoSwitch SELECT Source FUNC_STATUS CDecoder Genlock BOOL AutoSwitch Description Enables the decoder to synchronize to a genlock input source Parameters SHORT Port Port number of decoder to accept the command BOOL AutoS witch Flag TRUE Switch to Standalone when Genlock Loss FALSE No Switching SELECT Source Source of genlock input Return Value See page 120 for FUNC_STATUS definition Comments e Use STANDALONE to remove synchronizing to a genlock input source e CineCast Quad Pro version of GENLOCK allows source selection e See page 124 for SELECT definition Listing of Public Functions 50 CineCast API Developer s Guide Version 2 6 GenlockTiming C Methods FUNC_STATUS CCinecastEx GenlockTiming WORD Horiz BYTE Vert Description This function adjusts the relative position of the SDI output to that of the composite genlock input Parameters WORD Horiz Adjustment is in terms of 27MHz clock delays BYTE Vert Adjustment is 8 lines to 7 lines Return Value See page 120 for FUNC_STATUS definition Comments e Horizontal Adjustment is in the following ranges NTSC 0 to 1715 0 to 63 5 uS PAL 0t0 1727 0 to 64 0 uS e Vertical Adjustment with a positive time indicates that the SDI output will precede genlock negative time indicates that SDI follows genlock Listing of Public Functions Chapter 2 API Developmen
68. ription This function will set the Subcarrier Phase to the desired point Parameters SHORT Data Range is 0x00 to OxFF Return Value See page 120 for FUNC_STATUS definition Comments e Function works for SCSI 2 and SCSI 4 only e Use of this command may drastically reduce picture quality Only experi enced users should attempt to customize the NTSC PAL video Consult with Vela for additional information Listing of Public Functions Chapter 2 API Development 99 SwitchAudio C Call FUNC STATUS SwitchAudio SHORT Port AUDIO FUNC func AUDIO DATA data C Method FUNC STATUS CSCSI SwitchAudio AUDIO FUNC func AUDIO DATA data Description Selects and sets up audio output Parameters SHORT Port Port number of decoder to accept the command AUDIO FUNC func Select audio function to modify AUDIO DATA data Tvpe of modification Return Value See page 120 for FUNC STATUS definition Comments e Not supported bv CineCast Quad Pro e See page 118 for AUDIO DATA definition e See page 118 for AUDIO FUNC definition Listing of Public Functions 100 CineCast API Developer s Guide Version 2 6 TestPattern C Call FUNC STATUS TestPattern SHORT Port C Method FUNC STATUS CDecoder TestPattern Description Generates a color bar test pattern along with an audio tone Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC STATUS
69. s Comments e Use this function along with GETSETTINGS SETSETTINGS and SAVESET TINGS to make the decoder settings persistent between executions INITIALIZE must be call to effect the settings onto the decoder Listing of Public Functions 80 CineCast API Developer s Guide Version 2 6 Resume C Call FUNC STATUS Resume SHORT Port C Method FUNC STATUS CDecoder Resume Description Resumes the video clip that currently is paused in slow motion or in fast for ward mode Parameters SHORT Port Port number of decoder to accept the command Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 81 ResumeNormal C Calls FUNC STATUS ResumeNormal SHORT Port FUNC STATUS ResumeNormallnlined SHORT Port BOOL binline BYTE Mode C Methods FUNC_STATUS CDecoder ResumeNormal FUNC_STATUS CCinecast ResumeNormal BOOL binline BYTE Mode Description Resumes the video clip that currently is paused Parameters SHORT Port Port number of decoder to accept the command BOOL binline FALSE Commands are executed immediately TRUE Commands will remain pending until the specific event occurs BYTE Mode Determines in what event the inlined command is activated Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions 82 CineCast API Developer s Guide Versio
70. standard Channel 0 point ing to Port 0 Channel 0 could now point to Port 3 instead allowing for customization of the channel ordering 4 How do I execute trick modes Play Stop Pause Fast Forward Slow Motion and Frame Advance For C interface implementation Play FUNC_STATUS rc SUCCESSFUL SHORT Port 0 char Clip D first mpg BOOL ErrorRecovery TRUE BOOL Midstream FALSE BOOL Pause FALSE CineCast SDK Q amp A Chapter 2 API Development 9 BOOL Trigger FALSE STREAM Type AutoDetect UCHAR PreBlack 1 ULONG Frames 0 WORD PostBlack 10 DWORDLONG Offset 0 rc Play Port Clip ErrorRecoverv Midstream Pause Trigger Type PreBlack Frames PostBlack Offset This call will initialize a playback thread and begin playing the selected clip Use SessionActive to determine if the thread is still sending data to the decoder The thread will terminate before the clip ends unless WaitForCondition is enabled Stop BOOL Freeze TRUE Stop Port Freeze Pause PauseVideo Port Fast Forward USHORT WhichFrame 5 FastMotion Port WhichFrame Slow Motion USHORT WhichFrame 3 USHORT Repeat 5 SlowMotion Port WhichFrame Repeat Frame Advance FrameAdvance Port Resume Resume Port For C interface implementation Same as above but the calls are issued using the C object and no Port number is required since it was assigned when Open
71. t 51 GetMPEGFilelnfo C Call BOOL GetMPEGFilelnfo PMPEG FILE DETAILS pFile Description This function will return information on MPEG files such as size total frame count stream tvpe bit rate and frame rate Parameters PMPEG FILE DETAILS pfile Pointer to structure Return Value TRUE if valid MPEG data is retrieved FALSE if no file or data is found Comments e Calculation of PAL file size is based on the Frame Rate Code If the Code is 2 3 4 or 5 the fps will be set to 24 00 25 00 29 97 and 30 00 If not it will default to 29 97 BitRate is described in kbps Support for anv file size includ ing those over 4 GB range e pFile gt szFileName must be initialized to address of string holding a valid path filename e See page 122 for PMPEG FILE DETAILS definition Listing of Public Functions 52 CineCast API Developer s Guide Version 2 6 GetMpegPath C Call FUNC STATUS GetMpegPath SHORT Port LPCSTR Path C Method FUNC STATUS CDecoder GetMpegPath LPCSTR Path Description This function will return the default path of the clip location Parameters SHORT Port Port number of decoder to accept the command LPCSTR Path Path of last decoder clip Return Value See page 120 for FUNC STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 53 GetProductiD C Call FUNC STATUS GetProductID SHORT Port PDECODER TVPE this decoder C M
72. time Pause the current video clip playing Resume the video clip paused Play the current video clip in slow motion Listing of Public Functions Chapter 2 API Development 117 Status GPIN1Bit GPIN2Bit ReadTimeCode ReadAudioLevel Clip ErrorMask Description N A Parameters Returns state of general purpose input discrete 1 Returns state of general purpose input discrete 2 Read SMPTE time code for next command Returns average Audio Levels Returns latest MPEG or Hardware errors encountered SHORT Port Port number of decoder to accept the command Return Value Not yet documented Comments None Listing of Public Functions 118 CineCast API Developer s Guide Version 2 6 Definitions tvpedef enum AUDIO DATA AUDIO LSI 0x00 AUDIO_OVELAY 0x01 AUDIO_PASS 0x02 AUDIO_MUTE 0x03 AUDIO_LEFTMONO 0x04 AUDIO_STEREO 0x05 AUDIO_RIGHTMONO 0x06 AUDIO_LOUDOFF 0x00 AUDIO_LOUDON 0x01 y AUDIO DATA tvpedef enum AUDIO FUNC INPUT 0x0 LOUDNESS 0x1 BASS 0x2 TREBLE 0x3 LEFT_VOL 0x4 RIGHT_VOL 0x5 MODE_SEL 0x6 AUDIO FUNC typedef enum AV STREAM CMD AV DEFAULT 0x00 AUDIO ALL 0x02 AUDIO SET 0x03 VIDEO ALL 0x04 VIDEO SET 0x05 AV STREAM CMD Definitions Chapter 2 API Development 119 typedef struct BOARD INFO UCHAR PortNumber UCHAR Pathid UCHAR Targetld UCHAR Lun Scsi port number 1 1 S
73. tion SELECT VideoSource Set video source to OWN CHN 1 or ADJ channel BYTE FadeVideo Fade time is specified in terms of video frames BYTE FadeAudio Fade time is specified in terms of video frames BOOLEAN blnline BYTE Mode Return Value See page 120 for FUNC_STATUS definition Comments e This command is supported on the Models 2000 0422 1 Dash 1 only e It can be also used in place of AUDIOCHANNELFADE e With FadeToBlack enabled the primary video source will fade to black or background color and then fade from black or background color to the secondary video source Listing of Public Functions Chapter 2 API Development 15 AVStreamID C Call FUNC STATUS AVStreamID SHORT Port AV STREAM Cmd BYTE Id C Method FUNC STATUS CDecoder AVStreamiD AV STREAM CMD AvCmd BYTE Avid Description Selects which audio and video stream IDs to decode and determines which audio video stream ID to use The actual ID must be determined beforehand Parameters SHORT Port Port number of decoder to accept the command AV_STREAM_CMD emd Command for all audio and video IDs BYTE ld Stream ID value Return Value See page 120 for FUNC_STATUS definition Comments e See page 118 for AV_STREAM definition Listing of Public Functions 16 CineCast API Developer s Guide Version 2 6 AVSynch C Call FUNC_STATUS AVSynch SHORT Port BYTE Coarse BYTE Medium BYTE Fine C Method FUNC STAT
74. to accept the command Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 61 LtcVitcTimeCode C Call FUNC STATUS LtcVitcTimeCode SHORT Port BOOL LTC BOOL VITC BYTE OutputSource WORD LineFieldi WORD LineField2 C Method FUNC STATUS CCinecast LtcVitcTimeCode BOOL LTC BOOL VITC BYTE OutputSource WORD LineField1 WORD LineField2 Description Configures LTC Output and VITC insertion extraction Parameters SHORT Port Port number of decoder to accept the command BOOL LTC TRUE LTC disabled FALSE LTC enabled BOOL VITC TRUE VITC disabled FALSE VITC enabled BYTE OutputSource Source of time code WORD LineField1 Line Field for extraction insertion of time code WORD LineField2 Line Field for extraction insertion of time code Return Value See page 120 for FUNC_STATUS definition Comments e This command is supported only by the CineCast Quad Pro e OutputSource is defined as 0x0 Use GOP header SMPTE time code default 0x1 Use user defined starting time code set using TIMECODE Listing of Public Functions 62 CineCast API Developer s Guide Version 2 6 MpegPlay C Calls FUNC_STATUS MpegPlay SHORT Port BOOL Trigger BOOL Pause BOOL MidStrm BOOL ErrRcvy STREAM Stream UCHAR PreBlack DWORD FrameCount WORD PostBlack FUNC STATUS MpegPlayCC SHORT Port BOOL Trigger BOOL Pause BOOL MidStrm
75. to the desired point Parameters SHORT Port Port number of decoder to accept the command SHORT Data Range is 0 to OxIF Return Value See page 120 for FUNC_STATUS definition Comments e Use of this command may drastically reduce picture quality Only experi enced users should attempt to customize the NTSC PAL video Consult with Vela for additional information Listing of Public Functions 24 CineCast API Developer s Guide Version 2 6 BufferReset C Calls FUNC STATUS BufferReset SHORT Port FUNC STATUS BufferResetCC SHORT Port BOOL FreezeFrame C Methods FUNC_STATUS CDecoder BufferReset FUNC_STATUS CCinecast BufferReset FUNC_STATUS CCinecast BufferReset BOOL FreezeFrame Description Resets the MPEG buffer pointers before starting the next download of MPEG data to the decoder Parameters SHORT Port Port number of decoder to accept the command BOOL FreezeFrame Freeze frame on the last decoded picture of the MPEG stream Return Value See page 120 for FUNC_STATUS definition Comments None Listing of Public Functions Chapter 2 API Development 25 ClosedCaptionReorder C Call FUNC STATUS ClosedCaptionReorder SHORT Port BOOL Temporal C Method FUNC STATUS CCinecast ClosedCaptionReorder BOOL Temporal Description Displavs Closed Caption based on bit stream or displav order Parameters SHORT Port Port number of decoder to accept the command BOOL Tempor
76. ybackSignal SHORT Port BOOL Enable void Callback SHORT Port C Method FUNC_STATUS CDecoder EnablePlaybackSignal BOOL Enable void Callback Description During back to back playback this feature will detect a SCSI Status Immediate Condition Met 14h when the playback transition between the present and next video occurs and report it via a supplied callback function Parameters SHORT Port Port number of decoder to accept the command BOOL Enable Flag TRUE Enabled FALSE Disabled void Callback SHORT nPort Pointer to callback function when status return is encountered Return Value See page 120 for FUNC_STATUS definition Comments e Note that C Callback does not require a port since the CDecoder object has a port number assigned to it Listing of Public Functions 34 CineCast API Developer s Guide Version 2 6 EnableWaitForCondition C Call FUNC STATUS EnableWaitForCondition SHORT Port WORD TimeOut CHAR Complete BOOL Enable C Method FUNC STATUS CDecoder EnableWaitForCondition WORD TimeOut CHAR Complete BOOL Enable Description Activates WAITFORCONDITION function at the end of playback This will cause the playback thread to suspend until the conditions are met Parameters SHORT Port Port number of decoder to accept the command WORD TimeOut Expiration time 1 60 second for NTSC 1 50 second for PAL CHAR Complete Option to signal on two or zero frames left

Vela CineCast®

Contents

Download Pdf Manuals

Related Search

Related Contents

Vela CineCast&reg;

Contents

Download Pdf Manuals

Related Search

Related Contents

Vela CineCast®