MythMusic: Fix coverity ID 703848 Structurally dead code

In FileScanner::GetDirectoryId(): Code block is unreachable because of the
syntactic structure of the code. Re-factor the code to keep coverity happy
and add some comments to clarify what the code is doing.