video.h

Go to the documentation of this file.

/*
 * video.h
 *
 * Video interface class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): Derek Smithies (derek@indranet.co.nz)
 *
 * $Revision: 29535 $
 * $Author: rjongbloed $
 * $Date: 2013-04-19 18:51:15 +1000 (Fri, 19 Apr 2013) $
 */

#ifndef PTLIB_VIDEO_H
#define PTLIB_VIDEO_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib.h>

#if P_VIDEO

#include <ptlib/videoio.h>

class PVideoChannel : public PChannel
{
  PCLASSINFO(PVideoChannel, PChannel);

  public:
    enum Directions {
      Recorder,
      Player
    };

    PVideoChannel();

    PVideoChannel(
      const PString & device,   
      Directions dir            
    );
    // 

    ~PVideoChannel();
    // Destroy and close the video driver

    PBoolean Open(
      const PString & device,   
      Directions dir            
    );

     PBoolean IsOpen() const;
    
    static PStringArray GetDeviceNames(
      Directions dir    
    )  ;

    static PString GetDefaultDevice(
      Directions dir    // Video I/O direction
    );

    
    virtual PINDEX  GetGrabWidth(); 

    virtual PINDEX  GetGrabHeight();

    virtual PBoolean Read(void * buf, PINDEX  len);
      // Low level read from the video channel. This function will block until the
      // requested number of characters were read.
  
  
    PBoolean Write(const void * buf,  //Pointer to the image data to be rendered
               PINDEX      len);

    virtual PBoolean Write(
      const void * buf,  
      PINDEX len,        
          void * mark        
    );
    
    virtual PBoolean Redraw(const void * frame); 

    PINDEX  GetRenderWidth();

    PINDEX  GetRenderHeight();

    virtual void SetRenderFrameSize(int width, int height); 

    virtual void SetRenderFrameSize(int width, int height,int sarwidth, int sarheight);
  
    virtual void SetGrabberFrameSize(int width, int height); 

    virtual void AttachVideoPlayer(PVideoOutputDevice * device, PBoolean keepCurrent = true);

    virtual void AttachVideoReader(PVideoInputDevice * device, PBoolean keepCurrent = true);

    virtual PVideoInputDevice *GetVideoReader();

    virtual PVideoOutputDevice *GetVideoPlayer();

    virtual PBoolean IsGrabberOpen();
    
    virtual PBoolean IsRenderOpen();

        virtual PBoolean DisableDecode();

    PBoolean DisplayRawData(void *videoBuffer);

    virtual void CloseVideoReader();

    virtual void CloseVideoPlayer();

    void RestrictAccess();
    
    void EnableAccess();

    PBoolean ToggleVFlipInput();

    virtual bool FlowControl(const void * flowData);

 protected:

    Directions       direction;

    PString          deviceName;     
    PVideoInputDevice  *mpInput;    
    PVideoOutputDevice *mpOutput;   

    PMutex           accessMutex;   // Ensure that only task is accesing 
                                    // members in this video channel.
  private:
    void Construct();


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/video.h"
#else
#include "unix/ptlib/video.h"
#endif
};

#endif // P_VIDEO

#endif // PTLIB_VIDEO_H


// End Of File ///////////////////////////////////////////////////////////////