connectors.h

/*****************************************************************
 * gavl - a general purpose audio/video processing library
 *
 * Copyright (c) 2001 - 2012 Members of the Gmerlin project
 * gmerlin-general@lists.sourceforge.net
 * http://gmerlin.sourceforge.net
 *
 * 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 2 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, see <http://www.gnu.org/licenses/>.
 * *****************************************************************/
 
#ifndef GAVL_CONNECTORS_H_INCLUDED
#define GAVL_CONNECTORS_H_INCLUDED
 
#include <gavl/gavl.h>
#include <gavl/compression.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void (*gavl_connector_lock_func_t)(void * priv);
 
  
typedef enum
  {
    GAVL_SOURCE_EOF   = 0, 
    GAVL_SOURCE_OK    = 1, 
    GAVL_SOURCE_AGAIN = 2, 
  } gavl_source_status_t;
  
typedef gavl_source_status_t
(*gavl_audio_source_func_t)(void * priv, gavl_audio_frame_t ** frame);
 
typedef gavl_source_status_t
(*gavl_video_source_func_t)(void * priv, gavl_video_frame_t ** frame);
 
typedef gavl_source_status_t
(*gavl_packet_source_func_t)(void * priv, gavl_packet_t ** p);
 
 
#define GAVL_SOURCE_SRC_ALLOC               (1<<0)
 
 
#define GAVL_SOURCE_SRC_FRAMESIZE_MAX       (1<<2)
 
#define GAVL_SOURCE_SRC_DISCONTINUOUS       (1<<3)
 
 
/* Called by the source */
 
GAVL_PUBLIC
gavl_video_source_t *
gavl_video_source_create(gavl_video_source_func_t func,
                         void * priv, int src_flags,
                         const gavl_video_format_t * src_format);
 
GAVL_PUBLIC
gavl_video_source_t *
gavl_video_source_create_source(gavl_video_source_func_t func,
                                void * priv, int src_flags,
                                gavl_video_source_t * src);
  
GAVL_PUBLIC void
gavl_video_source_set_lock_funcs(gavl_video_source_t * src,
                                 gavl_connector_lock_func_t lock_func,
                                 gavl_connector_lock_func_t unlock_func,
                                 void * priv);
  
  
GAVL_PUBLIC
gavl_video_options_t * gavl_video_source_get_options(gavl_video_source_t * s);
 
GAVL_PUBLIC
void gavl_video_source_reset(gavl_video_source_t * s);
 
GAVL_PUBLIC
void gavl_video_source_destroy(gavl_video_source_t * s);
  
/* Called by the destination */
 
GAVL_PUBLIC
const gavl_video_format_t *
gavl_video_source_get_src_format(gavl_video_source_t * s);
 
GAVL_PUBLIC
const gavl_video_format_t *
gavl_video_source_get_dst_format(gavl_video_source_t * s);
 
GAVL_PUBLIC
void
gavl_video_source_set_dst(gavl_video_source_t * s, int dst_flags,
                          const gavl_video_format_t * dst_format);
 
GAVL_PUBLIC
gavl_source_status_t
gavl_video_source_read_frame(void * s, gavl_video_frame_t ** frame);
  
/* Called by source */ 
 
GAVL_PUBLIC
gavl_audio_source_t *
gavl_audio_source_create(gavl_audio_source_func_t func,
                         void * priv, int src_flags,
                         const gavl_audio_format_t * src_format);
 
GAVL_PUBLIC
gavl_audio_source_t *
gavl_audio_source_create_source(gavl_audio_source_func_t func,
                                void * priv, int src_flags,
                                gavl_audio_source_t * src);
 
  
GAVL_PUBLIC void
gavl_audio_source_set_lock_funcs(gavl_audio_source_t * src,
                                 gavl_connector_lock_func_t lock_func,
                                 gavl_connector_lock_func_t unlock_func,
                                 void * priv);
 
  
GAVL_PUBLIC
const gavl_audio_format_t *
gavl_audio_source_get_src_format(gavl_audio_source_t * s);
 
GAVL_PUBLIC
const gavl_audio_format_t *
gavl_audio_source_get_dst_format(gavl_audio_source_t * s);
 
GAVL_PUBLIC
void
gavl_audio_source_set_dst(gavl_audio_source_t * s, int dst_flags,
                          const gavl_audio_format_t * dst_format);
 
GAVL_PUBLIC
gavl_source_status_t
gavl_audio_source_read_frame(void*s, gavl_audio_frame_t ** frame);
 
GAVL_PUBLIC
void 
gavl_audio_source_skip_src(gavl_audio_source_t * s, int num_samples);
  
GAVL_PUBLIC
int gavl_audio_source_read_samples(void*s, gavl_audio_frame_t * frame,
                                   int num_samples);
 
GAVL_PUBLIC
gavl_audio_options_t * gavl_audio_source_get_options(gavl_audio_source_t * s);
 
GAVL_PUBLIC
void gavl_audio_source_reset(gavl_audio_source_t * s);
 
GAVL_PUBLIC
void gavl_audio_source_destroy(gavl_audio_source_t * s);
 
 
/* Packet source */
 
GAVL_PUBLIC
gavl_packet_source_t *
gavl_packet_source_create_audio(gavl_packet_source_func_t func,
                                void * priv, int src_flags,
                                const gavl_compression_info_t * ci,
                                const gavl_audio_format_t * afmt);
 
GAVL_PUBLIC
gavl_packet_source_t *
gavl_packet_source_create_video(gavl_packet_source_func_t func,
                                void * priv, int src_flags,
                                const gavl_compression_info_t * ci,
                                const gavl_video_format_t * vfmt);
 
GAVL_PUBLIC
gavl_packet_source_t *
gavl_packet_source_create_text(gavl_packet_source_func_t func,
                               void * priv, int src_flags, int timescale);
 
GAVL_PUBLIC
gavl_packet_source_t *
gavl_packet_source_create_source(gavl_packet_source_func_t func,
                                 void * priv, int src_flags,
                                 gavl_packet_source_t * src);
 
  
GAVL_PUBLIC void
gavl_packet_source_set_lock_funcs(gavl_packet_source_t * src,
                                  gavl_connector_lock_func_t lock_func,
                                  gavl_connector_lock_func_t unlock_func,
                                  void * priv);
 
  
GAVL_PUBLIC const gavl_compression_info_t *
gavl_packet_source_get_ci(gavl_packet_source_t * s);
 
GAVL_PUBLIC const gavl_audio_format_t *
gavl_packet_source_get_audio_format(gavl_packet_source_t * s);
 
GAVL_PUBLIC const gavl_video_format_t *
gavl_packet_source_get_video_format(gavl_packet_source_t * s);
 
GAVL_PUBLIC int
gavl_packet_source_get_timescale(gavl_packet_source_t * s);
 
GAVL_PUBLIC gavl_source_status_t
gavl_packet_source_read_packet(void*s, gavl_packet_t ** p);
 
GAVL_PUBLIC void
gavl_packet_source_destroy(gavl_packet_source_t * s);
 
typedef enum
  {
    GAVL_SINK_ERROR, 
    GAVL_SINK_OK,    
  } gavl_sink_status_t;
 
 
typedef gavl_audio_frame_t *
(*gavl_audio_sink_get_func)(void * priv);
 
typedef gavl_sink_status_t
(*gavl_audio_sink_put_func)(void * priv, gavl_audio_frame_t * f);
 
GAVL_PUBLIC gavl_audio_sink_t *
gavl_audio_sink_create(gavl_audio_sink_get_func get_func,
                       gavl_audio_sink_put_func put_func,
                       void * priv,
                       const gavl_audio_format_t * format);
 
GAVL_PUBLIC void
gavl_audio_sink_set_lock_funcs(gavl_audio_sink_t * sink,
                               gavl_connector_lock_func_t lock_func,
                               gavl_connector_lock_func_t unlock_func,
                               void * priv);
 
  
GAVL_PUBLIC const gavl_audio_format_t *
gavl_audio_sink_get_format(gavl_audio_sink_t * s);
 
GAVL_PUBLIC gavl_audio_frame_t *
gavl_audio_sink_get_frame(gavl_audio_sink_t * s);
 
GAVL_PUBLIC gavl_sink_status_t
gavl_audio_sink_put_frame(gavl_audio_sink_t * s, gavl_audio_frame_t * f);
 
GAVL_PUBLIC void
gavl_audio_sink_destroy(gavl_audio_sink_t * s);
 
  
 
typedef gavl_video_frame_t *
(*gavl_video_sink_get_func)(void * priv);
 
typedef gavl_sink_status_t
(*gavl_video_sink_put_func)(void * priv, gavl_video_frame_t * f);
 
GAVL_PUBLIC gavl_video_sink_t *
gavl_video_sink_create(gavl_video_sink_get_func get_func,
                       gavl_video_sink_put_func put_func,
                       void * priv,
                       const gavl_video_format_t * format);
 
GAVL_PUBLIC void
gavl_video_sink_set_lock_funcs(gavl_video_sink_t * sink,
                               gavl_connector_lock_func_t lock_func,
                               gavl_connector_lock_func_t unlock_func,
                               void * priv);
  
GAVL_PUBLIC const gavl_video_format_t *
gavl_video_sink_get_format(gavl_video_sink_t * s);
 
GAVL_PUBLIC gavl_video_frame_t *
gavl_video_sink_get_frame(gavl_video_sink_t * s);
 
GAVL_PUBLIC gavl_sink_status_t
gavl_video_sink_put_frame(gavl_video_sink_t * s, gavl_video_frame_t * f);
 
GAVL_PUBLIC void
gavl_video_sink_destroy(gavl_video_sink_t * s);
 
 
 
typedef gavl_packet_t *
(*gavl_packet_sink_get_func)(void * priv);
 
typedef gavl_sink_status_t
(*gavl_packet_sink_put_func)(void * priv, gavl_packet_t * p);
 
GAVL_PUBLIC gavl_packet_sink_t *
gavl_packet_sink_create(gavl_packet_sink_get_func get_func,
                        gavl_packet_sink_put_func put_func,
                        void * priv);
 
GAVL_PUBLIC void
gavl_packet_sink_set_lock_funcs(gavl_packet_sink_t * sink,
                                gavl_connector_lock_func_t lock_func,
                                gavl_connector_lock_func_t unlock_func,
                                void * priv);
 
  
GAVL_PUBLIC gavl_packet_t *
gavl_packet_sink_get_packet(gavl_packet_sink_t * s);
 
GAVL_PUBLIC gavl_sink_status_t
gavl_packet_sink_put_packet(gavl_packet_sink_t * s, gavl_packet_t * p);
 
GAVL_PUBLIC void
gavl_packet_sink_destroy(gavl_packet_sink_t * s);
 
  
typedef struct gavl_audio_connector_s gavl_audio_connector_t;
 
typedef struct gavl_video_connector_s gavl_video_connector_t;
 
typedef struct gavl_packet_connector_s gavl_packet_connector_t;
  
typedef void
(*gavl_audio_connector_process_func)(void * priv,
                                     gavl_audio_frame_t * frame);
 
typedef void
(*gavl_video_connector_process_func)(void * priv,
                                     gavl_video_frame_t * frame);
 
typedef void
(*gavl_packet_connector_process_func)(void * priv,
                                      gavl_packet_t * p);
  
GAVL_PUBLIC gavl_audio_connector_t *
gavl_audio_connector_create(gavl_audio_source_t * src);
 
GAVL_PUBLIC gavl_audio_options_t *
gavl_audio_connector_get_options(gavl_audio_connector_t * c);
 
GAVL_PUBLIC void
gavl_audio_connector_destroy(gavl_audio_connector_t * c);
 
GAVL_PUBLIC void
gavl_audio_connector_connect(gavl_audio_connector_t * c,
                             gavl_audio_sink_t * sink);
 
GAVL_PUBLIC void
gavl_audio_connector_set_process_func(gavl_audio_connector_t * c,
                                      gavl_audio_connector_process_func func,
                                      void * priv);
 
GAVL_PUBLIC void
gavl_audio_connector_start(gavl_audio_connector_t * c);
 
GAVL_PUBLIC const gavl_audio_format_t * 
gavl_audio_connector_get_process_format(gavl_audio_connector_t * c);
 
GAVL_PUBLIC int
gavl_audio_connector_process(gavl_audio_connector_t * c);
 
GAVL_PUBLIC
void gavl_audio_connector_reset(gavl_audio_connector_t * c);
 
GAVL_PUBLIC gavl_source_status_t
gavl_audio_connector_get_source_status(gavl_audio_connector_t * c);
 
  
/* */
 
GAVL_PUBLIC gavl_video_connector_t *
gavl_video_connector_create(gavl_video_source_t * src);
 
GAVL_PUBLIC gavl_video_options_t *
gavl_video_connector_get_options(gavl_video_connector_t * c);
 
GAVL_PUBLIC void
gavl_video_connector_destroy(gavl_video_connector_t * c);
 
GAVL_PUBLIC void
gavl_video_connector_connect(gavl_video_connector_t * c,
                             gavl_video_sink_t * sink);
 
GAVL_PUBLIC void
gavl_video_connector_set_process_func(gavl_video_connector_t * c,
                                      gavl_video_connector_process_func func,
                                      void * priv);
 
GAVL_PUBLIC void
gavl_video_connector_start(gavl_video_connector_t * c);
 
GAVL_PUBLIC const gavl_video_format_t * 
gavl_video_connector_get_process_format(gavl_video_connector_t * c);
 
GAVL_PUBLIC int
gavl_video_connector_process(gavl_video_connector_t * c);
 
GAVL_PUBLIC
void gavl_video_connector_reset(gavl_video_connector_t * c);
 
GAVL_PUBLIC gavl_source_status_t 
gavl_video_connector_get_source_status(gavl_video_connector_t * c);
 
/* */
 
GAVL_PUBLIC gavl_packet_connector_t *
gavl_packet_connector_create(gavl_packet_source_t * src);
 
GAVL_PUBLIC void
gavl_packet_connector_destroy(gavl_packet_connector_t * c);
 
GAVL_PUBLIC void
gavl_packet_connector_connect(gavl_packet_connector_t * c,
                              gavl_packet_sink_t * sink);
 
GAVL_PUBLIC void
gavl_packet_connector_set_process_func(gavl_packet_connector_t * c,
                                       gavl_packet_connector_process_func func,
                                       void * priv);
 
GAVL_PUBLIC int
gavl_packet_connector_process(gavl_packet_connector_t * c);
 
GAVL_PUBLIC gavl_source_status_t 
gavl_packet_connector_get_source_status(gavl_packet_connector_t * c);
 
 
  
#ifdef __cplusplus
}
#endif
 
#endif // GAVL_CONNECTORS_H_INCLUDED