ceVideoCore.h

Go to the documentation of this file.

/* --- Source License
 * Author  : FX Programmer.
 * Contact : FXProgrammer@CorEngine.com.ar
 *
 * Copyright (c) 2010 by FX Programmer.
 *
 * This source code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This source code is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. The origin of this software must not be misrepresented; you must not
 *       claim that you wrote the original software. If you use this software
 *       in a product, an acknowledgement in the product documentation would be
 *       appreciated but is not required.
 *    2. Altered source versions must be clearly marked as such, and must not
 *       be misrepresented as being the original software.
 *    3. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this source code; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
 */

 #ifndef _CE_VIDEOCORE_H_
 #define _CE_VIDEOCORE_H_ 0x1 
 #ifndef __cplusplus
 #error ceVideoCore.h requires C++ compilation (use a .cpp suffix)
 #endif

 #if __GNUC__ >= 0x3
 #pragma GCC system_header
 #endif

 #if _MSC_VER > 1000
 #pragma once
 #pragma warning(disable: 4100)
 #endif

 #include "ceWindowInfo.h"
 #include "ceVideoInfo.h"
 // #include "ceVideo.h"

 #include "ceVideoVersion.h"
 #include "begin_code.h"

 namespace ce {

// ---                                              class IVideoManager --- */

 class DECLSPEC IVideoManager
 {
  public:

    #ifndef DOXYGEN_SHOULD_SKIP_THIS
    virtual ~IVideoManager(void) { };
    #endif

    // --- Window Info --- */
      virtual void APICALL
      SetWindowInfo(const SWindowInfo &WindowInfo) = 0;

    /* ! \brief Undocumented.
        \param WindowInfo Undocumented.
     * /
      virtual void APICALL
      SetAsyncWindowInfo(SWindowInfo *WindowInfo) = 0; */

      virtual SWindowInfo* APICALL
      GetWindowInfo(void) = 0;
    // ---------------------- */

    // --- Register / Unregister Video Window --- */
      virtual void APICALL
      RegisterVideoWindow(void *instance = NULL, void *handle = NULL) = 0;

      virtual void APICALL
      RegisterVideoWindowFrom(const SWindowInfo &WindowInfo) = 0;

    /* ! \brief This method registers a window for subsequent use in calls
        to the CreateVideoWindow() method.
        \param WindowInfo Pointer of an asynchronous information of the window.
     * /
      virtual void APICALL
      RegisterVideoWindowAsync(SWindowInfo *WindowInfo) = 0; */

      virtual void APICALL
      UnregisterVideoWindow(void) = 0;
    // ------------------------------------------ */

    // --- Create / Destroy Video Window --- */
      virtual short APICALL
      CreateVideoWindow(void) = 0;

      virtual void APICALL
      DestroyVideoWindow(void) = 0;

      virtual short APICALL
      ShowVideoWindow(const short show = CE_SHOWDEFAULT) = 0;
    // ------------------------------------- */

    // --- Main Loop --- */
      virtual short APICALL
      InitVideoWindow(void) = 0;

      virtual int APICALL
      UpdateVideoWindow(void) = 0;
    // ----------------- */

    /* /! \brief Undocumented.
      virtual void APICALL
      CreateVideoDevice(void) = 0;

    // ! \brief Undocumented.
      virtual void APICALL
      DestroyVideoDevice(void) = 0; */

      virtual unsigned int APICALL
      LoadVideoFile(char *file_name, const unsigned long flags = 0x0) = 0;

      virtual short APICALL
      ReleaseVideo(const unsigned int videoID = 0x1) = 0;

      virtual void APICALL
      ReleaseAllVideos(void) = 0;

      virtual SVideoInfo APICALL
      GetVideoInfo(const unsigned int videoID = 0x1) = 0;

      virtual SVideoInfo* APICALL
      GetAsyncVideoInfo(const unsigned int videoID = 0x1) = 0;

      virtual short APICALL
      ShowVideo(const unsigned int videoID = 0x1,
                const int show = CE_VIDEO_SHOW) = 0;

      virtual void APICALL
      PlayVideo(const unsigned int videoID = 0x1) = 0;

      virtual void APICALL
      PlayVideoFrom(const unsigned int videoID = 0x1,
                    unsigned long start = 0x0) = 0;

      virtual void APICALL
      PlayVideoFromTo(const unsigned int videoID = 0x1,
                      unsigned long start = 0x0, unsigned long end = 0x0) = 0;

      virtual void APICALL
      PlayVideoTo(const unsigned int videoID = 0x1,
                  unsigned long end = 0x0) = 0;

    /* ! \brief Undocumented.
        \param videoID Handle of the video or also can take<br /><br />
        <b>CE_VIDEOID_FIRST</b> Handle to first video.<br />
        <b>CE_VIDEOID_LAST</b> Handle to last video.<br />
        <b>CE_VIDEOID_ALL</b> Handle to all videos.
     * /
      virtual void APICALL
      PlayVideoReverse(const unsigned int videoID = 0x1) = 0; */

      virtual void APICALL
      PauseVideo(const unsigned int videoID = 0x1,
                 const short pause = TRUE) = 0;

      virtual void APICALL
      ResumeVideo(const unsigned int videoID = 0x1) = 0;

      virtual void APICALL
      StopVideo(const unsigned int videoID = 0x1) = 0;

      virtual void APICALL
      SeekVideo(const unsigned int videoID   = 0x1,
                const unsigned long position = 0x0) = 0;

      virtual void APICALL
      SeekStartVideo(const unsigned int videoID = 0x1) = 0;

      virtual void APICALL
      SeekEndVideo(const unsigned int videoID = 0x1) = 0;

      virtual void APICALL
      SetVolumeVideo(const unsigned int videoID = 0x1,
                     const unsigned int volume  = 1000) = 0;

      virtual void APICALL
      SetZoomVideo(const unsigned int videoID = 0x1,
                   const unsigned int zoom    = 100) = 0;

      virtual void APICALL
      SetSpeedVideo(const unsigned int videoID = 0x1,
                    const unsigned int speed    = 1000) = 0;

      virtual void APICALL
      SetRepeatVideo(const unsigned int videoID = 0x1,
                     const short repeat = TRUE) = 0;

      virtual unsigned int APICALL
      GetVolumeVideo(const unsigned int videoID = 0x1) = 0;

      virtual unsigned int APICALL
      GetZoomVideo(const unsigned int videoID = 0x1) = 0;

      virtual unsigned int APICALL
      GetSpeedVideo(const unsigned int videoID = 0x1) = 0;

      virtual unsigned int APICALL
      GetRepeatVideo(const unsigned int videoID = 0x1) = 0;

      virtual unsigned long APICALL
      GetPositionVideo(const unsigned int videoID = 0x1) = 0;

      virtual unsigned long APICALL
      GetLengthVideo(const unsigned int videoID = 0x1) = 0;

      virtual unsigned long APICALL
      GetStartVideo(const unsigned int videoID = 0x1) = 0;

      virtual unsigned long APICALL
      GetEndVideo(const unsigned int videoID = 0x1) = 0;

 };

// ---                                                                  --- */

// ---                                            IVideoManager Factory --- */

 extern DECLSPEC IVideoManager* APICALL
  CreateVideoManager(void);

 extern DECLSPEC void APICALL
  DestroyVideoManager(IVideoManager **Instance = NULL);

// ---                                                                  --- */

 } // end namespace ce

 #include "close_code.h"

 #if _MSC_VER > 1000
 #pragma warning(default: 4100)
 #endif

 #endif // _CE_VIDEOCORE_H_