codec.h

/*
 *  Copyright (C) 2004-2012 Savoir-Faire Linux Inc.
 *  Author: Pierre-Luc Bacon <pierre-luc.bacon@savoirfairelinux.com>
 *
 *  This program 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; either version 3 of the License, or
 *  (at your option) any later version.
 *  This program 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 this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  If you modify this program, or any covered work, by linking or
 *  combining it with the OpenSSL project's OpenSSL library (or a
 *  modified version of that library), containing parts covered by the
 *  terms of the OpenSSL or SSLeay licenses, Savoir-Faire Linux Inc.
 *  grants you additional permission to convey the resulting work.
 *  Corresponding Source for a non-source form of such a combination
 *  shall include the source code for the parts of OpenSSL used as well
 *  as that of the covered work.
 */

#ifndef CODEC_H_
#define CODEC_H_

#include "cc_config.h" // for types

/**
 * Interface for both audio codecs as well as video codecs.
 */
namespace sfl {
class Codec {
    public:
        virtual ~Codec() {}
        /**
         * @return The mimesubtype for this codec. Eg. : "theora"
         */
        virtual std::string getMimeSubtype() const = 0;

        /**
         * @return payload type numeric identifier.
         */
        virtual uint8 getPayloadType() const = 0;

        /**
         * @return RTP clock rate in Hz.
         */
        virtual uint32 getClockRate() const = 0;

        /**
         * @return The bitrate for which this codec is configured // TODO deal with VBR case.
         */
        virtual double getBitRate() const = 0;
};
}

typedef sfl::Codec* create_t();

typedef void destroy_t (sfl::Codec*);

#endif // CODEC_H_