mpf_context.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_context.h 2136 2014-07-04 06:33:36Z achaloyan@gmail.com $
 */

#ifndef MPF_CONTEXT_H
#define MPF_CONTEXT_H

/**
 * @file mpf_context.h
 * @brief MPF Context
 */ 

#include "mpf_types.h"

APT_BEGIN_EXTERN_C

/** Opaque factory of media contexts */
typedef struct mpf_context_factory_t mpf_context_factory_t;
 
/**
 * Create factory of media contexts.
 */
MPF_DECLARE(mpf_context_factory_t*) mpf_context_factory_create(apr_pool_t *pool); 

/**
 * Destroy factory of media contexts.
 */
MPF_DECLARE(void) mpf_context_factory_destroy(mpf_context_factory_t *factory); 

/**
 * Process factory of media contexts.
 */
MPF_DECLARE(apt_bool_t) mpf_context_factory_process(mpf_context_factory_t *factory);

/**
 * Create MPF context.
 * @param factory the factory context belongs to
 * @param name the informative name of the context
 * @param obj the external object associated with context
 * @param max_termination_count the max number of terminations in context
 * @param pool the pool to allocate memory from
 */
MPF_DECLARE(mpf_context_t*) mpf_context_create(
                                mpf_context_factory_t *factory, 
                                const char *name,
                                void *obj, 
                                apr_size_t max_termination_count, 
                                apr_pool_t *pool);

/**
 * Destroy MPF context.
 * @param context the context to destroy
 */
MPF_DECLARE(apt_bool_t) mpf_context_destroy(mpf_context_t *context);

/**
 * Get external object associated with MPF context.
 * @param context the context to get object from
 */
MPF_DECLARE(void*) mpf_context_object_get(const mpf_context_t *context);

/**
 * Add termination to context.
 * @param context the context to add termination to
 * @param termination the termination to add
 */
MPF_DECLARE(apt_bool_t) mpf_context_termination_add(mpf_context_t *context, mpf_termination_t *termination);

/**
 * Subtract termination from context.
 * @param context the context to subtract termination from
 * @param termination the termination to subtract
 */
MPF_DECLARE(apt_bool_t) mpf_context_termination_subtract(mpf_context_t *context, mpf_termination_t *termination);

/**
 * Add association between specified terminations.
 * @param context the context to add association in the scope of
 * @param termination1 the first termination to associate
 * @param termination2 the second termination to associate
 */
MPF_DECLARE(apt_bool_t) mpf_context_association_add(mpf_context_t *context, mpf_termination_t *termination1, mpf_termination_t *termination2);

/**
 * Remove association between specified terminations.
 * @param context the context to remove association in the scope of
 * @param termination1 the first termination
 * @param termination2 the second termination
 */
MPF_DECLARE(apt_bool_t) mpf_context_association_remove(mpf_context_t *context, mpf_termination_t *termination1, mpf_termination_t *termination2);

/**
 * Reset assigned associations and destroy applied topology.
 * @param context the context to reset associations for
 */
MPF_DECLARE(apt_bool_t) mpf_context_associations_reset(mpf_context_t *context);

/**
 * Apply topology.
 * @param context the context to apply topology for
 */
MPF_DECLARE(apt_bool_t) mpf_context_topology_apply(mpf_context_t *context);

/**
 * Destroy topology.
 * @param context the context to destroy topology for
 */
MPF_DECLARE(apt_bool_t) mpf_context_topology_destroy(mpf_context_t *context);

/**
 * Process context.
 * @param context the context to process
 */
MPF_DECLARE(apt_bool_t) mpf_context_process(mpf_context_t *context);


APT_END_EXTERN_C

#endif /* MPF_CONTEXT_H */