pvfiledev.h

Go to the documentation of this file.

/*
 * pvfiledev.cxx
 *
 * Video file declaration
 *
 * Portable Windows Library
 *
 * Copyright (C) 2004 Post Increment
 *
 * 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
 * Craig Southeren <craigs@postincrement.com>
 *
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 30765 $
 * $Author: rjongbloed $
 * $Date: 2013-10-21 12:26:29 +1100 (Mon, 21 Oct 2013) $
 */

#ifndef PTLIB_PVFILEDEV_H
#define PTLIB_PVFILEDEV_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#if P_VIDEO
#if P_VIDFILE

#include <ptlib/video.h>
#include <ptlib/vconvert.h>
#include <ptclib/pvidfile.h>
#include <ptclib/delaychan.h>


//
// This class defines a video capture (input) device that reads video from a raw YUV file
//

class PVideoInputDevice_VideoFile : public PVideoInputDevice
{
  PCLASSINFO(PVideoInputDevice_VideoFile, PVideoInputDevice);
  public:
    enum {
      Channel_PlayAndClose     = 0,
      Channel_PlayAndRepeat    = 1,
      Channel_PlayAndKeepLast  = 2,
      Channel_PlayAndShowBlack = 3,
      ChannelCount             = 4
    };

    PVideoInputDevice_VideoFile();

    virtual ~PVideoInputDevice_VideoFile();


    PBoolean Open(
      const PString & deviceName,   
      PBoolean startImmediate = true    
    );

    PBoolean IsOpen() ;

    PBoolean Close();

    PBoolean Start();

    PBoolean Stop();

    PBoolean IsCapturing();

    static PStringArray GetInputDeviceNames();

    virtual PStringArray GetDeviceNames() const
      { return GetInputDeviceNames(); }

    static bool GetDeviceCapabilities(
      const PString & /*deviceName*/, 
      Capabilities * /*caps*/         
    ) { return false; }

    virtual PINDEX GetMaxFrameBytes();

    virtual PBoolean GetFrameData(
      BYTE * buffer,                 
      PINDEX * bytesReturned = NULL  
    );

    virtual PBoolean GetFrameDataNoDelay(
      BYTE * buffer,                 
      PINDEX * bytesReturned = NULL  
    );


    virtual PBoolean SetVideoFormat(
      VideoFormat videoFormat   
    );

    virtual int GetNumChannels();

    virtual PStringArray GetChannelNames();

    virtual PBoolean SetColourFormat(
      const PString & colourFormat   // New colour format for device.
    );
    
    virtual PBoolean SetFrameRate(
      unsigned rate  
    );
         
    virtual PBoolean GetFrameSizeLimits(
      unsigned & minWidth,   
      unsigned & minHeight,  
      unsigned & maxWidth,   
      unsigned & maxHeight   
    ) ;

    virtual PBoolean SetFrameSize(
      unsigned width,   
      unsigned height   
    );

   
 protected:
   PVideoFile   * m_file;
   PAdaptiveDelay m_pacing;
   unsigned       m_frameRateAdjust;
   bool           m_opened;
};


//
// This class defines a video display (output) device that writes video to a raw YUV file
//

class PVideoOutputDevice_VideoFile : public PVideoOutputDevice
{
  PCLASSINFO(PVideoOutputDevice_VideoFile, PVideoOutputDevice);

  public:
    PVideoOutputDevice_VideoFile();

    virtual ~PVideoOutputDevice_VideoFile();

    static PStringArray GetOutputDeviceNames();

    virtual PStringArray GetDeviceNames() const
      { return GetOutputDeviceNames(); }

    virtual PBoolean Open(
      const PString & deviceName,   
      PBoolean startImmediate = true    
    );

    PBoolean Start();

    PBoolean Stop();

    virtual PBoolean Close();

    virtual PBoolean IsOpen();

    virtual PBoolean SetColourFormat(
      const PString & colourFormat   // New colour format for device.
    );
    
    virtual PINDEX GetMaxFrameBytes();

    virtual PBoolean SetFrameData(
      unsigned x,
      unsigned y,
      unsigned width,
      unsigned height,
      const BYTE * data,
      PBoolean endFrame = true
    );

  protected:  
   PVideoFile * m_file;
   bool         m_opened;
};


#endif // P_VIDFILE
#endif

#endif // PTLIB_PVFILEDEV_H


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