audio_data.h 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. /*
  2. * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com>
  3. *
  4. * This file is part of Libav.
  5. *
  6. * Libav 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. * Libav 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 Libav; 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_DATA_H
  21. #define AVRESAMPLE_AUDIO_DATA_H
  22. #include <stdint.h>
  23. #include "libavutil/audio_fifo.h"
  24. #include "libavutil/log.h"
  25. #include "libavutil/samplefmt.h"
  26. #include "avresample.h"
  27. /**
  28. * Audio buffer used for intermediate storage between conversion phases.
  29. */
  30. typedef struct AudioData {
  31. const AVClass *class; /**< AVClass for logging */
  32. uint8_t *data[AVRESAMPLE_MAX_CHANNELS]; /**< data plane pointers */
  33. uint8_t *buffer; /**< data buffer */
  34. unsigned int buffer_size; /**< allocated buffer size */
  35. int allocated_samples; /**< number of samples the buffer can hold */
  36. int nb_samples; /**< current number of samples */
  37. enum AVSampleFormat sample_fmt; /**< sample format */
  38. int channels; /**< channel count */
  39. int allocated_channels; /**< allocated channel count */
  40. int is_planar; /**< sample format is planar */
  41. int planes; /**< number of data planes */
  42. int sample_size; /**< bytes per sample */
  43. int stride; /**< sample byte offset within a plane */
  44. int read_only; /**< data is read-only */
  45. int allow_realloc; /**< realloc is allowed */
  46. int ptr_align; /**< minimum data pointer alignment */
  47. int samples_align; /**< allocated samples alignment */
  48. const char *name; /**< name for debug logging */
  49. } AudioData;
  50. int ff_audio_data_set_channels(AudioData *a, int channels);
  51. /**
  52. * Initialize AudioData using a given source.
  53. *
  54. * This does not allocate an internal buffer. It only sets the data pointers
  55. * and audio parameters.
  56. *
  57. * @param a AudioData struct
  58. * @param src source data pointers
  59. * @param plane_size plane size, in bytes.
  60. * This can be 0 if unknown, but that will lead to
  61. * optimized functions not being used in many cases,
  62. * which could slow down some conversions.
  63. * @param channels channel count
  64. * @param nb_samples number of samples in the source data
  65. * @param sample_fmt sample format
  66. * @param read_only indicates if buffer is read only or read/write
  67. * @param name name for debug logging (can be NULL)
  68. * @return 0 on success, negative AVERROR value on error
  69. */
  70. int ff_audio_data_init(AudioData *a, void **src, int plane_size, int channels,
  71. int nb_samples, enum AVSampleFormat sample_fmt,
  72. int read_only, const char *name);
  73. /**
  74. * Allocate AudioData.
  75. *
  76. * This allocates an internal buffer and sets audio parameters.
  77. *
  78. * @param channels channel count
  79. * @param nb_samples number of samples to allocate space for
  80. * @param sample_fmt sample format
  81. * @param name name for debug logging (can be NULL)
  82. * @return newly allocated AudioData struct, or NULL on error
  83. */
  84. AudioData *ff_audio_data_alloc(int channels, int nb_samples,
  85. enum AVSampleFormat sample_fmt,
  86. const char *name);
  87. /**
  88. * Reallocate AudioData.
  89. *
  90. * The AudioData must have been previously allocated with ff_audio_data_alloc().
  91. *
  92. * @param a AudioData struct
  93. * @param nb_samples number of samples to allocate space for
  94. * @return 0 on success, negative AVERROR value on error
  95. */
  96. int ff_audio_data_realloc(AudioData *a, int nb_samples);
  97. /**
  98. * Free AudioData.
  99. *
  100. * The AudioData must have been previously allocated with ff_audio_data_alloc().
  101. *
  102. * @param a AudioData struct
  103. */
  104. void ff_audio_data_free(AudioData **a);
  105. /**
  106. * Copy data from one AudioData to another.
  107. *
  108. * @param out output AudioData
  109. * @param in input AudioData
  110. * @return 0 on success, negative AVERROR value on error
  111. */
  112. int ff_audio_data_copy(AudioData *out, AudioData *in);
  113. /**
  114. * Append data from one AudioData to the end of another.
  115. *
  116. * @param dst destination AudioData
  117. * @param dst_offset offset, in samples, to start writing, relative to the
  118. * start of dst
  119. * @param src source AudioData
  120. * @param src_offset offset, in samples, to start copying, relative to the
  121. * start of the src
  122. * @param nb_samples number of samples to copy
  123. * @return 0 on success, negative AVERROR value on error
  124. */
  125. int ff_audio_data_combine(AudioData *dst, int dst_offset, AudioData *src,
  126. int src_offset, int nb_samples);
  127. /**
  128. * Drain samples from the start of the AudioData.
  129. *
  130. * Remaining samples are shifted to the start of the AudioData.
  131. *
  132. * @param a AudioData struct
  133. * @param nb_samples number of samples to drain
  134. */
  135. void ff_audio_data_drain(AudioData *a, int nb_samples);
  136. /**
  137. * Add samples in AudioData to an AVAudioFifo.
  138. *
  139. * @param af Audio FIFO Buffer
  140. * @param a AudioData struct
  141. * @param offset number of samples to skip from the start of the data
  142. * @param nb_samples number of samples to add to the FIFO
  143. * @return number of samples actually added to the FIFO, or
  144. * negative AVERROR code on error
  145. */
  146. int ff_audio_data_add_to_fifo(AVAudioFifo *af, AudioData *a, int offset,
  147. int nb_samples);
  148. /**
  149. * Read samples from an AVAudioFifo to AudioData.
  150. *
  151. * @param af Audio FIFO Buffer
  152. * @param a AudioData struct
  153. * @param nb_samples number of samples to read from the FIFO
  154. * @return number of samples actually read from the FIFO, or
  155. * negative AVERROR code on error
  156. */
  157. int ff_audio_data_read_from_fifo(AVAudioFifo *af, AudioData *a, int nb_samples);
  158. #endif /* AVRESAMPLE_AUDIO_DATA_H */