AtomicParsley

https://github.com/wez/atomicparsley
Admin
A lightweight command-line utility for reading, parsing, and setting iTunes-style metadata into...
Tokens:6,094
Snippets:120
Trust Score:9.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Installation Rule

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Specifies that the AtomicParsley executable should be installed to the bin directory.

```cmake
install(TARGETS AtomicParsley RUNTIME DESTINATION bin)
```

--------------------------------

### AtomicParsley Usage Examples

Source: https://github.com/wez/atomicparsley/blob/master/README.md

General usage examples for AtomicParsley, demonstrating how to set various metadata tags and retrieve file information.

```bash
AtomicParsley /path/to.mp4 -T 1
AtomicParsley /path/to.mp4 -t +
AtomicParsley /path/to.mp4 --artist "Me" --artwork /path/to/art.jpg
Atomicparsley /path/to.mp4 --albumArtist "You" --podcastFlag true
Atomicparsley /path/to.mp4 --stik "TV Show" --advisory explicit
```

--------------------------------

### Install AtomicParsley via Homebrew

Source: https://github.com/wez/atomicparsley/blob/master/README.md

Command to install AtomicParsley using the Homebrew package manager on macOS.

```bash
$ brew install atomicparsley
```

--------------------------------

### Building AtomicParsley from Source

Source: https://github.com/wez/atomicparsley/blob/master/README.md

Commands to build the AtomicParsley executable from source using cmake.

```bash
cmake .
cmake --build . --config Release
```

--------------------------------

### Project Configuration

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Sets the minimum CMake version, target architectures for macOS, and project name.

```cmake
cmake_minimum_required(VERSION 3.5)

SET(CMAKE_OSX_ARCHITECTURES "x86_64;arm64" CACHE STRING "Build all architectures for Mac OS X" FORCE)

project(AtomicParsley)
```

--------------------------------

### Preprocessor Definitions

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Adds general preprocessor definitions for package version, build info, and file offset bits.

```cmake
add_definitions(
  -DPACKAGE_VERSION="${PACKAGE_VERSION}"
  -DBUILD_INFO="${BUILD_INFO}"
  -D_FILE_OFFSET_BITS=64
)
```

--------------------------------

### ZLIB Find and Include

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Finds the ZLIB library and includes its headers if found.

```cmake
find_package(ZLIB)
if(ZLIB_FOUND)
  include_directories(${ZLIB_INCLUDE_DIRS})
  add_definitions(-DHAVE_ZLIB_H)
endif()
```

--------------------------------

### Source File List

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Lists the source files for the project, conditionally adding platform-specific files.

```cmake
list(APPEND sources
	src/CDtoc.cpp
	src/arrays.cpp
	src/compress.cpp
	src/extracts.cpp
	src/iconv.cpp
	src/id3v2.cpp
	src/main.cpp
	src/metalist.cpp
	src/parsley.cpp
	src/sha1.cpp
	src/util.cpp
	src/uuid.cpp
)

if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
  list(APPEND sources
    src/nsfile.mm
    src/nsimage.mm
  )
endif()

if(WIN32)
  list(APPEND sources
    src/extras/getopt.c
    src/extras/getopt1.c
  )
endif()
```

--------------------------------

### Linking Libraries

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Links necessary libraries, including ZLIB and macOS specific frameworks.

```cmake
if(ZLIB_FOUND)
  target_link_libraries(
    AtomicParsley
    ${ZLIB_LIBRARIES}
  )
endif()

if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
  target_link_libraries(
    AtomicParsley
    "-framework Cocoa"
    "-framework Foundation"
    "-framework IOKit"
  )
endif()
```

--------------------------------

### Build Type and ASAN Option

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Sets default build type to Release if not specified and defines an option for AddressSanitizer (ASAN).

```cmake
if(NOT CMAKE_BUILD_TYPE)
  set(CMAKE_BUILD_TYPE Release)
endif()

option(ASAN "whether to enable ASAN" OFF)
```

--------------------------------

### Symbol Existence Checks

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Checks for the existence of specific C library functions (strsep, fseeko) and defines preprocessor macros accordingly.

```cmake
include(CheckSymbolExists)
check_symbol_exists(strsep "string.h" HAVE_STRSEP)
if(HAVE_STRSEP)
  add_definitions(-DHAVE_STRSEP)
endif()
check_symbol_exists(fseeko "stdio.h" HAVE_FSEEKO)
if(HAVE_FSEEKO)
  add_definitions(-DHAVE_FSEEKO)
endif()
```

--------------------------------

### Executable Target

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Defines the main executable target 'AtomicParsley' with the collected source files.

```cmake
add_executable(
  AtomicParsley
  ${sources}
)
```

--------------------------------

### Git Information Extraction

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Finds the git executable and extracts build information (commit hash and date) if available.

```cmake
find_program(GIT git)
if(GIT)
  execute_process(
    COMMAND "${GIT}" "show" "-s" "--format=%H;%cd" "--date=format:%Y%m%d.%H%M%S.0"
    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
    RESULT_VARIABLE git_result
    OUTPUT_VARIABLE git_data
    ERROR_VARIABLE git_err
    OUTPUT_STRIP_TRAILING_WHITESPACE
  )
  if(git_result EQUAL 0)
    list(GET git_data 0 BUILD_INFO)
    list(GET git_data 1 PACKAGE_VERSION)
  endif()
endif()
```

--------------------------------

### ASAN Flags

Source: https://github.com/wez/atomicparsley/blob/master/CMakeLists.txt

Configures compiler and linker flags for AddressSanitizer when ASAN is enabled.

```cmake
if (ASAN)
  set (CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -fno-omit-frame-pointer -fsanitize=address")
  set (CMAKE_LINKER_FLAGS_DEBUG "${CMAKE_LINKER_FLAGS_DEBUG} -fno-omit-frame-pointer -fsanitize=address")
endif()
```
Tokens:
Raw