omx/mm-video/qdsp6/venc/test/common/inc/venctest_Queue.h

/*--------------------------------------------------------------------------
Copyright (c) 2010, Code Aurora Forum. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of Code Aurora nor
      the names of its contributors may be used to endorse or promote
      products derived from this software without specific prior written
      permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--------------------------------------------------------------------------*/

#ifndef _VENC_TEST_QUEUE_H
#define _VENC_TEST_QUEUE_H
/*========================================================================

                     INCLUDE FILES FOR MODULE

==========================================================================*/
#include "OMX_Core.h"

namespace venctest
{

  /**
   * @brief Queue class.
   */
  class Queue
  {
    public:

      /**
       * @brief Constructor
       *
       * @param nMaxQueueSize Max number of items in queue (size)
       * @param nMaxDataSize Max data size
       */
      Queue(OMX_S32 nMaxQueueSize,
          OMX_S32 nMaxDataSize);

      /**
       * @brief Destructor
       */
      ~Queue();

    private:
      Queue(); // private default constructor
    public:

      /**
       * @brief Pushes an item onto the queue.
       *
       * @param pData Pointer to the data
       * @param nDataSize Size of the data in bytes
       */
      OMX_ERRORTYPE Push(OMX_PTR pData,
          OMX_S32 nDataSize);

      /**
       * @brief Pops an item from the queue.
       *
       * @param pData Pointer to the data
       * @param nDataSize Size of the data buffer in bytes
       */
      OMX_ERRORTYPE Pop(OMX_PTR pData,
          OMX_S32 nDataSize);

      /**
       * @brief Peeks at the item at the head of the queue
       *
       * Nothing will be removed from the queue
       *
       * @param pData Pointer to the data
       * @param nDataSize Size of the data in bytes
       *
       * @return OMX_ErrorNotReady if there is no data
       */
      OMX_ERRORTYPE Peek(OMX_PTR pData,
          OMX_S32 nDataSize);

      /**
       * @brief Get the size of the queue.
       */
      OMX_S32 GetSize();

    private:
      OMX_PTR m_pHandle;
  };
}

#endif // #ifndef _VENC_TEST_QUEUE_H