Fix nightly doc build (CircleCI) (#3258)

Summary: Pull Request resolved: https://github.com/pytorch/audio/pull/3258

Reviewed By: nateanl

Differential Revision: D44859397

Pulled By: mthrok

fbshipit-source-id: 361ac6a8c7092cc753f77d7745ec178760e8b9c3

.circleci/config.yml

@@ -809,7 +809,7 @@ jobs:
             # gxx_linux-64 is for installing pesq library that depends on cython
             conda install -y pandoc 'ffmpeg<5' gxx_linux-64 git make
             conda install -y -c conda-forge doxygen
-            pip install --progress-bar off -r docs/requirements.txt -r docs/requirements-tutorials.txt
+            pip install --progress-bar off flashlight-text git+https://github.com/kpu/kenlm -r docs/requirements.txt -r docs/requirements-tutorials.txt
       - run:
           name: Build docs
           command: |

.circleci/config.yml.in

@@ -809,7 +809,7 @@ jobs:
             # gxx_linux-64 is for installing pesq library that depends on cython
             conda install -y pandoc 'ffmpeg<5' gxx_linux-64 git make
             conda install -y -c conda-forge doxygen
-            pip install --progress-bar off -r docs/requirements.txt -r docs/requirements-tutorials.txt
+            pip install --progress-bar off flashlight-text git+https://github.com/kpu/kenlm -r docs/requirements.txt -r docs/requirements-tutorials.txt
       - run:
           name: Build docs
           command: |

torchaudio/csrc/ffmpeg/stream_reader/stream_reader.h

@@ -299,10 +299,12 @@ class StreamReader {
   /// @param backoff Time to wait before retrying in milli seconds.
   int process_packet_block(const double timeout, const double backoff);
 
+  /// @cond
   // High-level method used by Python bindings.
   int process_packet(
       const c10::optional<double>& timeout,
       const double backoff);
+  /// @endcond
 
   /// Process packets unitl EOF
   void process_all_packets();

torchaudio/csrc/ffmpeg/stream_reader/typedefs.h

@@ -113,6 +113,7 @@ struct OutputStreamInfo {
   /// @todo Introduce own enum and get rid of FFmpeg dependency
   ///
   AVMediaType media_type = AVMEDIA_TYPE_UNKNOWN;
+  /// Media format. AVSampleFormat for audio or AVPixelFormat for video.
   int format = -1;
 
   /// Filter graph definition, such as

torchaudio/csrc/ffmpeg/stream_writer/stream_writer.h

@@ -102,6 +102,10 @@ class StreamWriter {
   /// override the format used for encoding.
   ///  To list supported formats for the encoder, you can use
   /// ``ffmpeg -h encoder=<ENCODER>`` command.
+  /// @param encoder_sample_rate If provided, perform resampling
+  /// before encoding.
+  /// @param encoder_num_channels If provided, change channel configuration
+  /// before encoding.
   /// @param codec_config Codec configuration.
   /// @param filter_desc Additional processing to apply before
   /// encoding the input data
@@ -137,6 +141,9 @@ class StreamWriter {
   /// @param encoder See ``add_audio_stream()``.
   /// @param encoder_option See ``add_audio_stream()``.
   /// @param encoder_format See ``add_audio_stream()``.
+  /// @param encoder_frame_rate If provided, change frame rate before encoding.
+  /// @param encoder_width If provided, resize image before encoding.
+  /// @param encoder_height If provided, resize image before encoding.
   /// @param hw_accel Enable hardware acceleration.
   /// @param codec_config Codec configuration.
   /// @parblock