ACCEasy SDK Programmer's Guide. Version July 2013

Size: px

Start display at page:

Download "ACCEasy SDK Programmer's Guide. Version July 2013"

Andrew Campbell
5 years ago
Views:

1 ACCEasy SDK Programmer's Guide Version July 2013 Copyright Datapath Ltd Page - 1

2 Contents ACCEasy SDK Programmer's Guide... 1 Contents... 2 Document Revision History... 3 Overview... 4 SDK Contents... 5 ACCEasy Function Reference... 6 ACCLoad... 6 ACCFree... 7 ACCClose... 8 ACCSetWindow... 9 ACCGetState ACCSetState ACCGetRunningSourceSize ACCSetEventFn ACCFileOpen ACCDVBOpen ACCDVBSetChannel ACCDVBScanForChannels ACCDVBGetNumberOfTuners ACCDVBGetNumberOfChannels ACCDVBGetChannelInfo Copyright Datapath Ltd Page - 2

3 Document Revision History Revision Date Changes First release. Copyright Datapath Ltd Page - 3

4 Overview ACCEasy is an application interface for the display of media content using an accelerated interface on Datapath graphics cards. ACCEasy is implemented within ACCEasy.dll.. ACCEasy supports Image4 and ImageDP4 graphics cards. Copyright Datapath Ltd Page - 4

5 SDK Contents Support for the ACCEasy is included within the drivers for Datapath Image4 and ImageDP4 graphics cards. The ACCEasy SDK is implemented in C and has the following structure: INCLUDE\ACCAPI.H This file defines all the functions available within ACCEasy. INCLUDE\ACC.H This file defines the structures and constants used within ACCEasy. INCLUDE\ACCERROR.H This file defines error codes that can be returned by the interface. DOCS\ACCEasy SDK Programmer Guide.pdf This document. Most applications will use the import library, ACCEasy.LIB, to automatically load ACCEasy on start-up. For those applications that wish to control when ACCEasy is loaded, two additional files are provided: INCLUDE\API.H This file defines functions to help with loading of ACCEasy and obtaining pointers to the functions. COMMON\API.C This file implements functions to help with loading of ACCEasy and obtaining pointers to functions. SAMPLE Directories These directories contain sample Visual Studio applications demonstrating how to use ACCEasy. Copyright Datapath Ltd Page - 5

6 ACCEasy Function Reference This section documents the functions available within ACCEasy. ACCLoad ACCLoad ( PHACCLOAD phaccload ) Loads the ACCEASY interface. This should be the first function by an application. phaccload IN/OUT Pointer to a variable that receives a handle to the interface. If the function succeeds, the return value is 0. the function fails an appropriate error value is returned. Copyright Datapath Ltd Page - 6

7 ACCFree ACCFree ( HACCLOAD haccload ) Releases the ACCEASY interface. This should be the last function called by an application following a successful ACCLoad. haccload IN The ACC handle returned by ACCLoad. Copyright Datapath Ltd Page - 7

8 ACCClose ACCClose ( HACC hacc ) Closes an ACC interface. hacc IN The ACC handle returned by an ACC 'Open' function. If the function succeeds, the return value is 0. the function fails an appropriate error value is returned. Copyright Datapath Ltd Page - 8

9 ACCSetWindow ACCSetWindow ( HACC hacc, HWND hwnd ) Sets the window in which specified ACC content is to be displayed. hacc IN The ACC handle returned by an ACC 'Open' function. hwnd IN The window handle. Copyright Datapath Ltd Page - 9

10 ACCGetState ACCGetState ( HACC hacc, PACCSTATE pstate ) Gets the current state. hacc IN The ACC handle returned by an ACC 'Open' function. pstate IN/OUT Pointer to a variable that receives the state. Copyright Datapath Ltd Page - 10

11 ACCSetState ACCSetState ( HACC hacc, ACCSTATE state ) Gets the current state. hacc IN The ACC handle returned by an ACC 'Open' function. State IN The state to set. Copyright Datapath Ltd Page - 11

12 ACCGetRunningSourceSize ACCGetRunningSourceSize ( HACC hacc, long *pwidth, long *pheight ) Gets the size of the source once the stream has started running. hacc IN The ACC handle returned by an ACC 'Open' function. pwidth IN/OUT Pointer to a variable that receives the width. pheight IN/OUT Pointer to a variable that receives the height. Copyright Datapath Ltd Page - 12

13 ACCSetEventFn ACCSetEventFn ( HACC hacc, PACCEVENTCALLBACKFN PACCEventCallbackFn, UINT_PTR UserData ) Sets and un-sets an event call-back function. hacc IN The ACC handle returned by an ACC 'Open' function. PACCEventCallbackFn IN Pointer to an application defined event call-back function. If this value is NULL, call-backs will no longer occur. UserData IN Application-determined context to pass to the event call-back. Copyright Datapath Ltd Page - 13

14 ACCFileOpen ACCFileOpenW ( const wchar_t *pfilename, PHACC phacc ) ACCFileOpenA ( const char *pfilename, PHACC phacc ) Opens an ACC instance for the video file specified. pfilename IN Absolute path to the video file. phacc IN/OUT Pointer to a variable that receives the handle that identifies the ACC instance. Copyright Datapath Ltd Page - 14

15 ACCDVBOpen ACCDVBOpen ( ACCDVB_TYPE type, tuner, HACC *phacc ) Opens an ACC instance for the DVB tuner specified. type IN DVB tuner type. tuner IN Tuner number. phacc IN/OUT Pointer to a variable that receives the handle that identifies the ACC instance. Copyright Datapath Ltd Page - 15

16 ACCDVBSetChannel ACCDVBSetChannel ( HACC hacc, index ) Specifies the channel to play. hacc IN The ACC handle returned by an ACC 'Open' function. index IN Channel index. Copyright Datapath Ltd Page - 16

17 ACCDVBScanForChannels ACCDVBScanForChannels ( HACC hacc ) Specifies to perform a channel scan. hacc IN The ACC handle returned by an ACC 'Open' function. Copyright Datapath Ltd Page - 17

18 ACCDVBGetNumberOfTuners ACCDVBGetNumberOfTuners ( ACCDVB_TYPE type, *pnumtuners ) Gets the number of tuners. type IN DVB tuner type. phacc IN/OUT Pointer to a variable that receives the number of tuners. Copyright Datapath Ltd Page - 18

19 ACCDVBGetNumberOfChannels ACCDVBGetNumberOfChannels ( ACCDVB_TYPE type, *pnumchannels ) Gets the number of available channels. type IN DVB tuner type. pnumchannels IN/OUT Pointer to a variable that receives the number of channels. Copyright Datapath Ltd Page - 19

20 ACCDVBGetChannelInfo ACCDVBGetChannelInfoW ( ACCDVB_TYPE type, index, PACCDVB_CHANNELINFOW pchannelinfo ) ACCDVBGetChannelInfoA ( ACCDVB_TYPE type, index, PACCDVB_CHANNELINFOA pchannelinfo ) Gets information about the channel. type IN DVB tuner type. index IN Channel index. pchannelinfo IN/OUT Pointer to a variable that receives the channel info. Copyright Datapath Ltd Page - 20

int fnvgetconfig(handle h, UINT32 id, const void *cfg, size_t sz);... 4

int fnvgetconfig(handle h, UINT32 id, const void *cfg, size_t sz);... 4 RP-VL-UTIL-V1 Developer s Guide [ Contents ] 1. Introduction... 1 2. Building Environment... 1 3. Operating Environment... 1 4. Function Explanation... 2 4.1. Common API for Transmitting and Receiving...