recording.h

Go to the documentation of this file.

/*
 * audiorecord.h
 *
 * OPAL audio record manager
 *
 * Open Phone Abstraction Library (OPAL)
 * Formally known as the Open H323 project.
 *
 * Copyright (C) 2007 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 Open Phone Abstraction Library.
 *
 * The Initial Developer of the Original Code is Post Increment
 *
 * Contributor(s): ______________________________________.
 */


#ifndef OPAL_OPAL_AUDIORECORD_H
#define OPAL_OPAL_AUDIORECORD_H


#include <opal_config.h>

#if OPAL_HAS_MIXER

#include <ptlib/vconvert.h>
#include <ptlib/pfactory.h>


class OpalMediaFormat;
class RTP_DataFrame;


class OpalRecordManager : public PObject
{
    PCLASSINFO(OpalRecordManager, PObject);
  public:
    typedef PFactory<OpalRecordManager, PFilePathString> Factory;

#if OPAL_VIDEO
    enum VideoMode {
      eSideBySideLetterbox, 
      eSideBySideScaled,    
      eStackedPillarbox,    
      eStackedScaled,       
      eSeparateStreams,     
      NumVideoMixingModes
    };
#endif

    // Options for recording calls.
    struct Options {
      bool      m_stereo;       
      PString   m_audioFormat;  
      PINDEX    m_audioBufferSize; 
#if OPAL_VIDEO
      VideoMode m_videoMixing;  
      PString   m_videoFormat;  
      unsigned  m_videoWidth;   
      unsigned  m_videoHeight;  
      unsigned  m_videoRate;    
#endif
      bool      m_pushThreads;  

      Options(
        bool         stereo = true,
#if OPAL_VIDEO
        VideoMode    videoMixing = eSideBySideLetterbox,
#endif
        const char * audioFormat = NULL,
#if OPAL_VIDEO
        const char * videoFormat = NULL,
        unsigned width = PVideoFrameInfo::CIFWidth,
        unsigned height = PVideoFrameInfo::CIFHeight,
        unsigned rate = 15,
#endif
        bool pushThreads = true
      ) : m_stereo(stereo)
        , m_audioFormat(audioFormat)
        , m_audioBufferSize(0)
#if OPAL_VIDEO
        , m_videoMixing(videoMixing)
        , m_videoFormat(videoFormat)
        , m_videoWidth(width)
        , m_videoHeight(height)
        , m_videoRate(rate)
#endif
        , m_pushThreads(pushThreads)
      {
      }
    };

    bool Open(const PFilePath & fn);

    bool Open(const PFilePath & fn, bool mono); // For backward compatibility

    bool Open(const PFilePath & fn, const Options & options);

    virtual bool IsOpen() const = 0;

    virtual bool Close() = 0;

    virtual bool OpenStream(
      const PString & strmId,         
      const OpalMediaFormat & format  
    ) = 0;

    virtual bool CloseStream(
      const PString & strmId  
    ) = 0;

    virtual bool OnPushAudio() = 0;
    virtual unsigned GetPushAudioPeriodMS() const = 0;

    virtual bool WriteAudio(
      const PString & strmId,     
      const RTP_DataFrame & rtp   
    ) = 0;

#if OPAL_VIDEO

    virtual bool OnPushVideo() = 0;
    virtual unsigned GetPushVideoPeriodMS() const = 0;

    virtual bool WriteVideo(
      const PString & strmId,     
      const RTP_DataFrame & rtp   
    ) = 0;
#endif

    const Options & GetOptions() const { return m_options; }

    void SetOptions(const Options & options)
    {
      m_options = options;
    }

  protected:
    virtual bool OpenFile(const PFilePath & fn) = 0;

    Options m_options;
};

#endif // OPAL_HAS_MIXER

#endif // OPAL_OPAL_AUDIORECORD_H