git.sesse.net Git - ffmpeg/blob - libswresample/swresample.h

   1 /*
   2  * Copyright (C) 2011 Michael Niedermayer (michaelni@gmx.at)
   3  *
   4  * This file is part of libswresample
   5  *
   6  * libswresample is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * libswresample is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with libswresample; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * libswresample public header
  24  */
  25
  26 #ifndef SWR_H
  27 #define SWR_H
  28
  29 #include <inttypes.h>
  30 #include "libavutil/samplefmt.h"
  31
  32 #define LIBSWRESAMPLE_VERSION_MAJOR 0
  33 #define LIBSWRESAMPLE_VERSION_MINOR 5
  34 #define LIBSWRESAMPLE_VERSION_MICRO 100
  35
  36 #define LIBSWRESAMPLE_VERSION_INT  AV_VERSION_INT(LIBSWRESAMPLE_VERSION_MAJOR, \
  37                                                   LIBSWRESAMPLE_VERSION_MINOR, \
  38                                                   LIBSWRESAMPLE_VERSION_MICRO)
  39
  40 #define SWR_CH_MAX 16   ///< Maximum number of channels
  41
  42 #define SWR_FLAG_RESAMPLE 1 ///< Force resampling even if equal sample rate
  43 //TODO use int resample ?
  44 //long term TODO can we enable this dynamically?
  45
  46
  47 struct SwrContext;
  48
  49 /**
  50  * Allocate SwrContext.
  51  *
  52  * If you use this function you will need to set the parameters (manually or
  53  * with swr_alloc_set_opts()) before calling swr_init().
  54  *
  55  * @see swr_alloc_set_opts(), swr_init(), swr_free()
  56  * @return NULL on error, allocated context otherwise
  57  */
  58 struct SwrContext *swr_alloc(void);
  59
  60 /**
  61  * Initialize context after user parameters have been set.
  62  *
  63  * @return AVERROR error code in case of failure.
  64  */
  65 int swr_init(struct SwrContext *s);
  66
  67 /**
  68  * Allocate SwrContext if needed and set/reset common parameters.
  69  *
  70  * This function does not require s to be allocated with swr_alloc(). On the
  71  * other hand, swr_alloc() can use swr_alloc_set_opts() to set the parameters
  72  * on the allocated context.
  73  *
  74  * @param s               Swr context, can be NULL
  75  * @param out_ch_layout   output channel layout (AV_CH_LAYOUT_*)
  76  * @param out_sample_fmt  output sample format (AV_SAMPLE_FMT_*).
  77  * @param out_sample_rate output sample rate (frequency in Hz)
  78  * @param in_ch_layout    input channel layout (AV_CH_LAYOUT_*)
  79  * @param in_sample_fmt   input sample format (AV_SAMPLE_FMT_*).
  80  * @param in_sample_rate  input sample rate (frequency in Hz)
  81  * @param log_offset      logging level offset
  82  * @param log_ctx         parent logging context, can be NULL
  83  *
  84  * @see swr_init(), swr_free()
  85  * @return NULL on error, allocated context otherwise
  86  */
  87 struct SwrContext *swr_alloc_set_opts(struct SwrContext *s,
  88                                       int64_t out_ch_layout, enum AVSampleFormat out_sample_fmt, int out_sample_rate,
  89                                       int64_t  in_ch_layout, enum AVSampleFormat  in_sample_fmt, int  in_sample_rate,
  90                                       int log_offset, void *log_ctx);
  91
  92 /**
  93  * Free the given SwrContext and set the pointer to NULL.
  94  */
  95 void swr_free(struct SwrContext **s);
  96
  97 /**
  98  * Convert audio.
  99  *
 100  * in and in_count can be set to 0 to flush the last few samples out at the
 101  * end.
 102  *
 103  * @param s         allocated Swr context, with parameters set
 104  * @param out       output buffers, only the first one need be set in case of packed audio
 105  * @param out_count amount of space available for output in samples per channel
 106  * @param in        input buffers, only the first one need to be set in case of packed audio
 107  * @param in_count  number of input samples available in one channel
 108  *
 109  * @return number of samples output per channel
 110  */
 111 int swr_convert(struct SwrContext *s, uint8_t *out[SWR_CH_MAX], int out_count,
 112                                 const uint8_t *in [SWR_CH_MAX], int in_count);
 113
 114 /**
 115  * Activate resampling compensation.
 116  */
 117 void swr_compensate(struct SwrContext *s, int sample_delta, int compensation_distance);
 118
 119 /**
 120  * Set a customized input channel mapping.
 121  *
 122  * @param s           allocated Swr context, not yet initialized
 123  * @param channel_map customized input channel mapping (array of channel
 124  *                    indexes, -1 for a muted channel)
 125  * @return AVERROR error code in case of failure.
 126  */
 127 int swr_set_channel_mapping(struct SwrContext *s, const int *channel_map);
 128
 129 /**
 130  * Return the LIBSWRESAMPLE_VERSION_INT constant.
 131  */
 132 unsigned swresample_version(void);
 133
 134 /**
 135  * Return the swr build-time configuration.
 136  */
 137 const char *swresample_configuration(void);
 138
 139 /**
 140  * Return the swr license.
 141  */
 142 const char *swresample_license(void);
 143
 144 #endif