Add sox_effects submodule and delegate sox_effects initialization

[mthrok]

No description provided.

[codecov]

Codecov Report

Merging #708 into master will decrease coverage by 0.05%.
The diff coverage is 91.66%.

@@            Coverage Diff             @@
##           master     #708      +/-   ##
==========================================
- Coverage   89.29%   89.23%   -0.06%     
==========================================
  Files          25       26       +1     
  Lines        2344     2350       +6     
==========================================
+ Hits         2093     2097       +4     
- Misses        251      253       +2     

Impacted Files	Coverage Δ
torchaudio/backend/utils.py	86.66% <84.61%> (-5.34%)	⬇️
torchaudio/__init__.py	89.47% <100.00%> (-1.84%)	⬇️
torchaudio/backend/__init__.py	100.00% <100.00%> (ø)
torchaudio/sox_effects/__init__.py	100.00% <100.00%> (ø)
torchaudio/sox_effects/sox_effects.py	87.50% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b788db3...c7eb0e9. Read the comment docs.

[vincentqb]

Can you detail what you are trying to do here?

[vincentqb]

that's BC breaking, no? torchaudio.sox_effects.initialize_sox()

[vincentqb]

I saw that torchaudio.shutdown_sox() still works as you re-import correctly above. However, users could have been doing torchaudio.sox_effects.shutdown_sox() which would now be torchaudio.sox_effects.shutdown_sox_effects(), right?

[mthrok]

Yeah if the user adopts torchaudio.sox_effects.shutdown_sox() which introduced only a couple of days ago.
I do not see that a problem but if you insist, I can simply add [BC braking] tag to commit.

[vincentqb]

Oh right, since it wasn't part of a release, we don't need to worry about this then.

[vincentqb]

nit: that's a separate issue :)

[mthrok]

Can you detail what you are trying to do here?

There are couple of aspects of this PR that overall improves the maintainability of the code base, based on "decoupling" and "separation of concerns".

As you know, sox_effects functionalities are either available or unavailable. From the viewpoint of torchaudio main module, the looser the connection between the torchaudio module and torchaudio.sox_effects, the more manageable the code base become because you can change the two modules independently. This is mostly accomplished when the definitions of initialize_sox and shutdown_sox were moved from torchaudio.__init__ to torchaudio.sox_effects, but the initialization of sox effects are still happening in torchaudio.__init__. If we move the initialization to sox_effects module, the responsibility of sox initialization is moved to sox_effects module, along with the required module availability check etc. The main torchaudio module can be carefree about how the sox_effects module should work.

In addition to that, I found that initialize_sox and shutdown_sox are confusing because it sound like they are required for libsox based I/O. To make it clear, I renamed them to include sox_effect in function name.

Also moving functions from the original places are BC breaking itself, therefore, these functions are re-imported in torchaudio.__init__ and renamed to match the original names. Therefore the PR is not BC breaking.

In the next PR 9519310, I am gonna mark the initialize_sox and shutdown_sox deprecated, so that the decoupling is completed.

[vincentqb]

Thanks for clarifying. I just wanted to make sure we are on the same page :)

[mthrok]

Thanks for clarifying. I just wanted to make sure we are on the same page :)

Great, let me know if you need something for approval.

[vincentqb]

LGTM

[mthrok]

Thanks!