/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* Copyright (c) 2011, The WebRTC project authors. All rights reserved.

 * Copyright (c) 2014, Mozilla

 *

 * 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 Google 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 AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 * HOLDER 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 GMP_VIDEO_ENCODE_h_

#define GMP_VIDEO_ENCODE_h_

#include <vector>

#include <stdint.h>

#include "gmp-errors.h"

#include "gmp-video-frame-i420.h"

#include "gmp-video-frame-encoded.h"

#include "gmp-video-codec.h"

// ALL METHODS MUST BE CALLED ON THE MAIN THREAD

class GMPVideoEncoderCallback

{

public:

  virtual ~GMPVideoEncoderCallback() {}

  virtual void Encoded(GMPVideoEncodedFrame* aEncodedFrame,

                       const uint8_t* aCodecSpecificInfo,

                       uint32_t aCodecSpecificInfoLength) = 0;

  // Called when the encoder encounters a catestrophic error and cannot

  // continue. Gecko will not send any more input for encoding.

  virtual void Error(GMPErr aError) = 0;

};

#define GMP_API_VIDEO_ENCODER "encode-video"

// Video encoding for a single stream. A GMP may be asked to create multiple

// encoders concurrently.

//

// API name macro: GMP_API_VIDEO_ENCODER

// Host API: GMPVideoHost

//

// ALL METHODS MUST BE CALLED ON THE MAIN THREAD

class GMPVideoEncoder

{

public:

  virtual ~GMPVideoEncoder() {}

  // Initialize the encoder with the information from the VideoCodec.

  //

  // Input:

  // - codecSettings : Codec settings

  // - aCodecSpecific : codec specific data, pointer to a

  //                    GMPCodecSpecific structure appropriate for

  //                    this codec type.

  // - aCodecSpecificLength : number of bytes in aCodecSpecific

  // - aCallback: Subclass should retain reference to it until EncodingComplete

  //              is called. Do not attempt to delete it, host retains ownership.

  // - aNnumberOfCores : Number of cores available for the encoder

  // - aMaxPayloadSize : The maximum size each payload is allowed

  //                    to have. Usually MTU - overhead.

  virtual void InitEncode(const GMPVideoCodec& aCodecSettings,

                          const uint8_t* aCodecSpecific,

                          uint32_t aCodecSpecificLength,

                          GMPVideoEncoderCallback* aCallback,

                          int32_t aNumberOfCores,

                          uint32_t aMaxPayloadSize) = 0;

  // Encode an I420 frame (as a part of a video stream). The encoded frame

  // will be returned to the user through the encode complete callback.

  //

  // Input:

  // - aInputFrame : Frame to be encoded

  // - aCodecSpecificInfo : codec specific data, pointer to a

  //                        GMPCodecSpecificInfo structure appropriate for

  //                        this codec type.

  // - aCodecSpecificInfoLength : number of bytes in aCodecSpecific

  // - aFrameTypes : The frame type to encode

  // - aFrameTypesLength : The number of elements in aFrameTypes array.

  virtual void Encode(GMPVideoi420Frame* aInputFrame,

                      const uint8_t* aCodecSpecificInfo,

                      uint32_t aCodecSpecificInfoLength,

                      const GMPVideoFrameType* aFrameTypes,

                      uint32_t aFrameTypesLength) = 0;

  // Inform the encoder about the packet loss and round trip time on the

  // network used to decide the best pattern and signaling.

  //

  // - packetLoss : Fraction lost (loss rate in percent =

  // 100 * packetLoss / 255)

  // - rtt : Round-trip time in milliseconds

  virtual void SetChannelParameters(uint32_t aPacketLoss, uint32_t aRTT) = 0;

  // Inform the encoder about the new target bit rate.

  //

  // - newBitRate : New target bit rate

  // - frameRate : The target frame rate

  virtual void SetRates(uint32_t aNewBitRate, uint32_t aFrameRate) = 0;

  // Use this function to enable or disable periodic key frames. Can be useful for codecs

  // which have other ways of stopping error propagation.

  //

  // - enable : Enable or disable periodic key frames

  virtual void SetPeriodicKeyFrames(bool aEnable) = 0;

  // May free Encoder memory.

  virtual void EncodingComplete() = 0;

};

#endif // GMP_VIDEO_ENCODE_h_