/* Network-Integrated Multimedia Middleware (NMM)
 * http://www.motama.com/nmm.html
 *
 * Copyright (C) 2006-2007
 * Motama GmbH, Saarbruecken, Germany
 * http://www.motama.com
 *
 * This file is part of NMM. 
 * 
 * NMM is free software; you can redistribute it and/or modify it    
 * under the terms of the GNU General Public License as published by 
 * the Free Software Foundation; only version 2 of the License.      
 * 
 * NMM is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public 
 * License for more details.  
 * 
 * You should have received a copy of the GNU General Public License 
 * along with NMM; if not, write to the Free Software Foundation,    
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */

module NMM {
  
  /** Interface for encoding statistics.
   *
   * Interface for encoders that provide statistics by sending events
   * to an IEncodeStatsListener.
   */
  interface IEncodeStats {
    
    /** Toggles sending frame count events.
     * 
     * Turns sending frame count events on or off. A frame count event
     * contains the number of frames encoded so far and the encoding
     * framerate.
     *
     * @param value True if frame count should be sent, false otherwise.
     */
    void sendFrameCount(in nmm_bool value);
  };
  
  /** Interface for handling/receiving encoding statistics.
   *
   * Used for handling instream events by an encoder that implements
   * IEncodeStats.
   */
  interface IEncodeStatsListener {
    
    /** Propagates encoded frames and current framerate.
     * 
     * Statistical event sent by the node, e.g. encoder.
     *
     * @param count number of frames encoded so far
     * @param fps current encoding framerate in frames per second
     */
    void setFrameCount(in nmm_uint32 count, in nmm_float fps) instream;
  };
}
