mpf_stream.h

Go to the documentation of this file.

/*
 * Copyright 2008-2014 Arsen Chaloyan
 *
 * Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * $Id: mpf_stream.h 2136 2014-07-04 06:33:36Z achaloyan@gmail.com $
 */

#ifndef MPF_STREAM_H
#define MPF_STREAM_H

/**
 * @file mpf_stream.h
 * @brief MPF Bidirectional Stream
 */ 

#include "mpf_types.h"
#include "mpf_frame.h"
#include "mpf_stream_descriptor.h"
#include "mpf_codec.h"
#include "apt_text_stream.h"

APT_BEGIN_EXTERN_C

/** Declaration of virtual table of audio stream */
typedef struct mpf_audio_stream_vtable_t mpf_audio_stream_vtable_t;

/** Audio stream */
struct mpf_audio_stream_t {
    /** External object */
    void                            *obj;
    /** Table of virtual methods */
    const mpf_audio_stream_vtable_t *vtable;
    /** Back pointer */
    mpf_termination_t               *termination;

    /** Stream capabilities */
    const mpf_stream_capabilities_t *capabilities;

    /** Stream direction send/receive (bitmask of mpf_stream_direction_e) */
    mpf_stream_direction_e           direction;
    /** Rx codec descriptor */
    mpf_codec_descriptor_t          *rx_descriptor;
    /** Rx event descriptor */
    mpf_codec_descriptor_t          *rx_event_descriptor;
    /** Tx codec descriptor */
    mpf_codec_descriptor_t          *tx_descriptor;
    /** Tx event descriptor */
    mpf_codec_descriptor_t          *tx_event_descriptor;
};

/** Video stream */
struct mpf_video_stream_t {
    /** Back pointer */
    mpf_termination_t               *termination;
    /** Stream direction send/receive (bitmask of mpf_stream_direction_e) */
    mpf_stream_direction_e           direction;
};

/** Table of audio stream virtual methods */
struct mpf_audio_stream_vtable_t {
    /** Virtual destroy method */
    apt_bool_t (*destroy)(mpf_audio_stream_t *stream);

    /** Virtual open receiver method */
    apt_bool_t (*open_rx)(mpf_audio_stream_t *stream, mpf_codec_t *codec);
    /** Virtual close receiver method */
    apt_bool_t (*close_rx)(mpf_audio_stream_t *stream);
    /** Virtual read frame method */
    apt_bool_t (*read_frame)(mpf_audio_stream_t *stream, mpf_frame_t *frame);

    /** Virtual open transmitter method */
    apt_bool_t (*open_tx)(mpf_audio_stream_t *stream, mpf_codec_t *codec);
    /** Virtual close transmitter method */
    apt_bool_t (*close_tx)(mpf_audio_stream_t *stream);
    /** Virtual write frame method */
    apt_bool_t (*write_frame)(mpf_audio_stream_t *stream, const mpf_frame_t *frame);

    /** Virtual trace method */
    void (*trace)(mpf_audio_stream_t *stream, mpf_stream_direction_e direction, apt_text_stream_t *output);
};

/** Create audio stream */
MPF_DECLARE(mpf_audio_stream_t*) mpf_audio_stream_create(void *obj, const mpf_audio_stream_vtable_t *vtable, const mpf_stream_capabilities_t *capabilities, apr_pool_t *pool);

/** Validate audio stream receiver */
MPF_DECLARE(apt_bool_t) mpf_audio_stream_rx_validate(
                            mpf_audio_stream_t *stream,
                            const mpf_codec_descriptor_t *descriptor,
                            const mpf_codec_descriptor_t *event_descriptor,
                            apr_pool_t *pool);

/** Validate audio stream transmitter */
MPF_DECLARE(apt_bool_t) mpf_audio_stream_tx_validate(
                            mpf_audio_stream_t *stream, 
                            const mpf_codec_descriptor_t *descriptor, 
                            const mpf_codec_descriptor_t *event_descriptor, 
                            apr_pool_t *pool);

/** Destroy audio stream */
static APR_INLINE apt_bool_t mpf_audio_stream_destroy(mpf_audio_stream_t *stream)
{
    if(stream->vtable->destroy)
        return stream->vtable->destroy(stream);
    return TRUE;
}

/** Open audio stream receiver */
static APR_INLINE apt_bool_t mpf_audio_stream_rx_open(mpf_audio_stream_t *stream, mpf_codec_t *codec)
{
    if(stream->vtable->open_rx)
        return stream->vtable->open_rx(stream,codec);
    return TRUE;
}

/** Close audio stream receiver */
static APR_INLINE apt_bool_t mpf_audio_stream_rx_close(mpf_audio_stream_t *stream)
{
    if(stream->vtable->close_rx)
        return stream->vtable->close_rx(stream);
    return TRUE;
}

/** Read frame */
static APR_INLINE apt_bool_t mpf_audio_stream_frame_read(mpf_audio_stream_t *stream, mpf_frame_t *frame)
{
    if(stream->vtable->read_frame)
        return stream->vtable->read_frame(stream,frame);
    return TRUE;
}

/** Open audio stream transmitter */
static APR_INLINE apt_bool_t mpf_audio_stream_tx_open(mpf_audio_stream_t *stream, mpf_codec_t *codec)
{
    if(stream->vtable->open_tx)
        return stream->vtable->open_tx(stream,codec);
    return TRUE;
}

/** Close audio stream transmitter */
static APR_INLINE apt_bool_t mpf_audio_stream_tx_close(mpf_audio_stream_t *stream)
{
    if(stream->vtable->close_tx)
        return stream->vtable->close_tx(stream);
    return TRUE;
}

/** Write frame */
static APR_INLINE apt_bool_t mpf_audio_stream_frame_write(mpf_audio_stream_t *stream, const mpf_frame_t *frame)
{
    if(stream->vtable->write_frame)
        return stream->vtable->write_frame(stream,frame);
    return TRUE;
}

/** Trace media path */
MPF_DECLARE(void) mpf_audio_stream_trace(mpf_audio_stream_t *stream, mpf_stream_direction_e direction, apt_text_stream_t *output);

APT_END_EXTERN_C

#endif /* MPF_STREAM_H */