audio_convert.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. /*
  2. * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg 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. * FFmpeg 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 FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. #ifndef AVRESAMPLE_AUDIO_CONVERT_H
  21. #define AVRESAMPLE_AUDIO_CONVERT_H
  22. #include "libavutil/samplefmt.h"
  23. #include "avresample.h"
  24. #include "internal.h"
  25. #include "audio_data.h"
  26. /**
  27. * Set conversion function if the parameters match.
  28. *
  29. * This compares the parameters of the conversion function to the parameters
  30. * in the AudioConvert context. If the parameters do not match, no changes are
  31. * made to the active functions. If the parameters do match and the alignment
  32. * is not constrained, the function is set as the generic conversion function.
  33. * If the parameters match and the alignment is constrained, the function is
  34. * set as the optimized conversion function.
  35. *
  36. * @param ac AudioConvert context
  37. * @param out_fmt output sample format
  38. * @param in_fmt input sample format
  39. * @param channels number of channels, or 0 for any number of channels
  40. * @param ptr_align buffer pointer alignment, in bytes
  41. * @param samples_align buffer size alignment, in samples
  42. * @param descr function type description (e.g. "C" or "SSE")
  43. * @param conv conversion function pointer
  44. */
  45. void ff_audio_convert_set_func(AudioConvert *ac, enum AVSampleFormat out_fmt,
  46. enum AVSampleFormat in_fmt, int channels,
  47. int ptr_align, int samples_align,
  48. const char *descr, void *conv);
  49. /**
  50. * Allocate and initialize AudioConvert context for sample format conversion.
  51. *
  52. * @param avr AVAudioResampleContext
  53. * @param out_fmt output sample format
  54. * @param in_fmt input sample format
  55. * @param channels number of channels
  56. * @param sample_rate sample rate (used for dithering)
  57. * @param apply_map apply channel map during conversion
  58. * @return newly-allocated AudioConvert context
  59. */
  60. AudioConvert *ff_audio_convert_alloc(AVAudioResampleContext *avr,
  61. enum AVSampleFormat out_fmt,
  62. enum AVSampleFormat in_fmt,
  63. int channels, int sample_rate,
  64. int apply_map);
  65. /**
  66. * Free AudioConvert.
  67. *
  68. * The AudioConvert must have been previously allocated with ff_audio_convert_alloc().
  69. *
  70. * @param ac AudioConvert struct
  71. */
  72. void ff_audio_convert_free(AudioConvert **ac);
  73. /**
  74. * Convert audio data from one sample format to another.
  75. *
  76. * For each call, the alignment of the input and output AudioData buffers are
  77. * examined to determine whether to use the generic or optimized conversion
  78. * function (when available).
  79. *
  80. * The number of samples to convert is determined by in->nb_samples. The output
  81. * buffer must be large enough to handle this many samples. out->nb_samples is
  82. * set by this function before a successful return.
  83. *
  84. * @param ac AudioConvert context
  85. * @param out output audio data
  86. * @param in input audio data
  87. * @return 0 on success, negative AVERROR code on failure
  88. */
  89. int ff_audio_convert(AudioConvert *ac, AudioData *out, AudioData *in);
  90. /* arch-specific initialization functions */
  91. void ff_audio_convert_init_aarch64(AudioConvert *ac);
  92. void ff_audio_convert_init_arm(AudioConvert *ac);
  93. void ff_audio_convert_init_x86(AudioConvert *ac);
  94. #endif /* AVRESAMPLE_AUDIO_CONVERT_H */