User Guide for Sign Language Video Chat for Deaf People. User Guide. For End Users ( or Deaf people) For Developers ( or Programmers) FAQs

Transcription

1 User Guide For End Users (or Deaf people) For Developers ( or Programmers) FAQs For End Users ( or Deaf people) 1. Introduction This application allows two or more Deaf people to communicate with each other by signing. It comprises login, recording, transmission, playing and replaying functionalities. The login process provides the presence service to enable the users to choose their appropriate people for communication; then the recording process captures your signing video and stored locally, waiting for transmission; the transmission allow you to send your video files to your partner; playing and replaying processes allow you to view incoming video files. 2. Install Application Go to folder..\slvideochat_dshow\setup\debug\, then double click the executable file: slvideochat_install.msi. It is an installation file. You may follow the steps given and finish the installation process. Please take a note that you must install the application under this directory: C:\slvideo_dshow\ instead of the default directory C:\Program Files\CoE\slvideo_dshow. Otherwise, the application could not find the video files. After the installation is done, navigate to the installation folder where all the executable files are installed. First of all, run Server.exe for presence server, and FTPServer.exe for Written by Zhenyu Ma Page 1

2 FTP server, then add a new FTP client user and password, for instance, ftp client is test and its password is test as well. After that, you may change the corresponding information in setup.ini file, such as, the values for the following entries: server=, FtpServerIP=, FtpClientIP=, FtpClientName=, and FtpClientPassword=. Also you must make sure you have the folder in your C drive: C:\slvideochat_dshow\videofiles\. 3. Install Video Encoder and Decoder Right click x264vfw.inf and click install. It helps you install the x264 video for windows encoder onto your system. Then install the k_lite package for video decoder klcodec390f.exe provided by this application. Actually, you may download the latest k_lite package from their official website ( and it is totally free to use. During the installation of k_lite, you need to add x264 codec, otherwise the application won t run correctly. 4. Run Application Double click SLVideoChat.exe, you will see the main frame like this: Written by Zhenyu Ma Page 2

3 The only active button is LogIn button that enables the Deaf people to login the presence server. When you click the LogIn button, a small dialog prompt to ask your user name. and the user name is the identifier name for you in the network. Therefore, it could not be duplicate. After login, you will see the following changes in the main frame: Anyone who has already logged in displays in the Online textbox, and Logoff and Connect buttons are activated. Then, you may press Connect button to connect the person that you want to communicate with, or you may press Logoff button to terminate your operation. Once you press the Connect button, the following figure is shown: Written by Zhenyu Ma Page 3

4 As long as the remote user you try to connect response you, the connection between you has been established. You may capture videos, and transmit video files. The application will notify you when a new incoming video file comes from remote. You will see the following: The message box with message You have new video file and press PLAY flicks and a small application icon flicks as well with different colors. Written by Zhenyu Ma Page 4

5 For Developers 1. Install Visual Studio 2005/2008 Since the entire application was developed in the Microsoft Visual Studio 2005 under Windows operating system, it is strongly recommended that the correct version of Visual studio was installed in case of avoiding some unexpected incompatible version matching problems. If Visual Studio 2005 or 2008 express version (free version) was employed, the application should not have any problems when compiling. However, the extra MFC library is supposed to be installed accordingly. If you have any compiling problems, please find relevant solutions in FAQs. 2. Visual Studio 2005 Configurations In this application, some extra include files and library were introduced into. Before compiling this application, please make sure whether you have included the necessary files. Start Visual Studio 2005; Click tools in the toolbar, go to options, and then open project directories; Choose include and add the following folders provided in this application: common (comprising DShow API general include files ), baseclasses (DShow API base classes), and include (DShow base include files and MFC classes); Choose library and add lib (all necessary libraries for DShow and this application). Click OK to save the changes. 3. Compile this application Because this application is composed of several subprojects: FTP, x264, x264vfw, and slvideo_dshow. Some of the projects depend on other project, for example, x264vfw depends on the libx264.lib that was generated by compiling x264 project, and Written by Zhenyu Ma Page 5

6 slvideo_dshow depends on x264vfw.lib (that was generated by compiling x264vfw project) and libx264.lib as well. Therefore, the compilation is by-and-large a little bit complicated. Compile Presence Server This project is independent one to the entire project because it provides the presence service for this project. The presence clients are embedded into this application and would start immediately after running this application. Remember that the presence server is supposed to be run before the application starts. Otherwise, it deserves Presence server is not available! error message. Compile FTP This project is independent one to the entire project and a third party open source project. It only provides the ftp server running in the background to allow the client to transmit the video files. So it must run before the transmission process performs. The ftp client side was embedded into this application and ran automatically when uploading or downloading video files. Compile x264 x264 is an open source project and free to download from Since x264 is written in C programming language, you may integrate it into our project (in C++) with some appropriate modification. If you want to add a C++ header file into C source code, for instance, an error message will show that this C++ header file does not match C source code. The solution is to change the precompiled header of the C source code to Not Using Precompiled headers. When recompiling the source code, you could find some errors that were likely discussed in FAQ part. Good suggestions and comments were welcomed from the Internet help. After compilation is done, the libx264 is generated, and move it to a public place where x264vfw project could access. Written by Zhenyu Ma Page 6

7 Compile x264vfw This project aims to provide the x264 compressor library x264vfw.lib that installs the x264 codec into the system so that the compression process would pick it up. It will generate a library file, and an installation file. You could download the source code x264_snapshot_ _2245 and find the related files in the vfw folder after compiling the source code. Compile SLVideoChat This project is the main project of this application. You must make sure that all the above projects compiled without any errors. Otherwise, this project won t compile because it employs some other library obtained from above projects. 4. Make it running First of all, install the decoder. You should install either ffdshow decoder or K-Lite package suite to decode the compressed video files for this application. Otherwise, it will throw an error message Could not render video file. You may recompile ffdshow source code to obtain the decoder or you may simply install K_lite latest version to decode your video files. Secondly, you should modify the setup.ini file to configure the IP addresses of FTP server and Presence Server. Then, make sure the presence server is running and FTP server is running, and run SLVideoChat application. FAQs 1. Character set problems: such as convert from LPCTSTR to const char etc. Configure the project properties, go togeneralcharacter set not set. 2. AfxMessageBox: none of the 2 overloads could convert all the argument types. From the definition of AfxMessageBox, it is acknowledged that it takes three arguments with the last two default values. The first argument is a type of LPCTSTR, which mean long pointer constant string, and LPCTSTR has two different formats according to different settings of unicode (LPCWSTR if unicode is set, and LPCSTR otherwise). E.g. if you use AfxMessageBox( Show me this! ) and show the above error, you d better change it to AfxMessageBox(_T( Show me this! )). Similarly, if you encounter an error like this: Cannot convert parameter 2 from const char[20] to LPCWSTR, the same solution Written by Zhenyu Ma Page 7

8 applies. 3. Error C2146: Syntax error: missing ; before identifier PVOID64 In winnt.h, you need to add the following: #define PINTER_64 ptr64 before typedef void * PVOID; 4. Error C2440: static_cast : Cannot convert from void( thiscall CMainFrame::*)(void) to LRESULT( thiscall (Wnd::*) (WPARAM, LPARAM) This error occurs from time to time when you mismatch the return type of function in its declaration and its definition; when the types of parameters are not matched; or when the message function for Windows is defined incorrectly (the correct definition for Windows message function is afx_msg LRESULT Method_Name(WPARAM, LPARAM). 5. Error: int followed by int is illegal Add the following line to the corresponding file: typedef _w64 int intptr_t; 6. Error C2440: static_cast : cannot convert from LRESULT ( thiscall xxx::*)(wparam, LPARAM) to void( thiscall CWinThread::*)(WPARAM, LPARAM) This error occurs when implanting Visual Studio 6 to Visual Studio 2003/2005 project. The better way is to check the return type and parameters types of the methods mentioned in the error messages. 7. Access violation at address x00000c! This error is quite common during run-time and the reason is that some variables are not initialized or objects have not created yet but they might be called somewhere. Multiple break pointers may help find out the locations of this error. 8. X264 integrity problems. In stdafx.h, you need to add the related library, e.g.: #pragma comment(lib,../../lib/libx264.lib ) extern C { #include common/common.h } 9. Error: link error: unsolved external symbols. This link error is to tell you that you are lacking some of the necessary library. And look at the first line of this error, you will find which library you need to import into your project. 10. Error: link error 2019: unresolved external symbol WinMain@16xxxx referenced in function tmaincrtstartup. You need to change project propertieslinkeradvancedentry point: Main. Or you need to change project propertieslinkersystemsubsystem: <console>/<windows>/<windowce>, which indicates different types of project to be built. 11. Written by Zhenyu Ma Page 8