From 4830c13593f54a6c5909ff4adf3e151f58469ea0 Mon Sep 17 00:00:00 2001 From: Kyle Neideck Date: Wed, 24 Feb 2016 19:14:12 +1100 Subject: [PATCH] Fix various Markdown bugs --- CONTRIBUTING.md | 2 +- DEVELOPING.md | 6 +++++- README.md | 21 +++++++++++---------- TODO.md | 2 +- 4 files changed, 18 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff3a2c7..e77afc1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ Audio, for that matter. No dependencies so far, though you're welcome to add some. The best place to start is probably `DEVELOPING.md`, which has an overview of the project and instructions for building, -debugging, etc. Though it's kind of long and not very interesting, so you might prefer to go straight into the code. +debugging, etc. It's kind of long, though, and not very interesting, so you might prefer to go straight into the code. If you've got questions related to Core Audio, the [Core Audio mailing list](https://lists.apple.com/archives/coreaudio-api) is very useful. There's also the [Core Audio diff --git a/DEVELOPING.md b/DEVELOPING.md index 1dd1d04..72d2833 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -77,7 +77,9 @@ Music Device.driver` to `/Library/Audio/Plug-Ins/HAL` and restart coreaudiod. Before you build, Xcode might show incorrect warnings on the `#pragma clang assume_nonnull` lines for some reason. They go away after you build and don't seem to cause any problems. -**The following debug instructions stopped working in El Capitan.** System Integrity Protection stops LLDB from attaching to coreaudiod. I don't know of a workaround except to disable SIP. +**The following debug instructions stopped working in OS X 10.11 (El Capitan).** [System Integrity +Protection](https://support.apple.com/en-us/HT204899) stops LLDB from attaching to coreaudiod. I don't know of a +workaround except to disable SIP. To debug in Xcode, - edit the BGMDevice scheme and @@ -89,11 +91,13 @@ To debug in Xcode, - set BGMDevice as the active scheme, - build and install, - stop coreaudiod + ```shell sudo launchctl unload /System/Library/LaunchDaemons/com.apple.audio.coreaudiod.plist ``` - run in Xcode, - start coreaudiod + ```shell sudo launchctl load /System/Library/LaunchDaemons/com.apple.audio.coreaudiod.plist ``` diff --git a/README.md b/README.md index c57feac..3215651 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,17 @@ # Background Music ##### OS X audio utility -![](Images/README/screenshot.png) +![](Images/README/Screenshot.png) - Automatically pauses your music player when other audio starts playing and unpauses it afterwards - Per-application volume, boost quiet apps -- Record system audio - +- Record system audio
+
- No restart required to install - Runs entirely in userspace **Version 0.1.0**, first release. Probably very buggy. Pretty much only tested on one system (a MacBook running OS X -10.11.3 using the built-in audio device). +10.11 using the built-in audio device). **Requires OS X 10.10+**. Might work on 10.9, but I haven't tried it. @@ -25,9 +25,9 @@ Background Music can pause your music player app when other audio starts playing that when I'm listening to music and pause it to watch a video or something I always forget to unpause it afterwards. So this keeps me from wearing headphones for hours listening to nothing. -So far only iTunes and Spotify are supported, but adding support for a music player should only take a few minutes (see -BGMMusicPlayer.h). If you don't know how to program, or just don't feel like it, create an issue and I'll try to add it -for you. +So far only iTunes, Spotify and VLC are supported, but adding support for a music player should only take a few minutes +(see `BGMMusicPlayer.h`). If you don't know how to program, or just don't feel like it, create an issue and I'll try to +add it for you. ## App volumes @@ -58,7 +58,8 @@ No binaries yet, but building only takes a few seconds. ```shell xcodebuild -project BGMApp/BGMApp.xcodeproj -target "Background Music" DSTROOT="/" install RUN_CLANG_STATIC_ANALYZER=0 ``` -- Restart `coreaudiod`: (audio will stop working until the next step, so you might want to pause any running audio apps) +- Restart `coreaudiod`:
+ (Audio will stop working until the next step, so you might want to pause any running audio apps.) ```shell sudo launchctl unload /System/Library/LaunchDaemons/com.apple.audio.coreaudiod.plist @@ -71,8 +72,8 @@ No binaries yet, but building only takes a few seconds. - Delete `Background Music.app` from `/Applications`. - Delete `Background Music Device.driver` from `/Library/Audio/Plug-Ins/HAL`. - Pause apps that are playing audio, if you can. -- Restart `coreaudiod`: +- Restart `coreaudiod`: + [//]: # ( (Open `/Applications/Utilities/Terminal.app` and paste the following at the prompt.) ) ```shell sudo launchctl unload /System/Library/LaunchDaemons/com.apple.audio.coreaudiod.plist diff --git a/TODO.md b/TODO.md index 9923785..8edbf24 100644 --- a/TODO.md +++ b/TODO.md @@ -86,6 +86,6 @@ There are also lots of other TODOs commented around the code. - When BGMApp changes the default device to BGMDevice, some apps seem to keep using the previous default device if they were running IO at the time. Not sure if we can do anything about this. -- Figure out how to test BGMDriver with Address Sanitizer enabled. It isn't working because coreaudio will try to read +- Figure out how to test BGMDriver with Address Sanitizer enabled. It isn't working because coreaudiod will try to read files outside of its sandbox.