rob
/
mpeg-audio-frame-parser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Stream-oriented MPEG frame parser in Elixir
13 Commits 3 Branches 0 Tags 477 KiB
Elixir 100%
Go to file
Rob Watson 417f5d0545 Re-add doctest 2018-04-19 20:32:16 +02:00
config Add initial implementation 2018-04-17 11:51:12 +02:00
lib Experimental refactor to a more functional style 2018-04-19 20:29:11 +02:00
test Re-add doctest 2018-04-19 20:32:16 +02:00
.formatter.exs Vanilla Elixir 1.6.3 app 2018-04-13 13:06:37 +02:00
.gitignore Add initial implementation 2018-04-17 11:51:12 +02:00
README.md Add TODO 2018-04-18 21:50:43 +02:00
mix.exs Add initial implementation 2018-04-17 11:51:12 +02:00

README.md

MPEGAudioFrameParser

Given a series of binary packets, extract any complete MPEG audio frames that can be found and return them to clients.

In theory supports all of MPEG layer 1, 2 and 3 and versions 1, 2 and 2.5, but is most useful for (and has been most thoroughly tested with) layer 3 (MP3) files.

Usage

Currently WIP. See the moduledoc for usage examples.

TODO

  • Validate CRC signature if present
  • Extract additional metadata (channel mode, copyright, etc)
  • Further tighten frame validation
  • Investigate improvements to public API/interface

Contributing

Contributions welcome! Please ensure that appropriate automated tests are included with any pull requests.

License

Copyright 2018 Rob Watson.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.