FFmpeg
soxenc.c
Go to the documentation of this file.
1 /*
2  * SoX native format muxer
3  * Copyright (c) 2009 Daniel Verkamp <daniel@drv.nu>
4  *
5  * Based on libSoX sox-fmt.c
6  * Copyright (c) 2008 robs@users.sourceforge.net
7  *
8  * This file is part of FFmpeg.
9  *
10  * FFmpeg is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * FFmpeg is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with FFmpeg; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24 
25 /**
26  * @file
27  * SoX native format muxer
28  * @author Daniel Verkamp
29  * @see http://wiki.multimedia.cx/index.php?title=SoX_native_intermediate_format
30  */
31 
32 #include "libavutil/intreadwrite.h"
33 #include "libavutil/intfloat.h"
34 #include "libavutil/dict.h"
35 #include "avformat.h"
36 #include "avio_internal.h"
37 #include "rawenc.h"
38 #include "sox.h"
39 
40 typedef struct SoXContext {
41  int64_t header_size;
42 } SoXContext;
43 
45 {
46  SoXContext *sox = s->priv_data;
47  AVIOContext *pb = s->pb;
48  AVCodecParameters *par = s->streams[0]->codecpar;
50  size_t comment_len = 0, comment_size;
51 
52  comment = av_dict_get(s->metadata, "comment", NULL, 0);
53  if (comment)
54  comment_len = strlen(comment->value);
55  comment_size = FFALIGN(comment_len, 8);
56 
57  sox->header_size = SOX_FIXED_HDR + comment_size;
58 
59  if (par->codec_id == AV_CODEC_ID_PCM_S32LE) {
60  ffio_wfourcc(pb, ".SoX");
61  avio_wl32(pb, sox->header_size);
62  avio_wl64(pb, 0); /* number of samples */
64  avio_wl32(pb, par->channels);
65  avio_wl32(pb, comment_size);
66  } else if (par->codec_id == AV_CODEC_ID_PCM_S32BE) {
67  ffio_wfourcc(pb, "XoS.");
68  avio_wb32(pb, sox->header_size);
69  avio_wb64(pb, 0); /* number of samples */
71  avio_wb32(pb, par->channels);
72  avio_wb32(pb, comment_size);
73  } else {
74  av_log(s, AV_LOG_ERROR, "invalid codec; use pcm_s32le or pcm_s32be\n");
75  return AVERROR(EINVAL);
76  }
77 
78  if (comment_len)
79  avio_write(pb, comment->value, comment_len);
80 
81  ffio_fill(pb, 0, comment_size - comment_len);
82 
83  return 0;
84 }
85 
87 {
88  SoXContext *sox = s->priv_data;
89  AVIOContext *pb = s->pb;
90  AVCodecParameters *par = s->streams[0]->codecpar;
91 
92  if (s->pb->seekable & AVIO_SEEKABLE_NORMAL) {
93  /* update number of samples */
94  int64_t file_size = avio_tell(pb);
95  int64_t num_samples = (file_size - sox->header_size - 4LL) >> 2LL;
96  avio_seek(pb, 8, SEEK_SET);
97  if (par->codec_id == AV_CODEC_ID_PCM_S32LE) {
98  avio_wl64(pb, num_samples);
99  } else
100  avio_wb64(pb, num_samples);
101  avio_seek(pb, file_size, SEEK_SET);
102  }
103 
104  return 0;
105 }
106 
108  .name = "sox",
109  .long_name = NULL_IF_CONFIG_SMALL("SoX native"),
110  .extensions = "sox",
111  .priv_data_size = sizeof(SoXContext),
112  .audio_codec = AV_CODEC_ID_PCM_S32LE,
113  .video_codec = AV_CODEC_ID_NONE,
118 };
AVOutputFormat::name
const char * name
Definition: avformat.h:496
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
ffio_wfourcc
static av_always_inline void ffio_wfourcc(AVIOContext *pb, const uint8_t *s)
Definition: avio_internal.h:105
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:52
AVFMT_NOTIMESTAMPS
#define AVFMT_NOTIMESTAMPS
Format does not need / have any timestamps.
Definition: avformat.h:467
sox.h
avio_wl64
void avio_wl64(AVIOContext *s, uint64_t val)
Definition: aviobuf.c:439
intfloat.h
sox_write_trailer
static int sox_write_trailer(AVFormatContext *s)
Definition: soxenc.c:86
AVCodecParameters::channels
int channels
Audio only.
Definition: codec_par.h:166
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:486
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_dict_get
AVDictionaryEntry * av_dict_get(const AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
Get a dictionary entry with matching key.
Definition: dict.c:40
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
ff_raw_write_packet
int ff_raw_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: rawenc.c:29
AVFormatContext
Format I/O context.
Definition: avformat.h:1097
NULL
#define NULL
Definition: coverity.c:32
write_trailer
static int write_trailer(AVFormatContext *s1)
Definition: v4l2enc.c:98
ff_sox_muxer
const AVOutputFormat ff_sox_muxer
Definition: soxenc.c:107
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:170
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:218
avio_wb32
void avio_wb32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:379
avio_wl32
void avio_wl32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:371
rawenc.h
write_packet
static void write_packet(OutputFile *of, AVPacket *pkt, OutputStream *ost, int unqueue)
Definition: ffmpeg.c:731
av_double2int
static av_always_inline uint64_t av_double2int(double f)
Reinterpret a double as a 64-bit integer.
Definition: intfloat.h:70
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:48
AVOutputFormat
Definition: avformat.h:495
avio_internal.h
AV_CODEC_ID_PCM_S32BE
@ AV_CODEC_ID_PCM_S32BE
Definition: codec_id.h:322
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:246
comment
static int FUNC() comment(CodedBitstreamContext *ctx, RWContext *rw, JPEGRawComment *current)
Definition: cbs_jpeg_syntax_template.c:174
SoXContext::header_size
int64_t header_size
Definition: soxenc.c:41
avformat.h
dict.h
AVIO_SEEKABLE_NORMAL
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
avio_wb64
void avio_wb64(AVIOContext *s, uint64_t val)
Definition: aviobuf.c:445
AV_CODEC_ID_PCM_S32LE
@ AV_CODEC_ID_PCM_S32LE
Definition: codec_id.h:321
AVDictionaryEntry
Definition: dict.h:79
FFALIGN
#define FFALIGN(x, a)
Definition: macros.h:78
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:60
SOX_FIXED_HDR
#define SOX_FIXED_HDR
Size of fixed header without magic.
Definition: sox.h:25
ffio_fill
void ffio_fill(AVIOContext *s, int b, int count)
Definition: aviobuf.c:204
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
write_header
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:347
SoXContext
Definition: soxenc.c:40
sox_write_header
static int sox_write_header(AVFormatContext *s)
Definition: soxenc.c:44