No Description

audiomanip_8h.tex 5.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. \hypertarget{audiomanip_8h}{}\section{audiomanip.\+h File Reference}
  2. \label{audiomanip_8h}\index{audiomanip.\+h@{audiomanip.\+h}}
  3. {\ttfamily \#include $<$Q\+Audio\+Buffer$>$}\\*
  4. \subsection*{Macros}
  5. \begin{DoxyCompactItemize}
  6. \item
  7. \#define \hyperlink{audiomanip_8h_a03d94cc61b0c5794b5aeb0e8390e7e0d}{Audio\+Buffer}~Q\+Audio\+Buffer\+::\+S16\+S
  8. \end{DoxyCompactItemize}
  9. \subsection*{Functions}
  10. \begin{DoxyCompactItemize}
  11. \item
  12. void \hyperlink{audiomanip_8h_a3cd69c0b889169ee6625239ca35e9538}{Remove\+Vocals} (\hyperlink{audiomanip_8h_a03d94cc61b0c5794b5aeb0e8390e7e0d}{Audio\+Buffer} frames\mbox{[}$\,$\mbox{]}, int N)
  13. \begin{DoxyCompactList}\small\item\em Given the audio frames of the sound clip, remove the vocals from the clip. \end{DoxyCompactList}\item
  14. void \hyperlink{audiomanip_8h_a88857e657ef3840063e4ea5e9e898dba}{Audio\+Fade\+In} (\hyperlink{audiomanip_8h_a03d94cc61b0c5794b5aeb0e8390e7e0d}{Audio\+Buffer} frames\mbox{[}$\,$\mbox{]}, int N, int fade\+\_\+length)
  15. \begin{DoxyCompactList}\small\item\em Perform an audio fade in of the sound clip. \end{DoxyCompactList}\item
  16. void \hyperlink{audiomanip_8h_a980252d21947f1aa1bd45d1ba3938121}{Audio\+Fade\+Out} (\hyperlink{audiomanip_8h_a03d94cc61b0c5794b5aeb0e8390e7e0d}{Audio\+Buffer} frames\mbox{[}$\,$\mbox{]}, int N, int fade\+\_\+length)
  17. \begin{DoxyCompactList}\small\item\em Perform an audio fade out of the sound clip. \end{DoxyCompactList}\item
  18. void \hyperlink{audiomanip_8h_acdb38ec71647d81c81eeadf210a7800c}{Left\+To\+Right} (\hyperlink{audiomanip_8h_a03d94cc61b0c5794b5aeb0e8390e7e0d}{Audio\+Buffer} frames\mbox{[}$\,$\mbox{]}, int N, int pan\+\_\+length)
  19. \begin{DoxyCompactList}\small\item\em Performs a panning effect from left to right. \end{DoxyCompactList}\end{DoxyCompactItemize}
  20. \subsection{Macro Definition Documentation}
  21. \hypertarget{audiomanip_8h_a03d94cc61b0c5794b5aeb0e8390e7e0d}{}\index{audiomanip.\+h@{audiomanip.\+h}!Audio\+Buffer@{Audio\+Buffer}}
  22. \index{Audio\+Buffer@{Audio\+Buffer}!audiomanip.\+h@{audiomanip.\+h}}
  23. \subsubsection[{Audio\+Buffer}]{\setlength{\rightskip}{0pt plus 5cm}\#define Audio\+Buffer~Q\+Audio\+Buffer\+::\+S16\+S}\label{audiomanip_8h_a03d94cc61b0c5794b5aeb0e8390e7e0d}
  24. Audio\+Buffer is an object with left and right side of an stereo audio
  25. \subsection{Function Documentation}
  26. \hypertarget{audiomanip_8h_a88857e657ef3840063e4ea5e9e898dba}{}\index{audiomanip.\+h@{audiomanip.\+h}!Audio\+Fade\+In@{Audio\+Fade\+In}}
  27. \index{Audio\+Fade\+In@{Audio\+Fade\+In}!audiomanip.\+h@{audiomanip.\+h}}
  28. \subsubsection[{Audio\+Fade\+In}]{\setlength{\rightskip}{0pt plus 5cm}void Audio\+Fade\+In (
  29. \begin{DoxyParamCaption}
  30. \item[{{\bf Audio\+Buffer}}]{frames\mbox{[}$\,$\mbox{]}, }
  31. \item[{int}]{N, }
  32. \item[{int}]{fade\+\_\+length}
  33. \end{DoxyParamCaption}
  34. )}\label{audiomanip_8h_a88857e657ef3840063e4ea5e9e898dba}
  35. Perform an audio fade in of the sound clip.
  36. \begin{DoxyParams}{Parameters}
  37. {\em frames} & array that contains audio samples, it will modified this function. \\
  38. \hline
  39. {\em N} & number of audio samples (per channel) \\
  40. \hline
  41. {\em fade\+\_\+length} & length of the fade in, in terms of audio samples \\
  42. \hline
  43. \end{DoxyParams}
  44. \hypertarget{audiomanip_8h_a980252d21947f1aa1bd45d1ba3938121}{}\index{audiomanip.\+h@{audiomanip.\+h}!Audio\+Fade\+Out@{Audio\+Fade\+Out}}
  45. \index{Audio\+Fade\+Out@{Audio\+Fade\+Out}!audiomanip.\+h@{audiomanip.\+h}}
  46. \subsubsection[{Audio\+Fade\+Out}]{\setlength{\rightskip}{0pt plus 5cm}void Audio\+Fade\+Out (
  47. \begin{DoxyParamCaption}
  48. \item[{{\bf Audio\+Buffer}}]{frames\mbox{[}$\,$\mbox{]}, }
  49. \item[{int}]{N, }
  50. \item[{int}]{fade\+\_\+length}
  51. \end{DoxyParamCaption}
  52. )}\label{audiomanip_8h_a980252d21947f1aa1bd45d1ba3938121}
  53. Perform an audio fade out of the sound clip.
  54. \begin{DoxyParams}{Parameters}
  55. {\em frames} & array that contains audio samples, it will modified this function. \\
  56. \hline
  57. {\em N} & number of audio samples (per channel) \\
  58. \hline
  59. {\em fade\+\_\+length} & length of the fade out, in terms of audio samples \\
  60. \hline
  61. \end{DoxyParams}
  62. \hypertarget{audiomanip_8h_acdb38ec71647d81c81eeadf210a7800c}{}\index{audiomanip.\+h@{audiomanip.\+h}!Left\+To\+Right@{Left\+To\+Right}}
  63. \index{Left\+To\+Right@{Left\+To\+Right}!audiomanip.\+h@{audiomanip.\+h}}
  64. \subsubsection[{Left\+To\+Right}]{\setlength{\rightskip}{0pt plus 5cm}void Left\+To\+Right (
  65. \begin{DoxyParamCaption}
  66. \item[{{\bf Audio\+Buffer}}]{frames\mbox{[}$\,$\mbox{]}, }
  67. \item[{int}]{N, }
  68. \item[{int}]{pan\+\_\+length}
  69. \end{DoxyParamCaption}
  70. )}\label{audiomanip_8h_acdb38ec71647d81c81eeadf210a7800c}
  71. Performs a panning effect from left to right.
  72. \begin{DoxyParams}{Parameters}
  73. {\em frames} & array that contains audio samples, it will modified this function. \\
  74. \hline
  75. {\em N} & number of audio samples (per channel) \\
  76. \hline
  77. {\em pan\+\_\+length} & length of the panning effect, in terms of audio samples \\
  78. \hline
  79. \end{DoxyParams}
  80. \hypertarget{audiomanip_8h_a3cd69c0b889169ee6625239ca35e9538}{}\index{audiomanip.\+h@{audiomanip.\+h}!Remove\+Vocals@{Remove\+Vocals}}
  81. \index{Remove\+Vocals@{Remove\+Vocals}!audiomanip.\+h@{audiomanip.\+h}}
  82. \subsubsection[{Remove\+Vocals}]{\setlength{\rightskip}{0pt plus 5cm}void Remove\+Vocals (
  83. \begin{DoxyParamCaption}
  84. \item[{{\bf Audio\+Buffer}}]{frames\mbox{[}$\,$\mbox{]}, }
  85. \item[{int}]{N}
  86. \end{DoxyParamCaption}
  87. )}\label{audiomanip_8h_a3cd69c0b889169ee6625239ca35e9538}
  88. Given the audio frames of the sound clip, remove the vocals from the clip.
  89. \begin{DoxyParams}{Parameters}
  90. {\em frames} & array that contains audio samples, it will be modified this function. \\
  91. \hline
  92. {\em N} & number of audio samples (per channel) \\
  93. \hline
  94. \end{DoxyParams}