X-Codec

Unified Semantic and Acoustic Codec for Audio Language Model.

X-Codec-2.0 released!

Paper

Title: Codec Does Matter: Exploring the Semantic Shortcoming of Codec for Audio Language Model (AAAI 2025)

Authors: Zhen Ye, Peiwen Sun, Jiahe Lei, Hongzhan Lin, Xu Tan, Zheqi Dai, Qiuqiang Kong, Jianyi Chen, Jiahao Pan, Qifeng Liu, Yike Guo*, Wei Xue*

Experiments on VALL-E

Highlight

You can easily apply our approach to enhance any existing acoustic codec:

For example

class Codec():
    def __init__(self):
        # Acoustic codec components
        self.encoder = Encoder(...)       # Acoustic encoder
        self.decoder = Decoder(...)       # Acoustic decoder
        self.quantizer = RVQ(...)         # Residual Vector Quantizer (RVQ)

        # Adding the semantic module
        self.semantic_model = AutoModel.from_pretrained(...)  # e.g., Hubert, WavLM

        # Adding Projector
        self.fc_prior = nn.Linear(...)     
        self.fc_post1 = nn.Linear(...)     
        self.fc_post2 = nn.Linear(...)     

    def forward(self, x, bw):
        # Encode the input acoustically and semantically
        e_acoustic = self.encoder(x)
        e_semantic = self.semantic_model(x)

        # Combine acoustic and semantic features
        combined_features = torch.cat([e_acoustic, e_semantic])

        # Apply prior transformation
        transformed_features = self.fc_prior(combined_features)

        # Quantize the unified  semantic and acoustic features
        quantized, codes, bandwidth, commit_loss = self.quantizer(transformed_features, bw)

        # Post-process the quantized features
        quantized_semantic = self.fc_post1(quantized)
        quantized_acoustic = self.fc_post2(quantized)

        # Decode the quantized acoustic features
        output = self.decoder(quantized_acoustic)



    def semantic_loss(self,semantic,quantized_semantic):
        return F.mse_loss(semantic,quantized_semantic)

For more details, please refer to our code.

Available models

X-Codec is part of Hugging Face's Transformers library (see model documentation).

Below are the Transformers-compatible checkpoints on the Hugging Face Hub 🤗

| Model checkpoint | Semantic Model | Domain | Training Data | |--------------------------------------------|-----------------------------------------------------------------------|---------------|-------------------------------| | xcodec-hubert-librispeech | facebook/hubert-base-ls960 | Speech | Librispeech | | xcodec-wavlm-mls (not mentioned in paper) | microsoft/wavlm-base-plus| Speech | MLS English | | xcodec-wavlm-more-data (not mentioned in paper) | microsoft/wavlm-base-plus| Speech | MLS English + Internal data | | xcodec-hubert-general | ZhenYe234/hubert_base_general_audio | General audio | 200k hours internal data | | xcodec-hubert-general-balanced (not mentioned in paper) | ZhenYe234/hubert_base_general_audio | General audio | More balanced data |

Below are the original checkpoints.

| Model name | Hugging Face | Config | Semantic Model | Domain | Training Data | |---------------------------------------------|--------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|---------------|-------------------------------| | xcodec_hubert_librispeech | 🤗 | 🤗 | 🤗 Hubert-base | Speech | Librispeech | | xcodec_wavlm_mls (not mentioned in paper) | 🤗 | 🤗 | 🤗 Wavlm-base-plus | Speech | MLS English | | xcodec_wavlm_more_data (not mentioned in paper) | 🤗 | 🤗 | 🤗 Wavlm-base-plus | Speech | MLS English + Internal data | | xcodec_hubert_general_audio | 🤗 | 🤗 | 🤗Hubert-base-general-audio | General audio | 200k hours internal data | | xcodec_hubert_general_audio_more_data (not mentioned in paper) | 🤗 | 🤗 | 🤗Hubert-base-general-audio | General audio | More balanced data |

Inference

To run inference, first download the model and config from hugging face.

python inference.py

Training

Prepare the training_file and validation_file in config. The file should list the paths to your audio files:

/path/to/your/xxx.wav
/path/to/your/yyy.wav
...

Then:

torchrun --nnodes=1 --nproc-per-node=8 main_launch_vqdp.py

Acknowledgement

I would like to extend a special thanks to authors of Uniaudio and DAC, since our code base is mainly borrowed from Uniaudio and DAC.

Citation

If you find this repo helpful, please consider citing in the following format:

@article{ye2024codecdoesmatterexploring,
      title={Codec Does Matter: Exploring the Semantic Shortcoming of Codec for Audio Language Model}, 
      author={Zhen Ye and Peiwen Sun and Jiahe Lei and Hongzhan Lin and Xu Tan and Zheqi Dai and Qiuqiang Kong and Jianyi Chen and Jiahao Pan and Qifeng Liu and Yike Guo and Wei Xue},
      journal={arXiv preprint arXiv:2408.17175},
      year={2024},
}

Xcodec

Install / Use

README